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 * Server and execution environment information
69 *
70 * @deprecated
71 **/
72$HTTP_SERVER_VARS = array();
73
74/**
75 * Session variables
76 *
77 * @deprecated
78 **/
79$HTTP_SESSION_VARS = array();
80
81/**
82 * The previous error message
83 **/
84$php_errormsg = array();
85
86/**
87 * HTTP Cookies
88 *
89 * @superglobal
90 **/
91$_COOKIE = array();
92
93/**
94 * Environment variables
95 *
96 * @superglobal
97 **/
98$_ENV = array();
99
100/**
101 * HTTP File Upload variables
102 *
103 * @superglobal
104 **/
105$_FILES = array();
106
107/**
108 * HTTP GET variables
109 *
110 * @superglobal
111 **/
112$_GET = array();
113
114/**
115 * HTTP POST variables
116 *
117 * @superglobal
118 **/
119$_POST = array();
120
121/**
122 * HTTP Request variables
123 *
124 * @superglobal
125 **/
126$_REQUEST = array();
127
128/**
129 * Server and execution environment information
130 *
131 * @superglobal
132 **/
133$_SERVER = array();
134
135/**
136 * Session variables
137 *
138 * @superglobal
139 **/
140$_SESSION = array();
141
142/**
143 * is the base class for all Exceptions.
144 **/
145class Exception extends Exception {
146    /**
147     * Returns the Exception code.
148     *
149     * @return int
150     * @since PHP 5 >= 5.1.0
151     **/
152    function getCode(){}
153
154    /**
155     * Get the name of the file the exception was thrown from.
156     *
157     * @return string
158     * @since PHP 5 >= 5.1.0
159     **/
160    function getFile(){}
161
162    /**
163     * Returns line number where the exception was thrown.
164     *
165     * @return int
166     * @since PHP 5 >= 5.1.0
167     **/
168    function getLine(){}
169
170    /**
171     * Returns the Exception message.
172     *
173     * @return string
174     * @since PHP 5 >= 5.1.0
175     **/
176    function getMessage(){}
177
178    /**
179     * Returns previous Exception (the third parameter of
180     * Exception::__construct).
181     *
182     * @return Exception
183     * @since PHP 5 >= 5.3.0
184     **/
185    function getPrevious(){}
186
187    /**
188     * Returns the Exception stack trace.
189     *
190     * @return array
191     * @since PHP 5 >= 5.1.0
192     **/
193    function getTrace(){}
194
195    /**
196     * Returns the Exception stack trace as a string.
197     *
198     * @return string
199     * @since PHP 5 >= 5.1.0
200     **/
201    function getTraceAsString(){}
202
203    /**
204     * Tries to clone the Exception, which results in Fatal error.
205     *
206     * @return void
207     * @since PHP 5 >= 5.1.0
208     **/
209    function __clone(){}
210
211    /**
212     * Returns the string representation of the exception.
213     *
214     * @return string
215     * @since PHP 5 >= 5.1.0
216     **/
217    function __toString(){}
218
219}
220/**
221 * Represents a connection to an AMQP broker.
222 **/
223class AMQPConnection {
224    /**
225     * This method will check whether the connection to the AMQP broker is
226     * still valid. It does so by checking the return status of the last
227     * command.
228     *
229     * @return void
230     * @since PECL amqp >= Unknown
231     **/
232    function isConnected(){}
233
234    /**
235     * Creates an AMQPConnection instance representing a connection to an
236     * AMQP broker.
237     *
238     * @param array $credentials The {@link credentials} is an optional
239     *   array of credential information for connecting to the AMQP broker.
240     *   The keys used in the {@link credentials} array are: host, port,
241     *   vhost, login and password. All other keys will be ignored. For each
242     *   missing credential, the extension will check the ini settings or use
243     *   the default value.
244     * @since PECL amqp >= Unknown
245     **/
246    function __construct($credentials){}
247
248}
249class AMQPConnectionException extends AMQPException {
250}
251class AMQPException extends Exception {
252}
253/**
254 * Represents an AMQP exchange.
255 **/
256class AMQPExchange {
257    /**
258     * Bind an exchange to a queue using the specified routing key.
259     *
260     * @param string $queue_name The name of the queue to which to bind.
261     * @param string $routing_key The routing key to use as a binding.
262     * @return void
263     * @since PECL amqp >= Unknown
264     **/
265    function bind($queue_name, $routing_key){}
266
267    /**
268     * Delete and exchange from the broker.
269     *
270     * @param string $exchange_name The name of the exchange to delete. If
271     *   the AMQPExchange object is already bound to an existing exchange and
272     *   then {@link exchange_name} is not specified, the exchange bound to
273     *   the AMQPExchange object will be deleted.
274     * @return void
275     * @since PECL amqp >= Unknown
276     **/
277    function delete($exchange_name){}
278
279    /**
280     * Publish a message to the exchange represented by the AMQPExchange
281     * object.
282     *
283     * @param string $message The message to publish.
284     * @param string $routing_key The routing key to which to publish.
285     * @return void
286     * @since PECL amqp >= Unknown
287     **/
288    function publish($message, $routing_key){}
289
290    /**
291     * Returns a new instance of an AMQPExchange object, associated with the
292     * given AMQPConnection object. If the {@link exchange_name} parameter is
293     * specified and the an exchange by that name exists on the broker, an
294     * instance of that specific exchange will be returned. Otherwise, the
295     * {@link exchange_name} is ignored.
296     *
297     * @param AMQPConnection $connection A valid AMQPConnection object,
298     *   connected to a broker.
299     * @param string $exchange_name The name of an existing exchange to
300     *   represent.
301     * @since PECL amqp >= Unknown
302     **/
303    function __construct($connection, $exchange_name){}
304
305}
306class AMQPExchangeException extends AMQPException {
307}
308/**
309 * Represents an AMQP queue.
310 **/
311class AMQPQueue {
312    /**
313     * This method allows the acknowledgement of a message that is retrieved
314     * with the AMQP_NOACK flag through AMQPQueue::get or AMQPQueue::consume
315     *
316     * @param int $delivery_tag The message delivery tag of which to
317     *   acknowledge receipt.
318     * @param int $flags The only valid flag that can be passed is
319     *   AMQP_MULTIPLE.
320     * @return void
321     **/
322    function ack($delivery_tag, $flags){}
323
324    /**
325     * The bind method will bind the given queue to the specified routing key
326     * on the given exchange.
327     *
328     * @param string $exchange_name The exchange name on which to bind.
329     * @param string $routing_key The routing key to which to bind.
330     * @return void
331     * @since PECL amqp >= Unknown
332     **/
333    function bind($exchange_name, $routing_key){}
334
335    /**
336     * Cancel a queue that is already bound to an exchange and routing key.
337     *
338     * @param string $consumer_tag The queue name to cancel, if the queue
339     *   object is not already representative of a queue.
340     * @return void
341     * @since PECL amqp >= Unknown
342     **/
343    function cancel($consumer_tag){}
344
345    /**
346     * @param string $num_messages
347     * @param string $flags
348     * @return void
349     * @since PECL amqp >= Unknown
350     **/
351    function consume($num_messages, $flags){}
352
353    /**
354     * Delete a queue from the broker, including its entire contents of
355     * unread or unacknowledged messages.
356     *
357     * @param string $queue_name The name of the queue to delete.
358     * @return void
359     * @since PECL amqp >= Unknown
360     **/
361    function delete($queue_name){}
362
363    /**
364     * Retrieve the next message from the queue.
365     *
366     * @param string $flags A bitmask of any of the flags: AMQP_NOACK.
367     * @return void
368     * @since PECL amqp >= Unknown
369     **/
370    function get($flags){}
371
372    /**
373     * Purge the contents of a queue.
374     *
375     * @param string $queue_name The name of the queue to purge
376     * @return void
377     * @since PECL amqp >= Unknown
378     **/
379    function purge($queue_name){}
380
381    /**
382     * Remove a routing key binding on an exchange from the given queue.
383     *
384     * @param string $exchange_name The name of the exchange on which the
385     *   queue is bound.
386     * @param string $routing_key The binding routing key used by the
387     *   queue.
388     * @return void
389     * @since PECL amqp >= Unknown
390     **/
391    function unbind($exchange_name, $routing_key){}
392
393    /**
394     * Creates an AMQPQueue instance representing an AMQP queue on the
395     * broker.
396     *
397     * @param string $amqp_connection A valid AMQPConnection object.
398     * @param string $queue_name The name of the queue to construct. If no
399     *   queue name is specified, the broker will generate one.
400     * @since PECL amqp >= Unknown
401     **/
402    function __construct($amqp_connection, $queue_name){}
403
404}
405class AMQPQueueException extends AMQPException {
406}
407/**
408 * The class makes it easier to iterate over large APC caches. This is
409 * helpful as it allows iterating over large caches in steps, while
410 * grabbing a defined number of entries per lock instance, so it frees
411 * the cache locks for other activities rather than hold up the entire
412 * cache to grab 100 (the default) entries. Also, using regular
413 * expression matching is more efficient as it's been moved to the C
414 * level.
415 **/
416class APCIterator implements Iterator, Traversable {
417    /**
418     * Gets the current item from the APCIterator stack.
419     *
420     * @return mixed
421     * @since PECL apc >= 3.1.1
422     **/
423    function current(){}
424
425    /**
426     * Get the total count.
427     *
428     * @return integer
429     * @since PECL apc >= 3.1.1
430     **/
431    function getTotalCount(){}
432
433    /**
434     * Gets the total number of cache hits.
435     *
436     * @return integer
437     * @since PECL apc >= 3.1.1
438     **/
439    function getTotalHits(){}
440
441    /**
442     * Gets the total cache size.
443     *
444     * @return int
445     * @since PECL apc >= 3.1.1
446     **/
447    function getTotalSize(){}
448
449    /**
450     * Gets the current iterator key.
451     *
452     * @return string
453     * @since PECL apc >= 3.1.1
454     **/
455    function key(){}
456
457    /**
458     * Moves the iterator pointer to the next element.
459     *
460     * @return void
461     * @since PECL apc >= 3.1.1
462     **/
463    function next(){}
464
465    /**
466     * Rewinds back the iterator to the first element.
467     *
468     * @return void
469     * @since PECL apc >= 3.1.1
470     **/
471    function rewind(){}
472
473    /**
474     * Checks if the current iterator position is valid.
475     *
476     * @return void
477     * @since PECL apc >= 3.1.1
478     **/
479    function valid(){}
480
481    /**
482     * Constructs an APCIterator object.
483     *
484     * @param string $cache The cache type, which will be user or file.
485     * @param mixed $search A PCRE regular expression that matches against
486     *   APC key names, either as a string for a single regular expression,
487     *   or as an array of regular expressions. Or, optionally pass in to
488     *   skip the search.
489     * @param int $format The desired format, as configured with one ore
490     *   more of the APC_ITER_* constants.
491     * @param int $chunk_size The chunk size. Must be a value greater than
492     *   0. The default value is 100.
493     * @param int $list The type to list. Either pass in APC_LIST_ACTIVE or
494     *   APC_LIST_INACTIVE.
495     * @since PECL apc >= 3.1.1
496     **/
497    function __construct($cache, $search, $format, $chunk_size, $list){}
498
499}
500/**
501 * Iterate over multiple collections.
502 **/
503class AppendIterator extends IteratorIterator implements OuterIterator, Traversable, Iterator {
504    /**
505     * Appends an iterator.
506     *
507     * @param Iterator $iterator The iterator to append.
508     * @return void
509     * @since PHP 5 >= 5.1.0
510     **/
511    function append($iterator){}
512
513    /**
514     * Gets the current value.
515     *
516     * @return void
517     * @since PHP 5 >= 5.1.0
518     **/
519    function current(){}
520
521    /**
522     * The getArrayIterator method
523     *
524     * @return void
525     * @since PHP 5 >= 5.1.0
526     **/
527    function getArrayIterator(){}
528
529    /**
530     * Get an inner iterator
531     *
532     * @return void
533     * @since PHP 5 >= 5.1.0
534     **/
535    function getInnerIterator(){}
536
537    /**
538     * Get an index of iterators.
539     *
540     * @return void
541     * @since PHP 5 >= 5.1.0
542     **/
543    function getIteratorIndex(){}
544
545    /**
546     * Get the current key
547     *
548     * @return void
549     * @since PHP 5 >= 5.1.0
550     **/
551    function key(){}
552
553    /**
554     * Moves to the next element. If this means to another Iterator then it
555     * rewinds that Iterator.
556     *
557     * @return void
558     * @since PHP 5 >= 5.1.0
559     **/
560    function next(){}
561
562    /**
563     * Rewind to the first element of the first inner Iterator.
564     *
565     * @return void
566     * @since PHP 5 >= 5.1.0
567     **/
568    function rewind(){}
569
570    /**
571     * Checks validity of the current element.
572     *
573     * @return void
574     * @since PHP 5 >= 5.1.0
575     **/
576    function valid(){}
577
578    /**
579     * Constructs an AppendIterator.
580     *
581     * @since PHP 5 >= 5.1.0
582     **/
583    function __construct(){}
584
585}
586/**
587 * Interface to provide accessing objects as arrays.
588 **/
589interface ArrayAccess {
590    /**
591     * Whether or not an offset exists.
592     *
593     * This method is executed when using {@link isset} or {@link empty} on
594     * objects implementing ArrayAccess.
595     *
596     * @param mixed $offset An offset to check for.
597     * @return boolean
598     * @since PHP 5 >= 5.1.0
599     **/
600    function offsetExists($offset);
601
602    /**
603     * Returns the value at specified offset.
604     *
605     * This method is executed when checking if offset is {@link empty}.
606     *
607     * @param mixed $offset The offset to retrieve.
608     * @return mixed
609     * @since PHP 5 >= 5.1.0
610     **/
611    function offsetGet($offset);
612
613    /**
614     * Assigns a value to the specified offset.
615     *
616     * @param mixed $offset The offset to assign the value to.
617     * @param mixed $value The value to set.
618     * @return void
619     * @since PHP 5 >= 5.1.0
620     **/
621    function offsetSet($offset, $value);
622
623    /**
624     * Unsets an offset.
625     *
626     * @param mixed $offset The offset to unset.
627     * @return void
628     * @since PHP 5 >= 5.1.0
629     **/
630    function offsetUnset($offset);
631
632}
633/**
634 * This iterator allows to unset and modify values and keys while
635 * iterating over Arrays and Objects.
636 *
637 * When you want to iterate over the same array multiple times you need
638 * to instantiate ArrayObject and let it create ArrayIterator instances
639 * that refer to it either by using or by calling its getIterator()
640 * method manually.
641 **/
642class ArrayIterator implements Iterator, Traversable, ArrayAccess, SeekableIterator, Countable {
643    /**
644     * Appends value as the last element.
645     *
646     * @param mixed $value The value to append.
647     * @return void
648     * @since PHP 5 >= 5.0.0
649     **/
650    function append($value){}
651
652    /**
653     * Sorts an array by values.
654     *
655     * @return void
656     * @since PHP 5 >= 5.2.0
657     **/
658    function asort(){}
659
660    /**
661     * Gets the number of elements in the array, or the number of public
662     * properties in the object.
663     *
664     * @return void
665     * @since PHP 5 >= 5.0.0
666     **/
667    function count(){}
668
669    /**
670     * Get the current array entry.
671     *
672     * @return mixed
673     * @since PHP 5 >= 5.0.0
674     **/
675    function current(){}
676
677    /**
678     * Get a copy of an array.
679     *
680     * @return array
681     * @since PHP 5 >= 5.0.0
682     **/
683    function getArrayCopy(){}
684
685    /**
686     * Get the current flags.
687     *
688     * @return void
689     * @since PHP 5 >= 5.1.0
690     **/
691    function getFlags(){}
692
693    /**
694     * This function returns the current array key
695     *
696     * @return mixed
697     * @since PHP 5 >= 5.0.0
698     **/
699    function key(){}
700
701    /**
702     * Sorts an array by the keys.
703     *
704     * @return void
705     * @since PHP 5 >= 5.2.0
706     **/
707    function ksort(){}
708
709    /**
710     * Sort the entries by values using a case insensitive "natural order"
711     * algorithm.
712     *
713     * @return void
714     * @since PHP 5 >= 5.2.0
715     **/
716    function natcasesort(){}
717
718    /**
719     * Sort the entries by values using "natural order" algorithm.
720     *
721     * @return void
722     * @since PHP 5 >= 5.2.0
723     **/
724    function natsort(){}
725
726    /**
727     * The iterator to the next entry.
728     *
729     * @return void
730     * @since PHP 5 >= 5.0.0
731     **/
732    function next(){}
733
734    /**
735     * Checks if the offset exists.
736     *
737     * @param string $index The offset being checked.
738     * @return void
739     * @since PHP 5 >= 5.0.0
740     **/
741    function offsetExists($index){}
742
743    /**
744     * Gets the value from the provided offset.
745     *
746     * @param string $index The offset to get the value from.
747     * @return mixed
748     * @since PHP 5 >= 5.0.0
749     **/
750    function offsetGet($index){}
751
752    /**
753     * Sets a value for a given offset.
754     *
755     * @param string $index The index to set for.
756     * @param string $newval The new value to store at the index.
757     * @return void
758     * @since PHP 5 >= 5.0.0
759     **/
760    function offsetSet($index, $newval){}
761
762    /**
763     * Unsets a value for an offset.
764     *
765     * @param string $index The offset to unset.
766     * @return void
767     * @since PHP 5 >= 5.0.0
768     **/
769    function offsetUnset($index){}
770
771    /**
772     * This rewinds the iterator to the beginning.
773     *
774     * @return void
775     * @since PHP 5 >= 5.0.0
776     **/
777    function rewind(){}
778
779    /**
780     * @param int $position The position to seek to.
781     * @return void
782     * @since PHP 5 >= 5.0.0
783     **/
784    function seek($position){}
785
786    /**
787     * Serialize.
788     *
789     * @return string
790     * @since PHP 5 >= 5.3.0
791     **/
792    function serialize(){}
793
794    /**
795     * Sets behaviour flags.
796     *
797     * @param string $flags A bitmask as follows: 0 = Properties of the
798     *   object have their normal functionality when accessed as list
799     *   (var_dump, foreach, etc.). 1 = Array indices can be accessed as
800     *   properties in read/write.
801     * @return void
802     * @since PHP 5 >= 5.1.0
803     **/
804    function setFlags($flags){}
805
806    /**
807     * Sort the entries by values using user defined function.
808     *
809     * @param string $cmp_function The compare function used for the sort.
810     * @return void
811     * @since PHP 5 >= 5.2.0
812     **/
813    function uasort($cmp_function){}
814
815    /**
816     * Sort the entries by key using user defined function.
817     *
818     * @param string $cmp_function The compare function used for the sort.
819     * @return void
820     * @since PHP 5 >= 5.2.0
821     **/
822    function uksort($cmp_function){}
823
824    /**
825     * Unserialize.
826     *
827     * @param string $serialized The serialized ArrayIterator object to be
828     *   unserialized.
829     * @return string
830     * @since PHP 5 >= 5.3.0
831     **/
832    function unserialize($serialized){}
833
834    /**
835     * Checks if the array contains any more entries.
836     *
837     * @return bool
838     * @since PHP 5 >= 5.0.0
839     **/
840    function valid(){}
841
842    /**
843     * Constructs an ArrayIterator object.
844     *
845     * @param mixed $array The array or object to be iterated on.
846     * @since PHP 5 >= 5.0.0
847     **/
848    function __construct($array){}
849
850}
851/**
852 * This class allows objects to work as arrays.
853 **/
854class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable {
855    /**
856     * Appends a new value as the last element.
857     *
858     * @param mixed $value The value being appended.
859     * @return void
860     * @since PHP 5 >= 5.0.0
861     **/
862    function append($value){}
863
864    /**
865     * Sorts the entries such that the keys maintain their correlation with
866     * the entries they are associated with. This is used mainly when sorting
867     * associative arrays where the actual element order is significant.
868     *
869     * @return void
870     * @since PHP 5 >= 5.2.0
871     **/
872    function asort(){}
873
874    /**
875     * Get the number of public properties in the ArrayObject.
876     *
877     * @return int
878     * @since PHP 5 >= 5.0.0
879     **/
880    function count(){}
881
882    /**
883     * Exchange the current array with another array or object.
884     *
885     * @param mixed $input The new array or object to exchange with the
886     *   current array.
887     * @return array
888     * @since PHP 5 >= 5.1.0
889     **/
890    function exchangeArray($input){}
891
892    /**
893     * Exports the ArrayObject to an array.
894     *
895     * @return array
896     * @since PHP 5 >= 5.0.0
897     **/
898    function getArrayCopy(){}
899
900    /**
901     * Gets the behavior flags of the ArrayObject. See the
902     * ArrayObject::setFlags method for a list of the available flags.
903     *
904     * @return int
905     * @since PHP 5 >= 5.1.0
906     **/
907    function getFlags(){}
908
909    /**
910     * Create a new iterator from an ArrayObject instance.
911     *
912     * @return ArrayIterator
913     * @since PHP 5 >= 5.0.0
914     **/
915    function getIterator(){}
916
917    /**
918     * Gets the class name of the array iterator that is used by
919     * ArrayObject::getIterator().
920     *
921     * @return string
922     * @since PHP 5 >= 5.1.0
923     **/
924    function getIteratorClass(){}
925
926    /**
927     * Sorts the entries by key, maintaining key to entry correlations. This
928     * is useful mainly for associative arrays.
929     *
930     * @return void
931     * @since PHP 5 >= 5.2.0
932     **/
933    function ksort(){}
934
935    /**
936     * This method is a case insensitive version of ArrayObject::natsort.
937     *
938     * This method implements a sort algorithm that orders alphanumeric
939     * strings in the way a human being would while maintaining key/value
940     * associations. This is described as a "natural ordering".
941     *
942     * @return void
943     * @since PHP 5 >= 5.2.0
944     **/
945    function natcasesort(){}
946
947    /**
948     * This method implements a sort algorithm that orders alphanumeric
949     * strings in the way a human being would while maintaining key/value
950     * associations. This is described as a "natural ordering". An example of
951     * the difference between this algorithm and the regular computer string
952     * sorting algorithms (used in ArrayObject::asort) method can be seen in
953     * the example below.
954     *
955     * @return void
956     * @since PHP 5 >= 5.2.0
957     **/
958    function natsort(){}
959
960    /**
961     * @param mixed $index The index being checked.
962     * @return bool
963     * @since PHP 5 >= 5.0.0
964     **/
965    function offsetExists($index){}
966
967    /**
968     * @param mixed $index The index with the value.
969     * @return mixed
970     * @since PHP 5 >= 5.0.0
971     **/
972    function offsetGet($index){}
973
974    /**
975     * Sets the value at the specified index to newval.
976     *
977     * @param mixed $index The index being set.
978     * @param mixed $newval The new value for the {@link index}.
979     * @return void
980     * @since PHP 5 >= 5.0.0
981     **/
982    function offsetSet($index, $newval){}
983
984    /**
985     * Unsets the value at the specified index.
986     *
987     * @param mixed $index The index being unset.
988     * @return void
989     * @since PHP 5 >= 5.0.0
990     **/
991    function offsetUnset($index){}
992
993    /**
994     * Serializes an ArrayObject.
995     *
996     * @return void
997     * @since PHP 5 >= 5.3.0
998     **/
999    function serialize(){}
1000
1001    /**
1002     * Set the flags that change the behavior of the ArrayObject.
1003     *
1004     * @param int $flags The new ArrayObject behavior. It takes on either a
1005     *   bitmask, or named constants. Using named constants is strongly
1006     *   encouraged to ensure compatibility for future versions. The
1007     *   available behavior flags are listed below. The actual meanings of
1008     *   these flags are described in the predefined constants. ArrayObject
1009     *   behavior flags value constant 1 ArrayObject::STD_PROP_LIST 2
1010     *   ArrayObject::ARRAY_AS_PROPS
1011     * @return void
1012     * @since PHP 5 >= 5.1.0
1013     **/
1014    function setFlags($flags){}
1015
1016    /**
1017     * Sets the classname of the array iterator that is used by
1018     * ArrayObject::getIterator().
1019     *
1020     * @param string $iterator_class The classname of the array iterator to
1021     *   use when iterating over this object.
1022     * @return void
1023     * @since PHP 5 >= 5.1.0
1024     **/
1025    function setIteratorClass($iterator_class){}
1026
1027    /**
1028     * This function sorts the entries such that keys maintain their
1029     * correlation with the entry that they are associated with, using a
1030     * user-defined comparison function.
1031     *
1032     * This is used mainly when sorting associative arrays where the actual
1033     * element order is significant.
1034     *
1035     * @param callback $cmp_function Function {@link cmp_function} should
1036     *   accept two parameters which will be filled by pairs of entries. The
1037     *   comparison function must return an integer less than, equal to, or
1038     *   greater than zero if the first argument is considered to be
1039     *   respectively less than, equal to, or greater than the second.
1040     * @return void
1041     * @since PHP 5 >= 5.2.0
1042     **/
1043    function uasort($cmp_function){}
1044
1045    /**
1046     * This function sorts the keys of the entries using a user-supplied
1047     * comparison function. The key to entry correlations will be maintained.
1048     *
1049     * @param callback $cmp_function The callback comparison function.
1050     *   Function {@link cmp_function} should accept two parameters which
1051     *   will be filled by pairs of entry keys. The comparison function must
1052     *   return an integer less than, equal to, or greater than zero if the
1053     *   first argument is considered to be respectively less than, equal to,
1054     *   or greater than the second.
1055     * @return void
1056     * @since PHP 5 >= 5.2.0
1057     **/
1058    function uksort($cmp_function){}
1059
1060    /**
1061     * Unserializes a serialized ArrayObject.
1062     *
1063     * @param string $serialized The serialized ArrayObject.
1064     * @return void
1065     * @since PHP 5 >= 5.3.0
1066     **/
1067    function unserialize($serialized){}
1068
1069}
1070/**
1071 * Exception thrown if a callback refers to an undefined function or if
1072 * some arguments are missing
1073 **/
1074class BadFunctionCallException extends LogicException {
1075}
1076/**
1077 * Exception thrown if a callback refers to an undefined method or if
1078 * some arguments are missing
1079 **/
1080class BadMethodCallException extends BadFunctionCallException {
1081}
1082/**
1083 * This object supports cached iteration over another iterator.
1084 **/
1085class CachingIterator extends IteratorIterator implements OuterIterator, Traversable, Iterator, ArrayAccess, Countable {
1086    const CALL_TOSTRING = 0;
1087    const CATCH_GET_CHILD = 0;
1088    /**
1089     * May return the number of elements in the iterator.
1090     *
1091     * @return void
1092     * @since PHP 5 >= 5.2.2
1093     **/
1094    function count(){}
1095
1096    /**
1097     * May return the current element in the iteration.
1098     *
1099     * @return void
1100     * @since PHP 5
1101     **/
1102    function current(){}
1103
1104    /**
1105     * @return void
1106     * @since PHP 5 >= 5.2.0
1107     **/
1108    function getCache(){}
1109
1110    /**
1111     * Get the bitmask of the flags used for this CachingIterator instance.
1112     *
1113     * @return void
1114     * @since PHP 5 >= 5.2.0
1115     **/
1116    function getFlags(){}
1117
1118    /**
1119     * Returns the iterator sent to the constructor.
1120     *
1121     * @return void
1122     * @since PHP 5
1123     **/
1124    function getInnerIterator(){}
1125
1126    /**
1127     * @return void
1128     * @since PHP 5
1129     **/
1130    function hasNext(){}
1131
1132    /**
1133     * This method may return a key for the current element.
1134     *
1135     * @return void
1136     * @since PHP 5
1137     **/
1138    function key(){}
1139
1140    /**
1141     * Move the iterator forward.
1142     *
1143     * @return void
1144     * @since PHP 5
1145     **/
1146    function next(){}
1147
1148    /**
1149     * @param string $index The index being checked.
1150     * @return void
1151     * @since PHP 5 >= 5.2.0
1152     **/
1153    function offsetExists($index){}
1154
1155    /**
1156     * @param string $index Description...
1157     * @return void
1158     * @since PHP 5 >= 5.2.0
1159     **/
1160    function offsetGet($index){}
1161
1162    /**
1163     * @param string $index The index of the element to be set.
1164     * @param string $newval The new value for the {@link index}.
1165     * @return void
1166     * @since PHP 5 >= 5.2.0
1167     **/
1168    function offsetSet($index, $newval){}
1169
1170    /**
1171     * @param string $index The index of the element to be unset.
1172     * @return void
1173     * @since PHP 5 >= 5.2.0
1174     **/
1175    function offsetUnset($index){}
1176
1177    /**
1178     * Rewind the iterator.
1179     *
1180     * @return void
1181     * @since PHP 5
1182     **/
1183    function rewind(){}
1184
1185    /**
1186     * Set the flags for the CachingIterator object.
1187     *
1188     * @param bitmask $flags Bitmask of the flags to set.
1189     * @return void
1190     * @since PHP 5 >= 5.2.0
1191     **/
1192    function setFlags($flags){}
1193
1194    /**
1195     * Check whether the current element is valid.
1196     *
1197     * @return void
1198     * @since PHP 5
1199     **/
1200    function valid(){}
1201
1202    /**
1203     * @param Iterator $iterator Iterator to cache
1204     * @param string $flags Bitmask of flags.
1205     * @since PHP 5
1206     **/
1207    function __construct($iterator, $flags){}
1208
1209    /**
1210     * Get the string representation of the current element.
1211     *
1212     * @return void
1213     * @since PHP 5
1214     **/
1215    function __toString(){}
1216
1217}
1218/**
1219 * Simple class with some static helper methods.
1220 **/
1221class Cairo {
1222    /**
1223     * Returns an array with the available font backends
1224     *
1225     * @return array
1226     * @since PECL cairo >= 0.1.0
1227     **/
1228    function availableFonts(){}
1229
1230    /**
1231     * Returns an array with the available surface backends
1232     *
1233     * @return array
1234     * @since PECL cairo >= 0.1.0
1235     **/
1236    function availableSurfaces(){}
1237
1238    /**
1239     * Retrieves the current status as a readable string
1240     *
1241     * @param int $status A valid status code given by {@link cairo_status}
1242     *   or CairoContext::status
1243     * @return string
1244     * @since PECL cairo >= 0.1.0
1245     **/
1246    function statusToString($status){}
1247
1248    /**
1249     * Retrieves the current version of the cairo library as an integer value
1250     *
1251     * @return int
1252     * @since PECL cairo >= 0.1.0
1253     **/
1254    function version(){}
1255
1256    /**
1257     * Retrieves the current cairo library version as a string.
1258     *
1259     * @return string
1260     * @since PECL cairo >= 0.1.0
1261     **/
1262    function versionString(){}
1263
1264}
1265/**
1266 * Enum class that specifies the type of antialiasing to do when
1267 * rendering text or shapes.
1268 **/
1269class CairoAntialias {
1270}
1271/**
1272 * is used to describe the content that a surface will contain, whether
1273 * color information, alpha information (translucence vs. opacity), or
1274 * both.
1275 *
1276 * Note: The large values here are designed to keep values distinct from
1277 * values so that the implementation can detect the error if users
1278 * confuse the two types.
1279 **/
1280class CairoContent {
1281}
1282/**
1283 * Context is the main object used when drawing with cairo. To draw with
1284 * cairo, you create a , set the target , and drawing options for the ,
1285 * create shapes with functions . like and , and then draw shapes with or
1286 * .
1287 *
1288 * Contexts can be pushed to a stack via . They may then safely be
1289 * changed, without loosing the current state. Use to restore to the
1290 * saved state.
1291 **/
1292class CairoContext {
1293    /**
1294     * Appends the {@link path} onto the current path. The {@link path} may
1295     * be either the return value from one of CairoContext::copyPath or
1296     * CairoContext::copyPathFlat;
1297     *
1298     * if {@link path} is not a valid CairoPath instance a CairoException
1299     * will be thrown
1300     *
1301     * @param CairoPath $path CairoContext object
1302     * @return void
1303     * @since PECL cairo >= 0.1.0
1304     **/
1305    function appendPath($path){}
1306
1307    /**
1308     * Adds a circular arc of the given radius to the current path. The arc
1309     * is centered at ({@link x}, {@link y}), begins at {@link angle1} and
1310     * proceeds in the direction of increasing angles to end at {@link
1311     * angle2}. If {@link angle2} is less than {@link angle1} it will be
1312     * progressively increased by 2*M_PI until it is greater than {@link
1313     * angle1}. If there is a current point, an initial line segment will be
1314     * added to the path to connect the current point to the beginning of the
1315     * arc. If this initial line is undesired, it can be avoided by calling
1316     * CairoContext::newSubPath or procedural {@link cairo_new_sub_path}
1317     * before calling CairoContext::arc or {@link cairo_arc}.
1318     *
1319     * Angles are measured in radians. An angle of 0.0 is in the direction of
1320     * the positive X axis (in user space). An angle of M_PI/2.0 radians (90
1321     * degrees) is in the direction of the positive Y axis (in user space).
1322     * Angles increase in the direction from the positive X axis toward the
1323     * positive Y axis. So with the default transformation matrix, angles
1324     * increase in a clockwise direction.
1325     *
1326     * (To convert from degrees to radians, use degrees * (M_PI / 180.).)
1327     * This function gives the arc in the direction of increasing angles; see
1328     * CairoContext::arcNegative or {@link cairo_arc_negative} to get the arc
1329     * in the direction of decreasing angles.
1330     *
1331     * @param float $x A valid CairoContext object
1332     * @param float $y x position
1333     * @param float $radius y position
1334     * @param float $angle1 Radius of the arc
1335     * @param float $angle2 start angle
1336     * @return void
1337     * @since PECL cairo >= 0.1.0
1338     **/
1339    function arc($x, $y, $radius, $angle1, $angle2){}
1340
1341    /**
1342     * Adds a circular arc of the given {@link radius} to the current path.
1343     * The arc is centered at ({@link x}, {@link y}), begins at {@link
1344     * angle1} and proceeds in the direction of decreasing angles to end at
1345     * {@link angle2}. If {@link angle2} is greater than {@link angle1} it
1346     * will be progressively decreased by 2*M_PI until it is less than {@link
1347     * angle1}.
1348     *
1349     * See CairoContext::arc or {@link cairo_arc} for more details. This
1350     * function differs only in the direction of the arc between the two
1351     * angles.
1352     *
1353     * @param float $x A valid CairoContext object
1354     * @param float $y double x position
1355     * @param float $radius double y position
1356     * @param float $angle1 The radius of the desired negative arc
1357     * @param float $angle2 Start angle of the arc
1358     * @return void
1359     * @since PECL cairo >= 0.1.0
1360     **/
1361    function arcNegative($x, $y, $radius, $angle1, $angle2){}
1362
1363    /**
1364     * Establishes a new clip region by intersecting the current clip region
1365     * with the current path as it would be filled by CairoContext::fill or
1366     * {@link cairo_fill} and according to the current fill rule (see
1367     * CairoContext::setFillRule or {@link cairo_set_fill_rule}).
1368     *
1369     * After CairoContext::clip or {@link cairo_clip}, the current path will
1370     * be cleared from the cairo context.
1371     *
1372     * The current clip region affects all drawing operations by effectively
1373     * masking out any changes to the surface that are outside the current
1374     * clip region.
1375     *
1376     * Calling CairoContext::clip or {@link cairo_clip} can only make the
1377     * clip region smaller, never larger. But the current clip is part of the
1378     * graphics state, so a temporary restriction of the clip region can be
1379     * achieved by calling CairoContext::clip or {@link cairo_clip} within a
1380     * CairoContext::save/CairoContext::restore or {@link cairo_save}/{@link
1381     * cairo_restore} pair. The only other means of increasing the size of
1382     * the clip region is CairoContext::resetClip or procedural {@link
1383     * cairo_reset_clip}.
1384     *
1385     * @return void
1386     * @since PECL cairo >= 0.1.0
1387     **/
1388    function clip(){}
1389
1390    /**
1391     * Computes a bounding box in user coordinates covering the area inside
1392     * the current clip.
1393     *
1394     * @return array
1395     * @since PECL cairo >= 0.1.0
1396     **/
1397    function clipExtents(){}
1398
1399    /**
1400     * Establishes a new clip region by intersecting the current clip region
1401     * with the current path as it would be filled by Context.fill and
1402     * according to the current FILL RULE (see CairoContext::setFillRule or
1403     * {@link cairo_set_fill_rule}).
1404     *
1405     * Unlike CairoContext::clip, CairoContext::clipPreserve preserves the
1406     * path within the Context. The current clip region affects all drawing
1407     * operations by effectively masking out any changes to the surface that
1408     * are outside the current clip region.
1409     *
1410     * Calling CairoContext::clipPreserve can only make the clip region
1411     * smaller, never larger. But the current clip is part of the graphics
1412     * state, so a temporary restriction of the clip region can be achieved
1413     * by calling CairoContext::clipPreserve within a
1414     * CairoContext::save/CairoContext::restore pair. The only other means of
1415     * increasing the size of the clip region is CairoContext::resetClip.
1416     *
1417     * @return void
1418     * @since PECL cairo >= 0.1.0
1419     **/
1420    function clipPreserve(){}
1421
1422    /**
1423     * Returns a list-type array with the current clip region as a list of
1424     * rectangles in user coordinates
1425     *
1426     * @return array
1427     * @since PECL cairo >= 0.1.0
1428     **/
1429    function clipRectangleList(){}
1430
1431    /**
1432     * Adds a line segment to the path from the current point to the
1433     * beginning of the current sub-path, (the most recent point passed to
1434     * CairoContext::moveTo), and closes this sub-path. After this call the
1435     * current point will be at the joined endpoint of the sub-path.
1436     *
1437     * The behavior of close_path() is distinct from simply calling
1438     * CairoContext::lineTo with the equivalent coordinate in the case of
1439     * stroking. When a closed sub-path is stroked, there are no caps on the
1440     * ends of the sub-path. Instead, there is a line join connecting the
1441     * final and initial segments of the sub-path.
1442     *
1443     * If there is no current point before the call to
1444     * CairoContext::closePath, this function will have no effect.
1445     *
1446     * @return void
1447     * @since PECL cairo >= 0.1.0
1448     **/
1449    function closePath(){}
1450
1451    /**
1452     * Emits the current page for backends that support multiple pages, but
1453     * doesn’t clear it, so, the contents of the current page will be
1454     * retained for the next page too. Use CairoContext::showPage if you want
1455     * to get an empty page after the emission.
1456     *
1457     * This is a convenience function that simply calls
1458     * CairoSurface::copyPage on CairoContext’s target.
1459     *
1460     * @return void
1461     * @since PECL cairo >= 0.1.0
1462     **/
1463    function copyPage(){}
1464
1465    /**
1466     * Creates a copy of the current path and returns it to the user as a
1467     * CairoPath. See CairoPath for hints on how to iterate over the returned
1468     * data structure.
1469     *
1470     * This function will always return a valid CairoPath object, but the
1471     * result will have no data, if either of the following conditions hold:
1472     * 1. If there is insufficient memory to copy the path. In this case
1473     * CairoPath->status will be set to CAIRO_STATUS_NO_MEMORY. 2. If {@link
1474     * context} is already in an error state. In this case CairoPath->status
1475     * will contain the same status that would be returned by {@link
1476     * cairo_status}.
1477     *
1478     * In either case, CairoPath->status will be set to
1479     * CAIRO_STATUS_NO_MEMORY (regardless of what the error status in cr
1480     * might have been).
1481     *
1482     * @return CairoPath
1483     * @since PECL cairo >= 0.1.0
1484     **/
1485    function copyPath(){}
1486
1487    /**
1488     * A CairoContext object
1489     *
1490     * @return CairoPath
1491     * @since PECL cairo >= 0.1.0
1492     **/
1493    function copyPathFlat(){}
1494
1495    /**
1496     * Adds a cubic Bezier spline to the path from the current point to
1497     * position {@link x3} ,{@link y3} in user-space coordinates, using
1498     * {@link x1}, {@link y1} and {@link x2}, {@link y2} as the control
1499     * points. After this call the current point will be {@link x3}, {@link
1500     * y3}.
1501     *
1502     * If there is no current point before the call to CairoContext::curveTo
1503     * this function will behave as if preceded by a call to
1504     * CairoContext::moveTo ({@link x1}, {@link y1}).
1505     *
1506     * @param float $x1 A valid CairoContext object created with
1507     *   CairoContext::__construct or {@link cairo_create}
1508     * @param float $y1 First control point in the x axis for the curve
1509     * @param float $x2 First control point in the y axis for the curve
1510     * @param float $y2 Second control point in x axis for the curve
1511     * @param float $x3 Second control point in y axis for the curve
1512     * @param float $y3 Final point in the x axis for the curve
1513     * @return void
1514     * @since PECL cairo >= 0.1.0
1515     **/
1516    function curveTo($x1, $y1, $x2, $y2, $x3, $y3){}
1517
1518    /**
1519     * Transform a coordinate from device space to user space by multiplying
1520     * the given point by the inverse of the current transformation matrix
1521     * (CTM).
1522     *
1523     * @param float $x A valid CairoContext object created with
1524     *   CairoContext::__construct or {@link cairo_create}
1525     * @param float $y x value of the coordinate
1526     * @return array
1527     * @since PECL cairo >= 0.1.0
1528     **/
1529    function deviceToUser($x, $y){}
1530
1531    /**
1532     * Transform a distance vector from device space to user space. This
1533     * function is similar to CairoContext::deviceToUser or {@link
1534     * cairo_device_to_user} except that the translation components of the
1535     * inverse Cairo Transformation Matrix will be ignored when transforming
1536     * ({@link x},{@link y}).
1537     *
1538     * @param float $x A valid CairoContext object created with
1539     *   CairoContext::__construct or {@link cairo_create}
1540     * @param float $y X component of a distance vector
1541     * @return array
1542     * @since PECL cairo >= 0.1.0
1543     **/
1544    function deviceToUserDistance($x, $y){}
1545
1546    /**
1547     * A drawing operator that fills the current path according to the
1548     * current CairoFillRule, (each sub-path is implicitly closed before
1549     * being filled). After CairoContext::fill or {@link cairo_fill}, the
1550     * current path will be cleared from the CairoContext.
1551     *
1552     * @return void
1553     * @since PECL cairo >= 0.1.0
1554     **/
1555    function fill(){}
1556
1557    /**
1558     * Computes a bounding box in user coordinates covering the area that
1559     * would be affected, (the “inked” area), by a CairoContext::fill
1560     * operation given the current path and fill parameters. If the current
1561     * path is empty, returns an empty rectangle (0,0,0,0). Surface
1562     * dimensions and clipping are not taken into account.
1563     *
1564     * Contrast with CairoContext::pathExtents, which is similar, but returns
1565     * non-zero extents for some paths with no inked area, (such as a simple
1566     * line segment).
1567     *
1568     * Note that CairoContext::fillExtents must necessarily do more work to
1569     * compute the precise inked areas in light of the fill rule, so
1570     * CairoContext::pathExtents may be more desirable for sake of
1571     * performance if the non-inked path extents are desired.
1572     *
1573     * @return array
1574     * @since PECL cairo >= 0.1.0
1575     **/
1576    function fillExtents(){}
1577
1578    /**
1579     * A drawing operator that fills the current path according to the
1580     * current CairoFillRule, (each sub-path is implicitly closed before
1581     * being filled). Unlike CairoContext::fill, CairoContext::fillPreserve
1582     * (Procedural {@link cairo_fill}, {@link cairo_fill_preserve},
1583     * respectively) preserves the path within the Context.
1584     *
1585     * @return void
1586     * @since PECL cairo >= 0.1.0
1587     **/
1588    function fillPreserve(){}
1589
1590    /**
1591     * Gets the font extents for the currently selected font.
1592     *
1593     * @return array
1594     * @since PECL cairo >= 0.1.0
1595     **/
1596    function fontExtents(){}
1597
1598    /**
1599     * Returns the current CairoAntialias mode, as set by
1600     * CairoContext::setAntialias.
1601     *
1602     * @return int
1603     * @since PECL cairo >= 0.1.0
1604     **/
1605    function getAntialias(){}
1606
1607    /**
1608     * Gets the current point of the current path, which is conceptually the
1609     * final point reached by the path so far.
1610     *
1611     * The current point is returned in the user-space coordinate system. If
1612     * there is no defined current point or if cr is in an error status, x
1613     * and y will both be set to 0.0. It is possible to check this in advance
1614     * with CairoContext::hasCurrentPoint.
1615     *
1616     * Most path construction functions alter the current point. See the
1617     * following for details on how they affect the current point:
1618     * CairoContext::newPath, CairoContext::newSubPath,
1619     * CairoContext::appendPath, CairoContext::closePath,
1620     * CairoContext::moveTo, CairoContext::lineTo, CairoContext::curveTo,
1621     * CairoContext::relMoveTo, CairoContext::relLineTo,
1622     * CairoContext::relCurveTo, CairoContext::arc,
1623     * CairoContext::arcNegative, CairoContext::rectangle,
1624     * CairoContext::textPath, CairoContext::glyphPath.
1625     *
1626     * Some functions use and alter the current point but do not otherwise
1627     * change current path: CairoContext::showText.
1628     *
1629     * Some functions unset the current path and as a result, current point:
1630     * CairoContext::fill, CairoContext::stroke.
1631     *
1632     * @return array
1633     * @since PECL cairo >= 0.1.0
1634     **/
1635    function getCurrentPoint(){}
1636
1637    /**
1638     * Description here.
1639     *
1640     * @return array
1641     * @since PECL cairo >= 0.1.0
1642     **/
1643    function getDash(){}
1644
1645    /**
1646     * Description here.
1647     *
1648     * @return int
1649     * @since PECL cairo >= 0.1.0
1650     **/
1651    function getDashCount(){}
1652
1653    /**
1654     * Description here.
1655     *
1656     * @return int
1657     * @since PECL cairo >= 0.1.0
1658     **/
1659    function getFillRule(){}
1660
1661    /**
1662     * Description here.
1663     *
1664     * @return void
1665     * @since PECL cairo >= 0.1.0
1666     **/
1667    function getFontFace(){}
1668
1669    /**
1670     * Description here.
1671     *
1672     * @return void
1673     * @since PECL cairo >= 0.1.0
1674     **/
1675    function getFontMatrix(){}
1676
1677    /**
1678     * Description here.
1679     *
1680     * @return void
1681     * @since PECL cairo >= 0.1.0
1682     **/
1683    function getFontOptions(){}
1684
1685    /**
1686     * Description here.
1687     *
1688     * @return void
1689     * @since PECL cairo >= 0.1.0
1690     **/
1691    function getGroupTarget(){}
1692
1693    /**
1694     * Description here.
1695     *
1696     * @return int
1697     * @since PECL cairo >= 0.1.0
1698     **/
1699    function getLineCap(){}
1700
1701    /**
1702     * Description here.
1703     *
1704     * @return int
1705     * @since PECL cairo >= 0.1.0
1706     **/
1707    function getLineJoin(){}
1708
1709    /**
1710     * Description here.
1711     *
1712     * @return float
1713     * @since PECL cairo >= 0.1.0
1714     **/
1715    function getLineWidth(){}
1716
1717    /**
1718     * Description here.
1719     *
1720     * @return void
1721     * @since PECL cairo >= 0.1.0
1722     **/
1723    function getMatrix(){}
1724
1725    /**
1726     * Description here.
1727     *
1728     * @return float
1729     * @since PECL cairo >= 0.1.0
1730     **/
1731    function getMiterLimit(){}
1732
1733    /**
1734     * Description here.
1735     *
1736     * @return int
1737     * @since PECL cairo >= 0.1.0
1738     **/
1739    function getOperator(){}
1740
1741    /**
1742     * Description here.
1743     *
1744     * @return void
1745     * @since PECL cairo >= 0.1.0
1746     **/
1747    function getScaledFont(){}
1748
1749    /**
1750     * Description here.
1751     *
1752     * @return void
1753     * @since PECL cairo >= 0.1.0
1754     **/
1755    function getSource(){}
1756
1757    /**
1758     * Description here.
1759     *
1760     * @return void
1761     * @since PECL cairo >= 0.1.0
1762     **/
1763    function getTarget(){}
1764
1765    /**
1766     * Description here.
1767     *
1768     * @return float
1769     * @since PECL cairo >= 0.1.0
1770     **/
1771    function getTolerance(){}
1772
1773    /**
1774     * Description here.
1775     *
1776     * @param array $glyphs Description...
1777     * @return void
1778     * @since PECL cairo >= 0.1.0
1779     **/
1780    function glyphPath($glyphs){}
1781
1782    /**
1783     * Returns whether a current point is defined on the current path. See
1784     * CairoContext::getCurrentPoint for details on the current point.
1785     *
1786     * @return bool
1787     * @since PECL cairo >= 0.1.0
1788     **/
1789    function hasCurrentPoint(){}
1790
1791    /**
1792     * Description here.
1793     *
1794     * @return void
1795     * @since PECL cairo >= 0.1.0
1796     **/
1797    function identityMatrix(){}
1798
1799    /**
1800     * Description here.
1801     *
1802     * @param string $x Description...
1803     * @param string $y Description...
1804     * @return bool
1805     * @since PECL cairo >= 0.1.0
1806     **/
1807    function inFill($x, $y){}
1808
1809    /**
1810     * Description here.
1811     *
1812     * @param string $x Description...
1813     * @param string $y Description...
1814     * @return bool
1815     * @since PECL cairo >= 0.1.0
1816     **/
1817    function inStroke($x, $y){}
1818
1819    /**
1820     * Description here.
1821     *
1822     * @param string $x Description...
1823     * @param string $y Description...
1824     * @return void
1825     * @since PECL cairo >= 0.1.0
1826     **/
1827    function lineTo($x, $y){}
1828
1829    /**
1830     * Description here.
1831     *
1832     * @param string $pattern Description...
1833     * @return void
1834     * @since PECL cairo >= 0.1.0
1835     **/
1836    function mask($pattern){}
1837
1838    /**
1839     * Description here.
1840     *
1841     * @param string $surface Description...
1842     * @param string $x Description...
1843     * @param string $y Description...
1844     * @return void
1845     * @since PECL cairo >= 0.1.0
1846     **/
1847    function maskSurface($surface, $x, $y){}
1848
1849    /**
1850     * Begin a new sub-path. After this call the current point will be (x,
1851     * y).
1852     *
1853     * @param string $x A valid CairoContext object.
1854     * @param string $y The x coordinate of the new position.
1855     * @return void
1856     * @since PECL cairo >= 0.1.0
1857     **/
1858    function moveTo($x, $y){}
1859
1860    /**
1861     * Clears the current path. After this call there will be no path and no
1862     * current point.
1863     *
1864     * @return void
1865     * @since PECL cairo >= 0.1.0
1866     **/
1867    function newPath(){}
1868
1869    /**
1870     * Description here.
1871     *
1872     * @return void
1873     * @since PECL cairo >= 0.1.0
1874     **/
1875    function newSubPath(){}
1876
1877    /**
1878     * Description here.
1879     *
1880     * @return void
1881     * @since PECL cairo >= 0.1.0
1882     **/
1883    function paint(){}
1884
1885    /**
1886     * Description here.
1887     *
1888     * @param string $alpha Description...
1889     * @return void
1890     * @since PECL cairo >= 0.1.0
1891     **/
1892    function paintWithAlpha($alpha){}
1893
1894    /**
1895     * Description here.
1896     *
1897     * @return array
1898     * @since PECL cairo >= 0.1.0
1899     **/
1900    function pathExtents(){}
1901
1902    /**
1903     * Description here.
1904     *
1905     * @return void
1906     * @since PECL cairo >= 0.1.0
1907     **/
1908    function popGroup(){}
1909
1910    /**
1911     * Description here.
1912     *
1913     * @return void
1914     * @since PECL cairo >= 0.1.0
1915     **/
1916    function popGroupToSource(){}
1917
1918    /**
1919     * Description here.
1920     *
1921     * @return void
1922     * @since PECL cairo >= 0.1.0
1923     **/
1924    function pushGroup(){}
1925
1926    /**
1927     * Description here.
1928     *
1929     * @param string $content Description...
1930     * @return void
1931     * @since PECL cairo >= 0.1.0
1932     **/
1933    function pushGroupWithContent($content){}
1934
1935    /**
1936     * Description here.
1937     *
1938     * @param string $x Description...
1939     * @param string $y Description...
1940     * @param string $width Description...
1941     * @param string $height Description...
1942     * @return void
1943     * @since PECL cairo >= 0.1.0
1944     **/
1945    function rectangle($x, $y, $width, $height){}
1946
1947    /**
1948     * Description here.
1949     *
1950     * @param string $x1 Description...
1951     * @param string $y1 Description...
1952     * @param string $x2 Description...
1953     * @param string $y2 Description...
1954     * @param string $x3 Description...
1955     * @param string $y3 Description...
1956     * @return void
1957     * @since PECL cairo >= 0.1.0
1958     **/
1959    function relCurveTo($x1, $y1, $x2, $y2, $x3, $y3){}
1960
1961    /**
1962     * Description here.
1963     *
1964     * @param string $x Description...
1965     * @param string $y Description...
1966     * @return void
1967     * @since PECL cairo >= 0.1.0
1968     **/
1969    function relLineTo($x, $y){}
1970
1971    /**
1972     * Description here.
1973     *
1974     * @param string $x Description...
1975     * @param string $y Description...
1976     * @return void
1977     * @since PECL cairo >= 0.1.0
1978     **/
1979    function relMoveTo($x, $y){}
1980
1981    /**
1982     * Description here.
1983     *
1984     * @return void
1985     * @since PECL cairo >= 0.1.0
1986     **/
1987    function resetClip(){}
1988
1989    /**
1990     * Description here.
1991     *
1992     * @return void
1993     * @since PECL cairo >= 0.1.0
1994     **/
1995    function restore(){}
1996
1997    /**
1998     * Description here.
1999     *
2000     * @param string $angle Description...
2001     * @return void
2002     * @since PECL cairo >= 0.1.0
2003     **/
2004    function rotate($angle){}
2005
2006    /**
2007     * Description here.
2008     *
2009     * @return void
2010     * @since PECL cairo >= 0.1.0
2011     **/
2012    function save(){}
2013
2014    /**
2015     * Description here.
2016     *
2017     * @param string $x Description...
2018     * @param string $y Description...
2019     * @return void
2020     * @since PECL cairo >= 0.1.0
2021     **/
2022    function scale($x, $y){}
2023
2024    /**
2025     * Description here.
2026     *
2027     * @param string $family Description...
2028     * @param string $slant Description...
2029     * @param string $weight Description...
2030     * @return void
2031     * @since PECL cairo >= 0.1.0
2032     **/
2033    function selectFontFace($family, $slant, $weight){}
2034
2035    /**
2036     * Description here.
2037     *
2038     * @param string $antialias Description...
2039     * @return void
2040     * @since PECL cairo >= 0.1.0
2041     **/
2042    function setAntialias($antialias){}
2043
2044    /**
2045     * Description here.
2046     *
2047     * @param string $dashes Description...
2048     * @param string $offset Description...
2049     * @return void
2050     * @since PECL cairo >= 0.1.0
2051     **/
2052    function setDash($dashes, $offset){}
2053
2054    /**
2055     * Description here.
2056     *
2057     * @param string $setting Description...
2058     * @return void
2059     * @since PECL cairo >= 0.1.0
2060     **/
2061    function setFillRule($setting){}
2062
2063    /**
2064     * Sets the font-face for a given context.
2065     *
2066     * @param CairoFontFace $fontface A CairoContext object to change the
2067     *   font-face for.
2068     * @return void
2069     * @since PECL cairo >= 0.1.0
2070     **/
2071    function setFontFace($fontface){}
2072
2073    /**
2074     * Description here.
2075     *
2076     * @param string $matrix Description...
2077     * @return void
2078     * @since PECL cairo >= 0.1.0
2079     **/
2080    function setFontMatrix($matrix){}
2081
2082    /**
2083     * Description here.
2084     *
2085     * @param string $fontoptions Description...
2086     * @return void
2087     * @since PECL cairo >= 0.1.0
2088     **/
2089    function setFontOptions($fontoptions){}
2090
2091    /**
2092     * Description here.
2093     *
2094     * @param string $size Description...
2095     * @return void
2096     * @since PECL cairo >= 0.1.0
2097     **/
2098    function setFontSize($size){}
2099
2100    /**
2101     * Description here.
2102     *
2103     * @param string $setting Description...
2104     * @return void
2105     * @since PECL cairo >= 0.1.0
2106     **/
2107    function setLineCap($setting){}
2108
2109    /**
2110     * Description here.
2111     *
2112     * @param string $setting Description...
2113     * @return void
2114     * @since PECL cairo >= 0.1.0
2115     **/
2116    function setLineJoin($setting){}
2117
2118    /**
2119     * Description here.
2120     *
2121     * @param string $width Description...
2122     * @return void
2123     * @since PECL cairo >= 0.1.0
2124     **/
2125    function setLineWidth($width){}
2126
2127    /**
2128     * Description here.
2129     *
2130     * @param string $matrix Description...
2131     * @return void
2132     * @since PECL cairo >= 0.1.0
2133     **/
2134    function setMatrix($matrix){}
2135
2136    /**
2137     * Description here.
2138     *
2139     * @param string $limit Description...
2140     * @return void
2141     * @since PECL cairo >= 0.1.0
2142     **/
2143    function setMiterLimit($limit){}
2144
2145    /**
2146     * Description here.
2147     *
2148     * @param string $setting Description...
2149     * @return void
2150     * @since PECL cairo >= 0.1.0
2151     **/
2152    function setOperator($setting){}
2153
2154    /**
2155     * Description here.
2156     *
2157     * @param string $scaledfont Description...
2158     * @return void
2159     * @since PECL cairo >= 0.1.0
2160     **/
2161    function setScaledFont($scaledfont){}
2162
2163    /**
2164     * Description here.
2165     *
2166     * @param string $pattern Description...
2167     * @return void
2168     * @since PECL cairo >= 0.1.0
2169     **/
2170    function setSource($pattern){}
2171
2172    /**
2173     * Description here.
2174     *
2175     * @param string $red Description...
2176     * @param string $green Description...
2177     * @param string $blue Description...
2178     * @return void
2179     * @since PECL cairo >= 0.1.0
2180     **/
2181    function setSourceRGB($red, $green, $blue){}
2182
2183    /**
2184     * Description here.
2185     *
2186     * @param string $red Description...
2187     * @param string $green Description...
2188     * @param string $blue Description...
2189     * @param string $alpha Description...
2190     * @return void
2191     * @since PECL cairo >= 0.1.0
2192     **/
2193    function setSourceRGBA($red, $green, $blue, $alpha){}
2194
2195    /**
2196     * Description here.
2197     *
2198     * @param string $surface Description...
2199     * @param string $x Description...
2200     * @param string $y Description...
2201     * @return void
2202     * @since PECL cairo >= 0.1.0
2203     **/
2204    function setSourceSurface($surface, $x, $y){}
2205
2206    /**
2207     * Description here.
2208     *
2209     * @param string $tolerance Description...
2210     * @return void
2211     * @since PECL cairo >= 0.1.0
2212     **/
2213    function setTolerance($tolerance){}
2214
2215    /**
2216     * Description here.
2217     *
2218     * @return void
2219     * @since PECL cairo >= 0.1.0
2220     **/
2221    function showPage(){}
2222
2223    /**
2224     * Description here.
2225     *
2226     * @param string $text Description...
2227     * @return void
2228     * @since PECL cairo >= 0.1.0
2229     **/
2230    function showText($text){}
2231
2232    /**
2233     * Description here.
2234     *
2235     * @return int
2236     * @since PECL cairo >= 0.1.0
2237     **/
2238    function status(){}
2239
2240    /**
2241     * Description here.
2242     *
2243     * @return void
2244     * @since PECL cairo >= 0.1.0
2245     **/
2246    function stroke(){}
2247
2248    /**
2249     * Description here.
2250     *
2251     * @return array
2252     * @since PECL cairo >= 0.1.0
2253     **/
2254    function strokeExtents(){}
2255
2256    /**
2257     * Description here.
2258     *
2259     * @return void
2260     * @since PECL cairo >= 0.1.0
2261     **/
2262    function strokePreserve(){}
2263
2264    /**
2265     * Description here.
2266     *
2267     * @param string $text Description...
2268     * @return array
2269     * @since PECL cairo >= 0.1.0
2270     **/
2271    function textExtents($text){}
2272
2273    /**
2274     * Description here.
2275     *
2276     * @param string $string Description...
2277     * @return void
2278     * @since PECL cairo >= 0.1.0
2279     **/
2280    function textPath($string){}
2281
2282    /**
2283     * Description here.
2284     *
2285     * @param string $matrix Description...
2286     * @return void
2287     * @since PECL cairo >= 0.1.0
2288     **/
2289    function transform($matrix){}
2290
2291    /**
2292     * Description here.
2293     *
2294     * @param string $x Description...
2295     * @param string $y Description...
2296     * @return void
2297     * @since PECL cairo >= 0.1.0
2298     **/
2299    function translate($x, $y){}
2300
2301    /**
2302     * Description here.
2303     *
2304     * @param string $x Description...
2305     * @param string $y Description...
2306     * @return array
2307     * @since PECL cairo >= 0.1.0
2308     **/
2309    function userToDevice($x, $y){}
2310
2311    /**
2312     * Description here.
2313     *
2314     * @param string $x Description...
2315     * @param string $y Description...
2316     * @return array
2317     * @since PECL cairo >= 0.1.0
2318     **/
2319    function userToDeviceDistance($x, $y){}
2320
2321    /**
2322     * Creates a new CairoContext object to draw
2323     *
2324     * @param CairoSurface $surface A valid CairoSurface like
2325     *   CairoImageSurface or CairoPdfSurface
2326     * @since PECL cairo >= 0.1.0
2327     **/
2328    function __construct($surface){}
2329
2330}
2331/**
2332 * class throwed by functions and methods
2333 **/
2334class CairoException extends Exception {
2335}
2336/**
2337 * Description of the class.
2338 **/
2339class CairoExtend {
2340}
2341/**
2342 * A is used to select how paths are filled. For both fill rules, whether
2343 * or not a point is included in the fill is determined by taking a ray
2344 * from that point to infinity and looking at intersections with the
2345 * path. The ray can be in any direction, as long as it doesn't pass
2346 * through the end point of a segment or have a tricky intersection such
2347 * as intersecting tangent to the path. (Note that filling is not
2348 * actually implemented in this way. This is just a description of the
2349 * rule that is applied.)
2350 *
2351 * The default fill rule is .
2352 **/
2353class CairoFillRule {
2354}
2355/**
2356 * A is used to indicate what filtering should be applied when reading
2357 * pixel values from patterns. See or for indicating the desired filter
2358 * to be used with a particular pattern.
2359 **/
2360class CairoFilter {
2361}
2362/**
2363 * CairoFontFace abstract class represents a particular font at a
2364 * particular weight, slant, and other characteristic but no
2365 * transformation or size.
2366 *
2367 * Note: This class can not be instantiated directly, it is created by or
2368 * .
2369 **/
2370class CairoFontFace {
2371    /**
2372     * This function returns the type of the backend used to create a font
2373     * face. See CairoFontType class constants for available types.
2374     *
2375     * @return int
2376     * @since PECL cairo >= 0.1.0
2377     **/
2378    function getType(){}
2379
2380    /**
2381     * Checks whether an error has previously occurred for this font face
2382     *
2383     * @return int
2384     * @since PECL cairo >= 0.1.0
2385     **/
2386    function status(){}
2387
2388    /**
2389     * CairoFontFace class represents a particular font at a particular
2390     * weight, slant, and other characteristic but no transformation or size.
2391     *
2392     * Note: This class can't be instantiated directly it is created by
2393     * CairoContext::getFontFace or {@link cairo_scaled_font_get_font_face}
2394     *
2395     * @since PECL cairo >= 0.1.0
2396     **/
2397    function __construct(){}
2398
2399}
2400/**
2401 * An opaque structure holding all options that are used when rendering
2402 * fonts.
2403 *
2404 * Individual features of a cairo_font_options_t can be set or accessed
2405 * using functions named cairo_font_options_set_feature_name and
2406 * cairo_font_options_get_feature_name, like
2407 * cairo_font_options_set_antialias() and
2408 * cairo_font_options_get_antialias().
2409 *
2410 * New features may be added to in the future. For this reason , , ,
2411 * (cairo_font_options_copy(), cairo_font_options_equal(),
2412 * cairo_font_options_merge(), and cairo_font_options_hash() in
2413 * procedural way) should be used to copy, check for equality, merge, or
2414 * compute a hash value of objects.
2415 **/
2416class CairoFontOptions {
2417    /**
2418     * The method description goes here.
2419     *
2420     * @param string $other Description...
2421     * @return bool
2422     * @since PECL cairo >= 0.1.0
2423     **/
2424    function equal($other){}
2425
2426    /**
2427     * Description here.
2428     *
2429     * @return int
2430     * @since PECL cairo >= 0.1.0
2431     **/
2432    function getAntialias(){}
2433
2434    /**
2435     * The method description goes here.
2436     *
2437     * @return int
2438     * @since PECL cairo >= 0.1.0
2439     **/
2440    function getHintMetrics(){}
2441
2442    /**
2443     * The method description goes here.
2444     *
2445     * @return int
2446     * @since PECL cairo >= 0.1.0
2447     **/
2448    function getHintStyle(){}
2449
2450    /**
2451     * The method description goes here.
2452     *
2453     * @return int
2454     * @since PECL cairo >= 0.1.0
2455     **/
2456    function getSubpixelOrder(){}
2457
2458    /**
2459     * The method description goes here.
2460     *
2461     * @return int
2462     * @since PECL cairo >= 0.1.0
2463     **/
2464    function hash(){}
2465
2466    /**
2467     * The method description goes here.
2468     *
2469     * @param string $other Description...
2470     * @return void
2471     * @since PECL cairo >= 0.1.0
2472     **/
2473    function merge($other){}
2474
2475    /**
2476     * Description here.
2477     *
2478     * @param string $antialias Description...
2479     * @return void
2480     * @since PECL cairo >= 0.1.0
2481     **/
2482    function setAntialias($antialias){}
2483
2484    /**
2485     * The method description goes here.
2486     *
2487     * @param string $hint_metrics Description...
2488     * @return void
2489     * @since PECL cairo >= 0.1.0
2490     **/
2491    function setHintMetrics($hint_metrics){}
2492
2493    /**
2494     * The method description goes here.
2495     *
2496     * @param string $hint_style Description...
2497     * @return void
2498     * @since PECL cairo >= 0.1.0
2499     **/
2500    function setHintStyle($hint_style){}
2501
2502    /**
2503     * The method description goes here.
2504     *
2505     * @param string $subpixel_order Description...
2506     * @return void
2507     * @since PECL cairo >= 0.1.0
2508     **/
2509    function setSubpixelOrder($subpixel_order){}
2510
2511    /**
2512     * Description here.
2513     *
2514     * @return int
2515     * @since PECL cairo >= 0.1.0
2516     **/
2517    function status(){}
2518
2519    /**
2520     * The method description goes here.
2521     *
2522     * @since PECL cairo >= 0.1.0
2523     **/
2524    function __construct(){}
2525
2526}
2527/**
2528 * Specifies variants of a font face based on their slant.
2529 **/
2530class CairoFontSlant {
2531}
2532/**
2533 * CairoFontType class is an abstract final class that contains constants
2534 * used to describe the type of a given or . The font types are also
2535 * known as "font backends" within cairo.
2536 *
2537 * The type of a CairoFontFace is determined by the how it is created, an
2538 * example would be the . The type can be queried with or
2539 *
2540 * The various functions can be used with a font face of any type.
2541 *
2542 * The type of a is determined by the type of the passed to or . The
2543 * scaled font type can be queried with or .
2544 **/
2545class CairoFontType {
2546}
2547/**
2548 * Specifies variants of a font face based on their weight.
2549 **/
2550class CairoFontWeight {
2551}
2552/**
2553 * CairoFormat enums are used to identify the memory format of the image
2554 * data.
2555 **/
2556class CairoFormat {
2557    /**
2558     * This method provides a stride value that will respect all alignment
2559     * requirements of the accelerated image-rendering code within cairo.
2560     *
2561     * @param int $format The desired CairoFormat to use
2562     * @param int $width The width of the image
2563     * @return int
2564     * @since PECL cairo >= 0.1.0
2565     **/
2566    function strideForWidth($format, $width){}
2567
2568}
2569/**
2570 * is an abstract base class from which other Pattern classes derive. It
2571 * cannot be instantiated directly.
2572 **/
2573class CairoGradientPattern extends CairoPattern {
2574    /**
2575     * The method description goes here.
2576     *
2577     * @param string $offset Description...
2578     * @param string $red Description...
2579     * @param string $green Description...
2580     * @param string $blue Description...
2581     * @return void
2582     * @since PECL cairo >= 0.1.0
2583     **/
2584    function addColorStopRgb($offset, $red, $green, $blue){}
2585
2586    /**
2587     * The method description goes here.
2588     *
2589     * @param string $offset Description...
2590     * @param string $red Description...
2591     * @param string $green Description...
2592     * @param string $blue Description...
2593     * @param string $alpha Description...
2594     * @return void
2595     * @since PECL cairo >= 0.1.0
2596     **/
2597    function addColorStopRgba($offset, $red, $green, $blue, $alpha){}
2598
2599    /**
2600     * The method description goes here.
2601     *
2602     * @return int
2603     * @since PECL cairo >= 0.1.0
2604     **/
2605    function getColorStopCount(){}
2606
2607    /**
2608     * The method description goes here.
2609     *
2610     * @param string $index Description...
2611     * @return array
2612     * @since PECL cairo >= 0.1.0
2613     **/
2614    function getColorStopRgba($index){}
2615
2616    /**
2617     * The method description goes here.
2618     *
2619     * @return int
2620     * @since PECL cairo >= 0.1.0
2621     **/
2622    function getExtend(){}
2623
2624    /**
2625     * The method description goes here.
2626     *
2627     * @param int $extend Description...
2628     * @return void
2629     * @since PECL cairo >= 0.1.0
2630     **/
2631    function setExtend($extend){}
2632
2633}
2634/**
2635 * Specifies whether to hint font metrics; hinting font metrics means
2636 * quantizing them so that they are integer values in device space. Doing
2637 * this improves the consistency of letter and line spacing, however it
2638 * also means that text will be laid out differently at different zoom
2639 * factors.
2640 **/
2641class CairoHintMetrics {
2642}
2643/**
2644 * Specifies the type of hinting to do on font outlines. Hinting is the
2645 * process of fitting outlines to the pixel grid in order to improve the
2646 * appearance of the result. Since hinting outlines involves distorting
2647 * them, it also reduces the faithfulness to the original outline shapes.
2648 * Not all of the outline hinting styles are supported by all font
2649 * backends.
2650 **/
2651class CairoHintStyle {
2652}
2653/**
2654 * CairoImageSurface provide the ability to render to memory buffers
2655 * either allocated by cairo or by the calling code. The supported image
2656 * formats are those defined in .
2657 **/
2658class CairoImageSurface extends CairoSurface {
2659    /**
2660     * The method description goes here.
2661     *
2662     * @param string $data Description...
2663     * @param int $format Description...
2664     * @param int $width Description...
2665     * @param int $height Description...
2666     * @param int $stride Description...
2667     * @return void
2668     * @since PECL cairo >= 0.1.0
2669     **/
2670    function createForData($data, $format, $width, $height, $stride){}
2671
2672    /**
2673     * Creates a new CairoImageSurface form a png image file
2674     *
2675     * This method should be called static
2676     *
2677     * @param string $file Path to PNG image file
2678     * @return CairoImageSurface
2679     * @since PECL cairo >= 0.1.0
2680     **/
2681    function createFromPng($file){}
2682
2683    /**
2684     * Returns the image data of this surface or NULL if surface is not an
2685     * image surface, or if CairoContext::finish, procedural : {@link
2686     * cairo_surface_finish}, has been called.
2687     *
2688     * @return string
2689     * @since PECL cairo >= 0.1.0
2690     **/
2691    function getData(){}
2692
2693    /**
2694     * Retrieves the image format, as one of the CairoFormat defined
2695     *
2696     * @return int
2697     * @since PECL cairo >= 0.1.0
2698     **/
2699    function getFormat(){}
2700
2701    /**
2702     * This methods returns the CairoImageSurface height.
2703     *
2704     * @return int
2705     * @since PECL cairo >= 0.1.0
2706     **/
2707    function getHeight(){}
2708
2709    /**
2710     * The method description goes here.
2711     *
2712     * @return int
2713     * @since PECL cairo >= 0.1.0
2714     **/
2715    function getStride(){}
2716
2717    /**
2718     * Gets the width of the CairoImageSurface
2719     *
2720     * @return int
2721     * @since PECL cairo >= 0.1.0
2722     **/
2723    function getWidth(){}
2724
2725    /**
2726     * Creates a new CairoImageSuface object of type {@link format}
2727     *
2728     * @param int $format Can be any defined in CairoFormat
2729     * @param int $width The width of the image surface
2730     * @param int $height The height of the image surface
2731     * @since PECL cairo >= 0.1.0
2732     **/
2733    function __construct($format, $width, $height){}
2734
2735}
2736/**
2737 * Create a new CairoLinearGradient along the line defined
2738 **/
2739class CairoLinearGradient extends CairoGradientPattern {
2740    /**
2741     * The method description goes here.
2742     *
2743     * @return array
2744     * @since PECL cairo >= 0.1.0
2745     **/
2746    function getPoints(){}
2747
2748    /**
2749     * The method description goes here.
2750     *
2751     * @param float $x0 Description...
2752     * @param float $y0 Description...
2753     * @param float $x1 Description...
2754     * @param float $y1 Description...
2755     * @since PECL cairo >= 0.1.0
2756     **/
2757    function __construct($x0, $y0, $x1, $y1){}
2758
2759}
2760/**
2761 * Specifies how to render the endpoints of the path when stroking.
2762 *
2763 * The default line cap style is .
2764 **/
2765class CairoLineCap {
2766}
2767/**
2768 * Description of the class.
2769 **/
2770class CairoLineJoin {
2771}
2772/**
2773 * Matrices are used throughout cairo to convert between different
2774 * coordinate spaces.
2775 **/
2776class CairoMatrix {
2777    /**
2778     * Creates a new matrix that is an identity transformation. An identity
2779     * transformation means the source data is copied into the destination
2780     * data without change
2781     *
2782     * @return void
2783     * @since PECL cairo >= 0.1.0
2784     **/
2785    function initIdentity(){}
2786
2787    /**
2788     * Creats a new matrix to a transformation that rotates by radians
2789     * provided
2790     *
2791     * @param float $radians angle of rotation, in radians. The direction
2792     *   of rotation is defined such that positive angles rotate in the
2793     *   direction from the positive X axis toward the positive Y axis. With
2794     *   the default axis orientation of cairo, positive angles rotate in a
2795     *   clockwise direction.
2796     * @return void
2797     * @since PECL cairo >= 0.1.0
2798     **/
2799    function initRotate($radians){}
2800
2801    /**
2802     * Creates a new matrix to a transformation that scales by sx and sy in
2803     * the X and Y dimensions, respectively.
2804     *
2805     * @param float $sx scale factor in the X direction
2806     * @param float $sy scale factor in the Y direction
2807     * @return void
2808     * @since PECL cairo >= 0.1.0
2809     **/
2810    function initScale($sx, $sy){}
2811
2812    /**
2813     * Creates a new matrix to a transformation that translates by tx and ty
2814     * in the X and Y dimensions, respectively.
2815     *
2816     * @param float $tx amount to translate in the X direction
2817     * @param float $ty amount to translate in the Y direction
2818     * @return void
2819     * @since PECL cairo >= 0.1.0
2820     **/
2821    function initTranslate($tx, $ty){}
2822
2823    /**
2824     * The method description goes here.
2825     *
2826     * @return void
2827     * @since PECL cairo >= 0.1.0
2828     **/
2829    function invert(){}
2830
2831    /**
2832     * The method description goes here.
2833     *
2834     * @param CairoMatrix $matrix1 Description...
2835     * @param CairoMatrix $matrix2 Description...
2836     * @return CairoMatrix
2837     * @since PECL cairo >= 0.1.0
2838     **/
2839    function multiply($matrix1, $matrix2){}
2840
2841    /**
2842     * Description here.
2843     *
2844     * @param string $sx Description...
2845     * @param string $sy Description...
2846     * @return void
2847     * @since PECL cairo >= 0.1.0
2848     **/
2849    function rotate($sx, $sy){}
2850
2851    /**
2852     * Applies scaling by sx, sy to the transformation in the matrix. The
2853     * effect of the new transformation is to first scale the coordinates by
2854     * sx and sy, then apply the original transformation to the coordinates.
2855     *
2856     * @param float $sx Procedural only - CairoMatrix instance
2857     * @param float $sy scale factor in the X direction
2858     * @return void
2859     * @since PECL cairo >= 0.1.0
2860     **/
2861    function scale($sx, $sy){}
2862
2863    /**
2864     * The method description goes here.
2865     *
2866     * @param string $dx Description...
2867     * @param string $dy Description...
2868     * @return array
2869     * @since PECL cairo >= 0.1.0
2870     **/
2871    function transformDistance($dx, $dy){}
2872
2873    /**
2874     * The method description goes here.
2875     *
2876     * @param string $dx Description...
2877     * @param string $dy Description...
2878     * @return array
2879     * @since PECL cairo >= 0.1.0
2880     **/
2881    function transformPoint($dx, $dy){}
2882
2883    /**
2884     * Description here.
2885     *
2886     * @param string $tx Description...
2887     * @param string $ty Description...
2888     * @return void
2889     * @since PECL cairo >= 0.1.0
2890     **/
2891    function translate($tx, $ty){}
2892
2893    /**
2894     * Returns new CairoMatrix object. Matrices are used throughout cairo to
2895     * convert between different coordinate spaces. Sets matrix to be the
2896     * affine transformation given by xx, yx, xy, yy, x0, y0. The
2897     * transformation is given by: x_new = xx * x + xy * y + x0; and y_new =
2898     * yx * x + yy * y + y0;
2899     *
2900     * @param float $xx xx component of the affine transformation
2901     * @param float $yx yx component of the affine transformation
2902     * @param float $xy xy component of the affine transformation
2903     * @param float $yy yy component of the affine transformation
2904     * @param float $x0 X translation component of the affine
2905     *   transformation
2906     * @param float $y0 Y translation component of the affine
2907     *   transformation
2908     * @since PECL cairo >= 0.1.0
2909     **/
2910    function __construct($xx, $yx, $xy, $yy, $x0, $y0){}
2911
2912}
2913/**
2914 * This is used to set the compositing operator for all cairo drawing
2915 * operations.
2916 *
2917 * The default operator is
2918 *
2919 * The operators marked as unbounded modify their destination even
2920 * outside of the mask layer (that is, their effect is not bound by the
2921 * mask layer). However, their effect can still be limited by way of
2922 * clipping.
2923 *
2924 * To keep things simple, the operator descriptions here document the
2925 * behavior for when both source and destination are either fully
2926 * transparent or fully opaque. The actual implementation works for
2927 * translucent layers too. For a more detailed explanation of the effects
2928 * of each operator, including the mathematical definitions, see
2929 * http://cairographics.org/operators/.
2930 **/
2931class CairoOperator {
2932}
2933/**
2934 * Description of the class.
2935 *
2936 * Note: CairoPath class cannot be instantiated directly, doing so will
2937 * result in Fatal Error if used or passed
2938 **/
2939class CairoPath {
2940}
2941/**
2942 * is the abstract base class from which all the other pattern classes
2943 * derive. It cannot be instantiated directly
2944 **/
2945class CairoPattern {
2946    /**
2947     * Description here.
2948     *
2949     * @return void
2950     * @since PECL cairo >= 0.1.0
2951     **/
2952    function getMatrix(){}
2953
2954    /**
2955     * The method description goes here.
2956     *
2957     * @return int
2958     * @since PECL cairo >= 0.1.0
2959     **/
2960    function getType(){}
2961
2962    /**
2963     * Description here.
2964     *
2965     * @param string $matrix Description...
2966     * @return void
2967     * @since PECL cairo >= 0.1.0
2968     **/
2969    function setMatrix($matrix){}
2970
2971    /**
2972     * Description here.
2973     *
2974     * @return int
2975     * @since PECL cairo >= 0.1.0
2976     **/
2977    function status(){}
2978
2979    /**
2980     * The method description goes here.
2981     *
2982     * @since PECL cairo >= 0.1.0
2983     **/
2984    function __construct(){}
2985
2986}
2987/**
2988 * is used to describe the type of a given pattern.
2989 *
2990 * The type of a pattern is determined by the function used to create it.
2991 * The and functions create patterns. The remaining
2992 * cairo_pattern_create_* functions map to pattern types in obvious ways.
2993 **/
2994class CairoPatternType {
2995}
2996/**
2997 * Description of the class.
2998 **/
2999class CairoPdfSurface extends CairoSurface {
3000    /**
3001     * The method description goes here.
3002     *
3003     * @param string $width Description...
3004     * @param string $height Description...
3005     * @return void
3006     * @since PECL cairo >= 0.1.0
3007     **/
3008    function setSize($width, $height){}
3009
3010    /**
3011     * The method description goes here.
3012     *
3013     * @param string $file Description...
3014     * @param float $width Description...
3015     * @param float $height Description...
3016     * @since PECL cairo >= 0.1.0
3017     **/
3018    function __construct($file, $width, $height){}
3019
3020}
3021/**
3022 * Description of the class.
3023 **/
3024class CairoPsLevel {
3025}
3026/**
3027 * Description of the class.
3028 **/
3029class CairoPsSurface extends CairoSurface {
3030    /**
3031     * The method description goes here.
3032     *
3033     * @return void
3034     * @since PECL cairo >= 0.1.0
3035     **/
3036    function dscBeginPageSetup(){}
3037
3038    /**
3039     * The method description goes here.
3040     *
3041     * @return void
3042     * @since PECL cairo >= 0.1.0
3043     **/
3044    function dscBeginSetup(){}
3045
3046    /**
3047     * The method description goes here.
3048     *
3049     * @param string $comment Description...
3050     * @return void
3051     * @since PECL cairo >= 0.1.0
3052     **/
3053    function dscComment($comment){}
3054
3055    /**
3056     * The method description goes here.
3057     *
3058     * @return bool
3059     * @since PECL cairo >= 0.1.0
3060     **/
3061    function getEps(){}
3062
3063    /**
3064     * The method description goes here.
3065     *
3066     * @return array
3067     * @since PECL cairo >= 0.1.0
3068     **/
3069    function getLevels(){}
3070
3071    /**
3072     * The method description goes here.
3073     *
3074     * @param string $level Description...
3075     * @return string
3076     * @since PECL cairo >= 0.1.0
3077     **/
3078    function levelToString($level){}
3079
3080    /**
3081     * The method description goes here.
3082     *
3083     * @param string $level Description...
3084     * @return void
3085     * @since PECL cairo >= 0.1.0
3086     **/
3087    function restrictToLevel($level){}
3088
3089    /**
3090     * The method description goes here.
3091     *
3092     * @param string $level Description...
3093     * @return void
3094     * @since PECL cairo >= 0.1.0
3095     **/
3096    function setEps($level){}
3097
3098    /**
3099     * The method description goes here.
3100     *
3101     * @param string $width Description...
3102     * @param string $height Description...
3103     * @return void
3104     * @since PECL cairo >= 0.1.0
3105     **/
3106    function setSize($width, $height){}
3107
3108    /**
3109     * The method description goes here.
3110     *
3111     * @param string $file Description...
3112     * @param float $width Description...
3113     * @param float $height Description...
3114     * @since PECL cairo >= 0.1.0
3115     **/
3116    function __construct($file, $width, $height){}
3117
3118}
3119/**
3120 * Description of the class.
3121 **/
3122class CairoRadialGradient extends CairoGradientPattern {
3123    /**
3124     * The method description goes here.
3125     *
3126     * @return array
3127     * @since PECL cairo >= 0.1.0
3128     **/
3129    function getCircles(){}
3130
3131    /**
3132     * Creates a new radial gradient CairoPattern between the two circles
3133     * defined by (x0, y0, r0) and (x1, y1, r1). Before using the gradient
3134     * pattern, a number of color stops should be defined using
3135     * CairoRadialGradient::addColorStopRgb or
3136     * CairoRadialGradient::addColorStopRgba.
3137     *
3138     * Note: The coordinates here are in pattern space. For a new pattern,
3139     * pattern space is identical to user space, but the relationship between
3140     * the spaces can be changed with CairoRadialGradient::setMatrix.
3141     *
3142     * @param float $x0 x coordinate for the center of the start circle.
3143     * @param float $y0 y coordinate for the center of the start circle.
3144     * @param float $r0 radius of the start circle.
3145     * @param float $x1 x coordinate for the center of the end circle.
3146     * @param float $y1 y coordinate for the center of the end circle.
3147     * @param float $r1 radius of the end circle.
3148     * @since PECL cairo >= 0.1.0
3149     **/
3150    function __construct($x0, $y0, $r0, $x1, $y1, $r1){}
3151
3152}
3153/**
3154 * Description of the class.
3155 **/
3156class CairoScaledFont {
3157    /**
3158     * The method description goes here.
3159     *
3160     * @return array
3161     * @since PECL cairo >= 0.1.0
3162     **/
3163    function extents(){}
3164
3165    /**
3166     * The method description goes here.
3167     *
3168     * @return CairoMatrix
3169     * @since PECL cairo >= 0.1.0
3170     **/
3171    function getCtm(){}
3172
3173    /**
3174     * Description here.
3175     *
3176     * @return void
3177     * @since PECL cairo >= 0.1.0
3178     **/
3179    function getFontFace(){}
3180
3181    /**
3182     * Description here.
3183     *
3184     * @return void
3185     * @since PECL cairo >= 0.1.0
3186     **/
3187    function getFontMatrix(){}
3188
3189    /**
3190     * Description here.
3191     *
3192     * @return void
3193     * @since PECL cairo >= 0.1.0
3194     **/
3195    function getFontOptions(){}
3196
3197    /**
3198     * The method description goes here.
3199     *
3200     * @return void
3201     * @since PECL cairo >= 0.1.0
3202     **/
3203    function getScaleMatrix(){}
3204
3205    /**
3206     * The method description goes here.
3207     *
3208     * @return int
3209     * @since PECL cairo >= 0.1.0
3210     **/
3211    function getType(){}
3212
3213    /**
3214     * The method description goes here.
3215     *
3216     * @param string $glyphs Description...
3217     * @return array
3218     * @since PECL cairo >= 0.1.0
3219     **/
3220    function glyphExtents($glyphs){}
3221
3222    /**
3223     * Description here.
3224     *
3225     * @return int
3226     * @since PECL cairo >= 0.1.0
3227     **/
3228    function status(){}
3229
3230    /**
3231     * Description here.
3232     *
3233     * @param string $text Description...
3234     * @return array
3235     * @since PECL cairo >= 0.1.0
3236     **/
3237    function textExtents($text){}
3238
3239    /**
3240     * The method description goes here.
3241     *
3242     * @param CairoFontFace $font_face Description...
3243     * @param CairoMatrix $matrix Description...
3244     * @param CairoMatrix $ctm Description...
3245     * @param CairoFontOptions $options Description...
3246     * @since PECL cairo >= 0.1.0
3247     **/
3248    function __construct($font_face, $matrix, $ctm, $options){}
3249
3250}
3251/**
3252 * Description of the class.
3253 **/
3254class CairoSolidPattern extends CairoPattern {
3255    /**
3256     * The method description goes here.
3257     *
3258     * @return array
3259     * @since PECL cairo >= 0.1.0
3260     **/
3261    function getRgba(){}
3262
3263    /**
3264     * The method description goes here.
3265     *
3266     * @param float $red Description...
3267     * @param float $green Description...
3268     * @param float $blue Description...
3269     * @param float $alpha Description...
3270     * @since PECL cairo >= 0.1.0
3271     **/
3272    function __construct($red, $green, $blue, $alpha){}
3273
3274}
3275/**
3276 * is used to indicate errors that can occur when using Cairo. In some
3277 * cases it is returned directly by functions. but when using , the last
3278 * error, if any, is stored in the object and can be retrieved with or .
3279 * New entries may be added in future versions. Use or to get a
3280 * human-readable representation of an error message.
3281 **/
3282class CairoStatus {
3283}
3284/**
3285 * Description of the class.
3286 **/
3287class CairoSubpixelOrder {
3288}
3289/**
3290 * This is the base-class for all other Surface types. CairoSurface is
3291 * the abstract type representing all different drawing targets that
3292 * cairo can render to. The actual drawings are performed using a
3293 * CairoContext.
3294 **/
3295class CairoSurface {
3296    /**
3297     * Emits the current page for backends that support multiple pages, but
3298     * doesn't clear it, so that the contents of the current page will be
3299     * retained for the next page. Use CairoSurface::showPage() if you want
3300     * to get an empty page after the emission.
3301     *
3302     * @return void
3303     * @since PECL cairo >= 0.1.0
3304     **/
3305    function copyPage(){}
3306
3307    /**
3308     * Create a new surface that is as compatible as possible with an
3309     * existing surface. For example the new surface will have the same
3310     * fallback resolution and font options as other. Generally, the new
3311     * surface will also use the same backend as other, unless that is not
3312     * possible for some reason. The type of the returned surface may be
3313     * examined with CairoSurface::getType(). Initially the surface contents
3314     * are all 0 (transparent if contents have transparency, black
3315     * otherwise.)
3316     *
3317     * @param CairoSurface $other An existing surface used to select the
3318     *   backend of the new surface
3319     * @param int $content The content for the new surface. See the
3320     *   CairoContent class for possible values.
3321     * @param string $width Width of the new surface, (in device-space
3322     *   units).
3323     * @param string $height Height of the new surface, (in device-space
3324     *   units).
3325     * @return void
3326     * @since PECL cairo >= 0.1.0
3327     **/
3328    function createSimilar($other, $content, $width, $height){}
3329
3330    /**
3331     * The method description goes here.
3332     *
3333     * @return void
3334     * @since PECL cairo >= 0.1.0
3335     **/
3336    function finish(){}
3337
3338    /**
3339     * The method description goes here.
3340     *
3341     * @return void
3342     * @since PECL cairo >= 0.1.0
3343     **/
3344    function flush(){}
3345
3346    /**
3347     * The method description goes here.
3348     *
3349     * @return int
3350     * @since PECL cairo >= 0.1.0
3351     **/
3352    function getContent(){}
3353
3354    /**
3355     * The method description goes here.
3356     *
3357     * @return array
3358     * @since PECL cairo >= 0.1.0
3359     **/
3360    function getDeviceOffset(){}
3361
3362    /**
3363     * Description here.
3364     *
3365     * @return void
3366     * @since PECL cairo >= 0.1.0
3367     **/
3368    function getFontOptions(){}
3369
3370    /**
3371     * The method description goes here.
3372     *
3373     * @return int
3374     * @since PECL cairo >= 0.1.0
3375     **/
3376    function getType(){}
3377
3378    /**
3379     * The method description goes here.
3380     *
3381     * @return void
3382     * @since PECL cairo >= 0.1.0
3383     **/
3384    function markDirty(){}
3385
3386    /**
3387     * The method description goes here.
3388     *
3389     * @param string $x Description...
3390     * @param string $y Description...
3391     * @param string $width Description...
3392     * @param string $height Description...
3393     * @return void
3394     * @since PECL cairo >= 0.1.0
3395     **/
3396    function markDirtyRectangle($x, $y, $width, $height){}
3397
3398    /**
3399     * The method description goes here.
3400     *
3401     * @param string $x Description...
3402     * @param string $y Description...
3403     * @return void
3404     * @since PECL cairo >= 0.1.0
3405     **/
3406    function setDeviceOffset($x, $y){}
3407
3408    /**
3409     * The method description goes here.
3410     *
3411     * @param string $x Description...
3412     * @param string $y Description...
3413     * @return void
3414     * @since PECL cairo >= 0.1.0
3415     **/
3416    function setFallbackResolution($x, $y){}
3417
3418    /**
3419     * Description here.
3420     *
3421     * @return void
3422     * @since PECL cairo >= 0.1.0
3423     **/
3424    function showPage(){}
3425
3426    /**
3427     * Description here.
3428     *
3429     * @return int
3430     * @since PECL cairo >= 0.1.0
3431     **/
3432    function status(){}
3433
3434    /**
3435     * The method description goes here.
3436     *
3437     * @param string $file Description...
3438     * @return void
3439     * @since PECL cairo >= 0.1.0
3440     **/
3441    function writeToPng($file){}
3442
3443    /**
3444     * CairoSurface is an abstract type and, as such, should not be
3445     * instantiated in your PHP scripts.
3446     *
3447     * @since PECL cairo >= 0.1.0
3448     **/
3449    function __construct(){}
3450
3451}
3452/**
3453 * Description of the class.
3454 **/
3455class CairoSurfacePattern extends CairoPattern {
3456    /**
3457     * The method description goes here.
3458     *
3459     * @return int
3460     * @since PECL cairo >= 0.1.0
3461     **/
3462    function getExtend(){}
3463
3464    /**
3465     * The method description goes here.
3466     *
3467     * @return int
3468     * @since PECL cairo >= 0.1.0
3469     **/
3470    function getFilter(){}
3471
3472    /**
3473     * The method description goes here.
3474     *
3475     * @return void
3476     * @since PECL cairo >= 0.1.0
3477     **/
3478    function getSurface(){}
3479
3480    /**
3481     * The method description goes here.
3482     *
3483     * @param int $extend Description...
3484     * @return void
3485     * @since PECL cairo >= 0.1.0
3486     **/
3487    function setExtend($extend){}
3488
3489    /**
3490     * The method description goes here.
3491     *
3492     * @param string $filter Description...
3493     * @return void
3494     * @since PECL cairo >= 0.1.0
3495     **/
3496    function setFilter($filter){}
3497
3498    /**
3499     * The method description goes here.
3500     *
3501     * @param CairoSurface $surface Description...
3502     * @since PECL cairo >= 0.1.0
3503     **/
3504    function __construct($surface){}
3505
3506}
3507/**
3508 * Description of the class.
3509 **/
3510class CairoSurfaceType {
3511}
3512/**
3513 * Svg specific surface class, uses the SVG (standard vector graphics)
3514 * surface backend.
3515 **/
3516class CairoSvgSurface extends CairoSurface {
3517    /**
3518     * Returns a numerically indexed array of currently available
3519     * CairoSvgVersion constants. In order to retreive the string values for
3520     * each item, use CairoSvgSurface::versionToString.
3521     *
3522     * @return array
3523     * @since PECL cairo >= 0.1.0
3524     **/
3525    function getVersions(){}
3526
3527    /**
3528     * The method description goes here.
3529     *
3530     * @param string $version Description...
3531     * @return void
3532     * @since PECL cairo >= 0.1.0
3533     **/
3534    function restrictToVersion($version){}
3535
3536    /**
3537     * The method description goes here.
3538     *
3539     * @param int $version Description...
3540     * @return string
3541     * @since PECL cairo >= 0.1.0
3542     **/
3543    function versionToString($version){}
3544
3545    /**
3546     * The method description goes here.
3547     *
3548     * @param string $file Description...
3549     * @param float $width Description...
3550     * @param float $height Description...
3551     * @since PECL cairo >= 0.1.0
3552     **/
3553    function __construct($file, $width, $height){}
3554
3555}
3556/**
3557 * Description of the class.
3558 **/
3559class CairoSvgVersion {
3560}
3561/**
3562 * The class can be used instead of to create a toy font independently of
3563 * a context.
3564 **/
3565class CairoToyFontFace extends CairoFontFace {
3566}
3567/**
3568 * Represents a loaded chdb file.
3569 **/
3570class chdb {
3571    /**
3572     * Gets the value associated with a key from a chdb database.
3573     *
3574     * @param string $key The key for which to get the value.
3575     * @return string
3576     * @since PECL chdb >= 0.1.0
3577     **/
3578    function get($key){}
3579
3580    /**
3581     * Loads a chdb file, by mapping it into memory. While some validity
3582     * checks are performed on the specified file, they are mostly there to
3583     * avoid the possibility of common mistakes (for example, loading a file
3584     * which is not a chdb database, or that is somehow incompatible with the
3585     * current system). A maliciously crafted chdb file can thus be dangerous
3586     * if loaded, so chdb files should be trusted and treated with the same
3587     * security protections used for PHP shared libraries.
3588     *
3589     * @param string $pathname The name of the file to load.
3590     * @since PECL chdb >= 0.1.0
3591     **/
3592    function __construct($pathname){}
3593
3594}
3595/**
3596 * Provides string comparison capability with support for appropriate
3597 * locale-sensitive sort orderings.
3598 **/
3599class Collator {
3600    /**
3601     * This function sorts an array such that array indices maintain their
3602     * correlation with the array elements they are associated with. This is
3603     * used mainly when sorting associative arrays where the actual element
3604     * order is significant. Array elements will have sort order according to
3605     * current locale rules.
3606     *
3607     * Equivalent to standard PHP {@link asort}.
3608     *
3609     * @param array $arr Collator object.
3610     * @param int $sort_flag Array of strings to sort.
3611     * @return bool
3612     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
3613     **/
3614    function asort(&$arr, $sort_flag){}
3615
3616    /**
3617     * Compare two Unicode strings according to collation rules.
3618     *
3619     * @param string $str1 Collator object.
3620     * @param string $str2 The first string to compare.
3621     * @return int
3622     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
3623     **/
3624    function compare($str1, $str2){}
3625
3626    /**
3627     * The strings will be compared using the options already specified.
3628     *
3629     * @param string $locale The locale containing the required collation
3630     *   rules. Special values for locales can be passed in - if null is
3631     *   passed for the locale, the default locale collation rules will be
3632     *   used. If empty string ("") or "root" are passed, UCA rules will be
3633     *   used.
3634     * @return Collator
3635     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
3636     **/
3637    function create($locale){}
3638
3639    /**
3640     * Get a value of an integer collator attribute.
3641     *
3642     * @param int $attr Collator object.
3643     * @return int
3644     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
3645     **/
3646    function getAttribute($attr){}
3647
3648    /**
3649     * @return int
3650     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
3651     **/
3652    function getErrorCode(){}
3653
3654    /**
3655     * Retrieves the message for the last error.
3656     *
3657     * @return string
3658     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
3659     **/
3660    function getErrorMessage(){}
3661
3662    /**
3663     * Get collector locale name.
3664     *
3665     * @param int $type Collator object.
3666     * @return string
3667     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
3668     **/
3669    function getLocale($type){}
3670
3671    /**
3672     * Return collation key for a string.
3673     *
3674     * @param string $str Collator object.
3675     * @return string
3676     **/
3677    function getSortKey($str){}
3678
3679    /**
3680     * @return int
3681     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
3682     **/
3683    function getStrength(){}
3684
3685    /**
3686     * @param int $attr Collator object.
3687     * @param int $val Attribute.
3688     * @return bool
3689     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
3690     **/
3691    function setAttribute($attr, $val){}
3692
3693    /**
3694     * The ICU Collation Service supports many levels of comparison (named
3695     * "Levels", but also known as "Strengths"). Having these categories
3696     * enables ICU to sort strings precisely according to local conventions.
3697     * However, by allowing the levels to be selectively employed, searching
3698     * for a string in text can be performed with various matching
3699     * conditions.
3700     *
3701     * Primary Level: Typically, this is used to denote differences between
3702     * base characters (for example, "a" < "b"). It is the strongest
3703     * difference. For example, dictionaries are divided into different
3704     * sections by base character. This is also called the level1 strength.
3705     * Secondary Level: Accents in the characters are considered secondary
3706     * differences (for example, "as" < "às" < "at"). Other differences
3707     * between letters can also be considered secondary differences,
3708     * depending on the language. A secondary difference is ignored when
3709     * there is a primary difference anywhere in the strings. This is also
3710     * called the level2 strength. Note: In some languages (such as Danish),
3711     * certain accented letters are considered to be separate base
3712     * characters. In most languages, however, an accented letter only has a
3713     * secondary difference from the unaccented version of that letter.
3714     * Tertiary Level: Upper and lower case differences in characters are
3715     * distinguished at the tertiary level (for example, "ao" < "Ao" <
3716     * "aò"). In addition, a variant of a letter differs from the base form
3717     * on the tertiary level (such as "A" and " "). Another example is the
3718     * difference between large and small Kana. A tertiary difference is
3719     * ignored when there is a primary or secondary difference anywhere in
3720     * the strings. This is also called the level3 strength. Quaternary
3721     * Level: When punctuation is ignored (see Ignoring Punctuations ) at
3722     * level 13, an additional level can be used to distinguish words with
3723     * and without punctuation (for example, "ab" < "a-b" < "aB"). This
3724     * difference is ignored when there is a primary, secondary or tertiary
3725     * difference. This is also known as the level4 strength. The quaternary
3726     * level should only be used if ignoring punctuation is required or when
3727     * processing Japanese text (see Hiragana processing). Identical Level:
3728     * When all other levels are equal, the identical level is used as a
3729     * tiebreaker. The Unicode code point values of the NFD form of each
3730     * string are compared at this level, just in case there is no difference
3731     * at levels 14. For example, Hebrew cantillation marks are only
3732     * distinguished at this level. This level should be used sparingly, as
3733     * only code point values differences between two strings is an extremely
3734     * rare occurrence. Using this level substantially decreases the
3735     * performance for both incremental comparison and sort key generation
3736     * (as well as increasing the sort key length). It is also known as level
3737     * 5 strength.
3738     *
3739     * For example, people may choose to ignore accents or ignore accents and
3740     * case when searching for text. Almost all characters are distinguished
3741     * by the first three levels, and in most locales the default value is
3742     * thus Tertiary. However, if Alternate is set to be Shifted, then the
3743     * Quaternary strength can be used to break ties among whitespace,
3744     * punctuation, and symbols that would otherwise be ignored. If very fine
3745     * distinctions among characters are required, then the Identical
3746     * strength can be used (for example, Identical Strength distinguishes
3747     * between the Mathematical Bold Small A and the Mathematical Italic
3748     * Small A.). However, using levels higher than Tertiary the Identical
3749     * strength result in significantly longer sort keys, and slower string
3750     * comparison performance for equal strings.
3751     *
3752     * @param int $strength Collator object.
3753     * @return bool
3754     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
3755     **/
3756    function setStrength($strength){}
3757
3758    /**
3759     * This function sorts an array according to current locale rules.
3760     *
3761     * Equivalent to standard PHP {@link sort} .
3762     *
3763     * @param array $arr Collator object.
3764     * @param int $sort_flag Array of strings to sort.
3765     * @return bool
3766     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
3767     **/
3768    function sort(&$arr, $sort_flag){}
3769
3770    /**
3771     * Similar to {@link collator_sort} but uses ICU sorting keys produced by
3772     * ucol_getSortKey() to gain more speed on large arrays.
3773     *
3774     * @param array $arr Collator object.
3775     * @return bool
3776     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
3777     **/
3778    function sortWithSortKeys(&$arr){}
3779
3780}
3781/**
3782 * Classes implementing can be used with the function.
3783 **/
3784interface Countable {
3785    /**
3786     * This method is executed when using the {@link count} function on an
3787     * object implementing Countable.
3788     *
3789     * @return int
3790     * @since PHP 5 >= 5.1.0
3791     **/
3792    function count();
3793
3794}
3795/**
3796 * Representation of date interval. A date interval stores either a fixed
3797 * amount of time (in years, months, days, hours etc) or a relative time
3798 * string in the format that DateTime's constructor supports.
3799 **/
3800class DateInterval {
3801    /**
3802     * Uses the normal date parsers and sets up a DateInterval from the
3803     * relative parts of the parsed string.
3804     *
3805     * @param string $time Date with relative parts.
3806     * @return DateInterval
3807     * @since PHP 5 >= 5.3.0
3808     **/
3809    function createFromDateString($time){}
3810
3811    /**
3812     * Formats the interval.
3813     *
3814     * @param string $format The following characters are recognized in the
3815     *   {@link format} parameter string. Each format character must be
3816     *   proceeded by a percent sign (%). {@link format} character
3817     *   Description Example values % Literal % % Y Years, numeric, at least
3818     *   2 digits with leading 0 01, 03 y Years, numeric 1, 3 M Months,
3819     *   numeric, at least 2 digits with leading 0 01, 03, 12 m Months,
3820     *   numeric 1, 3, 12 D Days, numeric, at least 2 digits with leading 0
3821     *   01, 03, 31 d Days, numeric 1, 3, 31 a Total amount of days 4, 18,
3822     *   8123 H Hours, numeric, at least 2 digits with leading 0 01, 03, 23 h
3823     *   Hours, numeric 1, 3, 23 I Minutes, numeric, at least 2 digits with
3824     *   leading 0 01, 03, 59 i Minutes, numeric 1, 3, 59 S Seconds, numeric,
3825     *   at least 2 digits with leading 0 01, 03, 57 s Seconds, numeric 1, 3,
3826     *   57 R Sign "-" when negative, "+" when positive -, + r Sign "-" when
3827     *   negative, empty when positive -,
3828     * @return string
3829     * @since PHP 5 >= 5.3.0
3830     **/
3831    function format($format){}
3832
3833}
3834/**
3835 * Representation of date period.
3836 **/
3837class DatePeriod implements Traversable {
3838}
3839/**
3840 * Representation of date and time.
3841 **/
3842class DateTime {
3843    /**
3844     * Adds the specified DateInterval object to the specified DateTime
3845     * object.
3846     *
3847     * @param DateInterval $interval A DateInterval object
3848     * @return DateTime
3849     * @since PHP 5 >= 5.3.0
3850     **/
3851    function add($interval){}
3852
3853    /**
3854     * Returns new DateTime object formatted according to the specified
3855     * format.
3856     *
3857     * @param string $format Format accepted by {@link date}. If {@link
3858     *   format} does not contain the character ! then portions of the
3859     *   generated time which are not specified in {@link format} will be set
3860     *   to the current system time. If {@link format} contains the character
3861     *   !, then portions of the generated time not provided in {@link
3862     *   format}, as well as values to the left-hand side of the !, will be
3863     *   set to corresponding values from the Unix epoch. The Unix epoch is
3864     *   1970-01-01 00:00:00 UTC.
3865     * @param string $time String representing the time.
3866     * @param DateTimeZone $timezone A DateTimeZone object representing the
3867     *   desired time zone.
3868     * @return DateTime
3869     * @since PHP 5 >= 5.3.0
3870     **/
3871    function createFromFormat($format, $time, $timezone){}
3872
3873    /**
3874     * Returns the difference between two DateTime objects.
3875     *
3876     * @param DateTime $datetime2 The date to compare to.
3877     * @param bool $absolute Whether to return absolute difference.
3878     * @return DateInterval
3879     * @since PHP 5 >= 5.3.0
3880     **/
3881    function diff($datetime2, $absolute){}
3882
3883    /**
3884     * Returns date formatted according to given format.
3885     *
3886     * @param string $format Format accepted by {@link date}.
3887     * @return string
3888     * @since PHP 5 >= 5.2.0
3889     **/
3890    function format($format){}
3891
3892    /**
3893     * Returns an array of warnings and errors found while parsing a
3894     * date/time string.
3895     *
3896     * @return array
3897     * @since PHP 5 >= 5.3.0
3898     **/
3899    function getLastErrors(){}
3900
3901    /**
3902     * Returns the timezone offset.
3903     *
3904     * @return int
3905     * @since PHP 5 >= 5.2.0
3906     **/
3907    function getOffset(){}
3908
3909    /**
3910     * Gets the Unix timestamp.
3911     *
3912     * @return int
3913     * @since PHP 5 >= 5.3.0
3914     **/
3915    function getTimestamp(){}
3916
3917    /**
3918     * Return time zone relative to given DateTime.
3919     *
3920     * @return DateTimeZone
3921     * @since PHP 5 >= 5.2.0
3922     **/
3923    function getTimezone(){}
3924
3925    /**
3926     * Alter the timestamp of a DateTime object by incrementing or
3927     * decrementing in a format accepted by {@link strtotime}.
3928     *
3929     * @param string $modify
3930     * @return DateTime
3931     * @since PHP 5 >= 5.2.0
3932     **/
3933    function modify($modify){}
3934
3935    /**
3936     * Resets the current date of the DateTime object to a different date.
3937     *
3938     * @param int $year Year of the date.
3939     * @param int $month Month of the date.
3940     * @param int $day Day of the date.
3941     * @return DateTime
3942     * @since PHP 5 >= 5.2.0
3943     **/
3944    function setDate($year, $month, $day){}
3945
3946    /**
3947     * Set a date according to the ISO 8601 standard - using weeks and day
3948     * offsets rather than specific dates.
3949     *
3950     * @param int $year Year of the date.
3951     * @param int $week Week of the date.
3952     * @param int $day Offset from the first day of the week.
3953     * @return DateTime
3954     * @since PHP 5 >= 5.2.0
3955     **/
3956    function setISODate($year, $week, $day){}
3957
3958    /**
3959     * Resets the current time of the DateTime object to a different time.
3960     *
3961     * @param int $hour Hour of the time.
3962     * @param int $minute Minute of the time.
3963     * @param int $second Second of the time.
3964     * @return DateTime
3965     * @since PHP 5 >= 5.2.0
3966     **/
3967    function setTime($hour, $minute, $second){}
3968
3969    /**
3970     * Sets the date and time based on an Unix timestamp.
3971     *
3972     * @param int $unixtimestamp Unix timestamp representing the date.
3973     * @return DateTime
3974     * @since PHP 5 >= 5.3.0
3975     **/
3976    function setTimestamp($unixtimestamp){}
3977
3978    /**
3979     * @param DateTimeZone $timezone A DateTimeZone object representing the
3980     *   desired time zone.
3981     * @return DateTime
3982     * @since PHP 5 >= 5.2.0
3983     **/
3984    function setTimezone($timezone){}
3985
3986    /**
3987     * Subtracts the specified DateInterval object from the specified
3988     * DateTime object.
3989     *
3990     * @param DateInterval $interval A DateInterval object
3991     * @return DateTime
3992     * @since PHP 5 >= 5.3.0
3993     **/
3994    function sub($interval){}
3995
3996    /**
3997     * The __set_state handler.
3998     *
3999     * @param array $array Initialization array.
4000     * @return DateTime
4001     * @since PHP 5 >= 5.2.0
4002     **/
4003    function __set_state($array){}
4004
4005    /**
4006     * The __wakeup handler.
4007     *
4008     * @return DateTime
4009     * @since PHP 5 >= 5.2.0
4010     **/
4011    function __wakeup(){}
4012
4013}
4014/**
4015 * Representation of time zone.
4016 **/
4017class DateTimeZone {
4018    /**
4019     * Returns location information for a timezone, including country code,
4020     * latitude/longitude and comments.
4021     *
4022     * @return array
4023     * @since PHP 5 >= 5.3.0
4024     **/
4025    function getLocation(){}
4026
4027    /**
4028     * Returns the name of the timezone.
4029     *
4030     * @return string
4031     * @since PHP 5 >= 5.2.0
4032     **/
4033    function getName(){}
4034
4035    /**
4036     * This function returns the offset to GMT for the date/time specified in
4037     * the {@link datetime} parameter. The GMT offset is calculated with the
4038     * timezone information contained in the DateTimeZone object being used.
4039     *
4040     * @param DateTime $datetime DateTime that contains the date/time to
4041     *   compute the offset from.
4042     * @return int
4043     * @since PHP 5 >= 5.2.0
4044     **/
4045    function getOffset($datetime){}
4046
4047    /**
4048     * @param int $timestamp_begin Begin timestamp.
4049     * @param int $timestamp_end End timestamp.
4050     * @return array
4051     * @since PHP 5 >= 5.2.0
4052     **/
4053    function getTransitions($timestamp_begin, $timestamp_end){}
4054
4055    /**
4056     * @return array
4057     * @since PHP 5 >= 5.2.0
4058     **/
4059    function listAbbreviations(){}
4060
4061    /**
4062     * @param int $what One of DateTimeZone class constants.
4063     * @param string $country A two-letter ISO 3166-1 compatible country
4064     *   code.
4065     * @return array
4066     * @since PHP 5 >= 5.2.0
4067     **/
4068    function listIdentifiers($what, $country){}
4069
4070}
4071/**
4072 * The class from which dir is instantiated.
4073 **/
4074class Directory {
4075    /**
4076     * A pseudo-object oriented mechanism for reading a directory. The given
4077     * {@link directory} is opened. Two properties are available once the
4078     * directory has been opened. The handle property can be used with other
4079     * directory functions such as {@link readdir}, {@link rewinddir} and
4080     * {@link closedir}. The path property is set to path the directory that
4081     * was opened. Three methods are available: read, rewind and close.
4082     *
4083     * @var resource
4084     **/
4085    var $handle;
4086    /**
4087     * A pseudo-object oriented mechanism for reading a directory. The given
4088     * {@link directory} is opened. Two properties are available once the
4089     * directory has been opened. The handle property can be used with other
4090     * directory functions such as {@link readdir}, {@link rewinddir} and
4091     * {@link closedir}. The path property is set to path the directory that
4092     * was opened. Three methods are available: read, rewind and close.
4093     *
4094     * @var string
4095     **/
4096    var $path;
4097    /**
4098     * A pseudo-object oriented mechanism for reading a directory. The given
4099     * {@link directory} is opened. Two properties are available once the
4100     * directory has been opened. The handle property can be used with other
4101     * directory functions such as {@link readdir}, {@link rewinddir} and
4102     * {@link closedir}. The path property is set to path the directory that
4103     * was opened. Three methods are available: read, rewind and close.
4104     *
4105     * @return string
4106     **/
4107    function read(){}
4108
4109}
4110/**
4111 * The DirectoryIterator class provides a simple interface for viewing
4112 * the contents of filesystem directories.
4113 **/
4114class DirectoryIterator extends SplFileInfo implements Iterator, Traversable, SeekableIterator {
4115    /**
4116     * Get the current DirectoryIterator item.
4117     *
4118     * @return DirectoryIterator
4119     * @since PHP 5
4120     **/
4121    function current(){}
4122
4123    /**
4124     * Get the last access time of the current DirectoryIterator item.
4125     *
4126     * @return int
4127     * @since PHP 5
4128     **/
4129    function getATime(){}
4130
4131    /**
4132     * Get the base name of the current DirectoryIterator item.
4133     *
4134     * @param string $suffix If the base name ends in {@link suffix}, this
4135     *   will be cut.
4136     * @return string
4137     * @since PHP 5 >= 5.2.2
4138     **/
4139    function getBasename($suffix){}
4140
4141    /**
4142     * Get the inode change time for the current DirectoryIterator item.
4143     *
4144     * @return int
4145     * @since PHP 5
4146     **/
4147    function getCTime(){}
4148
4149    /**
4150     * Get the file name of the current DirectoryIterator item.
4151     *
4152     * @return string
4153     * @since PHP 5
4154     **/
4155    function getFilename(){}
4156
4157    /**
4158     * Get the group id of the file.
4159     *
4160     * @return int
4161     * @since PHP 5
4162     **/
4163    function getGroup(){}
4164
4165    /**
4166     * Get the inode number for the current DirectoryIterator item.
4167     *
4168     * @return int
4169     * @since PHP 5
4170     **/
4171    function getInode(){}
4172
4173    /**
4174     * Get the last modification time of the current DirectoryIterator item,
4175     * as a Unix timestamp.
4176     *
4177     * @return int
4178     * @since PHP 5
4179     **/
4180    function getMTime(){}
4181
4182    /**
4183     * Get the owner of the current DirectoryIterator item, in numerical
4184     * format.
4185     *
4186     * @return int
4187     * @since PHP 5
4188     **/
4189    function getOwner(){}
4190
4191    /**
4192     * Get the path to the current DirectoryIterator item.
4193     *
4194     * @return string
4195     * @since PHP 5
4196     **/
4197    function getPath(){}
4198
4199    /**
4200     * Get the path and file name of the current file.
4201     *
4202     * @return string
4203     * @since PHP 5
4204     **/
4205    function getPathname(){}
4206
4207    /**
4208     * Get the permissions of the current DirectoryIterator item.
4209     *
4210     * @return int
4211     * @since PHP 5
4212     **/
4213    function getPerms(){}
4214
4215    /**
4216     * Get the file size for the current DirectoryIterator item.
4217     *
4218     * @return int
4219     * @since PHP 5
4220     **/
4221    function getSize(){}
4222
4223    /**
4224     * Determines which file type the current DirectoryIterator item belongs
4225     * to. One of file, link, or dir.
4226     *
4227     * @return string
4228     * @since PHP 5
4229     **/
4230    function getType(){}
4231
4232    /**
4233     * Determines if the current DirectoryIterator item is a directory.
4234     *
4235     * @return bool
4236     * @since PHP 5
4237     **/
4238    function isDir(){}
4239
4240    /**
4241     * Determines if the current DirectoryIterator item is a directory and
4242     * either . or ...
4243     *
4244     * @return bool
4245     * @since PHP 5
4246     **/
4247    function isDot(){}
4248
4249    /**
4250     * Determines if the current DirectoryIterator item is executable.
4251     *
4252     * @return bool
4253     * @since PHP 5
4254     **/
4255    function isExecutable(){}
4256
4257    /**
4258     * Determines if the current DirectoryIterator item is a regular file.
4259     *
4260     * @return bool
4261     * @since PHP 5
4262     **/
4263    function isFile(){}
4264
4265    /**
4266     * Determines if the current DirectoryIterator item is a symbolic link.
4267     *
4268     * @return bool
4269     * @since PHP 5
4270     **/
4271    function isLink(){}
4272
4273    /**
4274     * Determines if the current DirectoryIterator item is readable.
4275     *
4276     * @return bool
4277     * @since PHP 5
4278     **/
4279    function isReadable(){}
4280
4281    /**
4282     * Determines if the current DirectoryIterator item is writable.
4283     *
4284     * @return bool
4285     * @since PHP 5
4286     **/
4287    function isWritable(){}
4288
4289    /**
4290     * Get the key for the current DirectoryIterator item.
4291     *
4292     * @return string
4293     * @since PHP 5
4294     **/
4295    function key(){}
4296
4297    /**
4298     * Move forward to the next DirectoryIterator item.
4299     *
4300     * @return void
4301     * @since PHP 5
4302     **/
4303    function next(){}
4304
4305    /**
4306     * Rewind the DirectoryIterator back to the start.
4307     *
4308     * @return void
4309     * @since PHP 5
4310     **/
4311    function rewind(){}
4312
4313    /**
4314     * Seek to a given position in the DirectoryIterator.
4315     *
4316     * @param int $position The zero-based numeric position to seek to.
4317     * @return void
4318     **/
4319    function seek($position){}
4320
4321    /**
4322     * Check whether current DirectoryIterator position is a valid file.
4323     *
4324     * @return bool
4325     * @since PHP 5
4326     **/
4327    function valid(){}
4328
4329    /**
4330     * Get the file name of the current DirectoryIterator item.
4331     *
4332     * @return string
4333     * @since PHP 5
4334     **/
4335    function __toString(){}
4336
4337}
4338/**
4339 * Exception thrown if a value does not adhere to a defined valid data
4340 * domain
4341 **/
4342class DomainException extends LogicException {
4343}
4344/**
4345 * represents an attribute in the object.
4346 **/
4347class DomAttr extends DOMNode {
4348    /**
4349     * This function checks if the attribute is a defined ID.
4350     *
4351     * According to the DOM standard this requires a DTD which defines the
4352     * attribute ID to be of type ID. You need to validate your document with
4353     * or DOMDocument::validateOnParse before using this function.
4354     *
4355     * @return bool
4356     * @since PHP 5
4357     **/
4358    function isId(){}
4359
4360    /**
4361     * Creates a new DOMAttr object. This object is read only. It may be
4362     * appended to a document, but additional nodes may not be appended to
4363     * this node until the node is associated with a document. To create a
4364     * writable node, use .
4365     *
4366     * @param string $name The tag name of the attribute.
4367     * @param string $value The value of the attribute.
4368     * @since PHP 5
4369     **/
4370    function __construct($name, $value){}
4371
4372}
4373class DomAttribute {
4374    /**
4375     * Gets the name of the attribute.
4376     *
4377     * @return string
4378     * @since PHP 4 >= 4.1.0
4379     **/
4380    function name(){}
4381
4382    /**
4383     * This function sets the value of an attribute.
4384     *
4385     * @param string $content The new value.
4386     * @return bool
4387     * @since PHP 4 >= 4.1.0
4388     **/
4389    function set_value($content){}
4390
4391    /**
4392     * Checks if the attribute was explicitly given a value in the original
4393     * document.
4394     *
4395     * @return bool
4396     * @since PHP 4 >= 4.1.0
4397     **/
4398    function specified(){}
4399
4400    /**
4401     * This function returns the value of the attribute.
4402     *
4403     * @return string
4404     * @since PHP 4 >= 4.1.0
4405     **/
4406    function value(){}
4407
4408}
4409/**
4410 * Represents nodes with character data. No nodes directly correspond to
4411 * this class, but other nodes do inherit from it.
4412 **/
4413class DomCharacterData extends DOMNode {
4414    /**
4415     * Append the string {@link data} to the end of the character data of the
4416     * node.
4417     *
4418     * @param string $data The string to append.
4419     * @return void
4420     * @since PHP 5
4421     **/
4422    function appendData($data){}
4423
4424    /**
4425     * Deletes {@link count} characters starting from position {@link
4426     * offset}.
4427     *
4428     * @param int $offset The offset from which to start removing.
4429     * @param int $count The number of characters to delete. If the sum of
4430     *   {@link offset} and {@link count} exceeds the length, then all
4431     *   characters to the end of the data are deleted.
4432     * @return void
4433     * @since PHP 5
4434     **/
4435    function deleteData($offset, $count){}
4436
4437    /**
4438     * Inserts string {@link data} at position {@link offset}.
4439     *
4440     * @param int $offset The character offset at which to insert.
4441     * @param string $data The string to insert.
4442     * @return void
4443     * @since PHP 5
4444     **/
4445    function insertData($offset, $data){}
4446
4447    /**
4448     * Replace {@link count} characters starting from position {@link offset}
4449     * with {@link data}.
4450     *
4451     * @param int $offset The offset from which to start replacing.
4452     * @param int $count The number of characters to replace. If the sum of
4453     *   {@link offset} and {@link count} exceeds the length, then all
4454     *   characters to the end of the data are replaced.
4455     * @param string $data The string with which the range must be
4456     *   replaced.
4457     * @return void
4458     * @since PHP 5
4459     **/
4460    function replaceData($offset, $count, $data){}
4461
4462    /**
4463     * Returns the specified substring.
4464     *
4465     * @param int $offset Start offset of substring to extract.
4466     * @param int $count The number of characters to extract.
4467     * @return string
4468     * @since PHP 5
4469     **/
4470    function substringData($offset, $count){}
4471
4472}
4473/**
4474 * Represents comment nodes, characters delimited by and .
4475 **/
4476class DomComment extends DOMCharacterData {
4477    /**
4478     * Creates a new DOMComment object. This object is read only. It may be
4479     * appended to a document, but additional nodes may not be appended to
4480     * this node until the node is associated with a document. To create a
4481     * writeable node, use .
4482     *
4483     * @param string $value The value of the comment.
4484     * @since PHP 5
4485     **/
4486    function __construct($value){}
4487
4488}
4489/**
4490 * Represents an entire HTML or XML document; serves as the root of the
4491 * document tree.
4492 **/
4493class DomDocument extends DOMNode {
4494    /**
4495     * Adds a root element node to a dom document and returns the new node.
4496     * The element name is given in the passed parameter.
4497     *
4498     * Creating a simple HTML document header
4499     *
4500     * <?php $doc = domxml_new_doc("1.0"); $root = $doc->add_root("html");
4501     * $head = $root->new_child("head", ""); $head->new_child("title", "Hier
4502     * der Titel"); echo htmlentities($doc->dump_mem()); ?>
4503     *
4504     * @param string $name
4505     * @return domelement
4506     * @since PHP 4 >= 4.1.0
4507     **/
4508    function add_root($name){}
4509
4510    /**
4511     * This function creates a new instance of class DOMAttr.
4512     *
4513     * @param string $name The name of the attribute.
4514     * @return DOMAttr
4515     * @since PHP 5
4516     **/
4517    function createAttribute($name){}
4518
4519    /**
4520     * This function creates a new instance of class DOMAttr.
4521     *
4522     * @param string $namespaceURI The URI of the namespace.
4523     * @param string $qualifiedName The tag name and prefix of the
4524     *   attribute, as prefix:tagname.
4525     * @return DOMAttr
4526     * @since PHP 5
4527     **/
4528    function createAttributeNS($namespaceURI, $qualifiedName){}
4529
4530    /**
4531     * This function creates a new instance of class DOMCDATASection.
4532     *
4533     * @param string $data The content of the cdata.
4534     * @return DOMCDATASection
4535     * @since PHP 5
4536     **/
4537    function createCDATASection($data){}
4538
4539    /**
4540     * This function creates a new instance of class DOMComment.
4541     *
4542     * @param string $data The content of the comment.
4543     * @return DOMComment
4544     * @since PHP 5
4545     **/
4546    function createComment($data){}
4547
4548    /**
4549     * This function creates a new instance of class DOMDocumentFragment.
4550     *
4551     * @return DOMDocumentFragment
4552     * @since PHP 5
4553     **/
4554    function createDocumentFragment(){}
4555
4556    /**
4557     * This function creates a new instance of class DOMElement.
4558     *
4559     * @param string $name The tag name of the element.
4560     * @param string $value The value of the element. By default, an empty
4561     *   element will be created. The value can also be set later with
4562     *   DOMElement->nodeValue.
4563     * @return DOMElement
4564     * @since PHP 5
4565     **/
4566    function createElement($name, $value){}
4567
4568    /**
4569     * This function creates a new element node with an associated namespace.
4570     *
4571     * @param string $namespaceURI The URI of the namespace.
4572     * @param string $qualifiedName The qualified name of the element, as
4573     *   prefix:tagname.
4574     * @param string $value The value of the element. By default, an empty
4575     *   element will be created. You can also set the value later with
4576     *   DOMElement->nodeValue.
4577     * @return DOMElement
4578     * @since PHP 5
4579     **/
4580    function createElementNS($namespaceURI, $qualifiedName, $value){}
4581
4582    /**
4583     * This function creates a new instance of class DOMEntityReference.
4584     *
4585     * @param string $name The content of the entity reference, e.g. the
4586     *   entity reference minus the leading & and the trailing ; characters.
4587     * @return DOMEntityReference
4588     * @since PHP 5
4589     **/
4590    function createEntityReference($name){}
4591
4592    /**
4593     * This function creates a new instance of class
4594     * DOMProcessingInstruction.
4595     *
4596     * @param string $target The target of the processing instruction.
4597     * @param string $data The content of the processing instruction.
4598     * @return DOMProcessingInstruction
4599     * @since PHP 5
4600     **/
4601    function createProcessingInstruction($target, $data){}
4602
4603    /**
4604     * This function creates a new instance of class DOMText.
4605     *
4606     * @param string $content The content of the text.
4607     * @return DOMText
4608     * @since PHP 5
4609     **/
4610    function createTextNode($content){}
4611
4612    /**
4613     * This function returns a new instance of class DomAttribute. The name
4614     * of the attribute is the value of the first parameter. The value of the
4615     * attribute is the value of the second parameter.
4616     *
4617     * The return value is if an error occurred.
4618     *
4619     * See also {@link domnode_append_child}, {@link
4620     * domdocument_create_element}, {@link domdocument_create_text}, {@link
4621     * domdocument_create_cdata_section}, {@link
4622     * domdocument_create_processing_instruction}, {@link
4623     * domdocument_create_entity_reference}, and {@link
4624     * domnode_insert_before}.
4625     *
4626     * @param string $name
4627     * @param string $value
4628     * @return domattribute
4629     * @since PHP 4 >= 4.1.0
4630     **/
4631    function create_attribute($name, $value){}
4632
4633    /**
4634     * This function returns a new instance of class DomCData. The content of
4635     * the cdata is the value of the passed parameter.
4636     *
4637     * The return value is if an error occurred.
4638     *
4639     * See also {@link domnode_append_child}, {@link
4640     * domdocument_create_element}, {@link domdocument_create_text}, {@link
4641     * domdocument_create_attribute}, {@link
4642     * domdocument_create_processing_instruction}, {@link
4643     * domdocument_create_entity_reference}, and {@link
4644     * domnode_insert_before}.
4645     *
4646     * @param string $content
4647     * @return domcdata
4648     * @since PHP 4 >= 4.1.0
4649     **/
4650    function create_cdata_section($content){}
4651
4652    /**
4653     * This function returns a new instance of class DomComment. The content
4654     * of the comment is the value of the passed parameter.
4655     *
4656     * The return value is if an error occurred.
4657     *
4658     * See also {@link domnode_append_child}, {@link
4659     * domdocument_create_element}, {@link domdocument_create_text}, {@link
4660     * domdocument_create_attribute}, {@link
4661     * domdocument_create_processing_instruction}, {@link
4662     * domdocument_create_entity_reference}, and {@link
4663     * domnode_insert_before}.
4664     *
4665     * @param string $content
4666     * @return domcomment
4667     * @since PHP 4 >= 4.1.0
4668     **/
4669    function create_comment($content){}
4670
4671    /**
4672     * This function returns a new instance of class DomElement. The tag name
4673     * of the element is the value of the passed parameter.
4674     *
4675     * The return value is if an error occurred.
4676     *
4677     * See also {@link domdocument_create_element_ns}, {@link
4678     * domnode_append_child}, {@link domdocument_create_text}, {@link
4679     * domdocument_create_comment}, {@link domdocument_create_attribute},
4680     * {@link domdocument_create_processing_instruction}, {@link
4681     * domdocument_create_entity_reference}, and {@link
4682     * domnode_insert_before}.
4683     *
4684     * @param string $name
4685     * @return domelement
4686     * @since PHP 4 >= 4.1.0
4687     **/
4688    function create_element($name){}
4689
4690    /**
4691     * This function returns a new instance of class DomElement. The tag name
4692     * of the element is the value of the passed parameter {@link name}. The
4693     * URI of the namespace is the value of the passed parameter {@link uri}.
4694     * If there is already a namespace declaration with the same uri in the
4695     * root-node of the document, the prefix of this is taken, otherwise it
4696     * will take the one provided in the optional parameter {@link prefix} or
4697     * generate a random one.
4698     *
4699     * The return value is if an error occurred.
4700     *
4701     * See also {@link domdocument_create_element_ns}, {@link
4702     * domnode_add_namespace}, {@link domnode_set_namespace}, {@link
4703     * domnode_append_child}, {@link domdocument_create_text}, {@link
4704     * domdocument_create_comment}, {@link domdocument_create_attribute},
4705     * {@link domdocument_create_processing_instruction}, {@link
4706     * domdocument_create_entity_reference}, and {@link
4707     * domnode_insert_before}.
4708     *
4709     * @param string $uri
4710     * @param string $name
4711     * @param string $prefix
4712     * @return domelement
4713     * @since PHP 4 >= 4.1.0
4714     **/
4715    function create_element_ns($uri, $name, $prefix){}
4716
4717    /**
4718     * This function returns a new instance of class DomEntityReference. The
4719     * content of the entity reference is the value of the passed parameter.
4720     *
4721     * The return value is if an error occurred.
4722     *
4723     * See also {@link domnode_append_child}, {@link
4724     * domdocument_create_element}, {@link domdocument_create_text}, {@link
4725     * domdocument_create_cdata_section}, {@link
4726     * domdocument_create_processing_instruction}, {@link
4727     * domdocument_create_attribute}, and {@link domnode_insert_before}.
4728     *
4729     * @param string $content
4730     * @return domentityreference
4731     * @since PHP 4 >= 4.1.0
4732     **/
4733    function create_entity_reference($content){}
4734
4735    /**
4736     * This function returns a new instance of class DomCData. The content of
4737     * the pi is the value of the passed parameter.
4738     *
4739     * The return value is if an error occurred.
4740     *
4741     * See also {@link domnode_append_child}, {@link
4742     * domdocument_create_element}, {@link domdocument_create_text}, {@link
4743     * domdocument_create_cdata_section}, {@link
4744     * domdocument_create_attribute}, {@link
4745     * domdocument_create_entity_reference}, and {@link
4746     * domnode_insert_before}.
4747     *
4748     * @param string $content
4749     * @return domprocessinginstruction
4750     * @since PHP 4 >= 4.1.0
4751     **/
4752    function create_processing_instruction($content){}
4753
4754    /**
4755     * This function returns a new instance of class DomText. The content of
4756     * the text is the value of the passed parameter.
4757     *
4758     * The return value is if an error occurred.
4759     *
4760     * See also {@link domnode_append_child}, {@link
4761     * domdocument_create_element}, {@link domdocument_create_comment},
4762     * {@link domdocument_create_text}, {@link domdocument_create_attribute},
4763     * {@link domdocument_create_processing_instruction}, {@link
4764     * domdocument_create_entity_reference}, and {@link
4765     * domnode_insert_before}.
4766     *
4767     * @param string $content
4768     * @return domtext
4769     * @since PHP 4 >= 4.1.0
4770     **/
4771    function create_text_node($content){}
4772
4773    /**
4774     * This function returns an object of class DomDocumentType. In versions
4775     * of PHP before 4.3 this has been the class Dtd, but the DOM Standard
4776     * does not know such a class.
4777     *
4778     * See also the methods of class DomDocumentType.
4779     *
4780     * @return domdocumenttype
4781     * @since PHP 4 >= 4.1.0
4782     **/
4783    function doctype(){}
4784
4785    /**
4786     * This function returns the root element node of a document.
4787     *
4788     * The following example returns just the element with name CHAPTER and
4789     * prints it. The other node -- the comment -- is not returned.
4790     * Retrieving root element
4791     *
4792     * <?php include("example.inc");
4793     *
4794     * if (!$dom = domxml_open_mem($xmlstr)) { echo "Error while parsing the
4795     * document\n"; exit; }
4796     *
4797     * $root = $dom->document_element(); print_r($root); ?>
4798     *
4799     * domelement Object ( [type] => 1 [tagname] => chapter [0] => 6 [1] =>
4800     * 137960648 )
4801     *
4802     * @return domelement
4803     * @since PHP 4 >= 4.1.0
4804     **/
4805    function document_element(){}
4806
4807    /**
4808     * Creates an XML document from the dom representation. This function
4809     * usually is called after building a new dom document from scratch as in
4810     * the example below. The {@link format} specifies whether the output
4811     * should be neatly formatted, or not. The first parameter specifies the
4812     * name of the filename and the second parameter, whether it should be
4813     * compressed or not.
4814     *
4815     * Creating a simple HTML document header
4816     *
4817     * <?php $doc = domxml_new_doc("1.0"); $root =
4818     * $doc->create_element("HTML"); $root = $doc->append_child($root); $head
4819     * = $doc->create_element("HEAD"); $head = $root->append_child($head);
4820     * $title = $doc->create_element("TITLE"); $title =
4821     * $head->append_child($title); $text = $doc->create_text_node("This is
4822     * the title"); $text = $title->append_child($text);
4823     * $doc->dump_file("/tmp/test.xml", false, true); ?>
4824     *
4825     * See also {@link domdocument_dump_mem}, and {@link
4826     * domdocument_html_dump_mem}.
4827     *
4828     * @param string $filename
4829     * @param bool $compressionmode
4830     * @param bool $format
4831     * @return string
4832     * @since PHP 4 >= 4.1.0
4833     **/
4834    function dump_file($filename, $compressionmode, $format){}
4835
4836    /**
4837     * Creates an XML document from the dom representation. This function
4838     * usually is called after building a new dom document from scratch as in
4839     * the example below. The {@link format} specifies whether the output
4840     * should be neatly formatted, or not.
4841     *
4842     * Creating a simple HTML document header
4843     *
4844     * <?php $doc = domxml_new_doc("1.0"); $root =
4845     * $doc->create_element("HTML"); $root = $doc->append_child($root); $head
4846     * = $doc->create_element("HEAD"); $head = $root->append_child($head);
4847     * $title = $doc->create_element("TITLE"); $title =
4848     * $head->append_child($title); $text = $doc->create_text_node("This is
4849     * the title"); $text = $title->append_child($text); echo "<PRE>"; echo
4850     * htmlentities($doc->dump_mem(true)); echo "</PRE>"; ?>
4851     *
4852     * See also {@link domdocument_dump_file}, and {@link
4853     * domdocument_html_dump_mem}.
4854     *
4855     * @param bool $format
4856     * @param string $encoding
4857     * @return string
4858     * @since PHP 4 >= 4.1.0
4859     **/
4860    function dump_mem($format, $encoding){}
4861
4862    /**
4863     * This function is similar to but searches for an element with a given
4864     * id.
4865     *
4866     * For this function to work, you will need either to set some ID
4867     * attributes with or a DTD which defines an attribute to be of type ID.
4868     * In the later case, you will need to validate your document with or
4869     * DOMDocument->validateOnParse before using this function.
4870     *
4871     * @param string $elementId The unique id value for an element.
4872     * @return DOMElement
4873     * @since PHP 5
4874     **/
4875    function getElementById($elementId){}
4876
4877    /**
4878     * This function returns a new instance of class DOMNodeList containing
4879     * the elements with a given tag name.
4880     *
4881     * @param string $name The name of the tag to match on. The special
4882     *   value * matches all tags.
4883     * @return DOMNodeList
4884     * @since PHP 5
4885     **/
4886    function getElementsByTagName($name){}
4887
4888    /**
4889     * Returns a DOMNodeList of all elements with a given local name and a
4890     * namespace URI.
4891     *
4892     * @param string $namespaceURI The namespace URI of the elements to
4893     *   match on. The special value * matches all namespaces.
4894     * @param string $localName The local name of the elements to match on.
4895     *   The special value * matches all local names.
4896     * @return DOMNodeList
4897     * @since PHP 5
4898     **/
4899    function getElementsByTagNameNS($namespaceURI, $localName){}
4900
4901    /**
4902     * See also {@link domdocument_add_root}
4903     *
4904     * @param string $name
4905     * @return array
4906     * @since PHP 4 >= 4.1.0
4907     **/
4908    function get_elements_by_tagname($name){}
4909
4910    /**
4911     * This function is similar to {@link
4912     * domdocument_get_elements_by_tagname} but searches for an element with
4913     * a given id. According to the DOM standard this requires a DTD which
4914     * defines the attribute ID to be of type ID, though the current
4915     * implementation simply does an xpath search for "//*[@ID = '%s']". This
4916     * does not comply to the DOM standard which requires to return null if
4917     * it is not known which attribute is of type id. This behaviour is
4918     * likely to be fixed, so do not rely on the current behaviour.
4919     *
4920     * See also {@link domdocument_get_elements_by_tagname}
4921     *
4922     * @param string $id
4923     * @return domelement
4924     * @since PHP 4 >= 4.1.0
4925     **/
4926    function get_element_by_id($id){}
4927
4928    /**
4929     * Creates an HTML document from the dom representation. This function
4930     * usually is called after building a new dom document from scratch as in
4931     * the example below.
4932     *
4933     * Creating a simple HTML document header
4934     *
4935     * <?php
4936     *
4937     * // Creates the document $doc = domxml_new_doc("1.0");
4938     *
4939     * $root = $doc->create_element("html"); $root =
4940     * $doc->append_child($root);
4941     *
4942     * $head = $doc->create_element("head"); $head =
4943     * $root->append_child($head);
4944     *
4945     * $title = $doc->create_element("title"); $title =
4946     * $head->append_child($title);
4947     *
4948     * $text = $doc->create_text_node("This is the title"); $text =
4949     * $title->append_child($text);
4950     *
4951     * echo $doc->html_dump_mem(); ?>
4952     *
4953     * <html><head><title>This is the title</title></head></html>
4954     *
4955     * See also {@link domdocument_dump_file}, and {@link
4956     * domdocument_html_dump_mem}.
4957     *
4958     * @return string
4959     * @since PHP 4 >= 4.1.0
4960     **/
4961    function html_dump_mem(){}
4962
4963    /**
4964     * This function returns a copy of the node to import and associates it
4965     * with the current document.
4966     *
4967     * @param DOMNode $importedNode The node to import.
4968     * @param bool $deep If set to , this method will recursively import
4969     *   the subtree under the {@link importedNode}.
4970     * @return DOMNode
4971     * @since PHP 5
4972     **/
4973    function importNode($importedNode, $deep){}
4974
4975    /**
4976     * Loads an XML document from a file.
4977     *
4978     * @param string $filename The path to the XML document.
4979     * @param int $options Bitwise OR of the libxml option constants.
4980     * @return mixed
4981     * @since PHP 5
4982     **/
4983    function load($filename, $options){}
4984
4985    /**
4986     * The function parses the HTML contained in the string {@link source}.
4987     * Unlike loading XML, HTML does not have to be well-formed to load. This
4988     * function may also be called statically to load and create a
4989     * DOMDocument object. The static invocation may be used when no
4990     * DOMDocument properties need to be set prior to loading.
4991     *
4992     * @param string $source The HTML string.
4993     * @return bool
4994     * @since PHP 5
4995     **/
4996    function loadHTML($source){}
4997
4998    /**
4999     * The function parses the HTML document in the file named {@link
5000     * filename}. Unlike loading XML, HTML does not have to be well-formed to
5001     * load.
5002     *
5003     * Though not recommended, this function may also be called statically to
5004     * load and create a DOMDocument object. The static invocation may be
5005     * used when no DOMDocument properties need to be set prior to loading.
5006     * However, doing so will result an in E_STRICT error being generated.
5007     *
5008     * @param string $filename The path to the HTML file.
5009     * @return bool
5010     * @since PHP 5
5011     **/
5012    function loadHTMLFile($filename){}
5013
5014    /**
5015     * Loads an XML document from a string.
5016     *
5017     * This method may also be called statically to load and create a
5018     * DOMDocument object. The static invocation may be used when no
5019     * DOMDocument properties need to be set prior to loading.
5020     *
5021     * @param string $source The string containing the XML.
5022     * @param int $options Bitwise OR of the libxml option constants.
5023     * @return mixed
5024     * @since PHP 5
5025     **/
5026    function loadXML($source, $options){}
5027
5028    /**
5029     * This method acts as if you saved and then loaded the document, putting
5030     * the document in a "normal" form.
5031     *
5032     * @return void
5033     * @since PHP 5
5034     **/
5035    function normalizeDocument(){}
5036
5037    /**
5038     * This method allows you to register your own extended DOM class to be
5039     * used afterward by the PHP DOM extension.
5040     *
5041     * This method is not part of the DOM standard.
5042     *
5043     * @param string $baseclass The DOM class that you want to extend. You
5044     *   can find a list of these classes in the chapter introduction.
5045     * @param string $extendedclass Your extended class name. If is
5046     *   provided, any previously registered class extending {@link
5047     *   baseclass} will be removed.
5048     * @return bool
5049     * @since PHP 5 >= 5.2.0
5050     **/
5051    function registerNodeClass($baseclass, $extendedclass){}
5052
5053    /**
5054     * Performs relaxNG validation on the document based on the given RNG
5055     * schema.
5056     *
5057     * @param string $filename The RNG file.
5058     * @return bool
5059     * @since PHP 5
5060     **/
5061    function relaxNGValidate($filename){}
5062
5063    /**
5064     * Performs relaxNG validation on the document based on the given RNG
5065     * source.
5066     *
5067     * @param string $source A string containing the RNG schema.
5068     * @return bool
5069     * @since PHP 5
5070     **/
5071    function relaxNGValidateSource($source){}
5072
5073    /**
5074     * Creates an XML document from the DOM representation. This function is
5075     * usually called after building a new dom document from scratch as in
5076     * the example below.
5077     *
5078     * @param string $filename The path to the saved XML document.
5079     * @param int $options Additional Options. Currently only
5080     *   LIBXML_NOEMPTYTAG is supported.
5081     * @return int
5082     * @since PHP 5
5083     **/
5084    function save($filename, $options){}
5085
5086    /**
5087     * Creates an HTML document from the DOM representation. This function is
5088     * usually called after building a new dom document from scratch as in
5089     * the example below.
5090     *
5091     * @return string
5092     * @since PHP 5
5093     **/
5094    function saveHTML(){}
5095
5096    /**
5097     * Creates an HTML document from the DOM representation. This function is
5098     * usually called after building a new dom document from scratch as in
5099     * the example below.
5100     *
5101     * @param string $filename The path to the saved HTML document.
5102     * @return int
5103     * @since PHP 5
5104     **/
5105    function saveHTMLFile($filename){}
5106
5107    /**
5108     * Creates an XML document from the DOM representation. This function is
5109     * usually called after building a new dom document from scratch as in
5110     * the example below.
5111     *
5112     * @param DOMNode $node Use this parameter to output only a specific
5113     *   node without XML declaration rather than the entire document.
5114     * @param int $options Additional Options. Currently only
5115     *   LIBXML_NOEMPTYTAG is supported.
5116     * @return string
5117     * @since PHP 5
5118     **/
5119    function saveXML($node, $options){}
5120
5121    /**
5122     * Validates a document based on the given schema file.
5123     *
5124     * @param string $filename The path to the schema.
5125     * @return bool
5126     * @since PHP 5
5127     **/
5128    function schemaValidate($filename){}
5129
5130    /**
5131     * Validates a document based on a schema defined in the given string.
5132     *
5133     * @param string $source A string containing the schema.
5134     * @return bool
5135     * @since PHP 5
5136     **/
5137    function schemaValidateSource($source){}
5138
5139    /**
5140     * Validates the document based on its DTD.
5141     *
5142     * You can also use the validateOnParse property of DOMDocument to make a
5143     * DTD validation.
5144     *
5145     * @return bool
5146     * @since PHP 5
5147     **/
5148    function validate(){}
5149
5150    /**
5151     * This method substitutes XIncludes in a DOMDocument object.
5152     *
5153     * @param int $options libxml parameters. Available since PHP 5.1.0 and
5154     *   Libxml 2.6.7.
5155     * @return int
5156     * @since PHP 5
5157     **/
5158    function xinclude($options){}
5159
5160    /**
5161     * Creates a new DOMDocument object.
5162     *
5163     * @param string $version The version number of the document as part of
5164     *   the XML declaration.
5165     * @param string $encoding The encoding of the document as part of the
5166     *   XML declaration.
5167     * @since PHP 5
5168     **/
5169    function __construct($version, $encoding){}
5170
5171}
5172class DomDocumentFragment extends DOMNode {
5173    /**
5174     * Appends raw XML data to a DOMDocumentFragment.
5175     *
5176     * This method is not part of the DOM standard. It was created as a
5177     * simpler approach for appending an XML DocumentFragment in a
5178     * DOMDocument.
5179     *
5180     * If you want to stick to the standards, you will have to create a
5181     * temporary DOMDocument with a dummy root and then loop through the
5182     * child nodes of the root of your XML data to append them.
5183     *
5184     * @param string $data XML to append.
5185     * @return bool
5186     * @since PHP 5 >= 5.1.0
5187     **/
5188    function appendXML($data){}
5189
5190}
5191/**
5192 * Each has a attribute whose value is either or a object.
5193 **/
5194class DomDocumentType extends DOMNode {
5195    /**
5196     * @return array
5197     * @since PHP 4 >= 4.1.0
5198     **/
5199    function entities(){}
5200
5201    /**
5202     * @return bool
5203     * @since PHP 4 >= 4.1.0
5204     **/
5205    function internal_subset(){}
5206
5207    /**
5208     * This function returns the name of the document type.
5209     *
5210     * @return string
5211     * @since PHP 4 >= 4.1.0
5212     **/
5213    function name(){}
5214
5215    /**
5216     * @return array
5217     * @since PHP 4 >= 4.1.0
5218     **/
5219    function notations(){}
5220
5221    /**
5222     * This function returns the public id of the document type.
5223     *
5224     * @return string
5225     * @since PHP 4 >= 4.1.0
5226     **/
5227    function public_id(){}
5228
5229    /**
5230     * Returns the system id of the document type.
5231     *
5232     * @return string
5233     * @since PHP 4 >= 4.1.0
5234     **/
5235    function system_id(){}
5236
5237}
5238class DomElement extends DOMNode {
5239    /**
5240     * Gets the value of the attribute with name {@link name} for the current
5241     * node.
5242     *
5243     * @param string $name The name of the attribute.
5244     * @return string
5245     * @since PHP 5
5246     **/
5247    function getAttribute($name){}
5248
5249    /**
5250     * Returns the attribute node with name {@link name} for the current
5251     * element.
5252     *
5253     * @param string $name The name of the attribute.
5254     * @return DOMAttr
5255     * @since PHP 5
5256     **/
5257    function getAttributeNode($name){}
5258
5259    /**
5260     * Returns the attribute node in namespace {@link namespaceURI} with
5261     * local name {@link localName} for the current node.
5262     *
5263     * @param string $namespaceURI The namespace URI.
5264     * @param string $localName The local name.
5265     * @return DOMAttr
5266     * @since PHP 5
5267     **/
5268    function getAttributeNodeNS($namespaceURI, $localName){}
5269
5270    /**
5271     * Gets the value of the attribute in namespace {@link namespaceURI} with
5272     * local name {@link localName} for the current node.
5273     *
5274     * @param string $namespaceURI The namespace URI.
5275     * @param string $localName The local name.
5276     * @return string
5277     * @since PHP 5
5278     **/
5279    function getAttributeNS($namespaceURI, $localName){}
5280
5281    /**
5282     * This function returns a new instance of the class DOMNodeList of all
5283     * descendant elements with a given tag {@link name}, in the order in
5284     * which they are encountered in a preorder traversal of this element
5285     * tree.
5286     *
5287     * @param string $name The tag name. Use * to return all elements
5288     *   within the element tree.
5289     * @return DOMNodeList
5290     * @since PHP 5
5291     **/
5292    function getElementsByTagName($name){}
5293
5294    /**
5295     * This function fetch all the descendant elements with a given {@link
5296     * localName} and {@link namespaceURI}.
5297     *
5298     * @param string $namespaceURI The namespace URI.
5299     * @param string $localName The local name. Use * to return all
5300     *   elements within the element tree.
5301     * @return DOMNodeList
5302     * @since PHP 5
5303     **/
5304    function getElementsByTagNameNS($namespaceURI, $localName){}
5305
5306    /**
5307     * Returns the value of the given attribute in the current element.
5308     *
5309     * Since PHP 4.3, if no attribute with given {@link name} is found, an
5310     * empty string is returned.
5311     *
5312     * @param string $name The name of the seeked attribute. This parameter
5313     *   is case sensitive.
5314     * @return string
5315     * @since PHP 4 >= 4.1.0
5316     **/
5317    function get_attribute($name){}
5318
5319    /**
5320     * Returns the node of the given attribute in the current element.
5321     *
5322     * @param string $name The name of the seeked attribute. This parameter
5323     *   is case sensitive.
5324     * @return DomAttribute
5325     * @since PHP 4 >= 4.1.0
5326     **/
5327    function get_attribute_node($name){}
5328
5329    /**
5330     * Gets all the sub elements with the specific {@link name} within the
5331     * current element.
5332     *
5333     * @param string $name The name of the seeked element.
5334     * @return array
5335     * @since PHP 4 >= 4.1.0
5336     **/
5337    function get_elements_by_tagname($name){}
5338
5339    /**
5340     * Indicates whether attribute named {@link name} exists as a member of
5341     * the element.
5342     *
5343     * @param string $name The attribute name.
5344     * @return bool
5345     * @since PHP 5
5346     **/
5347    function hasAttribute($name){}
5348
5349    /**
5350     * Indicates whether attribute in namespace {@link namespaceURI} named
5351     * {@link localName} exists as a member of the element.
5352     *
5353     * @param string $namespaceURI The namespace URI.
5354     * @param string $localName The local name.
5355     * @return bool
5356     * @since PHP 5
5357     **/
5358    function hasAttributeNS($namespaceURI, $localName){}
5359
5360    /**
5361     * This functions checks to see if an attribute named {@link name} exists
5362     * in the current node.
5363     *
5364     * @param string $name The name of the tested attribute.
5365     * @return bool
5366     * @since PHP 4 >= 4.1.0
5367     **/
5368    function has_attribute($name){}
5369
5370    /**
5371     * Removes attribute named {@link name} from the element.
5372     *
5373     * @param string $name The name of the attribute.
5374     * @return bool
5375     * @since PHP 5
5376     **/
5377    function removeAttribute($name){}
5378
5379    /**
5380     * Removes attribute {@link oldnode} from the element.
5381     *
5382     * @param DOMAttr $oldnode The attribute node.
5383     * @return bool
5384     * @since PHP 5
5385     **/
5386    function removeAttributeNode($oldnode){}
5387
5388    /**
5389     * Removes attribute is namespace {@link namespaceURI} named {@link
5390     * localName} from the element.
5391     *
5392     * @param string $namespaceURI The namespace URI.
5393     * @param string $localName The local name.
5394     * @return bool
5395     * @since PHP 5
5396     **/
5397    function removeAttributeNS($namespaceURI, $localName){}
5398
5399    /**
5400     * Removes an attribute from the current DomElement node.
5401     *
5402     * @param string $name The name of the attribute to remove.
5403     * @return bool
5404     * @since PHP 4 >= 4.1.0
5405     **/
5406    function remove_attribute($name){}
5407
5408    /**
5409     * Sets an attribute with name {@link name} to the given value. If the
5410     * attribute does not exist, it will be created.
5411     *
5412     * @param string $name The name of the attribute.
5413     * @param string $value The value of the attribute.
5414     * @return DOMAttr
5415     * @since PHP 5
5416     **/
5417    function setAttribute($name, $value){}
5418
5419    /**
5420     * Adds new attribute node {@link attr} to element.
5421     *
5422     * @param DOMAttr $attr The attribute node.
5423     * @return DOMAttr
5424     * @since PHP 5
5425     **/
5426    function setAttributeNode($attr){}
5427
5428    /**
5429     * Adds new attribute node {@link attr} to element.
5430     *
5431     * @param DOMAttr $attr The attribute node.
5432     * @return DOMAttr
5433     * @since PHP 5
5434     **/
5435    function setAttributeNodeNS($attr){}
5436
5437    /**
5438     * Sets an attribute with namespace {@link namespaceURI} and name {@link
5439     * name} to the given value. If the attribute does not exist, it will be
5440     * created.
5441     *
5442     * @param string $namespaceURI The namespace URI.
5443     * @param string $qualifiedName The qualified name of the attribute, as
5444     *   prefix:tagname.
5445     * @param string $value The value of the attribute.
5446     * @return void
5447     * @since PHP 5
5448     **/
5449    function setAttributeNS($namespaceURI, $qualifiedName, $value){}
5450
5451    /**
5452     * Declares the attribute {@link name} to be of type ID.
5453     *
5454     * @param string $name The name of the attribute.
5455     * @param bool $isId Set it to if you want {@link name} to be of type
5456     *   ID, otherwise.
5457     * @return void
5458     * @since PHP 5
5459     **/
5460    function setIdAttribute($name, $isId){}
5461
5462    /**
5463     * Declares the attribute specified by {@link attr} to be of type ID.
5464     *
5465     * @param DOMAttr $attr The attribute node.
5466     * @param bool $isId Set it to if you want {@link name} to be of type
5467     *   ID, otherwise.
5468     * @return void
5469     * @since PHP 5
5470     **/
5471    function setIdAttributeNode($attr, $isId){}
5472
5473    /**
5474     * Declares the attribute specified by {@link localName} and {@link
5475     * namespaceURI} to be of type ID.
5476     *
5477     * @param string $namespaceURI The namespace URI of the attribute.
5478     * @param string $localName The local name of the attribute, as
5479     *   prefix:tagname.
5480     * @param bool $isId Set it to if you want {@link name} to be of type
5481     *   ID, otherwise.
5482     * @return void
5483     * @since PHP 5
5484     **/
5485    function setIdAttributeNS($namespaceURI, $localName, $isId){}
5486
5487    /**
5488     * Sets an attribute with name {@link name} to the given {@link value}.
5489     *
5490     * @param string $name The name of the attribute. If this attribute
5491     *   doesn't exist, it will be created.
5492     * @param string $value The value of the attribute.
5493     * @return DomAttribute
5494     * @since PHP 4 >= 4.1.0
5495     **/
5496    function set_attribute($name, $value){}
5497
5498    /**
5499     * @param DomNode $attr
5500     * @return DomNode
5501     * @since PHP 4 >= 4.1.0
5502     **/
5503    function set_attribute_node($attr){}
5504
5505    /**
5506     * Returns the name of the current node. Calling this function is the
5507     * same as accessing the tagname property, or calling on the current
5508     * node.
5509     *
5510     * @return string
5511     * @since PHP 4 >= 4.1.0
5512     **/
5513    function tagname(){}
5514
5515    /**
5516     * Creates a new DOMElement object. This object is read only. It may be
5517     * appended to a document, but additional nodes may not be appended to
5518     * this node until the node is associated with a document. To create a
5519     * writeable node, use or .
5520     *
5521     * @param string $name The tag name of the element. When also passing
5522     *   in namespaceURI, the element name may take a prefix to be associated
5523     *   with the URI.
5524     * @param string $value The value of the element.
5525     * @param string $namespaceURI A namespace URI to create the element
5526     *   within a specific namespace.
5527     * @since PHP 5
5528     **/
5529    function __construct($name, $value, $namespaceURI){}
5530
5531}
5532/**
5533 * This interface represents a known entity, either parsed or unparsed,
5534 * in an XML document.
5535 **/
5536class DOMEntity extends DOMNode {
5537}
5538class DomEntityReference extends DOMNode {
5539    /**
5540     * Creates a new DOMEntityReference object.
5541     *
5542     * @param string $name The name of the entity reference.
5543     * @since PHP 5
5544     **/
5545    function __construct($name){}
5546
5547}
5548/**
5549 * DOM operations raise exceptions under particular circumstances, i.e.,
5550 * when an operation is impossible to perform for logical reasons.
5551 *
5552 * See also .
5553 **/
5554class DOMException extends Exception {
5555}
5556/**
5557 * The interface provides a number of methods for performing operations
5558 * that are independent of any particular instance of the document object
5559 * model.
5560 **/
5561class DomImplementation {
5562    /**
5563     * Creates a DOMDocument object of the specified type with its document
5564     * element.
5565     *
5566     * @param string $namespaceURI The namespace URI of the document
5567     *   element to create.
5568     * @param string $qualifiedName The qualified name of the document
5569     *   element to create.
5570     * @param DOMDocumentType $doctype The type of document to create or .
5571     * @return DOMDocument
5572     * @since PHP 5
5573     **/
5574    function createDocument($namespaceURI, $qualifiedName, $doctype){}
5575
5576    /**
5577     * Creates an empty DOMDocumentType object. Entity declarations and
5578     * notations are not made available. Entity reference expansions and
5579     * default attribute additions do not occur.
5580     *
5581     * @param string $qualifiedName The qualified name of the document type
5582     *   to create.
5583     * @param string $publicId The external subset public identifier.
5584     * @param string $systemId The external subset system identifier.
5585     * @return DOMDocumentType
5586     * @since PHP 5
5587     **/
5588    function createDocumentType($qualifiedName, $publicId, $systemId){}
5589
5590    /**
5591     * Test if the DOM implementation implements a specific {@link feature}.
5592     *
5593     * You can find a list of all features in the Conformance section of the
5594     * DOM specification.
5595     *
5596     * @param string $feature The feature to test.
5597     * @param string $version The version number of the {@link feature} to
5598     *   test. In level 2, this can be either 2.0 or 1.0.
5599     * @return bool
5600     * @since PHP 5
5601     **/
5602    function hasFeature($feature, $version){}
5603
5604    /**
5605     * Creates a new DOMImplementation object.
5606     *
5607     * @since PHP 5
5608     **/
5609    function __construct(){}
5610
5611}
5612class DOMNamedNodeMap {
5613    /**
5614     * Retrieves a node specified by its nodeName.
5615     *
5616     * @param string $name The nodeName of the node to retrieve.
5617     * @return DOMNode
5618     * @since PHP 5
5619     **/
5620    function getNamedItem($name){}
5621
5622    /**
5623     * Retrieves a node specified by {@link localName} and {@link
5624     * namespaceURI}.
5625     *
5626     * @param string $namespaceURI The namespace URI of the node to
5627     *   retrieve.
5628     * @param string $localName The local name of the node to retrieve.
5629     * @return DOMNode
5630     * @since PHP 5
5631     **/
5632    function getNamedItemNS($namespaceURI, $localName){}
5633
5634    /**
5635     * Retrieves a node specified by {@link index} within the DOMNamedNodeMap
5636     * object.
5637     *
5638     * @param int $index Index into this map.
5639     * @return DOMNode
5640     * @since PHP 5
5641     **/
5642    function item($index){}
5643
5644}
5645class DomNode {
5646    /**
5647     * This method adds a namespace declaration to a node.
5648     *
5649     * @param string $uri The namespace URI of the node.
5650     * @param string $prefix The namespace prefix of the node.
5651     * @return bool
5652     * @since PHP 4 >= 4.3.0
5653     **/
5654    function add_namespace($uri, $prefix){}
5655
5656    /**
5657     * This functions appends a child to an existing list of children or
5658     * creates a new list of children. The child can be created with e.g.
5659     * DOMDocument::createElement, DOMDocument::createTextNode etc. or simply
5660     * by using any other node.
5661     *
5662     * @param DOMNode $newnode The appended child.
5663     * @return DOMNode
5664     * @since PHP 5
5665     **/
5666    function appendChild($newnode){}
5667
5668    /**
5669     * This functions appends a child to an existing list of children or
5670     * creates a new list of children.
5671     *
5672     * @param DOMNode $newnode The node being appended. It can be created
5673     *   with e.g. , etc. or simply by using any other node.
5674     * @return DOMNode
5675     * @since PHP 4 >= 4.1.0
5676     **/
5677    function append_child($newnode){}
5678
5679    /**
5680     * This functions appends a sibling to an existing node. The child can be
5681     * created with e.g. {@link domdocument_create_element}, {@link
5682     * domdocument_create_text} etc. or simply by using any other node.
5683     *
5684     * Before a new sibling is added it is first duplicated. Therefore the
5685     * new child is a completely new copy which can be modified without
5686     * changing the node which was passed to this function. If the node
5687     * passed has children itself, they will be duplicated as well, which
5688     * makes it quite easy to duplicate large parts of an XML document. The
5689     * return value is the added sibling. If you plan to do further
5690     * modifications on the added sibling you must use the returned node.
5691     *
5692     * This function has been added to provide the behaviour of {@link
5693     * domnode_append_child} as it works till PHP 4.2.
5694     *
5695     * See also {@link domnode_append_before}.
5696     *
5697     * @param domelement $newnode
5698     * @return domelement
5699     * @since PHP 4 >= 4.2.0
5700     **/
5701    function append_sibling($newnode){}
5702
5703    /**
5704     * This function only returns an array of attributes if the node is of
5705     * type XML_ELEMENT_NODE.
5706     *
5707     * (PHP >= 4.3 only) If no attributes are found, NULL is returned.
5708     *
5709     * @return array
5710     * @since PHP 4 >= 4.1.0
5711     **/
5712    function attributes(){}
5713
5714    /**
5715     * Returns all children of the node.
5716     *
5717     * See also {@link domnode_next_sibling}, and {@link
5718     * domnode_previous_sibling}.
5719     *
5720     * @return array
5721     * @since PHP 4 >= 4.1.0
5722     **/
5723    function child_nodes(){}
5724
5725    /**
5726     * Creates a copy of the node.
5727     *
5728     * @param bool $deep Indicates whether to copy all descendant nodes.
5729     *   This parameter is defaulted to .
5730     * @return DOMNode
5731     * @since PHP 5
5732     **/
5733    function cloneNode($deep){}
5734
5735    /**
5736     * @return domelement
5737     * @since PHP 4 >= 4.1.0
5738     **/
5739    function clone_node(){}
5740
5741    /**
5742     * See also {@link domdocument_dump_mem}.
5743     *
5744     * @return string
5745     * @since PHP 4 >= 4.1.0
5746     **/
5747    function dump_node(){}
5748
5749    /**
5750     * Returns the first child of the node.
5751     *
5752     * (PHP >= 4.3 only) If no first child is found, NULL is returned.
5753     *
5754     * See also {@link domnode_last_child}, and {@link domnode_next_sibling},
5755     * {@link domnode_previous_sibling}.
5756     *
5757     * @return domelement
5758     * @since PHP 4 >= 4.1.0
5759     **/
5760    function first_child(){}
5761
5762    /**
5763     * Gets line number for where the node is defined.
5764     *
5765     * @return int
5766     * @since PHP 5 >= 5.3.0
5767     **/
5768    function getLineNo(){}
5769
5770    /**
5771     * This function returns the content of the actual node.
5772     *
5773     * Getting a content
5774     *
5775     * <?php if (!$dom = domxml_open_mem($xmlstr)) { echo "Error while
5776     * parsing the document\n"; exit; }
5777     *
5778     * $root = $dom->document_element();
5779     *
5780     * $node_array = $root->get_elements_by_tagname("element");
5781     *
5782     * for ($i = 0; $i<count($node_array); $i++) { $node = $node_array[$i];
5783     * echo "The element[$i] is: " . $node->get_content(); }
5784     *
5785     * ?>
5786     *
5787     * @return string
5788     * @since PHP 4 >= 4.2.0
5789     **/
5790    function get_content(){}
5791
5792    /**
5793     * This method checks if the node has attributes. The tested node have to
5794     * be an XML_ELEMENT_NODE.
5795     *
5796     * @return bool
5797     * @since PHP 5
5798     **/
5799    function hasAttributes(){}
5800
5801    /**
5802     * This function checks if the node has children.
5803     *
5804     * @return bool
5805     * @since PHP 5
5806     **/
5807    function hasChildNodes(){}
5808
5809    /**
5810     * This function checks if the node has attributes.
5811     *
5812     * See also {@link domnode_has_child_nodes}.
5813     *
5814     * @return bool
5815     * @since PHP 4 >= 4.1.0
5816     **/
5817    function has_attributes(){}
5818
5819    /**
5820     * This function checks if the node has children.
5821     *
5822     * See also {@link domnode_child_nodes}.
5823     *
5824     * @return bool
5825     * @since PHP 4 >= 4.1.0
5826     **/
5827    function has_child_nodes(){}
5828
5829    /**
5830     * This function inserts a new node right before the reference node. If
5831     * you plan to do further modifications on the appended child you must
5832     * use the returned node.
5833     *
5834     * @param DOMNode $newnode The new node.
5835     * @param DOMNode $refnode The reference node. If not supplied, {@link
5836     *   newnode} is appended to the children.
5837     * @return DOMNode
5838     * @since PHP 5
5839     **/
5840    function insertBefore($newnode, $refnode){}
5841
5842    /**
5843     * This function inserts the new node {@link newnode} right before the
5844     * node {@link refnode}. The return value is the inserted node. If you
5845     * plan to do further modifications on the appended child you must use
5846     * the returned node.
5847     *
5848     * (PHP >= 4.3 only) If {@link newnode} already is part of a document, it
5849     * will be first unlinked from its existing context. If {@link refnode}
5850     * is NULL, then {@link newnode} will be inserted at the end of the list
5851     * of children.
5852     *
5853     * {@link domnode_insert_before} is very similar to {@link
5854     * domnode_append_child} as the following example shows which does the
5855     * same as the example at {@link domnode_append_child}.
5856     *
5857     * Adding a child
5858     *
5859     * <?php include("example.inc");
5860     *
5861     * if (!$dom = domxml_open_mem($xmlstr)) { echo "Error while parsing the
5862     * document\n"; exit; }
5863     *
5864     * $elements = $dom->get_elements_by_tagname("informaltable");
5865     * print_r($elements); $element = $elements[0];
5866     *
5867     * $newnode = $element->insert_before($element, $element); $children =
5868     * $newnode->children(); $attr = $children[1]->set_attribute("align",
5869     * "left");
5870     *
5871     * echo "<pre>"; $xmlfile = $dom->dump_mem(); echo
5872     * htmlentities($xmlfile); echo "</pre>"; ?>
5873     *
5874     * See also {@link domnode_append_child}.
5875     *
5876     * @param domelement $newnode
5877     * @param domelement $refnode
5878     * @return domelement
5879     * @since PHP 4 >= 4.1.0
5880     **/
5881    function insert_before($newnode, $refnode){}
5882
5883    /**
5884     * Tells whether {@link namespaceURI} is the default namespace.
5885     *
5886     * @param string $namespaceURI The namespace URI to look for.
5887     * @return bool
5888     * @since PHP 5
5889     **/
5890    function isDefaultNamespace($namespaceURI){}
5891
5892    /**
5893     * This function indicates if two nodes are the same node. The comparison
5894     * is not based on content
5895     *
5896     * @param DOMNode $node The compared node.
5897     * @return bool
5898     * @since PHP 5
5899     **/
5900    function isSameNode($node){}
5901
5902    /**
5903     * Checks if the asked {@link feature} is supported for the specified
5904     * {@link version}.
5905     *
5906     * @param string $feature The feature to test. See the example of
5907     *   DOMImplementation::hasFeature for a list of features.
5908     * @param string $version The version number of the {@link feature} to
5909     *   test.
5910     * @return bool
5911     * @since PHP 5
5912     **/
5913    function isSupported($feature, $version){}
5914
5915    /**
5916     * @return bool
5917     * @since PHP 4 >= 4.1.0
5918     **/
5919    function is_blank_node(){}
5920
5921    /**
5922     * Returns the last child of the node.
5923     *
5924     * (PHP >= 4.3 only) If no last child is found, NULL is returned.
5925     *
5926     * See also {@link domnode_first_child}, and {@link
5927     * domnode_next_sibling}, {@link domnode_previous_sibling}.
5928     *
5929     * @return domelement
5930     * @since PHP 4 >= 4.1.0
5931     **/
5932    function last_child(){}
5933
5934    /**
5935     * Gets the namespace URI of the node based on the {@link prefix}.
5936     *
5937     * @param string $prefix The prefix of the namespace.
5938     * @return string
5939     * @since PHP 5
5940     **/
5941    function lookupNamespaceURI($prefix){}
5942
5943    /**
5944     * Gets the namespace prefix of the node based on the namespace URI.
5945     *
5946     * @param string $namespaceURI The namespace URI.
5947     * @return string
5948     * @since PHP 5
5949     **/
5950    function lookupPrefix($namespaceURI){}
5951
5952    /**
5953     * This function returns the next sibling of the current node. If there
5954     * is no next sibling it returns (< 4.3) or null (>= 4.3). You can use
5955     * this function to iterate over all children of a node as shown in the
5956     * example.
5957     *
5958     * Iterate over children
5959     *
5960     * <?php include("example.inc");
5961     *
5962     * if (!$dom = domxml_open_mem($xmlstr)) { echo "Error while parsing the
5963     * document\n"; exit; }
5964     *
5965     * $elements = $dom->get_elements_by_tagname("tbody"); $element =
5966     * $elements[0]; $child = $element->first_child();
5967     *
5968     * while ($child) { print_r($child); $child = $child->next_sibling(); }
5969     * ?>
5970     *
5971     * See also {@link domnode_previous_sibling}.
5972     *
5973     * @return domelement
5974     * @since PHP 4 >= 4.1.0
5975     **/
5976    function next_sibling(){}
5977
5978    /**
5979     * Returns name of the node. The name has different meanings for the
5980     * different types of nodes as illustrated in the following table.
5981     * Meaning of value Type Meaning DomAttribute value of attribute
5982     * DomAttribute DomCDataSection #cdata-section DomComment #comment
5983     * DomDocument #document DomDocumentType document type name DomElement
5984     * tag name DomEntity name of entity DomEntityReference name of entity
5985     * reference DomNotation notation name DomProcessingInstruction target
5986     * DomText #text
5987     *
5988     * @return string
5989     * @since PHP 4 >= 4.1.0
5990     **/
5991    function node_name(){}
5992
5993    /**
5994     * Returns the type of the node. All possible types are listed in the
5995     * table in the introduction.
5996     *
5997     * @return int
5998     * @since PHP 4 >= 4.1.0
5999     **/
6000    function node_type(){}
6001
6002    /**
6003     * Returns value of the node. The value has different meanings for the
6004     * different types of nodes as illustrated in the following table.
6005     * Meaning of value Type Meaning DomAttribute value of attribute
6006     * DomAttribute DomCDataSection content DomComment content of comment
6007     * DomDocument null DomDocumentType null DomElement null DomEntity null
6008     * DomEntityReference null DomNotation null DomProcessingInstruction
6009     * entire content without target DomText content of text
6010     *
6011     * @return string
6012     * @since PHP 4 >= 4.1.0
6013     **/
6014    function node_value(){}
6015
6016    /**
6017     * Normalizes the node.
6018     *
6019     * @return void
6020     * @since PHP 5
6021     **/
6022    function normalize(){}
6023
6024    /**
6025     * This function returns the document the current node belongs to.
6026     *
6027     * The following example will create two identical lists of children.
6028     * Finding the document of a node
6029     *
6030     * <?php $doc = domxml_new_doc("1.0"); $node =
6031     * $doc->create_element("para"); $node = $doc->append_child($node);
6032     * $children = $doc->children(); print_r($children);
6033     *
6034     * $doc2 = $node->owner_document(); $children = $doc2->children();
6035     * print_r($children); ?>
6036     *
6037     * See also {@link domnode_insert_before}.
6038     *
6039     * @return domdocument
6040     * @since PHP 4 >= 4.1.0
6041     **/
6042    function owner_document(){}
6043
6044    /**
6045     * This function returns the parent node.
6046     *
6047     * (PHP >= 4.3 only) If no parent is found, NULL is returned.
6048     *
6049     * The following example will show two identical lists of children.
6050     * Finding the document of a node
6051     *
6052     * <?php $doc = domxml_new_doc("1.0"); $node =
6053     * $doc->create_element("para"); $node = $doc->append_child($node);
6054     * $children = $doc->children(); print_r($children);
6055     *
6056     * $doc2 = $node->parent_node(); $children = $doc2->children();
6057     * print_r($children); ?>
6058     *
6059     * @return domnode
6060     * @since PHP 4 >= 4.1.0
6061     **/
6062    function parent_node(){}
6063
6064    /**
6065     * Returns the name space prefix of the node.
6066     *
6067     * @return string
6068     * @since PHP 4 >= 4.1.0
6069     **/
6070    function prefix(){}
6071
6072    /**
6073     * This function returns the previous sibling of the current node. If
6074     * there is no previous sibling it returns (< 4.3) or (>= 4.3). You can
6075     * use this function to iterate over all children of a node as shown in
6076     * the example.
6077     *
6078     * See also {@link domnode_next_sibling}.
6079     *
6080     * @return domelement
6081     * @since PHP 4 >= 4.1.0
6082     **/
6083    function previous_sibling(){}
6084
6085    /**
6086     * This functions removes a child from a list of children.
6087     *
6088     * @param DOMNode $oldnode The removed child.
6089     * @return DOMNode
6090     * @since PHP 5
6091     **/
6092    function removeChild($oldnode){}
6093
6094    /**
6095     * This functions removes a child from a list of children. If child
6096     * cannot be removed or is not a child the function will return . If the
6097     * child could be removed the functions returns the old child.
6098     *
6099     * Removing a child
6100     *
6101     * <?php include("example.inc");
6102     *
6103     * if (!$dom = domxml_open_mem($xmlstr)) { echo "Error while parsing the
6104     * document\n"; exit; }
6105     *
6106     * $elements = $dom->get_elements_by_tagname("tbody"); $element =
6107     * $elements[0]; $children = $element->child_nodes(); $child =
6108     * $element->remove_child($children[0]);
6109     *
6110     * echo "<PRE>"; $xmlfile = $dom->dump_mem(true); echo
6111     * htmlentities($xmlfile); echo "</PRE>"; ?>
6112     *
6113     * See also {@link domnode_append_child}.
6114     *
6115     * @param domtext $oldchild
6116     * @return domtext
6117     * @since PHP 4 >= 4.2.0
6118     **/
6119    function remove_child($oldchild){}
6120
6121    /**
6122     * This function replaces the child {@link oldnode} with the passed new
6123     * node. If the new node is already a child it will not be added a second
6124     * time. If the replacement succeeds the old node is returned.
6125     *
6126     * @param DOMNode $newnode The new node. It must be a member of the
6127     *   target document, i.e. created by one of the DOMDocument->createXXX()
6128     *   methods or imported in the document by .
6129     * @param DOMNode $oldnode The old node.
6130     * @return DOMNode
6131     * @since PHP 5
6132     **/
6133    function replaceChild($newnode, $oldnode){}
6134
6135    /**
6136     * (PHP 4.2) This function replaces the child {@link oldnode} with the
6137     * passed new node. If the new node is already a child it will not be
6138     * added a second time. If the old node cannot be found the function
6139     * returns . If the replacement succeeds the old node is returned.
6140     *
6141     * (PHP 4.3) This function replaces the child {@link oldnode} with the
6142     * passed {@link newnode}, even if the new node already is a child of the
6143     * DomNode. If {@link newnode} was already inserted in the document it is
6144     * first unlinked from its existing context. If the old node cannot be
6145     * found the function returns . If the replacement succeeds the old node
6146     * is returned. (This behaviour is according to the W3C specs).
6147     *
6148     * See also {@link domnode_append_child}
6149     *
6150     * @param domelement $newnode
6151     * @param domelement $oldnode
6152     * @return domelement
6153     * @since PHP 4 >= 4.2.0
6154     **/
6155    function replace_child($newnode, $oldnode){}
6156
6157    /**
6158     * (PHP 4.2) This function replaces an existing node with the passed new
6159     * node. Before the replacement {@link newnode} is copied if it has a
6160     * parent to make sure a node which is already in the document will not
6161     * be inserted a second time. This behaviour enforces doing all
6162     * modifications on the node before the replacement or to refetch the
6163     * inserted node afterwards with functions like {@link
6164     * domnode_first_child}, {@link domnode_child_nodes} etc..
6165     *
6166     * (PHP 4.3) This function replaces an existing node with the passed new
6167     * node. It is not copied anymore. If {@link newnode} was already
6168     * inserted in the document it is first unlinked from its existing
6169     * context. If the replacement succeeds the old node is returned.
6170     *
6171     * See also {@link domnode_append_child}
6172     *
6173     * @param domelement $newnode
6174     * @return domelement
6175     * @since PHP 4 >= 4.2.0
6176     **/
6177    function replace_node($newnode){}
6178
6179    /**
6180     * @param string $content
6181     * @return bool
6182     * @since PHP 4 >= 4.1.0
6183     **/
6184    function set_content($content){}
6185
6186    /**
6187     * Sets name of node.
6188     *
6189     * See also {@link domnode_node_name}.
6190     *
6191     * @return bool
6192     * @since PHP 4 >= 4.1.0
6193     **/
6194    function set_name(){}
6195
6196    /**
6197     * Sets the namespace of a node to {@link uri}. If there is already a
6198     * namespace declaration with the same uri in one of the parent nodes of
6199     * the node, the prefix of this is taken, otherwise it will take the one
6200     * provided in the optional parameter {@link prefix} or generate a random
6201     * one.
6202     *
6203     * See also {@link domdocument_create_element_ns}, and {@link
6204     * domnode_add_namespace}
6205     *
6206     * @param string $uri
6207     * @param string $prefix
6208     * @return void
6209     * @since PHP 4 >= 4.3.0
6210     **/
6211    function set_namespace($uri, $prefix){}
6212
6213    /**
6214     * @return void
6215     * @since PHP 4 >= 4.1.0
6216     **/
6217    function unlink_node(){}
6218
6219}
6220class DOMNodeList {
6221    /**
6222     * Retrieves a node specified by {@link index} within the DOMNodeList
6223     * object.
6224     *
6225     * @param int $index Index of the node into the collection.
6226     * @return DOMNode
6227     * @since PHP 5
6228     **/
6229    function item($index){}
6230
6231}
6232class DOMNotation extends DOMNode {
6233}
6234class DomProcessingInstruction extends DOMNode {
6235    /**
6236     * This method gets the data of the ProcessingInstruction node.
6237     *
6238     * @return string
6239     * @since PHP 4 >= 4.1.0
6240     **/
6241    function data(){}
6242
6243    /**
6244     * This method gets the target of the ProcessingInstruction node.
6245     *
6246     * @return string
6247     * @since PHP 4 >= 4.1.0
6248     **/
6249    function target(){}
6250
6251    /**
6252     * Creates a new DOMProcessingInstruction object. This object is read
6253     * only. It may be appended to a document, but additional nodes may not
6254     * be appended to this node until the node is associated with a document.
6255     * To create a writeable node, use .
6256     *
6257     * @param string $name The tag name of the processing instruction.
6258     * @param string $value The value of the processing instruction.
6259     * @since PHP 5
6260     **/
6261    function __construct($name, $value){}
6262
6263}
6264/**
6265 * The class inherits from and represents the textual content of a or .
6266 **/
6267class DOMText extends DOMCharacterData {
6268    /**
6269     * Indicates whether this text node contains whitespace. The text node is
6270     * determined to contain whitespace in element content during the load of
6271     * the document.
6272     *
6273     * @return bool
6274     * @since PHP 5
6275     **/
6276    function isWhitespaceInElementContent(){}
6277
6278    /**
6279     * Breaks this node into two nodes at the specified {@link offset},
6280     * keeping both in the tree as siblings.
6281     *
6282     * After being split, this node will contain all the content up to the
6283     * {@link offset}. If the original node had a parent node, the new node
6284     * is inserted as the next sibling of the original node. When the {@link
6285     * offset} is equal to the length of this node, the new node has no data.
6286     *
6287     * @param int $offset The offset at which to split, starting from 0.
6288     * @return DOMText
6289     * @since PHP 5
6290     **/
6291    function splitText($offset){}
6292
6293    /**
6294     * Creates a new DOMText object.
6295     *
6296     * @param string $value The value of the text node. If not supplied an
6297     *   empty text node is created.
6298     * @since PHP 5
6299     **/
6300    function __construct($value){}
6301
6302}
6303/**
6304 * Supports XPath 1.0
6305 **/
6306class DomXPath {
6307    /**
6308     * Executes the given XPath {@link expression} and returns a typed result
6309     * if possible.
6310     *
6311     * @param string $expression The XPath expression to execute.
6312     * @param DOMNode $contextnode The optional {@link contextnode} can be
6313     *   specified for doing relative XPath queries. By default, the queries
6314     *   are relative to the root element.
6315     * @return mixed
6316     * @since PHP 5 >= 5.1.0
6317     **/
6318    function evaluate($expression, $contextnode){}
6319
6320    /**
6321     * Executes the given XPath {@link expression}.
6322     *
6323     * @param string $expression The XPath expression to execute.
6324     * @param DOMNode $contextnode The optional {@link contextnode} can be
6325     *   specified for doing relative XPath queries. By default, the queries
6326     *   are relative to the root element.
6327     * @return DOMNodeList
6328     * @since PHP 5
6329     **/
6330    function query($expression, $contextnode){}
6331
6332    /**
6333     * Registers the {@link namespaceURI} and {@link prefix} with the
6334     * DOMXPath object.
6335     *
6336     * @param string $prefix The prefix.
6337     * @param string $namespaceURI The URI of the namespace.
6338     * @return bool
6339     * @since PHP 5
6340     **/
6341    function registerNamespace($prefix, $namespaceURI){}
6342
6343    /**
6344     * This method enables the ability to use PHP functions within XPath
6345     * expressions.
6346     *
6347     * @param mixed $restrict Use this parameter to only allow certain
6348     *   functions to be called from XPath. This parameter can be either a
6349     *   string (a function name) or an array of function names.
6350     * @return void
6351     * @since PHP 5 >= 5.3.0
6352     **/
6353    function registerPhpFunctions($restrict){}
6354
6355    /**
6356     * Creates a new DOMXPath object.
6357     *
6358     * @param DOMDocument $doc The DOMDocument associated with the
6359     *   DOMXPath.
6360     * @since PHP 5
6361     **/
6362    function __construct($doc){}
6363
6364}
6365class DomXsltStylesheet {
6366    /**
6367     * Applies an XSLT Transformation on the given DomDocument object.
6368     *
6369     * @param DomDocument $xml_doc The XML document being transformed, as a
6370     *   DomDocument object.
6371     * @param array $xslt_params An associative array that takes pairs of
6372     *   parameter names and values.
6373     * @param bool $is_xpath_param If set to the values of the {@link
6374     *   xslt_params} will be quoted. This is the default behavior. It allows
6375     *   you to pass the values as PHP strings.
6376     * @param string $profile_filename Set this to the path of a filename,
6377     *   if you want profiling information.
6378     * @return DomDocument
6379     * @since PHP 4 >= 4.1.0
6380     **/
6381    function process($xml_doc, $xslt_params, $is_xpath_param, $profile_filename){}
6382
6383    /**
6384     * Since always returns a well-formed XML DomDocument, no matter what
6385     * output method was declared in <xsl:output> and similar
6386     * attributes/elements, it's of not much use, if you want to output HTML
6387     * 4 or text data.
6388     *
6389     * This function on the contrary honors <xsl:output method="html|text">
6390     * and other output control directives. See the example for instruction
6391     * on how to use it.
6392     *
6393     * @param DomDocument $xmldoc
6394     * @param string $filename
6395     * @return string
6396     * @since PHP 4 >= 4.1.0
6397     **/
6398    function result_dump_file($xmldoc, $filename){}
6399
6400    /**
6401     * Since always returns a well-formed XML DomDocument, no matter what
6402     * output method was declared in <xsl:output> and similar
6403     * attributes/elements, it's of not much use, if you want to output HTML
6404     * 4 or text data.
6405     *
6406     * This function on the contrary honors <xsl:output method="html|text">
6407     * and other output control directives. See the example for instruction
6408     * on how to use it.
6409     *
6410     * @param DomDocument $xmldoc
6411     * @return string
6412     * @since PHP 4 >= 4.1.0
6413     **/
6414    function result_dump_mem($xmldoc){}
6415
6416}
6417/**
6418 * The EmptyIterator class for an empty iterator.
6419 **/
6420class EmptyIterator implements Iterator, Traversable {
6421    /**
6422     * This function must not be called. It throws an exception upon access.
6423     *
6424     * @return void
6425     * @since PHP 5 >= 5.1.0
6426     **/
6427    function current(){}
6428
6429    /**
6430     * This function must not be called. It throws an exception upon access.
6431     *
6432     * @return void
6433     * @since PHP 5 >= 5.1.0
6434     **/
6435    function key(){}
6436
6437    /**
6438     * No operation, nothing to do.
6439     *
6440     * @return void
6441     * @since PHP 5 >= 5.1.0
6442     **/
6443    function next(){}
6444
6445    /**
6446     * No operation, nothing to do.
6447     *
6448     * @return void
6449     * @since PHP 5 >= 5.1.0
6450     **/
6451    function rewind(){}
6452
6453    /**
6454     * The EmptyIterator valid() method.
6455     *
6456     * @return void
6457     * @since PHP 5 >= 5.1.0
6458     **/
6459    function valid(){}
6460
6461}
6462/**
6463 * An Error Exception.
6464 **/
6465class ErrorException extends Exception {
6466    /**
6467     * Returns the severity of the exception.
6468     *
6469     * @return int
6470     * @since PHP 5 >= 5.1.0
6471     **/
6472    function getSeverity(){}
6473
6474}
6475/**
6476 * The Filesystem iterator
6477 **/
6478class FilesystemIterator extends DirectoryIterator implements SeekableIterator, Traversable, Iterator {
6479    /**
6480     * Get file information of the current element.
6481     *
6482     * @return mixed
6483     * @since PHP 5 >= 5.3.0
6484     **/
6485    function current(){}
6486
6487    /**
6488     * Gets the handling flags, as set in FilesystemIterator::__construct or
6489     * FilesystemIterator::setFlags.
6490     *
6491     * @return int
6492     * @since PHP 5 >= 5.3.0
6493     **/
6494    function getFlags(){}
6495
6496    /**
6497     * @return string
6498     * @since PHP 5 >= 5.3.0
6499     **/
6500    function key(){}
6501
6502    /**
6503     * Move to the next file.
6504     *
6505     * @return void
6506     * @since PHP 5 >= 5.3.0
6507     **/
6508    function next(){}
6509
6510    /**
6511     * Rewinds the directory back to the start.
6512     *
6513     * @return void
6514     * @since PHP 5 >= 5.3.0
6515     **/
6516    function rewind(){}
6517
6518    /**
6519     * Sets handling flags.
6520     *
6521     * @param int $flags The handling flags to set. See the
6522     *   FilesystemIterator constants.
6523     * @return void
6524     * @since PHP 5 >= 5.3.0
6525     **/
6526    function setFlags($flags){}
6527
6528    /**
6529     * Constructs a new filesystem iterator from the {@link path}.
6530     *
6531     * @param string $path The path of the filesystem item to be iterated
6532     *   over.
6533     * @param int $flags Flags may be provided which will affect the
6534     *   behavior of some methods. A list of the flags can found under
6535     *   FilesystemIterator predefined constants. They can also be set later
6536     *   with FilesystemIterator::setFlags
6537     * @since PHP 5 >= 5.3.0
6538     **/
6539    function __construct($path, $flags){}
6540
6541}
6542/**
6543 * This abstract iterator filters out unwanted values. This class should
6544 * be extended to implement custom iterator filters. The must be
6545 * implemented in the subclass.
6546 **/
6547class FilterIterator extends IteratorIterator implements OuterIterator, Traversable, Iterator {
6548    /**
6549     * Returns whether the current element of the iterator is acceptable
6550     * through this filter.
6551     *
6552     * @return bool
6553     * @since PHP 5 >= 5.1.0
6554     **/
6555    function accept(){}
6556
6557    /**
6558     * Get the current element value.
6559     *
6560     * @return mixed
6561     * @since PHP 5 >= 5.1.0
6562     **/
6563    function current(){}
6564
6565    /**
6566     * Get the inner iterator.
6567     *
6568     * @return Iterator
6569     * @since PHP 5 >= 5.1.0
6570     **/
6571    function getInnerIterator(){}
6572
6573    /**
6574     * Get the current key.
6575     *
6576     * @return mixed
6577     * @since PHP 5 >= 5.1.0
6578     **/
6579    function key(){}
6580
6581    /**
6582     * Move the iterator forward.
6583     *
6584     * @return void
6585     * @since PHP 5 >= 5.1.0
6586     **/
6587    function next(){}
6588
6589    /**
6590     * Rewind the iterator.
6591     *
6592     * @return void
6593     * @since PHP 5 >= 5.1.0
6594     **/
6595    function rewind(){}
6596
6597    /**
6598     * Checks whether the current element is valid.
6599     *
6600     * @return bool
6601     * @since PHP 5 >= 5.1.0
6602     **/
6603    function valid(){}
6604
6605    /**
6606     * Constructs a new FilterIterator, which consists of a passed in {@link
6607     * iterator} with filters applied to it.
6608     *
6609     * @param Iterator $iterator The iterator that is being filtered.
6610     * @since PHP 5 >= 5.1.0
6611     **/
6612    function __construct($iterator){}
6613
6614}
6615class finfo {
6616    /**
6617     * This function is used to get information about binary data in a
6618     * string.
6619     *
6620     * @param string $string Fileinfo resource returned by {@link
6621     *   finfo_open}.
6622     * @param int $options Content of a file to be checked.
6623     * @param resource $context One or disjunction of more Fileinfo
6624     *   constants.
6625     * @return string
6626     **/
6627    function buffer($string, $options, $context){}
6628
6629    /**
6630     * This function is used to get information about a file.
6631     *
6632     * @param string $file_name Fileinfo resource returned by {@link
6633     *   finfo_open}.
6634     * @param int $options Name of a file to be checked.
6635     * @param resource $context One or disjunction of more Fileinfo
6636     *   constants.
6637     * @return string
6638     **/
6639    function file($file_name, $options, $context){}
6640
6641    /**
6642     * This function sets various Fileinfo options. Options can be set also
6643     * directly in {@link finfo_open} or other Fileinfo functions.
6644     *
6645     * @param int $options Fileinfo resource returned by {@link
6646     *   finfo_open}.
6647     * @return bool
6648     **/
6649    function set_flags($options){}
6650
6651}
6652/**
6653 * Represents a class for connecting to a Gearman job server and making
6654 * requests to perform some function on provided data. The function
6655 * performed must be one registerd by a Gearman worker and the data
6656 * passed is opaque to the job server.
6657 **/
6658class GearmanClient {
6659    /**
6660     * Adds one or more options to those already set.
6661     *
6662     * @param int $options The options to add
6663     * @return bool
6664     * @since PECL gearman >= 0.6.0
6665     **/
6666    function addOptions($options){}
6667
6668    /**
6669     * Adds a job server to a list of servers that can be used to run a task.
6670     * No socket I/O happens here; the server is simply added to the list.
6671     *
6672     * @param string $host
6673     * @param int $port
6674     * @return bool
6675     * @since PECL gearman >= 0.5.0
6676     **/
6677    function addServer($host, $port){}
6678
6679    /**
6680     * Adds a list of job servers that can be used to run a task. No socket
6681     * I/O happens here; the servers are simply added to the full list of
6682     * servers.
6683     *
6684     * @param string $servers A comma-separated list of servers, each
6685     *   server specified in the format host:port.
6686     * @return bool
6687     * @since PECL gearman >= 0.5.0
6688     **/
6689    function addServers($servers){}
6690
6691    /**
6692     * Adds a task to be run in parallel with other tasks. Call this method
6693     * for all the tasks to be run in parallel, then call
6694     * GearmanClient::runTasks to perform the work. Note that enough workers
6695     * need to be available for the tasks to all run in parallel.
6696     *
6697     * @param string $function_name
6698     * @param string $workload
6699     * @param mixed $context
6700     * @param string $unique
6701     * @return GearmanTask
6702     * @since PECL gearman >= 0.5.0
6703     **/
6704    function addTask($function_name, $workload, &$context, $unique){}
6705
6706    /**
6707     * Adds a background task to be run in parallel with other tasks. Call
6708     * this method for all the tasks to be run in parallel, then call
6709     * GearmanClient::runTasks to perform the work.
6710     *
6711     * @param string $function_name
6712     * @param string $workload
6713     * @param mixed $context
6714     * @param string $unique
6715     * @return GearmanTask
6716     * @since PECL gearman >= 0.5.0
6717     **/
6718    function addTaskBackground($function_name, $workload, &$context, $unique){}
6719
6720    /**
6721     * Adds a high priority task to be run in parallel with other tasks. Call
6722     * this method for all the high priority tasks to be run in parallel,
6723     * then call GearmanClient::runTasks to perform the work. Tasks with a
6724     * high priority will be selected from the queue before those of normal
6725     * or low priority.
6726     *
6727     * @param string $function_name
6728     * @param string $workload
6729     * @param mixed $context
6730     * @param string $unique
6731     * @return GearmanTask
6732     * @since PECL gearman >= 0.5.0
6733     **/
6734    function addTaskHigh($function_name, $workload, &$context, $unique){}
6735
6736    /**
6737     * Adds a high priority background task to be run in parallel with other
6738     * tasks. Call this method for all the tasks to be run in parallel, then
6739     * call GearmanClient::runTasks to perform the work. Tasks with a high
6740     * priority will be selected from the queue before those of normal or low
6741     * priority.
6742     *
6743     * @param string $function_name
6744     * @param string $workload
6745     * @param mixed $context
6746     * @param string $unique
6747     * @return GearmanTask
6748     * @since PECL gearman >= 0.5.0
6749     **/
6750    function addTaskHighBackground($function_name, $workload, &$context, $unique){}
6751
6752    /**
6753     * Adds a low priority background task to be run in parallel with other
6754     * tasks. Call this method for all the tasks to be run in parallel, then
6755     * call GearmanClient::runTasks to perform the work. Tasks with a low
6756     * priority will be selected from the queue after those of normal or low
6757     * priority.
6758     *
6759     * @param string $function_name
6760     * @param string $workload
6761     * @param mixed $context
6762     * @param string $unique
6763     * @return GearmanTask
6764     * @since PECL gearman >= 0.5.0
6765     **/
6766    function addTaskLow($function_name, $workload, &$context, $unique){}
6767
6768    /**
6769     * Adds a low priority background task to be run in parallel with other
6770     * tasks. Call this method for all the tasks to be run in parallel, then
6771     * call GearmanClient::runTasks to perform the work. Tasks with a low
6772     * priority will be selected from the queue after those of normal or high
6773     * priority.
6774     *
6775     * @param string $function_name
6776     * @param string $workload
6777     * @param mixed $context
6778     * @param string $unique
6779     * @return GearmanTask
6780     * @since PECL gearman >= 0.5.0
6781     **/
6782    function addTaskLowBackground($function_name, $workload, &$context, $unique){}
6783
6784    /**
6785     * Used to request status information from the Gearman server, which will
6786     * call the specified status callback (set using
6787     * GearmanClient::setStatusCallback).
6788     *
6789     * @param string $job_handle The job handle for the task to get status
6790     *   for
6791     * @param string $context Data to be passed to the status callback,
6792     *   generally a reference to an array or object
6793     * @return GearmanTask
6794     * @since PECL gearman >= 0.5.0
6795     **/
6796    function addTaskStatus($job_handle, &$context){}
6797
6798    /**
6799     * Clears all the task callback functions that have previously been set.
6800     *
6801     * @return bool
6802     * @since PECL gearman >= 0.5.0
6803     **/
6804    function clearCallbacks(){}
6805
6806    /**
6807     * Get the application context previously set with
6808     * GearmanClient::setContext.
6809     *
6810     * @return string
6811     * @since PECL gearman >= 0.6.0
6812     **/
6813    function context(){}
6814
6815    /**
6816     * Get the application data previously set with GearmanClient::setData.
6817     *
6818     * @return string
6819     * @since PECL gearman
6820     **/
6821    function data(){}
6822
6823    /**
6824     * Runs a task in the background, returning a job handle which can be
6825     * used to get the status of the running task.
6826     *
6827     * @param string $function_name
6828     * @param string $workload
6829     * @param string $unique
6830     * @return string
6831     * @since PECL gearman >= 0.5.0
6832     **/
6833    function doBackground($function_name, $workload, $unique){}
6834
6835    /**
6836     * Runs a single high priority task and returns a string representation
6837     * of the result. It is up to the GearmanClient and GearmanWorker to
6838     * agree on the format of the result. High priority tasks will get
6839     * precedence over normal and low priority tasks in the job queue.
6840     *
6841     * @param string $function_name
6842     * @param string $workload
6843     * @param string $unique
6844     * @return string
6845     * @since PECL gearman >= 0.5.0
6846     **/
6847    function doHigh($function_name, $workload, $unique){}
6848
6849    /**
6850     * Runs a high priority task in the background, returning a job handle
6851     * which can be used to get the status of the running task. High priority
6852     * tasks take precedence over normal and low priority tasks in the job
6853     * queue.
6854     *
6855     * @param string $function_name
6856     * @param string $workload
6857     * @param string $unique
6858     * @return string
6859     * @since PECL gearman >= 0.5.0
6860     **/
6861    function doHighBackground($function_name, $workload, $unique){}
6862
6863    /**
6864     * Gets that job handle for a running task. This should be used between
6865     * repeated GearmanClient::do calls. The job handle can then be used to
6866     * get information on the task.
6867     *
6868     * @return string
6869     * @since PECL gearman >= 0.5.0
6870     **/
6871    function doJobHandle(){}
6872
6873    /**
6874     * Runs a single low priority task and returns a string representation of
6875     * the result. It is up to the GearmanClient and GearmanWorker to agree
6876     * on the format of the result. Normal and high priority tasks will get
6877     * precedence over low priority tasks in the job queue.
6878     *
6879     * @param string $function_name
6880     * @param string $workload
6881     * @param string $unique
6882     * @return string
6883     * @since PECL gearman >= 0.5.0
6884     **/
6885    function doLow($function_name, $workload, $unique){}
6886
6887    /**
6888     * Runs a low priority task in the background, returning a job handle
6889     * which can be used to get the status of the running task. Normal and
6890     * high priority tasks take precedence over low priority tasks in the job
6891     * queue.
6892     *
6893     * @param string $function_name
6894     * @param string $workload
6895     * @param string $unique
6896     * @return string
6897     * @since PECL gearman >= 0.5.0
6898     **/
6899    function doLowBackground($function_name, $workload, $unique){}
6900
6901    /**
6902     * Returns the status for the running task. This should be used between
6903     * repeated GearmanClient::do calls.
6904     *
6905     * @return array
6906     * @since PECL gearman >= 0.5.0
6907     **/
6908    function doStatus(){}
6909
6910    /**
6911     * Returns an error string for the last error encountered.
6912     *
6913     * @return string
6914     * @since PECL gearman >= 0.5.0
6915     **/
6916    function error(){}
6917
6918    /**
6919     * Value of errno in the case of a GEARMAN_ERRNO return value.
6920     *
6921     * @return int
6922     * @since PECL gearman >= 0.5.0
6923     **/
6924    function getErrno(){}
6925
6926    /**
6927     * Gets the status for a background job given a job handle. The status
6928     * information will specify whether the job is known, whether the job is
6929     * currently running, and the percentage completion.
6930     *
6931     * @param string $job_handle
6932     * @return array
6933     * @since PECL gearman >= 0.5.0
6934     **/
6935    function jobStatus($job_handle){}
6936
6937    /**
6938     * Removes (unsets) one or more options.
6939     *
6940     * @param int $options The options to be removed (unset)
6941     * @return bool
6942     * @since PECL gearman >= 0.6.0
6943     **/
6944    function removeOptions($options){}
6945
6946    /**
6947     * Returns the last Gearman return code.
6948     *
6949     * @return int
6950     * @since PECL gearman >= 0.5.0
6951     **/
6952    function returnCode(){}
6953
6954    /**
6955     * For a set of tasks previously added with GearmanClient::addTask,
6956     * GearmanClient::addTaskHigh, GearmanClient::addTaskLow,
6957     * GearmanClient::addTaskBackground,
6958     * GearmanClient::addTaskHighBackground, or
6959     * GearmanClient::addTaskLowBackground, this call starts running the
6960     * tasks in parallel.
6961     *
6962     * @return bool
6963     * @since PECL gearman >= 0.5.0
6964     **/
6965    function runTasks(){}
6966
6967    /**
6968     * Sets the callback function for accepting data packets for a task. The
6969     * callback function should take a single argument, a GearmanTask object.
6970     *
6971     * @param callback $callback A function or method to call
6972     * @return void
6973     * @since PECL gearman
6974     **/
6975    function setClientCallback($callback){}
6976
6977    /**
6978     * Use to set a function to be called when a task is completed. The
6979     * callback function should accept a single argument, a GearmanTask
6980     * oject.
6981     *
6982     * @param callback $callback A function to be called
6983     * @return bool
6984     * @since PECL gearman >= 0.5.0
6985     **/
6986    function setCompleteCallback($callback){}
6987
6988    /**
6989     * Sets an arbitrary string to provide application context that can later
6990     * be retrieved by GearmanClient::context.
6991     *
6992     * @param string $context Arbitrary context data
6993     * @return bool
6994     * @since PECL gearman >= 0.6.0
6995     **/
6996    function setContext($context){}
6997
6998    /**
6999     * Sets a function to be called when a task is received and queued by the
7000     * Gearman job server. The callback should accept a single argument, a
7001     * GearmanClient oject.
7002     *
7003     * @param string $callback A function to call
7004     * @return bool
7005     * @since PECL gearman >= 0.5.0
7006     **/
7007    function setCreatedCallback($callback){}
7008
7009    /**
7010     * Sets some arbitrary application data that can later be retrieved by
7011     * GearmanClient::data.
7012     *
7013     * @param string $data
7014     * @return bool
7015     * @since PECL gearman
7016     **/
7017    function setData($data){}
7018
7019    /**
7020     * Sets the callback function for accepting data packets for a task. The
7021     * callback function should take a single argument, a GearmanTask object.
7022     *
7023     * @param callback $callback A function or method to call
7024     * @return bool
7025     * @since PECL gearman >= 0.6.0
7026     **/
7027    function setDataCallback($callback){}
7028
7029    /**
7030     * Specifies a function to call when a worker for a task sends an
7031     * exception.
7032     *
7033     * @param callback $callback Function to call when the worker throws an
7034     *   exception
7035     * @return bool
7036     * @since PECL gearman >= 0.5.0
7037     **/
7038    function setExceptionCallback($callback){}
7039
7040    /**
7041     * Sets the callback function to be used when a task does not complete
7042     * successfully. The function should accept a single argument, a
7043     * GearmanTask object.
7044     *
7045     * @param callback $callback A function to call
7046     * @return bool
7047     * @since PECL gearman >= 0.5.0
7048     **/
7049    function setFailCallback($callback){}
7050
7051    /**
7052     * Sets one or more client options.
7053     *
7054     * @param int $options The options to be set
7055     * @return bool
7056     * @since PECL gearman >= 0.5.0
7057     **/
7058    function setOptions($options){}
7059
7060    /**
7061     * Sets a callback function used for getting updated status information
7062     * from a worker. The function should accept a single argument, a
7063     * GearmanTask object.
7064     *
7065     * @param callback $callback A function to call
7066     * @return bool
7067     * @since PECL gearman >= 0.5.0
7068     **/
7069    function setStatusCallback($callback){}
7070
7071    /**
7072     * Sets the timeout for socket I/O activity.
7073     *
7074     * @param int $timeout An interval of time in milliseconds
7075     * @return bool
7076     * @since PECL gearman >= 0.6.0
7077     **/
7078    function setTimeout($timeout){}
7079
7080    /**
7081     * Sets a function to be called when a worker sends a warning. The
7082     * callback should accept a single argument, a GearmanTask object.
7083     *
7084     * @param callback $callback A function to call
7085     * @return bool
7086     * @since PECL gearman >= 0.5.0
7087     **/
7088    function setWarningCallback($callback){}
7089
7090    /**
7091     * Sets a function to be called when a worker needs to send back data
7092     * prior to job completion. A worker can do this when it needs to send
7093     * updates, send partial results, or flush data during long running jobs.
7094     * The callback should accept a single argument, a GearmanTask object.
7095     *
7096     * @param callback $callback A function to call
7097     * @return bool
7098     * @since PECL gearman >= 0.5.0
7099     **/
7100    function setWorkloadCallback($callback){}
7101
7102    /**
7103     * Returns the timeout in milliseconds to wait for I/O activity.
7104     *
7105     * @return int
7106     * @since PECL gearman >= 0.6.0
7107     **/
7108    function timeout(){}
7109
7110    /**
7111     * Creates a GearmanClient instance representing a client that connects
7112     * to the job server and submits tasks to complete.
7113     *
7114     * @since PECL gearman >= 0.5.0
7115     **/
7116    function __construct(){}
7117
7118}
7119/**
7120 * Description of the class.
7121 **/
7122class GearmanException extends Exception {
7123}
7124/**
7125 * Description of the class.
7126 **/
7127class GearmanJob {
7128    /**
7129     * Sends result data and the complete status update for this job.
7130     *
7131     * @param string $result Serialized result data.
7132     * @return bool
7133     * @since PECL gearman
7134     **/
7135    function complete($result){}
7136
7137    /**
7138     * Sends data to the job server (and any listening clients) for this job.
7139     *
7140     * @param string $data Arbitrary serialized data.
7141     * @return bool
7142     * @since PECL gearman
7143     **/
7144    function data($data){}
7145
7146    /**
7147     * Sends the supplied exception when this job is running.
7148     *
7149     * @param string $exception An exception description.
7150     * @return bool
7151     * @since PECL gearman
7152     **/
7153    function exception($exception){}
7154
7155    /**
7156     * Sends failure status for this job, indicating that the job failed in a
7157     * known way (as opposed to failing due to a thrown exception).
7158     *
7159     * @return bool
7160     * @since PECL gearman
7161     **/
7162    function fail(){}
7163
7164    /**
7165     * Returns the function name for this job. This is the function the work
7166     * will execute to perform the job.
7167     *
7168     * @return string
7169     * @since PECL gearman >= 0.5.0
7170     **/
7171    function functionName(){}
7172
7173    /**
7174     * Returns the opaque job handle assigned by the job server.
7175     *
7176     * @return string
7177     * @since PECL gearman >= 0.5.0
7178     **/
7179    function handle(){}
7180
7181    /**
7182     * Returns the last return code issued by the job server.
7183     *
7184     * @return int
7185     * @since PECL gearman >= 0.5.0
7186     **/
7187    function returnCode(){}
7188
7189    /**
7190     * Sends result data and the complete status update for this job.
7191     *
7192     * @param string $result Serialized result data.
7193     * @return bool
7194     * @since PECL gearman >= 0.6.0
7195     **/
7196    function sendComplete($result){}
7197
7198    /**
7199     * Sends data to the job server (and any listening clients) for this job.
7200     *
7201     * @param string $data Arbitrary serialized data.
7202     * @return bool
7203     * @since PECL gearman >= 0.6.0
7204     **/
7205    function sendData($data){}
7206
7207    /**
7208     * Sends the supplied exception when this job is running.
7209     *
7210     * @param string $exception An exception description.
7211     * @return bool
7212     * @since PECL gearman >= 0.6.0
7213     **/
7214    function sendException($exception){}
7215
7216    /**
7217     * Sends failure status for this job, indicating that the job failed in a
7218     * known way (as opposed to failing due to a thrown exception).
7219     *
7220     * @return bool
7221     * @since PECL gearman >= 0.6.0
7222     **/
7223    function sendFail(){}
7224
7225    /**
7226     * Sends status information to the job server and any listening clients.
7227     * Use this to specify what percentage of the job has been completed.
7228     *
7229     * @param int $numerator The numerator of the precentage completed
7230     *   expressed as a fraction.
7231     * @param int $denominator The denominator of the precentage completed
7232     *   expressed as a fraction.
7233     * @return bool
7234     * @since PECL gearman >= 0.6.0
7235     **/
7236    function sendStatus($numerator, $denominator){}
7237
7238    /**
7239     * Sends a warning for this job while it is running.
7240     *
7241     * @param string $warning A warning messages.
7242     * @return bool
7243     * @since PECL gearman >= 0.6.0
7244     **/
7245    function sendWarning($warning){}
7246
7247    /**
7248     * Sets the return value for this job, indicates how the job completed.
7249     *
7250     * @param string $gearman_return_t A valid Gearman return value.
7251     * @return bool
7252     * @since PECL gearman >= 0.5.0
7253     **/
7254    function setReturn($gearman_return_t){}
7255
7256    /**
7257     * Sends status information to the job server and any listening clients.
7258     * Use this to specify what percentage of the job has been completed.
7259     *
7260     * @param int $numerator The numerator of the precentage completed
7261     *   expressed as a fraction.
7262     * @param int $denominator The denominator of the precentage completed
7263     *   expressed as a fraction.
7264     * @return bool
7265     * @since PECL gearman
7266     **/
7267    function status($numerator, $denominator){}
7268
7269    /**
7270     * Returns the unique identifiter for this job. The identifier is
7271     * assigned by the client.
7272     *
7273     * @return string
7274     * @since PECL gearman >= 0.5.0
7275     **/
7276    function unique(){}
7277
7278    /**
7279     * Sends a warning for this job while it is running.
7280     *
7281     * @param string $warning A warning messages.
7282     * @return bool
7283     * @since PECL gearman
7284     **/
7285    function warning($warning){}
7286
7287    /**
7288     * Returns the workload for the job. This is serialized data that is to
7289     * be processed by the worker.
7290     *
7291     * @return string
7292     * @since PECL gearman >= 0.5.0
7293     **/
7294    function workload(){}
7295
7296    /**
7297     * Returns the size of the job's work load (the data the worker is to
7298     * process) in bytes.
7299     *
7300     * @return int
7301     * @since PECL gearman >= 0.5.0
7302     **/
7303    function workloadSize(){}
7304
7305    /**
7306     * Creates a GearmanJob instance representing a job the worker is to
7307     * complete.
7308     *
7309     * @since PECL gearman >= 0.5.0
7310     **/
7311    function __construct(){}
7312
7313}
7314/**
7315 * Description of the class.
7316 **/
7317class GearmanTask {
7318    /**
7319     * Returns a new GearmanTask object.
7320     *
7321     * @return GearmanTask
7322     * @since PECL gearman
7323     **/
7324    function create(){}
7325
7326    /**
7327     * Returns data being returned for a task by a worker.
7328     *
7329     * @return string
7330     * @since PECL gearman >= 0.5.0
7331     **/
7332    function data(){}
7333
7334    /**
7335     * Returns the size of the data being returned for a task.
7336     *
7337     * @return int
7338     * @since PECL gearman >= 0.5.0
7339     **/
7340    function dataSize(){}
7341
7342    /**
7343     * Returns the name of the function this task is associated with, i.e.,
7344     * the function the Gearman worker calls.
7345     *
7346     * @return string
7347     * @since PECL gearman >= 0.6.0
7348     **/
7349    function functionName(){}
7350
7351    /**
7352     * Gets the status information for whether or not this task is known to
7353     * the job server.
7354     *
7355     * @return bool
7356     * @since PECL gearman >= 0.5.0
7357     **/
7358    function isKnown(){}
7359
7360    /**
7361     * Indicates whether or not this task is currently running.
7362     *
7363     * @return bool
7364     * @since PECL gearman >= 0.5.0
7365     **/
7366    function isRunning(){}
7367
7368    /**
7369     * Returns the job handle for this task.
7370     *
7371     * @return string
7372     * @since PECL gearman >= 0.5.0
7373     **/
7374    function jobHandle(){}
7375
7376    /**
7377     * @param int $data_len Length of data to be read.
7378     * @return array
7379     * @since PECL gearman >= 0.5.0
7380     **/
7381    function recvData($data_len){}
7382
7383    /**
7384     * Returns the last Gearman return code for this task.
7385     *
7386     * @return int
7387     * @since PECL gearman >= 0.5.0
7388     **/
7389    function returnCode(){}
7390
7391    /**
7392     * @param string $data Data to send to the worker.
7393     * @return int
7394     * @since PECL gearman
7395     **/
7396    function sendData($data){}
7397
7398    /**
7399     * @param string $data Data to send to the worker.
7400     * @return int
7401     * @since PECL gearman >= 0.6.0
7402     **/
7403    function sendWorkload($data){}
7404
7405    /**
7406     * Returns the denominator of the percentage of the task that is complete
7407     * expressed as a fraction.
7408     *
7409     * @return int
7410     * @since PECL gearman >= 0.5.0
7411     **/
7412    function taskDenominator(){}
7413
7414    /**
7415     * Returns the numerator of the percentage of the task that is complete
7416     * expressed as a fraction.
7417     *
7418     * @return int
7419     * @since PECL gearman >= 0.5.0
7420     **/
7421    function taskNumerator(){}
7422
7423    /**
7424     * Returns the unique identifier for this task. This is assigned by the
7425     * GearmanClient, as opposed to the job handle which is set by the
7426     * Gearman job server.
7427     *
7428     * @return string
7429     * @since PECL gearman >= 0.6.0
7430     **/
7431    function unique(){}
7432
7433    /**
7434     * Returns the unique identifier for this task. This is assigned by the
7435     * GearmanClient, as opposed to the job handle which is set by the
7436     * Gearman job server.
7437     *
7438     * @return string
7439     * @since PECL gearman
7440     **/
7441    function uuid(){}
7442
7443    /**
7444     * Creates a GearmanTask instance representing a task to be submitted to
7445     * a job server.
7446     *
7447     * @since PECL gearman >= 0.5.0
7448     **/
7449    function __construct(){}
7450
7451}
7452/**
7453 * Description of the class.
7454 **/
7455class GearmanWorker {
7456    /**
7457     * Registers a function name with the job server and specifies a callback
7458     * corresponding to that function. Optionally specify extra application
7459     * context data to be used when the callback is called and a timeout.
7460     *
7461     * @param string $function_name The name of a function to register with
7462     *   the job server
7463     * @param callback $function A callback that gets called when a job for
7464     *   the registered function name is submitted
7465     * @param mixed $context A reference to arbitrary application context
7466     *   data that can be modified by the worker function
7467     * @param int $timeout An interval of time in seconds
7468     * @return bool
7469     * @since PECL gearman >= 0.5.0
7470     **/
7471    function addFunction($function_name, $function, &$context, $timeout){}
7472
7473    /**
7474     * Adds one or more options to the options previously set.
7475     *
7476     * @param int $option The options to be added
7477     * @return bool
7478     * @since PECL gearman >= 0.6.0
7479     **/
7480    function addOptions($option){}
7481
7482    /**
7483     * Adds a job server to this worker. This goes into a list of servers
7484     * than can be used to run jobs. No socket I/O happens here.
7485     *
7486     * @param string $host
7487     * @param int $port
7488     * @return bool
7489     * @since PECL gearman >= 0.5.0
7490     **/
7491    function addServer($host, $port){}
7492
7493    /**
7494     * Adds one or more job servers to this worker. These go into a list of
7495     * servers that can be used to run jobs. No socket I/O happens here.
7496     *
7497     * @param string $servers A comma separated list of job servers in the
7498     *   format host:port. If no port is specified, it defaults to 4730.
7499     * @return bool
7500     * @since PECL gearman >= 0.5.0
7501     **/
7502    function addServers($servers){}
7503
7504    /**
7505     * Returns an error string for the last error encountered.
7506     *
7507     * @return string
7508     * @since PECL gearman >= 0.5.0
7509     **/
7510    function error(){}
7511
7512    /**
7513     * Returns the value of errno in the case of a GEARMAN_ERRNO return
7514     * value.
7515     *
7516     * @return int
7517     * @since PECL gearman >= 0.5.0
7518     **/
7519    function getErrno(){}
7520
7521    /**
7522     * Gets the options previously set for the worker.
7523     *
7524     * @return int
7525     * @since PECL gearman >= 0.6.0
7526     **/
7527    function options(){}
7528
7529    /**
7530     * Registers a function name with the job server with an optional
7531     * timeout. The timeout specifies how many seconds the server will wait
7532     * before marking a job as failed. If the timeout is set to zero, there
7533     * is no timeout.
7534     *
7535     * @param string $function_name The name of a function to register with
7536     *   the job server
7537     * @param int $timeout An interval of time in seconds
7538     * @return bool
7539     * @since PECL gearman >= 0.6.0
7540     **/
7541    function register($function_name, $timeout){}
7542
7543    /**
7544     * Removes (unsets) one or more worker options.
7545     *
7546     * @param int $option The options to be removed (unset)
7547     * @return bool
7548     * @since PECL gearman >= 0.6.0
7549     **/
7550    function removeOptions($option){}
7551
7552    /**
7553     * Returns the last Gearman return code.
7554     *
7555     * @return int
7556     * @since PECL gearman >= 0.5.0
7557     **/
7558    function returnCode(){}
7559
7560    /**
7561     * Sets one or more options to the supplied value.
7562     *
7563     * @param int $option The options to be set
7564     * @return bool
7565     * @since PECL gearman >= 0.5.0
7566     **/
7567    function setOptions($option){}
7568
7569    /**
7570     * Sets the interval of time to wait for socket I/O activity.
7571     *
7572     * @param int $timeout An interval of time in milliseconds. A negative
7573     *   value indicates an infinite timeout.
7574     * @return bool
7575     * @since PECL gearman >= 0.6.0
7576     **/
7577    function setTimeout($timeout){}
7578
7579    /**
7580     * Returns the current time to wait, in milliseconds, for socket I/O
7581     * activity.
7582     *
7583     * @return int
7584     * @since PECL gearman >= 0.6.0
7585     **/
7586    function timeout(){}
7587
7588    /**
7589     * Unregisters a function name with the job servers ensuring that no more
7590     * jobs (for that function) are sent to this worker.
7591     *
7592     * @param string $function_name The name of a function to register with
7593     *   the job server
7594     * @return bool
7595     * @since PECL gearman >= 0.6.0
7596     **/
7597    function unregister($function_name){}
7598
7599    /**
7600     * Unregisters all previously registered functions, ensuring that no more
7601     * jobs are sent to this worker.
7602     *
7603     * @return bool
7604     * @since PECL gearman >= 0.6.0
7605     **/
7606    function unregisterAll(){}
7607
7608    /**
7609     * Causes the worker to wait for activity from one of the Gearman job
7610     * servers when operating in non-blocking I/O mode. On failure, issues a
7611     * E_WARNING with the last Gearman error encountered.
7612     *
7613     * @return bool
7614     * @since PECL gearman >= 0.6.0
7615     **/
7616    function wait(){}
7617
7618    /**
7619     * Waits for a job to be assigned and then calls the appropriate callback
7620     * function. Issues an E_WARNING with the last Gearman error if the
7621     * return code is not one of GEARMAN_SUCCESS, GEARMAN_IO_WAIT, or
7622     * GEARMAN_WORK_FAIL.
7623     *
7624     * @return bool
7625     * @since PECL gearman >= 0.5.0
7626     **/
7627    function work(){}
7628
7629    /**
7630     * Creates a GearmanWorker instance representing a worker that connects
7631     * to the job server and accepts tasks to run.
7632     *
7633     * @since PECL gearman >= 0.5.0
7634     **/
7635    function __construct(){}
7636
7637}
7638/**
7639 * Returns the absolute value of {@link number}.
7640 *
7641 * @param mixed $number The numeric value to process
7642 * @return number
7643 * @since PHP 4, PHP 5
7644 **/
7645function abs($number){}
7646
7647/**
7648 * Returns the arc cosine of {@link arg} in radians. {@link acos} is the
7649 * complementary function of {@link cos}, which means that
7650 * a==cos(acos(a)) for every value of a that is within {@link acos}'
7651 * range.
7652 *
7653 * @param float $arg The argument to process
7654 * @return float
7655 * @since PHP 4, PHP 5
7656 **/
7657function acos($arg){}
7658
7659/**
7660 * Returns the inverse hyperbolic cosine of {@link arg}, i.e. the value
7661 * whose hyperbolic cosine is {@link arg}.
7662 *
7663 * @param float $arg The value to process
7664 * @return float
7665 * @since PHP 4 >= 4.1.0, PHP 5
7666 **/
7667function acosh($arg){}
7668
7669/**
7670 * Returns a string with backslashes before characters that are listed in
7671 * {@link charlist} parameter.
7672 *
7673 * @param string $str The string to be escaped.
7674 * @param string $charlist A list of characters to be escaped. If
7675 *   {@link charlist} contains characters \n, \r etc., they are converted
7676 *   in C-like style, while other non-alphanumeric characters with ASCII
7677 *   codes lower than 32 and higher than 126 converted to octal
7678 *   representation. When you define a sequence of characters in the
7679 *   charlist argument make sure that you know what characters come
7680 *   between the characters that you set as the start and end of the
7681 *   range.
7682 *
7683 *   <?php echo addcslashes('foo[ ]', 'A..z'); // output: \f\o\o\[ \] //
7684 *   All upper and lower-case letters will be escaped // ... but so will
7685 *   the [\]^_` ?>
7686 *
7687 *   Also, if the first character in a range has a higher ASCII value
7688 *   than the second character in the range, no range will be
7689 *   constructed. Only the start, end and period characters will be
7690 *   escaped. Use the {@link ord} function to find the ASCII value for a
7691 *   character.
7692 *
7693 *   <?php echo addcslashes("zoo['.']", 'z..A'); // output: \zoo['\.'] ?>
7694 *
7695 *   Be careful if you choose to escape characters 0, a, b, f, n, r, t
7696 *   and v. They will be converted to \0, \a, \b, \f, \n, \r, \t and \v.
7697 *   In PHP \0 (NULL), \r (carriage return), \n (newline), \f (form
7698 *   feed), \v (vertical tab) and \t (tab) are predefined escape
7699 *   sequences, while in C all of these are predefined escape sequences.
7700 * @return string
7701 * @since PHP 4, PHP 5
7702 **/
7703function addcslashes($str, $charlist){}
7704
7705/**
7706 * Returns a string with backslashes before characters that need to be
7707 * quoted in database queries etc. These characters are single quote ('),
7708 * double quote ("), backslash (\) and NUL (the byte).
7709 *
7710 * An example use of {@link addslashes} is when you're entering data into
7711 * a database. For example, to insert the name O'reilly into a database,
7712 * you will need to escape it. It's highly recommeneded to use DBMS
7713 * specific escape function (e.g. {@link mysqli_real_escape_string} for
7714 * MySQL or {@link pg_escape_string} for PostgreSQL), but if the DBMS
7715 * you're using does't have an escape function and the DBMS uses \ to
7716 * escape special chars, you can use this function. This would only be to
7717 * get the data into the database, the extra \ will not be inserted.
7718 * Having the PHP directive magic_quotes_sybase set to on will mean ' is
7719 * instead escaped with another '.
7720 *
7721 * The PHP directive magic_quotes_gpc is on by default, and it
7722 * essentially runs {@link addslashes} on all GET, POST, and COOKIE data.
7723 * Do not use {@link addslashes} on strings that have already been
7724 * escaped with magic_quotes_gpc as you'll then do double escaping. The
7725 * function {@link get_magic_quotes_gpc} may come in handy for checking
7726 * this.
7727 *
7728 * @param string $str The string to be escaped.
7729 * @return string
7730 * @since PHP 4, PHP 5
7731 **/
7732function addslashes($str){}
7733
7734/**
7735 * Aggregates methods and properties defined in a class to an existing
7736 * object. Methods and properties with names starting with an underscore
7737 * character (_) are considered private to the aggregated class and are
7738 * not used, constructors are also excluded from the aggregation
7739 * procedure.
7740 *
7741 * @param object $object
7742 * @param string $class_name
7743 * @return void
7744 * @since PHP 4 >= 4.2.0
7745 **/
7746function aggregate($object, $class_name){}
7747
7748/**
7749 * Gets the aggregation information for the given {@link object}.
7750 *
7751 * @param object $object
7752 * @return array
7753 * @since PHP 4 >= 4.3.0
7754 **/
7755function aggregate_info($object){}
7756
7757/**
7758 * Aggregates all methods defined in a class to an existing object,
7759 * except for the class constructor, or methods whose names start with an
7760 * underscore character (_) which are considered private to the
7761 * aggregated class.
7762 *
7763 * @param object $object
7764 * @param string $class_name
7765 * @return void
7766 * @since PHP 4 >= 4.2.0
7767 **/
7768function aggregate_methods($object, $class_name){}
7769
7770/**
7771 * Aggregates methods from a class to an existing object using a list of
7772 * method names.
7773 *
7774 * The class constructor or methods whose names start with an underscore
7775 * character (_), which are considered private to the aggregated class,
7776 * are always excluded.
7777 *
7778 * @param object $object
7779 * @param string $class_name
7780 * @param array $methods_list
7781 * @param bool $exclude The optional parameter {@link exclude} is used
7782 *   to decide whether the list contains the names of methods to include
7783 *   in the aggregation (i.e. {@link exclude} is ), or to exclude from
7784 *   the aggregation ({@link exclude} is ).
7785 * @return void
7786 * @since PHP 4 >= 4.2.0
7787 **/
7788function aggregate_methods_by_list($object, $class_name, $methods_list, $exclude){}
7789
7790/**
7791 * Aggregates methods from a class to an existing object using a regular
7792 * expression to match method names.
7793 *
7794 * The class constructor or methods whose names start with an underscore
7795 * character (_), which are considered private to the aggregated class,
7796 * are always excluded.
7797 *
7798 * @param object $object
7799 * @param string $class_name
7800 * @param string $regexp
7801 * @param bool $exclude The optional parameter {@link exclude} is used
7802 *   to decide whether the regular expression will select the names of
7803 *   methods to include in the aggregation (i.e. {@link exclude} is ), or
7804 *   to exclude from the aggregation ({@link exclude} is ).
7805 * @return void
7806 * @since PHP 4 >= 4.2.0
7807 **/
7808function aggregate_methods_by_regexp($object, $class_name, $regexp, $exclude){}
7809
7810/**
7811 * Aggregates all properties defined in a class to an existing object,
7812 * except for properties whose names start with an underscore character
7813 * (_) which are considered private to the aggregated class.
7814 *
7815 * @param object $object
7816 * @param string $class_name
7817 * @return void
7818 * @since PHP 4 >= 4.2.0
7819 **/
7820function aggregate_properties($object, $class_name){}
7821
7822/**
7823 * Aggregates properties from a class to an existing object using a list
7824 * of property names.
7825 *
7826 * The properties whose names start with an underscore character (_),
7827 * which are considered private to the aggregated class, are always
7828 * excluded.
7829 *
7830 * @param object $object
7831 * @param string $class_name
7832 * @param array $properties_list
7833 * @param bool $exclude The optional parameter {@link exclude} is used
7834 *   to decide whether the list contains the names of class properties to
7835 *   include in the aggregation (i.e. {@link exclude} is ), or to exclude
7836 *   from the aggregation ({@link exclude} is ).
7837 * @return void
7838 * @since PHP 4 >= 4.2.0
7839 **/
7840function aggregate_properties_by_list($object, $class_name, $properties_list, $exclude){}
7841
7842/**
7843 * Aggregates properties from a class to an existing object using a
7844 * regular expression to match their names.
7845 *
7846 * The properties whose names start with an underscore character (_),
7847 * which are considered private to the aggregated class, are always
7848 * excluded.
7849 *
7850 * @param object $object
7851 * @param string $class_name
7852 * @param string $regexp
7853 * @param bool $exclude The optional parameter {@link exclude} is used
7854 *   to decide whether the regular expression will select the names of
7855 *   class properties to include in the aggregation (i.e. {@link exclude}
7856 *   is ), or to exclude from the aggregation ({@link exclude} is ).
7857 * @return void
7858 * @since PHP 4 >= 4.2.0
7859 **/
7860function aggregate_properties_by_regexp($object, $class_name, $regexp, $exclude){}
7861
7862/**
7863 * Gets the aggregation information for the given {@link object}.
7864 *
7865 * @param object $object
7866 * @return array
7867 * @since PHP 4 >= 4.2.0 and < 4.3.0
7868 **/
7869function aggregation_info($object){}
7870
7871/**
7872 * {@link apache_child_terminate} will register the Apache process
7873 * executing the current PHP request for termination once execution of
7874 * PHP code is completed. It may be used to terminate a process after a
7875 * script with high memory consumption has been run as memory will
7876 * usually only be freed internally but not given back to the operating
7877 * system.
7878 *
7879 * @return bool
7880 * @since PHP 4 >= 4.0.5, PHP 5
7881 **/
7882function apache_child_terminate(){}
7883
7884/**
7885 * Get an Apache environment variable as specified by {@link variable}.
7886 *
7887 * This function requires Apache 2 otherwise it's undefined.
7888 *
7889 * @param string $variable The Apache environment variable
7890 * @param bool $walk_to_top Whether to get the top-level variable
7891 *   available to all Apache layers.
7892 * @return string
7893 * @since PHP 4 >= 4.3.0, PHP 5
7894 **/
7895function apache_getenv($variable, $walk_to_top){}
7896
7897/**
7898 * Get a list of loaded Apache modules.
7899 *
7900 * @return array
7901 * @since PHP 4 >= 4.3.2, PHP 5
7902 **/
7903function apache_get_modules(){}
7904
7905/**
7906 * Fetch the Apache version.
7907 *
7908 * @return string
7909 * @since PHP 4 >= 4.3.2, PHP 5
7910 **/
7911function apache_get_version(){}
7912
7913/**
7914 * This performs a partial request for a URI. It goes just far enough to
7915 * obtain all the important information about the given resource.
7916 *
7917 * @param string $filename The filename (URI) that's being requested.
7918 * @return object
7919 * @since PHP 4, PHP 5
7920 **/
7921function apache_lookup_uri($filename){}
7922
7923/**
7924 * This function is a wrapper for Apache's table_get and table_set. It
7925 * edits the table of notes that exists during a request. The table's
7926 * purpose is to allow Apache modules to communicate.
7927 *
7928 * The main use for {@link apache_note} is to pass information from one
7929 * module to another within the same request.
7930 *
7931 * @param string $note_name The name of the note.
7932 * @param string $note_value The value of the note.
7933 * @return string
7934 * @since PHP 4, PHP 5
7935 **/
7936function apache_note($note_name, $note_value){}
7937
7938/**
7939 * Fetches all HTTP request headers from the current request.
7940 *
7941 * @return array
7942 * @since PHP 4 >= 4.3.0, PHP 5
7943 **/
7944function apache_request_headers(){}
7945
7946/**
7947 * {@link apache_reset_timeout} resets the Apache write timer, which
7948 * defaults to 300 seconds. With set_time_limit(0);
7949 * ignore_user_abort(true) and periodic {@link apache_reset_timeout}
7950 * calls, Apache can theoretically run forever.
7951 *
7952 * This function requires Apache 1.
7953 *
7954 * @return bool
7955 * @since PHP 5 >= 5.1.0
7956 **/
7957function apache_reset_timeout(){}
7958
7959/**
7960 * Fetch all HTTP response headers.
7961 *
7962 * @return array
7963 * @since PHP 4 >= 4.3.0, PHP 5
7964 **/
7965function apache_response_headers(){}
7966
7967/**
7968 * {@link apache_setenv} sets the value of the Apache environment
7969 * variable specified by {@link variable}.
7970 *
7971 * @param string $variable The environment variable that's being set.
7972 * @param string $value The new {@link variable} value.
7973 * @param bool $walk_to_top Whether to set the top-level variable
7974 *   available to all Apache layers.
7975 * @return bool
7976 * @since PHP 4 >= 4.2.0, PHP 5
7977 **/
7978function apache_setenv($variable, $value, $walk_to_top){}
7979
7980/**
7981 * Caches a variable in the data store, only if it's not already stored.
7982 *
7983 * @param string $key Store the variable using this name. {@link key}s
7984 *   are cache-unique, so attempting to use {@link apc_add} to store data
7985 *   with a key that already exists will not overwrite the existing data,
7986 *   and will instead return . (This is the only difference between
7987 *   {@link apc_add} and {@link apc_store}.)
7988 * @param mixed $var The variable to store
7989 * @param int $ttl Time To Live; store {@link var} in the cache for
7990 *   {@link ttl} seconds. After the {@link ttl} has passed, the stored
7991 *   variable will be expunged from the cache (on the next request). If
7992 *   no {@link ttl} is supplied (or if the {@link ttl} is 0), the value
7993 *   will persist until it is removed from the cache manually, or
7994 *   otherwise fails to exist in the cache (clear, restart, etc.).
7995 * @return bool
7996 * @since PECL apc >= 3.0.13
7997 **/
7998function apc_add($key, $var, $ttl){}
7999
8000/**
8001 * Returns a binary dump of the given files and user variables from the
8002 * APC cache. A for files or user_vars signals a dump of every entry,
8003 * whereas array() will dump nothing.
8004 *
8005 * @param array $files The files. Passing in signals a dump of every
8006 *   entry, while passing in {@link array} will dump nothing.
8007 * @param array $user_vars The user vars. Passing in signals a dump of
8008 *   every entry, while passing in {@link array} will dump nothing.
8009 * @return string
8010 * @since PECL apc >= 3.1.4
8011 **/
8012function apc_bin_dump($files, $user_vars){}
8013
8014/**
8015 * Outputs a binary dump of the given files and user variables from the
8016 * APC cache to the named file.
8017 *
8018 * @param array $files The file names being dumped.
8019 * @param array $user_vars The user variables being dumped.
8020 * @param string $filename The filename where the dump is being saved.
8021 * @param int $flags Flags passed to the {@link filename} stream. See
8022 *   the {@link file_put_contents} documentation for details.
8023 * @param resource $context The context passed to the {@link filename}
8024 *   stream. See the {@link file_put_contents} documentation for details.
8025 * @return int
8026 * @since PECL apc >= 3.1.4
8027 **/
8028function apc_bin_dumpfile($files, $user_vars, $filename, $flags, $context){}
8029
8030/**
8031 * Loads the given binary dump into the APC file/user cache.
8032 *
8033 * @param string $data The binary dump being loaded, likely from {@link
8034 *   apc_bin_dump}.
8035 * @param int $flags Either APC_BIN_VERIFY_CRC32, APC_BIN_VERIFY_MD5,
8036 *   or both.
8037 * @return bool
8038 * @since PECL apc >= 3.1.4
8039 **/
8040function apc_bin_load($data, $flags){}
8041
8042/**
8043 * Loads a binary dump from a file into the APC file/user cache.
8044 *
8045 * @param string $filename The file name containing the dump, likely
8046 *   from {@link apc_bin_dumpfile}.
8047 * @param resource $context The files context.
8048 * @param int $flags Either APC_BIN_VERIFY_CRC32, APC_BIN_VERIFY_MD5,
8049 *   or both.
8050 * @return bool
8051 * @since PECL apc >= 3.1.4
8052 **/
8053function apc_bin_loadfile($filename, $context, $flags){}
8054
8055/**
8056 * Retrieves cached information and meta-data from APC's data store.
8057 *
8058 * @param string $cache_type If {@link cache_type} is "user",
8059 *   information about the user cache will be returned. If {@link
8060 *   cache_type} is "filehits", information about which files have been
8061 *   served from the bytecode cache for the current request will be
8062 *   returned. This feature must be enabled at compile time using
8063 *   --enable-filehits. If an invalid or no {@link cache_type} is
8064 *   specified, information about the system cache (cached files) will be
8065 *   returned.
8066 * @param bool $limited If {@link limited} is , the return value will
8067 *   exclude the individual list of cache entries. This is useful when
8068 *   trying to optimize calls for statistics gathering.
8069 * @return array
8070 * @since PECL apc >= 2.0.0
8071 **/
8072function apc_cache_info($cache_type, $limited){}
8073
8074/**
8075 * apc_cas
8076 *
8077 * @param string $key
8078 * @param int $old
8079 * @param int $new
8080 * @return int
8081 * @since PECL apc >= 3.1.1
8082 **/
8083function apc_cas($key, $old, $new){}
8084
8085/**
8086 * Clears the user/system cache.
8087 *
8088 * @param string $cache_type If {@link cache_type} is "user", the user
8089 *   cache will be cleared; otherwise, the system cache (cached files)
8090 *   will be cleared.
8091 * @return bool
8092 * @since PECL apc >= 2.0.0
8093 **/
8094function apc_clear_cache($cache_type){}
8095
8096/**
8097 * Stores a file in the bytecode cache, bypassing all filters.
8098 *
8099 * @param string $filename Full or relative path to a PHP file that
8100 *   will be compiled and stored in the bytecode cache.
8101 * @return bool
8102 * @since PECL apc >= 3.0.13
8103 **/
8104function apc_compile_file($filename){}
8105
8106/**
8107 * Decreases a stored integer value.
8108 *
8109 * @param string $key The key of the value being decreased.
8110 * @param int $step The step, or value to decrease.
8111 * @param bool $success Optionally pass the success or fail boolean
8112 *   value to this referenced variable.
8113 * @return int
8114 * @since PECL apc >= 3.1.1
8115 **/
8116function apc_dec($key, $step, &$success){}
8117
8118/**
8119 * {@link define} is notoriously slow. Since the main benefit of APC is
8120 * to increase the performance of scripts/applications, this mechanism is
8121 * provided to streamline the process of mass constant definition.
8122 * However, this function does not perform as well as anticipated.
8123 *
8124 * For a better-performing solution, try the hidef extension from PECL.
8125 *
8126 * @param string $key The {@link key} serves as the name of the
8127 *   constant set being stored. This {@link key} is used to retrieve the
8128 *   stored constants in {@link apc_load_constants}.
8129 * @param array $constants An associative array of constant_name =>
8130 *   value pairs. The constant_name must follow the normal constant
8131 *   naming rules. value must evaluate to a scalar value.
8132 * @param bool $case_sensitive The default behaviour for constants is
8133 *   to be declared case-sensitive; i.e. CONSTANT and Constant represent
8134 *   different values. If this parameter evaluates to the constants will
8135 *   be declared as case-insensitive symbols.
8136 * @return bool
8137 * @since PECL apc >= 3.0.0
8138 **/
8139function apc_define_constants($key, $constants, $case_sensitive){}
8140
8141/**
8142 * Removes a stored variable from the cache.
8143 *
8144 * @param string $key The {@link key} used to store the value (with
8145 *   {@link apc_store}).
8146 * @return bool
8147 * @since PECL apc >= 3.0.0
8148 **/
8149function apc_delete($key){}
8150
8151/**
8152 * Deletes the given files from the opcode cache.
8153 *
8154 * @param mixed $keys The files to be deleted. Accepts a string, array
8155 *   of strings, or an APCIterator object.
8156 * @return mixed
8157 * @since PECL apc >= 3.1.1
8158 **/
8159function apc_delete_file($keys){}
8160
8161/**
8162 * Checks if one ore more APC keys exist.
8163 *
8164 * @param mixed $keys A string, or an array of strings, that contain
8165 *   keys.
8166 * @return mixed
8167 * @since PECL apc >= 3.1.4
8168 **/
8169function apc_exists($keys){}
8170
8171/**
8172 * Fetchs a stored variable from the cache.
8173 *
8174 * @param mixed $key The {@link key} used to store the value (with
8175 *   {@link apc_store}). If an array is passed then each element is
8176 *   fetched and returned.
8177 * @param bool $success Set to in success and in failure.
8178 * @return mixed
8179 * @since PECL apc >= 3.0.0
8180 **/
8181function apc_fetch($key, &$success){}
8182
8183/**
8184 * Increases a stored number.
8185 *
8186 * @param string $key The key of the value being increased.
8187 * @param int $step The step, or value to increase.
8188 * @param bool $success Optionally pass the success or fail boolean
8189 *   value to this referenced variable.
8190 * @return int
8191 * @since PECL apc >= 3.1.1
8192 **/
8193function apc_inc($key, $step, &$success){}
8194
8195/**
8196 * Loads a set of constants from the cache.
8197 *
8198 * @param string $key The name of the constant set (that was stored
8199 *   with {@link apc_define_constants}) to be retrieved.
8200 * @param bool $case_sensitive The default behaviour for constants is
8201 *   to be declared case-sensitive; i.e. CONSTANT and Constant represent
8202 *   different values. If this parameter evaluates to the constants will
8203 *   be declared as case-insensitive symbols.
8204 * @return bool
8205 * @since PECL apc >= 3.0.0
8206 **/
8207function apc_load_constants($key, $case_sensitive){}
8208
8209/**
8210 * Retrieves APC's Shared Memory Allocation information.
8211 *
8212 * @param bool $limited When set to (default) {@link apc_sma_info} will
8213 *   return a detailed information about each segment.
8214 * @return array
8215 * @since PECL apc >= 2.0.0
8216 **/
8217function apc_sma_info($limited){}
8218
8219/**
8220 * Cache a variable in the data store.
8221 *
8222 * @param string $key Store the variable using this name. {@link key}s
8223 *   are cache-unique, so storing a second value with the same {@link
8224 *   key} will overwrite the original value.
8225 * @param mixed $var The variable to store
8226 * @param int $ttl Time To Live; store {@link var} in the cache for
8227 *   {@link ttl} seconds. After the {@link ttl} has passed, the stored
8228 *   variable will be expunged from the cache (on the next request). If
8229 *   no {@link ttl} is supplied (or if the {@link ttl} is 0), the value
8230 *   will persist until it is removed from the cache manually, or
8231 *   otherwise fails to exist in the cache (clear, restart, etc.).
8232 * @return bool
8233 * @since PECL apc >= 3.0.0
8234 **/
8235function apc_store($key, $var, $ttl){}
8236
8237/**
8238 * This can be used to stop the running of your script, and await
8239 * responses on the connected socket. To step the program, just send
8240 * enter (a blank line), or enter a php command to be executed.
8241 *
8242 * @param int $debug_level
8243 * @return bool
8244 * @since PECL apd >= 0.2
8245 **/
8246function apd_breakpoint($debug_level){}
8247
8248/**
8249 * Returns the current call stack as an array
8250 *
8251 * @return array
8252 * @since PECL apd 0.2-0.4
8253 **/
8254function apd_callstack(){}
8255
8256/**
8257 * Behaves like perl's Carp::cluck. Throw a warning and a callstack.
8258 *
8259 * @param string $warning The warning to throw.
8260 * @param string $delimiter The delimiter. Default to <BR />.
8261 * @return void
8262 * @since PECL apd 0.2-0.4
8263 **/
8264function apd_clunk($warning, $delimiter){}
8265
8266/**
8267 * Usually sent via the socket to restart the interpreter.
8268 *
8269 * @param int $debug_level
8270 * @return bool
8271 * @since PECL apd >= 0.2
8272 **/
8273function apd_continue($debug_level){}
8274
8275/**
8276 * Behaves like perl's Carp::croak. Throw an error, a callstack and then
8277 * exit.
8278 *
8279 * @param string $warning The warning to throw.
8280 * @param string $delimiter The delimiter. Default to <BR />.
8281 * @return void
8282 * @since PECL apd 0.2-0.4
8283 **/
8284function apd_croak($warning, $delimiter){}
8285
8286/**
8287 * Outputs the current function table.
8288 *
8289 * @return void
8290 * @since Unknown
8291 **/
8292function apd_dump_function_table(){}
8293
8294/**
8295 * Return all persistent resources as an array.
8296 *
8297 * @return array
8298 * @since PECL apd 0.2-0.4
8299 **/
8300function apd_dump_persistent_resources(){}
8301
8302/**
8303 * Return all current regular resources as an array.
8304 *
8305 * @return array
8306 * @since PECL apd 0.2-0.4
8307 **/
8308function apd_dump_regular_resources(){}
8309
8310/**
8311 * Usually sent via the socket to request information about the running
8312 * script.
8313 *
8314 * @param string $output The debugged variable.
8315 * @return bool
8316 * @since PECL apd >= 0.2
8317 **/
8318function apd_echo($output){}
8319
8320/**
8321 * Returns the names of all the variables defined in the active scope,
8322 * (not their values).
8323 *
8324 * @return array
8325 * @since PECL apd 0.2
8326 **/
8327function apd_get_active_symbols(){}
8328
8329/**
8330 * Starts debugging to pprof_{process_id} in the dump directory.
8331 *
8332 * @param string $dump_directory The directory in which the profile
8333 *   dump file is written. If not set, the apd.dumpdir setting from the
8334 *   file is used.
8335 * @param string $fragment
8336 * @return string
8337 * @since PECL apd >= 0.2
8338 **/
8339function apd_set_pprof_trace($dump_directory, $fragment){}
8340
8341/**
8342 * This can be used to increase or decrease debugging in a different area
8343 * of your application.
8344 *
8345 * @param int $debug_level
8346 * @return void
8347 * @since PECL apd 0.2-0.4
8348 **/
8349function apd_set_session($debug_level){}
8350
8351/**
8352 * Starts debugging to apd_dump_{process_id} in the dump directory.
8353 *
8354 * @param int $debug_level The directory in which the profile dump file
8355 *   is written. If not set, the apd.dumpdir setting from the file is
8356 *   used.
8357 * @param string $dump_directory
8358 * @return void
8359 * @since PECL apd 0.2-0.4
8360 **/
8361function apd_set_session_trace($debug_level, $dump_directory){}
8362
8363/**
8364 * Connects to the specified {@link tcp_server} (eg. tcplisten) and sends
8365 * debugging data to the socket.
8366 *
8367 * @param string $tcp_server IP or Unix Domain socket (like a file) of
8368 *   the TCP server.
8369 * @param int $socket_type Can be AF_UNIX for file based sockets or
8370 *   APD_AF_INET for standard tcp/ip.
8371 * @param int $port You can use any port, but higher numbers are better
8372 *   as most of the lower numbers may be used by other system services.
8373 * @param int $debug_level
8374 * @return bool
8375 * @since PECL apd >= 0.2
8376 **/
8377function apd_set_session_trace_socket($tcp_server, $socket_type, $port, $debug_level){}
8378
8379/**
8380 * Returns an array with all keys from {@link input} lowercased or
8381 * uppercased. Numbered indices are left as is.
8382 *
8383 * @param array $input The array to work on
8384 * @param int $case Either CASE_UPPER or CASE_LOWER (default)
8385 * @return array
8386 * @since PHP 4 >= 4.2.0, PHP 5
8387 **/
8388function array_change_key_case($input, $case){}
8389
8390/**
8391 * Chunks an array into {@link size} large chunks. The last chunk may
8392 * contain less than {@link size} elements.
8393 *
8394 * @param array $input The array to work on
8395 * @param int $size The size of each chunk
8396 * @param bool $preserve_keys When set to keys will be preserved.
8397 *   Default is which will reindex the chunk numerically
8398 * @return array
8399 * @since PHP 4 >= 4.2.0, PHP 5
8400 **/
8401function array_chunk($input, $size, $preserve_keys){}
8402
8403/**
8404 * Creates an array by using the values from the {@link keys} array as
8405 * keys and the values from the {@link values} array as the corresponding
8406 * values.
8407 *
8408 * @param array $keys Array of keys to be used. Illegal values for key
8409 *   will be converted to string.
8410 * @param array $values Array of values to be used
8411 * @return array
8412 * @since PHP 5
8413 **/
8414function array_combine($keys, $values){}
8415
8416/**
8417 * {@link array_count_values} returns an array using the values of the
8418 * {@link input} array as keys and their frequency in {@link input} as
8419 * values.
8420 *
8421 * @param array $input The array of values to count
8422 * @return array
8423 * @since PHP 4, PHP 5
8424 **/
8425function array_count_values($input){}
8426
8427/**
8428 * Compares {@link array1} against {@link array2} and returns the
8429 * difference.
8430 *
8431 * @param array $array1 The array to compare from
8432 * @param array $array2 An array to compare against
8433 * @return array
8434 * @since PHP 4 >= 4.0.1, PHP 5
8435 **/
8436function array_diff($array1, $array2){}
8437
8438/**
8439 * Compares {@link array1} against {@link array2} and returns the
8440 * difference. Unlike {@link array_diff} the array keys are used in the
8441 * comparison.
8442 *
8443 * @param array $array1 The array to compare from
8444 * @param array $array2 An array to compare against
8445 * @return array
8446 * @since PHP 4 >= 4.3.0, PHP 5
8447 **/
8448function array_diff_assoc($array1, $array2){}
8449
8450/**
8451 * Compares the keys from {@link array1} against the keys from {@link
8452 * array2} and returns the difference. This function is like {@link
8453 * array_diff} except the comparison is done on the keys instead of the
8454 * values.
8455 *
8456 * @param array $array1 The array to compare from
8457 * @param array $array2 An array to compare against
8458 * @return array
8459 * @since PHP 5 >= 5.1.0
8460 **/
8461function array_diff_key($array1, $array2){}
8462
8463/**
8464 * Compares {@link array1} against {@link array2} and returns the
8465 * difference. Unlike {@link array_diff} the array keys are used in the
8466 * comparison.
8467 *
8468 * Unlike {@link array_diff_assoc} an user supplied callback function is
8469 * used for the indices comparison, not internal function.
8470 *
8471 * @param array $array1 The array to compare from
8472 * @param array $array2 An array to compare against
8473 * @param callback $key_compare_func More arrays to compare against
8474 * @return array
8475 * @since PHP 5
8476 **/
8477function array_diff_uassoc($array1, $array2, $key_compare_func){}
8478
8479/**
8480 * Compares the keys from {@link array1} against the keys from {@link
8481 * array2} and returns the difference. This function is like {@link
8482 * array_diff} except the comparison is done on the keys instead of the
8483 * values.
8484 *
8485 * Unlike {@link array_diff_key} an user supplied callback function is
8486 * used for the indices comparison, not internal function.
8487 *
8488 * @param array $array1 The array to compare from
8489 * @param array $array2 An array to compare against
8490 * @param callback $key_compare_func More arrays to compare against
8491 * @return array
8492 * @since PHP 5 >= 5.1.0
8493 **/
8494function array_diff_ukey($array1, $array2, $key_compare_func){}
8495
8496/**
8497 * Fills an array with {@link num} entries of the value of the {@link
8498 * value} parameter, keys starting at the {@link start_index} parameter.
8499 *
8500 * @param int $start_index The first index of the returned array.
8501 *   Supports non-negative indexes only.
8502 * @param int $num Number of elements to insert
8503 * @param mixed $value Value to use for filling
8504 * @return array
8505 * @since PHP 4 >= 4.2.0, PHP 5
8506 **/
8507function array_fill($start_index, $num, $value){}
8508
8509/**
8510 * Fills an array with the value of the {@link value} parameter, using
8511 * the values of the {@link keys} array as keys.
8512 *
8513 * @param array $keys Array of values that will be used as keys.
8514 *   Illegal values for key will be converted to string.
8515 * @param mixed $value Value to use for filling
8516 * @return array
8517 * @since PHP 5 >= 5.2.0
8518 **/
8519function array_fill_keys($keys, $value){}
8520
8521/**
8522 * Iterates over each value in the {@link input} array passing them to
8523 * the {@link callback} function. If the callback function returns true,
8524 * the current value from {@link input} is returned into the result
8525 * array. Array keys are preserved.
8526 *
8527 * @param array $input The array to iterate over
8528 * @param callback $callback The callback function to use If no {@link
8529 *   callback} is supplied, all entries of {@link input} equal to (see
8530 *   converting to boolean) will be removed.
8531 * @return array
8532 * @since PHP 4 >= 4.0.6, PHP 5
8533 **/
8534function array_filter($input, $callback){}
8535
8536/**
8537 * {@link array_flip} returns an array in flip order, i.e. keys from
8538 * {@link trans} become values and values from {@link trans} become keys.
8539 *
8540 * Note that the values of {@link trans} need to be valid keys, i.e. they
8541 * need to be either integer or string. A warning will be emitted if a
8542 * value has the wrong type, and the key/value pair in question will not
8543 * be flipped.
8544 *
8545 * If a value has several occurrences, the latest key will be used as its
8546 * values, and all others will be lost.
8547 *
8548 * @param array $trans An array of key/value pairs to be flipped.
8549 * @return array
8550 * @since PHP 4, PHP 5
8551 **/
8552function array_flip($trans){}
8553
8554/**
8555 * {@link array_intersect} returns an array containing all the values of
8556 * {@link array1} that are present in all the arguments. Note that keys
8557 * are preserved.
8558 *
8559 * @param array $array1 The array with master values to check.
8560 * @param array $array2 An array to compare values against.
8561 * @return array
8562 * @since PHP 4 >= 4.0.1, PHP 5
8563 **/
8564function array_intersect($array1, $array2){}
8565
8566/**
8567 * @param array $array1 The array with master values to check.
8568 * @param array $array2 An array to compare values against.
8569 * @return array
8570 * @since PHP 4 >= 4.3.0, PHP 5
8571 **/
8572function array_intersect_assoc($array1, $array2){}
8573
8574/**
8575 * {@link array_intersect_key} returns an array containing all the
8576 * entries of {@link array1} which have keys that are present in all the
8577 * arguments.
8578 *
8579 * @param array $array1 The array with master keys to check.
8580 * @param array $array2 An array to compare keys against.
8581 * @return array
8582 * @since PHP 5 >= 5.1.0
8583 **/
8584function array_intersect_key($array1, $array2){}
8585
8586/**
8587 * {@link array_intersect_uassoc} returns an array containing all the
8588 * values of {@link array1} that are present in all the arguments. Note
8589 * that the keys are used in the comparison unlike in {@link
8590 * array_intersect}.
8591 *
8592 * The index comparison is done by a user supplied callback function. It
8593 * must return an integer less than, equal to, or greater than zero if
8594 * the first argument is considered to be respectively less than, equal
8595 * to, or greater than the second.
8596 *
8597 * @param array $array1 Initial array for comparison of the arrays.
8598 * @param array $array2 First array to compare keys against.
8599 * @param callback $key_compare_func Variable list of array arguments
8600 *   to compare values against.
8601 * @return array
8602 * @since PHP 5
8603 **/
8604function array_intersect_uassoc($array1, $array2, $key_compare_func){}
8605
8606/**
8607 * {@link array_intersect_ukey} returns an array containing all the
8608 * values of {@link array1} which have matching keys that are present in
8609 * all the arguments.
8610 *
8611 * This comparison is done by a user supplied callback function. It must
8612 * return an integer less than, equal to, or greater than zero if the
8613 * first key is considered to be respectively less than, equal to, or
8614 * greater than the second.
8615 *
8616 * @param array $array1 Initial array for comparison of the arrays.
8617 * @param array $array2 First array to compare keys against.
8618 * @param callback $key_compare_func Variable list of array arguments
8619 *   to compare keys against.
8620 * @return array
8621 * @since PHP 5 >= 5.1.0
8622 **/
8623function array_intersect_ukey($array1, $array2, $key_compare_func){}
8624
8625/**
8626 * {@link array_keys} returns the keys, numeric and string, from the
8627 * {@link input} array.
8628 *
8629 * If the optional {@link search_value} is specified, then only the keys
8630 * for that value are returned. Otherwise, all the keys from the {@link
8631 * input} are returned.
8632 *
8633 * @param array $input An array containing keys to return.
8634 * @param mixed $search_value If specified, then only keys containing
8635 *   these values are returned.
8636 * @param bool $strict Determines if strict comparison (===) should be
8637 *   used during the search.
8638 * @return array
8639 * @since PHP 4, PHP 5
8640 **/
8641function array_keys($input, $search_value, $strict){}
8642
8643/**
8644 * {@link array_key_exists} returns if the given {@link key} is set in
8645 * the array. {@link key} can be any value possible for an array index.
8646 *
8647 * @param mixed $key Value to check.
8648 * @param array $search An array with keys to check.
8649 * @return bool
8650 * @since PHP 4 >= 4.0.7, PHP 5
8651 **/
8652function array_key_exists($key, $search){}
8653
8654/**
8655 * {@link array_map} returns an array containing all the elements of
8656 * {@link arr1} after applying the {@link callback} function to each one.
8657 * The number of parameters that the {@link callback} function accepts
8658 * should match the number of arrays passed to the {@link array_map}
8659 *
8660 * @param callback $callback Callback function to run for each element
8661 *   in each array.
8662 * @param array $arr1 An array to run through the {@link callback}
8663 *   function.
8664 * @return array
8665 * @since PHP 4 >= 4.0.6, PHP 5
8666 **/
8667function array_map($callback, $arr1){}
8668
8669/**
8670 * Merges the elements of one or more arrays together so that the values
8671 * of one are appended to the end of the previous one. It returns the
8672 * resulting array.
8673 *
8674 * If the input arrays have the same string keys, then the later value
8675 * for that key will overwrite the previous one. If, however, the arrays
8676 * contain numeric keys, the later value will not overwrite the original
8677 * value, but will be appended.
8678 *
8679 * If all of the arrays contain only numeric keys, the resulting array is
8680 * given incrementing keys starting from zero.
8681 *
8682 * @param array $array1 Initial array to merge.
8683 * @param array $array2 Variable list of arrays to recursively merge.
8684 * @return array
8685 * @since PHP 4, PHP 5
8686 **/
8687function array_merge($array1, $array2){}
8688
8689/**
8690 * {@link array_merge_recursive} merges the elements of one or more
8691 * arrays together so that the values of one are appended to the end of
8692 * the previous one. It returns the resulting array.
8693 *
8694 * If the input arrays have the same string keys, then the values for
8695 * these keys are merged together into an array, and this is done
8696 * recursively, so that if one of the values is an array itself, the
8697 * function will merge it with a corresponding entry in another array
8698 * too. If, however, the arrays have the same numeric key, the later
8699 * value will not overwrite the original value, but will be appended.
8700 *
8701 * @param array $array1 Initial array to merge.
8702 * @return array
8703 * @since PHP 4 >= 4.0.1, PHP 5
8704 **/
8705function array_merge_recursive($array1){}
8706
8707/**
8708 * {@link array_multisort} can be used to sort several arrays at once, or
8709 * a multi-dimensional array by one or more dimensions.
8710 *
8711 * Associative (string) keys will be maintained, but numeric keys will be
8712 * re-indexed.
8713 *
8714 * @param array $arr An array being sorted.
8715 * @param mixed $arg Optionally another array, or sort options for the
8716 *   previous array argument: SORT_ASC, SORT_DESC, SORT_REGULAR,
8717 *   SORT_NUMERIC, SORT_STRING.
8718 * @param mixed $arg Additional {@link arg}'s.
8719 * @return bool
8720 * @since PHP 4, PHP 5
8721 **/
8722function array_multisort(&$arr, $arg, $arg){}
8723
8724/**
8725 * {@link array_pad} returns a copy of the {@link input} padded to size
8726 * specified by {@link pad_size} with value {@link pad_value}. If {@link
8727 * pad_size} is positive then the array is padded on the right, if it's
8728 * negative then on the left. If the absolute value of {@link pad_size}
8729 * is less than or equal to the length of the {@link input} then no
8730 * padding takes place. It is possible to add most 1048576 elements at a
8731 * time.
8732 *
8733 * @param array $input Initial array of values to pad.
8734 * @param int $pad_size New size of the array.
8735 * @param mixed $pad_value Value to pad if {@link input} is less than
8736 *   {@link pad_size}.
8737 * @return array
8738 * @since PHP 4, PHP 5
8739 **/
8740function array_pad($input, $pad_size, $pad_value){}
8741
8742/**
8743 * {@link array_pop} pops and returns the last value of the {@link
8744 * array}, shortening the {@link array} by one element. If {@link array}
8745 * is empty (or is not an array), will be returned. Will additionally
8746 * produce a Warning when called on a non-array.
8747 *
8748 * @param array $array The array to get the value from.
8749 * @return mixed
8750 * @since PHP 4, PHP 5
8751 **/
8752function array_pop(&$array){}
8753
8754/**
8755 * {@link array_product} returns the product of values in an array.
8756 *
8757 * @param array $array The array.
8758 * @return number
8759 * @since PHP 5 >= 5.1.0
8760 **/
8761function array_product($array){}
8762
8763/**
8764 * {@link array_push} treats {@link array} as a stack, and pushes the
8765 * passed variables onto the end of {@link array}. The length of {@link
8766 * array} increases by the number of variables pushed. Has the same
8767 * effect as:
8768 *
8769 * <?php $array[] = $var; ?>
8770 *
8771 * repeated for each {@link var}.
8772 *
8773 * @param array $array The input array.
8774 * @param mixed $var The pushed value.
8775 * @return int
8776 * @since PHP 4, PHP 5
8777 **/
8778function array_push(&$array, $var){}
8779
8780/**
8781 * {@link array_rand} is rather useful when you want to pick one or more
8782 * random entries out of an array.
8783 *
8784 * @param array $input The input array.
8785 * @param int $num_req Specifies how many entries you want to pick.
8786 *   Trying to pick more elements than there are in the array will result
8787 *   in an E_WARNING level error.
8788 * @return mixed
8789 * @since PHP 4, PHP 5
8790 **/
8791function array_rand($input, $num_req){}
8792
8793/**
8794 * {@link array_reduce} applies iteratively the {@link function} function
8795 * to the elements of the array {@link input}, so as to reduce the array
8796 * to a single value.
8797 *
8798 * @param array $input The input array.
8799 * @param callback $function The callback function.
8800 * @param mixed $initial If the optional {@link initial} is available,
8801 *   it will be used at the beginning of the process, or as a final
8802 *   result in case the array is empty.
8803 * @return mixed
8804 * @since PHP 4 >= 4.0.5, PHP 5
8805 **/
8806function array_reduce($input, $function, $initial){}
8807
8808/**
8809 * {@link array_replace} replaces the values of the first {@link array}
8810 * with the same values from all the following arrays. If a key from the
8811 * first array exists in the second array, its value will be replaced by
8812 * the value from the second array. If the key exists in the second
8813 * array, and not the first, it will be created in the first array. If a
8814 * key only exists in the first array, it will be left as is. If several
8815 * arrays are passed for replacement, they will be processed in order,
8816 * the later arrays overwriting the previous values.
8817 *
8818 * {@link array_replace} is not recursive : it will replace values in the
8819 * first array by whatever type is in the second array.
8820 *
8821 * @param array $array The array in which elements are replaced.
8822 * @param array $array1 The array from which elements will be
8823 *   extracted.
8824 * @param array $array2
8825 * @return array
8826 * @since PHP 5 >= 5.3.0
8827 **/
8828function array_replace(&$array, &$array1, &$array2){}
8829
8830/**
8831 * {@link array_replace_recursive} replaces the values of the first
8832 * {@link array} with the same values from all the following arrays. If a
8833 * key from the first array exists in the second array, its value will be
8834 * replaced by the value from the second array. If the key exists in the
8835 * second array, and not the first, it will be created in the first
8836 * array. If a key only exists in the first array, it will be left as is.
8837 * If several arrays are passed for replacement, they will be processed
8838 * in order, the later array overwriting the previous values.
8839 *
8840 * {@link array_replace_recursive} is recursive : it will recurse into
8841 * arrays and apply the same process to the inner value.
8842 *
8843 * When the value in {@link array} is scalar, it will be replaced by the
8844 * value in {@link array1}, may it be scalar or array. When the value in
8845 * {@link array} and {@link array1} are both arrays, {@link
8846 * array_replace_recursive} will replace their respective value
8847 * recursively.
8848 *
8849 * @param array $array The array in which elements are replaced.
8850 * @param array $array1 The array from which elements will be
8851 *   extracted.
8852 * @param array $array2
8853 * @return array
8854 * @since PHP 5 >= 5.3.0
8855 **/
8856function array_replace_recursive(&$array, &$array1, &$array2){}
8857
8858/**
8859 * Takes an input {@link array} and returns a new array with the order of
8860 * the elements reversed.
8861 *
8862 * @param array $array The input array.
8863 * @param bool $preserve_keys If set to keys are preserved.
8864 * @return array
8865 * @since PHP 4, PHP 5
8866 **/
8867function array_reverse($array, $preserve_keys){}
8868
8869/**
8870 * Searches {@link haystack} for {@link needle}.
8871 *
8872 * @param mixed $needle The searched value.
8873 * @param array $haystack The array.
8874 * @param bool $strict If the third parameter {@link strict} is set to
8875 *   then the {@link array_search} function will search for identical
8876 *   elements in the {@link haystack}. This means it will also check the
8877 *   types of the {@link needle} in the {@link haystack}, and objects
8878 *   must be the same instance.
8879 * @return mixed
8880 * @since PHP 4 >= 4.0.5, PHP 5
8881 **/
8882function array_search($needle, $haystack, $strict){}
8883
8884/**
8885 * {@link array_shift} shifts the first value of the {@link array} off
8886 * and returns it, shortening the {@link array} by one element and moving
8887 * everything down. All numerical array keys will be modified to start
8888 * counting from zero while literal keys won't be touched.
8889 *
8890 * @param array $array The input array.
8891 * @return mixed
8892 * @since PHP 4, PHP 5
8893 **/
8894function array_shift(&$array){}
8895
8896/**
8897 * {@link array_slice} returns the sequence of elements from the array
8898 * {@link array} as specified by the {@link offset} and {@link length}
8899 * parameters.
8900 *
8901 * @param array $array The input array.
8902 * @param int $offset If {@link offset} is non-negative, the sequence
8903 *   will start at that offset in the {@link array}. If {@link offset} is
8904 *   negative, the sequence will start that far from the end of the
8905 *   {@link array}.
8906 * @param int $length If {@link length} is given and is positive, then
8907 *   the sequence will have that many elements in it. If {@link length}
8908 *   is given and is negative then the sequence will stop that many
8909 *   elements from the end of the array. If it is omitted, then the
8910 *   sequence will have everything from {@link offset} up until the end
8911 *   of the {@link array}.
8912 * @param bool $preserve_keys Note that {@link array_slice} will
8913 *   reorder and reset the array indices by default. You can change this
8914 *   behaviour by setting {@link preserve_keys} to .
8915 * @return array
8916 * @since PHP 4, PHP 5
8917 **/
8918function array_slice($array, $offset, $length, $preserve_keys){}
8919
8920/**
8921 * Removes the elements designated by {@link offset} and {@link length}
8922 * from the {@link input} array, and replaces them with the elements of
8923 * the {@link replacement} array, if supplied.
8924 *
8925 * Note that numeric keys in {@link input} are not preserved.
8926 *
8927 * @param array $input The input array.
8928 * @param int $offset If {@link offset} is positive then the start of
8929 *   removed portion is at that offset from the beginning of the {@link
8930 *   input} array. If {@link offset} is negative then it starts that far
8931 *   from the end of the {@link input} array.
8932 * @param int $length If {@link length} is omitted, removes everything
8933 *   from {@link offset} to the end of the array. If {@link length} is
8934 *   specified and is positive, then that many elements will be removed.
8935 *   If {@link length} is specified and is negative then the end of the
8936 *   removed portion will be that many elements from the end of the
8937 *   array. Tip: to remove everything from {@link offset} to the end of
8938 *   the array when {@link replacement} is also specified, use
8939 *   count($input) for {@link length}.
8940 * @param mixed $replacement If {@link replacement} array is specified,
8941 *   then the removed elements are replaced with elements from this
8942 *   array. If {@link offset} and {@link length} are such that nothing is
8943 *   removed, then the elements from the {@link replacement} array are
8944 *   inserted in the place specified by the {@link offset}. Note that
8945 *   keys in replacement array are not preserved. If {@link replacement}
8946 *   is just one element it is not necessary to put array() around it,
8947 *   unless the element is an array itself, an object or .
8948 * @return array
8949 * @since PHP 4, PHP 5
8950 **/
8951function array_splice(&$input, $offset, $length, $replacement){}
8952
8953/**
8954 * {@link array_sum} returns the sum of values in an array.
8955 *
8956 * @param array $array The input array.
8957 * @return number
8958 * @since PHP 4 >= 4.0.4, PHP 5
8959 **/
8960function array_sum($array){}
8961
8962/**
8963 * Computes the difference of arrays by using a callback function for
8964 * data comparison. This is unlike {@link array_diff} which uses an
8965 * internal function for comparing the data.
8966 *
8967 * @param array $array1 The first array.
8968 * @param array $array2 The second array.
8969 * @param callback $data_compare_func The callback comparison function.
8970 *   The user supplied callback function is used for comparison. It must
8971 *   return an integer less than, equal to, or greater than zero if the
8972 *   first argument is considered to be respectively less than, equal to,
8973 *   or greater than the second.
8974 * @return array
8975 * @since PHP 5
8976 **/
8977function array_udiff($array1, $array2, $data_compare_func){}
8978
8979/**
8980 * Computes the difference of arrays with additional index check,
8981 * compares data by a callback function.
8982 *
8983 * @param array $array1 The first array.
8984 * @param array $array2 The second array.
8985 * @param callback $data_compare_func The callback comparison function.
8986 *   The user supplied callback function is used for comparison. It must
8987 *   return an integer less than, equal to, or greater than zero if the
8988 *   first argument is considered to be respectively less than, equal to,
8989 *   or greater than the second.
8990 * @return array
8991 * @since PHP 5
8992 **/
8993function array_udiff_assoc($array1, $array2, $data_compare_func){}
8994
8995/**
8996 * Computes the difference of arrays with additional index check,
8997 * compares data and indexes by a callback function.
8998 *
8999 * Note that the keys are used in the comparison unlike {@link
9000 * array_diff} and {@link array_udiff}.
9001 *
9002 * @param array $array1 The first array.
9003 * @param array $array2 The second array.
9004 * @param callback $data_compare_func The callback comparison function.
9005 *   The user supplied callback function is used for comparison. It must
9006 *   return an integer less than, equal to, or greater than zero if the
9007 *   first argument is considered to be respectively less than, equal to,
9008 *   or greater than the second. The comparison of arrays' data is
9009 *   performed by using an user-supplied callback : {@link
9010 *   data_compare_func}. In this aspect the behaviour is opposite to the
9011 *   behaviour of {@link array_diff_assoc} which uses internal function
9012 *   for comparison.
9013 * @param callback $key_compare_func The comparison of keys (indices)
9014 *   is done also by the callback function {@link key_compare_func}. This
9015 *   behaviour is unlike what {@link array_udiff_assoc} does, since the
9016 *   latter compares the indices by using an internal function.
9017 * @return array
9018 * @since PHP 5
9019 **/
9020function array_udiff_uassoc($array1, $array2, $data_compare_func, $key_compare_func){}
9021
9022/**
9023 * Computes the intersection of arrays, compares data by a callback
9024 * function.
9025 *
9026 * @param array $array1 The first array.
9027 * @param array $array2 The second array.
9028 * @param callback $data_compare_func The callback comparison function.
9029 *   The user supplied callback function is used for comparison. It must
9030 *   return an integer less than, equal to, or greater than zero if the
9031 *   first argument is considered to be respectively less than, equal to,
9032 *   or greater than the second.
9033 * @return array
9034 * @since PHP 5
9035 **/
9036function array_uintersect($array1, $array2, $data_compare_func){}
9037
9038/**
9039 * Computes the intersection of arrays with additional index check,
9040 * compares data by a callback function.
9041 *
9042 * Note that the keys are used in the comparison unlike in {@link
9043 * array_uintersect}. The data is compared by using a callback function.
9044 *
9045 * @param array $array1 The first array.
9046 * @param array $array2 The second array.
9047 * @param callback $data_compare_func For comparison is used the user
9048 *   supplied callback function. It must return an integer less than,
9049 *   equal to, or greater than zero if the first argument is considered
9050 *   to be respectively less than, equal to, or greater than the second.
9051 * @return array
9052 * @since PHP 5
9053 **/
9054function array_uintersect_assoc($array1, $array2, $data_compare_func){}
9055
9056/**
9057 * Computes the intersection of arrays with additional index check,
9058 * compares data and indexes by a callback functions Note that the keys
9059 * are used in the comparison unlike in {@link array_uintersect}. Both
9060 * the data and the indexes are compared by using separate callback
9061 * functions.
9062 *
9063 * @param array $array1 The first array.
9064 * @param array $array2 The second array.
9065 * @param callback $data_compare_func For comparison is used the user
9066 *   supplied callback function. It must return an integer less than,
9067 *   equal to, or greater than zero if the first argument is considered
9068 *   to be respectively less than, equal to, or greater than the second.
9069 * @param callback $key_compare_func Key comparison callback function.
9070 * @return array
9071 * @since PHP 5
9072 **/
9073function array_uintersect_uassoc($array1, $array2, $data_compare_func, $key_compare_func){}
9074
9075/**
9076 * Takes an input {@link array} and returns a new array without duplicate
9077 * values.
9078 *
9079 * Note that keys are preserved. {@link array_unique} sorts the values
9080 * treated as string at first, then will keep the first key encountered
9081 * for every value, and ignore all following keys. It does not mean that
9082 * the key of the first related value from the unsorted {@link array}
9083 * will be kept.
9084 *
9085 * @param array $array The input array.
9086 * @param int $sort_flags The optional second parameter {@link
9087 *   sort_flags} may be used to modify the sorting behavior using these
9088 *   values: Sorting type flags: SORT_REGULAR - compare items normally
9089 *   (don't change types) SORT_NUMERIC - compare items numerically
9090 *   SORT_STRING - compare items as strings SORT_LOCALE_STRING - compare
9091 *   items as strings, based on the current locale. Added in PHP 4.4.0
9092 *   and 5.0.2.
9093 * @return array
9094 * @since PHP 4 >= 4.0.1, PHP 5
9095 **/
9096function array_unique($array, $sort_flags){}
9097
9098/**
9099 * {@link array_unshift} prepends passed elements to the front of the
9100 * {@link array}. Note that the list of elements is prepended as a whole,
9101 * so that the prepended elements stay in the same order. All numerical
9102 * array keys will be modified to start counting from zero while literal
9103 * keys won't be touched.
9104 *
9105 * @param array $array The input array.
9106 * @param mixed $var The prepended variable.
9107 * @return int
9108 * @since PHP 4, PHP 5
9109 **/
9110function array_unshift(&$array, $var){}
9111
9112/**
9113 * {@link array_values} returns all the values from the {@link input}
9114 * array and indexes numerically the array.
9115 *
9116 * @param array $input The array.
9117 * @return array
9118 * @since PHP 4, PHP 5
9119 **/
9120function array_values($input){}
9121
9122/**
9123 * {@link array_walk} is not affected by the internal array pointer of
9124 * {@link array}. {@link array_walk} will walk through the entire array
9125 * regardless of pointer position.
9126 *
9127 * @param array $array The input array.
9128 * @param callback $funcname Typically, {@link funcname} takes on two
9129 *   parameters. The {@link array} parameter's value being the first, and
9130 *   the key/index second. Users may not change the {@link array} itself
9131 *   from the callback function. e.g. Add/delete elements, unset
9132 *   elements, etc. If the array that {@link array_walk} is applied to is
9133 *   changed, the behavior of this function is undefined, and
9134 *   unpredictable.
9135 * @param mixed $userdata If the optional {@link userdata} parameter is
9136 *   supplied, it will be passed as the third parameter to the callback
9137 *   {@link funcname}.
9138 * @return bool
9139 * @since PHP 4, PHP 5
9140 **/
9141function array_walk(&$array, $funcname, $userdata){}
9142
9143/**
9144 * Applies the user-defined function {@link funcname} to each element of
9145 * the {@link input} array. This function will recur into deeper arrays.
9146 *
9147 * @param array $input The input array.
9148 * @param callback $funcname Typically, {@link funcname} takes on two
9149 *   parameters. The {@link input} parameter's value being the first, and
9150 *   the key/index second.
9151 * @param mixed $userdata If the optional {@link userdata} parameter is
9152 *   supplied, it will be passed as the third parameter to the callback
9153 *   {@link funcname}.
9154 * @return bool
9155 * @since PHP 5
9156 **/
9157function array_walk_recursive(&$input, $funcname, $userdata){}
9158
9159/**
9160 * This function sorts an array such that array indices maintain their
9161 * correlation with the array elements they are associated with.
9162 *
9163 * This is used mainly when sorting associative arrays where the actual
9164 * element order is significant.
9165 *
9166 * @param array $array The input array.
9167 * @param int $sort_flags You may modify the behavior of the sort using
9168 *   the optional parameter {@link sort_flags}, for details see {@link
9169 *   sort}.
9170 * @return bool
9171 * @since PHP 4, PHP 5
9172 **/
9173function arsort(&$array, $sort_flags){}
9174
9175/**
9176 * Returns the arc sine of {@link arg} in radians. {@link asin} is the
9177 * complementary function of {@link sin}, which means that
9178 * a==sin(asin(a)) for every value of a that is within {@link asin}'s
9179 * range.
9180 *
9181 * @param float $arg The argument to process
9182 * @return float
9183 * @since PHP 4, PHP 5
9184 **/
9185function asin($arg){}
9186
9187/**
9188 * Returns the inverse hyperbolic sine of {@link arg}, i.e. the value
9189 * whose hyperbolic sine is {@link arg}.
9190 *
9191 * @param float $arg The argument to process
9192 * @return float
9193 * @since PHP 4 >= 4.1.0, PHP 5
9194 **/
9195function asinh($arg){}
9196
9197/**
9198 * This function sorts an array such that array indices maintain their
9199 * correlation with the array elements they are associated with. This is
9200 * used mainly when sorting associative arrays where the actual element
9201 * order is significant.
9202 *
9203 * @param array $array The input array.
9204 * @param int $sort_flags You may modify the behavior of the sort using
9205 *   the optional parameter {@link sort_flags}, for details see {@link
9206 *   sort}.
9207 * @return bool
9208 * @since PHP 4, PHP 5
9209 **/
9210function asort(&$array, $sort_flags){}
9211
9212/**
9213 * {@link assert} will check the given {@link assertion} and take
9214 * appropriate action if its result is .
9215 *
9216 * If the {@link assertion} is given as a string it will be evaluated as
9217 * PHP code by {@link assert}. The advantages of a string {@link
9218 * assertion} are less overhead when assertion checking is off and
9219 * messages containing the {@link assertion} expression when an assertion
9220 * fails. This means that if you pass a boolean condition as {@link
9221 * assertion} this condition will not show up as parameter to the
9222 * assertion function which you may have defined with the {@link
9223 * assert_options} function, the condition is converted to a string
9224 * before calling that handler function, and the boolean is converted as
9225 * the empty string.
9226 *
9227 * Assertions should be used as a debugging feature only. You may use
9228 * them for sanity-checks that test for conditions that should always be
9229 * and that indicate some programming errors if not or to check for the
9230 * presence of certain features like extension functions or certain
9231 * system limits and features.
9232 *
9233 * Assertions should not be used for normal runtime operations like input
9234 * parameter checks. As a rule of thumb your code should always be able
9235 * to work correctly if assertion checking is not activated.
9236 *
9237 * The behavior of {@link assert} may be configured by {@link
9238 * assert_options} or by .ini-settings described in that functions manual
9239 * page.
9240 *
9241 * The {@link assert_options} function and/or ASSERT_CALLBACK
9242 * configuration directive allow a callback function to be set to handle
9243 * failed assertions.
9244 *
9245 * {@link assert} callbacks are particularly useful for building
9246 * automated test suites because they allow you to easily capture the
9247 * code passed to the assertion, along with information on where the
9248 * assertion was made. While this information can be captured via other
9249 * methods, using assertions makes it much faster and easier!
9250 *
9251 * The callback function should accept three arguments. The first
9252 * argument will contain the file the assertion failed in. The second
9253 * argument will contain the line the assertion failed on and the third
9254 * argument will contain the expression that failed (if any - literal
9255 * values such as 1 or "two" will not be passed via this argument)
9256 *
9257 * @param mixed $assertion The assertion.
9258 * @return bool
9259 * @since PHP 4, PHP 5
9260 **/
9261function assert($assertion){}
9262
9263/**
9264 * Set the various {@link assert} control options or just query their
9265 * current settings.
9266 *
9267 * @param int $what Assert Options Option INI Setting Default value
9268 *   Description ASSERT_ACTIVE assert.active 1 enable {@link assert}
9269 *   evaluation ASSERT_WARNING assert.warning 1 issue a PHP warning for
9270 *   each failed assertion ASSERT_BAIL assert.bail 0 terminate execution
9271 *   on failed assertions ASSERT_QUIET_EVAL assert.quiet_eval 0 disable
9272 *   error_reporting during assertion expression evaluation
9273 *   ASSERT_CALLBACK assert.callback () Callback to call on failed
9274 *   assertions
9275 * @param mixed $value An optional new value for the option.
9276 * @return mixed
9277 * @since PHP 4, PHP 5
9278 **/
9279function assert_options($what, $value){}
9280
9281/**
9282 * Returns the arc tangent of {@link arg} in radians. {@link atan} is the
9283 * complementary function of {@link tan}, which means that
9284 * a==tan(atan(a)) for every value of a that is within {@link atan}'s
9285 * range.
9286 *
9287 * @param float $arg The argument to process
9288 * @return float
9289 * @since PHP 4, PHP 5
9290 **/
9291function atan($arg){}
9292
9293/**
9294 * @param float $y Dividend parameter
9295 * @param float $x Divisor parameter
9296 * @return float
9297 * @since PHP 4, PHP 5
9298 **/
9299function atan2($y, $x){}
9300
9301/**
9302 * Returns the inverse hyperbolic tangent of {@link arg}, i.e. the value
9303 * whose hyperbolic tangent is {@link arg}.
9304 *
9305 * @param float $arg The argument to process
9306 * @return float
9307 * @since PHP 4 >= 4.1.0, PHP 5
9308 **/
9309function atanh($arg){}
9310
9311/**
9312 * Decodes a base64 encoded {@link data}.
9313 *
9314 * @param string $data The encoded data.
9315 * @param bool $strict Returns if input contains character from outside
9316 *   the base64 alphabet.
9317 * @return string
9318 * @since PHP 4, PHP 5
9319 **/
9320function base64_decode($data, $strict){}
9321
9322/**
9323 * Encodes the given {@link data} with base64.
9324 *
9325 * This encoding is designed to make binary data survive transport
9326 * through transport layers that are not 8-bit clean, such as mail
9327 * bodies.
9328 *
9329 * Base64-encoded data takes about 33% more space than the original data.
9330 *
9331 * @param string $data The data to encode.
9332 * @return string
9333 * @since PHP 4, PHP 5
9334 **/
9335function base64_encode($data){}
9336
9337/**
9338 * Given a string containing a path to a file, this function will return
9339 * the base name of the file.
9340 *
9341 * @param string $path A path. On Windows, both slash (/) and backslash
9342 *   (\) are used as directory separator character. In other
9343 *   environments, it is the forward slash (/).
9344 * @param string $suffix If the filename ends in {@link suffix} this
9345 *   will also be cut off.
9346 * @return string
9347 * @since PHP 4, PHP 5
9348 **/
9349function basename($path, $suffix){}
9350
9351/**
9352 * Returns a string containing {@link number} represented in base {@link
9353 * tobase}. The base in which {@link number} is given is specified in
9354 * {@link frombase}. Both {@link frombase} and {@link tobase} have to be
9355 * between 2 and 36, inclusive. Digits in numbers with a base higher than
9356 * 10 will be represented with the letters a-z, with a meaning 10, b
9357 * meaning 11 and z meaning 35.
9358 *
9359 * @param string $number The number to convert
9360 * @param int $frombase The base {@link number} is in
9361 * @param int $tobase The base to convert {@link number} to
9362 * @return string
9363 * @since PHP 4, PHP 5
9364 **/
9365function base_convert($number, $frombase, $tobase){}
9366
9367/**
9368 * Adds a tag to an existing BBCode_Container tag_set using tag_rules.
9369 *
9370 * @param resource $bbcode_container BBCode_Container resource,
9371 *   returned by {@link bbcode_create}.
9372 * @param string $tag_name The new tag to add to the BBCode_Container
9373 *   tag_set.
9374 * @param array $tag_rules An associative array containing the parsing
9375 *   rules; see {@link bbcode_create} for the available keys.
9376 * @return bool
9377 * @since PECL bbcode >= 0.9.0
9378 **/
9379function bbcode_add_element($bbcode_container, $tag_name, $tag_rules){}
9380
9381/**
9382 * Adds a smiley to the parser
9383 *
9384 * @param resource $bbcode_container BBCode_Container resource,
9385 *   returned by {@link bbcode_create}.
9386 * @param string $smiley The string that will be replaced when found.
9387 * @param string $replace_by The string that replace smiley when found.
9388 * @return bool
9389 * @since PECL bbcode >= 0.10.2
9390 **/
9391function bbcode_add_smiley($bbcode_container, $smiley, $replace_by){}
9392
9393/**
9394 * This function returns a new BBCode Resource used to parse BBCode
9395 * strings.
9396 *
9397 * @param array $bbcode_initial_tags An associative array containing
9398 *   the tag names as keys and parameters required to correctly parse
9399 *   BBCode as their value. The following key/value pairs are supported:
9400 *   flags optional - a flag set based on the BBCODE_FLAGS_* constants.
9401 *   type required - an int indicating the type of tag. Use the
9402 *   BBCODE_TYPE_* constants. open_tag required - the HTML replacement
9403 *   string for the open tag. close_tag required - the HTML replacement
9404 *   string for the close tag. default_arg optional - use this value as
9405 *   the default argument if none is provided and tag_type is of type
9406 *   OPTARG. content_handling optional - Gives the callback used for
9407 *   modification of the content. Object Oriented Notation supported only
9408 *   since 0.10.1 callback prototype is string name(string $content,
9409 *   string $argument) param_handling optional - Gives the callback used
9410 *   for modification of the argument. Object Oriented Notation supported
9411 *   only since 0.10.1 callback prototype is string name(string $content,
9412 *   string $argument) childs optional - List of accepted children for
9413 *   the tag. The format of the list is a comma separated string. If the
9414 *   list starts with ! it will be the list of rejected children for the
9415 *   tag. parent optional - List of accepted parents for the tag. The
9416 *   format of the list is a comma separated string.
9417 * @return resource
9418 * @since PECL bbcode >= 0.9.0
9419 **/
9420function bbcode_create($bbcode_initial_tags){}
9421
9422/**
9423 * This function closes the resource opened by {@link bbcode_create}.
9424 *
9425 * @param resource $bbcode_container BBCode_Container resource returned
9426 *   by {@link bbcode_create}.
9427 * @return bool
9428 * @since PECL bbcode >= 0.9.0
9429 **/
9430function bbcode_destroy($bbcode_container){}
9431
9432/**
9433 * This function parse the string to_parse following the rules in the
9434 * bbcode_container created by {@link bbcode_create}
9435 *
9436 * @param resource $bbcode_container BBCode_Container resource returned
9437 *   by {@link bbcode_create}.
9438 * @param string $to_parse The string we need to parse.
9439 * @return string
9440 * @since PECL bbcode >= 0.9.0
9441 **/
9442function bbcode_parse($bbcode_container, $to_parse){}
9443
9444/**
9445 * Attaches another parser to the bbcode_container. This parser is used
9446 * only when arguments must be parsed. If this function is not used, the
9447 * default argument parser is the parser itself.
9448 *
9449 * @param resource $bbcode_container BBCode_Container resource,
9450 *   returned by {@link bbcode_create}.
9451 * @param resource $bbcode_arg_parser BBCode_Container resource,
9452 *   returned by {@link bbcode_create}. It will be used only for parsed
9453 *   arguments
9454 * @return bool
9455 * @since PECL bbcode >= 0.10.2
9456 **/
9457function bbcode_set_arg_parser($bbcode_container, $bbcode_arg_parser){}
9458
9459/**
9460 * Set or alter parser options
9461 *
9462 * @param resource $bbcode_container BBCode_Container resource,
9463 *   returned by {@link bbcode_create}.
9464 * @param int $flags The flag set that must be applied to the
9465 *   bbcode_container options
9466 * @param int $mode One of the BBCODE_SET_FLAGS_* constant to set,
9467 *   unset a specific flag set or to replace the flag set by flags.
9468 * @return bool
9469 * @since PECL bbcode >= 0.10.2
9470 **/
9471function bbcode_set_flags($bbcode_container, $flags, $mode){}
9472
9473/**
9474 * Sums {@link left_operand} and {@link right_operand}.
9475 *
9476 * @param string $left_operand The left operand, as a string.
9477 * @param string $right_operand The right operand, as a string.
9478 * @param int $scale
9479 * @return string
9480 * @since PHP 4, PHP 5
9481 **/
9482function bcadd($left_operand, $right_operand, $scale){}
9483
9484/**
9485 * Compares the {@link left_operand} to the {@link right_operand} and
9486 * returns the result as an integer.
9487 *
9488 * @param string $left_operand The left operand, as a string.
9489 * @param string $right_operand The right operand, as a string.
9490 * @param int $scale The optional {@link scale} parameter is used to
9491 *   set the number of digits after the decimal place which will be used
9492 *   in the comparison.
9493 * @return int
9494 * @since PHP 4, PHP 5
9495 **/
9496function bccomp($left_operand, $right_operand, $scale){}
9497
9498/**
9499 * Divides the {@link left_operand} by the {@link right_operand}.
9500 *
9501 * @param string $left_operand The left operand, as a string.
9502 * @param string $right_operand The right operand, as a string.
9503 * @param int $scale
9504 * @return string
9505 * @since PHP 4, PHP 5
9506 **/
9507function bcdiv($left_operand, $right_operand, $scale){}
9508
9509/**
9510 * Get the modulus of the {@link left_operand} using {@link modulus}.
9511 *
9512 * @param string $left_operand The left operand, as a string.
9513 * @param string $modulus The modulus, as a string.
9514 * @return string
9515 * @since PHP 4, PHP 5
9516 **/
9517function bcmod($left_operand, $modulus){}
9518
9519/**
9520 * Multiply the {@link left_operand} by the {@link right_operand}.
9521 *
9522 * @param string $left_operand The left operand, as a string.
9523 * @param string $right_operand The right operand, as a string.
9524 * @param int $scale
9525 * @return string
9526 * @since PHP 4, PHP 5
9527 **/
9528function bcmul($left_operand, $right_operand, $scale){}
9529
9530/**
9531 * Reads data from a bzcompressed file and creates classes from the
9532 * bytecodes.
9533 *
9534 * @param string $filename The bzcompressed file path, as a string.
9535 * @return bool
9536 * @since PECL bcompiler >= 0.4
9537 **/
9538function bcompiler_load($filename){}
9539
9540/**
9541 * Reads data from a bcompiler exe file and creates classes from the
9542 * bytecodes.
9543 *
9544 * @param string $filename The exe file path, as a string.
9545 * @return bool
9546 * @since PECL bcompiler >= 0.4
9547 **/
9548function bcompiler_load_exe($filename){}
9549
9550/**
9551 * Reads the bytecodes of a class and calls back to a user function.
9552 *
9553 * @param string $class The class name, as a string.
9554 * @param string $callback
9555 * @return bool
9556 * @since PECL bcompiler >= 0.4
9557 **/
9558function bcompiler_parse_class($class, $callback){}
9559
9560/**
9561 * Reads data from a open file handle and creates classes from the
9562 * bytecodes.
9563 *
9564 * @param resource $filehandle A file handle as returned by {@link
9565 *   fopen}.
9566 * @return bool
9567 * @since PECL bcompiler >= 0.4
9568 **/
9569function bcompiler_read($filehandle){}
9570
9571/**
9572 * Reads the bytecodes from PHP for an existing class, and writes them to
9573 * the open file handle.
9574 *
9575 * @param resource $filehandle A file handle as returned by {@link
9576 *   fopen}.
9577 * @param string $className The class name, as a string.
9578 * @param string $extends
9579 * @return bool
9580 * @since PECL bcompiler >= 0.4
9581 **/
9582function bcompiler_write_class($filehandle, $className, $extends){}
9583
9584/**
9585 * Reads the bytecodes from PHP for an existing constant, and writes them
9586 * to the open file handle.
9587 *
9588 * @param resource $filehandle A file handle as returned by {@link
9589 *   fopen}.
9590 * @param string $constantName The name of the defined constant, as a
9591 *   string.
9592 * @return bool
9593 * @since PECL bcompiler >= 0.5
9594 **/
9595function bcompiler_write_constant($filehandle, $constantName){}
9596
9597/**
9598 * An EXE (or self executable) file consists of 3 parts: The stub
9599 * (executable code, e.g. a compiled C program) that loads PHP
9600 * interpreter, bcompiler extension, stored Bytecodes and initiates a
9601 * call for the specified function (e.g. main) or class method (e.g.
9602 * main::main) The Bytecodes (uncompressed only for the moment) The
9603 * bcompiler EXE footer
9604 *
9605 * To obtain a suitable stub you can compile php_embed-based stub phpe.c
9606 * located in the examples/embed directory on bcompiler's CVS.
9607 *
9608 * @param resource $filehandle A file handle as returned by {@link
9609 *   fopen}.
9610 * @param int $startpos The file position at which the Bytecodes start,
9611 *   and can be obtained using {@link ftell}.
9612 * @return bool
9613 * @since PECL bcompiler >= 0.4
9614 **/
9615function bcompiler_write_exe_footer($filehandle, $startpos){}
9616
9617/**
9618 * This function complies specified source file into bytecodes, and
9619 * writes them to the open file handle.
9620 *
9621 * @param resource $filehandle A file handle as returned by {@link
9622 *   fopen}.
9623 * @param string $filename The source file path, as a string.
9624 * @return bool
9625 * @since PECL bcompiler >= 0.6
9626 **/
9627function bcompiler_write_file($filehandle, $filename){}
9628
9629/**
9630 * Writes the single character \x00 to indicate End of compiled data.
9631 *
9632 * @param resource $filehandle A file handle as returned by {@link
9633 *   fopen}.
9634 * @return bool
9635 * @since PECL bcompiler >= 0.4
9636 **/
9637function bcompiler_write_footer($filehandle){}
9638
9639/**
9640 * Reads the bytecodes from PHP for an existing function, and writes them
9641 * to the open file handle. Order is not important, (eg. if function b
9642 * uses function a, and you compile it like the example below, it will
9643 * work perfectly OK).
9644 *
9645 * @param resource $filehandle A file handle as returned by {@link
9646 *   fopen}.
9647 * @param string $functionName The function name, as a string.
9648 * @return bool
9649 * @since PECL bcompiler >= 0.5
9650 **/
9651function bcompiler_write_function($filehandle, $functionName){}
9652
9653/**
9654 * Searches for all functions declared in the given file, and writes
9655 * their correspondent bytecodes to the open file handle.
9656 *
9657 * @param resource $filehandle A file handle as returned by {@link
9658 *   fopen}.
9659 * @param string $fileName The file to be compiled. You must always
9660 *   include or require the file you intend to compile.
9661 * @return bool
9662 * @since PECL bcompiler >= 0.5
9663 **/
9664function bcompiler_write_functions_from_file($filehandle, $fileName){}
9665
9666/**
9667 * Writes the header part of a bcompiler file.
9668 *
9669 * @param resource $filehandle A file handle as returned by {@link
9670 *   fopen}.
9671 * @param string $write_ver Can be used to write bytecode in a
9672 *   previously used format, so that you can use it with older versions
9673 *   of bcompiler.
9674 * @return bool
9675 * @since PECL bcompiler >= 0.3
9676 **/
9677function bcompiler_write_header($filehandle, $write_ver){}
9678
9679/**
9680 * @param resource $filehandle
9681 * @param string $filename
9682 * @return bool
9683 * @since PECL bcompiler >= 0.5
9684 **/
9685function bcompiler_write_included_filename($filehandle, $filename){}
9686
9687/**
9688 * Raise {@link left_operand} to the power {@link right_operand}.
9689 *
9690 * @param string $left_operand The left operand, as a string.
9691 * @param string $right_operand The right operand, as a string.
9692 * @param int $scale
9693 * @return string
9694 * @since PHP 4, PHP 5
9695 **/
9696function bcpow($left_operand, $right_operand, $scale){}
9697
9698/**
9699 * Use the fast-exponentiation method to raise {@link left_operand} to
9700 * the power {@link right_operand} with respect to the modulus {@link
9701 * modulus}.
9702 *
9703 * @param string $left_operand The left operand, as a string.
9704 * @param string $right_operand The right operand, as a string.
9705 * @param string $modulus The modulus, as a string.
9706 * @param int $scale
9707 * @return string
9708 * @since PHP 5
9709 **/
9710function bcpowmod($left_operand, $right_operand, $modulus, $scale){}
9711
9712/**
9713 * Sets the default scale parameter for all subsequent bc math functions
9714 * that do not explicitly specify a scale parameter.
9715 *
9716 * @param int $scale The scale factor.
9717 * @return bool
9718 * @since PHP 4, PHP 5
9719 **/
9720function bcscale($scale){}
9721
9722/**
9723 * Return the square root of the {@link operand}.
9724 *
9725 * @param string $operand The operand, as a string.
9726 * @param int $scale
9727 * @return string
9728 * @since PHP 4, PHP 5
9729 **/
9730function bcsqrt($operand, $scale){}
9731
9732/**
9733 * Subtracts the {@link right_operand} from the {@link left_operand}.
9734 *
9735 * @param string $left_operand The left operand, as a string.
9736 * @param string $right_operand The right operand, as a string.
9737 * @param int $scale
9738 * @return string
9739 * @since PHP 4, PHP 5
9740 **/
9741function bcsub($left_operand, $right_operand, $scale){}
9742
9743/**
9744 * Returns an ASCII string containing the hexadecimal representation of
9745 * {@link str}. The conversion is done byte-wise with the high-nibble
9746 * first.
9747 *
9748 * @param string $str A character.
9749 * @return string
9750 * @since PHP 4, PHP 5
9751 **/
9752function bin2hex($str){}
9753
9754/**
9755 * Returns the decimal equivalent of the binary number represented by the
9756 * {@link binary_string} argument.
9757 *
9758 * {@link bindec} converts a binary number to an integer or, if needed
9759 * for size reasons, float.
9760 *
9761 * {@link bindec} interprets all {@link binary_string} values as unsigned
9762 * integers. This is because {@link bindec} sees the most significant bit
9763 * as another order of magnitude rather than as the sign bit.
9764 *
9765 * @param string $binary_string The binary string to convert
9766 * @return number
9767 * @since PHP 4, PHP 5
9768 **/
9769function bindec($binary_string){}
9770
9771/**
9772 * The {@link bindtextdomain} function sets the path for a domain.
9773 *
9774 * @param string $domain The domain
9775 * @param string $directory The directory path
9776 * @return string
9777 * @since PHP 4, PHP 5
9778 **/
9779function bindtextdomain($domain, $directory){}
9780
9781/**
9782 * With {@link bind_textdomain_codeset}, you can set in which encoding
9783 * will be messages from {@link domain} returned by {@link gettext} and
9784 * similar functions.
9785 *
9786 * @param string $domain The domain
9787 * @param string $codeset The code set
9788 * @return string
9789 * @since PHP 4 >= 4.2.0, PHP 5
9790 **/
9791function bind_textdomain_codeset($domain, $codeset){}
9792
9793/**
9794 * This function is very beta and entirely useless for 99% of users. It
9795 * is only useful if you're doing something weird, such as writing your
9796 * own driver on top of the PHP driver.
9797 *
9798 * @param string $bson The BSON to be deserialized.
9799 * @return array
9800 * @since PECL mongo >=1.0.1
9801 **/
9802function bson_decode($bson){}
9803
9804/**
9805 * This function is very beta and entirely useless for 99% of users. It
9806 * is only useful if you're doing something weird, such as writing your
9807 * own driver on top of the PHP driver.
9808 *
9809 * @param mixed $anything The variable to be serialized.
9810 * @return string
9811 * @since PECL mongo >=1.0.1
9812 **/
9813function bson_encode($anything){}
9814
9815/**
9816 * Closes the given bzip2 file pointer.
9817 *
9818 * @param resource $bz The file pointer. It must be valid and must
9819 *   point to a file successfully opened by {@link bzopen}.
9820 * @return int
9821 * @since PHP 4 >= 4.0.4, PHP 5
9822 **/
9823function bzclose($bz){}
9824
9825/**
9826 * {@link bzcompress} compresses the given string and returns it as bzip2
9827 * encoded data.
9828 *
9829 * @param string $source The string to compress.
9830 * @param int $blocksize Specifies the blocksize used during
9831 *   compression and should be a number from 1 to 9 with 9 giving the
9832 *   best compression, but using more resources to do so.
9833 * @param int $workfactor Controls how the compression phase behaves
9834 *   when presented with worst case, highly repetitive, input data. The
9835 *   value can be between 0 and 250 with 0 being a special case.
9836 *   Regardless of the {@link workfactor}, the generated output is the
9837 *   same.
9838 * @return mixed
9839 * @since PHP 4 >= 4.0.4, PHP 5
9840 **/
9841function bzcompress($source, $blocksize, $workfactor){}
9842
9843/**
9844 * {@link bzdecompress} decompresses the given string containing bzip2
9845 * encoded data.
9846 *
9847 * @param string $source The string to decompress.
9848 * @param int $small If , an alternative decompression algorithm will
9849 *   be used which uses less memory (the maximum memory requirement drops
9850 *   to around 2300K) but works at roughly half the speed. See the bzip2
9851 *   documentation for more information about this feature.
9852 * @return mixed
9853 * @since PHP 4 >= 4.0.4, PHP 5
9854 **/
9855function bzdecompress($source, $small){}
9856
9857/**
9858 * Returns the error number of any bzip2 error returned by the given file
9859 * pointer.
9860 *
9861 * @param resource $bz The file pointer. It must be valid and must
9862 *   point to a file successfully opened by {@link bzopen}.
9863 * @return int
9864 * @since PHP 4 >= 4.0.4, PHP 5
9865 **/
9866function bzerrno($bz){}
9867
9868/**
9869 * Returns the error number and error string of any bzip2 error returned
9870 * by the given file pointer.
9871 *
9872 * @param resource $bz The file pointer. It must be valid and must
9873 *   point to a file successfully opened by {@link bzopen}.
9874 * @return array
9875 * @since PHP 4 >= 4.0.4, PHP 5
9876 **/
9877function bzerror($bz){}
9878
9879/**
9880 * Gets the error string of any bzip2 error returned by the given file
9881 * pointer.
9882 *
9883 * @param resource $bz The file pointer. It must be valid and must
9884 *   point to a file successfully opened by {@link bzopen}.
9885 * @return string
9886 * @since PHP 4 >= 4.0.4, PHP 5
9887 **/
9888function bzerrstr($bz){}
9889
9890/**
9891 * Forces a write of all buffered bzip2 data for the file pointer {@link
9892 * bz}.
9893 *
9894 * @param resource $bz The file pointer. It must be valid and must
9895 *   point to a file successfully opened by {@link bzopen}.
9896 * @return int
9897 * @since PHP 4 >= 4.0.4, PHP 5
9898 **/
9899function bzflush($bz){}
9900
9901/**
9902 * {@link bzopen} opens a bzip2 (.bz2) file for reading or writing.
9903 *
9904 * @param string $filename The name of the file to open.
9905 * @param string $mode Similar to the {@link fopen} function, only 'r'
9906 *   (read) and 'w' (write) are supported. Everything else will cause
9907 *   bzopen to return .
9908 * @return resource
9909 * @since PHP 4 >= 4.0.4, PHP 5
9910 **/
9911function bzopen($filename, $mode){}
9912
9913/**
9914 * {@link bzread} reads from the given bzip2 file pointer.
9915 *
9916 * Reading stops when {@link length} (uncompressed) bytes have been read
9917 * or EOF is reached, whichever comes first.
9918 *
9919 * @param resource $bz The file pointer. It must be valid and must
9920 *   point to a file successfully opened by {@link bzopen}.
9921 * @param int $length If not specified, {@link bzread} will read 1024
9922 *   (uncompressed) bytes at a time.
9923 * @return string
9924 * @since PHP 4 >= 4.0.4, PHP 5
9925 **/
9926function bzread($bz, $length){}
9927
9928/**
9929 * {@link bzwrite} writes a string into the given bzip2 file stream.
9930 *
9931 * @param resource $bz The file pointer. It must be valid and must
9932 *   point to a file successfully opened by {@link bzopen}.
9933 * @param string $data The written data.
9934 * @param int $length If supplied, writing will stop after {@link
9935 *   length} (uncompressed) bytes have been written or the end of {@link
9936 *   data} is reached, whichever comes first.
9937 * @return int
9938 * @since PHP 4 >= 4.0.4, PHP 5
9939 **/
9940function bzwrite($bz, $data, $length){}
9941
9942/**
9943 * Appends the {@link path} onto the current path. The {@link path} may
9944 * be either the return value from one of CairoContext::copyPath or
9945 * CairoContext::copyPathFlat;
9946 *
9947 * if {@link path} is not a valid CairoPath instance a CairoException
9948 * will be thrown
9949 *
9950 * @param CairoContext $context CairoContext object
9951 * @param CairoPath $path CairoPath object
9952 * @return void
9953 * @since PECL cairo >= 0.1.0
9954 **/
9955function cairo_append_path($context, $path){}
9956
9957/**
9958 * Adds a circular arc of the given radius to the current path. The arc
9959 * is centered at ({@link x}, {@link y}), begins at {@link angle1} and
9960 * proceeds in the direction of increasing angles to end at {@link
9961 * angle2}. If {@link angle2} is less than {@link angle1} it will be
9962 * progressively increased by 2*M_PI until it is greater than {@link
9963 * angle1}. If there is a current point, an initial line segment will be
9964 * added to the path to connect the current point to the beginning of the
9965 * arc. If this initial line is undesired, it can be avoided by calling
9966 * CairoContext::newSubPath or procedural {@link cairo_new_sub_path}
9967 * before calling CairoContext::arc or {@link cairo_arc}.
9968 *
9969 * Angles are measured in radians. An angle of 0.0 is in the direction of
9970 * the positive X axis (in user space). An angle of M_PI/2.0 radians (90
9971 * degrees) is in the direction of the positive Y axis (in user space).
9972 * Angles increase in the direction from the positive X axis toward the
9973 * positive Y axis. So with the default transformation matrix, angles
9974 * increase in a clockwise direction.
9975 *
9976 * (To convert from degrees to radians, use degrees * (M_PI / 180.).)
9977 * This function gives the arc in the direction of increasing angles; see
9978 * CairoContext::arcNegative or {@link cairo_arc_negative} to get the arc
9979 * in the direction of decreasing angles.
9980 *
9981 * @param CairoContext $context A valid CairoContext object
9982 * @param float $x x position
9983 * @param float $y y position
9984 * @param float $radius Radius of the arc
9985 * @param float $angle1 start angle
9986 * @param float $angle2 end angle
9987 * @return void
9988 * @since PECL cairo >= 0.1.0
9989 **/
9990function cairo_arc($context, $x, $y, $radius, $angle1, $angle2){}
9991
9992/**
9993 * Adds a circular arc of the given {@link radius} to the current path.
9994 * The arc is centered at ({@link x}, {@link y}), begins at {@link
9995 * angle1} and proceeds in the direction of decreasing angles to end at
9996 * {@link angle2}. If {@link angle2} is greater than {@link angle1} it
9997 * will be progressively decreased by 2*M_PI until it is less than {@link
9998 * angle1}.
9999 *
10000 * See CairoContext::arc or {@link cairo_arc} for more details. This
10001 * function differs only in the direction of the arc between the two
10002 * angles.
10003 *
10004 * @param CairoContext $context A valid CairoContext object
10005 * @param float $x double x position
10006 * @param float $y double y position
10007 * @param float $radius The radius of the desired negative arc
10008 * @param float $angle1 Start angle of the arc
10009 * @param float $angle2 End angle of the arc
10010 * @return void
10011 * @since PECL cairo >= 0.1.0
10012 **/
10013function cairo_arc_negative($context, $x, $y, $radius, $angle1, $angle2){}
10014
10015/**
10016 * Returns an array with the available font backends
10017 *
10018 * @return array
10019 **/
10020function cairo_available_fonts(){}
10021
10022/**
10023 * Returns an array with the available surface backends
10024 *
10025 * @return array
10026 **/
10027function cairo_available_surfaces(){}
10028
10029/**
10030 * Establishes a new clip region by intersecting the current clip region
10031 * with the current path as it would be filled by CairoContext::fill or
10032 * {@link cairo_fill} and according to the current fill rule (see
10033 * CairoContext::setFillRule or {@link cairo_set_fill_rule}).
10034 *
10035 * After CairoContext::clip or {@link cairo_clip}, the current path will
10036 * be cleared from the cairo context.
10037 *
10038 * The current clip region affects all drawing operations by effectively
10039 * masking out any changes to the surface that are outside the current
10040 * clip region.
10041 *
10042 * Calling CairoContext::clip or {@link cairo_clip} can only make the
10043 * clip region smaller, never larger. But the current clip is part of the
10044 * graphics state, so a temporary restriction of the clip region can be
10045 * achieved by calling CairoContext::clip or {@link cairo_clip} within a
10046 * CairoContext::save/CairoContext::restore or {@link cairo_save}/{@link
10047 * cairo_restore} pair. The only other means of increasing the size of
10048 * the clip region is CairoContext::resetClip or procedural {@link
10049 * cairo_reset_clip}.
10050 *
10051 * @param CairoContext $context A valid CairoContext object
10052 * @return void
10053 * @since PECL cairo >= 0.1.0
10054 **/
10055function cairo_clip($context){}
10056
10057/**
10058 * Computes a bounding box in user coordinates covering the area inside
10059 * the current clip.
10060 *
10061 * @param CairoContext $context A valid CairoContext object
10062 * @return array
10063 * @since PECL cairo >= 0.1.0
10064 **/
10065function cairo_clip_extents($context){}
10066
10067/**
10068 * Establishes a new clip region by intersecting the current clip region
10069 * with the current path as it would be filled by Context.fill and
10070 * according to the current FILL RULE (see CairoContext::setFillRule or
10071 * {@link cairo_set_fill_rule}).
10072 *
10073 * Unlike CairoContext::clip, CairoContext::clipPreserve preserves the
10074 * path within the Context. The current clip region affects all drawing
10075 * operations by effectively masking out any changes to the surface that
10076 * are outside the current clip region.
10077 *
10078 * Calling CairoContext::clipPreserve can only make the clip region
10079 * smaller, never larger. But the current clip is part of the graphics
10080 * state, so a temporary restriction of the clip region can be achieved
10081 * by calling CairoContext::clipPreserve within a
10082 * CairoContext::save/CairoContext::restore pair. The only other means of
10083 * increasing the size of the clip region is CairoContext::resetClip.
10084 *
10085 * @param CairoContext $context A valid CairoContext object
10086 * @return void
10087 * @since PECL cairo >= 0.1.0
10088 **/
10089function cairo_clip_preserve($context){}
10090
10091/**
10092 * Returns a list-type array with the current clip region as a list of
10093 * rectangles in user coordinates
10094 *
10095 * @param CairoContext $context A valid CairoContext object created
10096 *   with CairoContext::__construct or {@link cairo_create}
10097 * @return array
10098 * @since PECL cairo >= 0.1.0
10099 **/
10100function cairo_clip_rectangle_list($context){}
10101
10102/**
10103 * Adds a line segment to the path from the current point to the
10104 * beginning of the current sub-path, (the most recent point passed to
10105 * CairoContext::moveTo), and closes this sub-path. After this call the
10106 * current point will be at the joined endpoint of the sub-path.
10107 *
10108 * The behavior of close_path() is distinct from simply calling
10109 * CairoContext::lineTo with the equivalent coordinate in the case of
10110 * stroking. When a closed sub-path is stroked, there are no caps on the
10111 * ends of the sub-path. Instead, there is a line join connecting the
10112 * final and initial segments of the sub-path.
10113 *
10114 * If there is no current point before the call to
10115 * CairoContext::closePath, this function will have no effect.
10116 *
10117 * @param CairoContext $context A valid CairoContext object created
10118 *   with CairoContext::__construct or {@link cairo_create}
10119 * @return void
10120 * @since PECL cairo >= 0.1.0
10121 **/
10122function cairo_close_path($context){}
10123
10124/**
10125 * Emits the current page for backends that support multiple pages, but
10126 * doesn't clear it, so that the contents of the current page will be
10127 * retained for the next page. Use CairoSurface::showPage() if you want
10128 * to get an empty page after the emission.
10129 *
10130 * @param CairoContext $context A CairoContext object
10131 * @return void
10132 * @since PECL cairo >= 0.1.0
10133 **/
10134function cairo_copy_page($context){}
10135
10136/**
10137 * Creates a copy of the current path and returns it to the user as a
10138 * CairoPath. See CairoPath for hints on how to iterate over the returned
10139 * data structure.
10140 *
10141 * This function will always return a valid CairoPath object, but the
10142 * result will have no data, if either of the following conditions hold:
10143 * 1. If there is insufficient memory to copy the path. In this case
10144 * CairoPath->status will be set to CAIRO_STATUS_NO_MEMORY. 2. If {@link
10145 * context} is already in an error state. In this case CairoPath->status
10146 * will contain the same status that would be returned by {@link
10147 * cairo_status}.
10148 *
10149 * In either case, CairoPath->status will be set to
10150 * CAIRO_STATUS_NO_MEMORY (regardless of what the error status in cr
10151 * might have been).
10152 *
10153 * @param CairoContext $context A valid CairoContext object created
10154 *   with CairoContext::__construct or {@link cairo_create}
10155 * @return CairoPath
10156 * @since PECL cairo >= 0.1.0
10157 **/
10158function cairo_copy_path($context){}
10159
10160/**
10161 * A CairoContext object
10162 *
10163 * @param CairoContext $context Description...
10164 * @return CairoPath
10165 * @since PECL cairo >= 0.1.0
10166 **/
10167function cairo_copy_path_flat($context){}
10168
10169/**
10170 * The function description goes here.
10171 *
10172 * @param CairoSurface $surface Description...
10173 * @return CairoContext
10174 * @since PECL cairo >= 0.1.0
10175 **/
10176function cairo_create($surface){}
10177
10178/**
10179 * Adds a cubic Bezier spline to the path from the current point to
10180 * position {@link x3} ,{@link y3} in user-space coordinates, using
10181 * {@link x1}, {@link y1} and {@link x2}, {@link y2} as the control
10182 * points. After this call the current point will be {@link x3}, {@link
10183 * y3}.
10184 *
10185 * If there is no current point before the call to CairoContext::curveTo
10186 * this function will behave as if preceded by a call to
10187 * CairoContext::moveTo ({@link x1}, {@link y1}).
10188 *
10189 * @param CairoContext $context A valid CairoContext object created
10190 *   with CairoContext::__construct or {@link cairo_create}
10191 * @param float $x1 First control point in the x axis for the curve
10192 * @param float $y1 First control point in the y axis for the curve
10193 * @param float $x2 Second control point in x axis for the curve
10194 * @param float $y2 Second control point in y axis for the curve
10195 * @param float $x3 Final point in the x axis for the curve
10196 * @param float $y3 Final point in the y axis for the curve
10197 * @return void
10198 * @since PECL cairo >= 0.1.0
10199 **/
10200function cairo_curve_to($context, $x1, $y1, $x2, $y2, $x3, $y3){}
10201
10202/**
10203 * Transform a coordinate from device space to user space by multiplying
10204 * the given point by the inverse of the current transformation matrix
10205 * (CTM).
10206 *
10207 * @param CairoContext $context A valid CairoContext object created
10208 *   with CairoContext::__construct or {@link cairo_create}
10209 * @param float $x x value of the coordinate
10210 * @param float $y y value of the coordinate
10211 * @return array
10212 * @since PECL cairo >= 0.1.0
10213 **/
10214function cairo_device_to_user($context, $x, $y){}
10215
10216/**
10217 * Transform a distance vector from device space to user space. This
10218 * function is similar to CairoContext::deviceToUser or {@link
10219 * cairo_device_to_user} except that the translation components of the
10220 * inverse Cairo Transformation Matrix will be ignored when transforming
10221 * ({@link x},{@link y}).
10222 *
10223 * @param CairoContext $context A valid CairoContext object created
10224 *   with CairoContext::__construct or {@link cairo_create}
10225 * @param float $x X component of a distance vector
10226 * @param float $y Y component of a distance vector
10227 * @return array
10228 * @since PECL cairo >= 0.1.0
10229 **/
10230function cairo_device_to_user_distance($context, $x, $y){}
10231
10232/**
10233 * A drawing operator that fills the current path according to the
10234 * current CairoFillRule, (each sub-path is implicitly closed before
10235 * being filled). After CairoContext::fill or {@link cairo_fill}, the
10236 * current path will be cleared from the CairoContext.
10237 *
10238 * @param CairoContext $context A valid CairoContext object created
10239 *   with CairoContext::__construct or {@link cairo_create}
10240 * @return void
10241 * @since PECL cairo >= 0.1.0
10242 **/
10243function cairo_fill($context){}
10244
10245/**
10246 * Computes a bounding box in user coordinates covering the area that
10247 * would be affected, (the “inked” area), by a CairoContext::fill
10248 * operation given the current path and fill parameters. If the current
10249 * path is empty, returns an empty rectangle (0,0,0,0). Surface
10250 * dimensions and clipping are not taken into account.
10251 *
10252 * Contrast with CairoContext::pathExtents, which is similar, but returns
10253 * non-zero extents for some paths with no inked area, (such as a simple
10254 * line segment).
10255 *
10256 * Note that CairoContext::fillExtents must necessarily do more work to
10257 * compute the precise inked areas in light of the fill rule, so
10258 * CairoContext::pathExtents may be more desirable for sake of
10259 * performance if the non-inked path extents are desired.
10260 *
10261 * @param CairoContext $context A valid CairoContext object created
10262 *   with CairoContext::__construct or {@link cairo_create}
10263 * @return array
10264 * @since PECL cairo >= 0.1.0
10265 **/
10266function cairo_fill_extents($context){}
10267
10268/**
10269 * A drawing operator that fills the current path according to the
10270 * current CairoFillRule, (each sub-path is implicitly closed before
10271 * being filled). Unlike CairoContext::fill, CairoContext::fillPreserve
10272 * (Procedural {@link cairo_fill}, {@link cairo_fill_preserve},
10273 * respectively) preserves the path within the Context.
10274 *
10275 * @param CairoContext $context A valid CairoContext object created
10276 *   with CairoContext::__construct or {@link cairo_create}
10277 * @return void
10278 * @since PECL cairo >= 0.1.0
10279 **/
10280function cairo_fill_preserve($context){}
10281
10282/**
10283 * Gets the font extents for the currently selected font.
10284 *
10285 * @param CairoContext $context Description...
10286 * @return array
10287 * @since PECL cairo >= 0.1.0
10288 **/
10289function cairo_font_extents($context){}
10290
10291/**
10292 * The function description goes here.
10293 *
10294 * @param CairoFontFace $fontface Description...
10295 * @return int
10296 * @since PECL cairo >= 0.1.0
10297 **/
10298function cairo_font_face_get_type($fontface){}
10299
10300/**
10301 * The function description goes here.
10302 *
10303 * @param CairoFontFace $fontface Description...
10304 * @return int
10305 * @since PECL cairo >= 0.1.0
10306 **/
10307function cairo_font_face_status($fontface){}
10308
10309/**
10310 * The function description goes here.
10311 *
10312 * @return CairoFontOptions
10313 * @since PECL cairo >= 0.1.0
10314 **/
10315function cairo_font_options_create(){}
10316
10317/**
10318 * The function description goes here.
10319 *
10320 * @param CairoFontOptions $options Description...
10321 * @param CairoFontOptions $other Description...
10322 * @return bool
10323 * @since PECL cairo >= 0.1.0
10324 **/
10325function cairo_font_options_equal($options, $other){}
10326
10327/**
10328 * The function description goes here.
10329 *
10330 * @param CairoFontOptions $options Description...
10331 * @return int
10332 * @since PECL cairo >= 0.1.0
10333 **/
10334function cairo_font_options_get_antialias($options){}
10335
10336/**
10337 * The function description goes here.
10338 *
10339 * @param CairoFontOptions $options Description...
10340 * @return int
10341 * @since PECL cairo >= 0.1.0
10342 **/
10343function cairo_font_options_get_hint_metrics($options){}
10344
10345/**
10346 * The function description goes here.
10347 *
10348 * @param CairoFontOptions $options Description...
10349 * @return int
10350 * @since PECL cairo >= 0.1.0
10351 **/
10352function cairo_font_options_get_hint_style($options){}
10353
10354/**
10355 * The function description goes here.
10356 *
10357 * @param CairoFontOptions $options Description...
10358 * @return int
10359 * @since PECL cairo >= 0.1.0
10360 **/
10361function cairo_font_options_get_subpixel_order($options){}
10362
10363/**
10364 * The function description goes here.
10365 *
10366 * @param CairoFontOptions $options Description...
10367 * @return int
10368 * @since PECL cairo >= 0.1.0
10369 **/
10370function cairo_font_options_hash($options){}
10371
10372/**
10373 * The function description goes here.
10374 *
10375 * @param CairoFontOptions $options Description...
10376 * @param CairoFontOptions $other Description...
10377 * @return void
10378 * @since PECL cairo >= 0.1.0
10379 **/
10380function cairo_font_options_merge($options, $other){}
10381
10382/**
10383 * The function description goes here.
10384 *
10385 * @param CairoFontOptions $options Description...
10386 * @param string $antialias Description...
10387 * @return void
10388 * @since PECL cairo >= 0.1.0
10389 **/
10390function cairo_font_options_set_antialias($options, $antialias){}
10391
10392/**
10393 * The function description goes here.
10394 *
10395 * @param CairoFontOptions $options Description...
10396 * @param string $hint_metrics Description...
10397 * @return void
10398 * @since PECL cairo >= 0.1.0
10399 **/
10400function cairo_font_options_set_hint_metrics($options, $hint_metrics){}
10401
10402/**
10403 * The function description goes here.
10404 *
10405 * @param CairoFontOptions $options Description...
10406 * @param string $hint_style Description...
10407 * @return void
10408 * @since PECL cairo >= 0.1.0
10409 **/
10410function cairo_font_options_set_hint_style($options, $hint_style){}
10411
10412/**
10413 * The function description goes here.
10414 *
10415 * @param CairoFontOptions $options Description...
10416 * @param string $subpixel_order Description...
10417 * @return void
10418 * @since PECL cairo >= 0.1.0
10419 **/
10420function cairo_font_options_set_subpixel_order($options, $subpixel_order){}
10421
10422/**
10423 * The function description goes here.
10424 *
10425 * @param CairoFontOptions $options Description...
10426 * @return int
10427 * @since PECL cairo >= 0.1.0
10428 **/
10429function cairo_font_options_status($options){}
10430
10431/**
10432 * The function description goes here.
10433 *
10434 * @param int $format Description...
10435 * @param int $width Description...
10436 * @return int
10437 * @since PECL cairo >= 0.1.0
10438 **/
10439function cairo_format_stride_for_width($format, $width){}
10440
10441/**
10442 * Description here.
10443 *
10444 * @param CairoContext $context Description...
10445 * @return int
10446 * @since PECL cairo >= 0.1.0
10447 **/
10448function cairo_get_antialias($context){}
10449
10450/**
10451 * Gets the current point of the current path, which is conceptually the
10452 * final point reached by the path so far.
10453 *
10454 * The current point is returned in the user-space coordinate system. If
10455 * there is no defined current point or if cr is in an error status, x
10456 * and y will both be set to 0.0. It is possible to check this in advance
10457 * with CairoContext::hasCurrentPoint.
10458 *
10459 * Most path construction functions alter the current point. See the
10460 * following for details on how they affect the current point:
10461 * CairoContext::newPath, CairoContext::newSubPath,
10462 * CairoContext::appendPath, CairoContext::closePath,
10463 * CairoContext::moveTo, CairoContext::lineTo, CairoContext::curveTo,
10464 * CairoContext::relMoveTo, CairoContext::relLineTo,
10465 * CairoContext::relCurveTo, CairoContext::arc,
10466 * CairoContext::arcNegative, CairoContext::rectangle,
10467 * CairoContext::textPath, CairoContext::glyphPath.
10468 *
10469 * Some functions use and alter the current point but do not otherwise
10470 * change current path: CairoContext::showText.
10471 *
10472 * Some functions unset the current path and as a result, current point:
10473 * CairoContext::fill, CairoContext::stroke.
10474 *
10475 * @param CairoContext $context A valid CairoContext object.
10476 * @return array
10477 * @since PECL cairo >= 0.1.0
10478 **/
10479function cairo_get_current_point($context){}
10480
10481/**
10482 * Description here.
10483 *
10484 * @param CairoContext $context Description...
10485 * @return array
10486 * @since PECL cairo >= 0.1.0
10487 **/
10488function cairo_get_dash($context){}
10489
10490/**
10491 * Description here.
10492 *
10493 * @param CairoContext $context Description...
10494 * @return int
10495 * @since PECL cairo >= 0.1.0
10496 **/
10497function cairo_get_dash_count($context){}
10498
10499/**
10500 * Description here.
10501 *
10502 * @param CairoContext $context Description...
10503 * @return int
10504 * @since PECL cairo >= 0.1.0
10505 **/
10506function cairo_get_fill_rule($context){}
10507
10508/**
10509 * Description here.
10510 *
10511 * @param CairoContext $context Description...
10512 * @return void
10513 * @since PECL cairo >= 0.1.0
10514 **/
10515function cairo_get_font_face($context){}
10516
10517/**
10518 * Description here.
10519 *
10520 * @param CairoContext $context Description...
10521 * @return void
10522 * @since PECL cairo >= 0.1.0
10523 **/
10524function cairo_get_font_matrix($context){}
10525
10526/**
10527 * Description here.
10528 *
10529 * @param CairoContext $context Description...
10530 * @return void
10531 * @since PECL cairo >= 0.1.0
10532 **/
10533function cairo_get_font_options($context){}
10534
10535/**
10536 * Description here.
10537 *
10538 * @param CairoContext $context Description...
10539 * @return void
10540 * @since PECL cairo >= 0.1.0
10541 **/
10542function cairo_get_group_target($context){}
10543
10544/**
10545 * Description here.
10546 *
10547 * @param CairoContext $context Description...
10548 * @return int
10549 * @since PECL cairo >= 0.1.0
10550 **/
10551function cairo_get_line_cap($context){}
10552
10553/**
10554 * Description here.
10555 *
10556 * @param CairoContext $context Description...
10557 * @return int
10558 * @since PECL cairo >= 0.1.0
10559 **/
10560function cairo_get_line_join($context){}
10561
10562/**
10563 * Description here.
10564 *
10565 * @param CairoContext $context Description...
10566 * @return float
10567 * @since PECL cairo >= 0.1.0
10568 **/
10569function cairo_get_line_width($context){}
10570
10571/**
10572 * Description here.
10573 *
10574 * @param CairoContext $context Description...
10575 * @return void
10576 * @since PECL cairo >= 0.1.0
10577 **/
10578function cairo_get_matrix($context){}
10579
10580/**
10581 * Description here.
10582 *
10583 * @param CairoContext $context Description...
10584 * @return float
10585 * @since PECL cairo >= 0.1.0
10586 **/
10587function cairo_get_miter_limit($context){}
10588
10589/**
10590 * Description here.
10591 *
10592 * @param CairoContext $context Description...
10593 * @return int
10594 * @since PECL cairo >= 0.1.0
10595 **/
10596function cairo_get_operator($context){}
10597
10598/**
10599 * Description here.
10600 *
10601 * @param CairoContext $context Description...
10602 * @return void
10603 * @since PECL cairo >= 0.1.0
10604 **/
10605function cairo_get_scaled_font($context){}
10606
10607/**
10608 * Description here.
10609 *
10610 * @param CairoContext $context Description...
10611 * @return void
10612 * @since PECL cairo >= 0.1.0
10613 **/
10614function cairo_get_source($context){}
10615
10616/**
10617 * Description here.
10618 *
10619 * @param CairoContext $context Description...
10620 * @return void
10621 * @since PECL cairo >= 0.1.0
10622 **/
10623function cairo_get_target($context){}
10624
10625/**
10626 * Description here.
10627 *
10628 * @param CairoContext $context Description...
10629 * @return float
10630 * @since PECL cairo >= 0.1.0
10631 **/
10632function cairo_get_tolerance($context){}
10633
10634/**
10635 * Description here.
10636 *
10637 * @param CairoContext $context Description...
10638 * @param array $glyphs Description...
10639 * @return void
10640 * @since PECL cairo >= 0.1.0
10641 **/
10642function cairo_glyph_path($context, $glyphs){}
10643
10644/**
10645 * Returns whether a current point is defined on the current path. See
10646 * CairoContext::getCurrentPoint for details on the current point.
10647 *
10648 * @param CairoContext $context A valid CairoContext object.
10649 * @return bool
10650 * @since PECL cairo >= 0.1.0
10651 **/
10652function cairo_has_current_point($context){}
10653
10654/**
10655 * Description here.
10656 *
10657 * @param CairoContext $context Description...
10658 * @return void
10659 * @since PECL cairo >= 0.1.0
10660 **/
10661function cairo_identity_matrix($context){}
10662
10663/**
10664 * The function description goes here.
10665 *
10666 * @param int $format Description...
10667 * @param int $width Description...
10668 * @param int $height Description...
10669 * @return CairoImageSurface
10670 * @since PECL cairo >= 0.1.0
10671 **/
10672function cairo_image_surface_create($format, $width, $height){}
10673
10674/**
10675 * The function description goes here.
10676 *
10677 * @param string $data Description...
10678 * @param int $format Description...
10679 * @param int $width Description...
10680 * @param int $height Description...
10681 * @param int $stride Description...
10682 * @return CairoImageSurface
10683 * @since PECL cairo >= 0.1.0
10684 **/
10685function cairo_image_surface_create_for_data($data, $format, $width, $height, $stride){}
10686
10687/**
10688 * The function description goes here.
10689 *
10690 * @param string $file Description...
10691 * @return CairoImageSurface
10692 * @since PECL cairo >= 0.1.0
10693 **/
10694function cairo_image_surface_create_from_png($file){}
10695
10696/**
10697 * The function description goes here.
10698 *
10699 * @param CairoImageSurface $surface Description...
10700 * @return string
10701 * @since PECL cairo >= 0.1.0
10702 **/
10703function cairo_image_surface_get_data($surface){}
10704
10705/**
10706 * The function description goes here.
10707 *
10708 * @param CairoImageSurface $surface Description...
10709 * @return int
10710 * @since PECL cairo >= 0.1.0
10711 **/
10712function cairo_image_surface_get_format($surface){}
10713
10714/**
10715 * The function description goes here.
10716 *
10717 * @param CairoImageSurface $surface Description...
10718 * @return int
10719 * @since PECL cairo >= 0.1.0
10720 **/
10721function cairo_image_surface_get_height($surface){}
10722
10723/**
10724 * The function description goes here.
10725 *
10726 * @param CairoImageSurface $surface Description...
10727 * @return int
10728 * @since PECL cairo >= 0.1.0
10729 **/
10730function cairo_image_surface_get_stride($surface){}
10731
10732/**
10733 * The function description goes here.
10734 *
10735 * @param CairoImageSurface $surface Description...
10736 * @return int
10737 * @since PECL cairo >= 0.1.0
10738 **/
10739function cairo_image_surface_get_width($surface){}
10740
10741/**
10742 * Description here.
10743 *
10744 * @param CairoContext $context Description...
10745 * @param string $x Description...
10746 * @param string $y Description...
10747 * @return bool
10748 * @since PECL cairo >= 0.1.0
10749 **/
10750function cairo_in_fill($context, $x, $y){}
10751
10752/**
10753 * Description here.
10754 *
10755 * @param CairoContext $context Description...
10756 * @param string $x Description...
10757 * @param string $y Description...
10758 * @return bool
10759 * @since PECL cairo >= 0.1.0
10760 **/
10761function cairo_in_stroke($context, $x, $y){}
10762
10763/**
10764 * Description here.
10765 *
10766 * @param CairoContext $context Description...
10767 * @param string $x Description...
10768 * @param string $y Description...
10769 * @return void
10770 * @since PECL cairo >= 0.1.0
10771 **/
10772function cairo_line_to($context, $x, $y){}
10773
10774/**
10775 * Description here.
10776 *
10777 * @param CairoContext $context Description...
10778 * @param CairoPattern $pattern Description...
10779 * @return void
10780 * @since PECL cairo >= 0.1.0
10781 **/
10782function cairo_mask($context, $pattern){}
10783
10784/**
10785 * Description here.
10786 *
10787 * @param CairoContext $context Description...
10788 * @param CairoSurface $surface Description...
10789 * @param string $x Description...
10790 * @param string $y Description...
10791 * @return void
10792 * @since PECL cairo >= 0.1.0
10793 **/
10794function cairo_mask_surface($context, $surface, $x, $y){}
10795
10796/**
10797 * Returns new CairoMatrix object. Matrices are used throughout cairo to
10798 * convert between different coordinate spaces. Sets matrix to be the
10799 * affine transformation given by xx, yx, xy, yy, x0, y0. The
10800 * transformation is given by: x_new = xx * x + xy * y + x0; and y_new =
10801 * yx * x + yy * y + y0;
10802 *
10803 * @param float $xx xx component of the affine transformation
10804 * @param float $yx yx component of the affine transformation
10805 * @param float $xy xy component of the affine transformation
10806 * @param float $yy yy component of the affine transformation
10807 * @param float $x0 X translation component of the affine
10808 *   transformation
10809 * @param float $y0 Y translation component of the affine
10810 *   transformation
10811 * @return object
10812 **/
10813function cairo_matrix_init($xx, $yx, $xy, $yy, $x0, $y0){}
10814
10815/**
10816 * Creates a new matrix that is an identity transformation. An identity
10817 * transformation means the source data is copied into the destination
10818 * data without change
10819 *
10820 * @return object
10821 **/
10822function cairo_matrix_init_identity(){}
10823
10824/**
10825 * Creats a new matrix to a transformation that rotates by radians
10826 * provided
10827 *
10828 * @param float $radians angle of rotation, in radians. The direction
10829 *   of rotation is defined such that positive angles rotate in the
10830 *   direction from the positive X axis toward the positive Y axis. With
10831 *   the default axis orientation of cairo, positive angles rotate in a
10832 *   clockwise direction.
10833 * @return object
10834 **/
10835function cairo_matrix_init_rotate($radians){}
10836
10837/**
10838 * Creates a new matrix to a transformation that scales by sx and sy in
10839 * the X and Y dimensions, respectively.
10840 *
10841 * @param float $sx scale factor in the X direction
10842 * @param float $sy scale factor in the Y direction
10843 * @return object
10844 **/
10845function cairo_matrix_init_scale($sx, $sy){}
10846
10847/**
10848 * Creates a new matrix to a transformation that translates by tx and ty
10849 * in the X and Y dimensions, respectively.
10850 *
10851 * @param float $tx amount to translate in the X direction
10852 * @param float $ty amount to translate in the Y direction
10853 * @return object
10854 **/
10855function cairo_matrix_init_translate($tx, $ty){}
10856
10857/**
10858 * The function description goes here.
10859 *
10860 * @param CairoMatrix $matrix Description...
10861 * @return void
10862 * @since PECL cairo >= 0.1.0
10863 **/
10864function cairo_matrix_invert($matrix){}
10865
10866/**
10867 * The function description goes here.
10868 *
10869 * @param CairoMatrix $matrix1 Description...
10870 * @param CairoMatrix $matrix2 Description...
10871 * @return CairoMatrix
10872 * @since PECL cairo >= 0.1.0
10873 **/
10874function cairo_matrix_multiply($matrix1, $matrix2){}
10875
10876/**
10877 * The function description goes here.
10878 *
10879 * @param CairoMatrix $matrix Description...
10880 * @param string $radians Description...
10881 * @return void
10882 * @since PECL cairo >= 0.1.0
10883 **/
10884function cairo_matrix_rotate($matrix, $radians){}
10885
10886/**
10887 * Applies scaling by sx, sy to the transformation in the matrix. The
10888 * effect of the new transformation is to first scale the coordinates by
10889 * sx and sy, then apply the original transformation to the coordinates.
10890 *
10891 * @param CairoContext $context Procedural only - CairoMatrix instance
10892 * @param float $sx scale factor in the X direction
10893 * @param float $sy scale factor in the Y direction
10894 * @return void
10895 * @since PECL cairo >= 0.1.0
10896 **/
10897function cairo_matrix_scale($context, $sx, $sy){}
10898
10899/**
10900 * The function description goes here.
10901 *
10902 * @param CairoMatrix $matrix Description...
10903 * @param string $dx Description...
10904 * @param string $dy Description...
10905 * @return array
10906 * @since PECL cairo >= 0.1.0
10907 **/
10908function cairo_matrix_transform_distance($matrix, $dx, $dy){}
10909
10910/**
10911 * The function description goes here.
10912 *
10913 * @param CairoMatrix $matrix Description...
10914 * @param string $dx Description...
10915 * @param string $dy Description...
10916 * @return array
10917 * @since PECL cairo >= 0.1.0
10918 **/
10919function cairo_matrix_transform_point($matrix, $dx, $dy){}
10920
10921/**
10922 * The function description goes here.
10923 *
10924 * @param CairoMatrix $matrix Description...
10925 * @param string $tx Description...
10926 * @param string $ty Description...
10927 * @return void
10928 * @since PECL cairo >= 0.1.0
10929 **/
10930function cairo_matrix_translate($matrix, $tx, $ty){}
10931
10932/**
10933 * Begin a new sub-path. After this call the current point will be (x,
10934 * y).
10935 *
10936 * @param CairoContext $context A valid CairoContext object.
10937 * @param string $x The x coordinate of the new position.
10938 * @param string $y The y coordinate of the new position
10939 * @return void
10940 * @since PECL cairo >= 0.1.0
10941 **/
10942function cairo_move_to($context, $x, $y){}
10943
10944/**
10945 * Clears the current path. After this call there will be no path and no
10946 * current point.
10947 *
10948 * @param CairoContext $context A valid CairoContext object.
10949 * @return void
10950 * @since PECL cairo >= 0.1.0
10951 **/
10952function cairo_new_path($context){}
10953
10954/**
10955 * Description here.
10956 *
10957 * @param CairoContext $context Description...
10958 * @return void
10959 * @since PECL cairo >= 0.1.0
10960 **/
10961function cairo_new_sub_path($context){}
10962
10963/**
10964 * Description here.
10965 *
10966 * @param CairoContext $context Description...
10967 * @return void
10968 * @since PECL cairo >= 0.1.0
10969 **/
10970function cairo_paint($context){}
10971
10972/**
10973 * Description here.
10974 *
10975 * @param CairoContext $context Description...
10976 * @param string $alpha Description...
10977 * @return void
10978 * @since PECL cairo >= 0.1.0
10979 **/
10980function cairo_paint_with_alpha($context, $alpha){}
10981
10982/**
10983 * Description here.
10984 *
10985 * @param CairoContext $context Description...
10986 * @return array
10987 * @since PECL cairo >= 0.1.0
10988 **/
10989function cairo_path_extents($context){}
10990
10991/**
10992 * The function description goes here.
10993 *
10994 * @param CairoGradientPattern $pattern Description...
10995 * @param string $offset Description...
10996 * @param string $red Description...
10997 * @param string $green Description...
10998 * @param string $blue Description...
10999 * @return void
11000 * @since PECL cairo >= 0.1.0
11001 **/
11002function cairo_pattern_add_color_stop_rgb($pattern, $offset, $red, $green, $blue){}
11003
11004/**
11005 * The function description goes here.
11006 *
11007 * @param CairoGradientPattern $pattern Description...
11008 * @param string $offset Description...
11009 * @param string $red Description...
11010 * @param string $green Description...
11011 * @param string $blue Description...
11012 * @param string $alpha Description...
11013 * @return void
11014 * @since PECL cairo >= 0.1.0
11015 **/
11016function cairo_pattern_add_color_stop_rgba($pattern, $offset, $red, $green, $blue, $alpha){}
11017
11018/**
11019 * The function description goes here.
11020 *
11021 * @param CairoSurface $surface Description...
11022 * @return CairoPattern
11023 * @since PECL cairo >= 0.1.0
11024 **/
11025function cairo_pattern_create_for_surface($surface){}
11026
11027/**
11028 * The function description goes here.
11029 *
11030 * @param float $x0 Description...
11031 * @param float $y0 Description...
11032 * @param float $x1 Description...
11033 * @param float $y1 Description...
11034 * @return CairoPattern
11035 * @since PECL cairo >= 0.1.0
11036 **/
11037function cairo_pattern_create_linear($x0, $y0, $x1, $y1){}
11038
11039/**
11040 * The function description goes here.
11041 *
11042 * @param float $x0 Description...
11043 * @param float $y0 Description...
11044 * @param float $r0 Description...
11045 * @param float $x1 Description...
11046 * @param float $y1 Description...
11047 * @param float $r1 Description...
11048 * @return CairoPattern
11049 * @since PECL cairo >= 0.1.0
11050 **/
11051function cairo_pattern_create_radial($x0, $y0, $r0, $x1, $y1, $r1){}
11052
11053/**
11054 * The function description goes here.
11055 *
11056 * @param float $red Description...
11057 * @param float $green Description...
11058 * @param float $blue Description...
11059 * @return CairoPattern
11060 * @since PECL cairo >= 0.1.0
11061 **/
11062function cairo_pattern_create_rgb($red, $green, $blue){}
11063
11064/**
11065 * The function description goes here.
11066 *
11067 * @param float $red Description...
11068 * @param float $green Description...
11069 * @param float $blue Description...
11070 * @param float $alpha Description...
11071 * @return CairoPattern
11072 * @since PECL cairo >= 0.1.0
11073 **/
11074function cairo_pattern_create_rgba($red, $green, $blue, $alpha){}
11075
11076/**
11077 * The function description goes here.
11078 *
11079 * @param CairoGradientPattern $pattern Description...
11080 * @return int
11081 * @since PECL cairo >= 0.1.0
11082 **/
11083function cairo_pattern_get_color_stop_count($pattern){}
11084
11085/**
11086 * The function description goes here.
11087 *
11088 * @param CairoGradientPattern $pattern Description...
11089 * @param string $index Description...
11090 * @return array
11091 * @since PECL cairo >= 0.1.0
11092 **/
11093function cairo_pattern_get_color_stop_rgba($pattern, $index){}
11094
11095/**
11096 * The function description goes here.
11097 *
11098 * @param string $pattern Description...
11099 * @return int
11100 * @since PECL cairo >= 0.1.0
11101 **/
11102function cairo_pattern_get_extend($pattern){}
11103
11104/**
11105 * The function description goes here.
11106 *
11107 * @param CairoSurfacePattern $pattern Description...
11108 * @return int
11109 * @since PECL cairo >= 0.1.0
11110 **/
11111function cairo_pattern_get_filter($pattern){}
11112
11113/**
11114 * The function description goes here.
11115 *
11116 * @param CairoLinearGradient $pattern Description...
11117 * @return array
11118 * @since PECL cairo >= 0.1.0
11119 **/
11120function cairo_pattern_get_linear_points($pattern){}
11121
11122/**
11123 * The function description goes here.
11124 *
11125 * @param CairoPattern $pattern Description...
11126 * @return CairoMatrix
11127 * @since PECL cairo >= 0.1.0
11128 **/
11129function cairo_pattern_get_matrix($pattern){}
11130
11131/**
11132 * The function description goes here.
11133 *
11134 * @param CairoRadialGradient $pattern Description...
11135 * @return array
11136 * @since PECL cairo >= 0.1.0
11137 **/
11138function cairo_pattern_get_radial_circles($pattern){}
11139
11140/**
11141 * The function description goes here.
11142 *
11143 * @param CairoSolidPattern $pattern Description...
11144 * @return array
11145 * @since PECL cairo >= 0.1.0
11146 **/
11147function cairo_pattern_get_rgba($pattern){}
11148
11149/**
11150 * The function description goes here.
11151 *
11152 * @param CairoSurfacePattern $pattern Description...
11153 * @return CairoSurface
11154 * @since PECL cairo >= 0.1.0
11155 **/
11156function cairo_pattern_get_surface($pattern){}
11157
11158/**
11159 * The function description goes here.
11160 *
11161 * @param CairoPattern $pattern Description...
11162 * @return int
11163 * @since PECL cairo >= 0.1.0
11164 **/
11165function cairo_pattern_get_type($pattern){}
11166
11167/**
11168 * The function description goes here.
11169 *
11170 * @param string $pattern Description...
11171 * @param string $extend Description...
11172 * @return void
11173 * @since PECL cairo >= 0.1.0
11174 **/
11175function cairo_pattern_set_extend($pattern, $extend){}
11176
11177/**
11178 * The function description goes here.
11179 *
11180 * @param CairoSurfacePattern $pattern Description...
11181 * @param string $filter Description...
11182 * @return void
11183 * @since PECL cairo >= 0.1.0
11184 **/
11185function cairo_pattern_set_filter($pattern, $filter){}
11186
11187/**
11188 * The function description goes here.
11189 *
11190 * @param CairoPattern $pattern Description...
11191 * @param CairoMatrix $matrix Description...
11192 * @return void
11193 * @since PECL cairo >= 0.1.0
11194 **/
11195function cairo_pattern_set_matrix($pattern, $matrix){}
11196
11197/**
11198 * The function description goes here.
11199 *
11200 * @param CairoPattern $pattern Description...
11201 * @return int
11202 * @since PECL cairo >= 0.1.0
11203 **/
11204function cairo_pattern_status($pattern){}
11205
11206/**
11207 * The function description goes here.
11208 *
11209 * @param string $file Description...
11210 * @param float $width Description...
11211 * @param float $height Description...
11212 * @return CairoPdfSurface
11213 * @since PECL cairo >= 0.1.0
11214 **/
11215function cairo_pdf_surface_create($file, $width, $height){}
11216
11217/**
11218 * The function description goes here.
11219 *
11220 * @param CairoPdfSurface $surface Description...
11221 * @param string $width Description...
11222 * @param string $height Description...
11223 * @return void
11224 * @since PECL cairo >= 0.1.0
11225 **/
11226function cairo_pdf_surface_set_size($surface, $width, $height){}
11227
11228/**
11229 * Description here.
11230 *
11231 * @param CairoContext $context Description...
11232 * @return void
11233 * @since PECL cairo >= 0.1.0
11234 **/
11235function cairo_pop_group($context){}
11236
11237/**
11238 * Description here.
11239 *
11240 * @param CairoContext $context Description...
11241 * @return void
11242 * @since PECL cairo >= 0.1.0
11243 **/
11244function cairo_pop_group_to_source($context){}
11245
11246/**
11247 * The function description goes here.
11248 *
11249 * @return array
11250 * @since PECL cairo >= 0.1.0
11251 **/
11252function cairo_ps_get_levels(){}
11253
11254/**
11255 * The function description goes here.
11256 *
11257 * @param string $level Description...
11258 * @return string
11259 * @since PECL cairo >= 0.1.0
11260 **/
11261function cairo_ps_level_to_string($level){}
11262
11263/**
11264 * The function description goes here.
11265 *
11266 * @param string $file Description...
11267 * @param float $width Description...
11268 * @param float $height Description...
11269 * @return CairoPsSurface
11270 * @since PECL cairo >= 0.1.0
11271 **/
11272function cairo_ps_surface_create($file, $width, $height){}
11273
11274/**
11275 * The function description goes here.
11276 *
11277 * @param CairoPsSurface $surface Description...
11278 * @return void
11279 * @since PECL cairo >= 0.1.0
11280 **/
11281function cairo_ps_surface_dsc_begin_page_setup($surface){}
11282
11283/**
11284 * The function description goes here.
11285 *
11286 * @param CairoPsSurface $surface Description...
11287 * @return void
11288 * @since PECL cairo >= 0.1.0
11289 **/
11290function cairo_ps_surface_dsc_begin_setup($surface){}
11291
11292/**
11293 * The function description goes here.
11294 *
11295 * @param CairoPsSurface $surface Description...
11296 * @param string $comment Description...
11297 * @return void
11298 * @since PECL cairo >= 0.1.0
11299 **/
11300function cairo_ps_surface_dsc_comment($surface, $comment){}
11301
11302/**
11303 * The function description goes here.
11304 *
11305 * @param CairoPsSurface $surface Description...
11306 * @return bool
11307 * @since PECL cairo >= 0.1.0
11308 **/
11309function cairo_ps_surface_get_eps($surface){}
11310
11311/**
11312 * The function description goes here.
11313 *
11314 * @param CairoPsSurface $surface Description...
11315 * @param string $level Description...
11316 * @return void
11317 * @since PECL cairo >= 0.1.0
11318 **/
11319function cairo_ps_surface_restrict_to_level($surface, $level){}
11320
11321/**
11322 * The function description goes here.
11323 *
11324 * @param CairoPsSurface $surface Description...
11325 * @param string $level Description...
11326 * @return void
11327 * @since PECL cairo >= 0.1.0
11328 **/
11329function cairo_ps_surface_set_eps($surface, $level){}
11330
11331/**
11332 * The function description goes here.
11333 *
11334 * @param CairoPsSurface $surface Description...
11335 * @param string $width Description...
11336 * @param string $height Description...
11337 * @return void
11338 * @since PECL cairo >= 0.1.0
11339 **/
11340function cairo_ps_surface_set_size($surface, $width, $height){}
11341
11342/**
11343 * Description here.
11344 *
11345 * @param CairoContext $context Description...
11346 * @return void
11347 * @since PECL cairo >= 0.1.0
11348 **/
11349function cairo_push_group($context){}
11350
11351/**
11352 * Description here.
11353 *
11354 * @param CairoContext $context Description...
11355 * @param string $content Description...
11356 * @return void
11357 * @since PECL cairo >= 0.1.0
11358 **/
11359function cairo_push_group_with_content($context, $content){}
11360
11361/**
11362 * Description here.
11363 *
11364 * @param CairoContext $context Description...
11365 * @param string $x Description...
11366 * @param string $y Description...
11367 * @param string $width Description...
11368 * @param string $height Description...
11369 * @return void
11370 * @since PECL cairo >= 0.1.0
11371 **/
11372function cairo_rectangle($context, $x, $y, $width, $height){}
11373
11374/**
11375 * Description here.
11376 *
11377 * @param CairoContext $context Description...
11378 * @param string $x1 Description...
11379 * @param string $y1 Description...
11380 * @param string $x2 Description...
11381 * @param string $y2 Description...
11382 * @param string $x3 Description...
11383 * @param string $y3 Description...
11384 * @return void
11385 * @since PECL cairo >= 0.1.0
11386 **/
11387function cairo_rel_curve_to($context, $x1, $y1, $x2, $y2, $x3, $y3){}
11388
11389/**
11390 * Description here.
11391 *
11392 * @param CairoContext $context Description...
11393 * @param string $x Description...
11394 * @param string $y Description...
11395 * @return void
11396 * @since PECL cairo >= 0.1.0
11397 **/
11398function cairo_rel_line_to($context, $x, $y){}
11399
11400/**
11401 * Description here.
11402 *
11403 * @param CairoContext $context Description...
11404 * @param string $x Description...
11405 * @param string $y Description...
11406 * @return void
11407 * @since PECL cairo >= 0.1.0
11408 **/
11409function cairo_rel_move_to($context, $x, $y){}
11410
11411/**
11412 * Description here.
11413 *
11414 * @param CairoContext $context Description...
11415 * @return void
11416 * @since PECL cairo >= 0.1.0
11417 **/
11418function cairo_reset_clip($context){}
11419
11420/**
11421 * Description here.
11422 *
11423 * @param CairoContext $context Description...
11424 * @return void
11425 * @since PECL cairo >= 0.1.0
11426 **/
11427function cairo_restore($context){}
11428
11429/**
11430 * Description here.
11431 *
11432 * @param CairoContext $context Description...
11433 * @param string $angle Description...
11434 * @return void
11435 * @since PECL cairo >= 0.1.0
11436 **/
11437function cairo_rotate($context, $angle){}
11438
11439/**
11440 * Description here.
11441 *
11442 * @param CairoContext $context Description...
11443 * @return void
11444 * @since PECL cairo >= 0.1.0
11445 **/
11446function cairo_save($context){}
11447
11448/**
11449 * Description here.
11450 *
11451 * @param CairoContext $context Description...
11452 * @param string $x Description...
11453 * @param string $y Description...
11454 * @return void
11455 * @since PECL cairo >= 0.1.0
11456 **/
11457function cairo_scale($context, $x, $y){}
11458
11459/**
11460 * The function description goes here.
11461 *
11462 * @param CairoFontFace $fontface Description...
11463 * @param CairoMatrix $matrix Description...
11464 * @param CairoMatrix $ctm Description...
11465 * @param CairoFontOptions $fontoptions Description...
11466 * @return CairoScaledFont
11467 * @since PECL cairo >= 0.1.0
11468 **/
11469function cairo_scaled_font_create($fontface, $matrix, $ctm, $fontoptions){}
11470
11471/**
11472 * The function description goes here.
11473 *
11474 * @param CairoScaledFont $scaledfont Description...
11475 * @return array
11476 * @since PECL cairo >= 0.1.0
11477 **/
11478function cairo_scaled_font_extents($scaledfont){}
11479
11480/**
11481 * The function description goes here.
11482 *
11483 * @param CairoScaledFont $scaledfont Description...
11484 * @return CairoMatrix
11485 * @since PECL cairo >= 0.1.0
11486 **/
11487function cairo_scaled_font_get_ctm($scaledfont){}
11488
11489/**
11490 * The function description goes here.
11491 *
11492 * @param CairoScaledFont $scaledfont Description...
11493 * @return CairoFontFace
11494 * @since PECL cairo >= 0.1.0
11495 **/
11496function cairo_scaled_font_get_font_face($scaledfont){}
11497
11498/**
11499 * The function description goes here.
11500 *
11501 * @param CairoScaledFont $scaledfont Description...
11502 * @return CairoFontOptions
11503 * @since PECL cairo >= 0.1.0
11504 **/
11505function cairo_scaled_font_get_font_matrix($scaledfont){}
11506
11507/**
11508 * The function description goes here.
11509 *
11510 * @param CairoScaledFont $scaledfont Description...
11511 * @return CairoFontOptions
11512 * @since PECL cairo >= 0.1.0
11513 **/
11514function cairo_scaled_font_get_font_options($scaledfont){}
11515
11516/**
11517 * The function description goes here.
11518 *
11519 * @param CairoScaledFont $scaledfont Description...
11520 * @return CairoMatrix
11521 * @since PECL cairo >= 0.1.0
11522 **/
11523function cairo_scaled_font_get_scale_matrix($scaledfont){}
11524
11525/**
11526 * The function description goes here.
11527 *
11528 * @param CairoScaledFont $scaledfont Description...
11529 * @return int
11530 * @since PECL cairo >= 0.1.0
11531 **/
11532function cairo_scaled_font_get_type($scaledfont){}
11533
11534/**
11535 * The function description goes here.
11536 *
11537 * @param CairoScaledFont $scaledfont Description...
11538 * @param string $glyphs Description...
11539 * @return array
11540 * @since PECL cairo >= 0.1.0
11541 **/
11542function cairo_scaled_font_glyph_extents($scaledfont, $glyphs){}
11543
11544/**
11545 * The function description goes here.
11546 *
11547 * @param CairoScaledFont $scaledfont Description...
11548 * @return int
11549 * @since PECL cairo >= 0.1.0
11550 **/
11551function cairo_scaled_font_status($scaledfont){}
11552
11553/**
11554 * The function description goes here.
11555 *
11556 * @param CairoScaledFont $scaledfont Description...
11557 * @param string $text Description...
11558 * @return array
11559 * @since PECL cairo >= 0.1.0
11560 **/
11561function cairo_scaled_font_text_extents($scaledfont, $text){}
11562
11563/**
11564 * Description here.
11565 *
11566 * @param CairoContext $context Description...
11567 * @param string $family Description...
11568 * @param string $slant Description...
11569 * @param string $weight Description...
11570 * @return void
11571 * @since PECL cairo >= 0.1.0
11572 **/
11573function cairo_select_font_face($context, $family, $slant, $weight){}
11574
11575/**
11576 * Description here.
11577 *
11578 * @param CairoContext $context Description...
11579 * @param string $antialias Description...
11580 * @return void
11581 * @since PECL cairo >= 0.1.0
11582 **/
11583function cairo_set_antialias($context, $antialias){}
11584
11585/**
11586 * Description here.
11587 *
11588 * @param CairoContext $context Description...
11589 * @param array $dashes Description...
11590 * @param string $offset Description...
11591 * @return void
11592 * @since PECL cairo >= 0.1.0
11593 **/
11594function cairo_set_dash($context, $dashes, $offset){}
11595
11596/**
11597 * Description here.
11598 *
11599 * @param CairoContext $context Description...
11600 * @param string $setting Description...
11601 * @return void
11602 * @since PECL cairo >= 0.1.0
11603 **/
11604function cairo_set_fill_rule($context, $setting){}
11605
11606/**
11607 * Sets the font-face for a given context.
11608 *
11609 * @param CairoContext $context A CairoContext object to change the
11610 *   font-face for.
11611 * @param CairoFontFace $fontface A CairoFontFace object
11612 * @return void
11613 * @since PECL cairo >= 0.1.0
11614 **/
11615function cairo_set_font_face($context, $fontface){}
11616
11617/**
11618 * Description here.
11619 *
11620 * @param CairoContext $context Description...
11621 * @param CairoMatrix $matrix Description...
11622 * @return void
11623 * @since PECL cairo >= 0.1.0
11624 **/
11625function cairo_set_font_matrix($context, $matrix){}
11626
11627/**
11628 * Description here.
11629 *
11630 * @param CairoContext $context Description...
11631 * @param CairoFontOptions $fontoptions Description...
11632 * @return void
11633 * @since PECL cairo >= 0.1.0
11634 **/
11635function cairo_set_font_options($context, $fontoptions){}
11636
11637/**
11638 * Description here.
11639 *
11640 * @param CairoContext $context Description...
11641 * @param string $size Description...
11642 * @return void
11643 * @since PECL cairo >= 0.1.0
11644 **/
11645function cairo_set_font_size($context, $size){}
11646
11647/**
11648 * Description here.
11649 *
11650 * @param CairoContext $context Description...
11651 * @param string $setting Description...
11652 * @return void
11653 * @since PECL cairo >= 0.1.0
11654 **/
11655function cairo_set_line_cap($context, $setting){}
11656
11657/**
11658 * Description here.
11659 *
11660 * @param CairoContext $context Description...
11661 * @param string $setting Description...
11662 * @return void
11663 * @since PECL cairo >= 0.1.0
11664 **/
11665function cairo_set_line_join($context, $setting){}
11666
11667/**
11668 * Description here.
11669 *
11670 * @param CairoContext $context Description...
11671 * @param string $width Description...
11672 * @return void
11673 * @since PECL cairo >= 0.1.0
11674 **/
11675function cairo_set_line_width($context, $width){}
11676
11677/**
11678 * Description here.
11679 *
11680 * @param CairoContext $context Description...
11681 * @param CairoMatrix $matrix Description...
11682 * @return void
11683 * @since PECL cairo >= 0.1.0
11684 **/
11685function cairo_set_matrix($context, $matrix){}
11686
11687/**
11688 * Description here.
11689 *
11690 * @param CairoContext $context Description...
11691 * @param string $limit Description...
11692 * @return void
11693 * @since PECL cairo >= 0.1.0
11694 **/
11695function cairo_set_miter_limit($context, $limit){}
11696
11697/**
11698 * Description here.
11699 *
11700 * @param CairoContext $context Description...
11701 * @param string $setting Description...
11702 * @return void
11703 * @since PECL cairo >= 0.1.0
11704 **/
11705function cairo_set_operator($context, $setting){}
11706
11707/**
11708 * Description here.
11709 *
11710 * @param CairoContext $context Description...
11711 * @param CairoScaledFont $scaledfont Description...
11712 * @return void
11713 * @since PECL cairo >= 0.1.0
11714 **/
11715function cairo_set_scaled_font($context, $scaledfont){}
11716
11717/**
11718 * Description here.
11719 *
11720 * @param CairoContext $context Description...
11721 * @param CairoPattern $pattern Description...
11722 * @return void
11723 * @since PECL cairo >= 0.1.0
11724 **/
11725function cairo_set_source($context, $pattern){}
11726
11727/**
11728 * Description here.
11729 *
11730 * @param CairoContext $context Description...
11731 * @param CairoSurface $surface Description...
11732 * @param string $x Description...
11733 * @param string $y Description...
11734 * @return void
11735 * @since PECL cairo >= 0.1.0
11736 **/
11737function cairo_set_source_surface($context, $surface, $x, $y){}
11738
11739/**
11740 * Description here.
11741 *
11742 * @param CairoContext $context Description...
11743 * @param string $tolerance Description...
11744 * @return void
11745 * @since PECL cairo >= 0.1.0
11746 **/
11747function cairo_set_tolerance($context, $tolerance){}
11748
11749/**
11750 * Description here.
11751 *
11752 * @param CairoContext $context Description...
11753 * @return void
11754 * @since PECL cairo >= 0.1.0
11755 **/
11756function cairo_show_page($context){}
11757
11758/**
11759 * Description here.
11760 *
11761 * @param CairoContext $context Description...
11762 * @param string $text Description...
11763 * @return void
11764 * @since PECL cairo >= 0.1.0
11765 **/
11766function cairo_show_text($context, $text){}
11767
11768/**
11769 * Description here.
11770 *
11771 * @param CairoContext $context Description...
11772 * @return int
11773 * @since PECL cairo >= 0.1.0
11774 **/
11775function cairo_status($context){}
11776
11777/**
11778 * Retrieves the current status as a readable string
11779 *
11780 * @param int $status A valid status code given by {@link cairo_status}
11781 *   or CairoContext::status
11782 * @return string
11783 **/
11784function cairo_status_to_string($status){}
11785
11786/**
11787 * Description here.
11788 *
11789 * @param CairoContext $context Description...
11790 * @return void
11791 * @since PECL cairo >= 0.1.0
11792 **/
11793function cairo_stroke($context){}
11794
11795/**
11796 * Description here.
11797 *
11798 * @param CairoContext $context Description...
11799 * @return array
11800 * @since PECL cairo >= 0.1.0
11801 **/
11802function cairo_stroke_extents($context){}
11803
11804/**
11805 * Description here.
11806 *
11807 * @param CairoContext $context Description...
11808 * @return void
11809 * @since PECL cairo >= 0.1.0
11810 **/
11811function cairo_stroke_preserve($context){}
11812
11813/**
11814 * The function description goes here.
11815 *
11816 * @param CairoSurface $surface Description...
11817 * @return void
11818 * @since PECL cairo >= 0.1.0
11819 **/
11820function cairo_surface_copy_page($surface){}
11821
11822/**
11823 * The function description goes here.
11824 *
11825 * @param CairoSurface $surface Description...
11826 * @param string $content Description...
11827 * @param string $width Description...
11828 * @param string $height Description...
11829 * @return CairoSurface
11830 * @since PECL cairo >= 0.1.0
11831 **/
11832function cairo_surface_create_similar($surface, $content, $width, $height){}
11833
11834/**
11835 * The function description goes here.
11836 *
11837 * @param CairoSurface $surface Description...
11838 * @return void
11839 * @since PECL cairo >= 0.1.0
11840 **/
11841function cairo_surface_finish($surface){}
11842
11843/**
11844 * The function description goes here.
11845 *
11846 * @param CairoSurface $surface Description...
11847 * @return void
11848 * @since PECL cairo >= 0.1.0
11849 **/
11850function cairo_surface_flush($surface){}
11851
11852/**
11853 * The function description goes here.
11854 *
11855 * @param CairoSurface $surface Description...
11856 * @return int
11857 * @since PECL cairo >= 0.1.0
11858 **/
11859function cairo_surface_get_content($surface){}
11860
11861/**
11862 * The function description goes here.
11863 *
11864 * @param CairoSurface $surface Description...
11865 * @return array
11866 * @since PECL cairo >= 0.1.0
11867 **/
11868function cairo_surface_get_device_offset($surface){}
11869
11870/**
11871 * The function description goes here.
11872 *
11873 * @param CairoSurface $surface Description...
11874 * @return CairoFontOptions
11875 * @since PECL cairo >= 0.1.0
11876 **/
11877function cairo_surface_get_font_options($surface){}
11878
11879/**
11880 * The function description goes here.
11881 *
11882 * @param CairoSurface $surface Description...
11883 * @return int
11884 * @since PECL cairo >= 0.1.0
11885 **/
11886function cairo_surface_get_type($surface){}
11887
11888/**
11889 * The function description goes here.
11890 *
11891 * @param CairoSurface $surface Description...
11892 * @return void
11893 * @since PECL cairo >= 0.1.0
11894 **/
11895function cairo_surface_mark_dirty($surface){}
11896
11897/**
11898 * The function description goes here.
11899 *
11900 * @param CairoSurface $surface Description...
11901 * @param string $x Description...
11902 * @param string $y Description...
11903 * @param string $width Description...
11904 * @param string $height Description...
11905 * @return void
11906 * @since PECL cairo >= 0.1.0
11907 **/
11908function cairo_surface_mark_dirty_rectangle($surface, $x, $y, $width, $height){}
11909
11910/**
11911 * The function description goes here.
11912 *
11913 * @param CairoSurface $surface Description...
11914 * @param string $x Description...
11915 * @param string $y Description...
11916 * @return void
11917 * @since PECL cairo >= 0.1.0
11918 **/
11919function cairo_surface_set_device_offset($surface, $x, $y){}
11920
11921/**
11922 * The function description goes here.
11923 *
11924 * @param CairoSurface $surface Description...
11925 * @param string $x Description...
11926 * @param string $y Description...
11927 * @return void
11928 * @since PECL cairo >= 0.1.0
11929 **/
11930function cairo_surface_set_fallback_resolution($surface, $x, $y){}
11931
11932/**
11933 * The function description goes here.
11934 *
11935 * @param CairoSurface $surface Description...
11936 * @return void
11937 * @since PECL cairo >= 0.1.0
11938 **/
11939function cairo_surface_show_page($surface){}
11940
11941/**
11942 * The function description goes here.
11943 *
11944 * @param CairoSurface $surface Description...
11945 * @return int
11946 * @since PECL cairo >= 0.1.0
11947 **/
11948function cairo_surface_status($surface){}
11949
11950/**
11951 * The function description goes here.
11952 *
11953 * @param CairoSurface $surface Description...
11954 * @param string $x Description...
11955 * @param string $y Description...
11956 * @return void
11957 * @since PECL cairo >= 0.1.0
11958 **/
11959function cairo_surface_write_to_png($surface, $x, $y){}
11960
11961/**
11962 * Returns a numerically indexed array of currently available
11963 * CairoSvgVersion constants. In order to retreive the string values for
11964 * each item, use CairoSvgSurface::versionToString.
11965 *
11966 * @return array
11967 * @since PECL cairo >= 0.1.0
11968 **/
11969function cairo_svg_get_versions(){}
11970
11971/**
11972 * The function description goes here.
11973 *
11974 * @param string $file Description...
11975 * @param float $width Description...
11976 * @param float $height Description...
11977 * @return CairoSvgSurface
11978 * @since PECL cairo >= 0.1.0
11979 **/
11980function cairo_svg_surface_create($file, $width, $height){}
11981
11982/**
11983 * The function description goes here.
11984 *
11985 * @param CairoSvgSurface $surface Description...
11986 * @param string $version Description...
11987 * @return void
11988 * @since PECL cairo >= 0.1.0
11989 **/
11990function cairo_svg_surface_restrict_to_version($surface, $version){}
11991
11992/**
11993 * The function description goes here.
11994 *
11995 * @param int $version Description...
11996 * @return string
11997 * @since PECL cairo >= 0.1.0
11998 **/
11999function cairo_svg_version_to_string($version){}
12000
12001/**
12002 * Description here.
12003 *
12004 * @param CairoContext $context Description...
12005 * @return array
12006 * @since PECL cairo >= 0.1.0
12007 **/
12008function cairo_text_extents($context){}
12009
12010/**
12011 * Description here.
12012 *
12013 * @param CairoContext $context Description...
12014 * @param string $text Description...
12015 * @return void
12016 * @since PECL cairo >= 0.1.0
12017 **/
12018function cairo_text_path($context, $text){}
12019
12020/**
12021 * Description here.
12022 *
12023 * @param CairoContext $context Description...
12024 * @param CairoMatrix $matrix Description...
12025 * @return void
12026 * @since PECL cairo >= 0.1.0
12027 **/
12028function cairo_transform($context, $matrix){}
12029
12030/**
12031 * Description here.
12032 *
12033 * @param CairoContext $context Description...
12034 * @param string $x Description...
12035 * @param string $y Description...
12036 * @return void
12037 * @since PECL cairo >= 0.1.0
12038 **/
12039function cairo_translate($context, $x, $y){}
12040
12041/**
12042 * Description here.
12043 *
12044 * @param CairoContext $context Description...
12045 * @param string $x Description...
12046 * @param string $y Description...
12047 * @return array
12048 * @since PECL cairo >= 0.1.0
12049 **/
12050function cairo_user_to_device($context, $x, $y){}
12051
12052/**
12053 * Description here.
12054 *
12055 * @param CairoContext $context Description...
12056 * @param string $x Description...
12057 * @param string $y Description...
12058 * @return array
12059 * @since PECL cairo >= 0.1.0
12060 **/
12061function cairo_user_to_device_distance($context, $x, $y){}
12062
12063/**
12064 * Retrieves the current version of the cairo library as an integer value
12065 *
12066 * @return int
12067 **/
12068function cairo_version(){}
12069
12070/**
12071 * Retrieves the current cairo library version as a string.
12072 *
12073 * @return string
12074 **/
12075function cairo_version_string(){}
12076
12077/**
12078 * @param string $clent
12079 * @param string $data
12080 * @return string
12081 * @since PECL spplus >= 1.0.0
12082 **/
12083function calculhmac($clent, $data){}
12084
12085/**
12086 * @param string $clent
12087 * @param string $siretcode
12088 * @param string $price
12089 * @param string $reference
12090 * @param string $validity
12091 * @param string $taxation
12092 * @param string $devise
12093 * @param string $language
12094 * @return string
12095 * @since PECL spplus >= 1.0.0
12096 **/
12097function calcul_hmac($clent, $siretcode, $price, $reference, $validity, $taxation, $devise, $language){}
12098
12099/**
12100 * Call a user defined function given by the {@link function} parameter.
12101 *
12102 * @param callback $function The function to be called. Class methods
12103 *   may also be invoked statically using this function by passing
12104 *   array($classname, $methodname) to this parameter. Additionally class
12105 *   methods of an object instance may be called by passing
12106 *   array($objectinstance, $methodname) to this parameter.
12107 * @param mixed $parameter Zero or more parameters to be passed to the
12108 *   function.
12109 * @return mixed
12110 * @since PHP 4, PHP 5
12111 **/
12112function call_user_func($function, $parameter){}
12113
12114/**
12115 * Call a user defined {@link function} with the parameters in {@link
12116 * param_arr}.
12117 *
12118 * @param callback $function The function to be called.
12119 * @param array $param_arr The parameters to be passed to the function,
12120 *   as an indexed array.
12121 * @return mixed
12122 * @since PHP 4 >= 4.0.4, PHP 5
12123 **/
12124function call_user_func_array($function, $param_arr){}
12125
12126/**
12127 * @param string $method_name The method name being called.
12128 * @param object $obj The object that {@link method_name} is being
12129 *   called on.
12130 * @param mixed $parameter The optional parameters.
12131 * @return mixed
12132 * @since PHP 4, PHP 5
12133 **/
12134function call_user_method($method_name, &$obj, $parameter){}
12135
12136/**
12137 * @param string $method_name The method name being called.
12138 * @param object $obj The object that {@link method_name} is being
12139 *   called on.
12140 * @param array $params An array of parameters.
12141 * @return mixed
12142 * @since PHP 4 >= 4.0.5, PHP 5
12143 **/
12144function call_user_method_array($method_name, &$obj, $params){}
12145
12146/**
12147 * This function will return the number of days in the {@link month} of
12148 * {@link year} for the specified {@link calendar}.
12149 *
12150 * @param int $calendar Calendar to use for calculation
12151 * @param int $month Month in the selected calendar
12152 * @param int $year Year in the selected calendar
12153 * @return int
12154 * @since PHP 4 >= 4.1.0, PHP 5
12155 **/
12156function cal_days_in_month($calendar, $month, $year){}
12157
12158/**
12159 * {@link cal_from_jd} converts the Julian day given in {@link jd} into a
12160 * date of the specified {@link calendar}. Supported {@link calendar}
12161 * values are CAL_GREGORIAN, CAL_JULIAN, CAL_JEWISH and CAL_FRENCH.
12162 *
12163 * @param int $jd Julian day as integer
12164 * @param int $calendar Calendar to convert to
12165 * @return array
12166 * @since PHP 4 >= 4.1.0, PHP 5
12167 **/
12168function cal_from_jd($jd, $calendar){}
12169
12170/**
12171 * {@link cal_info} returns information on the specified {@link
12172 * calendar}.
12173 *
12174 * Calendar information is returned as an array containing the elements
12175 * calname, calsymbol, month, abbrevmonth and maxdaysinmonth. The names
12176 * of the different calendars which can be used as {@link calendar} are
12177 * as follows: 0 or CAL_GREGORIAN - Gregorian Calendar 1 or CAL_JULIAN -
12178 * Julian Calendar 2 or CAL_JEWISH - Jewish Calendar 3 or CAL_FRENCH -
12179 * French Revolutionary Calendar
12180 *
12181 * If no {@link calendar} is specified information on all supported
12182 * calendars is returned as an array.
12183 *
12184 * @param int $calendar Calendar to return information for. If no
12185 *   calendar is specified information about all calendars is returned.
12186 * @return array
12187 * @since PHP 4 >= 4.1.0, PHP 5
12188 **/
12189function cal_info($calendar){}
12190
12191/**
12192 * {@link cal_to_jd} calculates the Julian day count for a date in the
12193 * specified {@link calendar}. Supported {@link calendar}s are
12194 * CAL_GREGORIAN, CAL_JULIAN, CAL_JEWISH and CAL_FRENCH.
12195 *
12196 * @param int $calendar Calendar to convert from, one of CAL_GREGORIAN,
12197 *   CAL_JULIAN, CAL_JEWISH or CAL_FRENCH.
12198 * @param int $month The month as a number, the valid range depends on
12199 *   the {@link calendar}
12200 * @param int $day The day as a number, the valid range depends on the
12201 *   {@link calendar}
12202 * @param int $year The year as a number, the valid range depends on
12203 *   the {@link calendar}
12204 * @return int
12205 * @since PHP 4 >= 4.1.0, PHP 5
12206 **/
12207function cal_to_jd($calendar, $month, $day, $year){}
12208
12209/**
12210 * @param float $value The value to round
12211 * @return float
12212 * @since PHP 4, PHP 5
12213 **/
12214function ceil($value){}
12215
12216/**
12217 * {@link chdb_create} creates a chdb file containing the specified
12218 * key-value pairs.
12219 *
12220 * @param string $pathname The name of the file to create. If a file
12221 *   with the same name already exists, it is overwritten.
12222 * @param array $data An array containing the key-value pairs to store
12223 *   in the chdb file. Keys and values are converted to strings before
12224 *   being written to the file, as chdb only support the string type.
12225 *   Note that binary strings are supported as well, both as keys and
12226 *   values.
12227 * @return void
12228 * @since PECL chdb >= 0.1.0
12229 **/
12230function chdb_create($pathname, $data){}
12231
12232/**
12233 * Changes PHP's current directory to {@link directory}.
12234 *
12235 * @param string $directory The new current directory
12236 * @return bool
12237 * @since PHP 4, PHP 5
12238 **/
12239function chdir($directory){}
12240
12241/**
12242 * Checks the validity of the date formed by the arguments. A date is
12243 * considered valid if each parameter is properly defined.
12244 *
12245 * @param int $month The month is between 1 and 12 inclusive.
12246 * @param int $day The day is within the allowed number of days for the
12247 *   given {@link month}. Leap {@link year}s are taken into
12248 *   consideration.
12249 * @param int $year The year is between 1 and 32767 inclusive.
12250 * @return bool
12251 * @since PHP 4, PHP 5
12252 **/
12253function checkdate($month, $day, $year){}
12254
12255/**
12256 * Searches DNS for records of type {@link type} corresponding to {@link
12257 * host}.
12258 *
12259 * @param string $host {@link host} may either be the IP address in
12260 *   dotted-quad notation or the host name.
12261 * @param string $type {@link type} may be any one of: A, MX, NS, SOA,
12262 *   PTR, CNAME, AAAA, A6, SRV, NAPTR, TXT or ANY.
12263 * @return bool
12264 * @since PHP 4, PHP 5
12265 **/
12266function checkdnsrr($host, $type){}
12267
12268/**
12269 * Attempts to change the group of the file {@link filename} to {@link
12270 * group}.
12271 *
12272 * Only the superuser may change the group of a file arbitrarily; other
12273 * users may change the group of a file to any group of which that user
12274 * is a member.
12275 *
12276 * @param string $filename Path to the file.
12277 * @param mixed $group A group name or number.
12278 * @return bool
12279 * @since PHP 4, PHP 5
12280 **/
12281function chgrp($filename, $group){}
12282
12283/**
12284 * Attempts to change the mode of the specified file to that given in
12285 * {@link mode}.
12286 *
12287 * @param string $filename Path to the file.
12288 * @param int $mode Note that {@link mode} is not automatically assumed
12289 *   to be an octal value, so strings (such as "g+w") will not work
12290 *   properly. To ensure the expected operation, you need to prefix
12291 *   {@link mode} with a zero (0):
12292 *
12293 *   <?php chmod("/somedir/somefile", 755); // decimal; probably
12294 *   incorrect chmod("/somedir/somefile", "u+rwx,go+rx"); // string;
12295 *   incorrect chmod("/somedir/somefile", 0755); // octal; correct value
12296 *   of mode ?>
12297 *
12298 *   The {@link mode} parameter consists of three octal number components
12299 *   specifying access restrictions for the owner, the user group in
12300 *   which the owner is in, and to everybody else in this order. One
12301 *   component can be computed by adding up the needed permissions for
12302 *   that target user base. Number 1 means that you grant execute rights,
12303 *   number 2 means that you make the file writeable, number 4 means that
12304 *   you make the file readable. Add up these numbers to specify needed
12305 *   rights. You can also read more about modes on Unix systems with 'man
12306 *   1 chmod' and 'man 2 chmod'.
12307 *
12308 *   <?php // Read and write for owner, nothing for everybody else
12309 *   chmod("/somedir/somefile", 0600);
12310 *
12311 *   // Read and write for owner, read for everybody else
12312 *   chmod("/somedir/somefile", 0644);
12313 *
12314 *   // Everything for owner, read and execute for others
12315 *   chmod("/somedir/somefile", 0755);
12316 *
12317 *   // Everything for owner, read and execute for owner's group
12318 *   chmod("/somedir/somefile", 0750); ?>
12319 * @return bool
12320 * @since PHP 4, PHP 5
12321 **/
12322function chmod($filename, $mode){}
12323
12324/**
12325 * This function returns a string with whitespace stripped from the end
12326 * of {@link str}.
12327 *
12328 * Without the second parameter, {@link chop} will strip these
12329 * characters: " " (ASCII 32 (0x20)), an ordinary space. "\t" (ASCII 9
12330 * (0x09)), a tab. "\n" (ASCII 10 (0x0A)), a new line (line feed). "\r"
12331 * (ASCII 13 (0x0D)), a carriage return. "\0" (ASCII 0 (0x00)), the
12332 * NUL-byte. "\x0B" (ASCII 11 (0x0B)), a vertical tab.
12333 *
12334 * @param string $str The input string.
12335 * @param string $charlist You can also specify the characters you want
12336 *   to strip, by means of the {@link charlist} parameter. Simply list
12337 *   all characters that you want to be stripped. With .. you can specify
12338 *   a range of characters.
12339 * @return string
12340 * @since PHP 4, PHP 5
12341 **/
12342function chop($str, $charlist){}
12343
12344/**
12345 * Attempts to change the owner of the file {@link filename} to user
12346 * {@link user}. Only the superuser may change the owner of a file.
12347 *
12348 * @param string $filename Path to the file.
12349 * @param mixed $user A user name or number.
12350 * @return bool
12351 * @since PHP 4, PHP 5
12352 **/
12353function chown($filename, $user){}
12354
12355/**
12356 * Returns a one-character string containing the character specified by
12357 * {@link ascii}.
12358 *
12359 * This function complements {@link ord}.
12360 *
12361 * @param int $ascii The ascii code.
12362 * @return string
12363 * @since PHP 4, PHP 5
12364 **/
12365function chr($ascii){}
12366
12367/**
12368 * Changes the root directory of the current process to {@link
12369 * directory}.
12370 *
12371 * This function is only available if your system supports it and you're
12372 * using the CLI, CGI or Embed SAPI. Also, this function requires root
12373 * privileges.
12374 *
12375 * @param string $directory The new directory
12376 * @return bool
12377 * @since PHP 4 >= 4.0.5, PHP 5
12378 **/
12379function chroot($directory){}
12380
12381/**
12382 * Can be used to split a string into smaller chunks which is useful for
12383 * e.g. converting {@link base64_encode} output to match RFC 2045
12384 * semantics. It inserts {@link end} every {@link chunklen} characters.
12385 *
12386 * @param string $body The string to be chunked.
12387 * @param int $chunklen The chunk length.
12388 * @param string $end The line ending sequence.
12389 * @return string
12390 * @since PHP 4, PHP 5
12391 **/
12392function chunk_split($body, $chunklen, $end){}
12393
12394/**
12395 * @param string $filename The filename of the class method definitions
12396 *   to import
12397 * @return array
12398 * @since PECL classkit >= 0.3
12399 **/
12400function classkit_import($filename){}
12401
12402/**
12403 * @param string $classname The class to which this method will be
12404 *   added
12405 * @param string $methodname The name of the method to add
12406 * @param string $args Comma-delimited list of arguments for the
12407 *   newly-created method
12408 * @param string $code The code to be evaluated when {@link methodname}
12409 *   is called
12410 * @param int $flags The type of method to create, can be
12411 *   CLASSKIT_ACC_PUBLIC, CLASSKIT_ACC_PROTECTED or CLASSKIT_ACC_PRIVATE
12412 * @return bool
12413 * @since PECL classkit >= 0.1
12414 **/
12415function classkit_method_add($classname, $methodname, $args, $code, $flags){}
12416
12417/**
12418 * @param string $dClass Destination class for copied method
12419 * @param string $dMethod Destination method name
12420 * @param string $sClass Source class of the method to copy
12421 * @param string $sMethod Name of the method to copy from the source
12422 *   class. If this parameter is omitted, the value of {@link dMethod} is
12423 *   assumed.
12424 * @return bool
12425 * @since PECL classkit >= 0.2
12426 **/
12427function classkit_method_copy($dClass, $dMethod, $sClass, $sMethod){}
12428
12429/**
12430 * @param string $classname The class in which to redefine the method
12431 * @param string $methodname The name of the method to redefine
12432 * @param string $args Comma-delimited list of arguments for the
12433 *   redefined method
12434 * @param string $code The new code to be evaluated when {@link
12435 *   methodname} is called
12436 * @param int $flags The redefined method can be CLASSKIT_ACC_PUBLIC,
12437 *   CLASSKIT_ACC_PROTECTED or CLASSKIT_ACC_PRIVATE
12438 * @return bool
12439 * @since PECL classkit >= 0.1
12440 **/
12441function classkit_method_redefine($classname, $methodname, $args, $code, $flags){}
12442
12443/**
12444 * @param string $classname The class in which to remove the method
12445 * @param string $methodname The name of the method to remove
12446 * @return bool
12447 * @since PECL classkit >= 0.1
12448 **/
12449function classkit_method_remove($classname, $methodname){}
12450
12451/**
12452 * @param string $classname The class in which to rename the method
12453 * @param string $methodname The name of the method to rename
12454 * @param string $newname The new name to give to the renamed method
12455 * @return bool
12456 * @since PECL classkit >= 0.1
12457 **/
12458function classkit_method_rename($classname, $methodname, $newname){}
12459
12460/**
12461 * Creates an alias named {@link alias} based on the defined class {@link
12462 * original}. The aliased class is exactly the same as the original
12463 * class.
12464 *
12465 * @param string $original The original class.
12466 * @param string $alias The alias name for the class.
12467 * @return boolean
12468 * @since PHP 5 >= 5.3.0
12469 **/
12470function class_alias($original, $alias){}
12471
12472/**
12473 * This function checks whether or not the given class has been defined.
12474 *
12475 * @param string $class_name The class name. The name is matched in a
12476 *   case-insensitive manner.
12477 * @param bool $autoload Whether or not to call by default.
12478 * @return bool
12479 * @since PHP 4, PHP 5
12480 **/
12481function class_exists($class_name, $autoload){}
12482
12483/**
12484 * This function returns an array with the names of the interfaces that
12485 * the given {@link class} and its parents implement.
12486 *
12487 * @param mixed $class An object (class instance) or a string (class
12488 *   name).
12489 * @param bool $autoload Whether to allow this function to load the
12490 *   class automatically through the __autoload magic method.
12491 * @return array
12492 * @since PHP 5 >= 5.1.0
12493 **/
12494function class_implements($class, $autoload){}
12495
12496/**
12497 * This function returns an array with the name of the parent classes of
12498 * the given {@link class}.
12499 *
12500 * @param mixed $class An object (class instance) or a string (class
12501 *   name).
12502 * @param bool $autoload Whether to allow this function to load the
12503 *   class automatically through the __autoload magic method.
12504 * @return array
12505 * @since PHP 5 >= 5.1.0
12506 **/
12507function class_parents($class, $autoload){}
12508
12509/**
12510 * When you use {@link stat}, {@link lstat}, or any of the other
12511 * functions listed in the affected functions list (below), PHP caches
12512 * the information those functions return in order to provide faster
12513 * performance. However, in certain cases, you may want to clear the
12514 * cached information. For instance, if the same file is being checked
12515 * multiple times within a single script, and that file is in danger of
12516 * being removed or changed during that script's operation, you may elect
12517 * to clear the status cache. In these cases, you can use the {@link
12518 * clearstatcache} function to clear the information that PHP caches
12519 * about a file.
12520 *
12521 * You should also note that PHP doesn't cache information about
12522 * non-existent files. So, if you call {@link file_exists} on a file that
12523 * doesn't exist, it will return until you create the file. If you create
12524 * the file, it will return even if you then delete the file. However
12525 * {@link unlink} clears the cache automatically.
12526 *
12527 * Affected functions include {@link stat}, {@link lstat}, {@link
12528 * file_exists}, {@link is_writable}, {@link is_readable}, {@link
12529 * is_executable}, {@link is_file}, {@link is_dir}, {@link is_link},
12530 * {@link filectime}, {@link fileatime}, {@link filemtime}, {@link
12531 * fileinode}, {@link filegroup}, {@link fileowner}, {@link filesize},
12532 * {@link filetype}, and {@link fileperms}.
12533 *
12534 * @param bool $clear_realpath_cache Whether to clear the realpath
12535 *   cache or not.
12536 * @param string $filename Clear the realpath cache for a specific
12537 *   filename; only used if {@link clear_realpath_cache} is .
12538 * @return void
12539 * @since PHP 4, PHP 5
12540 **/
12541function clearstatcache($clear_realpath_cache, $filename){}
12542
12543/**
12544 * Closes the directory stream indicated by {@link dir_handle}. The
12545 * stream must have previously been opened by {@link opendir}.
12546 *
12547 * @param resource $dir_handle The directory handle resource previously
12548 *   opened with {@link opendir}. If the directory handle is not
12549 *   specified, the last link opened by {@link opendir} is assumed.
12550 * @return void
12551 * @since PHP 4, PHP 5
12552 **/
12553function closedir($dir_handle){}
12554
12555/**
12556 * {@link closelog} closes the descriptor being used to write to the
12557 * system logger. The use of {@link closelog} is optional.
12558 *
12559 * @return bool
12560 * @since PHP 4, PHP 5
12561 **/
12562function closelog(){}
12563
12564/**
12565 * This function sorts an array such that array indices maintain their
12566 * correlation with the array elements they are associated with. This is
12567 * used mainly when sorting associative arrays where the actual element
12568 * order is significant. Array elements will have sort order according to
12569 * current locale rules.
12570 *
12571 * Equivalent to standard PHP {@link asort}.
12572 *
12573 * @param Collator $coll Collator object.
12574 * @param array $arr Array of strings to sort.
12575 * @param int $sort_flag Optional sorting type, one of the following:
12576 *   Collator::SORT_REGULAR - compare items normally (don't change types)
12577 *   Collator::SORT_NUMERIC - compare items numerically
12578 *   Collator::SORT_STRING - compare items as strings Default $sort_flag
12579 *   value is Collator::SORT_REGULAR. It is also used if an invalid
12580 *   $sort_flag value has been specified.
12581 * @return bool
12582 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
12583 **/
12584function collator_asort($coll, &$arr, $sort_flag){}
12585
12586/**
12587 * Compare two Unicode strings according to collation rules.
12588 *
12589 * @param Collator $coll Collator object.
12590 * @param string $str1 The first string to compare.
12591 * @param string $str2 The second string to compare.
12592 * @return int
12593 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
12594 **/
12595function collator_compare($coll, $str1, $str2){}
12596
12597/**
12598 * The strings will be compared using the options already specified.
12599 *
12600 * @param string $locale The locale containing the required collation
12601 *   rules. Special values for locales can be passed in - if null is
12602 *   passed for the locale, the default locale collation rules will be
12603 *   used. If empty string ("") or "root" are passed, UCA rules will be
12604 *   used.
12605 * @return Collator
12606 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
12607 **/
12608function collator_create($locale){}
12609
12610/**
12611 * Get a value of an integer collator attribute.
12612 *
12613 * @param Collator $coll Collator object.
12614 * @param int $attr Attribute to get value for.
12615 * @return int
12616 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
12617 **/
12618function collator_get_attribute($coll, $attr){}
12619
12620/**
12621 * @param Collator $coll Collator object.
12622 * @return int
12623 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
12624 **/
12625function collator_get_error_code($coll){}
12626
12627/**
12628 * Retrieves the message for the last error.
12629 *
12630 * @param Collator $coll Collator object.
12631 * @return string
12632 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
12633 **/
12634function collator_get_error_message($coll){}
12635
12636/**
12637 * Get collector locale name.
12638 *
12639 * @param Collator $coll Collator object.
12640 * @param int $type You can choose between valid and actual locale (
12641 *   Locale::VALID_LOCALE and Locale::ACTUAL_LOCALE, respectively). The
12642 *   default is the actual locale.
12643 * @return string
12644 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
12645 **/
12646function collator_get_locale($coll, $type){}
12647
12648/**
12649 * Return collation key for a string.
12650 *
12651 * @param Collator $coll Collator object.
12652 * @param string $str The string to produce the key from.
12653 * @return string
12654 **/
12655function collator_get_sort_key($coll, $str){}
12656
12657/**
12658 * @param Collator $coll Collator object.
12659 * @return int
12660 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
12661 **/
12662function collator_get_strength($coll){}
12663
12664/**
12665 * @param Collator $coll Collator object.
12666 * @param int $attr Attribute.
12667 * @param int $val Attribute value.
12668 * @return bool
12669 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
12670 **/
12671function collator_set_attribute($coll, $attr, $val){}
12672
12673/**
12674 * The ICU Collation Service supports many levels of comparison (named
12675 * "Levels", but also known as "Strengths"). Having these categories
12676 * enables ICU to sort strings precisely according to local conventions.
12677 * However, by allowing the levels to be selectively employed, searching
12678 * for a string in text can be performed with various matching
12679 * conditions.
12680 *
12681 * Primary Level: Typically, this is used to denote differences between
12682 * base characters (for example, "a" < "b"). It is the strongest
12683 * difference. For example, dictionaries are divided into different
12684 * sections by base character. This is also called the level1 strength.
12685 * Secondary Level: Accents in the characters are considered secondary
12686 * differences (for example, "as" < "às" < "at"). Other differences
12687 * between letters can also be considered secondary differences,
12688 * depending on the language. A secondary difference is ignored when
12689 * there is a primary difference anywhere in the strings. This is also
12690 * called the level2 strength. Note: In some languages (such as Danish),
12691 * certain accented letters are considered to be separate base
12692 * characters. In most languages, however, an accented letter only has a
12693 * secondary difference from the unaccented version of that letter.
12694 * Tertiary Level: Upper and lower case differences in characters are
12695 * distinguished at the tertiary level (for example, "ao" < "Ao" <
12696 * "aò"). In addition, a variant of a letter differs from the base form
12697 * on the tertiary level (such as "A" and " "). Another example is the
12698 * difference between large and small Kana. A tertiary difference is
12699 * ignored when there is a primary or secondary difference anywhere in
12700 * the strings. This is also called the level3 strength. Quaternary
12701 * Level: When punctuation is ignored (see Ignoring Punctuations ) at
12702 * level 13, an additional level can be used to distinguish words with
12703 * and without punctuation (for example, "ab" < "a-b" < "aB"). This
12704 * difference is ignored when there is a primary, secondary or tertiary
12705 * difference. This is also known as the level4 strength. The quaternary
12706 * level should only be used if ignoring punctuation is required or when
12707 * processing Japanese text (see Hiragana processing). Identical Level:
12708 * When all other levels are equal, the identical level is used as a
12709 * tiebreaker. The Unicode code point values of the NFD form of each
12710 * string are compared at this level, just in case there is no difference
12711 * at levels 14. For example, Hebrew cantillation marks are only
12712 * distinguished at this level. This level should be used sparingly, as
12713 * only code point values differences between two strings is an extremely
12714 * rare occurrence. Using this level substantially decreases the
12715 * performance for both incremental comparison and sort key generation
12716 * (as well as increasing the sort key length). It is also known as level
12717 * 5 strength.
12718 *
12719 * For example, people may choose to ignore accents or ignore accents and
12720 * case when searching for text. Almost all characters are distinguished
12721 * by the first three levels, and in most locales the default value is
12722 * thus Tertiary. However, if Alternate is set to be Shifted, then the
12723 * Quaternary strength can be used to break ties among whitespace,
12724 * punctuation, and symbols that would otherwise be ignored. If very fine
12725 * distinctions among characters are required, then the Identical
12726 * strength can be used (for example, Identical Strength distinguishes
12727 * between the Mathematical Bold Small A and the Mathematical Italic
12728 * Small A.). However, using levels higher than Tertiary the Identical
12729 * strength result in significantly longer sort keys, and slower string
12730 * comparison performance for equal strings.
12731 *
12732 * @param Collator $coll Collator object.
12733 * @param int $strength Strength to set. Possible values are:
12734 *   Collator::PRIMARY Collator::SECONDARY Collator::TERTIARY
12735 *   Collator::QUATERNARY Collator::IDENTICAL Collator::DEFAULT
12736 * @return bool
12737 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
12738 **/
12739function collator_set_strength($coll, $strength){}
12740
12741/**
12742 * This function sorts an array according to current locale rules.
12743 *
12744 * Equivalent to standard PHP {@link sort} .
12745 *
12746 * @param Collator $coll Collator object.
12747 * @param array $arr Array of strings to sort.
12748 * @param int $sort_flag Optional sorting type, one of the following:
12749 *
12750 *   Collator::SORT_REGULAR - compare items normally (don't change types)
12751 *   Collator::SORT_NUMERIC - compare items numerically
12752 *   Collator::SORT_STRING - compare items as strings Default sorting
12753 *   type is Collator::SORT_REGULAR.
12754 * @return bool
12755 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
12756 **/
12757function collator_sort($coll, &$arr, $sort_flag){}
12758
12759/**
12760 * Similar to {@link collator_sort} but uses ICU sorting keys produced by
12761 * ucol_getSortKey() to gain more speed on large arrays.
12762 *
12763 * @param Collator $coll Collator object.
12764 * @param array $arr Array of strings to sort
12765 * @return bool
12766 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
12767 **/
12768function collator_sort_with_sort_keys($coll, &$arr){}
12769
12770/**
12771 * Creates an array containing variables and their values.
12772 *
12773 * For each of these, {@link compact} looks for a variable with that name
12774 * in the current symbol table and adds it to the output array such that
12775 * the variable name becomes the key and the contents of the variable
12776 * become the value for that key. In short, it does the opposite of
12777 * {@link extract}.
12778 *
12779 * Any strings that are not set will simply be skipped.
12780 *
12781 * @param mixed $varname {@link compact} takes a variable number of
12782 *   parameters. Each parameter can be either a string containing the
12783 *   name of the variable, or an array of variable names. The array can
12784 *   contain other arrays of variable names inside it; {@link compact}
12785 *   handles it recursively.
12786 * @return array
12787 * @since PHP 4, PHP 5
12788 **/
12789function compact($varname){}
12790
12791/**
12792 * Increases the components reference counter.
12793 *
12794 * @return void
12795 * @since PHP 4 >= 4.1.0
12796 **/
12797function com_addref(){}
12798
12799/**
12800 * Generates a Globally Unique Identifier (GUID).
12801 *
12802 * A GUID is generated in the same way as DCE UUID's, except that the
12803 * Microsoft convention is to enclose a GUID in curly braces.
12804 *
12805 * @return string
12806 * @since PHP 5
12807 **/
12808function com_create_guid(){}
12809
12810/**
12811 * Instructs COM to sink events generated by {@link comobject} into the
12812 * PHP object {@link sinkobject}.
12813 *
12814 * Be careful how you use this feature; if you are doing something
12815 * similar to the example below, then it doesn't really make sense to run
12816 * it in a web server context.
12817 *
12818 * @param variant $comobject
12819 * @param object $sinkobject {@link sinkobject} should be an instance
12820 *   of a class with methods named after those of the desired
12821 *   dispinterface; you may use {@link com_print_typeinfo} to help
12822 *   generate a template class for this purpose.
12823 * @param mixed $sinkinterface PHP will attempt to use the default
12824 *   dispinterface type specified by the typelibrary associated with
12825 *   {@link comobject}, but you may override this choice by setting
12826 *   {@link sinkinterface} to the name of the dispinterface that you want
12827 *   to use.
12828 * @return bool
12829 * @since PHP 4 >= 4.2.0, PHP 5
12830 **/
12831function com_event_sink($comobject, $sinkobject, $sinkinterface){}
12832
12833/**
12834 * {@link com_get_active_object} is similar to creating a new instance of
12835 * a object, except that it will only return an object to your script if
12836 * the object is already running. OLE applications use something known as
12837 * the Running Object Table to allow well-known applications to be
12838 * launched only once; this function exposes the COM library function
12839 * GetActiveObject() to get a handle on a running instance.
12840 *
12841 * @param string $progid {@link progid} must be either the ProgID or
12842 *   CLSID for the object that you want to access (for example
12843 *   Word.Application).
12844 * @param int $code_page Acts in precisely the same way that it does
12845 *   for the class.
12846 * @return variant
12847 * @since PHP 5
12848 **/
12849function com_get_active_object($progid, $code_page){}
12850
12851/**
12852 * {@link com_invoke} invokes the method named {@link function_name} of
12853 * the COM component referenced by {@link com_object}. {@link com_invoke}
12854 * returns on error, returns the {@link function_name}'s return value on
12855 * success. All the extra parameters {@link function_parameters} are
12856 * passed to the method {@link function_name}.
12857 *
12858 * Don't use com_invoke(), use OO syntax instead
12859 *
12860 * <?php // do this $val = $obj->method($one, $two); // instead of this:
12861 * $val = com_invoke($obj, 'method', $one, $two); ?>
12862 *
12863 * @param resource $com_object
12864 * @param string $function_name
12865 * @param mixed $function_parameters
12866 * @return mixed
12867 * @since PHP 4
12868 **/
12869function com_invoke($com_object, $function_name, $function_parameters){}
12870
12871/**
12872 * Checks to see if a COM object can be enumerated using the Next()
12873 * method hack. See class for more details on these methods.
12874 *
12875 * @param variant $com_module The COM object.
12876 * @return bool
12877 * @since PHP 4 >= 4.1.0
12878 **/
12879function com_isenum($com_module){}
12880
12881/**
12882 * Loads a type-library and registers its constants in the engine, as
12883 * though they were defined using {@link define}.
12884 *
12885 * Note that it is much more efficient to use the configuration setting
12886 * to pre-load and register the constants, although not so flexible.
12887 *
12888 * If you have turned on , then PHP will attempt to automatically
12889 * register the constants associated with a COM object when you
12890 * instantiate it. This depends on the interfaces provided by the COM
12891 * object itself, and may not always be possible.
12892 *
12893 * @param string $typelib_name {@link typelib_name} can be one of the
12894 *   following: The filename of a .tlb file or the executable module that
12895 *   contains the type library. The type library GUID, followed by its
12896 *   version number, for example
12897 *   {00000200-0000-0010-8000-00AA006D2EA4},2,0. The type library name,
12898 *   e.g. Microsoft OLE DB ActiveX Data Objects 1.0 Library. PHP will
12899 *   attempt to resolve the type library in this order, as the process
12900 *   gets more and more expensive as you progress down the list;
12901 *   searching for the type library by name is handled by physically
12902 *   enumerating the registry until we find a match.
12903 * @param bool $case_insensitive The {@link case_insensitive} behaves
12904 *   in the same way as the parameter with the same name in the {@link
12905 *   define} function.
12906 * @return bool
12907 * @since PHP 4 >= 4.1.0, PHP 5
12908 **/
12909function com_load_typelib($typelib_name, $case_insensitive){}
12910
12911/**
12912 * This function will sleep for up to {@link timeoutms} milliseconds, or
12913 * until a message arrives in the queue.
12914 *
12915 * The purpose of this function is to route COM calls between apartments
12916 * and handle various synchronization issues. This allows your script to
12917 * wait efficiently for events to be triggered, while still handling
12918 * other events or running other code in the background. You should use
12919 * it in a loop, as demonstrated by the example in the {@link
12920 * com_event_sink} function, until you are finished using event bound COM
12921 * objects.
12922 *
12923 * @param int $timeoutms The timeout, in milliseconds. If you do not
12924 *   specify a value for {@link timeoutms}, then 0 will be assumed. A 0
12925 *   value means that no waiting will be performed; if there are messages
12926 *   pending they will be dispatched as before; if there are no messages
12927 *   pending, the function will return immediately without sleeping.
12928 * @return bool
12929 * @since PHP 4 >= 4.2.0, PHP 5
12930 **/
12931function com_message_pump($timeoutms){}
12932
12933/**
12934 * The purpose of this function is to help generate a skeleton class for
12935 * use as an event sink. You may also use it to generate a dump of any
12936 * COM object, provided that it supports enough of the introspection
12937 * interfaces, and that you know the name of the interface you want to
12938 * display.
12939 *
12940 * @param object $comobject {@link comobject} should be either an
12941 *   instance of a COM object, or be the name of a typelibrary (which
12942 *   will be resolved according to the rules set out in {@link
12943 *   com_load_typelib}).
12944 * @param string $dispinterface The name of an IDispatch descendant
12945 *   interface that you want to display.
12946 * @param bool $wantsink If set to , the corresponding sink interface
12947 *   will be displayed instead.
12948 * @return bool
12949 * @since PHP 4 >= 4.2.0, PHP 5
12950 **/
12951function com_print_typeinfo($comobject, $dispinterface, $wantsink){}
12952
12953/**
12954 * Decreases the components reference counter.
12955 *
12956 * @return void
12957 * @since PHP 4 >= 4.1.0
12958 **/
12959function com_release(){}
12960
12961/**
12962 * Checks whether the client disconnected.
12963 *
12964 * @return int
12965 * @since PHP 4, PHP 5
12966 **/
12967function connection_aborted(){}
12968
12969/**
12970 * Gets the connection status bitfield.
12971 *
12972 * @return int
12973 * @since PHP 4, PHP 5
12974 **/
12975function connection_status(){}
12976
12977/**
12978 * Determines whether the script timed out.
12979 *
12980 * @return int
12981 * @since PHP 4
12982 **/
12983function connection_timeout(){}
12984
12985/**
12986 * @param string $name The constant name.
12987 * @return mixed
12988 * @since PHP 4 >= 4.0.4, PHP 5
12989 **/
12990function constant($name){}
12991
12992/**
12993 * Converts from one Cyrillic character set to another.
12994 *
12995 * @param string $str The string to be converted.
12996 * @param string $from The source Cyrillic character set, as a single
12997 *   character.
12998 * @param string $to The target Cyrillic character set, as a single
12999 *   character.
13000 * @return string
13001 * @since PHP 4, PHP 5
13002 **/
13003function convert_cyr_string($str, $from, $to){}
13004
13005/**
13006 * {@link convert_uudecode} decodes a uuencoded string.
13007 *
13008 * @param string $data The uuencoded data.
13009 * @return string
13010 * @since PHP 5
13011 **/
13012function convert_uudecode($data){}
13013
13014/**
13015 * {@link convert_uuencode} encodes a string using the uuencode
13016 * algorithm.
13017 *
13018 * Uuencode translates all strings (including binary's ones) into
13019 * printable characters, making them safe for network transmissions.
13020 * Uuencoded data is about 35% larger than the original.
13021 *
13022 * @param string $data The data to be encoded.
13023 * @return string
13024 * @since PHP 5
13025 **/
13026function convert_uuencode($data){}
13027
13028/**
13029 * Makes a copy of the file {@link source} to {@link dest}.
13030 *
13031 * If you wish to move a file, use the {@link rename} function.
13032 *
13033 * @param string $source Path to the source file.
13034 * @param string $dest The destination path. If {@link dest} is a URL,
13035 *   the copy operation may fail if the wrapper does not support
13036 *   overwriting of existing files.
13037 * @param resource $context A valid context resource created with
13038 *   {@link stream_context_create}.
13039 * @return bool
13040 * @since PHP 4, PHP 5
13041 **/
13042function copy($source, $dest, $context){}
13043
13044/**
13045 * {@link cos} returns the cosine of the {@link arg} parameter. The
13046 * {@link arg} parameter is in radians.
13047 *
13048 * @param float $arg An angle in radians
13049 * @return float
13050 * @since PHP 4, PHP 5
13051 **/
13052function cos($arg){}
13053
13054/**
13055 * Returns the hyperbolic cosine of {@link arg}, defined as (exp(arg) +
13056 * exp(-arg))/2.
13057 *
13058 * @param float $arg The argument to process
13059 * @return float
13060 * @since PHP 4 >= 4.1.0, PHP 5
13061 **/
13062function cosh($arg){}
13063
13064/**
13065 * Counts all elements in an array, or properties in an object.
13066 *
13067 * For objects, if you have SPL installed, you can hook into {@link
13068 * count} by implementing interface Countable. The interface has exactly
13069 * one method, {@link count}, which returns the return value for the
13070 * {@link count} function.
13071 *
13072 * Please see the Array section of the manual for a detailed explanation
13073 * of how arrays are implemented and used in PHP.
13074 *
13075 * @param mixed $var The array.
13076 * @param int $mode If the optional {@link mode} parameter is set to
13077 *   COUNT_RECURSIVE (or 1), {@link count} will recursively count the
13078 *   array. This is particularly useful for counting all the elements of
13079 *   a multidimensional array. {@link count} does not detect infinite
13080 *   recursion.
13081 * @return int
13082 * @since PHP 4, PHP 5
13083 **/
13084function count($var, $mode){}
13085
13086/**
13087 * Counts the number of occurrences of every byte-value (0..255) in
13088 * {@link string} and returns it in various ways.
13089 *
13090 * @param string $string The examined string.
13091 * @param int $mode See return values.
13092 * @return mixed
13093 * @since PHP 4, PHP 5
13094 **/
13095function count_chars($string, $mode){}
13096
13097/**
13098 * Performs an obscure check with the given password on the specified
13099 * dictionary.
13100 *
13101 * @param resource $dictionary The crack lib dictionary. If not
13102 *   specified, the last opened dictionary is used.
13103 * @param string $password The tested password.
13104 * @return bool
13105 * @since PECL crack >= 0.1
13106 **/
13107function crack_check($dictionary, $password){}
13108
13109/**
13110 * {@link crack_closedict} closes the specified {@link dictionary}
13111 * identifier.
13112 *
13113 * @param resource $dictionary The dictionary to close. If not
13114 *   specified, the current dictionary is closed.
13115 * @return bool
13116 * @since PECL crack >= 0.1
13117 **/
13118function crack_closedict($dictionary){}
13119
13120/**
13121 * {@link crack_getlastmessage} returns the message from the last obscure
13122 * check.
13123 *
13124 * @return string
13125 * @since PECL crack >= 0.1
13126 **/
13127function crack_getlastmessage(){}
13128
13129/**
13130 * {@link crack_opendict} opens the specified CrackLib {@link dictionary}
13131 * for use with {@link crack_check}.
13132 *
13133 * @param string $dictionary The path to the Cracklib dictionary.
13134 * @return resource
13135 * @since PECL crack >= 0.1
13136 **/
13137function crack_opendict($dictionary){}
13138
13139/**
13140 * Generates the cyclic redundancy checksum polynomial of 32-bit lengths
13141 * of the {@link str}. This is usually used to validate the integrity of
13142 * data being transmitted.
13143 *
13144 * Because PHP's integer type is signed, and many crc32 checksums will
13145 * result in negative integers, you need to use the "%u" formatter of
13146 * {@link sprintf} or {@link printf} to get the string representation of
13147 * the unsigned crc32 checksum.
13148 *
13149 * @param string $str The data.
13150 * @return int
13151 * @since PHP 4 >= 4.0.1, PHP 5
13152 **/
13153function crc32($str){}
13154
13155/**
13156 * Creates an anonymous function from the parameters passed, and returns
13157 * a unique name for it.
13158 *
13159 * @param string $args The function arguments.
13160 * @param string $code The function code.
13161 * @return string
13162 * @since PHP 4 >= 4.0.1, PHP 5
13163 **/
13164function create_function($args, $code){}
13165
13166/**
13167 * {@link crypt} will return a hashed string using the standard Unix
13168 * DES-based algorithm or alternative algorithms that may be available on
13169 * the system.
13170 *
13171 * Some operating systems support more than one type of hash. In fact,
13172 * sometimes the standard DES-based algorithm is replaced by an MD5-based
13173 * algorithm. The hash type is triggered by the salt argument. Prior to
13174 * 5.3, PHP would determine the available algorithms at install-time
13175 * based on the system's crypt(). If no salt is provided, PHP will
13176 * auto-generate either a standard two character (DES) salt, or a twelve
13177 * character (MD5), depending on the availability of MD5 crypt(). PHP
13178 * sets a constant named CRYPT_SALT_LENGTH which indicates the longest
13179 * valid salt allowed by the available hashes.
13180 *
13181 * The standard DES-based {@link crypt} returns the salt as the first two
13182 * characters of the output. It also only uses the first eight characters
13183 * of {@link str}, so longer strings that start with the same eight
13184 * characters will generate the same result (when the same salt is used).
13185 *
13186 * @param string $str The string to be hashed.
13187 * @param string $salt An optional salt string to base the hashing on.
13188 *   If not provided, the behaviour is defined by the algorithm
13189 *   implementation and can lead to unexpected results.
13190 * @return string
13191 * @since PHP 4, PHP 5
13192 **/
13193function crypt($str, $salt){}
13194
13195/**
13196 * Checks if all of the characters in the provided string, {@link text},
13197 * are alphanumeric. In the standard C locale letters are just [A-Za-z].
13198 *
13199 * @param string $text The tested string.
13200 * @return bool
13201 * @since PHP 4 >= 4.0.4, PHP 5
13202 **/
13203function ctype_alnum($text){}
13204
13205/**
13206 * Checks if all of the characters in the provided string, {@link text},
13207 * are alphabetic. In the standard C locale letters are just [A-Za-z] and
13208 * {@link ctype_alpha} is equivalent to (ctype_upper($text) ||
13209 * ctype_lower($text)) if $text is just a single character, but other
13210 * languages have letters that are considered neither upper nor lower
13211 * case.
13212 *
13213 * @param string $text The tested string.
13214 * @return bool
13215 * @since PHP 4 >= 4.0.4, PHP 5
13216 **/
13217function ctype_alpha($text){}
13218
13219/**
13220 * Checks if all of the characters in the provided string, {@link text},
13221 * are control characters. Control characters are e.g. line feed, tab,
13222 * escape.
13223 *
13224 * @param string $text The tested string.
13225 * @return bool
13226 * @since PHP 4 >= 4.0.4, PHP 5
13227 **/
13228function ctype_cntrl($text){}
13229
13230/**
13231 * Checks if all of the characters in the provided string, {@link text},
13232 * are numerical.
13233 *
13234 * @param string $text The tested string.
13235 * @return bool
13236 * @since PHP 4 >= 4.0.4, PHP 5
13237 **/
13238function ctype_digit($text){}
13239
13240/**
13241 * Checks if all of the characters in the provided string, {@link text},
13242 * creates visible output.
13243 *
13244 * @param string $text The tested string.
13245 * @return bool
13246 * @since PHP 4 >= 4.0.4, PHP 5
13247 **/
13248function ctype_graph($text){}
13249
13250/**
13251 * Checks if all of the characters in the provided string, {@link text},
13252 * are lowercase letters.
13253 *
13254 * @param string $text The tested string.
13255 * @return bool
13256 * @since PHP 4 >= 4.0.4, PHP 5
13257 **/
13258function ctype_lower($text){}
13259
13260/**
13261 * Checks if all of the characters in the provided string, {@link text},
13262 * are printable.
13263 *
13264 * @param string $text The tested string.
13265 * @return bool
13266 * @since PHP 4 >= 4.0.4, PHP 5
13267 **/
13268function ctype_print($text){}
13269
13270/**
13271 * Checks if all of the characters in the provided string, {@link text},
13272 * are punctuation character.
13273 *
13274 * @param string $text The tested string.
13275 * @return bool
13276 * @since PHP 4 >= 4.0.4, PHP 5
13277 **/
13278function ctype_punct($text){}
13279
13280/**
13281 * Checks if all of the characters in the provided string, {@link text},
13282 * creates whitespace.
13283 *
13284 * @param string $text The tested string.
13285 * @return bool
13286 * @since PHP 4 >= 4.0.4, PHP 5
13287 **/
13288function ctype_space($text){}
13289
13290/**
13291 * Checks if all of the characters in the provided string, {@link text},
13292 * are uppercase characters.
13293 *
13294 * @param string $text The tested string.
13295 * @return bool
13296 * @since PHP 4 >= 4.0.4, PHP 5
13297 **/
13298function ctype_upper($text){}
13299
13300/**
13301 * Checks if all of the characters in the provided string, {@link text},
13302 * are hexadecimal 'digits'.
13303 *
13304 * @param string $text The tested string.
13305 * @return bool
13306 * @since PHP 4 >= 4.0.4, PHP 5
13307 **/
13308function ctype_xdigit($text){}
13309
13310/**
13311 * Closes a cURL session and frees all resources. The cURL handle, {@link
13312 * ch}, is also deleted.
13313 *
13314 * @param resource $ch
13315 * @return void
13316 * @since PHP 4 >= 4.0.2, PHP 5
13317 **/
13318function curl_close($ch){}
13319
13320/**
13321 * Copies a cURL handle keeping the same preferences.
13322 *
13323 * @param resource $ch
13324 * @return resource
13325 * @since PHP 5
13326 **/
13327function curl_copy_handle($ch){}
13328
13329/**
13330 * Returns the error number for the last cURL operation.
13331 *
13332 * @param resource $ch
13333 * @return int
13334 * @since PHP 4 >= 4.0.3, PHP 5
13335 **/
13336function curl_errno($ch){}
13337
13338/**
13339 * Returns a clear text error message for the last cURL operation.
13340 *
13341 * @param resource $ch
13342 * @return string
13343 * @since PHP 4 >= 4.0.3, PHP 5
13344 **/
13345function curl_error($ch){}
13346
13347/**
13348 * Execute the given cURL session.
13349 *
13350 * This function should be called after initializing a cURL session and
13351 * all the options for the session are set.
13352 *
13353 * @param resource $ch
13354 * @return mixed
13355 * @since PHP 4 >= 4.0.2, PHP 5
13356 **/
13357function curl_exec($ch){}
13358
13359/**
13360 * Gets information about the last transfer.
13361 *
13362 * @param resource $ch This may be one of the following constants:
13363 *   CURLINFO_EFFECTIVE_URL - Last effective URL CURLINFO_HTTP_CODE -
13364 *   Last received HTTP code CURLINFO_FILETIME - Remote time of the
13365 *   retrieved document, if -1 is returned the time of the document is
13366 *   unknown CURLINFO_TOTAL_TIME - Total transaction time in seconds for
13367 *   last transfer CURLINFO_NAMELOOKUP_TIME - Time in seconds until name
13368 *   resolving was complete CURLINFO_CONNECT_TIME - Time in seconds it
13369 *   took to establish the connection CURLINFO_PRETRANSFER_TIME - Time in
13370 *   seconds from start until just before file transfer begins
13371 *   CURLINFO_STARTTRANSFER_TIME - Time in seconds until the first byte
13372 *   is about to be transferred CURLINFO_REDIRECT_TIME - Time in seconds
13373 *   of all redirection steps before final transaction was started
13374 *   CURLINFO_SIZE_UPLOAD - Total number of bytes uploaded
13375 *   CURLINFO_SIZE_DOWNLOAD - Total number of bytes downloaded
13376 *   CURLINFO_SPEED_DOWNLOAD - Average download speed
13377 *   CURLINFO_SPEED_UPLOAD - Average upload speed CURLINFO_HEADER_SIZE -
13378 *   Total size of all headers received CURLINFO_HEADER_OUT - The request
13379 *   string sent CURLINFO_REQUEST_SIZE - Total size of issued requests,
13380 *   currently only for HTTP requests CURLINFO_SSL_VERIFYRESULT - Result
13381 *   of SSL certification verification requested by setting
13382 *   CURLOPT_SSL_VERIFYPEER CURLINFO_CONTENT_LENGTH_DOWNLOAD -
13383 *   content-length of download, read from Content-Length: field
13384 *   CURLINFO_CONTENT_LENGTH_UPLOAD - Specified size of upload
13385 *   CURLINFO_CONTENT_TYPE - Content-Type: of downloaded object, NULL
13386 *   indicates server did not send valid Content-Type: header
13387 * @param int $opt
13388 * @return mixed
13389 * @since PHP 4 >= 4.0.4, PHP 5
13390 **/
13391function curl_getinfo($ch, $opt){}
13392
13393/**
13394 * Initializes a new session and return a cURL handle for use with the
13395 * {@link curl_setopt}, {@link curl_exec}, and {@link curl_close}
13396 * functions.
13397 *
13398 * @param string $url If provided, the CURLOPT_URL option will be set
13399 *   to its value. You can manually set this using the {@link
13400 *   curl_setopt} function.
13401 * @return resource
13402 * @since PHP 4 >= 4.0.2, PHP 5
13403 **/
13404function curl_init($url){}
13405
13406/**
13407 * Adds the {@link ch} handle to the multi handle {@link mh}
13408 *
13409 * @param resource $mh
13410 * @param resource $ch
13411 * @return int
13412 * @since PHP 5
13413 **/
13414function curl_multi_add_handle($mh, $ch){}
13415
13416/**
13417 * Closes a set of cURL handles.
13418 *
13419 * @param resource $mh
13420 * @return void
13421 * @since PHP 5
13422 **/
13423function curl_multi_close($mh){}
13424
13425/**
13426 * Processes each of the handles in the stack. This method can be called
13427 * whether or not a handle needs to read or write data.
13428 *
13429 * @param resource $mh A reference to a flag to tell whether the
13430 *   operations are still running.
13431 * @param int $still_running
13432 * @return int
13433 * @since PHP 5
13434 **/
13435function curl_multi_exec($mh, &$still_running){}
13436
13437/**
13438 * If CURLOPT_RETURNTRANSFER is an option that is set for a specific
13439 * handle, then this function will return the content of that cURL handle
13440 * in the form of a string.
13441 *
13442 * @param resource $ch
13443 * @return string
13444 * @since PHP 5
13445 **/
13446function curl_multi_getcontent($ch){}
13447
13448/**
13449 * Ask the multi handle if there are any messages or information from the
13450 * individual transfers. Messages may include information such as an
13451 * error code from the transfer or just the fact that a transfer is
13452 * completed.
13453 *
13454 * Repeated calls to this function will return a new result each time,
13455 * until a is returned as a signal that there is no more to get at this
13456 * point. The integer pointed to with {@link msgs_in_queue} will contain
13457 * the number of remaining messages after this function was called.
13458 *
13459 * @param resource $mh Number of messages that are still in the queue
13460 * @param int $msgs_in_queue
13461 * @return array
13462 * @since PHP 5
13463 **/
13464function curl_multi_info_read($mh, &$msgs_in_queue){}
13465
13466/**
13467 * Allows the processing of multiple cURL handles in parallel.
13468 *
13469 * @return resource
13470 * @since PHP 5
13471 **/
13472function curl_multi_init(){}
13473
13474/**
13475 * Removes a given {@link ch} handle from the given {@link mh} handle.
13476 * When the {@link ch} handle has been removed, it is again perfectly
13477 * legal to run {@link curl_exec} on this handle. Removing a handle while
13478 * being used, will effectively halt all transfers in progress.
13479 *
13480 * @param resource $mh
13481 * @param resource $ch
13482 * @return int
13483 * @since PHP 5
13484 **/
13485function curl_multi_remove_handle($mh, $ch){}
13486
13487/**
13488 * Blocks until there is activity on any of the curl_multi connections.
13489 *
13490 * @param resource $mh Time, in seconds, to wait for a response.
13491 * @param float $timeout
13492 * @return int
13493 * @since PHP 5
13494 **/
13495function curl_multi_select($mh, $timeout){}
13496
13497/**
13498 * Sets an option on the given cURL session handle.
13499 *
13500 * @param resource $ch The CURLOPT_XXX option to set.
13501 * @param int $option The value to be set on {@link option}. {@link
13502 *   value} should be a bool for the following values of the {@link
13503 *   option} parameter: Option Set {@link value} to Notes
13504 *   CURLOPT_AUTOREFERER to automatically set the Referer: field in
13505 *   requests where it follows a Location: redirect.
13506 *   CURLOPT_BINARYTRANSFER to return the raw output when
13507 *   CURLOPT_RETURNTRANSFER is used. CURLOPT_COOKIESESSION to mark this
13508 *   as a new cookie "session". It will force libcurl to ignore all
13509 *   cookies it is about to load that are "session cookies" from the
13510 *   previous session. By default, libcurl always stores and loads all
13511 *   cookies, independent if they are session cookies or not. Session
13512 *   cookies are cookies without expiry date and they are meant to be
13513 *   alive and existing for this "session" only. CURLOPT_CRLF to convert
13514 *   Unix newlines to CRLF newlines on transfers.
13515 *   CURLOPT_DNS_USE_GLOBAL_CACHE to use a global DNS cache. This option
13516 *   is not thread-safe and is enabled by default. CURLOPT_FAILONERROR to
13517 *   fail silently if the HTTP code returned is greater than or equal to
13518 *   400. The default behavior is to return the page normally, ignoring
13519 *   the code. CURLOPT_FILETIME to attempt to retrieve the modification
13520 *   date of the remote document. This value can be retrieved using the
13521 *   {@link CURLINFO_FILETIME} option with {@link curl_getinfo}.
13522 *   CURLOPT_FOLLOWLOCATION to follow any "Location: " header that the
13523 *   server sends as part of the HTTP header (note this is recursive, PHP
13524 *   will follow as many "Location: " headers that it is sent, unless
13525 *   CURLOPT_MAXREDIRS is set). CURLOPT_FORBID_REUSE to force the
13526 *   connection to explicitly close when it has finished processing, and
13527 *   not be pooled for reuse. CURLOPT_FRESH_CONNECT to force the use of a
13528 *   new connection instead of a cached one. CURLOPT_FTP_USE_EPRT to use
13529 *   EPRT (and LPRT) when doing active FTP downloads. Use to disable EPRT
13530 *   and LPRT and use PORT only. CURLOPT_FTP_USE_EPSV to first try an
13531 *   EPSV command for FTP transfers before reverting back to PASV. Set to
13532 *   to disable EPSV. CURLOPT_FTPAPPEND to append to the remote file
13533 *   instead of overwriting it. CURLOPT_FTPASCII An alias of
13534 *   CURLOPT_TRANSFERTEXT. Use that instead. CURLOPT_FTPLISTONLY to only
13535 *   list the names of an FTP directory. CURLOPT_HEADER to include the
13536 *   header in the output. CURLINFO_HEADER_OUT to track the handle's
13537 *   request string. Available since PHP 5.1.3. The CURLINFO_ prefix is
13538 *   intentional. CURLOPT_HTTPGET to reset the HTTP request method to
13539 *   GET. Since GET is the default, this is only necessary if the request
13540 *   method has been changed. CURLOPT_HTTPPROXYTUNNEL to tunnel through a
13541 *   given HTTP proxy. CURLOPT_MUTE to be completely silent with regards
13542 *   to the cURL functions. CURLOPT_NETRC to scan the ~/.netrc file to
13543 *   find a username and password for the remote site that a connection
13544 *   is being established with. CURLOPT_NOBODY to exclude the body from
13545 *   the output. Request method is then set to HEAD. Changing this to
13546 *   does not change it to GET. CURLOPT_NOPROGRESS to disable the
13547 *   progress meter for cURL transfers. PHP automatically sets this
13548 *   option to , this should only be changed for debugging purposes.
13549 *   CURLOPT_NOSIGNAL to ignore any cURL function that causes a signal to
13550 *   be sent to the PHP process. This is turned on by default in
13551 *   multi-threaded SAPIs so timeout options can still be used. Added in
13552 *   cURL 7.10. CURLOPT_POST to do a regular HTTP POST. This POST is the
13553 *   normal application/x-www-form-urlencoded kind, most commonly used by
13554 *   HTML forms. CURLOPT_PUT to HTTP PUT a file. The file to PUT must be
13555 *   set with CURLOPT_INFILE and CURLOPT_INFILESIZE.
13556 *   CURLOPT_RETURNTRANSFER to return the transfer as a string of the
13557 *   return value of {@link curl_exec} instead of outputting it out
13558 *   directly. CURLOPT_SSL_VERIFYPEER to stop cURL from verifying the
13559 *   peer's certificate. Alternate certificates to verify against can be
13560 *   specified with the CURLOPT_CAINFO option or a certificate directory
13561 *   can be specified with the CURLOPT_CAPATH option.
13562 *   CURLOPT_SSL_VERIFYHOST may also need to be or if
13563 *   CURLOPT_SSL_VERIFYPEER is disabled (it defaults to 2). by default as
13564 *   of cURL 7.10. Default bundle installed as of cURL 7.10.
13565 *   CURLOPT_TRANSFERTEXT to use ASCII mode for FTP transfers. For LDAP,
13566 *   it retrieves data in plain text instead of HTML. On Windows systems,
13567 *   it will not set STDOUT to binary mode. CURLOPT_UNRESTRICTED_AUTH to
13568 *   keep sending the username and password when following locations
13569 *   (using CURLOPT_FOLLOWLOCATION), even when the hostname has changed.
13570 *   CURLOPT_UPLOAD to prepare for an upload. CURLOPT_VERBOSE to output
13571 *   verbose information. Writes output to STDERR, or the file specified
13572 *   using CURLOPT_STDERR. {@link value} should be an integer for the
13573 *   following values of the {@link option} parameter: Option Set {@link
13574 *   value} to Notes CURLOPT_BUFFERSIZE The size of the buffer to use for
13575 *   each read. There is no guarantee this request will be fulfilled,
13576 *   however. Added in cURL 7.10. CURLOPT_CLOSEPOLICY Either {@link
13577 *   CURLCLOSEPOLICY_LEAST_RECENTLY_USED} or {@link
13578 *   CURLCLOSEPOLICY_OLDEST}. There are three other CURLCLOSEPOLICY_
13579 *   constants, but cURL does not support them yet.
13580 *   CURLOPT_CONNECTTIMEOUT The number of seconds to wait while trying to
13581 *   connect. Use 0 to wait indefinitely. CURLOPT_CONNECTTIMEOUT_MS The
13582 *   number of milliseconds to wait while trying to connect. Use 0 to
13583 *   wait indefinitely. Added in cURL 7.16.2. Available since PHP 5.2.3.
13584 *   CURLOPT_DNS_CACHE_TIMEOUT The number of seconds to keep DNS entries
13585 *   in memory. This option is set to 120 (2 minutes) by default.
13586 *   CURLOPT_FTPSSLAUTH The FTP authentication method (when is
13587 *   activated): CURLFTPAUTH_SSL (try SSL first), CURLFTPAUTH_TLS (try
13588 *   TLS first), or CURLFTPAUTH_DEFAULT (let cURL decide). Added in cURL
13589 *   7.12.2. CURLOPT_HTTP_VERSION {@link CURL_HTTP_VERSION_NONE}
13590 *   (default, lets CURL decide which version to use), {@link
13591 *   CURL_HTTP_VERSION_1_0} (forces HTTP/1.0), or {@link
13592 *   CURL_HTTP_VERSION_1_1} (forces HTTP/1.1). CURLOPT_HTTPAUTH The HTTP
13593 *   authentication method(s) to use. The options are: {@link
13594 *   CURLAUTH_BASIC}, {@link CURLAUTH_DIGEST}, {@link
13595 *   CURLAUTH_GSSNEGOTIATE}, {@link CURLAUTH_NTLM}, {@link CURLAUTH_ANY},
13596 *   and {@link CURLAUTH_ANYSAFE}. The bitwise | (or) operator can be
13597 *   used to combine more than one method. If this is done, cURL will
13598 *   poll the server to see what methods it supports and pick the best
13599 *   one. {@link CURLAUTH_ANY} is an alias for CURLAUTH_BASIC |
13600 *   CURLAUTH_DIGEST | CURLAUTH_GSSNEGOTIATE | CURLAUTH_NTLM. {@link
13601 *   CURLAUTH_ANYSAFE} is an alias for CURLAUTH_DIGEST |
13602 *   CURLAUTH_GSSNEGOTIATE | CURLAUTH_NTLM. CURLOPT_INFILESIZE The
13603 *   expected size, in bytes, of the file when uploading a file to a
13604 *   remote site. CURLOPT_LOW_SPEED_LIMIT The transfer speed, in bytes
13605 *   per second, that the transfer should be below during the count of
13606 *   CURLOPT_LOW_SPEED_TIME seconds before PHP considers the transfer too
13607 *   slow and aborts. CURLOPT_LOW_SPEED_TIME The number of seconds the
13608 *   transfer speed should be below CURLOPT_LOW_SPEED_LIMIT before PHP
13609 *   considers the transfer too slow and aborts. CURLOPT_MAXCONNECTS The
13610 *   maximum amount of persistent connections that are allowed. When the
13611 *   limit is reached, CURLOPT_CLOSEPOLICY is used to determine which
13612 *   connection to close. CURLOPT_MAXREDIRS The maximum amount of HTTP
13613 *   redirections to follow. Use this option alongside
13614 *   CURLOPT_FOLLOWLOCATION. CURLOPT_PORT An alternative port number to
13615 *   connect to. CURLOPT_PROTOCOLS Bitmask of CURLPROTO_* values. If
13616 *   used, this bitmask limits what protocols libcurl may use in the
13617 *   transfer. This allows you to have a libcurl built to support a wide
13618 *   range of protocols but still limit specific transfers to only be
13619 *   allowed to use a subset of them. By default libcurl will accept all
13620 *   protocols it supports. See also CURLOPT_REDIR_PROTOCOLS. Valid
13621 *   protocol options are: {@link CURLPROTO_HTTP}, {@link
13622 *   CURLPROTO_HTTPS}, {@link CURLPROTO_FTP}, {@link CURLPROTO_FTPS},
13623 *   {@link CURLPROTO_SCP}, {@link CURLPROTO_SFTP}, {@link
13624 *   CURLPROTO_TELNET}, {@link CURLPROTO_LDAP}, {@link CURLPROTO_LDAPS},
13625 *   {@link CURLPROTO_DICT}, {@link CURLPROTO_FILE}, {@link
13626 *   CURLPROTO_TFTP}, {@link CURLPROTO_ALL} Added in cURL 7.19.4.
13627 *   CURLOPT_PROXYAUTH The HTTP authentication method(s) to use for the
13628 *   proxy connection. Use the same bitmasks as described in
13629 *   CURLOPT_HTTPAUTH. For proxy authentication, only {@link
13630 *   CURLAUTH_BASIC} and {@link CURLAUTH_NTLM} are currently supported.
13631 *   Added in cURL 7.10.7. CURLOPT_PROXYPORT The port number of the proxy
13632 *   to connect to. This port number can also be set in CURLOPT_PROXY.
13633 *   CURLOPT_PROXYTYPE Either {@link CURLPROXY_HTTP} (default) or {@link
13634 *   CURLPROXY_SOCKS5}. Added in cURL 7.10. CURLOPT_REDIR_PROTOCOLS
13635 *   Bitmask of CURLPROTO_* values. If used, this bitmask limits what
13636 *   protocols libcurl may use in a transfer that it follows to in a
13637 *   redirect when CURLOPT_FOLLOWLOCATION is enabled. This allows you to
13638 *   limit specific transfers to only be allowed to use a subset of
13639 *   protocols in redirections. By default libcurl will allow all
13640 *   protocols except for FILE and SCP. This is a difference compared to
13641 *   pre-7.19.4 versions which unconditionally would follow to all
13642 *   protocols supported. See also CURLOPT_PROTOCOLS for protocol
13643 *   constant values. Added in cURL 7.19.4. CURLOPT_RESUME_FROM The
13644 *   offset, in bytes, to resume a transfer from. CURLOPT_SSL_VERIFYHOST
13645 *   1 to check the existence of a common name in the SSL peer
13646 *   certificate. 2 to check the existence of a common name and also
13647 *   verify that it matches the hostname provided. CURLOPT_SSLVERSION The
13648 *   SSL version (2 or 3) to use. By default PHP will try to determine
13649 *   this itself, although in some cases this must be set manually.
13650 *   CURLOPT_TIMECONDITION How CURLOPT_TIMEVALUE is treated. Use {@link
13651 *   CURL_TIMECOND_IFMODSINCE} to return the page only if it has been
13652 *   modified since the time specified in CURLOPT_TIMEVALUE. If it hasn't
13653 *   been modified, a "304 Not Modified" header will be returned assuming
13654 *   CURLOPT_HEADER is . Use {@link CURL_TIMECOND_IFUNMODSINCE} for the
13655 *   reverse effect. {@link CURL_TIMECOND_IFMODSINCE} is the default.
13656 *   CURLOPT_TIMEOUT The maximum number of seconds to allow cURL
13657 *   functions to execute. CURLOPT_TIMEOUT_MS The maximum number of
13658 *   milliseconds to allow cURL functions to execute. Added in cURL
13659 *   7.16.2. Available since PHP 5.2.3. CURLOPT_TIMEVALUE The time in
13660 *   seconds since January 1st, 1970. The time will be used by
13661 *   CURLOPT_TIMECONDITION. By default, {@link CURL_TIMECOND_IFMODSINCE}
13662 *   is used. {@link value} should be a string for the following values
13663 *   of the {@link option} parameter: Option Set {@link value} to Notes
13664 *   CURLOPT_CAINFO The name of a file holding one or more certificates
13665 *   to verify the peer with. This only makes sense when used in
13666 *   combination with CURLOPT_SSL_VERIFYPEER. CURLOPT_CAPATH A directory
13667 *   that holds multiple CA certificates. Use this option alongside
13668 *   CURLOPT_SSL_VERIFYPEER. CURLOPT_COOKIE The contents of the "Cookie:
13669 *   " header to be used in the HTTP request. Note that multiple cookies
13670 *   are separated with a semicolon followed by a space (e.g.,
13671 *   "fruit=apple; colour=red") CURLOPT_COOKIEFILE The name of the file
13672 *   containing the cookie data. The cookie file can be in Netscape
13673 *   format, or just plain HTTP-style headers dumped into a file.
13674 *   CURLOPT_COOKIEJAR The name of a file to save all internal cookies to
13675 *   when the connection closes. CURLOPT_CUSTOMREQUEST A custom request
13676 *   method to use instead of "GET" or "HEAD" when doing a HTTP request.
13677 *   This is useful for doing "DELETE" or other, more obscure HTTP
13678 *   requests. Valid values are things like "GET", "POST", "CONNECT" and
13679 *   so on; i.e. Do not enter a whole HTTP request line here. For
13680 *   instance, entering "GET /index.html HTTP/1.0\r\n\r\n" would be
13681 *   incorrect. Don't do this without making sure the server supports the
13682 *   custom request method first. CURLOPT_EGDSOCKET Like
13683 *   CURLOPT_RANDOM_FILE, except a filename to an Entropy Gathering
13684 *   Daemon socket. CURLOPT_ENCODING The contents of the
13685 *   "Accept-Encoding: " header. This enables decoding of the response.
13686 *   Supported encodings are "identity", "deflate", and "gzip". If an
13687 *   empty string, "", is set, a header containing all supported encoding
13688 *   types is sent. Added in cURL 7.10. CURLOPT_FTPPORT The value which
13689 *   will be used to get the IP address to use for the FTP "POST"
13690 *   instruction. The "POST" instruction tells the remote server to
13691 *   connect to our specified IP address. The string may be a plain IP
13692 *   address, a hostname, a network interface name (under Unix), or just
13693 *   a plain '-' to use the systems default IP address. CURLOPT_INTERFACE
13694 *   The name of the outgoing network interface to use. This can be an
13695 *   interface name, an IP address or a host name. CURLOPT_KRB4LEVEL The
13696 *   KRB4 (Kerberos 4) security level. Any of the following values (in
13697 *   order from least to most powerful) are valid: "clear", "safe",
13698 *   "confidential", "private".. If the string does not match one of
13699 *   these, "private" is used. Setting this option to will disable KRB4
13700 *   security. Currently KRB4 security only works with FTP transactions.
13701 *   CURLOPT_POSTFIELDS The full data to post in a HTTP "POST" operation.
13702 *   To post a file, prepend a filename with @ and use the full path.
13703 *   This can either be passed as a urlencoded string like
13704 *   'para1=val1&para2=val2&...' or as an array with the field name as
13705 *   key and field data as value. If {@link value} is an array, the
13706 *   Content-Type header will be set to multipart/form-data.
13707 *   CURLOPT_PROXY The HTTP proxy to tunnel requests through.
13708 *   CURLOPT_PROXYUSERPWD A username and password formatted as
13709 *   "[username]:[password]" to use for the connection to the proxy.
13710 *   CURLOPT_RANDOM_FILE A filename to be used to seed the random number
13711 *   generator for SSL. CURLOPT_RANGE Range(s) of data to retrieve in the
13712 *   format "X-Y" where X or Y are optional. HTTP transfers also support
13713 *   several intervals, separated with commas in the format "X-Y,N-M".
13714 *   CURLOPT_REFERER The contents of the "Referer: " header to be used in
13715 *   a HTTP request. CURLOPT_SSL_CIPHER_LIST A list of ciphers to use for
13716 *   SSL. For example, RC4-SHA and TLSv1 are valid cipher lists.
13717 *   CURLOPT_SSLCERT The name of a file containing a PEM formatted
13718 *   certificate. CURLOPT_SSLCERTPASSWD The password required to use the
13719 *   CURLOPT_SSLCERT certificate. CURLOPT_SSLCERTTYPE The format of the
13720 *   certificate. Supported formats are "PEM" (default), "DER", and
13721 *   "ENG". Added in cURL 7.9.3. CURLOPT_SSLENGINE The identifier for the
13722 *   crypto engine of the private SSL key specified in CURLOPT_SSLKEY.
13723 *   CURLOPT_SSLENGINE_DEFAULT The identifier for the crypto engine used
13724 *   for asymmetric crypto operations. CURLOPT_SSLKEY The name of a file
13725 *   containing a private SSL key. CURLOPT_SSLKEYPASSWD The secret
13726 *   password needed to use the private SSL key specified in
13727 *   CURLOPT_SSLKEY. Since this option contains a sensitive password,
13728 *   remember to keep the PHP script it is contained within safe.
13729 *   CURLOPT_SSLKEYTYPE The key type of the private SSL key specified in
13730 *   CURLOPT_SSLKEY. Supported key types are "PEM" (default), "DER", and
13731 *   "ENG". CURLOPT_URL The URL to fetch. This can also be set when
13732 *   initializing a session with {@link curl_init}. CURLOPT_USERAGENT The
13733 *   contents of the "User-Agent: " header to be used in a HTTP request.
13734 *   CURLOPT_USERPWD A username and password formatted as
13735 *   "[username]:[password]" to use for the connection. {@link value}
13736 *   should be an array for the following values of the {@link option}
13737 *   parameter: Option Set {@link value} to Notes CURLOPT_HTTP200ALIASES
13738 *   An array of HTTP 200 responses that will be treated as valid
13739 *   responses and not as errors. Added in cURL 7.10.3.
13740 *   CURLOPT_HTTPHEADER An array of HTTP header fields to set, in the
13741 *   format array('Content-type: text/plain', 'Content-length: 100')
13742 *   CURLOPT_POSTQUOTE An array of FTP commands to execute on the server
13743 *   after the FTP request has been performed. CURLOPT_QUOTE An array of
13744 *   FTP commands to execute on the server prior to the FTP request.
13745 *   {@link value} should be a stream resource (using {@link fopen}, for
13746 *   example) for the following values of the {@link option} parameter:
13747 *   Option Set {@link value} to CURLOPT_FILE The file that the transfer
13748 *   should be written to. The default is STDOUT (the browser window).
13749 *   CURLOPT_INFILE The file that the transfer should be read from when
13750 *   uploading. CURLOPT_STDERR An alternative location to output errors
13751 *   to instead of STDERR. CURLOPT_WRITEHEADER The file that the header
13752 *   part of the transfer is written to. {@link value} should be a string
13753 *   that is the name of a valid callback function for the following
13754 *   values of the {@link option} parameter: Option Set {@link value} to
13755 *   CURLOPT_HEADERFUNCTION The name of a callback function where the
13756 *   callback function takes two parameters. The first is the cURL
13757 *   resource, the second is a string with the header data to be written.
13758 *   The header data must be written when using this callback function.
13759 *   Return the number of bytes written. CURLOPT_PASSWDFUNCTION The name
13760 *   of a callback function where the callback function takes three
13761 *   parameters. The first is the cURL resource, the second is a string
13762 *   containing a password prompt, and the third is the maximum password
13763 *   length. Return the string containing the password.
13764 *   CURLOPT_PROGRESSFUNCTION The name of a callback function where the
13765 *   callback function takes three parameters. The first is the cURL
13766 *   resource, the second is a file-descriptor resource, and the third is
13767 *   length. Return the string containing the data. CURLOPT_READFUNCTION
13768 *   The name of a callback function where the callback function takes
13769 *   two parameters. The first is the cURL resource, and the second is a
13770 *   string with the data to be read. The data must be read by using this
13771 *   callback function. Return the number of bytes read. Return 0 to
13772 *   signal EOF. CURLOPT_WRITEFUNCTION The name of a callback function
13773 *   where the callback function takes two parameters. The first is the
13774 *   cURL resource, and the second is a string with the data to be
13775 *   written. The data must be written by using this callback function.
13776 *   Must return the exact number of bytes written or this will fail.
13777 * @param mixed $value
13778 * @return bool
13779 * @since PHP 4 >= 4.0.2, PHP 5
13780 **/
13781function curl_setopt($ch, $option, $value){}
13782
13783/**
13784 * Sets multiple options for a cURL session. This function is useful for
13785 * setting a large amount of cURL options without repetitively calling
13786 * {@link curl_setopt}.
13787 *
13788 * @param resource $ch An array specifying which options to set and
13789 *   their values. The keys should be valid {@link curl_setopt} constants
13790 *   or their integer equivalents.
13791 * @param array $options
13792 * @return bool
13793 * @since PHP 5 >= 5.1.3
13794 **/
13795function curl_setopt_array($ch, $options){}
13796
13797/**
13798 * Returns information about the cURL version.
13799 *
13800 * @param int $age
13801 * @return array
13802 * @since PHP 4 >= 4.0.2, PHP 5
13803 **/
13804function curl_version($age){}
13805
13806/**
13807 * Every array has an internal pointer to its "current" element, which is
13808 * initialized to the first element inserted into the array.
13809 *
13810 * @param array $array The array.
13811 * @return mixed
13812 * @since PHP 4, PHP 5
13813 **/
13814function current(&$array){}
13815
13816/**
13817 * @param resource $connection
13818 * @param string $mechlist
13819 * @param string $service
13820 * @param string $user
13821 * @param int $minssf
13822 * @param int $maxssf
13823 * @param string $authname
13824 * @param string $password
13825 * @return void
13826 * @since PHP 4 >= 4.1.0, PECL cyrus 1.0
13827 **/
13828function cyrus_authenticate($connection, $mechlist, $service, $user, $minssf, $maxssf, $authname, $password){}
13829
13830/**
13831 * Binds callbacks to a Cyrus IMAP connection.
13832 *
13833 * @param resource $connection The connection handle.
13834 * @param array $callbacks An array of callbacks.
13835 * @return bool
13836 * @since PHP 4 >= 4.1.0, PECL cyrus 1.0
13837 **/
13838function cyrus_bind($connection, $callbacks){}
13839
13840/**
13841 * Closes the connection to a Cyrus IMAP server.
13842 *
13843 * @param resource $connection The connection handle.
13844 * @return bool
13845 * @since PHP 4 >= 4.1.0, PECL cyrus 1.0
13846 **/
13847function cyrus_close($connection){}
13848
13849/**
13850 * Connects to a Cyrus IMAP server.
13851 *
13852 * @param string $host The Cyrus IMAP host name.
13853 * @param string $port The port number.
13854 * @param int $flags
13855 * @return resource
13856 * @since PHP 4 >= 4.1.0, PECL cyrus 1.0
13857 **/
13858function cyrus_connect($host, $port, $flags){}
13859
13860/**
13861 * Sends a query to a Cyrus IMAP server.
13862 *
13863 * @param resource $connection The connection handle.
13864 * @param string $query The query string.
13865 * @return array
13866 * @since PHP 4 >= 4.1.0, PECL cyrus 1.0
13867 **/
13868function cyrus_query($connection, $query){}
13869
13870/**
13871 * @param resource $connection The connection handle.
13872 * @param string $trigger_name The trigger name.
13873 * @return bool
13874 * @since PHP 4 >= 4.1.0, PECL cyrus 1.0
13875 **/
13876function cyrus_unbind($connection, $trigger_name){}
13877
13878/**
13879 * Returns a string formatted according to the given format string using
13880 * the given integer {@link timestamp} or the current time if no
13881 * timestamp is given. In other words, {@link timestamp} is optional and
13882 * defaults to the value of {@link time}.
13883 *
13884 * @param string $format The format of the outputted date string. See
13885 *   the formatting options below. There are also several predefined date
13886 *   constants that may be used instead, so for example DATE_RSS contains
13887 *   the format string 'D, d M Y H:i:s'.
13888 *
13889 *   The following characters are recognized in the {@link format}
13890 *   parameter string {@link format} character Description Example
13891 *   returned values Day --- --- d Day of the month, 2 digits with
13892 *   leading zeros 01 to 31 D A textual representation of a day, three
13893 *   letters Mon through Sun j Day of the month without leading zeros 1
13894 *   to 31 l (lowercase 'L') A full textual representation of the day of
13895 *   the week Sunday through Saturday N ISO-8601 numeric representation
13896 *   of the day of the week (added in PHP 5.1.0) 1 (for Monday) through 7
13897 *   (for Sunday) S English ordinal suffix for the day of the month, 2
13898 *   characters st, nd, rd or th. Works well with j w Numeric
13899 *   representation of the day of the week 0 (for Sunday) through 6 (for
13900 *   Saturday) z The day of the year (starting from 0) 0 through 365 Week
13901 *   --- --- W ISO-8601 week number of year, weeks starting on Monday
13902 *   (added in PHP 4.1.0) Example: 42 (the 42nd week in the year) Month
13903 *   --- --- F A full textual representation of a month, such as January
13904 *   or March January through December m Numeric representation of a
13905 *   month, with leading zeros 01 through 12 M A short textual
13906 *   representation of a month, three letters Jan through Dec n Numeric
13907 *   representation of a month, without leading zeros 1 through 12 t
13908 *   Number of days in the given month 28 through 31 Year --- --- L
13909 *   Whether it's a leap year 1 if it is a leap year, 0 otherwise. o
13910 *   ISO-8601 year number. This has the same value as Y, except that if
13911 *   the ISO week number (W) belongs to the previous or next year, that
13912 *   year is used instead. (added in PHP 5.1.0) Examples: 1999 or 2003 Y
13913 *   A full numeric representation of a year, 4 digits Examples: 1999 or
13914 *   2003 y A two digit representation of a year Examples: 99 or 03 Time
13915 *   --- --- a Lowercase Ante meridiem and Post meridiem am or pm A
13916 *   Uppercase Ante meridiem and Post meridiem AM or PM B Swatch Internet
13917 *   time 000 through 999 g 12-hour format of an hour without leading
13918 *   zeros 1 through 12 G 24-hour format of an hour without leading zeros
13919 *   0 through 23 h 12-hour format of an hour with leading zeros 01
13920 *   through 12 H 24-hour format of an hour with leading zeros 00 through
13921 *   23 i Minutes with leading zeros 00 to 59 s Seconds, with leading
13922 *   zeros 00 through 59 u Microseconds (added in PHP 5.2.2) Example:
13923 *   654321 Timezone --- --- e Timezone identifier (added in PHP 5.1.0)
13924 *   Examples: UTC, GMT, Atlantic/Azores I (capital i) Whether or not the
13925 *   date is in daylight saving time 1 if Daylight Saving Time, 0
13926 *   otherwise. O Difference to Greenwich time (GMT) in hours Example:
13927 *   +0200 P Difference to Greenwich time (GMT) with colon between hours
13928 *   and minutes (added in PHP 5.1.3) Example: +02:00 T Timezone
13929 *   abbreviation Examples: EST, MDT ... Z Timezone offset in seconds.
13930 *   The offset for timezones west of UTC is always negative, and for
13931 *   those east of UTC is always positive. -43200 through 50400 Full
13932 *   Date/Time --- --- c ISO 8601 date (added in PHP 5)
13933 *   2004-02-12T15:19:21+00:00 r RFC 2822 formatted date Example: Thu, 21
13934 *   Dec 2000 16:01:07 +0200 U Seconds since the Unix Epoch (January 1
13935 *   1970 00:00:00 GMT) See also {@link time} Unrecognized characters in
13936 *   the format string will be printed as-is. The Z format will always
13937 *   return 0 when using {@link gmdate}.
13938 * @param int $timestamp
13939 * @return string
13940 * @since PHP 4, PHP 5
13941 **/
13942function date($format, $timestamp){}
13943
13944/**
13945 * Create a date formatter
13946 *
13947 * @param string $locale Locale to use when formatting or parsing.
13948 * @param int $datetype Date type to use (none, short, medium, long,
13949 *   full). This is one of the IntlDateFormatter constants.
13950 * @param int $timetype Time type to use (none, short, medium, long,
13951 *   full). This is one of the IntlDateFormatter constants.
13952 * @param string $timezone Time zone ID, default is system default.
13953 * @param int $calendar Calendar to use for formatting or parsing;
13954 *   default is Gregorian. This is one of the IntlDateFormatter calendar
13955 *   constants.
13956 * @param string $pattern Optional pattern to use when formatting or
13957 *   parsing. Possible patterns are documented at .
13958 * @return IntlDateFormatter
13959 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
13960 **/
13961function datefmt_create($locale, $datetype, $timetype, $timezone, $calendar, $pattern){}
13962
13963/**
13964 * Formats the time value as a string.
13965 *
13966 * @param IntlDateFormatter $fmt The date formatter resource.
13967 * @param mixed $value Value to format. Can be integer for an Unix
13968 *   timestamp value (seconds since epoch, UTC) or array for a {@link
13969 *   localtime} array.
13970 * @return string
13971 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
13972 **/
13973function datefmt_format($fmt, $value){}
13974
13975/**
13976 * @param IntlDateFormatter $fmt The formatter resource
13977 * @return int
13978 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
13979 **/
13980function datefmt_get_calendar($fmt){}
13981
13982/**
13983 * Returns date type used by the formatter.
13984 *
13985 * @param IntlDateFormatter $fmt The formatter resource.
13986 * @return int
13987 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
13988 **/
13989function datefmt_get_datetype($fmt){}
13990
13991/**
13992 * Get the error code from last operation. Returns error code from the
13993 * last number formatting operation.
13994 *
13995 * @param IntlDateFormatter $fmt The formatter resource.
13996 * @return int
13997 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
13998 **/
13999function datefmt_get_error_code($fmt){}
14000
14001/**
14002 * Get the error text from the last operation.
14003 *
14004 * @param IntlDateFormatter $fmt The formatter resource.
14005 * @return string
14006 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
14007 **/
14008function datefmt_get_error_message($fmt){}
14009
14010/**
14011 * Get locale used by the formatter.
14012 *
14013 * @param IntlDateFormatter $fmt The formatter resource
14014 * @param int $which You can choose between valid and actual locale (
14015 *   Locale::VALID_LOCALE, Locale::ACTUAL_LOCALE, respectively). The
14016 *   default is the actual locale.
14017 * @return string
14018 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
14019 **/
14020function datefmt_get_locale($fmt, $which){}
14021
14022/**
14023 * Get pattern used by the formatter.
14024 *
14025 * @param IntlDateFormatter $fmt The formatter resource.
14026 * @return string
14027 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
14028 **/
14029function datefmt_get_pattern($fmt){}
14030
14031/**
14032 * Return time type used by the formatter.
14033 *
14034 * @param IntlDateFormatter $fmt The formatter resource.
14035 * @return int
14036 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
14037 **/
14038function datefmt_get_timetype($fmt){}
14039
14040/**
14041 * Get the timezone-id used for the IntlDateFormatter.
14042 *
14043 * @param IntlDateFormatter $fmt The formatter resource.
14044 * @return string
14045 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
14046 **/
14047function datefmt_get_timezone_id($fmt){}
14048
14049/**
14050 * Check if the parser is strict or lenient in interpreting inputs that
14051 * do not match the pattern exactly.
14052 *
14053 * @param IntlDateFormatter $fmt The formatter resource.
14054 * @return bool
14055 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
14056 **/
14057function datefmt_is_lenient($fmt){}
14058
14059/**
14060 * Converts string $value to a field-based time value ( an array of
14061 * various fields), starting at $parse_pos and consuming as much of the
14062 * input value as possible.
14063 *
14064 * @param IntlDateFormatter $fmt The formatter resource
14065 * @param string $value string to convert to a time
14066 * @param int $position Position at which to start the parsing in
14067 *   $value (zero-based). If no error occurs before $value is consumed,
14068 *   $parse_pos will contain -1 otherwise it will contain the position at
14069 *   which parsing ended . If $parse_pos > strlen($value), the parse
14070 *   fails immediately.
14071 * @return array
14072 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
14073 **/
14074function datefmt_localtime($fmt, $value, &$position){}
14075
14076/**
14077 * Converts string $value to an incremental time value, starting at
14078 * $parse_pos and consuming as much of the input value as possible.
14079 *
14080 * @param IntlDateFormatter $fmt The formatter resource
14081 * @param string $value string to convert to a time
14082 * @param int $position Position at which to start the parsing in
14083 *   $value (zero-based). If no error occurs before $value is consumed,
14084 *   $parse_pos will contain -1 otherwise it will contain the position at
14085 *   which parsing ended (and the error occurred). This variable will
14086 *   contain the end position if the parse fails. If $parse_pos >
14087 *   strlen($value), the parse fails immediately.
14088 * @return int
14089 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
14090 **/
14091function datefmt_parse($fmt, $value, &$position){}
14092
14093/**
14094 * Sets the calendar used by the formatter.
14095 *
14096 * @param IntlDateFormatter $fmt The formatter resource.
14097 * @param int $which The calendar to use. Default is
14098 *   IntlDateFormatter::GREGORIAN.
14099 * @return bool
14100 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
14101 **/
14102function datefmt_set_calendar($fmt, $which){}
14103
14104/**
14105 * Define if the parser is strict or lenient in interpreting inputs that
14106 * do not match the pattern exactly. Enabling lenient parsing allows the
14107 * parser to accept otherwise flawed date or time patterns, parsing as
14108 * much as possible to obtain a value. Extra space, unrecognized tokens,
14109 * or invalid values ("February 30th") are not accepted.
14110 *
14111 * @param IntlDateFormatter $fmt The formatter resource
14112 * @param bool $lenient Sets whether the parser is lenient or not,
14113 *   default is (strict).
14114 * @return bool
14115 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
14116 **/
14117function datefmt_set_lenient($fmt, $lenient){}
14118
14119/**
14120 * Set the pattern used for the IntlDateFormatter.
14121 *
14122 * @param IntlDateFormatter $fmt The formatter resource.
14123 * @param string $pattern New pattern string to use. Possible patterns
14124 *   are documented at .
14125 * @return bool
14126 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
14127 **/
14128function datefmt_set_pattern($fmt, $pattern){}
14129
14130/**
14131 * Sets the time zone to use.
14132 *
14133 * @param IntlDateFormatter $fmt The formatter resource.
14134 * @param string $zone The time zone ID string of the time zone to use.
14135 *   If or the empty string, the default time zone for the runtime is
14136 *   used.
14137 * @return bool
14138 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
14139 **/
14140function datefmt_set_timezone_id($fmt, $zone){}
14141
14142/**
14143 * Adds the specified DateInterval object to the specified DateTime
14144 * object.
14145 *
14146 * @param DateTime $object A DateInterval object
14147 * @param DateInterval $interval
14148 * @return DateTime
14149 * @since PHP 5 >= 5.3.0
14150 **/
14151function date_add($object, $interval){}
14152
14153/**
14154 * Returns new DateTime object.
14155 *
14156 * @param string $time Enter here to obtain the current time when using
14157 *   the {@link $timezone} parameter.
14158 * @param DateTimeZone $timezone A DateTimeZone object representing the
14159 *   desired time zone. If {@link $timezone} is omitted, the current
14160 *   timezone will be used.
14161 * @return DateTime
14162 * @since PHP 5 >= 5.2.0
14163 **/
14164function date_create($time, $timezone){}
14165
14166/**
14167 * Returns new DateTime object formatted according to the specified
14168 * format.
14169 *
14170 * @param string $format Format accepted by {@link date}. If {@link
14171 *   format} does not contain the character ! then portions of the
14172 *   generated time which are not specified in {@link format} will be set
14173 *   to the current system time. If {@link format} contains the character
14174 *   !, then portions of the generated time not provided in {@link
14175 *   format}, as well as values to the left-hand side of the !, will be
14176 *   set to corresponding values from the Unix epoch. The Unix epoch is
14177 *   1970-01-01 00:00:00 UTC.
14178 * @param string $time String representing the time.
14179 * @param DateTimeZone $timezone A DateTimeZone object representing the
14180 *   desired time zone.
14181 * @return DateTime
14182 * @since PHP 5 >= 5.3.0
14183 **/
14184function date_create_from_format($format, $time, $timezone){}
14185
14186/**
14187 * Resets the current date of the DateTime object to a different date.
14188 *
14189 * @param DateTime $object Year of the date.
14190 * @param int $year Month of the date.
14191 * @param int $month Day of the date.
14192 * @param int $day
14193 * @return DateTime
14194 * @since PHP 5 >= 5.2.0
14195 **/
14196function date_date_set($object, $year, $month, $day){}
14197
14198/**
14199 * In order of preference, this function returns the default timezone by:
14200 * Reading the timezone set using the {@link date_default_timezone_set}
14201 * function (if any) Reading the TZ environment variable (if non empty)
14202 * (Prior to PHP 5.3.0) Reading the value of the date.timezone ini option
14203 * (if set) Querying the host operating system (if supported and allowed
14204 * by the OS)
14205 *
14206 * If none of the above succeed, date_default_timezone_get will return a
14207 * default timezone of UTC.
14208 *
14209 * @return string
14210 * @since PHP 5 >= 5.1.0
14211 **/
14212function date_default_timezone_get(){}
14213
14214/**
14215 * {@link date_default_timezone_set} sets the default timezone used by
14216 * all date/time functions.
14217 *
14218 * Instead of using this function to set the default timezone in your
14219 * script, you can also use the INI setting date.timezone to set the
14220 * default timezone.
14221 *
14222 * @param string $timezone_identifier The timezone identifier, like UTC
14223 *   or Europe/Lisbon. The list of valid identifiers is available in the
14224 *   .
14225 * @return bool
14226 * @since PHP 5 >= 5.1.0
14227 **/
14228function date_default_timezone_set($timezone_identifier){}
14229
14230/**
14231 * Returns the difference between two DateTime objects.
14232 *
14233 * @param DateTime $datetime1 The date to compare to.
14234 * @param DateTime $datetime2 Whether to return absolute difference.
14235 * @param bool $absolute
14236 * @return DateInterval
14237 * @since PHP 5 >= 5.3.0
14238 **/
14239function date_diff($datetime1, $datetime2, $absolute){}
14240
14241/**
14242 * Returns date formatted according to given format.
14243 *
14244 * @param DateTime $object Format accepted by {@link date}.
14245 * @param string $format
14246 * @return string
14247 * @since PHP 5 >= 5.2.0
14248 **/
14249function date_format($object, $format){}
14250
14251/**
14252 * Returns an array of warnings and errors found while parsing a
14253 * date/time string.
14254 *
14255 * @return array
14256 * @since PHP 5 >= 5.3.0
14257 **/
14258function date_get_last_errors(){}
14259
14260/**
14261 * Set a date according to the ISO 8601 standard - using weeks and day
14262 * offsets rather than specific dates.
14263 *
14264 * @param DateTime $object Year of the date.
14265 * @param int $year Week of the date.
14266 * @param int $week Offset from the first day of the week.
14267 * @param int $day
14268 * @return DateTime
14269 * @since PHP 5 >= 5.2.0
14270 **/
14271function date_isodate_set($object, $year, $week, $day){}
14272
14273/**
14274 * Alter the timestamp of a DateTime object by incrementing or
14275 * decrementing in a format accepted by {@link strtotime}.
14276 *
14277 * @param DateTime $object
14278 * @param string $modify
14279 * @return DateTime
14280 * @since PHP 5 >= 5.2.0
14281 **/
14282function date_modify($object, $modify){}
14283
14284/**
14285 * Returns the timezone offset.
14286 *
14287 * @param DateTime $object
14288 * @return int
14289 * @since PHP 5 >= 5.2.0
14290 **/
14291function date_offset_get($object){}
14292
14293/**
14294 * @param string $date Date in format accepted by {@link strtotime}.
14295 * @return array
14296 * @since PHP 5 >= 5.2.0
14297 **/
14298function date_parse($date){}
14299
14300/**
14301 * Returns associative array with detailed info about given date.
14302 *
14303 * @param string $format Format accepted by {@link date} with some
14304 *   extras.
14305 * @param string $date String representing the date.
14306 * @return array
14307 * @since PHP 5 >= 5.3.0
14308 **/
14309function date_parse_from_format($format, $date){}
14310
14311/**
14312 * Subtracts the specified DateInterval object from the specified
14313 * DateTime object.
14314 *
14315 * @param DateTime $object A DateInterval object
14316 * @param DateInterval $interval
14317 * @return DateTime
14318 * @since PHP 5 >= 5.3.0
14319 **/
14320function date_sub($object, $interval){}
14321
14322/**
14323 * {@link date_sunrise} returns the sunrise time for a given day
14324 * (specified as a {@link timestamp}) and location.
14325 *
14326 * @param int $timestamp The {@link timestamp} of the day from which
14327 *   the sunrise time is taken.
14328 * @param int $format {@link format} constants constant description
14329 *   example SUNFUNCS_RET_STRING returns the result as string 16:46
14330 *   SUNFUNCS_RET_DOUBLE returns the result as float 16.78243132
14331 *   SUNFUNCS_RET_TIMESTAMP returns the result as integer (timestamp)
14332 *   1095034606
14333 * @param float $latitude Defaults to North, pass in a negative value
14334 *   for South. See also: date.default_latitude
14335 * @param float $longitude Defaults to East, pass in a negative value
14336 *   for West. See also: date.default_longitude
14337 * @param float $zenith Default: date.sunrise_zenith
14338 * @param float $gmt_offset Specified in hours.
14339 * @return mixed
14340 * @since PHP 5
14341 **/
14342function date_sunrise($timestamp, $format, $latitude, $longitude, $zenith, $gmt_offset){}
14343
14344/**
14345 * {@link date_sunset} returns the sunset time for a given day (specified
14346 * as a {@link timestamp}) and location.
14347 *
14348 * @param int $timestamp The {@link timestamp} of the day from which
14349 *   the sunset time is taken.
14350 * @param int $format {@link format} constants constant description
14351 *   example SUNFUNCS_RET_STRING returns the result as string 16:46
14352 *   SUNFUNCS_RET_DOUBLE returns the result as float 16.78243132
14353 *   SUNFUNCS_RET_TIMESTAMP returns the result as integer (timestamp)
14354 *   1095034606
14355 * @param float $latitude Defaults to North, pass in a negative value
14356 *   for South. See also: date.default_latitude
14357 * @param float $longitude Defaults to East, pass in a negative value
14358 *   for West. See also: date.default_longitude
14359 * @param float $zenith Default: date.sunset_zenith
14360 * @param float $gmt_offset Specified in hours.
14361 * @return mixed
14362 * @since PHP 5
14363 **/
14364function date_sunset($timestamp, $format, $latitude, $longitude, $zenith, $gmt_offset){}
14365
14366/**
14367 * @param int $time Timestamp.
14368 * @param float $latitude Latitude in degrees.
14369 * @param float $longitude Longitude in degrees.
14370 * @return array
14371 * @since PHP 5 >= 5.1.2
14372 **/
14373function date_sun_info($time, $latitude, $longitude){}
14374
14375/**
14376 * Gets the Unix timestamp.
14377 *
14378 * @param DateTime $object
14379 * @return int
14380 * @since PHP 5 >= 5.3.0
14381 **/
14382function date_timestamp_get($object){}
14383
14384/**
14385 * Sets the date and time based on an Unix timestamp.
14386 *
14387 * @param DateTime $object Unix timestamp representing the date.
14388 * @param int $unixtimestamp
14389 * @return DateTime
14390 * @since PHP 5 >= 5.3.0
14391 **/
14392function date_timestamp_set($object, $unixtimestamp){}
14393
14394/**
14395 * Return time zone relative to given DateTime.
14396 *
14397 * @param DateTime $object
14398 * @return DateTimeZone
14399 * @since PHP 5 >= 5.2.0
14400 **/
14401function date_timezone_get($object){}
14402
14403/**
14404 * @param DateTime $object A DateTimeZone object representing the
14405 *   desired time zone.
14406 * @param DateTimeZone $timezone
14407 * @return DateTime
14408 * @since PHP 5 >= 5.2.0
14409 **/
14410function date_timezone_set($object, $timezone){}
14411
14412/**
14413 * Resets the current time of the DateTime object to a different time.
14414 *
14415 * @param DateTime $object Hour of the time.
14416 * @param int $hour Minute of the time.
14417 * @param int $minute Second of the time.
14418 * @param int $second
14419 * @return DateTime
14420 * @since PHP 5 >= 5.2.0
14421 **/
14422function date_time_set($object, $hour, $minute, $second){}
14423
14424/**
14425 * Sets or gets the AUTOCOMMIT behavior of the specified connection
14426 * resource.
14427 *
14428 * @param resource $connection A valid database connection resource
14429 *   variable as returned from {@link db2_connect} or {@link
14430 *   db2_pconnect}.
14431 * @param bool $value One of the following constants:
14432 *   DB2_AUTOCOMMIT_OFF Turns AUTOCOMMIT off. DB2_AUTOCOMMIT_ON Turns
14433 *   AUTOCOMMIT on.
14434 * @return mixed
14435 * @since PECL ibm_db2 >= 1.0.0
14436 **/
14437function db2_autocommit($connection, $value){}
14438
14439/**
14440 * Binds a PHP variable to an SQL statement parameter in a statement
14441 * resource returned by {@link db2_prepare}. This function gives you more
14442 * control over the parameter type, data type, precision, and scale for
14443 * the parameter than simply passing the variable as part of the optional
14444 * input array to {@link db2_execute}.
14445 *
14446 * @param resource $stmt A prepared statement returned from {@link
14447 *   db2_prepare}.
14448 * @param int $parameternumber Specifies the 1-indexed position of the
14449 *   parameter in the prepared statement.
14450 * @param string $variablename A string specifying the name of the PHP
14451 *   variable to bind to the parameter specified by {@link
14452 *   parameter-number}.
14453 * @param int $parametertype A constant specifying whether the PHP
14454 *   variable should be bound to the SQL parameter as an input parameter
14455 *   (DB2_PARAM_IN), an output parameter (DB2_PARAM_OUT), or as a
14456 *   parameter that accepts input and returns output (DB2_PARAM_INOUT).
14457 *   To avoid memory overhead, you can also specify DB2_PARAM_FILE to
14458 *   bind the PHP variable to the name of a file that contains large
14459 *   object (BLOB, CLOB, or DBCLOB) data.
14460 * @param int $datatype A constant specifying the SQL data type that
14461 *   the PHP variable should be bound as: one of DB2_BINARY, DB2_CHAR,
14462 *   DB2_DOUBLE, or DB2_LONG .
14463 * @param int $precision Specifies the precision with which the
14464 *   variable should be bound to the database. This parameter can also be
14465 *   used for retrieving XML output values from stored procedures. A
14466 *   non-negative value specifies the maximum size of the XML data that
14467 *   will be retrieved from the database. If this parameter is not used,
14468 *   a default of 1MB will be assumed for retrieving the XML output value
14469 *   from the stored procedure.
14470 * @param int $scale Specifies the scale with which the variable should
14471 *   be bound to the database.
14472 * @return bool
14473 * @since PECL ibm_db2 >= 1.0.0
14474 **/
14475function db2_bind_param($stmt, $parameternumber, $variablename, $parametertype, $datatype, $precision, $scale){}
14476
14477/**
14478 * This function returns an object with read-only properties that return
14479 * information about the DB2 database client. The following table lists
14480 * the DB2 client properties: DB2 client properties Property name Return
14481 * type Description APPL_CODEPAGE int The application code page.
14482 * CONN_CODEPAGE int The code page for the current connection.
14483 * DATA_SOURCE_NAME string The data source name (DSN) used to create the
14484 * current connection to the database. DRIVER_NAME string The name of the
14485 * library that implements the DB2 Call Level Interface (CLI)
14486 * specification. DRIVER_ODBC_VER string The version of ODBC that the DB2
14487 * client supports. This returns a string "MM.mm" where MM is the major
14488 * version and mm is the minor version. The DB2 client always returns
14489 * "03.51". DRIVER_VER string The version of the client, in the form of a
14490 * string "MM.mm.uuuu" where MM is the major version, mm is the minor
14491 * version, and uuuu is the update. For example, "08.02.0001" represents
14492 * major version 8, minor version 2, update 1. ODBC_SQL_CONFORMANCE
14493 * string The level of ODBC SQL grammar supported by the client: MINIMUM
14494 * Supports the minimum ODBC SQL grammar. CORE Supports the core ODBC SQL
14495 * grammar. EXTENDED Supports extended ODBC SQL grammar. ODBC_VER string
14496 * The version of ODBC that the ODBC driver manager supports. This
14497 * returns a string "MM.mm.rrrr" where MM is the major version, mm is the
14498 * minor version, and rrrr is the release. The DB2 client always returns
14499 * "03.01.0000".
14500 *
14501 * @param resource $connection Specifies an active DB2 client
14502 *   connection.
14503 * @return object
14504 * @since PECL ibm_db2 >= 1.1.1
14505 **/
14506function db2_client_info($connection){}
14507
14508/**
14509 * This function closes a DB2 client connection created with {@link
14510 * db2_connect} and returns the corresponding resources to the database
14511 * server.
14512 *
14513 * If you attempt to close a persistent DB2 client connection created
14514 * with {@link db2_pconnect}, the close request is ignored and the
14515 * persistent DB2 client connection remains available for the next
14516 * caller.
14517 *
14518 * @param resource $connection Specifies an active DB2 client
14519 *   connection.
14520 * @return bool
14521 * @since PECL ibm_db2 >= 1.0.0
14522 **/
14523function db2_close($connection){}
14524
14525/**
14526 * Returns a result set listing the columns and associated metadata for a
14527 * table.
14528 *
14529 * @param resource $connection A valid connection to an IBM DB2,
14530 *   Cloudscape, or Apache Derby database.
14531 * @param string $qualifier A qualifier for DB2 databases running on
14532 *   OS/390 or z/OS servers. For other databases, pass or an empty
14533 *   string.
14534 * @param string $schema The schema which contains the tables. To match
14535 *   all schemas, pass '%'.
14536 * @param string $tablename The name of the table or view. To match all
14537 *   tables in the database, pass or an empty string.
14538 * @param string $columnname The name of the column. To match all
14539 *   columns in the table, pass or an empty string.
14540 * @return resource
14541 * @since PECL ibm_db2 >= 1.0.0
14542 **/
14543function db2_columns($connection, $qualifier, $schema, $tablename, $columnname){}
14544
14545/**
14546 * Returns a result set listing the columns and associated privileges for
14547 * a table.
14548 *
14549 * @param resource $connection A valid connection to an IBM DB2,
14550 *   Cloudscape, or Apache Derby database.
14551 * @param string $qualifier A qualifier for DB2 databases running on
14552 *   OS/390 or z/OS servers. For other databases, pass or an empty
14553 *   string.
14554 * @param string $schema The schema which contains the tables. To match
14555 *   all schemas, pass or an empty string.
14556 * @param string $tablename The name of the table or view. To match all
14557 *   tables in the database, pass or an empty string.
14558 * @param string $columnname The name of the column. To match all
14559 *   columns in the table, pass or an empty string.
14560 * @return resource
14561 * @since PECL ibm_db2 >= 1.0.0
14562 **/
14563function db2_column_privileges($connection, $qualifier, $schema, $tablename, $columnname){}
14564
14565/**
14566 * Commits an in-progress transaction on the specified connection
14567 * resource and begins a new transaction. PHP applications normally
14568 * default to AUTOCOMMIT mode, so {@link db2_commit} is not necessary
14569 * unless AUTOCOMMIT has been turned off for the connection resource.
14570 *
14571 * @param resource $connection A valid database connection resource
14572 *   variable as returned from {@link db2_connect} or {@link
14573 *   db2_pconnect}.
14574 * @return bool
14575 * @since PECL ibm_db2 >= 1.0.0
14576 **/
14577function db2_commit($connection){}
14578
14579/**
14580 * Creates a new connection to an IBM DB2 Universal Database, IBM
14581 * Cloudscape, or Apache Derby database.
14582 *
14583 * @param string $database For a cataloged connection to a database,
14584 *   {@link database} represents the database alias in the DB2 client
14585 *   catalog. For an uncataloged connection to a database, {@link
14586 *   database} represents a complete connection string in the following
14587 *   format: DATABASE={@link database};HOSTNAME={@link
14588 *   hostname};PORT={@link port};PROTOCOL=TCPIP;UID={@link
14589 *   username};PWD={@link password}; where the parameters represent the
14590 *   following values: {@link database} The name of the database. {@link
14591 *   hostname} The hostname or IP address of the database server. {@link
14592 *   port} The TCP/IP port on which the database is listening for
14593 *   requests. {@link username} The username with which you are
14594 *   connecting to the database. {@link password} The password with which
14595 *   you are connecting to the database.
14596 * @param string $username The name of the database.
14597 * @param string $password The hostname or IP address of the database
14598 *   server.
14599 * @param array $options The TCP/IP port on which the database is
14600 *   listening for requests.
14601 * @return resource
14602 * @since PECL ibm_db2 >= 1.0.0
14603 **/
14604function db2_connect($database, $username, $password, $options){}
14605
14606/**
14607 * {@link db2_conn_error} returns an SQLSTATE value representing the
14608 * reason the last attempt to connect to a database failed. As {@link
14609 * db2_connect} returns in the event of a failed connection attempt, you
14610 * do not pass any parameters to {@link db2_conn_error} to retrieve the
14611 * SQLSTATE value.
14612 *
14613 * If, however, the connection was successful but becomes invalid over
14614 * time, you can pass the {@link connection} parameter to retrieve the
14615 * SQLSTATE value for a specific connection.
14616 *
14617 * To learn what the SQLSTATE value means, you can issue the following
14618 * command at a DB2 Command Line Processor prompt: db2 '? {@link
14619 * sqlstate-value}'. You can also call {@link db2_conn_errormsg} to
14620 * retrieve an explicit error message and the associated SQLCODE value.
14621 *
14622 * @param resource $connection A connection resource associated with a
14623 *   connection that initially succeeded, but which over time became
14624 *   invalid.
14625 * @return string
14626 * @since PECL ibm_db2 >= 1.0.0
14627 **/
14628function db2_conn_error($connection){}
14629
14630/**
14631 * {@link db2_conn_errormsg} returns an error message and SQLCODE value
14632 * representing the reason the last database connection attempt failed.
14633 * As {@link db2_connect} returns in the event of a failed connection
14634 * attempt, do not pass any parameters to {@link db2_conn_errormsg} to
14635 * retrieve the associated error message and SQLCODE value.
14636 *
14637 * If, however, the connection was successful but becomes invalid over
14638 * time, you can pass the {@link connection} parameter to retrieve the
14639 * associated error message and SQLCODE value for a specific connection.
14640 *
14641 * @param resource $connection A connection resource associated with a
14642 *   connection that initially succeeded, but which over time became
14643 *   invalid.
14644 * @return string
14645 * @since PECL ibm_db2 >= 1.0.0
14646 **/
14647function db2_conn_errormsg($connection){}
14648
14649/**
14650 * Returns the cursor type used by a statement resource. Use this to
14651 * determine if you are working with a forward-only cursor or scrollable
14652 * cursor.
14653 *
14654 * @param resource $stmt A valid statement resource.
14655 * @return int
14656 * @since PECL ibm_db2 >= 1.0.0
14657 **/
14658function db2_cursor_type($stmt){}
14659
14660/**
14661 * Prepends backslashes to special characters in the string argument.
14662 *
14663 * @param string $string_literal The string that contains special
14664 *   characters that need to be modified. Characters that are prepended
14665 *   with a backslash are \x00, \n, \r, \, ', " and \x1a.
14666 * @return string
14667 * @since PECL ibm_db2 >= 1.6.0
14668 **/
14669function db2_escape_string($string_literal){}
14670
14671/**
14672 * Executes an SQL statement directly.
14673 *
14674 * If you plan to interpolate PHP variables into the SQL statement,
14675 * understand that this is one of the more common security exposures.
14676 * Consider calling {@link db2_prepare} to prepare an SQL statement with
14677 * parameter markers for input values. Then you can call {@link
14678 * db2_execute} to pass in the input values and avoid SQL injection
14679 * attacks.
14680 *
14681 * If you plan to repeatedly issue the same SQL statement with different
14682 * parameters, consider calling {@link db2_prepare} and {@link
14683 * db2_execute} to enable the database server to reuse its access plan
14684 * and increase the efficiency of your database access.
14685 *
14686 * @param resource $connection A valid database connection resource
14687 *   variable as returned from {@link db2_connect} or {@link
14688 *   db2_pconnect}.
14689 * @param string $statement An SQL statement. The statement cannot
14690 *   contain any parameter markers.
14691 * @param array $options An associative array containing statement
14692 *   options. You can use this parameter to request a scrollable cursor
14693 *   on database servers that support this functionality. For a
14694 *   description of valid statement options, see {@link db2_set_option}.
14695 * @return resource
14696 * @since PECL ibm_db2 >= 1.0.0
14697 **/
14698function db2_exec($connection, $statement, $options){}
14699
14700/**
14701 * {@link db2_execute} executes an SQL statement that was prepared by
14702 * {@link db2_prepare}.
14703 *
14704 * If the SQL statement returns a result set, for example, a SELECT
14705 * statement or a CALL to a stored procedure that returns one or more
14706 * result sets, you can retrieve a row as an array from the stmt resource
14707 * using {@link db2_fetch_assoc}, {@link db2_fetch_both}, or {@link
14708 * db2_fetch_array}. Alternatively, you can use {@link db2_fetch_row} to
14709 * move the result set pointer to the next row and fetch a column at a
14710 * time from that row with {@link db2_result}.
14711 *
14712 * Refer to {@link db2_prepare} for a brief discussion of the advantages
14713 * of using {@link db2_prepare} and {@link db2_execute} rather than
14714 * {@link db2_exec}.
14715 *
14716 * @param resource $stmt A prepared statement returned from {@link
14717 *   db2_prepare}.
14718 * @param array $parameters An array of input parameters matching any
14719 *   parameter markers contained in the prepared statement.
14720 * @return bool
14721 * @since PECL ibm_db2 >= 1.0.0
14722 **/
14723function db2_execute($stmt, $parameters){}
14724
14725/**
14726 * Returns an array, indexed by column position, representing a row in a
14727 * result set. The columns are 0-indexed.
14728 *
14729 * @param resource $stmt A valid stmt resource containing a result set.
14730 * @param int $row_number Requests a specific 1-indexed row from the
14731 *   result set. Passing this parameter results in a PHP warning if the
14732 *   result set uses a forward-only cursor.
14733 * @return array
14734 * @since PECL ibm_db2 >= 1.0.1
14735 **/
14736function db2_fetch_array($stmt, $row_number){}
14737
14738/**
14739 * Returns an array, indexed by column name, representing a row in a
14740 * result set.
14741 *
14742 * @param resource $stmt A valid stmt resource containing a result set.
14743 * @param int $row_number Requests a specific 1-indexed row from the
14744 *   result set. Passing this parameter results in a PHP warning if the
14745 *   result set uses a forward-only cursor.
14746 * @return array
14747 * @since PECL ibm_db2 >= 1.0.0
14748 **/
14749function db2_fetch_assoc($stmt, $row_number){}
14750
14751/**
14752 * Returns an array, indexed by both column name and position,
14753 * representing a row in a result set. Note that the row returned by
14754 * {@link db2_fetch_both} requires more memory than the single-indexed
14755 * arrays returned by {@link db2_fetch_assoc} or {@link db2_fetch_array}.
14756 *
14757 * @param resource $stmt A valid stmt resource containing a result set.
14758 * @param int $row_number Requests a specific 1-indexed row from the
14759 *   result set. Passing this parameter results in a PHP warning if the
14760 *   result set uses a forward-only cursor.
14761 * @return array
14762 * @since PECL ibm_db2 >= 1.0.0
14763 **/
14764function db2_fetch_both($stmt, $row_number){}
14765
14766/**
14767 * Returns an object in which each property represents a column returned
14768 * in the row fetched from a result set.
14769 *
14770 * @param resource $stmt A valid stmt resource containing a result set.
14771 * @param int $row_number Requests a specific 1-indexed row from the
14772 *   result set. Passing this parameter results in a PHP warning if the
14773 *   result set uses a forward-only cursor.
14774 * @return object
14775 * @since PECL ibm_db2 >= 1.0.0
14776 **/
14777function db2_fetch_object($stmt, $row_number){}
14778
14779/**
14780 * Use {@link db2_fetch_row} to iterate through a result set, or to point
14781 * to a specific row in a result set if you requested a scrollable
14782 * cursor.
14783 *
14784 * To retrieve individual fields from the result set, call the {@link
14785 * db2_result} function.
14786 *
14787 * Rather than calling {@link db2_fetch_row} and {@link db2_result}, most
14788 * applications will call one of {@link db2_fetch_assoc}, {@link
14789 * db2_fetch_both}, or {@link db2_fetch_array} to advance the result set
14790 * pointer and return a complete row as an array.
14791 *
14792 * @param resource $stmt A valid stmt resource.
14793 * @param int $row_number With scrollable cursors, you can request a
14794 *   specific row number in the result set. Row numbering is 1-indexed.
14795 * @return bool
14796 * @since PECL ibm_db2 >= 1.0.0
14797 **/
14798function db2_fetch_row($stmt, $row_number){}
14799
14800/**
14801 * Returns the maximum number of bytes required to display a column in a
14802 * result set.
14803 *
14804 * @param resource $stmt Specifies a statement resource containing a
14805 *   result set.
14806 * @param mixed $column Specifies the column in the result set. This
14807 *   can either be an integer representing the 0-indexed position of the
14808 *   column, or a string containing the name of the column.
14809 * @return int
14810 * @since PECL ibm_db2 >= 1.0.0
14811 **/
14812function db2_field_display_size($stmt, $column){}
14813
14814/**
14815 * Returns the name of the specified column in the result set.
14816 *
14817 * @param resource $stmt Specifies a statement resource containing a
14818 *   result set.
14819 * @param mixed $column Specifies the column in the result set. This
14820 *   can either be an integer representing the 0-indexed position of the
14821 *   column, or a string containing the name of the column.
14822 * @return string
14823 * @since PECL ibm_db2 >= 1.0.0
14824 **/
14825function db2_field_name($stmt, $column){}
14826
14827/**
14828 * Returns the position of the named column in a result set.
14829 *
14830 * @param resource $stmt Specifies a statement resource containing a
14831 *   result set.
14832 * @param mixed $column Specifies the column in the result set. This
14833 *   can either be an integer representing the 0-indexed position of the
14834 *   column, or a string containing the name of the column.
14835 * @return int
14836 * @since PECL ibm_db2 >= 1.0.0
14837 **/
14838function db2_field_num($stmt, $column){}
14839
14840/**
14841 * Returns the precision of the indicated column in a result set.
14842 *
14843 * @param resource $stmt Specifies a statement resource containing a
14844 *   result set.
14845 * @param mixed $column Specifies the column in the result set. This
14846 *   can either be an integer representing the 0-indexed position of the
14847 *   column, or a string containing the name of the column.
14848 * @return int
14849 * @since PECL ibm_db2 >= 1.0.0
14850 **/
14851function db2_field_precision($stmt, $column){}
14852
14853/**
14854 * Returns the scale of the indicated column in a result set.
14855 *
14856 * @param resource $stmt Specifies a statement resource containing a
14857 *   result set.
14858 * @param mixed $column Specifies the column in the result set. This
14859 *   can either be an integer representing the 0-indexed position of the
14860 *   column, or a string containing the name of the column.
14861 * @return int
14862 * @since PECL ibm_db2 >= 1.0.0
14863 **/
14864function db2_field_scale($stmt, $column){}
14865
14866/**
14867 * Returns the data type of the indicated column in a result set.
14868 *
14869 * @param resource $stmt Specifies a statement resource containing a
14870 *   result set.
14871 * @param mixed $column Specifies the column in the result set. This
14872 *   can either be an integer representing the 0-indexed position of the
14873 *   column, or a string containing the name of the column.
14874 * @return string
14875 * @since PECL ibm_db2 >= 1.0.0
14876 **/
14877function db2_field_type($stmt, $column){}
14878
14879/**
14880 * Returns the width of the current value of the indicated column in a
14881 * result set. This is the maximum width of the column for a fixed-length
14882 * data type, or the actual width of the column for a variable-length
14883 * data type.
14884 *
14885 * @param resource $stmt Specifies a statement resource containing a
14886 *   result set.
14887 * @param mixed $column Specifies the column in the result set. This
14888 *   can either be an integer representing the 0-indexed position of the
14889 *   column, or a string containing the name of the column.
14890 * @return int
14891 * @since PECL ibm_db2 >= 1.0.0
14892 **/
14893function db2_field_width($stmt, $column){}
14894
14895/**
14896 * Returns a result set listing the foreign keys for a table.
14897 *
14898 * @param resource $connection A valid connection to an IBM DB2,
14899 *   Cloudscape, or Apache Derby database.
14900 * @param string $qualifier A qualifier for DB2 databases running on
14901 *   OS/390 or z/OS servers. For other databases, pass or an empty
14902 *   string.
14903 * @param string $schema The schema which contains the tables. If
14904 *   {@link schema} is , {@link db2_foreign_keys} matches the schema for
14905 *   the current connection.
14906 * @param string $tablename The name of the table.
14907 * @return resource
14908 * @since PECL ibm_db2 >= 1.0.0
14909 **/
14910function db2_foreign_keys($connection, $qualifier, $schema, $tablename){}
14911
14912/**
14913 * Frees the system and database resources that are associated with a
14914 * result set. These resources are freed implicitly when a script
14915 * finishes, but you can call {@link db2_free_result} to explicitly free
14916 * the result set resources before the end of the script.
14917 *
14918 * @param resource $stmt A valid statement resource.
14919 * @return bool
14920 * @since PECL ibm_db2 >= 1.0.0
14921 **/
14922function db2_free_result($stmt){}
14923
14924/**
14925 * Frees the system and database resources that are associated with a
14926 * statement resource. These resources are freed implicitly when a script
14927 * finishes, but you can call {@link db2_free_stmt} to explicitly free
14928 * the statement resources before the end of the script.
14929 *
14930 * @param resource $stmt A valid statement resource.
14931 * @return bool
14932 * @since PECL ibm_db2 >= 1.0.0
14933 **/
14934function db2_free_stmt($stmt){}
14935
14936/**
14937 * Retrieves the value of a specified option value for a statement
14938 * resource or a connection resource.
14939 *
14940 * @param resource $resource A valid statement resource as returned
14941 *   from {@link db2_prepare} or a valid connection resource as returned
14942 *   from {@link db2_connect} or {@link db2_pconnect}.
14943 * @param string $option A valid statement or connection options. The
14944 *   following new options are available as of ibm_db2 version 1.6.0.
14945 *   They provide useful tracking information that can be set during
14946 *   execution with {@link db2_get_option}. Prior versions of ibm_db2 do
14947 *   not support these new options. When the value in each option is
14948 *   being set, some servers might not handle the entire length provided
14949 *   and might truncate the value. To ensure that the data specified in
14950 *   each option is converted correctly when transmitted to a host
14951 *   system, use only the characters A through Z, 0 through 9, and the
14952 *   underscore (_) or period (.). {@link userid} SQL_ATTR_INFO_USERID -
14953 *   A pointer to a null-terminated character string used to identify the
14954 *   client user ID sent to the host database server when using DB2
14955 *   Connect. DB2 for z/OS and OS/390 servers support up to a length of
14956 *   16 characters. This user-id is not to be confused with the
14957 *   authentication user-id, it is for identification purposes only and
14958 *   is not used for any authorization. {@link acctstr}
14959 *   SQL_ATTR_INFO_ACCTSTR - A pointer to a null-terminated character
14960 *   string used to identify the client accounting string sent to the
14961 *   host database server when using DB2 Connect. DB2 for z/OS and OS/390
14962 *   servers support up to a length of 200 characters. {@link applname}
14963 *   SQL_ATTR_INFO_APPLNAME - A pointer to a null-terminated character
14964 *   string used to identify the client application name sent to the host
14965 *   database server when using DB2 Connect. DB2 for z/OS and OS/390
14966 *   servers support up to a length of 32 characters. {@link wrkstnname}
14967 *   SQL_ATTR_INFO_WRKSTNNAME - A pointer to a null-terminated character
14968 *   string used to identify the client workstation name sent to the host
14969 *   database server when using DB2 Connect. DB2 for z/OS and OS/390
14970 *   servers support up to a length of 18 characters.
14971 * @return string
14972 * @since PECL ibm_db2 >= 1.6.0
14973 **/
14974function db2_get_option($resource, $option){}
14975
14976/**
14977 * Returns the auto generated ID of the last insert query that
14978 * successfully executed on this connection.
14979 *
14980 * The result of this function is not affected by any of the following: A
14981 * single row INSERT statement with a VALUES clause for a table without
14982 * an identity column. A multiple row INSERT statement with a VALUES
14983 * clause. An INSERT statement with a fullselect. A ROLLBACK TO SAVEPOINT
14984 * statement.
14985 *
14986 * @param resource $resource A valid connection resource as returned
14987 *   from {@link db2_connect} or {@link db2_pconnect}. The value of this
14988 *   parameter cannot be a statement resource or result set resource.
14989 * @return int
14990 * @since PECL ibm_db2 >= 1.7.1
14991 **/
14992function db2_last_insert_id($resource){}
14993
14994/**
14995 * Use {@link db2_lob_read} to iterate through a specified column of a
14996 * result set and retrieve a user defined size of LOB data.
14997 *
14998 * @param resource $stmt A valid stmt resource containing LOB data.
14999 * @param int $colnum A valid column number in the result set of the
15000 *   stmt resource.
15001 * @param int $length The size of the LOB data to be retrieved from the
15002 *   stmt resource.
15003 * @return string
15004 * @since PECL ibm_db2 >= 1.6.0
15005 **/
15006function db2_lob_read($stmt, $colnum, $length){}
15007
15008/**
15009 * A stored procedure can return zero or more result sets. While you
15010 * handle the first result set in exactly the same way you would handle
15011 * the results returned by a simple SELECT statement, to fetch the second
15012 * and subsequent result sets from a stored procedure you must call the
15013 * {@link db2_next_result} function and return the result to a uniquely
15014 * named PHP variable.
15015 *
15016 * @param resource $stmt A prepared statement returned from {@link
15017 *   db2_exec} or {@link db2_execute}.
15018 * @return resource
15019 * @since PECL ibm_db2 >= 1.0.0
15020 **/
15021function db2_next_result($stmt){}
15022
15023/**
15024 * Returns the number of fields contained in a result set. This is most
15025 * useful for handling the result sets returned by dynamically generated
15026 * queries, or for result sets returned by stored procedures, where your
15027 * application cannot otherwise know how to retrieve and use the results.
15028 *
15029 * @param resource $stmt A valid statement resource containing a result
15030 *   set.
15031 * @return int
15032 * @since PECL ibm_db2 >= 1.0.0
15033 **/
15034function db2_num_fields($stmt){}
15035
15036/**
15037 * Returns the number of rows deleted, inserted, or updated by an SQL
15038 * statement.
15039 *
15040 * To determine the number of rows that will be returned by a SELECT
15041 * statement, issue SELECT COUNT(*) with the same predicates as your
15042 * intended SELECT statement and retrieve the value.
15043 *
15044 * If your application logic checks the number of rows returned by a
15045 * SELECT statement and branches if the number of rows is 0, consider
15046 * modifying your application to attempt to return the first row with one
15047 * of {@link db2_fetch_assoc}, {@link db2_fetch_both}, {@link
15048 * db2_fetch_array}, or {@link db2_fetch_row}, and branch if the fetch
15049 * function returns .
15050 *
15051 * @param resource $stmt A valid stmt resource containing a result set.
15052 * @return int
15053 * @since PECL ibm_db2 >= 1.0.0
15054 **/
15055function db2_num_rows($stmt){}
15056
15057/**
15058 * This function closes a DB2 client connection created with {@link
15059 * db2_pconnect} and returns the corresponding resources to the database
15060 * server. This function is only available on i5/OS in response to i5/OS
15061 * system administration requests.
15062 *
15063 * If you have a persistent DB2 client connection created with {@link
15064 * db2_pconnect}, you may use this function to close the connection. To
15065 * avoid substantial connection performance penalties, this function
15066 * should only be used in rare cases when the persistent connection has
15067 * become unresponsive or the persistent connection will not be needed
15068 * for a long period of time.
15069 *
15070 * @param resource $resource Specifies an active DB2 client connection.
15071 * @return bool
15072 * @since PECL ibm_db2 >= 1.8.0
15073 **/
15074function db2_pclose($resource){}
15075
15076/**
15077 * Returns a persistent connection to an IBM DB2 Universal Database, IBM
15078 * Cloudscape, or Apache Derby database. For more information on
15079 * persistent connections, refer to .
15080 *
15081 * Calling {@link db2_close} on a persistent connection always returns ,
15082 * but the underlying DB2 client connection remains open and waiting to
15083 * serve the next matching {@link db2_pconnect} request.
15084 *
15085 * @param string $database The database alias in the DB2 client
15086 *   catalog.
15087 * @param string $username The username with which you are connecting
15088 *   to the database.
15089 * @param string $password The password with which you are connecting
15090 *   to the database.
15091 * @param array $options An associative array of connection options
15092 *   that affect the behavior of the connection, where valid array keys
15093 *   include: {@link autocommit} Passing the DB2_AUTOCOMMIT_ON value
15094 *   turns autocommit on for this connection handle. Passing the
15095 *   DB2_AUTOCOMMIT_OFF value turns autocommit off for this connection
15096 *   handle. {@link DB2_ATTR_CASE} Passing the DB2_CASE_NATURAL value
15097 *   specifies that column names are returned in natural case. Passing
15098 *   the DB2_CASE_LOWER value specifies that column names are returned in
15099 *   lower case. Passing the DB2_CASE_UPPER value specifies that column
15100 *   names are returned in upper case. {@link CURSOR} Passing the
15101 *   DB2_FORWARD_ONLY value specifies a forward-only cursor for a
15102 *   statement resource. This is the default cursor type and is supported
15103 *   on all database servers. Passing the DB2_SCROLLABLE value specifies
15104 *   a scrollable cursor for a statement resource. This mode enables
15105 *   random access to rows in a result set, but currently is supported
15106 *   only by IBM DB2 Universal Database. The following new option is
15107 *   available in ibm_db2 version 1.7.0 and later. {@link trustedcontext}
15108 *   Passing the DB2_TRUSTED_CONTEXT_ENABLE value turns trusted context
15109 *   on for this connection handle. This parameter cannot be set using
15110 *   {@link db2_set_option}. This key works only if the database is
15111 *   cataloged (even if the database is local), or if you specify the
15112 *   full DSN when you create the connection. To catalog the database,
15113 *   use following commands: db2 catalog tcpip node loopback remote
15114 *   <SERVERNAME> server <SERVICENAME> db2 catalog database <LOCALDBNAME>
15115 *   as <REMOTEDBNAME> at node loopback db2 "update dbm cfg using
15116 *   svcename <SERVICENAME>" db2set DB2COMM=TCPIP The following new i5/OS
15117 *   options are available in ibm_db2 version 1.5.1 and later.
15118 *   Conflicting connection attributes used in conjunction with
15119 *   persistent connections can produce indeterminate results on i5/OS.
15120 *   Site policies should be establish for all applications using each
15121 *   persistent connection user profile. The default DB2_AUTOCOMMIT_ON is
15122 *   suggested when using persistent connections. {@link i5_lib} A
15123 *   character value that indicates the default library that will be used
15124 *   for resolving unqualified file references. This is not valid if the
15125 *   connection is using system naming mode. {@link i5_naming}
15126 *   DB2_I5_NAMING_ON value turns on DB2 UDB CLI iSeries system naming
15127 *   mode. Files are qualified using the slash (/) delimiter. Unqualified
15128 *   files are resolved using the library list for the job.
15129 *   DB2_I5_NAMING_OFF value turns off DB2 UDB CLI default naming mode,
15130 *   which is SQL naming. Files are qualified using the period (.)
15131 *   delimiter. Unqualified files are resolved using either the default
15132 *   library or the current user ID. {@link i5_commit} The {@link
15133 *   i5_commit} attribute should be set before the {@link db2_pconnect}.
15134 *   If the value is changed after the connection has been established,
15135 *   and the connection is to a remote data source, the change does not
15136 *   take effect until the next successful {@link db2_pconnect} for the
15137 *   connection handle. The php.ini setting {@link
15138 *   ibm_db2.i5_allow_commit}==0 or DB2_I5_TXN_NO_COMMIT is the default,
15139 *   but may be overridden with the {@link i5_commit} option.
15140 *   DB2_I5_TXN_NO_COMMIT - Commitment control is not used.
15141 *   DB2_I5_TXN_READ_UNCOMMITTED - Dirty reads, nonrepeatable reads, and
15142 *   phantoms are possible. DB2_I5_TXN_READ_COMMITTED - Dirty reads are
15143 *   not possible. Nonrepeatable reads, and phantoms are possible.
15144 *   DB2_I5_TXN_REPEATABLE_READ - Dirty reads and nonrepeatable reads are
15145 *   not possible. Phantoms are possible. DB2_I5_TXN_SERIALIZABLE -
15146 *   Transactions are serializable. Dirty reads, non-repeatable reads,
15147 *   and phantoms are not possible {@link i5_query_optimize} DB2_FIRST_IO
15148 *   All queries are optimized with the goal of returning the first page
15149 *   of output as fast as possible. This goal works well when the output
15150 *   is controlled by a user who is most likely to cancel the query after
15151 *   viewing the first page of output data. Queries coded with an
15152 *   OPTIMIZE FOR nnn ROWS clause honor the goal specified by the clause.
15153 *   DB2_ALL_IO All queries are optimized with the goal of running the
15154 *   entire query to completion in the shortest amount of elapsed time.
15155 *   This is a good option when the output of a query is being written to
15156 *   a file or report, or the interface is queuing the output data.
15157 *   Queries coded with an OPTIMIZE FOR nnn ROWS clause honor the goal
15158 *   specified by the clause. This is the default. {@link i5_dbcs_alloc}
15159 *   DB2_I5_DBCS_ALLOC_ON value turns on DB2 6X allocation scheme for
15160 *   DBCS translation column size growth. DB2_I5_DBCS_ALLOC_OFF value
15161 *   turns off DB2 6X allocation scheme for DBCS translation column size
15162 *   growth. The php.ini setting {@link ibm_db2.i5_dbcs_alloc}==0 or
15163 *   DB2_I5_DBCS_ALLOC_OFF is the default, but may be overridden with the
15164 *   {@link i5_dbcs_alloc} option. {@link i5_date_fmt} DB2_I5_FMT_ISO -
15165 *   The International Organization for Standardization (ISO) date format
15166 *   yyyy-mm-dd is used. This is the default. DB2_I5_FMT_USA - The United
15167 *   States date format mm/dd/yyyy is used. DB2_I5_FMT_EUR - The European
15168 *   date format dd.mm.yyyy is used. DB2_I5_FMT_JIS - The Japanese
15169 *   Industrial Standard date format yyyy-mm-dd is used. DB2_I5_FMT_MDY -
15170 *   The date format mm/dd/yyyy is used. DB2_I5_FMT_DMY - The date format
15171 *   dd/mm/yyyy is used. DB2_I5_FMT_YMD - The date format yy/mm/dd is
15172 *   used. DB2_I5_FMT_JUL - The Julian date format yy/ddd is used.
15173 *   DB2_I5_FMT_JOB - The job default is used. {@link i5_date_sep}
15174 *   DB2_I5_SEP_SLASH - A slash ( / ) is used as the date separator. This
15175 *   is the default. DB2_I5_SEP_DASH - A dash ( - ) is used as the date
15176 *   separator. DB2_I5_SEP_PERIOD - A period ( . ) is used as the date
15177 *   separator. DB2_I5_SEP_COMMA - A comma ( , ) is used as the date
15178 *   separator. DB2_I5_SEP_BLANK - A blank is used as the date separator.
15179 *   DB2_I5_SEP_JOB - The job default is used {@link i5_time_fmt}
15180 *   DB2_I5_FMT_ISO - The International Organization for Standardization
15181 *   (ISO) time format hh.mm.ss is used. This is the default.
15182 *   DB2_I5_FMT_USA - The United States time format hh:mmxx is used,
15183 *   where xx is AM or PM. DB2_I5_FMT_EUR - The European time format
15184 *   hh.mm.ss is used. DB2_I5_FMT_JIS - The Japanese Industrial Standard
15185 *   time format hh:mm:ss is used. DB2_I5_FMT_HMS - The hh:mm:ss format
15186 *   is used. {@link i5_time_sep} DB2_I5_SEP_COLON - A colon ( : ) is
15187 *   used as the time separator. This is the default. DB2_I5_SEP_PERIOD -
15188 *   A period ( . ) is used as the time separator. DB2_I5_SEP_COMMA - A
15189 *   comma ( , ) is used as the time separator. DB2_I5_SEP_BLANK - A
15190 *   blank is used as the time separator. DB2_I5_SEP_JOB - The job
15191 *   default is used. {@link i5_decimal_sep} DB2_I5_SEP_PERIOD - A period
15192 *   ( . ) is used as the decimal separator. This is the default.
15193 *   DB2_I5_SEP_COMMA - A comma ( , ) is used as the decimal separator.
15194 *   DB2_I5_SEP_JOB - The job default is used. The following new i5/OS
15195 *   option is available in ibm_db2 version 1.8.0 and later. {@link
15196 *   i5_libl} A character value that indicates the library list that will
15197 *   be used for resolving unqualified file references. Specify the
15198 *   library list elements separated by blanks 'i5_libl'=>"MYLIB YOURLIB
15199 *   ANYLIB". i5_libl calls qsys2/qcmdexc('cmd',cmdlen), which is only
15200 *   available in i5/OS V5R4 and later.
15201 * @return resource
15202 * @since PECL ibm_db2 >= 1.0.0
15203 **/
15204function db2_pconnect($database, $username, $password, $options){}
15205
15206/**
15207 * {@link db2_prepare} creates a prepared SQL statement which can include
15208 * 0 or more parameter markers (? characters) representing parameters for
15209 * input, output, or input/output. You can pass parameters to the
15210 * prepared statement using {@link db2_bind_param}, or for input values
15211 * only, as an array passed to {@link db2_execute}.
15212 *
15213 * There are three main advantages to using prepared statements in your
15214 * application: Performance: when you prepare a statement, the database
15215 * server creates an optimized access plan for retrieving data with that
15216 * statement. Subsequently issuing the prepared statement with {@link
15217 * db2_execute} enables the statements to reuse that access plan and
15218 * avoids the overhead of dynamically creating a new access plan for
15219 * every statement you issue. Security: when you prepare a statement, you
15220 * can include parameter markers for input values. When you execute a
15221 * prepared statement with input values for placeholders, the database
15222 * server checks each input value to ensure that the type matches the
15223 * column definition or parameter definition. Advanced functionality:
15224 * Parameter markers not only enable you to pass input values to prepared
15225 * SQL statements, they also enable you to retrieve OUT and INOUT
15226 * parameters from stored procedures using {@link db2_bind_param}.
15227 *
15228 * @param resource $connection A valid database connection resource
15229 *   variable as returned from {@link db2_connect} or {@link
15230 *   db2_pconnect}.
15231 * @param string $statement An SQL statement, optionally containing one
15232 *   or more parameter markers..
15233 * @param array $options An associative array containing statement
15234 *   options. You can use this parameter to request a scrollable cursor
15235 *   on database servers that support this functionality. For a
15236 *   description of valid statement options, see {@link db2_set_option}.
15237 * @return resource
15238 * @since PECL ibm_db2 >= 1.0.0
15239 **/
15240function db2_prepare($connection, $statement, $options){}
15241
15242/**
15243 * Returns a result set listing the primary keys for a table.
15244 *
15245 * @param resource $connection A valid connection to an IBM DB2,
15246 *   Cloudscape, or Apache Derby database.
15247 * @param string $qualifier A qualifier for DB2 databases running on
15248 *   OS/390 or z/OS servers. For other databases, pass or an empty
15249 *   string.
15250 * @param string $schema The schema which contains the tables. If
15251 *   {@link schema} is , {@link db2_primary_keys} matches the schema for
15252 *   the current connection.
15253 * @param string $tablename The name of the table.
15254 * @return resource
15255 * @since PECL ibm_db2 >= 1.0.0
15256 **/
15257function db2_primary_keys($connection, $qualifier, $schema, $tablename){}
15258
15259/**
15260 * Returns a result set listing the stored procedures registered in a
15261 * database.
15262 *
15263 * @param resource $connection A valid connection to an IBM DB2,
15264 *   Cloudscape, or Apache Derby database.
15265 * @param string $qualifier A qualifier for DB2 databases running on
15266 *   OS/390 or z/OS servers. For other databases, pass or an empty
15267 *   string.
15268 * @param string $schema The schema which contains the procedures. This
15269 *   parameter accepts a search pattern containing _ and % as wildcards.
15270 * @param string $procedure The name of the procedure. This parameter
15271 *   accepts a search pattern containing _ and % as wildcards.
15272 * @return resource
15273 * @since PECL ibm_db2 >= 1.0.0
15274 **/
15275function db2_procedures($connection, $qualifier, $schema, $procedure){}
15276
15277/**
15278 * Returns a result set listing the parameters for one or more stored
15279 * procedures.
15280 *
15281 * @param resource $connection A valid connection to an IBM DB2,
15282 *   Cloudscape, or Apache Derby database.
15283 * @param string $qualifier A qualifier for DB2 databases running on
15284 *   OS/390 or z/OS servers. For other databases, pass or an empty
15285 *   string.
15286 * @param string $schema The schema which contains the procedures. This
15287 *   parameter accepts a search pattern containing _ and % as wildcards.
15288 * @param string $procedure The name of the procedure. This parameter
15289 *   accepts a search pattern containing _ and % as wildcards.
15290 * @param string $parameter The name of the parameter. This parameter
15291 *   accepts a search pattern containing _ and % as wildcards. If this
15292 *   parameter is , all parameters for the specified stored procedures
15293 *   are returned.
15294 * @return resource
15295 * @since PECL ibm_db2 >= 1.0.0
15296 **/
15297function db2_procedure_columns($connection, $qualifier, $schema, $procedure, $parameter){}
15298
15299/**
15300 * Use {@link db2_result} to return the value of a specified column in
15301 * the current row of a result set. You must call {@link db2_fetch_row}
15302 * before calling {@link db2_result} to set the location of the result
15303 * set pointer.
15304 *
15305 * @param resource $stmt A valid stmt resource.
15306 * @param mixed $column Either an integer mapping to the 0-indexed
15307 *   field in the result set, or a string matching the name of the
15308 *   column.
15309 * @return mixed
15310 * @since PECL ibm_db2 >= 1.0.0
15311 **/
15312function db2_result($stmt, $column){}
15313
15314/**
15315 * Rolls back an in-progress transaction on the specified connection
15316 * resource and begins a new transaction. PHP applications normally
15317 * default to AUTOCOMMIT mode, so {@link db2_rollback} normally has no
15318 * effect unless AUTOCOMMIT has been turned off for the connection
15319 * resource.
15320 *
15321 * @param resource $connection A valid database connection resource
15322 *   variable as returned from {@link db2_connect} or {@link
15323 *   db2_pconnect}.
15324 * @return bool
15325 * @since PECL ibm_db2 >= 1.0.0
15326 **/
15327function db2_rollback($connection){}
15328
15329/**
15330 * This function returns an object with read-only properties that return
15331 * information about the IBM DB2, Cloudscape, or Apache Derby database
15332 * server. The following table lists the database server properties:
15333 * Database server properties Property name Return type Description
15334 * DBMS_NAME string The name of the database server to which you are
15335 * connected. For DB2 servers this is a combination of DB2 followed by
15336 * the operating system on which the database server is running. DBMS_VER
15337 * string The version of the database server, in the form of a string
15338 * "MM.mm.uuuu" where MM is the major version, mm is the minor version,
15339 * and uuuu is the update. For example, "08.02.0001" represents major
15340 * version 8, minor version 2, update 1. DB_CODEPAGE int The code page of
15341 * the database to which you are connected. DB_NAME string The name of
15342 * the database to which you are connected. DFT_ISOLATION string The
15343 * default transaction isolation level supported by the server: UR
15344 * Uncommitted read: changes are immediately visible by all concurrent
15345 * transactions. CS Cursor stability: a row read by one transaction can
15346 * be altered and committed by a second concurrent transaction. RS Read
15347 * stability: a transaction can add or remove rows matching a search
15348 * condition or a pending transaction. RR Repeatable read: data affected
15349 * by pending transaction is not available to other transactions. NC No
15350 * commit: any changes are visible at the end of a successful operation.
15351 * Explicit commits and rollbacks are not allowed. IDENTIFIER_QUOTE_CHAR
15352 * string The character used to delimit an identifier. INST_NAME string
15353 * The instance on the database server that contains the database.
15354 * ISOLATION_OPTION array An array of the isolation options supported by
15355 * the database server. The isolation options are described in the
15356 * DFT_ISOLATION property. KEYWORDS array An array of the keywords
15357 * reserved by the database server. LIKE_ESCAPE_CLAUSE bool if the
15358 * database server supports the use of % and _ wildcard characters. if
15359 * the database server does not support these wildcard characters.
15360 * MAX_COL_NAME_LEN int Maximum length of a column name supported by the
15361 * database server, expressed in bytes. MAX_IDENTIFIER_LEN int Maximum
15362 * length of an SQL identifier supported by the database server,
15363 * expressed in characters. MAX_INDEX_SIZE int Maximum size of columns
15364 * combined in an index supported by the database server, expressed in
15365 * bytes. MAX_PROC_NAME_LEN int Maximum length of a procedure name
15366 * supported by the database server, expressed in bytes. MAX_ROW_SIZE int
15367 * Maximum length of a row in a base table supported by the database
15368 * server, expressed in bytes. MAX_SCHEMA_NAME_LEN int Maximum length of
15369 * a schema name supported by the database server, expressed in bytes.
15370 * MAX_STATEMENT_LEN int Maximum length of an SQL statement supported by
15371 * the database server, expressed in bytes. MAX_TABLE_NAME_LEN int
15372 * Maximum length of a table name supported by the database server,
15373 * expressed in bytes. NON_NULLABLE_COLUMNS bool if the database server
15374 * supports columns that can be defined as NOT NULL, if the database
15375 * server does not support columns defined as NOT NULL. PROCEDURES bool
15376 * if the database server supports the use of the CALL statement to call
15377 * stored procedures, if the database server does not support the CALL
15378 * statement. SPECIAL_CHARS string A string containing all of the
15379 * characters other than a-Z, 0-9, and underscore that can be used in an
15380 * identifier name. SQL_CONFORMANCE string The level of conformance to
15381 * the ANSI/ISO SQL-92 specification offered by the database server:
15382 * ENTRY Entry-level SQL-92 compliance. FIPS127 FIPS-127-2 transitional
15383 * compliance. FULL Full level SQL-92 compliance. INTERMEDIATE
15384 * Intermediate level SQL-92 compliance.
15385 *
15386 * @param resource $connection Specifies an active DB2 client
15387 *   connection.
15388 * @return object
15389 * @since PECL ibm_db2 >= 1.1.1
15390 **/
15391function db2_server_info($connection){}
15392
15393/**
15394 * Sets options for a statement resource or a connection resource. You
15395 * cannot set options for result set resources.
15396 *
15397 * @param resource $resource A valid statement resource as returned
15398 *   from {@link db2_prepare} or a valid connection resource as returned
15399 *   from {@link db2_connect} or {@link db2_pconnect}.
15400 * @param array $options An associative array containing valid
15401 *   statement or connection options. This parameter can be used to
15402 *   change autocommit values, cursor types (scrollable or forward), and
15403 *   to specify the case of the column names (lower, upper, or natural)
15404 *   that will appear in a result set. {@link autocommit} Passing
15405 *   DB2_AUTOCOMMIT_ON turns autocommit on for the specified connection
15406 *   resource. Passing DB2_AUTOCOMMIT_OFF turns autocommit off for the
15407 *   specified connection resource. {@link cursor} Passing
15408 *   DB2_FORWARD_ONLY specifies a forward-only cursor for a statement
15409 *   resource. This is the default cursor type, and is supported by all
15410 *   database servers. Passing DB2_SCROLLABLE specifies a scrollable
15411 *   cursor for a statement resource. Scrollable cursors enable result
15412 *   set rows to be accessed in non-sequential order, but are only
15413 *   supported by IBM DB2 Universal Database databases. {@link binmode}
15414 *   Passing DB2_BINARY specifies that binary data will be returned as
15415 *   is. This is the default mode. This is the equivalent of setting
15416 *   ibm_db2.binmode=1 in . Passing DB2_CONVERT specifies that binary
15417 *   data will be converted to hexadecimal encoding, and will be returned
15418 *   as such. This is the equivalent of setting ibm_db2.binmode=2 in .
15419 *   Passing DB2_PASSTHRU specifies that binary data will be converted to
15420 *   . This is the equivalent of setting ibm_db2.binmode=3 in . {@link
15421 *   db2_attr_case} Passing DB2_CASE_LOWER specifies that column names of
15422 *   the result set are returned in lower case. Passing DB2_CASE_UPPER
15423 *   specifies that column names of the result set are returned in upper
15424 *   case. Passing DB2_CASE_NATURAL specifies that column names of the
15425 *   result set are returned in natural case. {@link deferred_prepare}
15426 *   Passing DB2_DEFERRED_PREPARE_ON turns deferred prepare on for the
15427 *   specified statement resource. Passing DB2_DEFERRED_PREPARE_OFF turns
15428 *   deferred prepare off for the specified statement resource. The
15429 *   following new i5/OS options are available in ibm_db2 version 1.5.1
15430 *   and later. These options apply only when running PHP and ibm_db2
15431 *   natively on i5 systems. {@link i5_fetch_only} DB2_I5_FETCH_ON -
15432 *   Cursors are read-only and cannot be used for positioned updates or
15433 *   deletes. This is the default unless SQL_ATTR_FOR_FETCH_ONLY
15434 *   environment has been set to SQL_FALSE. DB2_I5_FETCH_OFF - Cursors
15435 *   can be used for positioned updates and deletes. The following new
15436 *   option is available in ibm_db2 version 1.8.0 and later. {@link
15437 *   rowcount} DB2_ROWCOUNT_PREFETCH_ON - Client can request the full row
15438 *   count prior to fetching, which means that {@link db2_num_rows}
15439 *   returns the number of rows selected even when a ROLLFORWARD_ONLY
15440 *   cursor is used. DB2_ROWCOUNT_PREFETCH_OFF - Client cannot request
15441 *   the full row count prior to fetching. The following new options are
15442 *   available in ibm_db2 version 1.7.0 and later. {@link trusted_user}
15443 *   To switch the user to a trusted user, pass the User ID (String) of
15444 *   the trusted user as the value of this key. This option can be set on
15445 *   a connection resource only. To use this option, trusted context must
15446 *   be enabled on the connection resource. {@link trusted_password} The
15447 *   password (String) that corresponds to the user specified by the
15448 *   trusted_user key. The following new options are available in ibm_db2
15449 *   version 1.6.0 and later. These options provide useful tracking
15450 *   information that can be accessed during execution with {@link
15451 *   db2_get_option}. When the value in each option is being set, some
15452 *   servers might not handle the entire length provided and might
15453 *   truncate the value. To ensure that the data specified in each option
15454 *   is converted correctly when transmitted to a host system, use only
15455 *   the characters A through Z, 0 through 9, and the underscore (_) or
15456 *   period (.). {@link userid} SQL_ATTR_INFO_USERID - A pointer to a
15457 *   null-terminated character string used to identify the client user ID
15458 *   sent to the host database server when using DB2 Connect. DB2 for
15459 *   z/OS and OS/390 servers support up to a length of 16 characters.
15460 *   This user-id is not to be confused with the authentication user-id,
15461 *   it is for identification purposes only and is not used for any
15462 *   authorization. {@link acctstr} SQL_ATTR_INFO_ACCTSTR - A pointer to
15463 *   a null-terminated character string used to identify the client
15464 *   accounting string sent to the host database server when using DB2
15465 *   Connect. DB2 for z/OS and OS/390 servers support up to a length of
15466 *   200 characters. {@link applname} SQL_ATTR_INFO_APPLNAME - A pointer
15467 *   to a null-terminated character string used to identify the client
15468 *   application name sent to the host database server when using DB2
15469 *   Connect. DB2 for z/OS and OS/390 servers support up to a length of
15470 *   32 characters. {@link wrkstnname} SQL_ATTR_INFO_WRKSTNNAME - A
15471 *   pointer to a null-terminated character string used to identify the
15472 *   client workstation name sent to the host database server when using
15473 *   DB2 Connect. DB2 for z/OS and OS/390 servers support up to a length
15474 *   of 18 characters.
15475 * @param int $type Passing DB2_AUTOCOMMIT_ON turns autocommit on for
15476 *   the specified connection resource. Passing DB2_AUTOCOMMIT_OFF turns
15477 *   autocommit off for the specified connection resource.
15478 * @return bool
15479 * @since PECL ibm_db2 >= 1.0.0
15480 **/
15481function db2_set_option($resource, $options, $type){}
15482
15483/**
15484 * Returns a result set listing the unique row identifier columns for a
15485 * table.
15486 *
15487 * @param resource $connection A valid connection to an IBM DB2,
15488 *   Cloudscape, or Apache Derby database.
15489 * @param string $qualifier A qualifier for DB2 databases running on
15490 *   OS/390 or z/OS servers. For other databases, pass or an empty
15491 *   string.
15492 * @param string $schema The schema which contains the tables.
15493 * @param string $table_name The name of the table.
15494 * @param int $scope Integer value representing the minimum duration
15495 *   for which the unique row identifier is valid. This can be one of the
15496 *   following values: Integer value SQL constant Description 0
15497 *   SQL_SCOPE_CURROW Row identifier is valid only while the cursor is
15498 *   positioned on the row. 1 SQL_SCOPE_TRANSACTION Row identifier is
15499 *   valid for the duration of the transaction. 2 SQL_SCOPE_SESSION Row
15500 *   identifier is valid for the duration of the connection.
15501 * @return resource
15502 * @since PECL ibm_db2 >= 1.0.0
15503 **/
15504function db2_special_columns($connection, $qualifier, $schema, $table_name, $scope){}
15505
15506/**
15507 * Returns a result set listing the index and statistics for a table.
15508 *
15509 * @param resource $connection A valid connection to an IBM DB2,
15510 *   Cloudscape, or Apache Derby database.
15511 * @param string $qualifier A qualifier for DB2 databases running on
15512 *   OS/390 or z/OS servers. For other databases, pass or an empty
15513 *   string.
15514 * @param string $schema The schema that contains the targeted table.
15515 *   If this parameter is , the statistics and indexes are returned for
15516 *   the schema of the current user.
15517 * @param string $tablename The name of the table.
15518 * @param bool $unique An integer value representing the type of index
15519 *   information to return. {@link 0} Return only the information for
15520 *   unique indexes on the table. {@link 1} Return the information for
15521 *   all indexes on the table.
15522 * @return resource
15523 * @since PECL ibm_db2 >= 1.0.0
15524 **/
15525function db2_statistics($connection, $qualifier, $schema, $tablename, $unique){}
15526
15527/**
15528 * Returns a string containing the SQLSTATE value returned by an SQL
15529 * statement.
15530 *
15531 * If you do not pass a statement resource as an argument to {@link
15532 * db2_stmt_error}, the driver returns the SQLSTATE value associated with
15533 * the last attempt to return a statement resource, for example, from
15534 * {@link db2_prepare} or {@link db2_exec}.
15535 *
15536 * To learn what the SQLSTATE value means, you can issue the following
15537 * command at a DB2 Command Line Processor prompt: db2 '? {@link
15538 * sqlstate-value}'. You can also call {@link db2_stmt_errormsg} to
15539 * retrieve an explicit error message and the associated SQLCODE value.
15540 *
15541 * @param resource $stmt A valid statement resource.
15542 * @return string
15543 * @since PECL ibm_db2 >= 1.0.0
15544 **/
15545function db2_stmt_error($stmt){}
15546
15547/**
15548 * Returns a string containing the last SQL statement error message.
15549 *
15550 * If you do not pass a statement resource as an argument to {@link
15551 * db2_stmt_errormsg}, the driver returns the error message associated
15552 * with the last attempt to return a statement resource, for example,
15553 * from {@link db2_prepare} or {@link db2_exec}.
15554 *
15555 * @param resource $stmt A valid statement resource.
15556 * @return string
15557 * @since PECL ibm_db2 >= 1.0.0
15558 **/
15559function db2_stmt_errormsg($stmt){}
15560
15561/**
15562 * Returns a result set listing the tables and associated metadata in a
15563 * database.
15564 *
15565 * @param resource $connection A valid connection to an IBM DB2,
15566 *   Cloudscape, or Apache Derby database.
15567 * @param string $qualifier A qualifier for DB2 databases running on
15568 *   OS/390 or z/OS servers. For other databases, pass or an empty
15569 *   string.
15570 * @param string $schema The schema which contains the tables. This
15571 *   parameter accepts a search pattern containing _ and % as wildcards.
15572 * @param string $tablename The name of the table. This parameter
15573 *   accepts a search pattern containing _ and % as wildcards.
15574 * @param string $tabletype A list of comma-delimited table type
15575 *   identifiers. To match all table types, pass or an empty string.
15576 *   Valid table type identifiers include: ALIAS, HIERARCHY TABLE,
15577 *   INOPERATIVE VIEW, NICKNAME, MATERIALIZED QUERY TABLE, SYSTEM TABLE,
15578 *   TABLE, TYPED TABLE, TYPED VIEW, and VIEW.
15579 * @return resource
15580 * @since PECL ibm_db2 >= 1.0.0
15581 **/
15582function db2_tables($connection, $qualifier, $schema, $tablename, $tabletype){}
15583
15584/**
15585 * Returns a result set listing the tables and associated privileges in a
15586 * database.
15587 *
15588 * @param resource $connection A valid connection to an IBM DB2,
15589 *   Cloudscape, or Apache Derby database.
15590 * @param string $qualifier A qualifier for DB2 databases running on
15591 *   OS/390 or z/OS servers. For other databases, pass or an empty
15592 *   string.
15593 * @param string $schema The schema which contains the tables. This
15594 *   parameter accepts a search pattern containing _ and % as wildcards.
15595 * @param string $table_name The name of the table. This parameter
15596 *   accepts a search pattern containing _ and % as wildcards.
15597 * @return resource
15598 * @since PECL ibm_db2 >= 1.0.0
15599 **/
15600function db2_table_privileges($connection, $qualifier, $schema, $table_name){}
15601
15602/**
15603 * Adds the given data to the database.
15604 *
15605 * @param int $dbase_identifier The database link identifier, returned
15606 *   by {@link dbase_open} or {@link dbase_create}.
15607 * @param array $record An indexed array of data. The number of items
15608 *   must be equal to the number of fields in the database, otherwise
15609 *   {@link dbase_add_record} will fail.
15610 * @return bool
15611 * @since PHP 4, PHP 5
15612 **/
15613function dbase_add_record($dbase_identifier, $record){}
15614
15615/**
15616 * Closes the given database link identifier.
15617 *
15618 * @param int $dbase_identifier The database link identifier, returned
15619 *   by {@link dbase_open} or {@link dbase_create}.
15620 * @return bool
15621 * @since PHP 4, PHP 5
15622 **/
15623function dbase_close($dbase_identifier){}
15624
15625/**
15626 * {@link dbase_create} creates a dBase database with the given
15627 * definition.
15628 *
15629 * @param string $filename The name of the database. It can be a
15630 *   relative or absolute path to the file where dBase will store your
15631 *   data.
15632 * @param array $fields An array of arrays, each array describing the
15633 *   format of one field of the database. Each field consists of a name,
15634 *   a character indicating the field type, and optionally, a length, and
15635 *   a precision.
15636 * @return int
15637 * @since PHP 4, PHP 5
15638 **/
15639function dbase_create($filename, $fields){}
15640
15641/**
15642 * Marks the given record to be deleted from the database.
15643 *
15644 * @param int $dbase_identifier The database link identifier, returned
15645 *   by {@link dbase_open} or {@link dbase_create}.
15646 * @param int $record_number An integer which spans from 1 to the
15647 *   number of records in the database (as returned by {@link
15648 *   dbase_numrecords}).
15649 * @return bool
15650 * @since PHP 4, PHP 5
15651 **/
15652function dbase_delete_record($dbase_identifier, $record_number){}
15653
15654/**
15655 * Returns information on the column structure of the given database link
15656 * identifier.
15657 *
15658 * @param int $dbase_identifier The database link identifier, returned
15659 *   by {@link dbase_open} or {@link dbase_create}.
15660 * @return array
15661 * @since PHP 5
15662 **/
15663function dbase_get_header_info($dbase_identifier){}
15664
15665/**
15666 * Gets a record from a database as an indexed array.
15667 *
15668 * @param int $dbase_identifier The database link identifier, returned
15669 *   by {@link dbase_open} or {@link dbase_create}.
15670 * @param int $record_number The index of the record.
15671 * @return array
15672 * @since PHP 4, PHP 5
15673 **/
15674function dbase_get_record($dbase_identifier, $record_number){}
15675
15676/**
15677 * Gets a record from a dBase database as an associative array.
15678 *
15679 * @param int $dbase_identifier The database link identifier, returned
15680 *   by {@link dbase_open} or {@link dbase_create}.
15681 * @param int $record_number The index of the record.
15682 * @return array
15683 * @since PHP 4, PHP 5
15684 **/
15685function dbase_get_record_with_names($dbase_identifier, $record_number){}
15686
15687/**
15688 * Gets the number of fields (columns) in the specified database.
15689 *
15690 * @param int $dbase_identifier The database link identifier, returned
15691 *   by {@link dbase_open} or {@link dbase_create}.
15692 * @return int
15693 * @since PHP 4, PHP 5
15694 **/
15695function dbase_numfields($dbase_identifier){}
15696
15697/**
15698 * Gets the number of records (rows) in the specified database.
15699 *
15700 * @param int $dbase_identifier The database link identifier, returned
15701 *   by {@link dbase_open} or {@link dbase_create}.
15702 * @return int
15703 * @since PHP 4, PHP 5
15704 **/
15705function dbase_numrecords($dbase_identifier){}
15706
15707/**
15708 * {@link dbase_open} opens a dBase database with the given access mode.
15709 *
15710 * @param string $filename The name of the database. It can be a
15711 *   relative or absolute path to the file where dBase will store your
15712 *   data.
15713 * @param int $mode An integer which correspond to those for the open()
15714 *   system call (Typically 0 means read-only, 1 means write-only, and 2
15715 *   means read and write).
15716 * @return int
15717 * @since PHP 4, PHP 5
15718 **/
15719function dbase_open($filename, $mode){}
15720
15721/**
15722 * Packs the specified database by permanently deleting all records
15723 * marked for deletion using {@link dbase_delete_record}.
15724 *
15725 * @param int $dbase_identifier The database link identifier, returned
15726 *   by {@link dbase_open} or {@link dbase_create}.
15727 * @return bool
15728 * @since PHP 4, PHP 5
15729 **/
15730function dbase_pack($dbase_identifier){}
15731
15732/**
15733 * Replaces the given record in the database with the given data.
15734 *
15735 * @param int $dbase_identifier The database link identifier, returned
15736 *   by {@link dbase_open} or {@link dbase_create}.
15737 * @param array $record An indexed array of data. The number of items
15738 *   must be equal to the number of fields in the database, otherwise
15739 *   {@link dbase_replace_record} will fail.
15740 * @param int $record_number An integer which spans from 1 to the
15741 *   number of records in the database (as returned by {@link
15742 *   dbase_numrecords}).
15743 * @return bool
15744 * @since PHP 4, PHP 5
15745 **/
15746function dbase_replace_record($dbase_identifier, $record, $record_number){}
15747
15748/**
15749 * {@link dba_close} closes the established database and frees all
15750 * resources of the specified database handle.
15751 *
15752 * @param resource $handle The database handler, returned by {@link
15753 *   dba_open} or {@link dba_popen}.
15754 * @return void
15755 * @since PHP 4, PHP 5
15756 **/
15757function dba_close($handle){}
15758
15759/**
15760 * {@link dba_delete} deletes the specified entry from the database.
15761 *
15762 * @param string $key The key of the entry which is deleted.
15763 * @param resource $handle The database handler, returned by {@link
15764 *   dba_open} or {@link dba_popen}.
15765 * @return bool
15766 * @since PHP 4, PHP 5
15767 **/
15768function dba_delete($key, $handle){}
15769
15770/**
15771 * {@link dba_exists} checks whether the specified {@link key} exists in
15772 * the database.
15773 *
15774 * @param string $key The key the check is performed for.
15775 * @param resource $handle The database handler, returned by {@link
15776 *   dba_open} or {@link dba_popen}.
15777 * @return bool
15778 * @since PHP 4, PHP 5
15779 **/
15780function dba_exists($key, $handle){}
15781
15782/**
15783 * {@link dba_fetch} fetches the data specified by {@link key} from the
15784 * database specified with {@link handle}.
15785 *
15786 * @param string $key The key the data is specified by.
15787 * @param resource $handle The number of key-value pairs to ignore when
15788 *   using cdb databases. This value is ignored for all other databases
15789 *   which do not support multiple keys with the same name.
15790 * @return string
15791 * @since PHP 4, PHP 5
15792 **/
15793function dba_fetch($key, $handle){}
15794
15795/**
15796 * {@link dba_firstkey} returns the first key of the database and resets
15797 * the internal key pointer. This permits a linear search through the
15798 * whole database.
15799 *
15800 * @param resource $handle The database handler, returned by {@link
15801 *   dba_open} or {@link dba_popen}.
15802 * @return string
15803 * @since PHP 4, PHP 5
15804 **/
15805function dba_firstkey($handle){}
15806
15807/**
15808 * {@link dba_handlers} list all the handlers supported by this
15809 * extension.
15810 *
15811 * @param bool $full_info Turns on/off full information display in the
15812 *   result.
15813 * @return array
15814 * @since PHP 4 >= 4.3.0, PHP 5
15815 **/
15816function dba_handlers($full_info){}
15817
15818/**
15819 * {@link dba_insert} inserts the entry described with {@link key} and
15820 * {@link value} into the database.
15821 *
15822 * @param string $key The key of the entry to be inserted. If this key
15823 *   already exist in the database, this function will fail. Use {@link
15824 *   dba_replace} if you need to replace an existent key.
15825 * @param string $value The value to be inserted.
15826 * @param resource $handle The database handler, returned by {@link
15827 *   dba_open} or {@link dba_popen}.
15828 * @return bool
15829 * @since PHP 4, PHP 5
15830 **/
15831function dba_insert($key, $value, $handle){}
15832
15833/**
15834 * {@link dba_key_split} splits a key (string representation) into an
15835 * array representation.
15836 *
15837 * @param mixed $key The key in string representation.
15838 * @return mixed
15839 * @since PHP 5
15840 **/
15841function dba_key_split($key){}
15842
15843/**
15844 * {@link dba_list} list all open database files.
15845 *
15846 * @return array
15847 * @since PHP 4 >= 4.3.0, PHP 5
15848 **/
15849function dba_list(){}
15850
15851/**
15852 * {@link dba_nextkey} returns the next key of the database and advances
15853 * the internal key pointer.
15854 *
15855 * @param resource $handle The database handler, returned by {@link
15856 *   dba_open} or {@link dba_popen}.
15857 * @return string
15858 * @since PHP 4, PHP 5
15859 **/
15860function dba_nextkey($handle){}
15861
15862/**
15863 * {@link dba_open} establishes a database instance for {@link path} with
15864 * {@link mode} using {@link handler}.
15865 *
15866 * @param string $path Commonly a regular path in your filesystem.
15867 * @param string $mode It is r for read access, w for read/write access
15868 *   to an already existing database, c for read/write access and
15869 *   database creation if it doesn't currently exist, and n for create,
15870 *   truncate and read/write access. The database is created in BTree
15871 *   mode, other modes (like Hash or Queue) are not supported.
15872 *   Additionally you can set the database lock method with the next
15873 *   char. Use l to lock the database with a .lck file or d to lock the
15874 *   databasefile itself. It is important that all of your applications
15875 *   do this consistently. If you want to test the access and do not want
15876 *   to wait for the lock you can add t as third character. When you are
15877 *   absolutely sure that you do not require database locking you can do
15878 *   so by using - instead of l or d. When none of d, l or - is used, dba
15879 *   will lock on the database file as it would with d.
15880 * @param string $handler The name of the handler which shall be used
15881 *   for accessing {@link path}. It is passed all optional parameters
15882 *   given to {@link dba_open} and can act on behalf of them.
15883 * @return resource
15884 * @since PHP 4, PHP 5
15885 **/
15886function dba_open($path, $mode, $handler){}
15887
15888/**
15889 * {@link dba_optimize} optimizes the underlying database.
15890 *
15891 * @param resource $handle The database handler, returned by {@link
15892 *   dba_open} or {@link dba_popen}.
15893 * @return bool
15894 * @since PHP 4, PHP 5
15895 **/
15896function dba_optimize($handle){}
15897
15898/**
15899 * {@link dba_popen} establishes a persistent database instance for
15900 * {@link path} with {@link mode} using {@link handler}.
15901 *
15902 * @param string $path Commonly a regular path in your filesystem.
15903 * @param string $mode It is r for read access, w for read/write access
15904 *   to an already existing database, c for read/write access and
15905 *   database creation if it doesn't currently exist, and n for create,
15906 *   truncate and read/write access.
15907 * @param string $handler The name of the handler which shall be used
15908 *   for accessing {@link path}. It is passed all optional parameters
15909 *   given to {@link dba_popen} and can act on behalf of them.
15910 * @return resource
15911 * @since PHP 4, PHP 5
15912 **/
15913function dba_popen($path, $mode, $handler){}
15914
15915/**
15916 * {@link dba_replace} replaces or inserts the entry described with
15917 * {@link key} and {@link value} into the database specified by {@link
15918 * handle}.
15919 *
15920 * @param string $key The key of the entry to be replaced.
15921 * @param string $value The value to be replaced.
15922 * @param resource $handle The database handler, returned by {@link
15923 *   dba_open} or {@link dba_popen}.
15924 * @return bool
15925 * @since PHP 4, PHP 5
15926 **/
15927function dba_replace($key, $value, $handle){}
15928
15929/**
15930 * {@link dba_sync} synchronizes the database. This will probably trigger
15931 * a physical write to the disk, if supported.
15932 *
15933 * @param resource $handle The database handler, returned by {@link
15934 *   dba_open} or {@link dba_popen}.
15935 * @return bool
15936 * @since PHP 4, PHP 5
15937 **/
15938function dba_sync($handle){}
15939
15940/**
15941 * Adds a tuple to a {@link relation}.
15942 *
15943 * @param resource $relation
15944 * @param array $tuple An array of attribute/value pairs to be inserted
15945 *   into the given {@link relation}. After successful execution this
15946 *   array will contain the complete data of the newly created tuple,
15947 *   including all implicitly set domain fields like sequences.
15948 * @return int
15949 * @since PHP 4 = 0.9
15950 **/
15951function dbplus_add($relation, $tuple){}
15952
15953/**
15954 * Executes an AQL {@link query} on the given {@link server} and {@link
15955 * dbpath}.
15956 *
15957 * @param string $query The AQL query to be executed. Further
15958 *   information on the AQL A... Query Language is provided in the
15959 *   original db++ manual.
15960 * @param string $server
15961 * @param string $dbpath
15962 * @return resource
15963 * @since PHP 4 = 0.9
15964 **/
15965function dbplus_aql($query, $server, $dbpath){}
15966
15967/**
15968 * Changes the virtual current directory where relation files will be
15969 * looked for by {@link dbplus_open}.
15970 *
15971 * @param string $newdir The new directory for relation files. You can
15972 *   omit this parameter to query the current working directory.
15973 * @return string
15974 * @since PHP 4 = 0.9
15975 **/
15976function dbplus_chdir($newdir){}
15977
15978/**
15979 * Closes a relation previously opened by {@link dbplus_open}.
15980 *
15981 * @param resource $relation A relation opened by {@link dbplus_open}.
15982 * @return mixed
15983 * @since PHP 4 = 0.9
15984 **/
15985function dbplus_close($relation){}
15986
15987/**
15988 * Reads the data for the current tuple for the given {@link relation}.
15989 *
15990 * @param resource $relation A relation opened by {@link dbplus_open}.
15991 * @param array $tuple The data will be passed back in this parameter,
15992 *   as an associative array.
15993 * @return int
15994 * @since PHP 4 = 0.9
15995 **/
15996function dbplus_curr($relation, &$tuple){}
15997
15998/**
15999 * Returns a clear error string for the given error code.
16000 *
16001 * @param int $errno The error code. If not provided, the result code
16002 *   of the last db++ operation is assumed.
16003 * @return string
16004 * @since PHP 4 = 0.9
16005 **/
16006function dbplus_errcode($errno){}
16007
16008/**
16009 * Returns the error code returned by the last db++ operation.
16010 *
16011 * @return int
16012 * @since PHP 4 = 0.9
16013 **/
16014function dbplus_errno(){}
16015
16016/**
16017 * Places a constraint on the given {@link relation}.
16018 *
16019 * Further calls to functions like {@link dbplus_curr} or {@link
16020 * dbplus_next} will only return tuples matching the given constraints.
16021 *
16022 * @param resource $relation A relation opened by {@link dbplus_open}.
16023 * @param array $constraints Constraints are triplets of strings
16024 *   containing of a domain name, a comparison operator and a comparison
16025 *   value. The {@link constraints} parameter array may consist of a
16026 *   collection of string arrays, each of which contains a domain, an
16027 *   operator and a value, or of a single string array containing a
16028 *   multiple of three elements. The comparison operator may be one of
16029 *   the following strings: '==', '>', '>=', '<', '<=', '!=', '~' for a
16030 *   regular expression match and 'BAND' or 'BOR' for bitwise operations.
16031 * @param mixed $tuple
16032 * @return int
16033 * @since PHP 4 = 0.9
16034 **/
16035function dbplus_find($relation, $constraints, $tuple){}
16036
16037/**
16038 * Reads the data for the first tuple for the given {@link relation},
16039 * makes it the current tuple and pass it back as an associative array in
16040 * {@link tuple}.
16041 *
16042 * @param resource $relation A relation opened by {@link dbplus_open}.
16043 * @param array $tuple
16044 * @return int
16045 * @since PHP 4 = 0.9
16046 **/
16047function dbplus_first($relation, &$tuple){}
16048
16049/**
16050 * Writes all changes applied to {@link relation} since the last flush to
16051 * disk.
16052 *
16053 * @param resource $relation A relation opened by {@link dbplus_open}.
16054 * @return int
16055 * @since PHP 4 = 0.9
16056 **/
16057function dbplus_flush($relation){}
16058
16059/**
16060 * Frees all tuple locks held by this client.
16061 *
16062 * @return int
16063 * @since PHP 4 = 0.9
16064 **/
16065function dbplus_freealllocks(){}
16066
16067/**
16068 * Releases a write lock on the given {@link tuple} previously obtained
16069 * by {@link dbplus_getlock}.
16070 *
16071 * @param resource $relation A relation opened by {@link dbplus_open}.
16072 * @param string $tuple
16073 * @return int
16074 * @since PHP 4 = 0.9
16075 **/
16076function dbplus_freelock($relation, $tuple){}
16077
16078/**
16079 * Frees all tuple locks held on the given {@link relation}.
16080 *
16081 * @param resource $relation A relation opened by {@link dbplus_open}.
16082 * @return int
16083 * @since PHP 4 = 0.9
16084 **/
16085function dbplus_freerlocks($relation){}
16086
16087/**
16088 * Requests a write lock on the specified {@link tuple}.
16089 *
16090 * @param resource $relation A relation opened by {@link dbplus_open}.
16091 * @param string $tuple
16092 * @return int
16093 * @since PHP 4 = 0.9
16094 **/
16095function dbplus_getlock($relation, $tuple){}
16096
16097/**
16098 * Obtains a number guaranteed to be unique for the given {@link
16099 * relation} and will pass it back in the variable given as {@link
16100 * uniqueid}.
16101 *
16102 * @param resource $relation A relation opened by {@link dbplus_open}.
16103 * @param int $uniqueid
16104 * @return int
16105 * @since PHP 4 = 0.9
16106 **/
16107function dbplus_getunique($relation, $uniqueid){}
16108
16109/**
16110 * @param resource $relation A relation opened by {@link dbplus_open}.
16111 * @param string $key
16112 * @param array $result
16113 * @return int
16114 * @since PHP 4 = 0.9
16115 **/
16116function dbplus_info($relation, $key, &$result){}
16117
16118/**
16119 * Reads the data for the last tuple for the given {@link relation},
16120 * makes it the current tuple and pass it back as an associative array in
16121 * {@link tuple}.
16122 *
16123 * @param resource $relation A relation opened by {@link dbplus_open}.
16124 * @param array $tuple
16125 * @return int
16126 * @since PHP 4 = 0.9
16127 **/
16128function dbplus_last($relation, &$tuple){}
16129
16130/**
16131 * Requests a write lock on the given {@link relation}.
16132 *
16133 * Other clients may still query the relation, but can't alter it while
16134 * it is locked.
16135 *
16136 * @param resource $relation A relation opened by {@link dbplus_open}.
16137 * @return int
16138 * @since PHP 4 = 0.9
16139 **/
16140function dbplus_lockrel($relation){}
16141
16142/**
16143 * Reads the data for the next tuple for the given {@link relation},
16144 * makes it the current tuple and will pass it back as an associative
16145 * array in {@link tuple}.
16146 *
16147 * @param resource $relation A relation opened by {@link dbplus_open}.
16148 * @param array $tuple
16149 * @return int
16150 * @since PHP 4 = 0.9
16151 **/
16152function dbplus_next($relation, &$tuple){}
16153
16154/**
16155 * Opens the given relation file.
16156 *
16157 * @param string $name Can be either a file name or a relative or
16158 *   absolute path name. This will be mapped in any case to an absolute
16159 *   relation file path on a specific host machine and server.
16160 * @return resource
16161 * @since PHP 4 = 0.9
16162 **/
16163function dbplus_open($name){}
16164
16165/**
16166 * Reads the data for the previous tuple for the given {@link relation},
16167 * makes it the current tuple and will pass it back as an associative
16168 * array in {@link tuple}.
16169 *
16170 * @param resource $relation A relation opened by {@link dbplus_open}.
16171 * @param array $tuple
16172 * @return int
16173 * @since PHP 4 = 0.9
16174 **/
16175function dbplus_prev($relation, &$tuple){}
16176
16177/**
16178 * Changes access permissions as specified by {@link mask}, {@link user}
16179 * and {@link group}. The values for these are operating system specific.
16180 *
16181 * @param resource $relation A relation opened by {@link dbplus_open}.
16182 * @param int $mask
16183 * @param string $user
16184 * @param string $group
16185 * @return int
16186 * @since PHP 4 = 0.9
16187 **/
16188function dbplus_rchperm($relation, $mask, $user, $group){}
16189
16190/**
16191 * Creates a new relation. Any existing relation sharing the same {@link
16192 * name} will be overwritten if the relation is currently not in use and
16193 * {@link overwrite} is set to TRUE.
16194 *
16195 * @param string $name
16196 * @param mixed $domlist A combination of domains. May be passed as a
16197 *   single domain name string or as an array of domain names. This
16198 *   parameter should contain the domain specification for the new
16199 *   relation within an array of domain description strings. A domain
16200 *   description string consists of a domain name unique to this
16201 *   relation, a slash and a type specification character. See the db++
16202 *   documentation, especially the dbcreate(1) manpage, for a description
16203 *   of available type specifiers and their meanings.
16204 * @param bool $overwrite
16205 * @return resource
16206 * @since PHP 4 = 0.9
16207 **/
16208function dbplus_rcreate($name, $domlist, $overwrite){}
16209
16210/**
16211 * {@link dbplus_rcrtexact} will create an exact but empty copy of the
16212 * given {@link relation} under a new {@link name}.
16213 *
16214 * @param string $name
16215 * @param resource $relation The copied relation, opened by {@link
16216 *   dbplus_open}.
16217 * @param bool $overwrite An existing relation by the same {@link name}
16218 *   will only be overwritten if this parameter is set to and no other
16219 *   process is currently using the relation.
16220 * @return mixed
16221 * @since PHP 4 = 0.9
16222 **/
16223function dbplus_rcrtexact($name, $relation, $overwrite){}
16224
16225/**
16226 * {@link dbplus_rcrtexact} will create an empty copy of the given {@link
16227 * relation} under a new {@link name}, but with default indices.
16228 *
16229 * @param string $name
16230 * @param resource $relation The copied relation, opened by {@link
16231 *   dbplus_open}.
16232 * @param int $overwrite An existing relation by the same {@link name}
16233 *   will only be overwritten if this parameter is set to and no other
16234 *   process is currently using the relation.
16235 * @return mixed
16236 * @since PHP 4 = 0.9
16237 **/
16238function dbplus_rcrtlike($name, $relation, $overwrite){}
16239
16240/**
16241 * {@link dbplus_resolve} will try to resolve the given {@link
16242 * relation_name} and find out internal server id, real hostname and the
16243 * database path on this host.
16244 *
16245 * @param string $relation_name The relation name.
16246 * @return array
16247 * @since PHP 4 = 0.9
16248 **/
16249function dbplus_resolve($relation_name){}
16250
16251/**
16252 * @param resource $relation A relation opened by {@link dbplus_open}.
16253 * @param array $tuple
16254 * @return int
16255 * @since PHP 4 = 0.9
16256 **/
16257function dbplus_restorepos($relation, $tuple){}
16258
16259/**
16260 * {@link dbplus_rkeys} will replace the current primary key for {@link
16261 * relation} with the combination of domains specified by {@link
16262 * domlist}.
16263 *
16264 * @param resource $relation A relation opened by {@link dbplus_open}.
16265 * @param mixed $domlist A combination of domains. May be passed as a
16266 *   single domain name string or as an array of domain names.
16267 * @return mixed
16268 * @since PHP 4 = 0.9
16269 **/
16270function dbplus_rkeys($relation, $domlist){}
16271
16272/**
16273 * {@link dbplus_ropen} will open the relation {@link file} locally for
16274 * quick access without any client/server overhead. Access is read only
16275 * and only {@link dbplus_curr} and {@link dbplus_next} may be applied to
16276 * the returned relation.
16277 *
16278 * @param string $name
16279 * @return resource
16280 * @since PHP 4 = 0.9
16281 **/
16282function dbplus_ropen($name){}
16283
16284/**
16285 * {@link dbplus_rquery} performs a local (raw) AQL query using an AQL
16286 * interpreter embedded into the db++ client library. {@link
16287 * dbplus_rquery} is faster than {@link dbplus_aql} but will work on
16288 * local data only.
16289 *
16290 * @param string $query
16291 * @param string $dbpath
16292 * @return resource
16293 * @since PHP 4 = 0.9
16294 **/
16295function dbplus_rquery($query, $dbpath){}
16296
16297/**
16298 * {@link dbplus_rrename} will change the name of {@link relation} to
16299 * {@link name}.
16300 *
16301 * @param resource $relation A relation opened by {@link dbplus_open}.
16302 * @param string $name
16303 * @return int
16304 * @since PHP 4 = 0.9
16305 **/
16306function dbplus_rrename($relation, $name){}
16307
16308/**
16309 * {@link dbplus_rsecindex} will create a new secondary index for {@link
16310 * relation} with consists of the domains specified by {@link domlist}
16311 * and is of type {@link type}
16312 *
16313 * @param resource $relation A relation opened by {@link dbplus_open}.
16314 * @param mixed $domlist A combination of domains. May be passed as a
16315 *   single domain name string or as an array of domain names.
16316 * @param int $type
16317 * @return mixed
16318 * @since PHP 4 = 0.9
16319 **/
16320function dbplus_rsecindex($relation, $domlist, $type){}
16321
16322/**
16323 * {@link dbplus_runlink} will close and remove the {@link relation}.
16324 *
16325 * @param resource $relation A relation opened by {@link dbplus_open}.
16326 * @return int
16327 * @since PHP 4 = 0.9
16328 **/
16329function dbplus_runlink($relation){}
16330
16331/**
16332 * {@link dbplus_rzap} will remove all tuples from {@link relation}.
16333 *
16334 * @param resource $relation A relation opened by {@link dbplus_open}.
16335 * @return int
16336 * @since PHP 4 = 0.9
16337 **/
16338function dbplus_rzap($relation){}
16339
16340/**
16341 * @param resource $relation A relation opened by {@link dbplus_open}.
16342 * @return int
16343 * @since PHP 4 = 0.9
16344 **/
16345function dbplus_savepos($relation){}
16346
16347/**
16348 * @param resource $relation A relation opened by {@link dbplus_open}.
16349 * @param string $idx_name
16350 * @return int
16351 * @since PHP 4 = 0.9
16352 **/
16353function dbplus_setindex($relation, $idx_name){}
16354
16355/**
16356 * @param resource $relation A relation opened by {@link dbplus_open}.
16357 * @param int $idx_number
16358 * @return int
16359 * @since PHP 4 = 0.9
16360 **/
16361function dbplus_setindexbynumber($relation, $idx_number){}
16362
16363/**
16364 * @param string $query
16365 * @param string $server
16366 * @param string $dbpath
16367 * @return resource
16368 * @since PHP 4 = 0.9
16369 **/
16370function dbplus_sql($query, $server, $dbpath){}
16371
16372/**
16373 * A db++ server will prepare a TCL interpreter for each client
16374 * connection. This interpreter will enable the server to execute TCL
16375 * code provided by the client as a sort of stored procedures to improve
16376 * the performance of database operations by avoiding client/server data
16377 * transfers and context switches.
16378 *
16379 * {@link dbplus_tcl} needs to pass the client connection id the TCL
16380 * {@link script} code should be executed by. {@link dbplus_resolve} will
16381 * provide this connection id. The function will return whatever the TCL
16382 * code returns or a TCL error message if the TCL code fails.
16383 *
16384 * @param int $sid
16385 * @param string $script
16386 * @return string
16387 * @since PHP 4 = 0.9
16388 **/
16389function dbplus_tcl($sid, $script){}
16390
16391/**
16392 * {@link dbplus_tremove} removes {@link tuple} from {@link relation} if
16393 * it perfectly matches a tuple within the relation. {@link current}, if
16394 * given, will contain the data of the new current tuple after calling
16395 * {@link dbplus_tremove}.
16396 *
16397 * @param resource $relation A relation opened by {@link dbplus_open}.
16398 * @param array $tuple
16399 * @param array $current
16400 * @return int
16401 * @since PHP 4 = 0.9
16402 **/
16403function dbplus_tremove($relation, $tuple, &$current){}
16404
16405/**
16406 * @param resource $relation A relation opened by {@link dbplus_open}.
16407 * @return int
16408 * @since PHP 4 = 0.9
16409 **/
16410function dbplus_undo($relation){}
16411
16412/**
16413 * @param resource $relation A relation opened by {@link dbplus_open}.
16414 * @return int
16415 * @since PHP 4 = 0.9
16416 **/
16417function dbplus_undoprepare($relation){}
16418
16419/**
16420 * Release a write lock previously obtained by {@link dbplus_lockrel}.
16421 *
16422 * @param resource $relation A relation opened by {@link dbplus_open}.
16423 * @return int
16424 * @since PHP 4 = 0.9
16425 **/
16426function dbplus_unlockrel($relation){}
16427
16428/**
16429 * Calling {@link dbplus_unselect} will remove a constraint previously
16430 * set by {@link dbplus_find} on {@link relation}.
16431 *
16432 * @param resource $relation A relation opened by {@link dbplus_open}.
16433 * @return int
16434 * @since PHP 4 = 0.9
16435 **/
16436function dbplus_unselect($relation){}
16437
16438/**
16439 * {@link dbplus_update} replaces the {@link old} tuple with the data
16440 * from the {@link new} one, only if the {@link old} completely matches a
16441 * tuple within {@link relation}.
16442 *
16443 * @param resource $relation A relation opened by {@link dbplus_open}.
16444 * @param array $old The old tuple.
16445 * @param array $new The new tuple.
16446 * @return int
16447 * @since PHP 4 = 0.9
16448 **/
16449function dbplus_update($relation, $old, $new){}
16450
16451/**
16452 * Request an exclusive lock on {@link relation} preventing even read
16453 * access from other clients.
16454 *
16455 * @param resource $relation A relation opened by {@link dbplus_open}.
16456 * @return int
16457 * @since PHP 4 = 0.9
16458 **/
16459function dbplus_xlockrel($relation){}
16460
16461/**
16462 * Releases an exclusive lock previously obtained by {@link
16463 * dbplus_xlockrel}.
16464 *
16465 * @param resource $relation A relation opened by {@link dbplus_open}.
16466 * @return int
16467 * @since PHP 4 = 0.9
16468 **/
16469function dbplus_xunlockrel($relation){}
16470
16471/**
16472 * @param object $link_identifier The DBX link object to close.
16473 * @return int
16474 * @since PHP 4 >= 4.0.6, PHP 5 = 1.1.0
16475 **/
16476function dbx_close($link_identifier){}
16477
16478/**
16479 * {@link dbx_compare} is a helper function for {@link dbx_sort} to ease
16480 * the make and use of the custom sorting function.
16481 *
16482 * @param array $row_a First row
16483 * @param array $row_b Second row
16484 * @param string $column_key The compared column
16485 * @param int $flags The {@link flags} can be set to specify comparison
16486 *   direction: DBX_CMP_ASC - ascending order DBX_CMP_DESC - descending
16487 *   order and the preferred comparison type: DBX_CMP_NATIVE - no type
16488 *   conversion DBX_CMP_TEXT - compare items as strings DBX_CMP_NUMBER -
16489 *   compare items numerically One of the direction and one of the type
16490 *   constant can be combined with bitwise OR operator (|).
16491 * @return int
16492 * @since PHP 4 >= 4.1.0, PHP 5 = 1.1.0
16493 **/
16494function dbx_compare($row_a, $row_b, $column_key, $flags){}
16495
16496/**
16497 * Opens a connection to a database.
16498 *
16499 * @param mixed $module The {@link module} parameter can be either a
16500 *   string or a constant, though the latter form is preferred. The
16501 *   possible values are given below, but keep in mind that they only
16502 *   work if the module is actually loaded.
16503 *
16504 *   DBX_MYSQL or "mysql" DBX_ODBC or "odbc" DBX_PGSQL or "pgsql"
16505 *   DBX_MSSQL or "mssql" DBX_FBSQL or "fbsql" DBX_SYBASECT or
16506 *   "sybase_ct" DBX_OCI8 or "oci8" DBX_SQLITE or "sqlite"
16507 * @param string $host The SQL server host
16508 * @param string $database The database name
16509 * @param string $username The username
16510 * @param string $password The password
16511 * @param int $persistent The {@link persistent} parameter can be set
16512 *   to DBX_PERSISTENT, if so, a persistent connection will be created.
16513 * @return object
16514 * @since PHP 4 >= 4.0.6, PHP 5 = 1.1.0
16515 **/
16516function dbx_connect($module, $host, $database, $username, $password, $persistent){}
16517
16518/**
16519 * {@link dbx_error} returns the last error message.
16520 *
16521 * @param object $link_identifier The DBX link object returned by
16522 *   {@link dbx_connect}
16523 * @return string
16524 * @since PHP 4 >= 4.0.6, PHP 5 = 1.1.0
16525 **/
16526function dbx_error($link_identifier){}
16527
16528/**
16529 * Escape the given string so that it can safely be used in an
16530 * sql-statement.
16531 *
16532 * @param object $link_identifier The DBX link object returned by
16533 *   {@link dbx_connect}
16534 * @param string $text The string to escape.
16535 * @return string
16536 * @since PHP 4 >= 4.3.0, PHP 5 = 1.1.0
16537 **/
16538function dbx_escape_string($link_identifier, $text){}
16539
16540/**
16541 * {@link dbx_fetch_row} fetches rows from a result identifier that had
16542 * the DBX_RESULT_UNBUFFERED flag set.
16543 *
16544 * When the DBX_RESULT_UNBUFFERED is not set in the query, {@link
16545 * dbx_fetch_row} will fail as all rows have already been fetched into
16546 * the results data property.
16547 *
16548 * As a side effect, the rows property of the query-result object is
16549 * incremented for each successful call to {@link dbx_fetch_row}.
16550 *
16551 * @param object $result_identifier A result set returned by {@link
16552 *   dbx_query}.
16553 * @return mixed
16554 * @since PHP 5 = 1.1.0
16555 **/
16556function dbx_fetch_row($result_identifier){}
16557
16558/**
16559 * Sends a query and fetch all results.
16560 *
16561 * @param object $link_identifier The DBX link object returned by
16562 *   {@link dbx_connect}
16563 * @param string $sql_statement SQL statement. Data inside the query
16564 *   should be properly escaped.
16565 * @param int $flags The {@link flags} parameter is used to control the
16566 *   amount of information that is returned. It may be any combination of
16567 *   the following constants with the bitwise OR operator (|). The
16568 *   DBX_COLNAMES_* flags override the dbx.colnames_case setting from .
16569 *   DBX_RESULT_INDEX It is always set, that is, the returned object has
16570 *   a data property which is a 2 dimensional array indexed numerically.
16571 *   For example, in the expression data[2][3] 2 stands for the row (or
16572 *   record) number and 3 stands for the column (or field) number. The
16573 *   first row and column are indexed at 0. If DBX_RESULT_ASSOC is also
16574 *   specified, the returning object contains the information related to
16575 *   DBX_RESULT_INFO too, even if it was not specified. DBX_RESULT_INFO
16576 *   It provides info about columns, such as field names and field types.
16577 *   DBX_RESULT_ASSOC It effects that the field values can be accessed
16578 *   with the respective column names used as keys to the returned
16579 *   object's data property. Associated results are actually references
16580 *   to the numerically indexed data, so modifying data[0][0] causes that
16581 *   data[0]['field_name_for_first_column'] is modified as well.
16582 *   DBX_RESULT_UNBUFFERED This flag will not create the data property,
16583 *   and the rows property will initially be 0. Use this flag for large
16584 *   datasets, and use {@link dbx_fetch_row} to retrieve the results row
16585 *   by row. The {@link dbx_fetch_row} function will return rows that are
16586 *   conformant to the flags set with this query. Incidentally, it will
16587 *   also update the rows each time it is called. DBX_COLNAMES_UNCHANGED
16588 *   The case of the returned column names will not be changed.
16589 *   DBX_COLNAMES_UPPERCASE The case of the returned column names will be
16590 *   changed to uppercase. DBX_COLNAMES_LOWERCASE The case of the
16591 *   returned column names will be changed to lowercase. Note that
16592 *   DBX_RESULT_INDEX is always used, regardless of the actual value of
16593 *   {@link flags} parameter. This means that only the following
16594 *   combinations are effective: DBX_RESULT_INDEX DBX_RESULT_INDEX |
16595 *   DBX_RESULT_INFO DBX_RESULT_INDEX | DBX_RESULT_INFO |
16596 *   DBX_RESULT_ASSOC - this is the default, if {@link flags} is not
16597 *   specified.
16598 * @return mixed
16599 * @since PHP 4 >= 4.0.6, PHP 5 = 1.1.0
16600 **/
16601function dbx_query($link_identifier, $sql_statement, $flags){}
16602
16603/**
16604 * Sort a result from a {@link dbx_query} call with a custom sort
16605 * function.
16606 *
16607 * @param object $result A result set returned by {@link dbx_query}.
16608 * @param string $user_compare_function The user-defined comparison
16609 *   function. It must accept two arguments and return an integer less
16610 *   than, equal to, or greater than zero if the first argument is
16611 *   considered to be respectively less than, equal to, or greater than
16612 *   the second.
16613 * @return bool
16614 * @since PHP 4 >= 4.0.6, PHP 5 = 1.1.0
16615 **/
16616function dbx_sort($result, $user_compare_function){}
16617
16618/**
16619 * This function allows you to override the current domain for a single
16620 * message lookup.
16621 *
16622 * @param string $domain The domain
16623 * @param string $message The message
16624 * @param int $category The category
16625 * @return string
16626 * @since PHP 4, PHP 5
16627 **/
16628function dcgettext($domain, $message, $category){}
16629
16630/**
16631 * This function allows you to override the current domain for a single
16632 * plural message lookup.
16633 *
16634 * @param string $domain The domain
16635 * @param string $msgid1
16636 * @param string $msgid2
16637 * @param int $n
16638 * @param int $category
16639 * @return string
16640 * @since PHP 4 >= 4.2.0, PHP 5
16641 **/
16642function dcngettext($domain, $msgid1, $msgid2, $n, $category){}
16643
16644/**
16645 * Removes the methods and properties from classes that were aggregated
16646 * to an object.
16647 *
16648 * @param object $object
16649 * @param string $class_name If the optional {@link class_name}
16650 *   parameters is passed, only those methods and properties defined in
16651 *   that class are removed, otherwise all aggregated methods and
16652 *   properties are eliminated.
16653 * @return void
16654 * @since PHP 4 >= 4.2.0
16655 **/
16656function deaggregate($object, $class_name){}
16657
16658/**
16659 * {@link debug_backtrace} generates a PHP backtrace.
16660 *
16661 * @param bool $provide_object Whether or not to populate the "object"
16662 *   index.
16663 * @return array
16664 * @since PHP 4 >= 4.3.0, PHP 5
16665 **/
16666function debug_backtrace($provide_object){}
16667
16668/**
16669 * {@link debug_print_backtrace} prints a PHP backtrace. It prints the
16670 * function calls, included/required files and {@link eval}ed stuff.
16671 *
16672 * @return void
16673 * @since PHP 5
16674 **/
16675function debug_print_backtrace(){}
16676
16677/**
16678 * Dumps a string representation of an internal zend value to output.
16679 *
16680 * @param mixed $variable The variable being evaluated.
16681 * @return void
16682 * @since PHP 4 >= 4.2.0, PHP 5
16683 **/
16684function debug_zval_dump($variable){}
16685
16686/**
16687 * Returns a string containing a binary representation of the given
16688 * {@link number} argument.
16689 *
16690 * @param int $number Decimal value to convert
16691 * @return string
16692 * @since PHP 4, PHP 5
16693 **/
16694function decbin($number){}
16695
16696/**
16697 * Returns a string containing a hexadecimal representation of the given
16698 * {@link number} argument. The largest number that can be converted is
16699 * 4294967295 in decimal resulting to "ffffffff".
16700 *
16701 * @param int $number Decimal value to convert
16702 * @return string
16703 * @since PHP 4, PHP 5
16704 **/
16705function dechex($number){}
16706
16707/**
16708 * Returns a string containing an octal representation of the given
16709 * {@link number} argument. The largest number that can be converted is
16710 * 4294967295 in decimal resulting to "37777777777".
16711 *
16712 * @param int $number Decimal value to convert
16713 * @return string
16714 * @since PHP 4, PHP 5
16715 **/
16716function decoct($number){}
16717
16718/**
16719 * Defines a named constant at runtime.
16720 *
16721 * @param string $name The name of the constant.
16722 * @param mixed $value The value of the constant; only scalar and null
16723 *   values are allowed. Scalar values are integer, float, string or
16724 *   boolean values. It is possible to define resource constants, however
16725 *   it is not recommended and may cause unpredictable behavior.
16726 * @param bool $case_insensitive If set to , the constant will be
16727 *   defined case-insensitive. The default behavior is case-sensitive;
16728 *   i.e. CONSTANT and Constant represent different values.
16729 * @return bool
16730 * @since PHP 4, PHP 5
16731 **/
16732function define($name, $value, $case_insensitive){}
16733
16734/**
16735 * Checks whether the given constant exists and is defined.
16736 *
16737 * @param string $name The constant name.
16738 * @return bool
16739 * @since PHP 4, PHP 5
16740 **/
16741function defined($name){}
16742
16743/**
16744 * Initializes all variables used in the syslog functions.
16745 *
16746 * @return void
16747 * @since PHP 4, PHP 5
16748 **/
16749function define_syslog_variables(){}
16750
16751/**
16752 * This function converts {@link number} from degrees to the radian
16753 * equivalent.
16754 *
16755 * @param float $number Angular value in degrees
16756 * @return float
16757 * @since PHP 4, PHP 5
16758 **/
16759function deg2rad($number){}
16760
16761/**
16762 * The {@link dgettext} function allows you to override the current
16763 * {@link domain} for a single message lookup.
16764 *
16765 * @param string $domain The domain
16766 * @param string $message The message
16767 * @return string
16768 * @since PHP 4, PHP 5
16769 **/
16770function dgettext($domain, $message){}
16771
16772/**
16773 * The function {@link dio_close} closes the file descriptor {@link fd}.
16774 *
16775 * @param resource $fd The file descriptor returned by {@link
16776 *   dio_open}.
16777 * @return void
16778 * @since PHP 4 >= 4.2.0, PHP 5
16779 **/
16780function dio_close($fd){}
16781
16782/**
16783 * The {@link dio_fcntl} function performs the operation specified by
16784 * {@link cmd} on the file descriptor {@link fd}. Some commands require
16785 * additional arguments {@link args} to be supplied.
16786 *
16787 * @param resource $fd The file descriptor returned by {@link
16788 *   dio_open}.
16789 * @param int $cmd Can be one of the following operations: F_SETLK -
16790 *   Lock is set or cleared. If the lock is held by someone else {@link
16791 *   dio_fcntl} returns -1. F_SETLKW - like F_SETLK, but in case the lock
16792 *   is held by someone else, {@link dio_fcntl} waits until the lock is
16793 *   released. F_GETLK - {@link dio_fcntl} returns an associative array
16794 *   (as described above) if someone else prevents lock. If there is no
16795 *   obstruction key "type" will set to F_UNLCK. F_DUPFD - finds the
16796 *   lowest numbered available file descriptor greater than or equal to
16797 *   {@link args} and returns them. F_SETFL - Sets the file descriptors
16798 *   flags to the value specified by {@link args}, which can be O_APPEND,
16799 *   O_NONBLOCK or O_ASYNC. To use O_ASYNC you will need to use the PCNTL
16800 *   extension.
16801 * @param mixed $args {@link args} is an associative array, when {@link
16802 *   cmd} is F_SETLK or F_SETLLW, with the following keys: "start" -
16803 *   offset where lock begins "length" - size of locked area. zero means
16804 *   to end of file "wenth" - Where l_start is relative to: can be
16805 *   SEEK_SET, SEEK_END and SEEK_CUR "type" - type of lock: can be
16806 *   F_RDLCK (read lock), F_WRLCK (write lock) or F_UNLCK (unlock)
16807 * @return mixed
16808 * @since PHP 4 >= 4.2.0, PHP 5
16809 **/
16810function dio_fcntl($fd, $cmd, $args){}
16811
16812/**
16813 * {@link dio_open} opens a file and returns a new file descriptor for
16814 * it.
16815 *
16816 * @param string $filename The pathname of the file to open.
16817 * @param int $flags The {@link flags} parameter is a bitwise-ORed
16818 *   value comprising flags from the following list. This value must
16819 *   include one of O_RDONLY, O_WRONLY, or O_RDWR. Additionally, it may
16820 *   include any combination of the other flags from this list. O_RDONLY
16821 *   - opens the file for read access. O_WRONLY - opens the file for
16822 *   write access. O_RDWR - opens the file for both reading and writing.
16823 *   O_CREAT - creates the file, if it doesn't already exist. O_EXCL - if
16824 *   both O_CREAT and O_EXCL are set and the file already exists, causes
16825 *   {@link dio_open} to fail. O_TRUNC - if the file exists and is opened
16826 *   for write access, the file will be truncated to zero length.
16827 *   O_APPEND - write operations write data at the end of the file.
16828 *   O_NONBLOCK - sets non blocking mode. O_NOCTTY - prevent the OS from
16829 *   assigning the opened file as the process's controlling terminal when
16830 *   opening a TTY device file.
16831 * @param int $mode If {@link flags} contains O_CREAT, {@link mode}
16832 *   will set the permissions of the file (creation permissions). {@link
16833 *   Mode} is required for correct operation when O_CREAT is specified in
16834 *   mode and is ignored otherwise. The actual permissions assigned to
16835 *   the created file will be affected by the process's umask setting as
16836 *   per usual.
16837 * @return resource
16838 * @since PHP 4 >= 4.2.0, PHP 5
16839 **/
16840function dio_open($filename, $flags, $mode){}
16841
16842/**
16843 * The function {@link dio_read} reads and returns {@link len} bytes from
16844 * file with descriptor {@link fd}.
16845 *
16846 * @param resource $fd The file descriptor returned by {@link
16847 *   dio_open}.
16848 * @param int $len The number of bytes to read. If not specified,
16849 *   {@link dio_read} reads 1K sized block.
16850 * @return string
16851 * @since PHP 4 >= 4.2.0, PHP 5
16852 **/
16853function dio_read($fd, $len){}
16854
16855/**
16856 * The function {@link dio_seek} is used to change the file position of
16857 * the given file descriptor.
16858 *
16859 * @param resource $fd The file descriptor returned by {@link
16860 *   dio_open}.
16861 * @param int $pos The new position.
16862 * @param int $whence Specifies how the position {@link pos} should be
16863 *   interpreted: SEEK_SET (default) - specifies that {@link pos} is
16864 *   specified from the beginning of the file. SEEK_CUR - Specifies that
16865 *   {@link pos} is a count of characters from the current file position.
16866 *   This count may be positive or negative. SEEK_END - Specifies that
16867 *   {@link pos} is a count of characters from the end of the file. A
16868 *   negative count specifies a position within the current extent of the
16869 *   file; a positive count specifies a position past the current end. If
16870 *   you set the position past the current end, and actually write data,
16871 *   you will extend the file with zeros up to that position.
16872 * @return int
16873 * @since PHP 4 >= 4.2.0, PHP 5
16874 **/
16875function dio_seek($fd, $pos, $whence){}
16876
16877/**
16878 * {@link dio_stat} returns information about the given file descriptor.
16879 *
16880 * @param resource $fd The file descriptor returned by {@link
16881 *   dio_open}.
16882 * @return array
16883 * @since PHP 4 >= 4.2.0, PHP 5
16884 **/
16885function dio_stat($fd){}
16886
16887/**
16888 * {@link dio_tcsetattr} sets the terminal attributes and baud rate of
16889 * the open {@link fd}.
16890 *
16891 * @param resource $fd The file descriptor returned by {@link
16892 *   dio_open}.
16893 * @param array $options The currently available options are: 'baud' -
16894 *   baud rate of the port - can be 38400,19200,9600,4800,2400,1800,
16895 *   1200,600,300,200,150,134,110,75 or 50, default value is 9600. 'bits'
16896 *   - data bits - can be 8,7,6 or 5. Default value is 8. 'stop' - stop
16897 *   bits - can be 1 or 2. Default value is 1. 'parity' - can be 0,1 or
16898 *   2. Default value is 0.
16899 * @return bool
16900 * @since PHP 4 >= 4.3.0, PHP 5
16901 **/
16902function dio_tcsetattr($fd, $options){}
16903
16904/**
16905 * {@link dio_truncate} truncates a file to at most {@link offset} bytes
16906 * in size.
16907 *
16908 * If the file previously was larger than this size, the extra data is
16909 * lost. If the file previously was shorter, it is unspecified whether
16910 * the file is left unchanged or is extended. In the latter case the
16911 * extended part reads as zero bytes.
16912 *
16913 * @param resource $fd The file descriptor returned by {@link
16914 *   dio_open}.
16915 * @param int $offset The offset in bytes.
16916 * @return bool
16917 * @since PHP 4 >= 4.2.0, PHP 5
16918 **/
16919function dio_truncate($fd, $offset){}
16920
16921/**
16922 * {@link dio_write} writes up to {@link len} bytes from {@link data} to
16923 * file {@link fd}.
16924 *
16925 * @param resource $fd The file descriptor returned by {@link
16926 *   dio_open}.
16927 * @param string $data The written data.
16928 * @param int $len The length of data to write in bytes. If not
16929 *   specified, the function writes all the data to the specified file.
16930 * @return int
16931 * @since PHP 4 >= 4.2.0, PHP 5
16932 **/
16933function dio_write($fd, $data, $len){}
16934
16935/**
16936 * Return an instance of the Directory class
16937 *
16938 * @param string $path
16939 * @return Directory
16940 * @since PHP 4, PHP 5
16941 **/
16942function dir($path){}
16943
16944/**
16945 * Given a string containing a path to a file, this function will return
16946 * the name of the directory.
16947 *
16948 * @param string $path A path. On Windows, both slash (/) and backslash
16949 *   (\) are used as directory separator character. In other
16950 *   environments, it is the forward slash (/).
16951 * @return string
16952 * @since PHP 4, PHP 5
16953 **/
16954function dirname($path){}
16955
16956/**
16957 * Given a string containing a directory, this function will return the
16958 * number of bytes available on the corresponding filesystem or disk
16959 * partition.
16960 *
16961 * @param string $directory A directory of the filesystem or disk
16962 *   partition.
16963 * @return float
16964 * @since PHP 4, PHP 5
16965 **/
16966function diskfreespace($directory){}
16967
16968/**
16969 * Given a string containing a directory, this function will return the
16970 * number of bytes available on the corresponding filesystem or disk
16971 * partition.
16972 *
16973 * @param string $directory A directory of the filesystem or disk
16974 *   partition.
16975 * @return float
16976 * @since PHP 4 >= 4.1.0, PHP 5
16977 **/
16978function disk_free_space($directory){}
16979
16980/**
16981 * Given a string containing a directory, this function will return the
16982 * total number of bytes on the corresponding filesystem or disk
16983 * partition.
16984 *
16985 * @param string $directory A directory of the filesystem or disk
16986 *   partition.
16987 * @return float
16988 * @since PHP 4 >= 4.1.0, PHP 5
16989 **/
16990function disk_total_space($directory){}
16991
16992/**
16993 * Loads the PHP extension given by the parameter {@link library}.
16994 *
16995 * Use {@link extension_loaded} to test whether a given extension is
16996 * already available or not. This works on both built-in extensions and
16997 * dynamically loaded ones (either through or {@link dl}).
16998 *
16999 * @param string $library This parameter is only the filename of the
17000 *   extension to load which also depends on your platform. For example,
17001 *   the sockets extension (if compiled as a shared module, not the
17002 *   default!) would be called sockets.so on Unix platforms whereas it is
17003 *   called php_sockets.dll on the Windows platform. The directory where
17004 *   the extension is loaded from depends on your platform: Windows - If
17005 *   not explicitly set in the , the extension is loaded from
17006 *   C:\php4\extensions\ (PHP4) or C:\php5\ (PHP5) by default. Unix - If
17007 *   not explicitly set in the , the default extension directory depends
17008 *   on whether PHP has been built with --enable-debug or not whether PHP
17009 *   has been built with (experimental) ZTS (Zend Thread Safety) support
17010 *   or not the current internal ZEND_MODULE_API_NO (Zend internal module
17011 *   API number, which is basically the date on which a major module API
17012 *   change happened, e.g. 20010901) Taking into account the above, the
17013 *   directory then defaults to <install-dir>/lib/php/extensions/
17014 *   <debug-or-not>-<zts-or-not>-ZEND_MODULE_API_NO, e.g.
17015 *   /usr/local/php/lib/php/extensions/debug-non-zts-20010901 or
17016 *   /usr/local/php/lib/php/extensions/no-debug-zts-20010901.
17017 * @return bool
17018 * @since PHP 4, PHP 5
17019 **/
17020function dl($library){}
17021
17022/**
17023 * The {@link dngettext} function allows you to override the current
17024 * {@link domain} for a single plural message lookup.
17025 *
17026 * @param string $domain The domain
17027 * @param string $msgid1
17028 * @param string $msgid2
17029 * @param int $n
17030 * @return string
17031 * @since PHP 4 >= 4.2.0, PHP 5
17032 **/
17033function dngettext($domain, $msgid1, $msgid2, $n){}
17034
17035/**
17036 * Searches DNS for records of type {@link type} corresponding to {@link
17037 * host}.
17038 *
17039 * @param string $host {@link host} may either be the IP address in
17040 *   dotted-quad notation or the host name.
17041 * @param string $type {@link type} may be any one of: A, MX, NS, SOA,
17042 *   PTR, CNAME, AAAA, A6, SRV, NAPTR, TXT or ANY.
17043 * @return bool
17044 * @since PHP 5
17045 **/
17046function dns_check_record($host, $type){}
17047
17048/**
17049 * Searches DNS for MX records corresponding to {@link hostname}.
17050 *
17051 * @param string $hostname The Internet host name.
17052 * @param array $mxhosts A list of the MX records found is placed into
17053 *   the array {@link mxhosts}.
17054 * @param array $weight If the {@link weight} array is given, it will
17055 *   be filled with the weight information gathered.
17056 * @return bool
17057 * @since PHP 5
17058 **/
17059function dns_get_mx($hostname, &$mxhosts, &$weight){}
17060
17061/**
17062 * Fetch DNS Resource Records associated with the given {@link hostname}.
17063 *
17064 * @param string $hostname {@link hostname} should be a valid DNS
17065 *   hostname such as "www.example.com". Reverse lookups can be generated
17066 *   using in-addr.arpa notation, but {@link gethostbyaddr} is more
17067 *   suitable for the majority of reverse lookups.
17068 * @param int $type By default, {@link dns_get_record} will search for
17069 *   any resource records associated with {@link hostname}. To limit the
17070 *   query, specify the optional {@link type} parameter. May be any one
17071 *   of the following: DNS_A, DNS_CNAME, DNS_HINFO, DNS_MX, DNS_NS,
17072 *   DNS_PTR, DNS_SOA, DNS_TXT, DNS_AAAA, DNS_SRV, DNS_NAPTR, DNS_A6,
17073 *   DNS_ALL or DNS_ANY.
17074 * @param array $authns Passed by reference and, if given, will be
17075 *   populated with Resource Records for the Authoritative Name Servers.
17076 * @param array $addtl Passed by reference and, if given, will be
17077 *   populated with any Additional Records.
17078 * @return array
17079 * @since PHP 5
17080 **/
17081function dns_get_record($hostname, $type, &$authns, &$addtl){}
17082
17083/**
17084 * Creates a new Dom document from scratch and returns it.
17085 *
17086 * @param string $version The XML version number of the document.
17087 * @return DomDocument
17088 * @since PHP 4 >= 4.2.0
17089 **/
17090function domxml_new_doc($version){}
17091
17092/**
17093 * The function parses the XML document in the given file.
17094 *
17095 * @param string $filename The path to the XML file. The file is
17096 *   accessed in read-only mode.
17097 * @param int $mode This optional parameter can be used to change the
17098 *   behavior of this function. You can use one of the following
17099 *   constants for it: DOMXML_LOAD_PARSING (default),
17100 *   DOMXML_LOAD_VALIDATING or DOMXML_LOAD_RECOVERING. You can add to it
17101 *   also DOMXML_LOAD_DONT_KEEP_BLANKS, DOMXML_LOAD_SUBSTITUTE_ENTITIES
17102 *   and DOMXML_LOAD_COMPLETE_ATTRS by bitwise or.
17103 * @param array $error If used, it will contain the error messages.
17104 *   {@link error} must be passed in by reference.
17105 * @return DomDocument
17106 * @since PHP 4 >= 4.2.0
17107 **/
17108function domxml_open_file($filename, $mode, &$error){}
17109
17110/**
17111 * The function parses the XML document in the given string.
17112 *
17113 * @param string $str The contents of the XML file.
17114 * @param int $mode This optional parameter can be used to change the
17115 *   behavior of this function. You can use one of the following
17116 *   constants for it: DOMXML_LOAD_PARSING (default),
17117 *   DOMXML_LOAD_VALIDATING or DOMXML_LOAD_RECOVERING. You can add to it
17118 *   also DOMXML_LOAD_DONT_KEEP_BLANKS, DOMXML_LOAD_SUBSTITUTE_ENTITIES
17119 *   and DOMXML_LOAD_COMPLETE_ATTRS by bitwise or.
17120 * @param array $error If used, it will contain the error messages.
17121 *   {@link error} must be passed in by reference.
17122 * @return DomDocument
17123 * @since PHP 4 >= 4.2.0
17124 **/
17125function domxml_open_mem($str, $mode, &$error){}
17126
17127/**
17128 * Gets the version of the XML library currently used.
17129 *
17130 * @return string
17131 * @since PHP 4 >= 4.1.0
17132 **/
17133function domxml_version(){}
17134
17135/**
17136 * The function parses the XML document in {@link str} and returns a tree
17137 * PHP objects as the parsed document.
17138 *
17139 * This function is isolated from the other functions, which means you
17140 * cannot access the tree with any of the other functions. Modifying it,
17141 * for example by adding nodes, makes no sense since there is currently
17142 * no way to dump it as an XML file.
17143 *
17144 * However this function may be valuable if you want to read a file and
17145 * investigate the content.
17146 *
17147 * @param string $str The contents of the XML file.
17148 * @return DomDocument
17149 * @since PHP 4 >= 4.2.0
17150 **/
17151function domxml_xmltree($str){}
17152
17153/**
17154 * Creates a DomXsltStylesheet object from the given XSL buffer.
17155 *
17156 * @param string $xsl_buf The XSL document, as a string.
17157 * @return DomXsltStylesheet
17158 * @since PHP 4 >= 4.2.0
17159 **/
17160function domxml_xslt_stylesheet($xsl_buf){}
17161
17162/**
17163 * Creates a DomXsltStylesheet object from the given XSL document.
17164 *
17165 * @param DomDocument $xsl_doc The XSL document, as a DomDocument
17166 *   object.
17167 * @return DomXsltStylesheet
17168 * @since PHP 4 >= 4.2.0
17169 **/
17170function domxml_xslt_stylesheet_doc($xsl_doc){}
17171
17172/**
17173 * Creates a DomXsltStylesheet object from the given XSL file.
17174 *
17175 * @param string $xsl_file The path to the XSL document, as a string.
17176 * @return DomXsltStylesheet
17177 * @since PHP 4 >= 4.2.0
17178 **/
17179function domxml_xslt_stylesheet_file($xsl_file){}
17180
17181/**
17182 * Gets the XSLT library version.
17183 *
17184 * @return int
17185 * @since PHP 4 >= 4.2.0
17186 **/
17187function domxml_xslt_version(){}
17188
17189/**
17190 * This function takes the node {@link node} of class SimpleXML and makes
17191 * it into a DOMElement node. This new object can then be used as a
17192 * native DOMElement node.
17193 *
17194 * @param SimpleXMLElement $node The SimpleXMLElement node.
17195 * @return DOMElement
17196 * @since PHP 5
17197 **/
17198function dom_import_simplexml($node){}
17199
17200/**
17201 * @param string $assembly_name
17202 * @param string $datatype_name
17203 * @param int $codepage
17204 * @return int
17205 * @since PHP 4
17206 **/
17207function dotnet_load($assembly_name, $datatype_name, $codepage){}
17208
17209/**
17210 * Gets the float value of {@link var}.
17211 *
17212 * @param mixed $var May be any scalar type. {@link floatval} should
17213 *   not be used on objects, as doing so will emit an E_NOTICE level
17214 *   error and return 1.
17215 * @return float
17216 * @since PHP 4, PHP 5
17217 **/
17218function doubleval($var){}
17219
17220/**
17221 * Return the current key and value pair from an array and advance the
17222 * array cursor.
17223 *
17224 * After {@link each} has executed, the array cursor will be left on the
17225 * next element of the array, or past the last element if it hits the end
17226 * of the array. You have to use {@link reset} if you want to traverse
17227 * the array again using each.
17228 *
17229 * @param array $array The input array.
17230 * @return array
17231 * @since PHP 4, PHP 5
17232 **/
17233function each(&$array){}
17234
17235/**
17236 * Returns the Unix timestamp corresponding to midnight on Easter of the
17237 * given year.
17238 *
17239 * The date of Easter Day was defined by the Council of Nicaea in AD325
17240 * as the Sunday after the first full moon which falls on or after the
17241 * Spring Equinox. The Equinox is assumed to always fall on 21st March,
17242 * so the calculation reduces to determining the date of the full moon
17243 * and the date of the following Sunday. The algorithm used here was
17244 * introduced around the year 532 by Dionysius Exiguus. Under the Julian
17245 * Calendar (for years before 1753) a simple 19-year cycle is used to
17246 * track the phases of the Moon. Under the Gregorian Calendar (for years
17247 * after 1753 - devised by Clavius and Lilius, and introduced by Pope
17248 * Gregory XIII in October 1582, and into Britain and its then colonies
17249 * in September 1752) two correction factors are added to make the cycle
17250 * more accurate.
17251 *
17252 * @param int $year The year as a number between 1970 an 2037
17253 * @return int
17254 * @since PHP 4, PHP 5
17255 **/
17256function easter_date($year){}
17257
17258/**
17259 * Returns the number of days after March 21 on which Easter falls for a
17260 * given year. If no year is specified, the current year is assumed.
17261 *
17262 * This function can be used instead of {@link easter_date} to calculate
17263 * Easter for years which fall outside the range of Unix timestamps (i.e.
17264 * before 1970 or after 2037).
17265 *
17266 * The date of Easter Day was defined by the Council of Nicaea in AD325
17267 * as the Sunday after the first full moon which falls on or after the
17268 * Spring Equinox. The Equinox is assumed to always fall on 21st March,
17269 * so the calculation reduces to determining the date of the full moon
17270 * and the date of the following Sunday. The algorithm used here was
17271 * introduced around the year 532 by Dionysius Exiguus. Under the Julian
17272 * Calendar (for years before 1753) a simple 19-year cycle is used to
17273 * track the phases of the Moon. Under the Gregorian Calendar (for years
17274 * after 1753 - devised by Clavius and Lilius, and introduced by Pope
17275 * Gregory XIII in October 1582, and into Britain and its then colonies
17276 * in September 1752) two correction factors are added to make the cycle
17277 * more accurate.
17278 *
17279 * @param int $year The year as a positive number
17280 * @param int $method Allows to calculate easter dates based on the
17281 *   Gregorian calendar during the years 1582 - 1752 when set to
17282 *   CAL_EASTER_ROMAN. See the calendar constants for more valid
17283 *   constants.
17284 * @return int
17285 * @since PHP 4, PHP 5
17286 **/
17287function easter_days($year, $method){}
17288
17289/**
17290 * Enumerates the Enchant providers and tells you some rudimentary
17291 * information about them. The same info is provided through phpinfo().
17292 *
17293 * @param resource $broker Broker resource
17294 * @return array
17295 * @since PECL enchant >= 0.1.0
17296 **/
17297function enchant_broker_describe($broker){}
17298
17299/**
17300 * Tells if a dictionary exists or not, using a non-empty tags
17301 *
17302 * @param resource $broker Broker resource
17303 * @param string $tag non-empty tag in the LOCALE format, ex: us_US,
17304 *   ch_DE, etc.
17305 * @return bool
17306 * @since PECL enchant >= 0.1.0
17307 **/
17308function enchant_broker_dict_exists($broker, $tag){}
17309
17310/**
17311 * Free a broker resource with all its dictionaries.
17312 *
17313 * @param resource $broker Broker resource
17314 * @return bool
17315 * @since PECL enchant >= 0.1.0
17316 **/
17317function enchant_broker_free($broker){}
17318
17319/**
17320 * Free a dictionary resource.
17321 *
17322 * @param resource $dict Dictionary resource.
17323 * @return bool
17324 * @since PECL enchant >= 0.1.0
17325 **/
17326function enchant_broker_free_dict($dict){}
17327
17328/**
17329 * Returns the last error which occurred in this broker.
17330 *
17331 * @param resource $broker Broker resource.
17332 * @return string
17333 * @since PECL enchant >= 0.1.0
17334 **/
17335function enchant_broker_get_error($broker){}
17336
17337/**
17338 * @return resource
17339 * @since PECL enchant >= 0.1.0
17340 **/
17341function enchant_broker_init(){}
17342
17343/**
17344 * Returns a list of available dictionaries with their details.
17345 *
17346 * @param resource $broker Broker resource
17347 * @return mixed
17348 * @since PECL enchant >= 1.0.1
17349 **/
17350function enchant_broker_list_dicts($broker){}
17351
17352/**
17353 * create a new dictionary using tag, the non-empty language tag you wish
17354 * to request a dictionary for ("en_US", "de_DE", ...)
17355 *
17356 * @param resource $broker Broker resource
17357 * @param string $tag A tag describing the locale, for example en_US,
17358 *   de_DE
17359 * @return resource
17360 * @since PECL enchant >= 0.1.0
17361 **/
17362function enchant_broker_request_dict($broker, $tag){}
17363
17364/**
17365 * Creates a dictionary using a PWL file. A PWL file is personal word
17366 * file one word per line.
17367 *
17368 * @param resource $broker Broker resource
17369 * @param string $filename Path to the PWL file.
17370 * @return resource
17371 * @since PECL enchant >= 0.1.0
17372 **/
17373function enchant_broker_request_pwl_dict($broker, $filename){}
17374
17375/**
17376 * Declares a preference of dictionaries to use for the language
17377 * described/referred to by 'tag'. The ordering is a comma delimited list
17378 * of provider names. As a special exception, the "*" tag can be used as
17379 * a language tag to declare a default ordering for any language that
17380 * does not explicitly declare an ordering.
17381 *
17382 * @param resource $broker Broker resource
17383 * @param string $tag Language tag. The special "*" tag can be used as
17384 *   a language tag to declare a default ordering for any language that
17385 *   does not explicitly declare an ordering.
17386 * @param string $ordering Comma delimited list of provider names
17387 * @return bool
17388 * @since PECL enchant >= 0.1.0
17389 **/
17390function enchant_broker_set_ordering($broker, $tag, $ordering){}
17391
17392/**
17393 * Add a word to personal word list of the given dictionary.
17394 *
17395 * @param resource $dict Dictionary resource
17396 * @param string $word The word to add
17397 * @return void
17398 * @since PECL enchant >= 0.1.0
17399 **/
17400function enchant_dict_add_to_personal($dict, $word){}
17401
17402/**
17403 * Add a word to the given dictionary. It will be added only for the
17404 * active spell-checking session.
17405 *
17406 * @param resource $dict Dictionary resource
17407 * @param string $word The word to add
17408 * @return void
17409 * @since PECL enchant >= 0.1.0
17410 **/
17411function enchant_dict_add_to_session($dict, $word){}
17412
17413/**
17414 * If the word is correctly spelled return , otherwise return
17415 *
17416 * @param resource $dict Dictionary resource
17417 * @param string $word The word to check
17418 * @return bool
17419 * @since PECL enchant >= 0.1.0
17420 **/
17421function enchant_dict_check($dict, $word){}
17422
17423/**
17424 * Returns the details of the dictionary.
17425 *
17426 * @param resource $dict Dictinaray resource
17427 * @return mixed
17428 * @since PECL enchant >= 0.1.0
17429 **/
17430function enchant_dict_describe($dict){}
17431
17432/**
17433 * Returns the last error of the current spelling-session
17434 *
17435 * @param resource $dict Dictinaray resource
17436 * @return string
17437 * @since PECL enchant >= 0.1.0
17438 **/
17439function enchant_dict_get_error($dict){}
17440
17441/**
17442 * Tells whether or not a word already exists in the current session.
17443 *
17444 * @param resource $dict Dictionary resource
17445 * @param string $word The word to lookup
17446 * @return bool
17447 * @since PECL enchant >= 0.1.0
17448 **/
17449function enchant_dict_is_in_session($dict, $word){}
17450
17451/**
17452 * If the word is correctly spelled return , otherwise return , if
17453 * suggestions variable is provided, fill it with spelling alternatives.
17454 *
17455 * @param resource $dict Dictionary resource
17456 * @param string $word The word to check
17457 * @param array $suggestions If the word is not correctly spelled, this
17458 *   variable will contain an array of suggestions.
17459 * @return bool
17460 * @since PECL enchant:0.2.0-1.0.1
17461 **/
17462function enchant_dict_quick_check($dict, $word, &$suggestions){}
17463
17464/**
17465 * Add a correction for 'mis' using 'cor'. Notes that you replaced @mis
17466 * with @cor, so it's possibly more likely that future occurrences of
17467 * @mis will be replaced with @cor. So it might bump @cor up in the
17468 * suggestion list.
17469 *
17470 * @param resource $dict Dictionary resource
17471 * @param string $mis The work to fix
17472 * @param string $cor The correct word
17473 * @return void
17474 * @since PECL enchant >= 0.1.0
17475 **/
17476function enchant_dict_store_replacement($dict, $mis, $cor){}
17477
17478/**
17479 * @param resource $dict Dictionary resource
17480 * @param string $word Word to use for the suggestions.
17481 * @return array
17482 * @since PECL enchant >= 0.1.0
17483 **/
17484function enchant_dict_suggest($dict, $word){}
17485
17486/**
17487 * {@link end} advances {@link array}'s internal pointer to the last
17488 * element, and returns its value.
17489 *
17490 * @param array $array The array. This array is passed by reference
17491 *   because it is modified by the function. This means you must pass it
17492 *   a real variable and not a function returning an array because only
17493 *   actual variables may be passed by reference.
17494 * @return mixed
17495 * @since PHP 4, PHP 5
17496 **/
17497function end(&$array){}
17498
17499/**
17500 * @param string $pattern Case sensitive regular expression.
17501 * @param string $string The input string.
17502 * @param array $regs If matches are found for parenthesized substrings
17503 *   of {@link pattern} and the function is called with the third
17504 *   argument {@link regs}, the matches will be stored in the elements of
17505 *   the array {@link regs}. $regs[1] will contain the substring which
17506 *   starts at the first left parenthesis; $regs[2] will contain the
17507 *   substring starting at the second, and so on. $regs[0] will contain a
17508 *   copy of the complete string matched.
17509 * @return int
17510 * @since PHP 4, PHP 5
17511 **/
17512function ereg($pattern, $string, &$regs){}
17513
17514/**
17515 * This function is identical to {@link ereg} except that it ignores case
17516 * distinction when matching alphabetic characters.
17517 *
17518 * @param string $pattern Case insensitive regular expression.
17519 * @param string $string The input string.
17520 * @param array $regs If matches are found for parenthesized substrings
17521 *   of {@link pattern} and the function is called with the third
17522 *   argument {@link regs}, the matches will be stored in the elements of
17523 *   the array {@link regs}. $regs[1] will contain the substring which
17524 *   starts at the first left parenthesis; $regs[2] will contain the
17525 *   substring starting at the second, and so on. $regs[0] will contain a
17526 *   copy of the complete string matched.
17527 * @return int
17528 * @since PHP 4, PHP 5
17529 **/
17530function eregi($pattern, $string, &$regs){}
17531
17532/**
17533 * This function is identical to {@link ereg_replace} except that this
17534 * ignores case distinction when matching alphabetic characters.
17535 *
17536 * @param string $pattern A POSIX extended regular expression.
17537 * @param string $replacement If {@link pattern} contains parenthesized
17538 *   substrings, {@link replacement} may contain substrings of the form
17539 *   \\digit, which will be replaced by the text matching the digit'th
17540 *   parenthesized substring; \\0 will produce the entire contents of
17541 *   string. Up to nine substrings may be used. Parentheses may be
17542 *   nested, in which case they are counted by the opening parenthesis.
17543 * @param string $string The input string.
17544 * @return string
17545 * @since PHP 4, PHP 5
17546 **/
17547function eregi_replace($pattern, $replacement, $string){}
17548
17549/**
17550 * @param string $pattern A POSIX extended regular expression.
17551 * @param string $replacement If {@link pattern} contains parenthesized
17552 *   substrings, {@link replacement} may contain substrings of the form
17553 *   \\digit, which will be replaced by the text matching the digit'th
17554 *   parenthesized substring; \\0 will produce the entire contents of
17555 *   string. Up to nine substrings may be used. Parentheses may be
17556 *   nested, in which case they are counted by the opening parenthesis.
17557 * @param string $string The input string.
17558 * @return string
17559 * @since PHP 4, PHP 5
17560 **/
17561function ereg_replace($pattern, $replacement, $string){}
17562
17563/**
17564 * Gets information about the last error that occurred.
17565 *
17566 * @return array
17567 * @since PHP 5 >= 5.2.0
17568 **/
17569function error_get_last(){}
17570
17571/**
17572 * Sends an error message to the web server's error log, a TCP port or to
17573 * a file.
17574 *
17575 * @param string $message The error message that should be logged.
17576 * @param int $message_type Says where the error should go. The
17577 *   possible message types are as follows:
17578 *
17579 *   {@link error_log} log types 0 {@link message} is sent to PHP's
17580 *   system logger, using the Operating System's system logging mechanism
17581 *   or a file, depending on what the error_log configuration directive
17582 *   is set to. This is the default option. 1 {@link message} is sent by
17583 *   email to the address in the {@link destination} parameter. This is
17584 *   the only message type where the fourth parameter, {@link
17585 *   extra_headers} is used. 2 No longer an option. 3 {@link message} is
17586 *   appended to the file {@link destination}. A newline is not
17587 *   automatically added to the end of the {@link message} string. 4
17588 *   {@link message} is sent directly to the SAPI logging handler.
17589 * @param string $destination The destination. Its meaning depends on
17590 *   the {@link message_type} parameter as described above.
17591 * @param string $extra_headers The extra headers. It's used when the
17592 *   {@link message_type} parameter is set to 1. This message type uses
17593 *   the same internal function as {@link mail} does.
17594 * @return bool
17595 * @since PHP 4, PHP 5
17596 **/
17597function error_log($message, $message_type, $destination, $extra_headers){}
17598
17599/**
17600 * The {@link error_reporting} function sets the error_reporting
17601 * directive at runtime. PHP has many levels of errors, using this
17602 * function sets that level for the duration (runtime) of your script. If
17603 * the optional {@link level} is not set, {@link error_reporting} will
17604 * just return the current error reporting level.
17605 *
17606 * @param int $level The new error_reporting level. It takes on either
17607 *   a bitmask, or named constants. Using named constants is strongly
17608 *   encouraged to ensure compatibility for future versions. As error
17609 *   levels are added, the range of integers increases, so older
17610 *   integer-based error levels will not always behave as expected. The
17611 *   available error level constants and the actual meanings of these
17612 *   error levels are described in the predefined constants.
17613 * @return int
17614 * @since PHP 4, PHP 5
17615 **/
17616function error_reporting($level){}
17617
17618/**
17619 * {@link escapeshellarg} adds single quotes around a string and
17620 * quotes/escapes any existing single quotes allowing you to pass a
17621 * string directly to a shell function and having it be treated as a
17622 * single safe argument. This function should be used to escape
17623 * individual arguments to shell functions coming from user input. The
17624 * shell functions include {@link exec}, {@link system} and the backtick
17625 * operator.
17626 *
17627 * @param string $arg The argument that will be escaped.
17628 * @return string
17629 * @since PHP 4 >= 4.0.3, PHP 5
17630 **/
17631function escapeshellarg($arg){}
17632
17633/**
17634 * {@link escapeshellcmd} escapes any characters in a string that might
17635 * be used to trick a shell command into executing arbitrary commands.
17636 * This function should be used to make sure that any data coming from
17637 * user input is escaped before this data is passed to the {@link exec}
17638 * or {@link system} functions, or to the backtick operator.
17639 *
17640 * Following characters are preceded by a backslash: #&;`|*?~<>^()[]{}$\,
17641 * \x0A and \xFF. ' and " are escaped only if they are not paired. In
17642 * Windows, all these characters plus % are replaced by a space instead.
17643 *
17644 * @param string $command The command that will be escaped.
17645 * @return string
17646 * @since PHP 4, PHP 5
17647 **/
17648function escapeshellcmd($command){}
17649
17650/**
17651 * {@link event_add} schedules the execution of the {@link event} when
17652 * the event specified in {@link event_set} occurs or in at least the
17653 * time specified by the {@link timeout} argument. If {@link timeout} was
17654 * not specified, not timeout is set. The {@link event} must be already
17655 * initalized by {@link event_set} and {@link event_base_set} functions.
17656 * If the {@link event} already has a timeout set, it is replaced by the
17657 * new one.
17658 *
17659 * @param resource $event Valid event resource.
17660 * @param int $timeout Optional timeout (in microseconds).
17661 * @return bool
17662 * @since PECL libevent >= 0.0.1
17663 **/
17664function event_add($event, $timeout){}
17665
17666/**
17667 * Destroys the specified {@link event_base} and frees all the resources
17668 * associated. Note that it's not possible to destroy an event base with
17669 * events attached to it.
17670 *
17671 * @param resource $event_base Valid event base resource.
17672 * @return void
17673 * @since PECL libevent >= 0.0.1
17674 **/
17675function event_base_free($event_base){}
17676
17677/**
17678 * Starts event loop for the specified event base.
17679 *
17680 * @param resource $event_base Valid event base resource.
17681 * @param int $flags Optional parameter, which can take any combination
17682 *   of EVLOOP_ONCE and EVLOOP_NONBLOCK.
17683 * @return int
17684 * @since PECL libevent >= 0.0.1
17685 **/
17686function event_base_loop($event_base, $flags){}
17687
17688/**
17689 * Abort the active event loop immediately. The behaviour is similar to
17690 * break statement.
17691 *
17692 * @param resource $event_base Valid event base resource.
17693 * @return bool
17694 * @since PECL libevent >= 0.0.1
17695 **/
17696function event_base_loopbreak($event_base){}
17697
17698/**
17699 * The next event loop iteration after the given timer expires will
17700 * complete normally, then exit without blocking for events again.
17701 *
17702 * @param resource $event_base Valid event base resource.
17703 * @param int $timeout Optional timeout parameter (in microseconds).
17704 * @return bool
17705 * @since PECL libevent >= 0.0.1
17706 **/
17707function event_base_loopexit($event_base, $timeout){}
17708
17709/**
17710 * Returns new event base, which can be used later in {@link
17711 * event_base_set}, {@link event_base_loop} and other functions.
17712 *
17713 * @return resource
17714 * @since PECL libevent >= 0.0.1
17715 **/
17716function event_base_new(){}
17717
17718/**
17719 * Sets the number of different event priority levels.
17720 *
17721 * By default all events are scheduled with the same priority ({@link
17722 * npriorities}/2). Using {@link event_base_priority_init} you can change
17723 * the number of event priority levels and then set a desired priority
17724 * for each event.
17725 *
17726 * @param resource $event_base Valid event base resource.
17727 * @param int $npriorities The number of event priority levels.
17728 * @return bool
17729 * @since PECL libevent >= 0.0.2
17730 **/
17731function event_base_priority_init($event_base, $npriorities){}
17732
17733/**
17734 * Associates the {@link event_base} with the {@link event}.
17735 *
17736 * @param resource $event Valid event resource.
17737 * @param resource $event_base Valid event base resource.
17738 * @return bool
17739 * @since PECL libevent >= 0.0.1
17740 **/
17741function event_base_set($event, $event_base){}
17742
17743/**
17744 * Assign the specified {@link bevent} to the {@link event_base}.
17745 *
17746 * @param resource $bevent Valid buffered event resource.
17747 * @param resource $event_base Valid event base resource.
17748 * @return bool
17749 * @since PECL libevent >= 0.0.1
17750 **/
17751function event_buffer_base_set($bevent, $event_base){}
17752
17753/**
17754 * Disables the specified buffered event.
17755 *
17756 * @param resource $bevent Valid buffered event resource.
17757 * @param int $events Any combination of EV_READ and EV_WRITE.
17758 * @return bool
17759 * @since PECL libevent >= 0.0.1
17760 **/
17761function event_buffer_disable($bevent, $events){}
17762
17763/**
17764 * Enables the specified buffered event.
17765 *
17766 * @param resource $bevent Valid buffered event resource.
17767 * @param int $events Any combination of EV_READ and EV_WRITE.
17768 * @return bool
17769 * @since PECL libevent >= 0.0.1
17770 **/
17771function event_buffer_enable($bevent, $events){}
17772
17773/**
17774 * Changes the file descriptor on which the buffered event operates.
17775 *
17776 * @param resource $bevent Valid buffered event resource.
17777 * @param resource $fd Valid PHP stream, must be castable to file
17778 *   descriptor.
17779 * @return void
17780 * @since PECL libevent >= 0.0.1
17781 **/
17782function event_buffer_fd_set($bevent, $fd){}
17783
17784/**
17785 * Destroys the specified buffered event and frees all the resources
17786 * associated.
17787 *
17788 * @param resource $bevent Valid buffered event resource.
17789 * @return void
17790 * @since PECL libevent >= 0.0.1
17791 **/
17792function event_buffer_free($bevent){}
17793
17794/**
17795 * Libevent provides an abstraction layer on top of the regular event
17796 * API. Using buffered event you don't need to deal with the I/O
17797 * manually, instead it provides input and output buffers that get filled
17798 * and drained automatically.
17799 *
17800 * @param resource $stream Valid PHP stream resource. Must be castable
17801 *   to file descriptor.
17802 * @param mixed $readcb Callback to invoke where there is data to read,
17803 *   or NULL if no callback is desired.
17804 * @param mixed $writecb Callback to invoke where the descriptor is
17805 *   ready for writing, or NULL if no callback is desired.
17806 * @param mixed $errorcb Callback to invoke where there is an error on
17807 *   the descriptor, cannot be NULL.
17808 * @param mixed $arg An argument that will be passed to each of the
17809 *   callbacks (optional).
17810 * @return resource
17811 * @since PECL libevent >= 0.0.1
17812 **/
17813function event_buffer_new($stream, $readcb, $writecb, $errorcb, $arg){}
17814
17815/**
17816 * Assign a priority to the {@link bevent}.
17817 *
17818 * @param resource $bevent Valid buffered event resource.
17819 * @param int $priority Priority level. Cannot be less than zero and
17820 *   cannot exceed maximum priority level of the event base (see {@link
17821 *   event_base_priority_init}).
17822 * @return bool
17823 * @since PECL libevent >= 0.0.1
17824 **/
17825function event_buffer_priority_set($bevent, $priority){}
17826
17827/**
17828 * Reads data from the input buffer of the buffered event.
17829 *
17830 * @param resource $bevent Valid buffered event resource.
17831 * @param int $data_size Data size in bytes.
17832 * @return string
17833 * @since PECL libevent >= 0.0.1
17834 **/
17835function event_buffer_read($bevent, $data_size){}
17836
17837/**
17838 * Sets or changes existing callbacks for the buffered {@link event}.
17839 *
17840 * @param resource $event Valid buffered event resource.
17841 * @param mixed $readcb Callback to invoke where there is data to read,
17842 *   or NULL if no callback is desired.
17843 * @param mixed $writecb Callback to invoke where the descriptor is
17844 *   ready for writing, or NULL if no callback is desired.
17845 * @param mixed $errorcb Callback to invoke where there is an error on
17846 *   the descriptor, cannot be NULL.
17847 * @param mixed $arg An argument that will be passed to each of the
17848 *   callbacks (optional).
17849 * @return resource
17850 * @since PECL libevent >= 0.0.4
17851 **/
17852function event_buffer_set_callback($event, $readcb, $writecb, $errorcb, $arg){}
17853
17854/**
17855 * Sets the read and write timeouts for the specified buffered event.
17856 *
17857 * @param resource $bevent Valid buffered event resource.
17858 * @param int $read_timeout Read timeout (in seconds).
17859 * @param int $write_timeout Write timeout (in seconds).
17860 * @return void
17861 * @since PECL libevent >= 0.0.1
17862 **/
17863function event_buffer_timeout_set($bevent, $read_timeout, $write_timeout){}
17864
17865/**
17866 * Sets the watermarks for read and write events. Libevent does not
17867 * invoke read callback unless there is at least {@link lowmark} bytes in
17868 * the input buffer; if the read buffer is beyond the {@link highmark},
17869 * reading is stopped. On output, the write callback is invoked whenever
17870 * the buffered data falls below the {@link lowmark}.
17871 *
17872 * @param resource $bevent Valid buffered event resource.
17873 * @param int $events Any combination of EV_READ and EV_WRITE.
17874 * @param int $lowmark Low watermark.
17875 * @param int $highmark High watermark.
17876 * @return void
17877 * @since PECL libevent >= 0.0.1
17878 **/
17879function event_buffer_watermark_set($bevent, $events, $lowmark, $highmark){}
17880
17881/**
17882 * Writes data to the specified buffered event. The data is appended to
17883 * the output buffer and written to the descriptor when it becomes
17884 * available for writing.
17885 *
17886 * @param resource $bevent Valid buffered event resource.
17887 * @param string $data The data to be written.
17888 * @param int $data_size Optional size parameter. {@link
17889 *   event_buffer_write} writes all the {@link data} by default.
17890 * @return bool
17891 * @since PECL libevent >= 0.0.1
17892 **/
17893function event_buffer_write($bevent, $data, $data_size){}
17894
17895/**
17896 * Cancels the {@link event}.
17897 *
17898 * @param resource $event Valid event resource.
17899 * @return bool
17900 * @since PECL libevent >= 0.0.1
17901 **/
17902function event_del($event){}
17903
17904/**
17905 * Frees previously created event resource.
17906 *
17907 * @param resource $event Valid event resource.
17908 * @return void
17909 * @since PECL libevent >= 0.0.1
17910 **/
17911function event_free($event){}
17912
17913/**
17914 * Creates and returns a new event resource.
17915 *
17916 * @return resource
17917 * @since PECL libevent >= 0.0.1
17918 **/
17919function event_new(){}
17920
17921/**
17922 * Prepares the event to be used in {@link event_add}. The event is
17923 * prepared to call the function specified by the {@link callback} on the
17924 * events specified in parameter {@link events}, which is a set of the
17925 * following flags: EV_TIMEOUT, EV_SIGNAL, EV_READ, EV_WRITE, EV_PERSIST
17926 * and EV_SIGNAL.
17927 *
17928 * If EV_SIGNAL bit is set in parameter {@link events}, the {@link fd} is
17929 * interpreted as signal number.
17930 *
17931 * After initializing the event, use {@link event_base_set} to associate
17932 * the event with its event base.
17933 *
17934 * In case of matching event, these three arguments are passed to the
17935 * {@link callback} function: {@link fd} Signal number or resource
17936 * indicating the stream. {@link events} A flag indicating the event.
17937 * Consists of the following flags: EV_TIMEOUT, EV_SIGNAL, EV_READ,
17938 * EV_WRITE, EV_PERSIST and EV_SIGNAL. {@link arg} Optional parameter,
17939 * previously passed to {@link event_set} as {@link arg}.
17940 *
17941 * @param resource $event Valid event resource.
17942 * @param mixed $fd Valid PHP stream resource. The stream must be
17943 *   castable to file descriptor, so you most likely won't be able to use
17944 *   any of filtered streams.
17945 * @param int $events A set of flags indicating the desired event, can
17946 *   be EV_READ and/or EV_WRITE. The additional flag EV_PERSIST makes the
17947 *   event to persist until {@link event_del} is called, otherwise the
17948 *   callback is invoked only once.
17949 * @param mixed $callback Callback function to be called when the
17950 *   matching event occurs.
17951 * @param mixed $arg Optional callback parameter.
17952 * @return bool
17953 * @since PECL libevent >= 0.0.1
17954 **/
17955function event_set($event, $fd, $events, $callback, $arg){}
17956
17957/**
17958 * {@link exec} executes the given {@link command}.
17959 *
17960 * @param string $command The command that will be executed.
17961 * @param array $output If the {@link output} argument is present, then
17962 *   the specified array will be filled with every line of output from
17963 *   the command. Trailing whitespace, such as \n, is not included in
17964 *   this array. Note that if the array already contains some elements,
17965 *   {@link exec} will append to the end of the array. If you do not want
17966 *   the function to append elements, call {@link unset} on the array
17967 *   before passing it to {@link exec}.
17968 * @param int $return_var If the {@link return_var} argument is present
17969 *   along with the {@link output} argument, then the return status of
17970 *   the executed command will be written to this variable.
17971 * @return string
17972 * @since PHP 4, PHP 5
17973 **/
17974function exec($command, &$output, &$return_var){}
17975
17976/**
17977 * {@link exif_imagetype} reads the first bytes of an image and checks
17978 * its signature.
17979 *
17980 * {@link exif_imagetype} can be used to avoid calls to other exif
17981 * functions with unsupported file types or in conjunction with
17982 * $_SERVER['HTTP_ACCEPT'] to check whether or not the viewer is able to
17983 * see a specific image in the browser.
17984 *
17985 * @param string $filename
17986 * @return int
17987 * @since PHP 4 >= 4.3.0, PHP 5
17988 **/
17989function exif_imagetype($filename){}
17990
17991/**
17992 * {@link exif_read_data} reads the EXIF headers from a JPEG or TIFF
17993 * image file. This way you can read meta data generated by digital
17994 * cameras.
17995 *
17996 * EXIF headers tend to be present in JPEG/TIFF images generated by
17997 * digital cameras, but unfortunately each digital camera maker has a
17998 * different idea of how to actually tag their images, so you can't
17999 * always rely on a specific Exif header being present.
18000 *
18001 * Height and Width are computed the same way {@link getimagesize} does
18002 * so their values must not be part of any header returned. Also, html is
18003 * a height/width text string to be used inside normal HTML.
18004 *
18005 * When an Exif header contains a Copyright note, this itself can contain
18006 * two values. As the solution is inconsistent in the Exif 2.10 standard,
18007 * the COMPUTED section will return both entries Copyright.Photographer
18008 * and Copyright.Editor while the IFD0 sections contains the byte array
18009 * with the NULL character that splits both entries. Or just the first
18010 * entry if the datatype was wrong (normal behaviour of Exif). The
18011 * COMPUTED will also contain the entry Copyright which is either the
18012 * original copyright string, or a comma separated list of the photo and
18013 * editor copyright.
18014 *
18015 * The tag UserComment has the same problem as the Copyright tag. It can
18016 * store two values. First the encoding used, and second the value
18017 * itself. If so the IFD section only contains the encoding or a byte
18018 * array. The COMPUTED section will store both in the entries
18019 * UserCommentEncoding and UserComment. The entry UserComment is
18020 * available in both cases so it should be used in preference to the
18021 * value in IFD0 section.
18022 *
18023 * {@link exif_read_data} also validates EXIF data tags according to the
18024 * EXIF specification (, page 20).
18025 *
18026 * @param string $filename The name of the image file being read. This
18027 *   cannot be an URL.
18028 * @param string $sections Is a comma separated list of sections that
18029 *   need to be present in file to produce a result array. If none of the
18030 *   requested sections could be found the return value is . FILE
18031 *   FileName, FileSize, FileDateTime, SectionsFound COMPUTED html,
18032 *   Width, Height, IsColor, and more if available. Height and Width are
18033 *   computed the same way {@link getimagesize} does so their values must
18034 *   not be part of any header returned. Also, html is a height/width
18035 *   text string to be used inside normal HTML. ANY_TAG Any information
18036 *   that has a Tag e.g. IFD0, EXIF, ... IFD0 All tagged data of IFD0. In
18037 *   normal imagefiles this contains image size and so forth. THUMBNAIL A
18038 *   file is supposed to contain a thumbnail if it has a second IFD. All
18039 *   tagged information about the embedded thumbnail is stored in this
18040 *   section. COMMENT Comment headers of JPEG images. EXIF The EXIF
18041 *   section is a sub section of IFD0. It contains more detailed
18042 *   information about an image. Most of these entries are digital camera
18043 *   related.
18044 * @param bool $arrays Specifies whether or not each section becomes an
18045 *   array. The {@link sections} COMPUTED, THUMBNAIL, and COMMENT always
18046 *   become arrays as they may contain values whose names conflict with
18047 *   other sections.
18048 * @param bool $thumbnail When set to the thumbnail itself is read.
18049 *   Otherwise, only the tagged data is read.
18050 * @return array
18051 * @since PHP 4 >= 4.2.0, PHP 5
18052 **/
18053function exif_read_data($filename, $sections, $arrays, $thumbnail){}
18054
18055/**
18056 * @param int $index The image index
18057 * @return string
18058 * @since PHP 4 >= 4.2.0, PHP 5
18059 **/
18060function exif_tagname($index){}
18061
18062/**
18063 * {@link exif_thumbnail} reads the embedded thumbnail of a TIFF or JPEG
18064 * image.
18065 *
18066 * If you want to deliver thumbnails through this function, you should
18067 * send the mimetype information using the {@link header} function.
18068 *
18069 * It is possible that {@link exif_thumbnail} cannot create an image but
18070 * can determine its size. In this case, the return value is but {@link
18071 * width} and {@link height} are set.
18072 *
18073 * @param string $filename The name of the image file being read. This
18074 *   image contains an embedded thumbnail.
18075 * @param int $width The return width of the returned thumbnail.
18076 * @param int $height The returned height of the returned thumbnail.
18077 * @param int $imagetype The returned image type of the returned
18078 *   thumbnail. This is either TIFF or JPEG.
18079 * @return string
18080 * @since PHP 4 >= 4.2.0, PHP 5
18081 **/
18082function exif_thumbnail($filename, &$width, &$height, &$imagetype){}
18083
18084/**
18085 * Returns e raised to the power of {@link arg}.
18086 *
18087 * @param float $arg The argument to process
18088 * @return float
18089 * @since PHP 4, PHP 5
18090 **/
18091function exp($arg){}
18092
18093/**
18094 * Waits until the output from a process matches one of the patterns, a
18095 * specified time period has passed, or an EOF is seen.
18096 *
18097 * If {@link match} is provided, then it is filled with the result of
18098 * search. The matched string can be found in {@link match[0]}. The match
18099 * substrings (according to the parentheses) in the original pattern can
18100 * be found in {@link match[1]}, {@link match[2]}, and so on, up to
18101 * {@link match[9]} (the limitation of libexpect).
18102 *
18103 * @param resource $expect An Expect stream, previously opened with
18104 *   {@link expect_popen}.
18105 * @param array $cases An array of expect cases. Each expect case is an
18106 *   indexed array, as described in the following table: Expect Case
18107 *   Array Index Key Value Type Description Is Mandatory Default Value 0
18108 *   string pattern, that will be matched against the output from the
18109 *   stream yes 1 mixed value, that will be returned by this function, if
18110 *   the pattern matches yes 2 integer pattern type, one of: EXP_GLOB,
18111 *   EXP_EXACT or EXP_REGEXP no EXP_GLOB
18112 * @param array $match
18113 * @return int
18114 * @since PECL expect >= 0.1.0
18115 **/
18116function expect_expectl($expect, $cases, &$match){}
18117
18118/**
18119 * Execute command via Bourne shell, and open the PTY stream to the
18120 * process.
18121 *
18122 * @param string $command Command to execute.
18123 * @return resource
18124 * @since PECL expect >= 0.1.0
18125 **/
18126function expect_popen($command){}
18127
18128/**
18129 * Returns an array of strings, each of which is a substring of {@link
18130 * string} formed by splitting it on boundaries formed by the string
18131 * {@link delimiter}.
18132 *
18133 * @param string $delimiter The boundary string.
18134 * @param string $string The input string.
18135 * @param int $limit If {@link limit} is set and positive, the returned
18136 *   array will contain a maximum of {@link limit} elements with the last
18137 *   element containing the rest of {@link string}. If the {@link limit}
18138 *   parameter is negative, all components except the last -{@link limit}
18139 *   are returned. If the {@link limit} parameter is zero, then this is
18140 *   treated as 1.
18141 * @return array
18142 * @since PHP 4, PHP 5
18143 **/
18144function explode($delimiter, $string, $limit){}
18145
18146/**
18147 * {@link expm1} returns the equivalent to 'exp({@link arg}) - 1'
18148 * computed in a way that is accurate even if the value of {@link arg} is
18149 * near zero, a case where 'exp ({@link arg}) - 1' would be inaccurate
18150 * due to subtraction of two numbers that are nearly equal.
18151 *
18152 * @param float $arg The argument to process
18153 * @return float
18154 * @since PHP 4 >= 4.1.0, PHP 5
18155 **/
18156function expm1($arg){}
18157
18158/**
18159 * Finds out whether the extension is loaded.
18160 *
18161 * @param string $name The extension name. You can see the names of
18162 *   various extensions by using {@link phpinfo} or if you're using the
18163 *   CGI or CLI version of PHP you can use the -m switch to list all
18164 *   available extensions:
18165 *
18166 *   $ php -m [PHP Modules] xml tokenizer standard sockets session posix
18167 *   pcre overload mysql mbstring ctype
18168 *
18169 *   [Zend Modules]
18170 * @return bool
18171 * @since PHP 4, PHP 5
18172 **/
18173function extension_loaded($name){}
18174
18175/**
18176 * Import variables from an array into the current symbol table.
18177 *
18178 * Checks each key to see whether it has a valid variable name. It also
18179 * checks for collisions with existing variables in the symbol table.
18180 *
18181 * @param array $var_array An associative array. This function treats
18182 *   keys as variable names and values as variable values. For each
18183 *   key/value pair it will create a variable in the current symbol
18184 *   table, subject to {@link extract_type} and {@link prefix}
18185 *   parameters. You must use an associative array; a numerically indexed
18186 *   array will not produce results unless you use EXTR_PREFIX_ALL or
18187 *   EXTR_PREFIX_INVALID.
18188 * @param int $extract_type The way invalid/numeric keys and collisions
18189 *   are treated is determined by the {@link extract_type}. It can be one
18190 *   of the following values: EXTR_OVERWRITE If there is a collision,
18191 *   overwrite the existing variable. EXTR_SKIP If there is a collision,
18192 *   don't overwrite the existing variable. EXTR_PREFIX_SAME If there is
18193 *   a collision, prefix the variable name with {@link prefix}.
18194 *   EXTR_PREFIX_ALL Prefix all variable names with {@link prefix}.
18195 *   EXTR_PREFIX_INVALID Only prefix invalid/numeric variable names with
18196 *   {@link prefix}. EXTR_IF_EXISTS Only overwrite the variable if it
18197 *   already exists in the current symbol table, otherwise do nothing.
18198 *   This is useful for defining a list of valid variables and then
18199 *   extracting only those variables you have defined out of $_REQUEST,
18200 *   for example. EXTR_PREFIX_IF_EXISTS Only create prefixed variable
18201 *   names if the non-prefixed version of the same variable exists in the
18202 *   current symbol table. EXTR_REFS Extracts variables as references.
18203 *   This effectively means that the values of the imported variables are
18204 *   still referencing the values of the {@link var_array} parameter. You
18205 *   can use this flag on its own or combine it with any other flag by
18206 *   OR'ing the {@link extract_type}. If {@link extract_type} is not
18207 *   specified, it is assumed to be EXTR_OVERWRITE.
18208 * @param string $prefix
18209 * @return int
18210 * @since PHP 4, PHP 5
18211 **/
18212function extract($var_array, $extract_type, $prefix){}
18213
18214/**
18215 * @param string $addr The email address that's being hashed.
18216 * @return int
18217 * @since PHP 4 >= 4.0.2, PHP 5
18218 **/
18219function ezmlm_hash($addr){}
18220
18221/**
18222 * Terminates monitoring on a resource.
18223 *
18224 * In addition an FAMAcknowledge event occurs.
18225 *
18226 * @param resource $fam A resource representing a connection to the FAM
18227 *   service returned by {@link fam_open}
18228 * @param resource $fam_monitor A resource returned by one of the
18229 *   fam_monitor_XXX functions
18230 * @return bool
18231 * @since PHP 5
18232 **/
18233function fam_cancel_monitor($fam, $fam_monitor){}
18234
18235/**
18236 * Closes a connection to the FAM service.
18237 *
18238 * @param resource $fam A resource representing a connection to the FAM
18239 *   service returned by {@link fam_open}
18240 * @return void
18241 * @since PHP 5
18242 **/
18243function fam_close($fam){}
18244
18245/**
18246 * Requests monitoring for a collection of files within a directory.
18247 *
18248 * A FAM event will be generated whenever the status of the files change.
18249 * The possible event codes are described in detail in the constants part
18250 * of this section.
18251 *
18252 * @param resource $fam A resource representing a connection to the FAM
18253 *   service returned by {@link fam_open}
18254 * @param string $dirname Directory path to the monitored files
18255 * @param int $depth The maximum search {@link depth} starting from
18256 *   this directory
18257 * @param string $mask A shell pattern {@link mask} restricting the
18258 *   file names to look for
18259 * @return resource
18260 * @since PHP 5
18261 **/
18262function fam_monitor_collection($fam, $dirname, $depth, $mask){}
18263
18264/**
18265 * Requests monitoring for a directory and all contained files.
18266 *
18267 * A FAM event will be generated whenever the status of the directory
18268 * (i.e. the result of function {@link stat} on that directory) or its
18269 * content (i.e. the results of {@link readdir}) changes.
18270 *
18271 * The possible event codes are described in detail in the constants part
18272 * of this section.
18273 *
18274 * @param resource $fam A resource representing a connection to the FAM
18275 *   service returned by {@link fam_open}
18276 * @param string $dirname Path to the monitored directory
18277 * @return resource
18278 * @since PHP 5
18279 **/
18280function fam_monitor_directory($fam, $dirname){}
18281
18282/**
18283 * Requests monitoring for a single file. A FAM event will be generated
18284 * whenever the file status changes (i.e. the result of function {@link
18285 * stat} on that file).
18286 *
18287 * The possible event codes are described in detail in the constants part
18288 * of this section.
18289 *
18290 * @param resource $fam A resource representing a connection to the FAM
18291 *   service returned by {@link fam_open}
18292 * @param string $filename Path to the monitored file
18293 * @return resource
18294 * @since PHP 5
18295 **/
18296function fam_monitor_file($fam, $filename){}
18297
18298/**
18299 * Returns the next pending FAM event.
18300 *
18301 * The function will block until an event is available which can be
18302 * checked for using {@link fam_pending}.
18303 *
18304 * @param resource $fam A resource representing a connection to the FAM
18305 *   service returned by {@link fam_open}
18306 * @return array
18307 * @since PHP 5
18308 **/
18309function fam_next_event($fam){}
18310
18311/**
18312 * Opens a connection to the FAM service daemon.
18313 *
18314 * @param string $appname A string identifying the application for
18315 *   logging reasons
18316 * @return resource
18317 * @since PHP 5
18318 **/
18319function fam_open($appname){}
18320
18321/**
18322 * Checks for pending FAM events.
18323 *
18324 * @param resource $fam A resource representing a connection to the FAM
18325 *   service returned by {@link fam_open}
18326 * @return int
18327 * @since PHP 5
18328 **/
18329function fam_pending($fam){}
18330
18331/**
18332 * Resumes monitoring of a resource previously suspended using {@link
18333 * fam_suspend_monitor}.
18334 *
18335 * @param resource $fam A resource representing a connection to the FAM
18336 *   service returned by {@link fam_open}
18337 * @param resource $fam_monitor A resource returned by one of the
18338 *   fam_monitor_XXX functions
18339 * @return bool
18340 * @since PHP 5
18341 **/
18342function fam_resume_monitor($fam, $fam_monitor){}
18343
18344/**
18345 * {@link fam_suspend_monitor} temporarily suspend monitoring of a
18346 * resource.
18347 *
18348 * Monitoring can later be continued using {@link fam_resume_monitor}
18349 * without the need of requesting a complete new monitor.
18350 *
18351 * @param resource $fam A resource representing a connection to the FAM
18352 *   service returned by {@link fam_open}
18353 * @param resource $fam_monitor A resource returned by one of the
18354 *   fam_monitor_XXX functions
18355 * @return bool
18356 * @since PHP 5
18357 **/
18358function fam_suspend_monitor($fam, $fam_monitor){}
18359
18360/**
18361 * {@link fbsql_affected_rows} returns the number of rows affected by the
18362 * last INSERT, UPDATE or DELETE query associated with {@link
18363 * link_identifier}.
18364 *
18365 * If the last query was a DELETE query with no WHERE clause, all of the
18366 * records will have been deleted from the table but this function will
18367 * return zero.
18368 *
18369 * @param resource $link_identifier
18370 * @return int
18371 * @since PHP 4 >= 4.0.6, PHP 5
18372 **/
18373function fbsql_affected_rows($link_identifier){}
18374
18375/**
18376 * Returns the current autocommit status.
18377 *
18378 * @param resource $link_identifier If this optional parameter is given
18379 *   the auto commit status will be changed. With {@link OnOff} set to
18380 *   each statement will be committed automatically, if no errors was
18381 *   found. With OnOff set to the user must commit or rollback the
18382 *   transaction using either {@link fbsql_commit} or {@link
18383 *   fbsql_rollback}.
18384 * @param bool $OnOff
18385 * @return bool
18386 * @since PHP 4 >= 4.0.6, PHP 5
18387 **/
18388function fbsql_autocommit($link_identifier, $OnOff){}
18389
18390/**
18391 * Returns the size of the given BLOB.
18392 *
18393 * @param string $blob_handle A BLOB handle, returned by {@link
18394 *   fbsql_create_blob}.
18395 * @param resource $link_identifier
18396 * @return int
18397 * @since PHP 4 >= 4.2.0, PHP 5
18398 **/
18399function fbsql_blob_size($blob_handle, $link_identifier){}
18400
18401/**
18402 * {@link fbsql_change_user} changes the logged in user of the specified
18403 * connection. If the new user and password authorization fails, the
18404 * current connected user stays active.
18405 *
18406 * @param string $user The new user name.
18407 * @param string $password The new user password.
18408 * @param string $database If specified, this will be the default or
18409 *   current database after the user has been changed.
18410 * @param resource $link_identifier
18411 * @return bool
18412 * @since PHP 4 >= 4.0.6, PHP 5
18413 **/
18414function fbsql_change_user($user, $password, $database, $link_identifier){}
18415
18416/**
18417 * Returns the size of the given CLOB.
18418 *
18419 * @param string $clob_handle A CLOB handle, returned by {@link
18420 *   fbsql_create_clob}.
18421 * @param resource $link_identifier
18422 * @return int
18423 * @since PHP 4 >= 4.2.0, PHP 5
18424 **/
18425function fbsql_clob_size($clob_handle, $link_identifier){}
18426
18427/**
18428 * Closes the connection to the FrontBase server that's associated with
18429 * the specified link identifier.
18430 *
18431 * Using {@link fbsql_close} isn't usually necessary, as non-persistent
18432 * open links are automatically closed at the end of the script's
18433 * execution.
18434 *
18435 * @param resource $link_identifier
18436 * @return bool
18437 * @since PHP 4 >= 4.0.6, PHP 5
18438 **/
18439function fbsql_close($link_identifier){}
18440
18441/**
18442 * Ends the current transaction by writing all inserts, updates and
18443 * deletes to the disk and unlocking all row and table locks held by the
18444 * transaction. This command is only needed if autocommit is set to
18445 * false.
18446 *
18447 * @param resource $link_identifier
18448 * @return bool
18449 * @since PHP 4 >= 4.0.6, PHP 5
18450 **/
18451function fbsql_commit($link_identifier){}
18452
18453/**
18454 * {@link fbsql_connect} establishes a connection to a FrontBase server.
18455 *
18456 * If a second call is made to {@link fbsql_connect} with the same
18457 * arguments, no new link will be established, but instead, the link
18458 * identifier of the already opened link will be returned.
18459 *
18460 * The link to the server will be closed as soon as the execution of the
18461 * script ends, unless it's closed earlier by explicitly calling {@link
18462 * fbsql_close}.
18463 *
18464 * @param string $hostname The server host name.
18465 * @param string $username The user name for the connection.
18466 * @param string $password The password for the connection.
18467 * @return resource
18468 * @since PHP 4 >= 4.0.6, PHP 5
18469 **/
18470function fbsql_connect($hostname, $username, $password){}
18471
18472/**
18473 * Creates a BLOB from the given data.
18474 *
18475 * @param string $blob_data The BLOB data.
18476 * @param resource $link_identifier
18477 * @return string
18478 * @since PHP 4 >= 4.2.0, PHP 5
18479 **/
18480function fbsql_create_blob($blob_data, $link_identifier){}
18481
18482/**
18483 * Creates a CLOB from the given data.
18484 *
18485 * @param string $clob_data The CLOB data.
18486 * @param resource $link_identifier
18487 * @return string
18488 * @since PHP 4 >= 4.2.0, PHP 5
18489 **/
18490function fbsql_create_clob($clob_data, $link_identifier){}
18491
18492/**
18493 * Attempts to create a new database on the specified server.
18494 *
18495 * @param string $database_name The database name, as a string.
18496 * @param resource $link_identifier
18497 * @param string $database_options
18498 * @return bool
18499 * @since PHP 4 >= 4.0.6, PHP 5
18500 **/
18501function fbsql_create_db($database_name, $link_identifier, $database_options){}
18502
18503/**
18504 * Get or set the database name used with the connection.
18505 *
18506 * @param resource $link_identifier The database name. If given, the
18507 *   default database of the connexion will be changed to {@link
18508 *   database}.
18509 * @param string $database
18510 * @return string
18511 * @since PHP 4 >= 4.0.6, PHP 5
18512 **/
18513function fbsql_database($link_identifier, $database){}
18514
18515/**
18516 * Sets and retrieves the database password used by the connection. If a
18517 * database is protected by a database password, the user must call this
18518 * function before calling {@link fbsql_select_db}.
18519 *
18520 * If no link is open, the function will try to establish a link as if
18521 * {@link fbsql_connect} was called, and use it.
18522 *
18523 * This function does not change the database password in the database
18524 * nor can it be used to retrieve the database password for a database.
18525 *
18526 * @param resource $link_identifier The database password, as a string.
18527 *   If given, the function sets the database password for the specified
18528 *   link identifier.
18529 * @param string $database_password
18530 * @return string
18531 * @since PHP 4 >= 4.0.6, PHP 5
18532 **/
18533function fbsql_database_password($link_identifier, $database_password){}
18534
18535/**
18536 * Moves the internal row pointer of the FrontBase result associated with
18537 * the specified result identifier to point to the specified row number.
18538 *
18539 * The next call to {@link fbsql_fetch_row} would return that row.
18540 *
18541 * @param resource $result The row number. Starts at 0.
18542 * @param int $row_number
18543 * @return bool
18544 * @since PHP 4 >= 4.0.6, PHP 5
18545 **/
18546function fbsql_data_seek($result, $row_number){}
18547
18548/**
18549 * Selects a database and executes a query on it.
18550 *
18551 * @param string $database The database to be selected.
18552 * @param string $query The SQL query to be executed.
18553 * @param resource $link_identifier
18554 * @return resource
18555 * @since PHP 4 >= 4.0.6, PHP 5
18556 **/
18557function fbsql_db_query($database, $query, $link_identifier){}
18558
18559/**
18560 * Gets the current status of the specified database.
18561 *
18562 * @param string $database_name The database name.
18563 * @param resource $link_identifier
18564 * @return int
18565 * @since PHP 4 >= 4.0.7, PHP 5
18566 **/
18567function fbsql_db_status($database_name, $link_identifier){}
18568
18569/**
18570 * {@link fbsql_drop_db} attempts to drop (remove) an entire database
18571 * from the server associated with the specified link identifier.
18572 *
18573 * @param string $database_name The database name, as a string.
18574 * @param resource $link_identifier
18575 * @return bool
18576 * @since PHP 4 >= 4.0.6, PHP 5
18577 **/
18578function fbsql_drop_db($database_name, $link_identifier){}
18579
18580/**
18581 * Returns the numerical value of the error message from previous
18582 * FrontBase operation.
18583 *
18584 * Errors coming back from the fbsql database backend don't issue
18585 * warnings. Instead, use {@link fbsql_errno} to retrieve the error code.
18586 * Note that this function only returns the error code from the most
18587 * recently executed fbsql function (not including {@link fbsql_error}
18588 * and {@link fbsql_errno}), so if you want to use it, make sure you
18589 * check the value before calling another fbsql function.
18590 *
18591 * @param resource $link_identifier
18592 * @return int
18593 * @since PHP 4 >= 4.0.6, PHP 5
18594 **/
18595function fbsql_errno($link_identifier){}
18596
18597/**
18598 * Returns the error message from previous FrontBase operation.
18599 *
18600 * Errors coming back from the fbsql database backend don't issue
18601 * warnings. Instead, use {@link fbsql_error} to retrieve the error text.
18602 * Note that this function only returns the error code from the most
18603 * recently executed fbsql function (not including {@link fbsql_error}
18604 * and {@link fbsql_errno}), so if you want to use it, make sure you
18605 * check the value before calling another fbsql function.
18606 *
18607 * @param resource $link_identifier
18608 * @return string
18609 * @since PHP 4 >= 4.0.6, PHP 5
18610 **/
18611function fbsql_error($link_identifier){}
18612
18613/**
18614 * {@link fbsql_fetch_array} is a combination of {@link fbsql_fetch_row}
18615 * and {@link fbsql_fetch_assoc}.
18616 *
18617 * An important thing to note is that using {@link fbsql_fetch_array} is
18618 * NOT significantly slower than using {@link fbsql_fetch_row}, while it
18619 * provides a significant added value.
18620 *
18621 * @param resource $result A constant and can take the following
18622 *   values: FBSQL_ASSOC, FBSQL_NUM, or FBSQL_BOTH. When using
18623 *   FBSQL_BOTH, in addition to storing the data in the numeric indices
18624 *   of the result array, it also stores the data in associative indices,
18625 *   using the field names as keys.
18626 * @param int $result_type
18627 * @return array
18628 * @since PHP 4 >= 4.0.6, PHP 5
18629 **/
18630function fbsql_fetch_array($result, $result_type){}
18631
18632/**
18633 * Calling {@link fbsql_fetch_assoc} is equivalent to calling {@link
18634 * fbsql_fetch_array} with FBSQL_ASSOC as second parameter. It only
18635 * returns an associative array.
18636 *
18637 * This is the way {@link fbsql_fetch_array} originally worked. If you
18638 * need the numeric indices as well as the associative, use {@link
18639 * fbsql_fetch_array}.
18640 *
18641 * An important thing to note is that using {@link fbsql_fetch_assoc} is
18642 * NOT significantly slower than using {@link fbsql_fetch_row}, while it
18643 * provides a significant added value.
18644 *
18645 * @param resource $result
18646 * @return array
18647 * @since PHP 4 >= 4.0.6, PHP 5
18648 **/
18649function fbsql_fetch_assoc($result){}
18650
18651/**
18652 * Used in order to obtain information about fields in a certain query
18653 * result.
18654 *
18655 * @param resource $result The numerical offset of the field. The field
18656 *   index starts at 0. If not specified, the next field that wasn't yet
18657 *   retrieved by {@link fbsql_fetch_field} is retrieved.
18658 * @param int $field_offset
18659 * @return object
18660 * @since PHP 4 >= 4.0.6, PHP 5
18661 **/
18662function fbsql_fetch_field($result, $field_offset){}
18663
18664/**
18665 * Stores the lengths of each result column in the last row returned by
18666 * {@link fbsql_fetch_row}, {@link fbsql_fetch_array} and {@link
18667 * fbsql_fetch_object} in an array.
18668 *
18669 * @param resource $result
18670 * @return array
18671 * @since PHP 4 >= 4.0.6, PHP 5
18672 **/
18673function fbsql_fetch_lengths($result){}
18674
18675/**
18676 * {@link fbsql_fetch_object} is similar to {@link fbsql_fetch_array},
18677 * with one difference - an object is returned, instead of an array.
18678 * Indirectly, that means that you can only access the data by the field
18679 * names, and not by their offsets (numbers are illegal property names).
18680 *
18681 * Speed-wise, the function is identical to {@link fbsql_fetch_array},
18682 * and almost as quick as {@link fbsql_fetch_row} (the difference is
18683 * insignificant).
18684 *
18685 * @param resource $result
18686 * @return object
18687 * @since PHP 4 >= 4.0.6, PHP 5
18688 **/
18689function fbsql_fetch_object($result){}
18690
18691/**
18692 * {@link fbsql_fetch_row} fetches one row of data from the result
18693 * associated with the specified result identifier.
18694 *
18695 * Subsequent call to {@link fbsql_fetch_row} would return the next row
18696 * in the result set, or if there are no more rows.
18697 *
18698 * @param resource $result
18699 * @return array
18700 * @since PHP 4 >= 4.0.6, PHP 5
18701 **/
18702function fbsql_fetch_row($result){}
18703
18704/**
18705 * Gets the flags associated with the specified field in a result.
18706 *
18707 * @param resource $result A result pointer returned by {@link
18708 *   fbsql_list_fields}.
18709 * @param int $field_offset The numerical offset of the field. The
18710 *   field index starts at 0.
18711 * @return string
18712 * @since PHP 4 >= 4.0.6, PHP 5
18713 **/
18714function fbsql_field_flags($result, $field_offset){}
18715
18716/**
18717 * Returns the length of the specified field.
18718 *
18719 * @param resource $result A result pointer returned by {@link
18720 *   fbsql_list_fields}.
18721 * @param int $field_offset The numerical offset of the field. The
18722 *   field index starts at 0.
18723 * @return int
18724 * @since PHP 4 >= 4.0.6, PHP 5
18725 **/
18726function fbsql_field_len($result, $field_offset){}
18727
18728/**
18729 * Returns the name of the specified field index.
18730 *
18731 * @param resource $result A result pointer returned by {@link
18732 *   fbsql_list_fields}.
18733 * @param int $field_index The numerical offset of the field. The field
18734 *   index starts at 0.
18735 * @return string
18736 * @since PHP 4 >= 4.0.6, PHP 5
18737 **/
18738function fbsql_field_name($result, $field_index){}
18739
18740/**
18741 * Seeks to the specified field offset. If the next call to {@link
18742 * fbsql_fetch_field} doesn't include a field offset, the field offset
18743 * specified in {@link fbsql_field_seek} will be returned.
18744 *
18745 * @param resource $result The numerical offset of the field. The field
18746 *   index starts at 0.
18747 * @param int $field_offset
18748 * @return bool
18749 * @since PHP 4 >= 4.0.6, PHP 5
18750 **/
18751function fbsql_field_seek($result, $field_offset){}
18752
18753/**
18754 * Returns the name of the table that the specified field is in.
18755 *
18756 * @param resource $result The numerical offset of the field. The field
18757 *   index starts at 0.
18758 * @param int $field_offset
18759 * @return string
18760 * @since PHP 4 >= 4.0.6, PHP 5
18761 **/
18762function fbsql_field_table($result, $field_offset){}
18763
18764/**
18765 * {@link fbsql_field_type} is similar to the {@link fbsql_field_name}
18766 * function, but the field type is returned instead.
18767 *
18768 * @param resource $result The numerical offset of the field. The field
18769 *   index starts at 0.
18770 * @param int $field_offset
18771 * @return string
18772 * @since PHP 4 >= 4.0.6, PHP 5
18773 **/
18774function fbsql_field_type($result, $field_offset){}
18775
18776/**
18777 * Frees all memory associated with the given {@link result} identifier.
18778 *
18779 * {@link fbsql_free_result} only needs to be called if you are concerned
18780 * about how much memory is being used for queries that return large
18781 * result sets. All associated result memory is automatically freed at
18782 * the end of the script's execution.
18783 *
18784 * @param resource $result
18785 * @return bool
18786 * @since PHP 4 >= 4.0.6, PHP 5
18787 **/
18788function fbsql_free_result($result){}
18789
18790/**
18791 * @param resource $link_identifier
18792 * @return array
18793 * @since PHP 4 >= 4.0.7, PHP 5
18794 **/
18795function fbsql_get_autostart_info($link_identifier){}
18796
18797/**
18798 * Gets or sets the host name used with a connection.
18799 *
18800 * @param resource $link_identifier If provided, this will be the new
18801 *   connection host name.
18802 * @param string $host_name
18803 * @return string
18804 * @since PHP 4 >= 4.0.6, PHP 5
18805 **/
18806function fbsql_hostname($link_identifier, $host_name){}
18807
18808/**
18809 * Gets the id generated from the previous INSERT operation which created
18810 * a DEFAULT UNIQUE value.
18811 *
18812 * @param resource $link_identifier
18813 * @return int
18814 * @since PHP 4 >= 4.0.6, PHP 5
18815 **/
18816function fbsql_insert_id($link_identifier){}
18817
18818/**
18819 * Return a result pointer containing the databases available from the
18820 * current fbsql daemon. Use the {@link fbsql_tablename} to traverse this
18821 * result pointer.
18822 *
18823 * @param resource $link_identifier
18824 * @return resource
18825 * @since PHP 4 >= 4.0.6, PHP 5
18826 **/
18827function fbsql_list_dbs($link_identifier){}
18828
18829/**
18830 * Retrieves information about the given table.
18831 *
18832 * @param string $database_name The database name.
18833 * @param string $table_name The table name.
18834 * @param resource $link_identifier
18835 * @return resource
18836 * @since PHP 4 >= 4.0.6, PHP 5
18837 **/
18838function fbsql_list_fields($database_name, $table_name, $link_identifier){}
18839
18840/**
18841 * Returns a result pointer describing the {@link database}.
18842 *
18843 * @param string $database The database name.
18844 * @param resource $link_identifier
18845 * @return resource
18846 * @since PHP 4 >= 4.0.6, PHP 5
18847 **/
18848function fbsql_list_tables($database, $link_identifier){}
18849
18850/**
18851 * When sending more than one SQL statement to the server or executing a
18852 * stored procedure with multiple results will cause the server to return
18853 * multiple result sets. This function will test for additional results
18854 * available form the server. If an additional result set exists it will
18855 * free the existing result set and prepare to fetch the words from the
18856 * new result set.
18857 *
18858 * @param resource $result
18859 * @return bool
18860 * @since PHP 4 >= 4.0.6, PHP 5
18861 **/
18862function fbsql_next_result($result){}
18863
18864/**
18865 * Returns the number of fields in the given {@link result} set.
18866 *
18867 * @param resource $result
18868 * @return int
18869 * @since PHP 4 >= 4.0.6, PHP 5
18870 **/
18871function fbsql_num_fields($result){}
18872
18873/**
18874 * Gets the number of rows in the given {@link result} set.
18875 *
18876 * This function is only valid for SELECT statements. To retrieve the
18877 * number of rows returned from a INSERT, UPDATE or DELETE query, use
18878 * {@link fbsql_affected_rows}.
18879 *
18880 * @param resource $result
18881 * @return int
18882 * @since PHP 4 >= 4.0.6, PHP 5
18883 **/
18884function fbsql_num_rows($result){}
18885
18886/**
18887 * Get or set the user password used with a connection.
18888 *
18889 * @param resource $link_identifier If provided, this will be the new
18890 *   connection password.
18891 * @param string $password
18892 * @return string
18893 * @since PHP 4 >= 4.0.6, PHP 5
18894 **/
18895function fbsql_password($link_identifier, $password){}
18896
18897/**
18898 * Establishes a persistent connection to a FrontBase server.
18899 *
18900 * To set the server port number, use {@link fbsql_select_db}.
18901 *
18902 * {@link fbsql_pconnect} acts very much like {@link fbsql_connect} with
18903 * two major differences:
18904 *
18905 * First, when connecting, the function would first try to find a
18906 * (persistent) link that's already open with the same host, username and
18907 * password. If one is found, an identifier for it will be returned
18908 * instead of opening a new connection.
18909 *
18910 * Second, the connection to the SQL server will not be closed when the
18911 * execution of the script ends. Instead, the link will remain open for
18912 * future use.
18913 *
18914 * This type of links is therefore called 'persistent'.
18915 *
18916 * @param string $hostname The server host name.
18917 * @param string $username The user name for the connection.
18918 * @param string $password The password for the connection.
18919 * @return resource
18920 * @since PHP 4 >= 4.0.6, PHP 5
18921 **/
18922function fbsql_pconnect($hostname, $username, $password){}
18923
18924/**
18925 * Sends a {@link query} to the currently active database on the server.
18926 *
18927 * If the query succeeds, you can call {@link fbsql_num_rows} to find out
18928 * how many rows were returned for a SELECT statement or {@link
18929 * fbsql_affected_rows} to find out how many rows were affected by a
18930 * DELETE, INSERT, REPLACE, or UPDATE statement.
18931 *
18932 * @param string $query The SQL query to be executed.
18933 * @param resource $link_identifier
18934 * @param int $batch_size
18935 * @return resource
18936 * @since PHP 4 >= 4.0.6, PHP 5
18937 **/
18938function fbsql_query($query, $link_identifier, $batch_size){}
18939
18940/**
18941 * Reads BLOB data from the database.
18942 *
18943 * If a select statement contains BLOB and/or CLOB columns FrontBase will
18944 * return the data directly when data is fetched. This default behavior
18945 * can be changed with {@link fbsql_set_lob_mode} so the fetch functions
18946 * will return handles to BLOB and CLOB data. If a handle is fetched a
18947 * user must call {@link fbsql_read_blob} to get the actual BLOB data
18948 * from the database.
18949 *
18950 * @param string $blob_handle A BLOB handle, returned by {@link
18951 *   fbsql_create_blob}.
18952 * @param resource $link_identifier
18953 * @return string
18954 * @since PHP 4 >= 4.2.0, PHP 5
18955 **/
18956function fbsql_read_blob($blob_handle, $link_identifier){}
18957
18958/**
18959 * Reads CLOB data from the database.
18960 *
18961 * If a select statement contains BLOB and/or CLOB columns FrontBase will
18962 * return the data directly when data is fetched. This default behavior
18963 * can be changed with {@link fbsql_set_lob_mode} so the fetch functions
18964 * will return handles to BLOB and CLOB data. If a handle is fetched a
18965 * user must call {@link fbsql_read_clob} to get the actual CLOB data
18966 * from the database.
18967 *
18968 * @param string $clob_handle A CLOB handle, returned by {@link
18969 *   fbsql_create_clob}.
18970 * @param resource $link_identifier
18971 * @return string
18972 * @since PHP 4 >= 4.2.0, PHP 5
18973 **/
18974function fbsql_read_clob($clob_handle, $link_identifier){}
18975
18976/**
18977 * Returns the contents of one cell from a FrontBase {@link result} set.
18978 *
18979 * When working on large result sets, you should consider using one of
18980 * the functions that fetch an entire row (specified below). As these
18981 * functions return the contents of multiple cells in one function call,
18982 * they're MUCH quicker than {@link fbsql_result}.
18983 *
18984 * Calls to {@link fbsql_result} should not be mixed with calls to other
18985 * functions that deal with the result set.
18986 *
18987 * @param resource $result
18988 * @param int $row Can be the field's offset, or the field's name, or
18989 *   the field's table dot field's name (tablename.fieldname). If the
18990 *   column name has been aliased ('select foo as bar from...'), use the
18991 *   alias instead of the column name.
18992 * @param mixed $field
18993 * @return mixed
18994 * @since PHP 4 >= 4.0.6, PHP 5
18995 **/
18996function fbsql_result($result, $row, $field){}
18997
18998/**
18999 * Ends the current transaction by rolling back all statements issued
19000 * since last commit.
19001 *
19002 * This command is only needed if autocommit is set to false.
19003 *
19004 * @param resource $link_identifier
19005 * @return bool
19006 * @since PHP 4 >= 4.0.6, PHP 5
19007 **/
19008function fbsql_rollback($link_identifier){}
19009
19010/**
19011 * Gets the number of rows affected by the last statement.
19012 *
19013 * @param resource $result
19014 * @return int
19015 * @since PHP 5 >= 5.1.0
19016 **/
19017function fbsql_rows_fetched($result){}
19018
19019/**
19020 * Sets the current active database on the given link identifier.
19021 *
19022 * The client contacts FBExec to obtain the port number to use for the
19023 * connection to the database. If the database name is a number the
19024 * system will use that as a port number and it will not ask FBExec for
19025 * the port number. The FrontBase server can be stared as FRontBase
19026 * -FBExec=No -port=<port number> <database name>.
19027 *
19028 * Every subsequent call to {@link fbsql_query} will be made on the
19029 * active database.
19030 *
19031 * @param string $database_name The name of the database to be
19032 *   selected. If the database is protected with a database password, the
19033 *   you must call {@link fbsql_database_password} before selecting the
19034 *   database.
19035 * @param resource $link_identifier
19036 * @return bool
19037 * @since PHP 4 >= 4.0.6, PHP 5
19038 **/
19039function fbsql_select_db($database_name, $link_identifier){}
19040
19041/**
19042 * @param resource $link_identifier
19043 * @param int $characterset
19044 * @param int $in_out_both
19045 * @return void
19046 * @since PHP 5 >= 5.1.0
19047 **/
19048function fbsql_set_characterset($link_identifier, $characterset, $in_out_both){}
19049
19050/**
19051 * Sets the mode for retrieving LOB data from the database.
19052 *
19053 * When BLOB and CLOB data is retrieved in FrontBase it can be retrieved
19054 * direct or indirect. Direct retrieved LOB data will always be fetched
19055 * no matter the setting of the lob mode. If the LOB data is less than
19056 * 512 bytes it will always be retrieved directly.
19057 *
19058 * @param resource $result Can be one of: FBSQL_LOB_DIRECT - LOB data
19059 *   is retrieved directly. When data is fetched from the database with
19060 *   {@link fbsql_fetch_row}, and other fetch functions, all CLOB and
19061 *   BLOB columns will be returned as ordinary columns. This is the
19062 *   default value on a new FrontBase result. FBSQL_LOB_HANDLE - LOB data
19063 *   is retrieved as handles to the data. When data is fetched from the
19064 *   database with {@link fbsql_fetch_row}, and other fetch functions,
19065 *   LOB data will be returned as a handle to the data if the data is
19066 *   stored indirect or the data if it is stored direct. If a handle is
19067 *   returned it will be a 27 byte string formatted as
19068 *   @'000000000000000000000000'.
19069 * @param int $lob_mode
19070 * @return bool
19071 * @since PHP 4 >= 4.2.0, PHP 5
19072 **/
19073function fbsql_set_lob_mode($result, $lob_mode){}
19074
19075/**
19076 * Changes the password for the given {@link user}.
19077 *
19078 * @param resource $link_identifier The user name.
19079 * @param string $user The new password to be set.
19080 * @param string $password The old password to be replaced.
19081 * @param string $old_password
19082 * @return bool
19083 * @since PHP 5
19084 **/
19085function fbsql_set_password($link_identifier, $user, $password, $old_password){}
19086
19087/**
19088 * Sets the transaction {@link locking} and {@link isolation}.
19089 *
19090 * @param resource $link_identifier The type of locking to be set. It
19091 *   can be one of the following constants: FBSQL_LOCK_DEFERRED,
19092 *   FBSQL_LOCK_OPTIMISTIC, or FBSQL_LOCK_PESSIMISTIC.
19093 * @param int $locking The type of isolation to be set. It can be one
19094 *   of the following constants: FBSQL_ISO_READ_UNCOMMITTED,
19095 *   FBSQL_ISO_READ_COMMITTED, FBSQL_ISO_REPEATABLE_READ,
19096 *   FBSQL_ISO_SERIALIZABLE, or FBSQL_ISO_VERSIONED.
19097 * @param int $isolation
19098 * @return void
19099 * @since PHP 4 >= 4.2.0, PHP 5
19100 **/
19101function fbsql_set_transaction($link_identifier, $locking, $isolation){}
19102
19103/**
19104 * Start a database on local or remote server.
19105 *
19106 * @param string $database_name The database name.
19107 * @param resource $link_identifier
19108 * @param string $database_options
19109 * @return bool
19110 * @since PHP 4 >= 4.0.6, PHP 5
19111 **/
19112function fbsql_start_db($database_name, $link_identifier, $database_options){}
19113
19114/**
19115 * Stops a database on local or remote server.
19116 *
19117 * @param string $database_name The database name.
19118 * @param resource $link_identifier
19119 * @return bool
19120 * @since PHP 4 >= 4.0.6, PHP 5
19121 **/
19122function fbsql_stop_db($database_name, $link_identifier){}
19123
19124/**
19125 * {@link fbsql_tablename} gets the name of the current table in the
19126 * given {@link result} set.
19127 *
19128 * The {@link fbsql_num_rows} function may be used to determine the
19129 * number of tables in the result pointer.
19130 *
19131 * @param resource $result A result pointer returned by {@link
19132 *   fbsql_list_tables}.
19133 * @param int $index Integer index for the current table.
19134 * @return string
19135 * @since PHP 4 >= 4.2.0, PHP 5
19136 **/
19137function fbsql_tablename($result, $index){}
19138
19139/**
19140 * {@link fbsql_table_name} gets the name of the current table in the
19141 * given {@link result} set.
19142 *
19143 * The {@link fbsql_num_rows} function may be used to determine the
19144 * number of tables in the result pointer.
19145 *
19146 * @param resource $result A result pointer returned by {@link
19147 *   fbsql_list_tables}.
19148 * @param int $index Integer index for the current table.
19149 * @return string
19150 * @since PHP 4 >= 4.2.0, PHP 5
19151 **/
19152function fbsql_table_name($result, $index){}
19153
19154/**
19155 * Get or set the username used for the connection.
19156 *
19157 * @param resource $link_identifier If provided, this is the new
19158 *   username to set.
19159 * @param string $username
19160 * @return string
19161 * @since PHP 4 >= 4.0.6, PHP 5
19162 **/
19163function fbsql_username($link_identifier, $username){}
19164
19165/**
19166 * Enables or disables FrontBase warnings.
19167 *
19168 * @param bool $OnOff Whether to enable warnings or no.
19169 * @return bool
19170 * @since PHP 4 >= 4.0.6, PHP 5
19171 **/
19172function fbsql_warnings($OnOff){}
19173
19174/**
19175 * The file pointed to by {@link handle} is closed.
19176 *
19177 * @param resource $handle The file pointer must be valid, and must
19178 *   point to a file successfully opened by {@link fopen} or {@link
19179 *   fsockopen}.
19180 * @return bool
19181 * @since PHP 4, PHP 5
19182 **/
19183function fclose($handle){}
19184
19185/**
19186 * Adds a script to the FDF, which Acrobat then adds to the doc-level
19187 * scripts of a document, once the FDF is imported into it.
19188 *
19189 * @param resource $fdf_document The FDF document handle, returned by
19190 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19191 * @param string $script_name The script name.
19192 * @param string $script_code The script code. It is strongly suggested
19193 *   to use \r for linebreaks within the script code.
19194 * @return bool
19195 * @since PHP 4 >= 4.3.0, PHP 5
19196 **/
19197function fdf_add_doc_javascript($fdf_document, $script_name, $script_code){}
19198
19199/**
19200 * @param resource $fdf_document
19201 * @param int $newpage
19202 * @param string $filename
19203 * @param string $template
19204 * @param int $rename
19205 * @return bool
19206 * @since PHP 4, PHP 5
19207 **/
19208function fdf_add_template($fdf_document, $newpage, $filename, $template, $rename){}
19209
19210/**
19211 * Closes the FDF document.
19212 *
19213 * @param resource $fdf_document The FDF document handle, returned by
19214 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19215 * @return void
19216 * @since PHP 4, PHP 5
19217 **/
19218function fdf_close($fdf_document){}
19219
19220/**
19221 * Creates a new FDF document.
19222 *
19223 * This function is needed if one would like to populate input fields in
19224 * a PDF document with data.
19225 *
19226 * @return resource
19227 * @since PHP 4, PHP 5
19228 **/
19229function fdf_create(){}
19230
19231/**
19232 * @param resource $fdf_document
19233 * @param callback $function
19234 * @param mixed $userdata
19235 * @return bool
19236 * @since PHP 4 >= 4.3.0, PHP 5
19237 **/
19238function fdf_enum_values($fdf_document, $function, $userdata){}
19239
19240/**
19241 * Gets the error code set by the last FDF function call.
19242 *
19243 * A textual description of the error may be obtained using with {@link
19244 * fdf_error}.
19245 *
19246 * @return int
19247 * @since PHP 4 >= 4.3.0, PHP 5
19248 **/
19249function fdf_errno(){}
19250
19251/**
19252 * Gets a textual description for the FDF error code given in {@link
19253 * error_code}.
19254 *
19255 * @param int $error_code An error code obtained with {@link
19256 *   fdf_errno}. If not provided, this function uses the internal error
19257 *   code set by the last operation.
19258 * @return string
19259 * @since PHP 4 >= 4.3.0, PHP 5
19260 **/
19261function fdf_error($error_code){}
19262
19263/**
19264 * Gets the appearance of a {@link field} (i.e. the value of the /AP key)
19265 * and stores it in a file.
19266 *
19267 * @param resource $fdf_document The FDF document handle, returned by
19268 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19269 * @param string $field
19270 * @param int $face The possible values are FDFNormalAP, FDFRolloverAP
19271 *   and FDFDownAP.
19272 * @param string $filename The appearance will be stored in this
19273 *   parameter.
19274 * @return bool
19275 * @since PHP 4 >= 4.3.0, PHP 5
19276 **/
19277function fdf_get_ap($fdf_document, $field, $face, $filename){}
19278
19279/**
19280 * Extracts a file uploaded by means of the "file selection" field {@link
19281 * fieldname} and stores it under {@link savepath}.
19282 *
19283 * @param resource $fdf_document The FDF document handle, returned by
19284 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19285 * @param string $fieldname
19286 * @param string $savepath May be the name of a plain file or an
19287 *   existing directory in which the file is to be created under its
19288 *   original name. Any existing file under the same name will be
19289 *   overwritten.
19290 * @return array
19291 * @since PHP 4 >= 4.3.0, PHP 5
19292 **/
19293function fdf_get_attachment($fdf_document, $fieldname, $savepath){}
19294
19295/**
19296 * Gets the value of the /Encoding key.
19297 *
19298 * @param resource $fdf_document The FDF document handle, returned by
19299 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19300 * @return string
19301 * @since PHP 4 >= 4.3.0, PHP 5
19302 **/
19303function fdf_get_encoding($fdf_document){}
19304
19305/**
19306 * Gets the value of the /F key.
19307 *
19308 * @param resource $fdf_document The FDF document handle, returned by
19309 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19310 * @return string
19311 * @since PHP 4, PHP 5
19312 **/
19313function fdf_get_file($fdf_document){}
19314
19315/**
19316 * @param resource $fdf_document
19317 * @param string $fieldname
19318 * @param int $whichflags
19319 * @return int
19320 * @since PHP 4 >= 4.3.0, PHP 5
19321 **/
19322function fdf_get_flags($fdf_document, $fieldname, $whichflags){}
19323
19324/**
19325 * @param resource $fdf_document
19326 * @param string $fieldname
19327 * @param int $element
19328 * @return mixed
19329 * @since PHP 4 >= 4.3.0, PHP 5
19330 **/
19331function fdf_get_opt($fdf_document, $fieldname, $element){}
19332
19333/**
19334 * Gets the value of the /STATUS key.
19335 *
19336 * @param resource $fdf_document The FDF document handle, returned by
19337 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19338 * @return string
19339 * @since PHP 4, PHP 5
19340 **/
19341function fdf_get_status($fdf_document){}
19342
19343/**
19344 * Gets the value for the requested field.
19345 *
19346 * @param resource $fdf_document The FDF document handle, returned by
19347 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19348 * @param string $fieldname Name of the FDF field, as a string.
19349 * @param int $which Elements of an array field can be retrieved by
19350 *   passing this optional parameter, starting at zero. For non-array
19351 *   fields, this parameter will be ignored.
19352 * @return mixed
19353 * @since PHP 4, PHP 5
19354 **/
19355function fdf_get_value($fdf_document, $fieldname, $which){}
19356
19357/**
19358 * Return the FDF version for the given document, or the toolkit API
19359 * version number if no parameter is given.
19360 *
19361 * @param resource $fdf_document The FDF document handle, returned by
19362 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19363 * @return string
19364 * @since PHP 4 >= 4.3.0, PHP 5
19365 **/
19366function fdf_get_version($fdf_document){}
19367
19368/**
19369 * This is a convenience function to set appropriate HTTP headers for FDF
19370 * output. It sets the Content-type: to application/vnd.fdf.
19371 *
19372 * @return void
19373 * @since PHP 4 >= 4.3.0, PHP 5
19374 **/
19375function fdf_header(){}
19376
19377/**
19378 * Gets the name of the field after the given field. This name can be
19379 * used with several functions.
19380 *
19381 * @param resource $fdf_document The FDF document handle, returned by
19382 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19383 * @param string $fieldname Name of the FDF field, as a string. If not
19384 *   given, the first field will be assumed.
19385 * @return string
19386 * @since PHP 4, PHP 5
19387 **/
19388function fdf_next_field_name($fdf_document, $fieldname){}
19389
19390/**
19391 * Opens a file with form data.
19392 *
19393 * You can also use {@link fdf_open_string} to process the results of a
19394 * PDF form POST request.
19395 *
19396 * @param string $filename Path to the FDF file. This file must contain
19397 *   the data as returned from a PDF form or created using {@link
19398 *   fdf_create} and {@link fdf_save}.
19399 * @return resource
19400 * @since PHP 4, PHP 5
19401 **/
19402function fdf_open($filename){}
19403
19404/**
19405 * Reads form data from a string.
19406 *
19407 * You can use {@link fdf_open_string} together with $HTTP_FDF_DATA to
19408 * process FDF form input from a remote client.
19409 *
19410 * @param string $fdf_data The data as returned from a PDF form or
19411 *   created using {@link fdf_create} and {@link fdf_save_string}.
19412 * @return resource
19413 * @since PHP 4 >= 4.3.0, PHP 5
19414 **/
19415function fdf_open_string($fdf_data){}
19416
19417/**
19418 * @param resource $fdf_document
19419 * @param string $fieldname
19420 * @param int $item
19421 * @return bool
19422 * @since PHP 4 >= 4.3.0, PHP 5
19423 **/
19424function fdf_remove_item($fdf_document, $fieldname, $item){}
19425
19426/**
19427 * Saves a FDF document.
19428 *
19429 * @param resource $fdf_document The FDF document handle, returned by
19430 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19431 * @param string $filename If provided, the resulting FDF will be
19432 *   written in this parameter. Otherwise, this function will write the
19433 *   FDF to the default PHP output stream.
19434 * @return bool
19435 * @since PHP 4, PHP 5
19436 **/
19437function fdf_save($fdf_document, $filename){}
19438
19439/**
19440 * Returns the FDF document as a string.
19441 *
19442 * @param resource $fdf_document The FDF document handle, returned by
19443 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19444 * @return string
19445 * @since PHP 4 >= 4.3.0, PHP 5
19446 **/
19447function fdf_save_string($fdf_document){}
19448
19449/**
19450 * Sets the appearance of a field (i.e. the value of the /AP key).
19451 *
19452 * @param resource $fdf_document The FDF document handle, returned by
19453 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19454 * @param string $field_name
19455 * @param int $face The possible values FDFNormalAP, FDFRolloverAP and
19456 *   FDFDownAP.
19457 * @param string $filename
19458 * @param int $page_number
19459 * @return bool
19460 * @since PHP 4, PHP 5
19461 **/
19462function fdf_set_ap($fdf_document, $field_name, $face, $filename, $page_number){}
19463
19464/**
19465 * Sets the character encoding for the FDF document.
19466 *
19467 * @param resource $fdf_document The FDF document handle, returned by
19468 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19469 * @param string $encoding The encoding name. The following values are
19470 *   supported: "Shift-JIS", "UHC", "GBK" and "BigFive". An empty string
19471 *   resets the encoding to the default PDFDocEncoding/Unicode scheme.
19472 * @return bool
19473 * @since PHP 4 >= 4.0.7, PHP 5
19474 **/
19475function fdf_set_encoding($fdf_document, $encoding){}
19476
19477/**
19478 * Selects a different PDF document to display the form results in then
19479 * the form it originated from.
19480 *
19481 * @param resource $fdf_document The FDF document handle, returned by
19482 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19483 * @param string $url Should be given as an absolute URL.
19484 * @param string $target_frame Use this parameter to specify the frame
19485 *   in which the document will be displayed. You can also set the
19486 *   default value for this parameter using {@link fdf_set_target_frame}.
19487 * @return bool
19488 * @since PHP 4, PHP 5
19489 **/
19490function fdf_set_file($fdf_document, $url, $target_frame){}
19491
19492/**
19493 * Sets certain flags of the given field.
19494 *
19495 * @param resource $fdf_document The FDF document handle, returned by
19496 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19497 * @param string $fieldname Name of the FDF field, as a string.
19498 * @param int $whichFlags
19499 * @param int $newFlags
19500 * @return bool
19501 * @since PHP 4 >= 4.0.2, PHP 5
19502 **/
19503function fdf_set_flags($fdf_document, $fieldname, $whichFlags, $newFlags){}
19504
19505/**
19506 * Sets a javascript action for the given field.
19507 *
19508 * @param resource $fdf_document The FDF document handle, returned by
19509 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19510 * @param string $fieldname Name of the FDF field, as a string.
19511 * @param int $trigger
19512 * @param string $script
19513 * @return bool
19514 * @since PHP 4 >= 4.0.2, PHP 5
19515 **/
19516function fdf_set_javascript_action($fdf_document, $fieldname, $trigger, $script){}
19517
19518/**
19519 * @param resource $fdf_document
19520 * @param string $script
19521 * @param bool $before_data_import
19522 * @return bool
19523 * @since PHP 4 >= 4.3.0, PHP 5
19524 **/
19525function fdf_set_on_import_javascript($fdf_document, $script, $before_data_import){}
19526
19527/**
19528 * Sets options of the given field.
19529 *
19530 * @param resource $fdf_document The FDF document handle, returned by
19531 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19532 * @param string $fieldname Name of the FDF field, as a string.
19533 * @param int $element
19534 * @param string $str1
19535 * @param string $str2
19536 * @return bool
19537 * @since PHP 4 >= 4.0.2, PHP 5
19538 **/
19539function fdf_set_opt($fdf_document, $fieldname, $element, $str1, $str2){}
19540
19541/**
19542 * Sets the value of the /STATUS key. When a client receives a FDF with a
19543 * status set it will present the value in an alert box.
19544 *
19545 * @param resource $fdf_document The FDF document handle, returned by
19546 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19547 * @param string $status
19548 * @return bool
19549 * @since PHP 4, PHP 5
19550 **/
19551function fdf_set_status($fdf_document, $status){}
19552
19553/**
19554 * Sets a submit form action for the given field.
19555 *
19556 * @param resource $fdf_document The FDF document handle, returned by
19557 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19558 * @param string $fieldname Name of the FDF field, as a string.
19559 * @param int $trigger
19560 * @param string $script
19561 * @param int $flags
19562 * @return bool
19563 * @since PHP 4 >= 4.0.2, PHP 5
19564 **/
19565function fdf_set_submit_form_action($fdf_document, $fieldname, $trigger, $script, $flags){}
19566
19567/**
19568 * Sets the target frame to display a result PDF defined with {@link
19569 * fdf_save_file} in.
19570 *
19571 * @param resource $fdf_document The FDF document handle, returned by
19572 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19573 * @param string $frame_name The frame name, as a string.
19574 * @return bool
19575 * @since PHP 4 >= 4.3.0, PHP 5
19576 **/
19577function fdf_set_target_frame($fdf_document, $frame_name){}
19578
19579/**
19580 * Sets the {@link value} for the given field.
19581 *
19582 * @param resource $fdf_document The FDF document handle, returned by
19583 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19584 * @param string $fieldname Name of the FDF field, as a string.
19585 * @param mixed $value This parameter will be stored as a string unless
19586 *   it is an array. In this case all array elements will be stored as a
19587 *   value array.
19588 * @param int $isName
19589 * @return bool
19590 * @since PHP 4, PHP 5
19591 **/
19592function fdf_set_value($fdf_document, $fieldname, $value, $isName){}
19593
19594/**
19595 * Sets the FDF {@link version} for the given document.
19596 *
19597 * Some features supported by this extension are only available in newer
19598 * FDF versions.
19599 *
19600 * @param resource $fdf_document The FDF document handle, returned by
19601 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
19602 * @param string $version The version number. For the current FDF
19603 *   toolkit 5.0, this may be either 1.2, 1.3 or 1.4.
19604 * @return bool
19605 * @since PHP 4 >= 4.3.0, PHP 5
19606 **/
19607function fdf_set_version($fdf_document, $version){}
19608
19609/**
19610 * Tests for end-of-file on a file pointer.
19611 *
19612 * @param resource $handle
19613 * @return bool
19614 * @since PHP 4, PHP 5
19615 **/
19616function feof($handle){}
19617
19618/**
19619 * This function forces a write of all buffered output to the resource
19620 * pointed to by the file {@link handle}.
19621 *
19622 * @param resource $handle
19623 * @return bool
19624 * @since PHP 4 >= 4.0.1, PHP 5
19625 **/
19626function fflush($handle){}
19627
19628/**
19629 * Gets a character from the given file pointer.
19630 *
19631 * @param resource $handle
19632 * @return string
19633 * @since PHP 4, PHP 5
19634 **/
19635function fgetc($handle){}
19636
19637/**
19638 * Similar to {@link fgets} except that {@link fgetcsv} parses the line
19639 * it reads for fields in CSV format and returns an array containing the
19640 * fields read.
19641 *
19642 * @param resource $handle A valid file pointer to a file successfully
19643 *   opened by {@link fopen}, {@link popen}, or {@link fsockopen}.
19644 * @param int $length Must be greater than the longest line (in
19645 *   characters) to be found in the CSV file (allowing for trailing
19646 *   line-end characters). It became optional in PHP 5. Omitting this
19647 *   parameter (or setting it to 0 in PHP 5.0.4 and later) the maximum
19648 *   line length is not limited, which is slightly slower.
19649 * @param string $delimiter Set the field delimiter (one character
19650 *   only).
19651 * @param string $enclosure Set the field enclosure character (one
19652 *   character only).
19653 * @param string $escape Set the escape character (one character only).
19654 *   Defaults as a backslash.
19655 * @return array
19656 * @since PHP 4, PHP 5
19657 **/
19658function fgetcsv($handle, $length, $delimiter, $enclosure, $escape){}
19659
19660/**
19661 * Gets a line from file pointer.
19662 *
19663 * @param resource $handle
19664 * @param int $length Reading ends when {@link length} - 1 bytes have
19665 *   been read, on a newline (which is included in the return value), or
19666 *   on EOF (whichever comes first). If no length is specified, it will
19667 *   keep reading from the stream until it reaches the end of the line.
19668 * @return string
19669 * @since PHP 4, PHP 5
19670 **/
19671function fgets($handle, $length){}
19672
19673/**
19674 * Identical to {@link fgets}, except that {@link fgetss} attempts to
19675 * strip any NUL bytes, HTML and PHP tags from the text it reads.
19676 *
19677 * @param resource $handle
19678 * @param int $length Length of the data to be retrieved.
19679 * @param string $allowable_tags You can use the optional third
19680 *   parameter to specify tags which should not be stripped.
19681 * @return string
19682 * @since PHP 4, PHP 5
19683 **/
19684function fgetss($handle, $length, $allowable_tags){}
19685
19686/**
19687 * Reads an entire file into an array.
19688 *
19689 * @param string $filename Path to the file.
19690 * @param int $flags The optional parameter {@link flags} can be one,
19691 *   or more, of the following constants: FILE_USE_INCLUDE_PATH Search
19692 *   for the file in the include_path. FILE_IGNORE_NEW_LINES Do not add
19693 *   newline at the end of each array element FILE_SKIP_EMPTY_LINES Skip
19694 *   empty lines
19695 * @param resource $context
19696 * @return array
19697 * @since PHP 4, PHP 5
19698 **/
19699function file($filename, $flags, $context){}
19700
19701/**
19702 * @param string $filename Path to the file.
19703 * @return int
19704 * @since PHP 4, PHP 5
19705 **/
19706function fileatime($filename){}
19707
19708/**
19709 * Gets the inode change time of a file.
19710 *
19711 * @param string $filename Path to the file.
19712 * @return int
19713 * @since PHP 4, PHP 5
19714 **/
19715function filectime($filename){}
19716
19717/**
19718 * Gets the file group. The group ID is returned in numerical format, use
19719 * {@link posix_getgrgid} to resolve it to a group name.
19720 *
19721 * @param string $filename Path to the file.
19722 * @return int
19723 * @since PHP 4, PHP 5
19724 **/
19725function filegroup($filename){}
19726
19727/**
19728 * Gets the file inode.
19729 *
19730 * @param string $filename Path to the file.
19731 * @return int
19732 * @since PHP 4, PHP 5
19733 **/
19734function fileinode($filename){}
19735
19736/**
19737 * This function returns the time when the data blocks of a file were
19738 * being written to, that is, the time when the content of the file was
19739 * changed.
19740 *
19741 * @param string $filename Path to the file.
19742 * @return int
19743 * @since PHP 4, PHP 5
19744 **/
19745function filemtime($filename){}
19746
19747/**
19748 * Gets the file owner.
19749 *
19750 * @param string $filename Path to the file.
19751 * @return int
19752 * @since PHP 4, PHP 5
19753 **/
19754function fileowner($filename){}
19755
19756/**
19757 * Gets permissions for the given file.
19758 *
19759 * @param string $filename Path to the file.
19760 * @return int
19761 * @since PHP 4, PHP 5
19762 **/
19763function fileperms($filename){}
19764
19765/**
19766 * This reads and verifies the map file, storing the field count and
19767 * info.
19768 *
19769 * No locking is done, so you should avoid modifying your filePro
19770 * database while it may be opened in PHP.
19771 *
19772 * @param string $directory The map directory.
19773 * @return bool
19774 * @since PHP 4, PHP 5
19775 **/
19776function filepro($directory){}
19777
19778/**
19779 * Returns the number of fields (columns) in the opened filePro database.
19780 *
19781 * @return int
19782 * @since PHP 4, PHP 5
19783 **/
19784function filepro_fieldcount(){}
19785
19786/**
19787 * Returns the name of the field corresponding to {@link field_number}.
19788 *
19789 * @param int $field_number The field number.
19790 * @return string
19791 * @since PHP 4, PHP 5
19792 **/
19793function filepro_fieldname($field_number){}
19794
19795/**
19796 * Returns the edit type of the field corresponding to {@link
19797 * field_number}.
19798 *
19799 * @param int $field_number The field number.
19800 * @return string
19801 * @since PHP 4, PHP 5
19802 **/
19803function filepro_fieldtype($field_number){}
19804
19805/**
19806 * Returns the width of the field corresponding to {@link field_number}.
19807 *
19808 * @param int $field_number The field number.
19809 * @return int
19810 * @since PHP 4, PHP 5
19811 **/
19812function filepro_fieldwidth($field_number){}
19813
19814/**
19815 * Returns the data from the specified location in the database.
19816 *
19817 * @param int $row_number The row number. Must be between zero and the
19818 *   total number of rows minus one (0..{@link filepro_rowcount} - 1)
19819 * @param int $field_number The field number. Accepts values between
19820 *   zero and the total number of fields minus one (0..{@link
19821 *   filepro_fieldcount} - 1)
19822 * @return string
19823 * @since PHP 4, PHP 5
19824 **/
19825function filepro_retrieve($row_number, $field_number){}
19826
19827/**
19828 * Returns the number of rows in the opened filePro database.
19829 *
19830 * @return int
19831 * @since PHP 4, PHP 5
19832 **/
19833function filepro_rowcount(){}
19834
19835/**
19836 * Gets the size for the given file.
19837 *
19838 * @param string $filename Path to the file.
19839 * @return int
19840 * @since PHP 4, PHP 5
19841 **/
19842function filesize($filename){}
19843
19844/**
19845 * Returns the type of the given file.
19846 *
19847 * @param string $filename Path to the file.
19848 * @return string
19849 * @since PHP 4, PHP 5
19850 **/
19851function filetype($filename){}
19852
19853/**
19854 * Checks whether a file or directory exists.
19855 *
19856 * @param string $filename Path to the file or directory. On windows,
19857 *   use //computername/share/filename or \\computername\share\filename
19858 *   to check files on network shares.
19859 * @return bool
19860 * @since PHP 4, PHP 5
19861 **/
19862function file_exists($filename){}
19863
19864/**
19865 * This function is similar to {@link file}, except that {@link
19866 * file_get_contents} returns the file in a string, starting at the
19867 * specified {@link offset} up to {@link maxlen} bytes. On failure,
19868 * {@link file_get_contents} will return .
19869 *
19870 * {@link file_get_contents} is the preferred way to read the contents of
19871 * a file into a string. It will use memory mapping techniques if
19872 * supported by your OS to enhance performance.
19873 *
19874 * @param string $filename Name of the file to read.
19875 * @param bool $use_include_path
19876 * @param resource $context A valid context resource created with
19877 *   {@link stream_context_create}. If you don't need to use a custom
19878 *   context, you can skip this parameter by .
19879 * @param int $offset The offset where the reading starts on the
19880 *   original stream.
19881 * @param int $maxlen Maximum length of data read. The default is to
19882 *   read until end of file is reached. Note that this parameter is
19883 *   applied to the stream processed by the filters.
19884 * @return string
19885 * @since PHP 4 >= 4.3.0, PHP 5
19886 **/
19887function file_get_contents($filename, $use_include_path, $context, $offset, $maxlen){}
19888
19889/**
19890 * This function is identical to calling {@link fopen}, {@link fwrite}
19891 * and {@link fclose} successively to write data to a file.
19892 *
19893 * If {@link filename} does not exist, the file is created. Otherwise,
19894 * the existing file is overwritten, unless the FILE_APPEND flags is set.
19895 *
19896 * @param string $filename Path to the file where to write the data.
19897 * @param mixed $data The data to write. Can be either a string, an
19898 *   array or a stream resource. If {@link data} is a stream resource,
19899 *   the remaining buffer of that stream will be copied to the specified
19900 *   file. This is similar with using {@link stream_copy_to_stream}. You
19901 *   can also specify the {@link data} parameter as a single dimension
19902 *   array. This is equivalent to file_put_contents($filename,
19903 *   implode('', $array)).
19904 * @param int $flags The value of {@link flags} can be any combination
19905 *   of the following flags (with some restrictions), joined with the
19906 *   binary OR (|) operator.
19907 *
19908 *   Available flags Flag Description FILE_USE_INCLUDE_PATH Search for
19909 *   {@link filename} in the include directory. See include_path for more
19910 *   information. FILE_APPEND If file {@link filename} already exists,
19911 *   append the data to the file instead of overwriting it. Mutually
19912 *   exclusive with LOCK_EX since appends are atomic and thus there is no
19913 *   reason to lock. LOCK_EX Acquire an exclusive lock on the file while
19914 *   proceeding to the writing. Mutually exclusive with FILE_APPEND.
19915 * @param resource $context A valid context resource created with
19916 *   {@link stream_context_create}.
19917 * @return int
19918 * @since PHP 5
19919 **/
19920function file_put_contents($filename, $data, $flags, $context){}
19921
19922/**
19923 * @param int $type One of INPUT_GET, INPUT_POST, INPUT_COOKIE,
19924 *   INPUT_SERVER, or INPUT_ENV.
19925 * @param string $variable_name Name of a variable to check.
19926 * @return bool
19927 * @since PHP 5 >= 5.2.0
19928 **/
19929function filter_has_var($type, $variable_name){}
19930
19931/**
19932 * @param string $filtername Name of a filter to get.
19933 * @return int
19934 * @since PHP 5 >= 5.2.0
19935 **/
19936function filter_id($filtername){}
19937
19938/**
19939 * @param int $type One of INPUT_GET, INPUT_POST, INPUT_COOKIE,
19940 *   INPUT_SERVER, or INPUT_ENV.
19941 * @param string $variable_name Name of a variable to get.
19942 * @param int $filter Filter to apply.
19943 * @param mixed $options Associative array of options or bitwise
19944 *   disjunction of flags. If filter accepts options, flags can be
19945 *   provided in "flags" field of array.
19946 * @return mixed
19947 * @since PHP 5 >= 5.2.0
19948 **/
19949function filter_input($type, $variable_name, $filter, $options){}
19950
19951/**
19952 * This function is useful for retrieving many values without
19953 * repetitively calling {@link filter_input}.
19954 *
19955 * @param int $type One of INPUT_GET, INPUT_POST, INPUT_COOKIE,
19956 *   INPUT_SERVER, or INPUT_ENV.
19957 * @param mixed $definition An array defining the arguments. A valid
19958 *   key is a string containing a variable name and a valid value is
19959 *   either a filter type, or an array optionally specifying the filter,
19960 *   flags and options. If the value is an array, valid keys are filter
19961 *   which specifies the filter type, flags which specifies any flags
19962 *   that apply to the filter, and options which specifies any options
19963 *   that apply to the filter. See the example below for a better
19964 *   understanding. This parameter can be also an integer holding a
19965 *   filter constant. Then all values in the input array are filtered by
19966 *   this filter.
19967 * @return mixed
19968 * @since PHP 5 >= 5.2.0
19969 **/
19970function filter_input_array($type, $definition){}
19971
19972/**
19973 * @return array
19974 * @since PHP 5 >= 5.2.0
19975 **/
19976function filter_list(){}
19977
19978/**
19979 * @param mixed $variable Value to filter.
19980 * @param int $filter ID of a filter to use (see the manual page).
19981 * @param mixed $options Associative array of options or bitwise
19982 *   disjunction of flags. If filter accepts options, flags can be
19983 *   provided in "flags" field of array. For the "callback" filter,
19984 *   callback type should be passed. The callback must accept one
19985 *   argument, the value to be filtered, and return the value after
19986 *   filtering/sanitizing it.
19987 *
19988 *   <?php // for filters that accept options, use this format $options =
19989 *   array( 'options' => array( 'default' => 3, // value to return if the
19990 *   filter fails // other options here 'min_range' => 0 ), 'flags' =>
19991 *   FILTER_FLAG_ALLOW_OCTAL, ); $var = filter_var('0755',
19992 *   FILTER_VALIDATE_INT, $options);
19993 *
19994 *   // for filter that only accept flags, you can pass them directly
19995 *   $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN,
19996 *   FILTER_NULL_ON_FAILURE);
19997 *
19998 *   // for filter that only accept flags, you can also pass as an array
19999 *   $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN, array('flags' =>
20000 *   FILTER_NULL_ON_FAILURE));
20001 *
20002 *   // callback filter function foo($value) { $ret = new stdClass;
20003 *   $ret->value = filter_var($value, FILTER_VALIDATE_BOOLEAN,
20004 *   array('flags' => FILTER_NULL_ON_FAILURE)); return $ret; } $var =
20005 *   filter_var('yes', FILTER_CALLBACK, array('options' => 'foo')); ?>
20006 * @return mixed
20007 * @since PHP 5 >= 5.2.0
20008 **/
20009function filter_var($variable, $filter, $options){}
20010
20011/**
20012 * This function is useful for retrieving many values without
20013 * repetitively calling {@link filter_var}.
20014 *
20015 * @param array $data An array with string keys containing the data to
20016 *   filter.
20017 * @param mixed $definition An array defining the arguments. A valid
20018 *   key is a string containing a variable name and a valid value is
20019 *   either a filter type, or an array optionally specifying the filter,
20020 *   flags and options. If the value is an array, valid keys are filter
20021 *   which specifies the filter type, flags which specifies any flags
20022 *   that apply to the filter, and options which specifies any options
20023 *   that apply to the filter. See the example below for a better
20024 *   understanding. This parameter can be also an integer holding a
20025 *   filter constant. Then all values in the input array are filtered by
20026 *   this filter.
20027 * @return mixed
20028 * @since PHP 5 >= 5.2.0
20029 **/
20030function filter_var_array($data, $definition){}
20031
20032/**
20033 * This function is used to get information about binary data in a
20034 * string.
20035 *
20036 * @param resource $finfo Fileinfo resource returned by {@link
20037 *   finfo_open}.
20038 * @param string $string Content of a file to be checked.
20039 * @param int $options One or disjunction of more Fileinfo constants.
20040 * @param resource $context
20041 * @return string
20042 * @since PHP 5 >= 5.3.0, PECL fileinfo >= 0.1.0
20043 **/
20044function finfo_buffer($finfo, $string, $options, $context){}
20045
20046/**
20047 * This function closes the resource opened by {@link finfo_open}.
20048 *
20049 * @param resource $finfo Fileinfo resource returned by {@link
20050 *   finfo_open}.
20051 * @return bool
20052 * @since PHP >= 5.3.0, PECL fileinfo >= 0.1.0
20053 **/
20054function finfo_close($finfo){}
20055
20056/**
20057 * This function is used to get information about a file.
20058 *
20059 * @param resource $finfo Fileinfo resource returned by {@link
20060 *   finfo_open}.
20061 * @param string $file_name Name of a file to be checked.
20062 * @param int $options One or disjunction of more Fileinfo constants.
20063 * @param resource $context For a description of contexts, refer to .
20064 * @return string
20065 * @since PHP >= 5.3.0, PECL fileinfo >= 0.1.0
20066 **/
20067function finfo_file($finfo, $file_name, $options, $context){}
20068
20069/**
20070 * This function opens a magic database and returns its resource.
20071 *
20072 * @param int $options One or disjunction of more Fileinfo constants.
20073 * @param string $magic_file Name of a magic database file, usually
20074 *   something like /path/to/magic.mime. If not specified, the MAGIC
20075 *   environment variable is used. If this variable is not set either,
20076 *   /usr/share/misc/magic is used by default. A .mime and/or .mgc suffix
20077 *   is added if needed. Passing NULL or an empty string will be
20078 *   equivalent to the default value.
20079 * @return resource
20080 * @since PHP >= 5.3.0, PECL fileinfo >= 0.1.0
20081 **/
20082function finfo_open($options, $magic_file){}
20083
20084/**
20085 * This function sets various Fileinfo options. Options can be set also
20086 * directly in {@link finfo_open} or other Fileinfo functions.
20087 *
20088 * @param resource $finfo Fileinfo resource returned by {@link
20089 *   finfo_open}.
20090 * @param int $options One or disjunction of more Fileinfo constants.
20091 * @return bool
20092 * @since PHP >= 5.3.0, PECL fileinfo >= 0.1.0
20093 **/
20094function finfo_set_flags($finfo, $options){}
20095
20096/**
20097 * Gets the float value of {@link var}.
20098 *
20099 * @param mixed $var May be any scalar type. {@link floatval} should
20100 *   not be used on objects, as doing so will emit an E_NOTICE level
20101 *   error and return 1.
20102 * @return float
20103 * @since PHP 4 >= 4.2.0, PHP 5
20104 **/
20105function floatval($var){}
20106
20107/**
20108 * {@link flock} allows you to perform a simple reader/writer model which
20109 * can be used on virtually every platform (including most Unix
20110 * derivatives and even Windows).
20111 *
20112 * The lock is released also by {@link fclose} (which is also called
20113 * automatically when script finished).
20114 *
20115 * PHP supports a portable way of locking complete files in an advisory
20116 * way (which means all accessing programs have to use the same way of
20117 * locking or it will not work). By default, this function will block
20118 * until the requested lock is acquired; this may be controlled (on
20119 * non-Windows platforms) with the LOCK_NB option documented below.
20120 *
20121 * @param resource $handle An open file pointer.
20122 * @param int $operation {@link operation} is one of the following:
20123 *   LOCK_SH to acquire a shared lock (reader). LOCK_EX to acquire an
20124 *   exclusive lock (writer). LOCK_UN to release a lock (shared or
20125 *   exclusive). It is also possible to add LOCK_NB as a bitmask to one
20126 *   of the above operations if you don't want {@link flock} to block
20127 *   while locking. (not supported on Windows)
20128 * @param int $wouldblock The optional third argument is set to if the
20129 *   lock would block (EWOULDBLOCK errno condition). (not supported on
20130 *   Windows)
20131 * @return bool
20132 * @since PHP 4, PHP 5
20133 **/
20134function flock($handle, $operation, &$wouldblock){}
20135
20136/**
20137 * @param float $value The numeric value to round
20138 * @return float
20139 * @since PHP 4, PHP 5
20140 **/
20141function floor($value){}
20142
20143/**
20144 * Flushes the write buffers of PHP and whatever backend PHP is using
20145 * (CGI, a web server, etc). This attempts to push current output all the
20146 * way to the browser with a few caveats.
20147 *
20148 * {@link flush} may not be able to override the buffering scheme of your
20149 * web server and it has no effect on any client-side buffering in the
20150 * browser. It also doesn't affect PHP's userspace output buffering
20151 * mechanism. This means you will have to call both {@link ob_flush} and
20152 * {@link flush} to flush the ob output buffers if you are using those.
20153 *
20154 * Several servers, especially on Win32, will still buffer the output
20155 * from your script until it terminates before transmitting the results
20156 * to the browser.
20157 *
20158 * Server modules for Apache like mod_gzip may do buffering of their own
20159 * that will cause {@link flush} to not result in data being sent
20160 * immediately to the client.
20161 *
20162 * Even the browser may buffer its input before displaying it. Netscape,
20163 * for example, buffers text until it receives an end-of-line or the
20164 * beginning of a tag, and it won't render tables until the </table> tag
20165 * of the outermost table is seen.
20166 *
20167 * Some versions of Microsoft Internet Explorer will only start to
20168 * display the page after they have received 256 bytes of output, so you
20169 * may need to send extra whitespace before flushing to get those
20170 * browsers to display the page.
20171 *
20172 * @return void
20173 * @since PHP 4, PHP 5
20174 **/
20175function flush(){}
20176
20177/**
20178 * Returns the floating point remainder of dividing the dividend ({@link
20179 * x}) by the divisor ({@link y}). The reminder (r) is defined as: x = i
20180 * * y + r, for some integer i. If {@link y} is non-zero, r has the same
20181 * sign as {@link x} and a magnitude less than the magnitude of {@link
20182 * y}.
20183 *
20184 * @param float $x The dividend
20185 * @param float $y The divisor
20186 * @return float
20187 * @since PHP 4 >= 4.2.0, PHP 5
20188 **/
20189function fmod($x, $y){}
20190
20191/**
20192 * {@link fnmatch} checks if the passed {@link string} would match the
20193 * given shell wildcard {@link pattern}.
20194 *
20195 * @param string $pattern The shell wildcard pattern.
20196 * @param string $string The tested string. This function is especially
20197 *   useful for filenames, but may also be used on regular strings. The
20198 *   average user may be used to shell patterns or at least in their
20199 *   simplest form to '?' and '*' wildcards so using {@link fnmatch}
20200 *   instead of {@link preg_match} for frontend search expression input
20201 *   may be way more convenient for non-programming users.
20202 * @param int $flags The value of {@link flags} can be any combination
20203 *   of the following flags, joined with the binary OR (|) operator. A
20204 *   list of possible flags for {@link fnmatch} {@link Flag} Description
20205 *   FNM_NOESCAPE Disable backslash escaping. FNM_PATHNAME Slash in
20206 *   string only matches slash in the given pattern. FNM_PERIOD Leading
20207 *   period in string must be exactly matched by period in the given
20208 *   pattern. FNM_CASEFOLD Caseless match. Part of the GNU extension.
20209 * @return bool
20210 * @since PHP 4 >= 4.3.0, PHP 5
20211 **/
20212function fnmatch($pattern, $string, $flags){}
20213
20214/**
20215 * {@link fopen} binds a named resource, specified by {@link filename},
20216 * to a stream.
20217 *
20218 * @param string $filename If {@link filename} is of the form
20219 *   "scheme://...", it is assumed to be a URL and PHP will search for a
20220 *   protocol handler (also known as a wrapper) for that scheme. If no
20221 *   wrappers for that protocol are registered, PHP will emit a notice to
20222 *   help you track potential problems in your script and then continue
20223 *   as though {@link filename} specifies a regular file. If PHP has
20224 *   decided that {@link filename} specifies a local file, then it will
20225 *   try to open a stream on that file. The file must be accessible to
20226 *   PHP, so you need to ensure that the file access permissions allow
20227 *   this access. If you have enabled , or open_basedir further
20228 *   restrictions may apply. If PHP has decided that {@link filename}
20229 *   specifies a registered protocol, and that protocol is registered as
20230 *   a network URL, PHP will check to make sure that allow_url_fopen is
20231 *   enabled. If it is switched off, PHP will emit a warning and the
20232 *   fopen call will fail. On the Windows platform, be careful to escape
20233 *   any backslashes used in the path to the file, or use forward
20234 *   slashes.
20235 *
20236 *   <?php $handle = fopen("c:\\folder\\resource.txt", "r"); ?>
20237 * @param string $mode The {@link mode} parameter specifies the type of
20238 *   access you require to the stream. It may be any of the following: A
20239 *   list of possible modes for {@link fopen} using {@link mode} {@link
20240 *   mode} Description 'r' Open for reading only; place the file pointer
20241 *   at the beginning of the file. 'r+' Open for reading and writing;
20242 *   place the file pointer at the beginning of the file. 'w' Open for
20243 *   writing only; place the file pointer at the beginning of the file
20244 *   and truncate the file to zero length. If the file does not exist,
20245 *   attempt to create it. 'w+' Open for reading and writing; place the
20246 *   file pointer at the beginning of the file and truncate the file to
20247 *   zero length. If the file does not exist, attempt to create it. 'a'
20248 *   Open for writing only; place the file pointer at the end of the
20249 *   file. If the file does not exist, attempt to create it. 'a+' Open
20250 *   for reading and writing; place the file pointer at the end of the
20251 *   file. If the file does not exist, attempt to create it. 'x' Create
20252 *   and open for writing only; place the file pointer at the beginning
20253 *   of the file. If the file already exists, the {@link fopen} call will
20254 *   fail by returning and generating an error of level E_WARNING. If the
20255 *   file does not exist, attempt to create it. This is equivalent to
20256 *   specifying O_EXCL|O_CREAT flags for the underlying open(2) system
20257 *   call. 'x+' Create and open for reading and writing; place the file
20258 *   pointer at the beginning of the file. If the file already exists,
20259 *   the {@link fopen} call will fail by returning and generating an
20260 *   error of level E_WARNING. If the file does not exist, attempt to
20261 *   create it. This is equivalent to specifying O_EXCL|O_CREAT flags for
20262 *   the underlying open(2) system call.
20263 * @param bool $use_include_path The optional third {@link
20264 *   use_include_path} parameter can be set to '1' or if you want to
20265 *   search for the file in the include_path, too.
20266 * @param resource $context
20267 * @return resource
20268 * @since PHP 4, PHP 5
20269 **/
20270function fopen($filename, $mode, $use_include_path, $context){}
20271
20272/**
20273 * Calls a user defined function or method given by the {@link function}
20274 * parameter, with the following arguments. This function must be called
20275 * within a method context, it can't be used outside a class.
20276 *
20277 * @param callback $function The function or method to be called. This
20278 *   parameter may be an array, with the name of the class, and the
20279 *   method, or a string, with a function name.
20280 * @param mixed $parameter Zero or more parameters to be passed to the
20281 *   function.
20282 * @return mixed
20283 * @since PHP 5 >= 5.3.0
20284 **/
20285function forward_static_call($function, $parameter){}
20286
20287/**
20288 * Calls a user defined function or method given by the {@link function}
20289 * parameter. This function must be called within a method context, it
20290 * can't be used outside a class. All arguments of the forwarded method
20291 * are passed as values, and as an array, similarly to {@link
20292 * call_user_func_array}.
20293 *
20294 * @param callback $function The function or method to be called. This
20295 *   parameter may be an , with the name of the class, and the method, or
20296 *   a , with a function name.
20297 * @param array $parameters One parameter, gathering all the method
20298 *   parameter in one array.
20299 * @return mixed
20300 * @since PHP 5 >= 5.3.0
20301 **/
20302function forward_static_call_array($function, $parameters){}
20303
20304/**
20305 * Reads to EOF on the given file pointer from the current position and
20306 * writes the results to the output buffer.
20307 *
20308 * You may need to call {@link rewind} to reset the file pointer to the
20309 * beginning of the file if you have already written data to the file.
20310 *
20311 * If you just want to dump the contents of a file to the output buffer,
20312 * without first modifying it or seeking to a particular offset, you may
20313 * want to use the {@link readfile}, which saves you the {@link fopen}
20314 * call.
20315 *
20316 * @param resource $handle
20317 * @return int
20318 * @since PHP 4, PHP 5
20319 **/
20320function fpassthru($handle){}
20321
20322/**
20323 * Write a string produced according to {@link format} to the stream
20324 * resource specified by {@link handle}.
20325 *
20326 * @param resource $handle
20327 * @param string $format See {@link sprintf} for a description of
20328 *   {@link format}.
20329 * @param mixed $args
20330 * @return int
20331 * @since PHP 5
20332 **/
20333function fprintf($handle, $format, $args){}
20334
20335/**
20336 * {@link fputcsv} formats a line (passed as a {@link fields} array) as
20337 * CSV and write it (terminated by a newline) to the specified file
20338 * {@link handle}.
20339 *
20340 * @param resource $handle
20341 * @param array $fields An array of values.
20342 * @param string $delimiter The optional {@link delimiter} parameter
20343 *   sets the field delimiter (one character only).
20344 * @param string $enclosure The optional {@link enclosure} parameter
20345 *   sets the field enclosure (one character only).
20346 * @return int
20347 * @since PHP 5 >= 5.1.0
20348 **/
20349function fputcsv($handle, $fields, $delimiter, $enclosure){}
20350
20351/**
20352 * @param resource $handle
20353 * @param string $string The string that is to be written.
20354 * @param int $length If the {@link length} argument is given, writing
20355 *   will stop after {@link length} bytes have been written or the end of
20356 *   {@link string} is reached, whichever comes first. Note that if the
20357 *   {@link length} argument is given, then the magic_quotes_runtime
20358 *   configuration option will be ignored and no slashes will be stripped
20359 *   from {@link string}.
20360 * @return int
20361 * @since PHP 4, PHP 5
20362 **/
20363function fputs($handle, $string, $length){}
20364
20365/**
20366 * {@link fread} reads up to {@link length} bytes from the file pointer
20367 * referenced by {@link handle}. Reading stops as soon as one of the
20368 * following conditions is met: {@link length} bytes have been read EOF
20369 * (end of file) is reached a packet becomes available (for network
20370 * streams) 8192 bytes have been read (after opening userspace stream)
20371 *
20372 * @param resource $handle
20373 * @param int $length Up to {@link length} number of bytes read.
20374 * @return string
20375 * @since PHP 4, PHP 5
20376 **/
20377function fread($handle, $length){}
20378
20379/**
20380 * Converts a date from the French Republican Calendar to a Julian Day
20381 * Count.
20382 *
20383 * These routines only convert dates in years 1 through 14 (Gregorian
20384 * dates 22 September 1792 through 22 September 1806). This more than
20385 * covers the period when the calendar was in use.
20386 *
20387 * @param int $month The month as a number from 1 (for Vendémiaire) to
20388 *   13 (for the period of 5-6 days at the end of each year)
20389 * @param int $day The day as a number from 1 to 30
20390 * @param int $year The year as a number between 1 and 14
20391 * @return int
20392 * @since PHP 4, PHP 5
20393 **/
20394function frenchtojd($month, $day, $year){}
20395
20396/**
20397 * Converts a logical string to a visual one.
20398 *
20399 * @param string $str The logical string.
20400 * @param string $direction One of FRIBIDI_RTL, FRIBIDI_LTR or
20401 *   FRIBIDI_AUTO.
20402 * @param int $charset One of the FRIBIDI_CHARSET_XXX constants.
20403 * @return string
20404 * @since PHP 4 >= 4.0.4 and PHP 4 = 1.0
20405 **/
20406function fribidi_log2vis($str, $direction, $charset){}
20407
20408/**
20409 * The function {@link fscanf} is similar to {@link sscanf}, but it takes
20410 * its input from a file associated with {@link handle} and interprets
20411 * the input according to the specified {@link format}, which is
20412 * described in the documentation for {@link sprintf}.
20413 *
20414 * Any whitespace in the format string matches any whitespace in the
20415 * input stream. This means that even a tab \t in the format string can
20416 * match a single space character in the input stream.
20417 *
20418 * Each call to {@link fscanf} reads one line from the file.
20419 *
20420 * @param resource $handle
20421 * @param string $format The specified format as described in the
20422 *   {@link sprintf} documentation.
20423 * @return mixed
20424 * @since PHP 4 >= 4.0.1, PHP 5
20425 **/
20426function fscanf($handle, $format){}
20427
20428/**
20429 * Sets the file position indicator for the file referenced by {@link
20430 * handle}. The new position, measured in bytes from the beginning of the
20431 * file, is obtained by adding {@link offset} to the position specified
20432 * by {@link whence}.
20433 *
20434 * @param resource $handle
20435 * @param int $offset The offset. To move to a position before the
20436 *   end-of-file, you need to pass a negative value in {@link offset} and
20437 *   set {@link whence} to SEEK_END.
20438 * @param int $whence {@link whence} values are: SEEK_SET - Set
20439 *   position equal to {@link offset} bytes. SEEK_CUR - Set position to
20440 *   current location plus {@link offset}. SEEK_END - Set position to
20441 *   end-of-file plus {@link offset}.
20442 * @return int
20443 * @since PHP 4, PHP 5
20444 **/
20445function fseek($handle, $offset, $whence){}
20446
20447/**
20448 * Initiates a socket connection to the resource specified by {@link
20449 * hostname}.
20450 *
20451 * PHP supports targets in the Internet and Unix domains as described in
20452 * . A list of supported transports can also be retrieved using {@link
20453 * stream_get_transports}.
20454 *
20455 * The socket will by default be opened in blocking mode. You can switch
20456 * it to non-blocking mode by using {@link stream_set_blocking}.
20457 *
20458 * @param string $hostname If you have compiled in OpenSSL support, you
20459 *   may prefix the {@link hostname} with either ssl:// or tls:// to use
20460 *   an SSL or TLS client connection over TCP/IP to connect to the remote
20461 *   host.
20462 * @param int $port The port number.
20463 * @param int $errno If provided, holds the system level error number
20464 *   that occurred in the system-level connect() call. If the value
20465 *   returned in {@link errno} is 0 and the function returned , it is an
20466 *   indication that the error occurred before the connect() call. This
20467 *   is most likely due to a problem initializing the socket.
20468 * @param string $errstr The error message as a string.
20469 * @param float $timeout The connection timeout, in seconds.
20470 * @return resource
20471 * @since PHP 4, PHP 5
20472 **/
20473function fsockopen($hostname, $port, &$errno, &$errstr, $timeout){}
20474
20475/**
20476 * Gathers the statistics of the file opened by the file pointer {@link
20477 * handle}. This function is similar to the {@link stat} function except
20478 * that it operates on an open file pointer instead of a filename.
20479 *
20480 * @param resource $handle
20481 * @return array
20482 * @since PHP 4, PHP 5
20483 **/
20484function fstat($handle){}
20485
20486/**
20487 * Returns the position of the file pointer referenced by {@link handle}.
20488 *
20489 * @param resource $handle The file pointer must be valid, and must
20490 *   point to a file successfully opened by {@link fopen} or {@link
20491 *   popen}. {@link ftell} gives undefined results for append-only
20492 *   streams (opened with "a" flag).
20493 * @return int
20494 * @since PHP 4, PHP 5
20495 **/
20496function ftell($handle){}
20497
20498/**
20499 * The function converts the {@link pathname} of an existing accessible
20500 * file and a project identifier into an integer for use with for example
20501 * {@link shmop_open} and other System V IPC keys.
20502 *
20503 * @param string $pathname Path to an accessible file.
20504 * @param string $proj Project identifier. This must be a one character
20505 *   string.
20506 * @return int
20507 * @since PHP 4 >= 4.2.0, PHP 5
20508 **/
20509function ftok($pathname, $proj){}
20510
20511/**
20512 * Sends an ALLO command to the remote FTP server to allocate space for a
20513 * file to be uploaded.
20514 *
20515 * @param resource $ftp_stream The link identifier of the FTP
20516 *   connection.
20517 * @param int $filesize The number of bytes to allocate.
20518 * @param string $result A textual representation of the servers
20519 *   response will be returned by reference in {@link result} if a
20520 *   variable is provided.
20521 * @return bool
20522 * @since PHP 5
20523 **/
20524function ftp_alloc($ftp_stream, $filesize, &$result){}
20525
20526/**
20527 * Changes to the parent directory.
20528 *
20529 * @param resource $ftp_stream The link identifier of the FTP
20530 *   connection.
20531 * @return bool
20532 * @since PHP 4, PHP 5
20533 **/
20534function ftp_cdup($ftp_stream){}
20535
20536/**
20537 * Changes the current directory to the specified one.
20538 *
20539 * @param resource $ftp_stream The link identifier of the FTP
20540 *   connection.
20541 * @param string $directory The target directory.
20542 * @return bool
20543 * @since PHP 4, PHP 5
20544 **/
20545function ftp_chdir($ftp_stream, $directory){}
20546
20547/**
20548 * Sets the permissions on the specified remote file to {@link mode}.
20549 *
20550 * @param resource $ftp_stream The link identifier of the FTP
20551 *   connection.
20552 * @param int $mode The new permissions, given as an octal value.
20553 * @param string $filename The remote file.
20554 * @return int
20555 * @since PHP 5
20556 **/
20557function ftp_chmod($ftp_stream, $mode, $filename){}
20558
20559/**
20560 * {@link ftp_close} closes the given link identifier and releases the
20561 * resource.
20562 *
20563 * @param resource $ftp_stream The link identifier of the FTP
20564 *   connection.
20565 * @return bool
20566 * @since PHP 4 >= 4.2.0, PHP 5
20567 **/
20568function ftp_close($ftp_stream){}
20569
20570/**
20571 * {@link ftp_connect} opens an FTP connection to the specified {@link
20572 * host}.
20573 *
20574 * @param string $host The FTP server address. This parameter shouldn't
20575 *   have any trailing slashes and shouldn't be prefixed with ftp://.
20576 * @param int $port This parameter specifies an alternate port to
20577 *   connect to. If it is omitted or set to zero, then the default FTP
20578 *   port, 21, will be used.
20579 * @param int $timeout This parameter specifies the timeout for all
20580 *   subsequent network operations. If omitted, the default value is 90
20581 *   seconds. The timeout can be changed and queried at any time with
20582 *   {@link ftp_set_option} and {@link ftp_get_option}.
20583 * @return resource
20584 * @since PHP 4, PHP 5
20585 **/
20586function ftp_connect($host, $port, $timeout){}
20587
20588/**
20589 * {@link ftp_delete} deletes the file specified by {@link path} from the
20590 * FTP server.
20591 *
20592 * @param resource $ftp_stream The link identifier of the FTP
20593 *   connection.
20594 * @param string $path The file to delete.
20595 * @return bool
20596 * @since PHP 4, PHP 5
20597 **/
20598function ftp_delete($ftp_stream, $path){}
20599
20600/**
20601 * Sends a SITE EXEC {@link command} request to the FTP server.
20602 *
20603 * @param resource $ftp_stream The link identifier of the FTP
20604 *   connection.
20605 * @param string $command The command to execute.
20606 * @return bool
20607 * @since PHP 4 >= 4.0.3, PHP 5
20608 **/
20609function ftp_exec($ftp_stream, $command){}
20610
20611/**
20612 * {@link ftp_fget} retrieves {@link remote_file} from the FTP server,
20613 * and writes it to the given file pointer.
20614 *
20615 * @param resource $ftp_stream The link identifier of the FTP
20616 *   connection.
20617 * @param resource $handle An open file pointer in which we store the
20618 *   data.
20619 * @param string $remote_file The remote file path.
20620 * @param int $mode The transfer mode. Must be either FTP_ASCII or
20621 *   FTP_BINARY.
20622 * @param int $resumepos The position in the remote file to start
20623 *   downloading from.
20624 * @return bool
20625 * @since PHP 4, PHP 5
20626 **/
20627function ftp_fget($ftp_stream, $handle, $remote_file, $mode, $resumepos){}
20628
20629/**
20630 * {@link ftp_fput} uploads the data from a file pointer to a remote file
20631 * on the FTP server.
20632 *
20633 * @param resource $ftp_stream The link identifier of the FTP
20634 *   connection.
20635 * @param string $remote_file The remote file path.
20636 * @param resource $handle An open file pointer on the local file.
20637 *   Reading stops at end of file.
20638 * @param int $mode The transfer mode. Must be either FTP_ASCII or
20639 *   FTP_BINARY.
20640 * @param int $startpos
20641 * @return bool
20642 * @since PHP 4, PHP 5
20643 **/
20644function ftp_fput($ftp_stream, $remote_file, $handle, $mode, $startpos){}
20645
20646/**
20647 * {@link ftp_get} retrieves a remote file from the FTP server, and saves
20648 * it into a local file.
20649 *
20650 * @param resource $ftp_stream The link identifier of the FTP
20651 *   connection.
20652 * @param string $local_file The local file path (will be overwritten
20653 *   if the file already exists).
20654 * @param string $remote_file The remote file path.
20655 * @param int $mode The transfer mode. Must be either FTP_ASCII or
20656 *   FTP_BINARY.
20657 * @param int $resumepos The position in the remote file to start
20658 *   downloading from.
20659 * @return bool
20660 * @since PHP 4, PHP 5
20661 **/
20662function ftp_get($ftp_stream, $local_file, $remote_file, $mode, $resumepos){}
20663
20664/**
20665 * This function returns the value for the requested {@link option} from
20666 * the specified FTP connection.
20667 *
20668 * @param resource $ftp_stream The link identifier of the FTP
20669 *   connection.
20670 * @param int $option Currently, the following options are supported:
20671 *   Supported runtime FTP options FTP_TIMEOUT_SEC Returns the current
20672 *   timeout used for network related operations. FTP_AUTOSEEK Returns if
20673 *   this option is on, otherwise.
20674 * @return mixed
20675 * @since PHP 4 >= 4.2.0, PHP 5
20676 **/
20677function ftp_get_option($ftp_stream, $option){}
20678
20679/**
20680 * Logs in to the given FTP stream.
20681 *
20682 * @param resource $ftp_stream The link identifier of the FTP
20683 *   connection.
20684 * @param string $username The username (USER).
20685 * @param string $password The password (PASS).
20686 * @return bool
20687 * @since PHP 4, PHP 5
20688 **/
20689function ftp_login($ftp_stream, $username, $password){}
20690
20691/**
20692 * {@link ftp_mdtm} gets the last modified time for a remote file.
20693 *
20694 * @param resource $ftp_stream The link identifier of the FTP
20695 *   connection.
20696 * @param string $remote_file The file from which to extract the last
20697 *   modification time.
20698 * @return int
20699 * @since PHP 4, PHP 5
20700 **/
20701function ftp_mdtm($ftp_stream, $remote_file){}
20702
20703/**
20704 * Creates the specified {@link directory} on the FTP server.
20705 *
20706 * @param resource $ftp_stream The link identifier of the FTP
20707 *   connection.
20708 * @param string $directory The name of the directory that will be
20709 *   created.
20710 * @return string
20711 * @since PHP 4, PHP 5
20712 **/
20713function ftp_mkdir($ftp_stream, $directory){}
20714
20715/**
20716 * Continues retrieving/sending a file non-blocking.
20717 *
20718 * @param resource $ftp_stream The link identifier of the FTP
20719 *   connection.
20720 * @return int
20721 * @since PHP 4 >= 4.3.0, PHP 5
20722 **/
20723function ftp_nb_continue($ftp_stream){}
20724
20725/**
20726 * {@link ftp_nb_fget} retrieves a remote file from the FTP server.
20727 *
20728 * The difference between this function and {@link ftp_fget} is that this
20729 * function retrieves the file asynchronously, so your program can
20730 * perform other operations while the file is being downloaded.
20731 *
20732 * @param resource $ftp_stream The link identifier of the FTP
20733 *   connection.
20734 * @param resource $handle An open file pointer in which we store the
20735 *   data.
20736 * @param string $remote_file The remote file path.
20737 * @param int $mode The transfer mode. Must be either FTP_ASCII or
20738 *   FTP_BINARY.
20739 * @param int $resumepos
20740 * @return int
20741 * @since PHP 4 >= 4.3.0, PHP 5
20742 **/
20743function ftp_nb_fget($ftp_stream, $handle, $remote_file, $mode, $resumepos){}
20744
20745/**
20746 * {@link ftp_nb_fput} uploads the data from a file pointer to a remote
20747 * file on the FTP server.
20748 *
20749 * The difference between this function and the {@link ftp_fput} is that
20750 * this function uploads the file asynchronously, so your program can
20751 * perform other operations while the file is being uploaded.
20752 *
20753 * @param resource $ftp_stream The link identifier of the FTP
20754 *   connection.
20755 * @param string $remote_file The remote file path.
20756 * @param resource $handle An open file pointer on the local file.
20757 *   Reading stops at end of file.
20758 * @param int $mode The transfer mode. Must be either FTP_ASCII or
20759 *   FTP_BINARY.
20760 * @param int $startpos
20761 * @return int
20762 * @since PHP 4 >= 4.3.0, PHP 5
20763 **/
20764function ftp_nb_fput($ftp_stream, $remote_file, $handle, $mode, $startpos){}
20765
20766/**
20767 * {@link ftp_nb_get} retrieves a remote file from the FTP server, and
20768 * saves it into a local file.
20769 *
20770 * The difference between this function and {@link ftp_get} is that this
20771 * function retrieves the file asynchronously, so your program can
20772 * perform other operations while the file is being downloaded.
20773 *
20774 * @param resource $ftp_stream The link identifier of the FTP
20775 *   connection.
20776 * @param string $local_file The local file path (will be overwritten
20777 *   if the file already exists).
20778 * @param string $remote_file The remote file path.
20779 * @param int $mode The transfer mode. Must be either FTP_ASCII or
20780 *   FTP_BINARY.
20781 * @param int $resumepos
20782 * @return int
20783 * @since PHP 4 >= 4.3.0, PHP 5
20784 **/
20785function ftp_nb_get($ftp_stream, $local_file, $remote_file, $mode, $resumepos){}
20786
20787/**
20788 * {@link ftp_nb_put} stores a local file on the FTP server.
20789 *
20790 * The difference between this function and the {@link ftp_put} is that
20791 * this function uploads the file asynchronously, so your program can
20792 * perform other operations while the file is being uploaded.
20793 *
20794 * @param resource $ftp_stream The link identifier of the FTP
20795 *   connection.
20796 * @param string $remote_file The remote file path.
20797 * @param string $local_file The local file path.
20798 * @param int $mode The transfer mode. Must be either FTP_ASCII or
20799 *   FTP_BINARY.
20800 * @param int $startpos
20801 * @return int
20802 * @since PHP 4 >= 4.3.0, PHP 5
20803 **/
20804function ftp_nb_put($ftp_stream, $remote_file, $local_file, $mode, $startpos){}
20805
20806/**
20807 * @param resource $ftp_stream The link identifier of the FTP
20808 *   connection.
20809 * @param string $directory The directory to be listed. This parameter
20810 *   can also include arguments, eg. ftp_nlist($conn_id, "-la
20811 *   /your/dir"); Note that this parameter isn't escaped so there may be
20812 *   some issues with filenames containing spaces and other characters.
20813 * @return array
20814 * @since PHP 4, PHP 5
20815 **/
20816function ftp_nlist($ftp_stream, $directory){}
20817
20818/**
20819 * {@link ftp_pasv} turns on or off passive mode. In passive mode, data
20820 * connections are initiated by the client, rather than by the server. It
20821 * may be needed if the client is behind firewall.
20822 *
20823 * Please note that {@link ftp_pasv} can only be called after a
20824 * successfull login or otherwise it will fail.
20825 *
20826 * @param resource $ftp_stream The link identifier of the FTP
20827 *   connection.
20828 * @param bool $pasv If , the passive mode is turned on, else it's
20829 *   turned off.
20830 * @return bool
20831 * @since PHP 4, PHP 5
20832 **/
20833function ftp_pasv($ftp_stream, $pasv){}
20834
20835/**
20836 * {@link ftp_put} stores a local file on the FTP server.
20837 *
20838 * @param resource $ftp_stream The link identifier of the FTP
20839 *   connection.
20840 * @param string $remote_file The remote file path.
20841 * @param string $local_file The local file path.
20842 * @param int $mode The transfer mode. Must be either FTP_ASCII or
20843 *   FTP_BINARY.
20844 * @param int $startpos
20845 * @return bool
20846 * @since PHP 4, PHP 5
20847 **/
20848function ftp_put($ftp_stream, $remote_file, $local_file, $mode, $startpos){}
20849
20850/**
20851 * @param resource $ftp_stream The link identifier of the FTP
20852 *   connection.
20853 * @return string
20854 * @since PHP 4, PHP 5
20855 **/
20856function ftp_pwd($ftp_stream){}
20857
20858/**
20859 * {@link ftp_quit} closes the given link identifier and releases the
20860 * resource.
20861 *
20862 * @param resource $ftp_stream The link identifier of the FTP
20863 *   connection.
20864 * @return bool
20865 * @since PHP 4, PHP 5
20866 **/
20867function ftp_quit($ftp_stream){}
20868
20869/**
20870 * Sends an arbitrary {@link command} to the FTP server.
20871 *
20872 * @param resource $ftp_stream The link identifier of the FTP
20873 *   connection.
20874 * @param string $command The command to execute.
20875 * @return array
20876 * @since PHP 5
20877 **/
20878function ftp_raw($ftp_stream, $command){}
20879
20880/**
20881 * {@link ftp_rawlist} executes the FTP LIST command, and returns the
20882 * result as an array.
20883 *
20884 * @param resource $ftp_stream The link identifier of the FTP
20885 *   connection.
20886 * @param string $directory The directory path.
20887 * @param bool $recursive If set to , the issued command will be LIST
20888 *   -R.
20889 * @return array
20890 * @since PHP 4, PHP 5
20891 **/
20892function ftp_rawlist($ftp_stream, $directory, $recursive){}
20893
20894/**
20895 * {@link ftp_rename} renames a file or a directory on the FTP server.
20896 *
20897 * @param resource $ftp_stream The link identifier of the FTP
20898 *   connection.
20899 * @param string $oldname The old file/directory name.
20900 * @param string $newname The new name.
20901 * @return bool
20902 * @since PHP 4, PHP 5
20903 **/
20904function ftp_rename($ftp_stream, $oldname, $newname){}
20905
20906/**
20907 * Removes the specified {@link directory} on the FTP server.
20908 *
20909 * @param resource $ftp_stream The link identifier of the FTP
20910 *   connection.
20911 * @param string $directory The directory to delete. This must be
20912 *   either an absolute or relative path to an empty directory.
20913 * @return bool
20914 * @since PHP 4, PHP 5
20915 **/
20916function ftp_rmdir($ftp_stream, $directory){}
20917
20918/**
20919 * This function controls various runtime options for the specified FTP
20920 * stream.
20921 *
20922 * @param resource $ftp_stream The link identifier of the FTP
20923 *   connection.
20924 * @param int $option Currently, the following options are supported:
20925 *   Supported runtime FTP options FTP_TIMEOUT_SEC Changes the timeout in
20926 *   seconds used for all network related functions. {@link value} must
20927 *   be an integer that is greater than 0. The default timeout is 90
20928 *   seconds. FTP_AUTOSEEK When enabled, GET or PUT requests with a
20929 *   {@link resumepos} or {@link startpos} parameter will first seek to
20930 *   the requested position within the file. This is enabled by default.
20931 * @param mixed $value This parameter depends on which {@link option}
20932 *   is chosen to be altered.
20933 * @return bool
20934 * @since PHP 4 >= 4.2.0, PHP 5
20935 **/
20936function ftp_set_option($ftp_stream, $option, $value){}
20937
20938/**
20939 * {@link ftp_site} sends the given SITE command to the FTP server.
20940 *
20941 * SITE commands are not standardized, and vary from server to server.
20942 * They are useful for handling such things as file permissions and group
20943 * membership.
20944 *
20945 * @param resource $ftp_stream The link identifier of the FTP
20946 *   connection.
20947 * @param string $command The SITE command. Note that this parameter
20948 *   isn't escaped so there may be some issues with filenames containing
20949 *   spaces and other characters.
20950 * @return bool
20951 * @since PHP 4, PHP 5
20952 **/
20953function ftp_site($ftp_stream, $command){}
20954
20955/**
20956 * {@link ftp_size} returns the size of the given file in bytes.
20957 *
20958 * @param resource $ftp_stream The link identifier of the FTP
20959 *   connection.
20960 * @param string $remote_file The remote file.
20961 * @return int
20962 * @since PHP 4, PHP 5
20963 **/
20964function ftp_size($ftp_stream, $remote_file){}
20965
20966/**
20967 * {@link ftp_ssl_connect} opens a SSL-FTP connection to the specified
20968 * {@link host}.
20969 *
20970 * @param string $host The FTP server address. This parameter shouldn't
20971 *   have any trailing slashes and shouldn't be prefixed with ftp://.
20972 * @param int $port This parameter specifies an alternate port to
20973 *   connect to. If it is omitted or set to zero, then the default FTP
20974 *   port, 21, will be used.
20975 * @param int $timeout This parameter specifies the timeout for all
20976 *   subsequent network operations. If omitted, the default value is 90
20977 *   seconds. The timeout can be changed and queried at any time with
20978 *   {@link ftp_set_option} and {@link ftp_get_option}.
20979 * @return resource
20980 * @since PHP 4 >= 4.3.0, PHP 5
20981 **/
20982function ftp_ssl_connect($host, $port, $timeout){}
20983
20984/**
20985 * Returns the system type identifier of the remote FTP server.
20986 *
20987 * @param resource $ftp_stream The link identifier of the FTP
20988 *   connection.
20989 * @return string
20990 * @since PHP 4, PHP 5
20991 **/
20992function ftp_systype($ftp_stream){}
20993
20994/**
20995 * Takes the filepointer, {@link handle}, and truncates the file to
20996 * length, {@link size}.
20997 *
20998 * @param resource $handle The file pointer.
20999 * @param int $size The size to truncate to.
21000 * @return bool
21001 * @since PHP 4, PHP 5
21002 **/
21003function ftruncate($handle, $size){}
21004
21005/**
21006 * Checks the list of defined functions, both built-in (internal) and
21007 * user-defined, for {@link function_name}.
21008 *
21009 * @param string $function_name The function name, as a string.
21010 * @return bool
21011 * @since PHP 4, PHP 5
21012 **/
21013function function_exists($function_name){}
21014
21015/**
21016 * Gets the specified argument from a user-defined function's argument
21017 * list.
21018 *
21019 * This function may be used in conjunction with {@link func_get_args}
21020 * and {@link func_num_args} to allow user-defined functions to accept
21021 * variable-length argument lists.
21022 *
21023 * @param int $arg_num The argument offset. Function arguments are
21024 *   counted starting from zero.
21025 * @return mixed
21026 * @since PHP 4, PHP 5
21027 **/
21028function func_get_arg($arg_num){}
21029
21030/**
21031 * Gets an array of the function's argument list.
21032 *
21033 * This function may be used in conjunction with {@link func_get_arg} and
21034 * {@link func_num_args} to allow user-defined functions to accept
21035 * variable-length argument lists.
21036 *
21037 * @return array
21038 * @since PHP 4, PHP 5
21039 **/
21040function func_get_args(){}
21041
21042/**
21043 * Gets the number of arguments passed to the function.
21044 *
21045 * This function may be used in conjunction with {@link func_get_arg} and
21046 * {@link func_get_args} to allow user-defined functions to accept
21047 * variable-length argument lists.
21048 *
21049 * @return int
21050 * @since PHP 4, PHP 5
21051 **/
21052function func_num_args(){}
21053
21054/**
21055 * @param resource $handle
21056 * @param string $string The string that is to be written.
21057 * @param int $length If the {@link length} argument is given, writing
21058 *   will stop after {@link length} bytes have been written or the end of
21059 *   {@link string} is reached, whichever comes first. Note that if the
21060 *   {@link length} argument is given, then the magic_quotes_runtime
21061 *   configuration option will be ignored and no slashes will be stripped
21062 *   from {@link string}.
21063 * @return int
21064 * @since PHP 4, PHP 5
21065 **/
21066function fwrite($handle, $string, $length){}
21067
21068/**
21069 * Forces collection of any existing garbage cycles.
21070 *
21071 * @return int
21072 **/
21073function gc_collect_cycles(){}
21074
21075/**
21076 * Deactivates the circular reference collector.
21077 *
21078 * @return void
21079 **/
21080function gc_disable(){}
21081
21082/**
21083 * Activates the circular reference collector.
21084 *
21085 * @return void
21086 **/
21087function gc_enable(){}
21088
21089/**
21090 * Returns status of the circular reference collector.
21091 *
21092 * @return bool
21093 **/
21094function gc_enabled(){}
21095
21096/**
21097 * Gets information about the version and capabilities of the installed
21098 * GD library.
21099 *
21100 * @return array
21101 * @since PHP 4 >= 4.3.0, PHP 5
21102 **/
21103function gd_info(){}
21104
21105/**
21106 * The {@link geoip_continent_code_by_name} function will return the two
21107 * letter continent code corresponding to a hostname or an IP address.
21108 *
21109 * @param string $hostname The hostname or IP address whose location is
21110 *   to be looked-up.
21111 * @return string
21112 * @since PECL geoip >= 1.0.3
21113 **/
21114function geoip_continent_code_by_name($hostname){}
21115
21116/**
21117 * The {@link geoip_country_code3_by_name} function will return the three
21118 * letter country code corresponding to a hostname or an IP address.
21119 *
21120 * @param string $hostname The hostname or IP address whose location is
21121 *   to be looked-up.
21122 * @return string
21123 * @since PECL geoip >= 0.2.0
21124 **/
21125function geoip_country_code3_by_name($hostname){}
21126
21127/**
21128 * The {@link geoip_country_code_by_name} function will return the two
21129 * letter country code corresponding to a hostname or an IP address.
21130 *
21131 * @param string $hostname The hostname or IP address whose location is
21132 *   to be looked-up.
21133 * @return string
21134 * @since PECL geoip >= 0.2.0
21135 **/
21136function geoip_country_code_by_name($hostname){}
21137
21138/**
21139 * The {@link geoip_country_name_by_name} function will return the full
21140 * country name corresponding to a hostname or an IP address.
21141 *
21142 * @param string $hostname The hostname or IP address whose location is
21143 *   to be looked-up.
21144 * @return string
21145 * @since PECL geoip >= 0.2.0
21146 **/
21147function geoip_country_name_by_name($hostname){}
21148
21149/**
21150 * The {@link geoip_database_info} function returns the corresponding
21151 * GeoIP Database version as it is defined inside the binary file.
21152 *
21153 * If this function is called without arguments, it returns the version
21154 * of the GeoIP Free Country Edition.
21155 *
21156 * @param int $database The database type as an integer. You can use
21157 *   the various constants defined with this extension (ie:
21158 *   GEOIP_*_EDITION).
21159 * @return string
21160 * @since PECL geoip >= 0.2.0
21161 **/
21162function geoip_database_info($database){}
21163
21164/**
21165 * The {@link geoip_db_avail} function returns if the corresponding GeoIP
21166 * Database is available and can be opened on disk.
21167 *
21168 * It does not indicate if the file is a proper database, only if it is
21169 * readable.
21170 *
21171 * @param int $database The database type as an integer. You can use
21172 *   the various constants defined with this extension (ie:
21173 *   GEOIP_*_EDITION).
21174 * @return bool
21175 * @since PECL geoip >= 1.0.1
21176 **/
21177function geoip_db_avail($database){}
21178
21179/**
21180 * The {@link geoip_db_filename} function returns the filename of the
21181 * corresponding GeoIP Database.
21182 *
21183 * It does not indicate if the file exists or not on disk, only where the
21184 * library is looking for the database.
21185 *
21186 * @param int $database The database type as an integer. You can use
21187 *   the various constants defined with this extension (ie:
21188 *   GEOIP_*_EDITION).
21189 * @return string
21190 * @since PECL geoip >= 1.0.1
21191 **/
21192function geoip_db_filename($database){}
21193
21194/**
21195 * The {@link geoip_db_get_all_info} function will return detailed
21196 * information as a multi-dimensional array about all the GeoIP database
21197 * types.
21198 *
21199 * This function is available even if no databases are installed. It will
21200 * simply list them as non-available.
21201 *
21202 * The names of the different keys of the returning associative array are
21203 * as follows:
21204 *
21205 * "available" -- Boolean, indicate if DB is available (see {@link
21206 * geoip_db_avail}) "description" -- The database description "filename"
21207 * -- The database filename on disk (see {@link geoip_db_filename})
21208 *
21209 * @return array
21210 * @since PECL geoip >= 1.0.1
21211 **/
21212function geoip_db_get_all_info(){}
21213
21214/**
21215 * The {@link geoip_id_by_name} function will return the country and
21216 * region corresponding to a hostname or an IP address.
21217 *
21218 * The return value is numeric and can be compared to the following
21219 * constants:
21220 *
21221 * GEOIP_UNKNOWN_SPEED GEOIP_DIALUP_SPEED GEOIP_CABLEDSL_SPEED
21222 * GEOIP_CORPORATE_SPEED
21223 *
21224 * @param string $hostname The hostname or IP address whose net speed
21225 *   is to be looked-up.
21226 * @return int
21227 * @since PECL geoip >= 0.2.0
21228 **/
21229function geoip_id_by_name($hostname){}
21230
21231/**
21232 * The {@link geoip_isp_by_name} function will return the name of the
21233 * Internet Service Provider (ISP) that an IP is assigned to.
21234 *
21235 * This function is currently only available to users who have bought a
21236 * commercial GeoIP ISP Edition. A warning will be issued if the proper
21237 * database cannot be located.
21238 *
21239 * @param string $hostname The hostname or IP address.
21240 * @return string
21241 * @since PECL geoip >= 1.0.2
21242 **/
21243function geoip_isp_by_name($hostname){}
21244
21245/**
21246 * The {@link geoip_org_by_name} function will return the name of the
21247 * organization that an IP is assigned to.
21248 *
21249 * This function is currently only available to users who have bought a
21250 * commercial GeoIP Organization, ISP or AS Edition. A warning will be
21251 * issued if the proper database cannot be located.
21252 *
21253 * @param string $hostname The hostname or IP address.
21254 * @return string
21255 * @since PECL geoip >= 0.2.0
21256 **/
21257function geoip_org_by_name($hostname){}
21258
21259/**
21260 * The {@link geoip_record_by_name} function will return the record
21261 * information corresponding to a hostname or an IP address.
21262 *
21263 * This function is available for both GeoLite City Edition and
21264 * commercial GeoIP City Edition. A warning will be issued if the proper
21265 * database cannot be located.
21266 *
21267 * The names of the different keys of the returning associative array are
21268 * as follows:
21269 *
21270 * "continent_code" -- Two letter continent code (as of version 1.0.4
21271 * with libgeoip 1.4.3 or newer) "country_code" -- Two letter country
21272 * code (see {@link geoip_country_code_by_name}) "country_code3" -- Three
21273 * letter country code (see {@link geoip_country_code3_by_name})
21274 * "country_name" -- The country name (see {@link
21275 * geoip_country_name_by_name}) "region" -- The region code (ex: CA for
21276 * California) "city" -- The city. "postal_code" -- The Postal Code, FSA
21277 * or Zip Code. "latitude" -- The Latitude as signed double. "longitude"
21278 * -- The Longitude as signed double. "dma_code" -- Designated Market
21279 * Area code (USA and Canada only) "area_code" -- The PSTN area code (ex:
21280 * 212)
21281 *
21282 * @param string $hostname The hostname or IP address whose record is
21283 *   to be looked-up.
21284 * @return array
21285 * @since PECL geoip >= 0.2.0
21286 **/
21287function geoip_record_by_name($hostname){}
21288
21289/**
21290 * The {@link geoip_region_by_name} function will return the country and
21291 * region corresponding to a hostname or an IP address.
21292 *
21293 * This function is currently only available to users who have bought a
21294 * commercial GeoIP Region Edition. A warning will be issued if the
21295 * proper database cannot be located.
21296 *
21297 * The names of the different keys of the returning associative array are
21298 * as follows:
21299 *
21300 * "country_code" -- Two letter country code (see {@link
21301 * geoip_country_code_by_name}) "region" -- The region code (ex: CA for
21302 * California)
21303 *
21304 * @param string $hostname The hostname or IP address whose region is
21305 *   to be looked-up.
21306 * @return array
21307 * @since PECL geoip >= 0.2.0
21308 **/
21309function geoip_region_by_name($hostname){}
21310
21311/**
21312 * The {@link geoip_region_name_by_code} function will return the region
21313 * name corresponding to a country and region code combo.
21314 *
21315 * In the United States, the region code corresponds to the two-letter
21316 * abbreviation of each state. In Canada, the region code corresponds to
21317 * the two-letter province or territory code as attributed by Canada
21318 * Post.
21319 *
21320 * For the rest of the world, GeoIP uses FIPS 10-4 codes to represent
21321 * regions. You can check for a detailed list of FIPS 10-4 codes.
21322 *
21323 * This function is always available if using GeoIP Library version 1.4.1
21324 * or newer. The data is taken directly from the GeoIP Library and not
21325 * from any database.
21326 *
21327 * @param string $country_code The two-letter country code (see {@link
21328 *   geoip_country_code_by_name})
21329 * @param string $region_code The two-letter (or digit) region code
21330 *   (see {@link geoip_region_by_name})
21331 * @return string
21332 * @since PECL geoip >= 1.0.4
21333 **/
21334function geoip_region_name_by_code($country_code, $region_code){}
21335
21336/**
21337 * The {@link geoip_time_zone_by_country_and_region} function will return
21338 * the time zone corresponding to a country and region code combo.
21339 *
21340 * In the United States, the region code corresponds to the two-letter
21341 * abbreviation of each state. In Canada, the region code corresponds to
21342 * the two-letter province or territory code as attributed by Canada
21343 * Post.
21344 *
21345 * For the rest of the world, GeoIP uses FIPS 10-4 codes to represent
21346 * regions. You can check for a detailed list of FIPS 10-4 codes.
21347 *
21348 * This function is always available if using GeoIP Library version 1.4.1
21349 * or newer. The data is taken directly from the GeoIP Library and not
21350 * from any database.
21351 *
21352 * @param string $country_code The two-letter country code (see {@link
21353 *   geoip_country_code_by_name})
21354 * @param string $region_code The two-letter (or digit) region code
21355 *   (see {@link geoip_region_by_name})
21356 * @return string
21357 * @since PECL geoip >= 1.0.4
21358 **/
21359function geoip_time_zone_by_country_and_region($country_code, $region_code){}
21360
21361/**
21362 * Fetches all HTTP headers from the current request.
21363 *
21364 * This function is an alias for {@link apache_request_headers}. Please
21365 * read the {@link apache_request_headers} documentation for more
21366 * information on how this function works.
21367 *
21368 * @return array
21369 * @since PHP 4, PHP 5
21370 **/
21371function getallheaders(){}
21372
21373/**
21374 * Gets the current working directory.
21375 *
21376 * @return string
21377 * @since PHP 4, PHP 5
21378 **/
21379function getcwd(){}
21380
21381/**
21382 * Returns an associative array containing the date information of the
21383 * {@link timestamp}, or the current local time if no {@link timestamp}
21384 * is given.
21385 *
21386 * @param int $timestamp
21387 * @return array
21388 * @since PHP 4, PHP 5
21389 **/
21390function getdate($timestamp){}
21391
21392/**
21393 * Gets the value of an environment variable.
21394 *
21395 * You can see a list of all the environmental variables by using {@link
21396 * phpinfo}. You can find out what many of them mean by taking a look at
21397 * the CGI specification, specifically the page on environmental
21398 * variables.
21399 *
21400 * @param string $varname The variable name.
21401 * @return string
21402 * @since PHP 4, PHP 5
21403 **/
21404function getenv($varname){}
21405
21406/**
21407 * Returns the host name of the Internet host specified by {@link
21408 * ip_address}.
21409 *
21410 * @param string $ip_address The host IP address.
21411 * @return string
21412 * @since PHP 4, PHP 5
21413 **/
21414function gethostbyaddr($ip_address){}
21415
21416/**
21417 * Returns the IPv4 address of the Internet host specified by {@link
21418 * hostname}.
21419 *
21420 * @param string $hostname The host name.
21421 * @return string
21422 * @since PHP 4, PHP 5
21423 **/
21424function gethostbyname($hostname){}
21425
21426/**
21427 * Returns a list of IPv4 addresses to which the Internet host specified
21428 * by {@link hostname} resolves.
21429 *
21430 * @param string $hostname The host name.
21431 * @return array
21432 * @since PHP 4, PHP 5
21433 **/
21434function gethostbynamel($hostname){}
21435
21436/**
21437 * {@link gethostname} gets the standard host name for the local machine.
21438 *
21439 * @return string
21440 * @since PHP >= 5.3.0
21441 **/
21442function gethostname(){}
21443
21444/**
21445 * The {@link getimagesize} function will determine the size of any given
21446 * image file and return the dimensions along with the file type and a
21447 * height/width text string to be used inside a normal HTML IMG tag and
21448 * the correspondant HTTP content type.
21449 *
21450 * {@link getimagesize} can also return some more information in {@link
21451 * imageinfo} parameter.
21452 *
21453 * @param string $filename This parameter specifies the file you wish
21454 *   to retrieve information about. It can reference a local file or
21455 *   (configuration permitting) a remote file using one of the supported
21456 *   streams.
21457 * @param array $imageinfo This optional parameter allows you to
21458 *   extract some extended information from the image file. Currently,
21459 *   this will return the different JPG APP markers as an associative
21460 *   array. Some programs use these APP markers to embed text information
21461 *   in images. A very common one is to embed IPTC information in the
21462 *   APP13 marker. You can use the {@link iptcparse} function to parse
21463 *   the binary APP13 marker into something readable.
21464 * @return array
21465 * @since PHP 4, PHP 5
21466 **/
21467function getimagesize($filename, &$imageinfo){}
21468
21469/**
21470 * Gets the time of the last modification of the current page.
21471 *
21472 * If you're interested in getting the last modification time of a
21473 * different file, consider using {@link filemtime}.
21474 *
21475 * @return int
21476 * @since PHP 4, PHP 5
21477 **/
21478function getlastmod(){}
21479
21480/**
21481 * Searches DNS for MX records corresponding to {@link hostname}.
21482 *
21483 * @param string $hostname The Internet host name.
21484 * @param array $mxhosts A list of the MX records found is placed into
21485 *   the array {@link mxhosts}.
21486 * @param array $weight If the {@link weight} array is given, it will
21487 *   be filled with the weight information gathered.
21488 * @return bool
21489 * @since PHP 4, PHP 5
21490 **/
21491function getmxrr($hostname, &$mxhosts, &$weight){}
21492
21493/**
21494 * @return int
21495 * @since PHP 4 >= 4.1.0, PHP 5
21496 **/
21497function getmygid(){}
21498
21499/**
21500 * Gets the inode of the current script.
21501 *
21502 * @return int
21503 * @since PHP 4, PHP 5
21504 **/
21505function getmyinode(){}
21506
21507/**
21508 * Gets the current PHP process ID.
21509 *
21510 * @return int
21511 * @since PHP 4, PHP 5
21512 **/
21513function getmypid(){}
21514
21515/**
21516 * @return int
21517 * @since PHP 4, PHP 5
21518 **/
21519function getmyuid(){}
21520
21521/**
21522 * Parses options passed to the script.
21523 *
21524 * @param string $options
21525 * @param array $longopts
21526 * @return array
21527 * @since PHP 4 >= 4.3.0, PHP 5
21528 **/
21529function getopt($options, $longopts){}
21530
21531/**
21532 * {@link getprotobyname} returns the protocol number associated with the
21533 * protocol {@link name} as per /etc/protocols.
21534 *
21535 * @param string $name The protocol name.
21536 * @return int
21537 * @since PHP 4, PHP 5
21538 **/
21539function getprotobyname($name){}
21540
21541/**
21542 * {@link getprotobynumber} returns the protocol name associated with
21543 * protocol {@link number} as per /etc/protocols.
21544 *
21545 * @param int $number The protocol number.
21546 * @return string
21547 * @since PHP 4, PHP 5
21548 **/
21549function getprotobynumber($number){}
21550
21551/**
21552 * @return int
21553 * @since PHP 4, PHP 5
21554 **/
21555function getrandmax(){}
21556
21557/**
21558 * This is an interface to getrusage(2). It gets data returned from the
21559 * system call.
21560 *
21561 * @param int $who If {@link who} is 1, getrusage will be called with
21562 *   RUSAGE_CHILDREN.
21563 * @return array
21564 * @since PHP 4, PHP 5
21565 **/
21566function getrusage($who){}
21567
21568/**
21569 * {@link getservbyname} returns the Internet port which corresponds to
21570 * {@link service} for the specified {@link protocol} as per
21571 * /etc/services.
21572 *
21573 * @param string $service The Internet service name, as a string.
21574 * @param string $protocol {@link protocol} is either "tcp" or "udp"
21575 *   (in lowercase).
21576 * @return int
21577 * @since PHP 4, PHP 5
21578 **/
21579function getservbyname($service, $protocol){}
21580
21581/**
21582 * {@link getservbyport} returns the Internet service associated with
21583 * {@link port} for the specified {@link protocol} as per /etc/services.
21584 *
21585 * @param int $port The port number.
21586 * @param string $protocol {@link protocol} is either "tcp" or "udp"
21587 *   (in lowercase).
21588 * @return string
21589 * @since PHP 4, PHP 5
21590 **/
21591function getservbyport($port, $protocol){}
21592
21593/**
21594 * Looks up a message in the current domain.
21595 *
21596 * @param string $message The message being translated.
21597 * @return string
21598 * @since PHP 4, PHP 5
21599 **/
21600function gettext($message){}
21601
21602/**
21603 * This is an interface to gettimeofday(2). It returns an associative
21604 * array containing the data returned from the system call.
21605 *
21606 * @param bool $return_float When set to , a float instead of an array
21607 *   is returned.
21608 * @return mixed
21609 * @since PHP 4, PHP 5
21610 **/
21611function gettimeofday($return_float){}
21612
21613/**
21614 * Returns the type of the PHP variable {@link var}.
21615 *
21616 * @param mixed $var The variable being type checked.
21617 * @return string
21618 * @since PHP 4, PHP 5
21619 **/
21620function gettype($var){}
21621
21622/**
21623 * Attempts to determine the capabilities of the user's browser, by
21624 * looking up the browser's information in the browscap.ini file.
21625 *
21626 * @param string $user_agent The User Agent to be analyzed. By default,
21627 *   the value of HTTP User-Agent header is used; however, you can alter
21628 *   this (i.e., look up another browser's info) by passing this
21629 *   parameter. You can bypass this parameter with a value.
21630 * @param bool $return_array If set to , this function will return an
21631 *   array instead of an object.
21632 * @return mixed
21633 * @since PHP 4, PHP 5
21634 **/
21635function get_browser($user_agent, $return_array){}
21636
21637/**
21638 * Gets the name of the class the static method is called in.
21639 *
21640 * @return string
21641 * @since PHP 5 >= 5.3.0
21642 **/
21643function get_called_class(){}
21644
21645/**
21646 * Gets the value of a PHP configuration {@link option}.
21647 *
21648 * This function will not return configuration information set when the
21649 * PHP was compiled, or read from an Apache configuration file.
21650 *
21651 * To check whether the system is using a configuration file, try
21652 * retrieving the value of the cfg_file_path configuration setting. If
21653 * this is available, a configuration file is being used.
21654 *
21655 * @param string $option The configuration option name.
21656 * @return string
21657 * @since PHP 4, PHP 5
21658 **/
21659function get_cfg_var($option){}
21660
21661/**
21662 * Gets the name of the class of the given {@link object}.
21663 *
21664 * @param object $object The tested object
21665 * @return string
21666 * @since PHP 4, PHP 5
21667 **/
21668function get_class($object){}
21669
21670/**
21671 * Gets the class methods names.
21672 *
21673 * @param mixed $class_name The class name or an object instance
21674 * @return array
21675 * @since PHP 4, PHP 5
21676 **/
21677function get_class_methods($class_name){}
21678
21679/**
21680 * Get the default properties of the given class.
21681 *
21682 * @param string $class_name The class name
21683 * @return array
21684 * @since PHP 4, PHP 5
21685 **/
21686function get_class_vars($class_name){}
21687
21688/**
21689 * @return string
21690 * @since PHP 4, PHP 5
21691 **/
21692function get_current_user(){}
21693
21694/**
21695 * Gets the declared classes.
21696 *
21697 * @return array
21698 * @since PHP 4, PHP 5
21699 **/
21700function get_declared_classes(){}
21701
21702/**
21703 * Gets the declared interfaces.
21704 *
21705 * @return array
21706 * @since PHP 5
21707 **/
21708function get_declared_interfaces(){}
21709
21710/**
21711 * Returns the names and values of all the constants currently defined.
21712 * This includes those created by extensions as well as those created
21713 * with the {@link define} function.
21714 *
21715 * @param bool $categorize Causing this function to return a
21716 *   multi-dimensional array with categories in the keys of the first
21717 *   dimension and constants and their values in the second dimension.
21718 *
21719 *   <?php define("MY_CONSTANT", 1);
21720 *   print_r(get_defined_constants(true)); ?>
21721 *
21722 *   Array ( [Core] => Array ( [E_ERROR] => 1 [E_WARNING] => 2 [E_PARSE]
21723 *   => 4 [E_NOTICE] => 8 [E_CORE_ERROR] => 16 [E_CORE_WARNING] => 32
21724 *   [E_COMPILE_ERROR] => 64 [E_COMPILE_WARNING] => 128 [E_USER_ERROR] =>
21725 *   256 [E_USER_WARNING] => 512 [E_USER_NOTICE] => 1024 [E_ALL] => 2047
21726 *   [TRUE] => 1 )
21727 *
21728 *   [pcre] => Array ( [PREG_PATTERN_ORDER] => 1 [PREG_SET_ORDER] => 2
21729 *   [PREG_OFFSET_CAPTURE] => 256 [PREG_SPLIT_NO_EMPTY] => 1
21730 *   [PREG_SPLIT_DELIM_CAPTURE] => 2 [PREG_SPLIT_OFFSET_CAPTURE] => 4
21731 *   [PREG_GREP_INVERT] => 1 )
21732 *
21733 *   [user] => Array ( [MY_CONSTANT] => 1 )
21734 *
21735 *   )
21736 * @return array
21737 * @since PHP 4 >= 4.1.0, PHP 5
21738 **/
21739function get_defined_constants($categorize){}
21740
21741/**
21742 * Gets an array of all defined functions.
21743 *
21744 * @return array
21745 * @since PHP 4 >= 4.0.4, PHP 5
21746 **/
21747function get_defined_functions(){}
21748
21749/**
21750 * This function returns a multidimensional array containing a list of
21751 * all defined variables, be them environment, server or user-defined
21752 * variables, within the scope that {@link get_defined_vars} is called.
21753 *
21754 * @return array
21755 * @since PHP 4 >= 4.0.4, PHP 5
21756 **/
21757function get_defined_vars(){}
21758
21759/**
21760 * This function returns the names of all the functions defined in the
21761 * module indicated by {@link module_name}.
21762 *
21763 * @param string $module_name The module name.
21764 * @return array
21765 * @since PHP 4, PHP 5
21766 **/
21767function get_extension_funcs($module_name){}
21768
21769/**
21770 * {@link get_headers} returns an array with the headers sent by the
21771 * server in response to a HTTP request.
21772 *
21773 * @param string $url The target URL.
21774 * @param int $format If the optional {@link format} parameter is set
21775 *   to non-zero, {@link get_headers} parses the response and sets the
21776 *   array's keys.
21777 * @return array
21778 * @since PHP 5
21779 **/
21780function get_headers($url, $format){}
21781
21782/**
21783 * {@link get_html_translation_table} will return the translation table
21784 * that is used internally for {@link htmlspecialchars} and {@link
21785 * htmlentities} with the default charset.
21786 *
21787 * @param int $table There are two new constants (HTML_ENTITIES,
21788 *   HTML_SPECIALCHARS) that allow you to specify the table you want.
21789 * @param int $quote_style Like the {@link htmlspecialchars} and {@link
21790 *   htmlentities} functions you can optionally specify the {@link
21791 *   quote_style} you are working with. See the description of these
21792 *   modes in {@link htmlspecialchars}.
21793 * @return array
21794 * @since PHP 4, PHP 5
21795 **/
21796function get_html_translation_table($table, $quote_style){}
21797
21798/**
21799 * Gets the names of all files that have been included using {@link
21800 * include}, {@link include_once}, {@link require} or {@link
21801 * require_once}.
21802 *
21803 * @return array
21804 * @since PHP 4, PHP 5
21805 **/
21806function get_included_files(){}
21807
21808/**
21809 * @return string
21810 * @since PHP 4 >= 4.3.0, PHP 5
21811 **/
21812function get_include_path(){}
21813
21814/**
21815 * This function returns the names of all the modules compiled and loaded
21816 * in the PHP interpreter.
21817 *
21818 * @param bool $zend_extensions Return zend_extensions or not, defaults
21819 *   to (do not list zend_extensions).
21820 * @return array
21821 * @since PHP 4, PHP 5
21822 **/
21823function get_loaded_extensions($zend_extensions){}
21824
21825/**
21826 * Returns the current configuration setting of magic_quotes_gpc
21827 *
21828 * Keep in mind that attempting to set magic_quotes_gpc at runtime will
21829 * not work.
21830 *
21831 * For more information about magic_quotes, see this security section.
21832 *
21833 * @return int
21834 * @since PHP 4, PHP 5
21835 **/
21836function get_magic_quotes_gpc(){}
21837
21838/**
21839 * @return int
21840 * @since PHP 4, PHP 5
21841 **/
21842function get_magic_quotes_runtime(){}
21843
21844/**
21845 * Opens {@link filename} and parses it line by line for <meta> tags in
21846 * the file. The parsing stops at </head>.
21847 *
21848 * @param string $filename The path to the HTML file, as a string. This
21849 *   can be a local file or an URL.
21850 *
21851 *   What {@link get_meta_tags} parses
21852 *
21853 *   <meta name="author" content="name"> <meta name="keywords"
21854 *   content="php documentation"> <meta name="DESCRIPTION" content="a php
21855 *   manual"> <meta name="geo.position" content="49.33;-86.59"> </head>
21856 *   <!-- parsing stops here -->
21857 *
21858 *   (pay attention to line endings - PHP uses a native function to parse
21859 *   the input, so a Mac file won't work on Unix).
21860 * @param bool $use_include_path Setting {@link use_include_path} to
21861 *   will result in PHP trying to open the file along the standard
21862 *   include path as per the include_path directive. This is used for
21863 *   local files, not URLs.
21864 * @return array
21865 * @since PHP 4, PHP 5
21866 **/
21867function get_meta_tags($filename, $use_include_path){}
21868
21869/**
21870 * Gets the accessible non-static properties of the given {@link object}
21871 * according to scope.
21872 *
21873 * @param object $object An object instance.
21874 * @return array
21875 * @since PHP 4, PHP 5
21876 **/
21877function get_object_vars($object){}
21878
21879/**
21880 * Retrieves the parent class name for object or class.
21881 *
21882 * @param mixed $object The tested object or class name
21883 * @return string
21884 * @since PHP 4, PHP 5
21885 **/
21886function get_parent_class($object){}
21887
21888/**
21889 * Gets the names of all files that have been included using {@link
21890 * include}, {@link include_once}, {@link require} or {@link
21891 * require_once}.
21892 *
21893 * @return array
21894 * @since PHP 4, PHP 5
21895 **/
21896function get_required_files(){}
21897
21898/**
21899 * This function gets the type of the given resource.
21900 *
21901 * @param resource $handle The evaluated resource handle.
21902 * @return string
21903 * @since PHP 4 >= 4.0.2, PHP 5
21904 **/
21905function get_resource_type($handle){}
21906
21907/**
21908 * The {@link glob} function searches for all the pathnames matching
21909 * {@link pattern} according to the rules used by the libc glob()
21910 * function, which is similar to the rules used by common shells.
21911 *
21912 * @param string $pattern The pattern. No tilde expansion or parameter
21913 *   substitution is done.
21914 * @param int $flags Valid flags: GLOB_MARK - Adds a slash to each
21915 *   directory returned GLOB_NOSORT - Return files as they appear in the
21916 *   directory (no sorting) GLOB_NOCHECK - Return the search pattern if
21917 *   no files matching it were found GLOB_NOESCAPE - Backslashes do not
21918 *   quote metacharacters GLOB_BRACE - Expands {a,b,c} to match 'a', 'b',
21919 *   or 'c' GLOB_ONLYDIR - Return only directory entries which match the
21920 *   pattern GLOB_ERR - Stop on read errors (like unreadable
21921 *   directories), by default errors are ignored.
21922 * @return array
21923 * @since PHP 4 >= 4.3.0, PHP 5
21924 **/
21925function glob($pattern, $flags){}
21926
21927/**
21928 * Identical to the {@link date} function except that the time returned
21929 * is Greenwich Mean Time (GMT).
21930 *
21931 * @param string $format The format of the outputted date string. See
21932 *   the formatting options for the {@link date} function.
21933 * @param int $timestamp
21934 * @return string
21935 * @since PHP 4, PHP 5
21936 **/
21937function gmdate($format, $timestamp){}
21938
21939/**
21940 * Identical to {@link mktime} except the passed parameters represents a
21941 * GMT date. {@link gmmktime} internally uses {@link mktime} so only
21942 * times valid in derived local time can be used.
21943 *
21944 * Like {@link mktime}, arguments may be left out in order from right to
21945 * left, with any omitted arguments being set to the current
21946 * corresponding GMT value.
21947 *
21948 * @param int $hour The hour
21949 * @param int $minute The minute
21950 * @param int $second The second
21951 * @param int $month The month
21952 * @param int $day The day
21953 * @param int $year The year
21954 * @param int $is_dst Parameters always represent a GMT date so {@link
21955 *   is_dst} doesn't influence the result.
21956 * @return int
21957 * @since PHP 4, PHP 5
21958 **/
21959function gmmktime($hour, $minute, $second, $month, $day, $year, $is_dst){}
21960
21961/**
21962 * Get the absolute value of a number.
21963 *
21964 * @param resource $a
21965 * @return resource
21966 * @since PHP 4 >= 4.0.4, PHP 5
21967 **/
21968function gmp_abs($a){}
21969
21970/**
21971 * Add two numbers.
21972 *
21973 * @param resource $a A number that will be added.
21974 * @param resource $b A number that will be added.
21975 * @return resource
21976 * @since PHP 4 >= 4.0.4, PHP 5
21977 **/
21978function gmp_add($a, $b){}
21979
21980/**
21981 * Calculates bitwise AND of two GMP numbers.
21982 *
21983 * @param resource $a
21984 * @param resource $b
21985 * @return resource
21986 * @since PHP 4 >= 4.0.4, PHP 5
21987 **/
21988function gmp_and($a, $b){}
21989
21990/**
21991 * Clears (sets to 0) bit {@link index} in {@link a}. The index starts at
21992 * 0.
21993 *
21994 * @param resource $a
21995 * @param int $index
21996 * @return void
21997 * @since PHP 4 >= 4.0.4, PHP 5
21998 **/
21999function gmp_clrbit($a, $index){}
22000
22001/**
22002 * Compares two numbers.
22003 *
22004 * @param resource $a
22005 * @param resource $b
22006 * @return int
22007 * @since PHP 4 >= 4.0.4, PHP 5
22008 **/
22009function gmp_cmp($a, $b){}
22010
22011/**
22012 * Returns the one's complement of {@link a}.
22013 *
22014 * @param resource $a
22015 * @return resource
22016 * @since PHP 4 >= 4.0.4, PHP 5
22017 **/
22018function gmp_com($a){}
22019
22020/**
22021 * Divides {@link a} by {@link b} and returns the integer result.
22022 *
22023 * @param resource $a The number being divided.
22024 * @param resource $b The number that {@link a} is being divided by.
22025 * @param int $round The result rounding is defined by the {@link
22026 *   round}, which can have the following values: GMP_ROUND_ZERO: The
22027 *   result is truncated towards 0. GMP_ROUND_PLUSINF: The result is
22028 *   rounded towards +infinity. GMP_ROUND_MINUSINF: The result is rounded
22029 *   towards -infinity.
22030 * @return resource
22031 * @since PHP 4 >= 4.0.4, PHP 5
22032 **/
22033function gmp_div($a, $b, $round){}
22034
22035/**
22036 * Divides {@link n} by {@link d}, using fast "exact division" algorithm.
22037 * This function produces correct results only when it is known in
22038 * advance that {@link d} divides {@link n}.
22039 *
22040 * @param resource $n The number being divided.
22041 * @param resource $d The number that {@link a} is being divided by.
22042 * @return resource
22043 * @since PHP 4 >= 4.0.4, PHP 5
22044 **/
22045function gmp_divexact($n, $d){}
22046
22047/**
22048 * Divides {@link a} by {@link b} and returns the integer result.
22049 *
22050 * @param resource $a The number being divided.
22051 * @param resource $b The number that {@link a} is being divided by.
22052 * @param int $round The result rounding is defined by the {@link
22053 *   round}, which can have the following values: GMP_ROUND_ZERO: The
22054 *   result is truncated towards 0. GMP_ROUND_PLUSINF: The result is
22055 *   rounded towards +infinity. GMP_ROUND_MINUSINF: The result is rounded
22056 *   towards -infinity.
22057 * @return resource
22058 * @since PHP 4 >= 4.0.4, PHP 5
22059 **/
22060function gmp_div_q($a, $b, $round){}
22061
22062/**
22063 * The function divides {@link n} by {@link d}.
22064 *
22065 * @param resource $n The number being divided.
22066 * @param resource $d The number that {@link n} is being divided by.
22067 * @param int $round See the {@link gmp_div_q} function for description
22068 *   of the {@link round} argument.
22069 * @return array
22070 * @since PHP 4 >= 4.0.4, PHP 5
22071 **/
22072function gmp_div_qr($n, $d, $round){}
22073
22074/**
22075 * Calculates remainder of the integer division of {@link n} by {@link
22076 * d}. The remainder has the sign of the {@link n} argument, if not zero.
22077 *
22078 * @param resource $n The number being divided.
22079 * @param resource $d The number that {@link n} is being divided by.
22080 * @param int $round See the {@link gmp_div_q} function for description
22081 *   of the {@link round} argument.
22082 * @return resource
22083 * @since PHP 4 >= 4.0.4, PHP 5
22084 **/
22085function gmp_div_r($n, $d, $round){}
22086
22087/**
22088 * Calculates factorial (a!) of {@link a}.
22089 *
22090 * @param mixed $a The factorial number.
22091 * @return resource
22092 * @since PHP 4 >= 4.0.4, PHP 5
22093 **/
22094function gmp_fact($a){}
22095
22096/**
22097 * Calculate greatest common divisor of {@link a} and {@link b}. The
22098 * result is always positive even if either of, or both, input operands
22099 * are negative.
22100 *
22101 * @param resource $a
22102 * @param resource $b
22103 * @return resource
22104 * @since PHP 4 >= 4.0.4, PHP 5
22105 **/
22106function gmp_gcd($a, $b){}
22107
22108/**
22109 * Calculates g, s, and t, such that a*s + b*t = g = gcd(a,b), where gcd
22110 * is the greatest common divisor. Returns an array with respective
22111 * elements g, s and t.
22112 *
22113 * This function can be used to solve linear Diophantine equations in two
22114 * variables. These are equations that allow only integer solutions and
22115 * have the form: a*x + b*y = c. For more information, go to the
22116 * "Diophantine Equation" page at MathWorld
22117 *
22118 * @param resource $a
22119 * @param resource $b
22120 * @return array
22121 * @since PHP 4 >= 4.0.4, PHP 5
22122 **/
22123function gmp_gcdext($a, $b){}
22124
22125/**
22126 * Returns the hamming distance between {@link a} and {@link b}. Both
22127 * operands should be non-negative.
22128 *
22129 * @param resource $a It should be positive.
22130 * @param resource $b It should be positive.
22131 * @return int
22132 * @since PHP 4 >= 4.0.4, PHP 5
22133 **/
22134function gmp_hamdist($a, $b){}
22135
22136/**
22137 * Creates a GMP number from an integer or string.
22138 *
22139 * @param mixed $number An integer or a string. The string
22140 *   representation can be decimal, hexadecimal or octal.
22141 * @param int $base The base. The base may vary from 2 to 36. If base
22142 *   is 0 (default value), the actual base is determined from the leading
22143 *   characters: if the first two characters are 0x or 0X, hexadecimal is
22144 *   assumed, otherwise if the first character is "0", octal is assumed,
22145 *   otherwise decimal is assumed.
22146 * @return resource
22147 * @since PHP 4 >= 4.0.4, PHP 5
22148 **/
22149function gmp_init($number, $base){}
22150
22151/**
22152 * This function allows to convert GMP number to integer.
22153 *
22154 * @param resource $gmpnumber A GMP number.
22155 * @return int
22156 * @since PHP 4 >= 4.0.4, PHP 5
22157 **/
22158function gmp_intval($gmpnumber){}
22159
22160/**
22161 * Computes the inverse of {@link a} modulo {@link b}.
22162 *
22163 * @param resource $a
22164 * @param resource $b
22165 * @return resource
22166 * @since PHP 4 >= 4.0.4, PHP 5
22167 **/
22168function gmp_invert($a, $b){}
22169
22170/**
22171 * Computes Jacobi symbol of {@link a} and {@link p}. {@link p} should be
22172 * odd and must be positive.
22173 *
22174 * @param resource $a
22175 * @param resource $p Should be odd and must be positive.
22176 * @return int
22177 * @since PHP 4 >= 4.0.4, PHP 5
22178 **/
22179function gmp_jacobi($a, $p){}
22180
22181/**
22182 * Compute the Legendre symbol of {@link a} and {@link p}. {@link p}
22183 * should be odd and must be positive.
22184 *
22185 * @param resource $a
22186 * @param resource $p Should be odd and must be positive.
22187 * @return int
22188 * @since PHP 4 >= 4.0.4, PHP 5
22189 **/
22190function gmp_legendre($a, $p){}
22191
22192/**
22193 * Calculates {@link n} modulo {@link d}. The result is always
22194 * non-negative, the sign of {@link d} is ignored.
22195 *
22196 * @param resource $n
22197 * @param resource $d The modulo that is being evaluated.
22198 * @return resource
22199 * @since PHP 4 >= 4.0.4, PHP 5
22200 **/
22201function gmp_mod($n, $d){}
22202
22203/**
22204 * Multiplies {@link a} by {@link b} and returns the result.
22205 *
22206 * @param resource $a A number that will be multiplied by {@link b}.
22207 * @param resource $b A number that will be multiplied by {@link a}.
22208 * @return resource
22209 * @since PHP 4 >= 4.0.4, PHP 5
22210 **/
22211function gmp_mul($a, $b){}
22212
22213/**
22214 * Returns the negative value of a number.
22215 *
22216 * @param resource $a
22217 * @return resource
22218 * @since PHP 4 >= 4.0.4, PHP 5
22219 **/
22220function gmp_neg($a){}
22221
22222/**
22223 * Find next prime number
22224 *
22225 * @param int $a
22226 * @return resource
22227 * @since PHP 5 >= 5.2.0
22228 **/
22229function gmp_nextprime($a){}
22230
22231/**
22232 * Calculates bitwise inclusive OR of two GMP numbers.
22233 *
22234 * @param resource $a
22235 * @param resource $b
22236 * @return resource
22237 * @since PHP 4 >= 4.0.4, PHP 5
22238 **/
22239function gmp_or($a, $b){}
22240
22241/**
22242 * Check if a number is a perfect square.
22243 *
22244 * @param resource $a The number being checked as a perfect square.
22245 * @return bool
22246 * @since PHP 4 >= 4.0.4, PHP 5
22247 **/
22248function gmp_perfect_square($a){}
22249
22250/**
22251 * Get the population count.
22252 *
22253 * @param resource $a
22254 * @return int
22255 * @since PHP 4 >= 4.0.4, PHP 5
22256 **/
22257function gmp_popcount($a){}
22258
22259/**
22260 * Raise {@link base} into power {@link exp}.
22261 *
22262 * @param resource $base The base number.
22263 * @param int $exp The positive power to raise the {@link base}.
22264 * @return resource
22265 * @since PHP 4 >= 4.0.4, PHP 5
22266 **/
22267function gmp_pow($base, $exp){}
22268
22269/**
22270 * Calculate ({@link base} raised into power {@link exp}) modulo {@link
22271 * mod}. If {@link exp} is negative, result is undefined.
22272 *
22273 * @param resource $base The base number.
22274 * @param resource $exp The positive power to raise the {@link base}.
22275 * @param resource $mod The modulo.
22276 * @return resource
22277 * @since PHP 4 >= 4.0.4, PHP 5
22278 **/
22279function gmp_powm($base, $exp, $mod){}
22280
22281/**
22282 * The function uses Miller-Rabin's probabilistic test to check if a
22283 * number is a prime.
22284 *
22285 * @param resource $a The number being checked as a prime.
22286 * @param int $reps Reasonable values of {@link reps} vary from 5 to 10
22287 *   (default being 10); a higher value lowers the probability for a
22288 *   non-prime to pass as a "probable" prime.
22289 * @return int
22290 * @since PHP 4 >= 4.0.4, PHP 5
22291 **/
22292function gmp_prob_prime($a, $reps){}
22293
22294/**
22295 * Generate a random number. The number will be between zero and the
22296 * number of bits per limb multiplied by {@link limiter}. If {@link
22297 * limiter} is negative, negative numbers are generated.
22298 *
22299 * A limb is an internal GMP mechanism. The number of bits in a limb is
22300 * not static, and can vary from system to system. Generally, the number
22301 * of bits in a limb is either 16 or 32, but this is not guaranteed.
22302 *
22303 * @param int $limiter The limiter.
22304 * @return resource
22305 * @since PHP 4 >= 4.0.4, PHP 5
22306 **/
22307function gmp_random($limiter){}
22308
22309/**
22310 * Scans {@link a}, starting with bit {@link start}, towards more
22311 * significant bits, until the first clear bit is found.
22312 *
22313 * @param resource $a The number to scan.
22314 * @param int $start The starting bit.
22315 * @return int
22316 * @since PHP 4 >= 4.0.4, PHP 5
22317 **/
22318function gmp_scan0($a, $start){}
22319
22320/**
22321 * Scans {@link a}, starting with bit {@link start}, towards more
22322 * significant bits, until the first set bit is found.
22323 *
22324 * @param resource $a The number to scan.
22325 * @param int $start The starting bit.
22326 * @return int
22327 * @since PHP 4 >= 4.0.4, PHP 5
22328 **/
22329function gmp_scan1($a, $start){}
22330
22331/**
22332 * Sets bit {@link index} in {@link a}.
22333 *
22334 * @param resource $a The number being set to.
22335 * @param int $index The set bit.
22336 * @param bool $set_clear Defines if the bit is set to 0 or 1. By
22337 *   default the bit is set to 1. Index starts at 0.
22338 * @return void
22339 * @since PHP 4 >= 4.0.4, PHP 5
22340 **/
22341function gmp_setbit($a, $index, $set_clear){}
22342
22343/**
22344 * Checks the sign of a number.
22345 *
22346 * @param resource $a
22347 * @return int
22348 * @since PHP 4 >= 4.0.4, PHP 5
22349 **/
22350function gmp_sign($a){}
22351
22352/**
22353 * Calculates square root of {@link a}.
22354 *
22355 * @param resource $a
22356 * @return resource
22357 * @since PHP 4 >= 4.0.4, PHP 5
22358 **/
22359function gmp_sqrt($a){}
22360
22361/**
22362 * Calculate the square root of a number, with remainder.
22363 *
22364 * @param resource $a The number being square rooted.
22365 * @return array
22366 * @since PHP 4 >= 4.0.4, PHP 5
22367 **/
22368function gmp_sqrtrem($a){}
22369
22370/**
22371 * Convert GMP number to string representation in base {@link base}. The
22372 * default base is 10.
22373 *
22374 * @param resource $gmpnumber The GMP number that will be converted to
22375 *   a string.
22376 * @param int $base The base of the returned number. The default base
22377 *   is 10. Allowed values for the base are from 2 to 62 and -2 to -36.
22378 * @return string
22379 * @since PHP 4 >= 4.0.4, PHP 5
22380 **/
22381function gmp_strval($gmpnumber, $base){}
22382
22383/**
22384 * Subtracts {@link b} from {@link a} and returns the result.
22385 *
22386 * @param resource $a The number being subtracted from.
22387 * @param resource $b The number subtracted from {@link a}.
22388 * @return resource
22389 * @since PHP 4 >= 4.0.4, PHP 5
22390 **/
22391function gmp_sub($a, $b){}
22392
22393/**
22394 * Tests if the specified bit is set.
22395 *
22396 * @param resource $a
22397 * @param int $index The bit to test
22398 * @return bool
22399 * @since PHP 5 >= 5.3.0
22400 **/
22401function gmp_testbit($a, $index){}
22402
22403/**
22404 * Calculates bitwise exclusive OR (XOR) of two GMP numbers.
22405 *
22406 * @param resource $a
22407 * @param resource $b
22408 * @return resource
22409 * @since PHP 4 >= 4.0.4, PHP 5
22410 **/
22411function gmp_xor($a, $b){}
22412
22413/**
22414 * Behaves the same as {@link strftime} except that the time returned is
22415 * Greenwich Mean Time (GMT). For example, when run in Eastern Standard
22416 * Time (GMT -0500), the first line below prints "Dec 31 1998 20:00:00",
22417 * while the second prints "Jan 01 1999 01:00:00".
22418 *
22419 * @param string $format See description in {@link strftime}.
22420 * @param int $timestamp
22421 * @return string
22422 * @since PHP 4, PHP 5
22423 **/
22424function gmstrftime($format, $timestamp){}
22425
22426/**
22427 * @param resource $identifier
22428 * @param string $fingerprint
22429 * @param string $passphrase The pass phrase.
22430 * @return bool
22431 * @since PECL gnupg >= 0.5
22432 **/
22433function gnupg_adddecryptkey($identifier, $fingerprint, $passphrase){}
22434
22435/**
22436 * @param resource $identifier
22437 * @param string $fingerprint
22438 * @return bool
22439 * @since PECL gnupg >= 0.5
22440 **/
22441function gnupg_addencryptkey($identifier, $fingerprint){}
22442
22443/**
22444 * @param resource $identifier
22445 * @param string $fingerprint
22446 * @param string $passphrase The pass phrase.
22447 * @return bool
22448 * @since PECL gnupg >= 0.5
22449 **/
22450function gnupg_addsignkey($identifier, $fingerprint, $passphrase){}
22451
22452/**
22453 * @param resource $identifier
22454 * @return bool
22455 * @since PECL gnupg >= 0.5
22456 **/
22457function gnupg_cleardecryptkeys($identifier){}
22458
22459/**
22460 * @param resource $identifier
22461 * @return bool
22462 * @since PECL gnupg >= 0.5
22463 **/
22464function gnupg_clearencryptkeys($identifier){}
22465
22466/**
22467 * @param resource $identifier
22468 * @return bool
22469 * @since PECL gnupg >= 0.5
22470 **/
22471function gnupg_clearsignkeys($identifier){}
22472
22473/**
22474 * Decrypts the given text with the keys, which were set with
22475 * gnupg_adddecryptkey before.
22476 *
22477 * @param resource $identifier
22478 * @param string $text The text being decrypted.
22479 * @return string
22480 * @since PECL gnupg >= 0.1
22481 **/
22482function gnupg_decrypt($identifier, $text){}
22483
22484/**
22485 * Decrypts and verifies a given text and returns information about the
22486 * signature.
22487 *
22488 * @param resource $identifier
22489 * @param string $text The text being decrypted.
22490 * @param string $plaintext The parameter {@link plaintext} gets filled
22491 *   with the decrypted text.
22492 * @return array
22493 * @since PECL gnupg >= 0.2
22494 **/
22495function gnupg_decryptverify($identifier, $text, &$plaintext){}
22496
22497/**
22498 * Encrypts the given {@link plaintext} with the keys, which were set
22499 * with gnupg_addencryptkey before and returns the encrypted text.
22500 *
22501 * @param resource $identifier
22502 * @param string $plaintext The text being encrypted.
22503 * @return string
22504 * @since PECL gnupg >= 0.1
22505 **/
22506function gnupg_encrypt($identifier, $plaintext){}
22507
22508/**
22509 * Encrypts and signs the given {@link plaintext} with the keys, which
22510 * were set with gnupg_addsignkey and gnupg_addencryptkey before and
22511 * returns the encrypted and signed text.
22512 *
22513 * @param resource $identifier
22514 * @param string $plaintext The text being encrypted.
22515 * @return string
22516 * @since PECL gnupg >= 0.2
22517 **/
22518function gnupg_encryptsign($identifier, $plaintext){}
22519
22520/**
22521 * Exports the key {@link fingerprint}.
22522 *
22523 * @param resource $identifier
22524 * @param string $fingerprint
22525 * @return string
22526 * @since PECL gnupg >= 0.1
22527 **/
22528function gnupg_export($identifier, $fingerprint){}
22529
22530/**
22531 * @param resource $identifier
22532 * @return string
22533 * @since PECL gnupg >= 0.1
22534 **/
22535function gnupg_geterror($identifier){}
22536
22537/**
22538 * @param resource $identifier
22539 * @return int
22540 * @since PECL gnupg >= 0.1
22541 **/
22542function gnupg_getprotocol($identifier){}
22543
22544/**
22545 * Imports the key {@link keydata} and returns an array with information
22546 * about the importprocess.
22547 *
22548 * @param resource $identifier
22549 * @param string $keydata The data key that is being imported.
22550 * @return array
22551 * @since PECL gnupg >= 0.3
22552 **/
22553function gnupg_import($identifier, $keydata){}
22554
22555/**
22556 * @return resource
22557 * @since PECL gnupg >= 0.4
22558 **/
22559function gnupg_init(){}
22560
22561/**
22562 * @param resource $identifier
22563 * @param string $pattern The pattern being checked against the keys.
22564 * @return array
22565 * @since PECL gnupg >= 0.1
22566 **/
22567function gnupg_keyinfo($identifier, $pattern){}
22568
22569/**
22570 * Toggle the armored output.
22571 *
22572 * @param resource $identifier
22573 * @param int $armor Pass a non-zero integer-value to this function to
22574 *   enable armored-output (default). Pass 0 to disable armored output.
22575 * @return bool
22576 * @since PECL gnupg >= 0.1
22577 **/
22578function gnupg_setarmor($identifier, $armor){}
22579
22580/**
22581 * Sets the mode for error_reporting.
22582 *
22583 * @param resource $identifier
22584 * @param int $errormode The error mode. {@link errormode} takes a
22585 *   constant indicating what type of error_reporting should be used. The
22586 *   possible values are GNUPG_ERROR_WARNING, GNUPG_ERROR_EXCEPTION and
22587 *   GNUPG_ERROR_SILENT. By default GNUPG_ERROR_SILENT is used.
22588 * @return void
22589 * @since PECL gnupg >= 0.6
22590 **/
22591function gnupg_seterrormode($identifier, $errormode){}
22592
22593/**
22594 * Sets the mode for signing.
22595 *
22596 * @param resource $identifier
22597 * @param int $signmode The mode for signing. {@link signmode} takes a
22598 *   constant indicating what type of signature should be produced. The
22599 *   possible values are GNUPG_SIG_MODE_NORMAL, GNUPG_SIG_MODE_DETACH and
22600 *   GNUPG_SIG_MODE_CLEAR. By default GNUPG_SIG_MODE_CLEAR is used.
22601 * @return bool
22602 * @since PECL gnupg >= 0.1
22603 **/
22604function gnupg_setsignmode($identifier, $signmode){}
22605
22606/**
22607 * Signs the given {@link plaintext} with the keys, which were set with
22608 * gnupg_addsignkey before and returns the signed text or the signature,
22609 * depending on what was set with gnupg_setsignmode.
22610 *
22611 * @param resource $identifier
22612 * @param string $plaintext The plain text being signed.
22613 * @return string
22614 * @since PECL gnupg >= 0.1
22615 **/
22616function gnupg_sign($identifier, $plaintext){}
22617
22618/**
22619 * Verifies the given {@link signed_text} and returns information about
22620 * the signature.
22621 *
22622 * @param resource $identifier
22623 * @param string $signed_text The signed text.
22624 * @param string $signature The signature. To verify a clearsigned
22625 *   text, set signature to .
22626 * @param string $plaintext The plain text. If this optional parameter
22627 *   is passed, it is filled with the plain text.
22628 * @return array
22629 * @since PECL gnupg >= 0.1
22630 **/
22631function gnupg_verify($identifier, $signed_text, $signature, &$plaintext){}
22632
22633/**
22634 * {@link gopher_parsedir} parses a gopher formatted directory entry into
22635 * an associative array.
22636 *
22637 * While gopher returns text/plain documents for actual document
22638 * requests. A request to a directory (such as /) will return specially
22639 * encoded series of lines with each line being one directory entry or
22640 * information line.
22641 *
22642 * @param string $dirent The directory entry.
22643 * @return array
22644 * @since PECL net_gopher >= 0.1
22645 **/
22646function gopher_parsedir($dirent){}
22647
22648/**
22649 * Function to extract a sequence of default grapheme clusters from a
22650 * text buffer, which must be encoded in UTF-8.
22651 *
22652 * @param string $haystack String to search.
22653 * @param int $size Maximum number items - based on the $extract_type -
22654 *   to return.
22655 * @param int $extract_type Defines the type of units referred to by
22656 *   the $size parameter:
22657 *
22658 *   GRAPHEME_EXTR_COUNT (default) - $size is the number of default
22659 *   grapheme clusters to extract. GRAPHEME_EXTR_MAXBYTES - $size is the
22660 *   maximum number of bytes returned. GRAPHEME_EXTR_MAXCHARS - $size is
22661 *   the maximum number of UTF-8 characters returned.
22662 * @param int $start Starting position in $haystack in bytes - if
22663 *   given, it must be zero or a positive value that is less than or
22664 *   equal to the length of $haystack in bytes. If $start does not point
22665 *   to the first byte of a UTF-8 character, the start position is moved
22666 *   to the next character boundary.
22667 * @param int $next Reference to a value that will be set to the next
22668 *   starting position. When the call returns, this may point to the
22669 *   first byte position past the end of the string.
22670 * @return string
22671 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
22672 **/
22673function grapheme_extract($haystack, $size, $extract_type, $start, &$next){}
22674
22675/**
22676 * Find position (in grapheme units) of first occurrence of a
22677 * case-insensitive string
22678 *
22679 * @param string $haystack The string to look in. Must be valid UTF-8.
22680 * @param string $needle The string to look for. Must be valid UTF-8.
22681 * @param int $offset The optional $offset parameter allows you to
22682 *   specify where in haystack to start searching as an offset in
22683 *   grapheme units (not bytes or characters). The position returned is
22684 *   still relative to the beginning of haystack regardless of the value
22685 *   of $offset.
22686 * @return int
22687 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
22688 **/
22689function grapheme_stripos($haystack, $needle, $offset){}
22690
22691/**
22692 * Returns part of haystack string from the first occurrence of
22693 * case-insensitive needle to the end of haystack.
22694 *
22695 * @param string $haystack The input string. Must be valid UTF-8.
22696 * @param string $needle The string to look for. Must be valid UTF-8.
22697 * @param bool $before_needle If , grapheme_strstr() returns the part
22698 *   of the haystack before the first occurrence of the needle.
22699 * @return string
22700 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
22701 **/
22702function grapheme_stristr($haystack, $needle, $before_needle){}
22703
22704/**
22705 * Get string length in grapheme units (not bytes or characters)
22706 *
22707 * @param string $input The string being measured for length. It must
22708 *   be a valid UTF-8 string.
22709 * @return int
22710 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
22711 **/
22712function grapheme_strlen($input){}
22713
22714/**
22715 * Find position (in grapheme units) of first occurrence of a string
22716 *
22717 * @param string $haystack The string to look in. Must be valid UTF-8.
22718 * @param string $needle The string to look for. Must be valid UTF-8.
22719 * @param int $offset The optional $offset parameter allows you to
22720 *   specify where in $haystack to start searching as an offset in
22721 *   grapheme units (not bytes or characters). The position returned is
22722 *   still relative to the beginning of haystack regardless of the value
22723 *   of $offset.
22724 * @return int
22725 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
22726 **/
22727function grapheme_strpos($haystack, $needle, $offset){}
22728
22729/**
22730 * Find position (in grapheme units) of last occurrence of a
22731 * case-insensitive string
22732 *
22733 * @param string $haystack The string to look in. Must be valid UTF-8.
22734 * @param string $needle The string to look for. Must be valid UTF-8.
22735 * @param int $offset The optional $offset parameter allows you to
22736 *   specify where in $haystack to start searching as an offset in
22737 *   grapheme units (not bytes or characters). The position returned is
22738 *   still relative to the beginning of haystack regardless of the value
22739 *   of $offset.
22740 * @return int
22741 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
22742 **/
22743function grapheme_strripos($haystack, $needle, $offset){}
22744
22745/**
22746 * Find position (in grapheme units) of last occurrence of a string
22747 *
22748 * @param string $haystack The string to look in. Must be valid UTF-8.
22749 * @param string $needle The string to look for. Must be valid UTF-8.
22750 * @param int $offset The optional $offset parameter allows you to
22751 *   specify where in $haystack to start searching as an offset in
22752 *   grapheme units (not bytes or characters). The position returned is
22753 *   still relative to the beginning of haystack regardless of the value
22754 *   of $offset.
22755 * @return int
22756 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
22757 **/
22758function grapheme_strrpos($haystack, $needle, $offset){}
22759
22760/**
22761 * Returns part of haystack string from the first occurrence of needle to
22762 * the end of haystack.
22763 *
22764 * @param string $haystack The input string. Must be valid UTF-8.
22765 * @param string $needle The string to look for. Must be valid UTF-8.
22766 * @param bool $before_needle If , grapheme_strstr() returns the part
22767 *   of the haystack before the first occurrence of the needle.
22768 * @return string
22769 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
22770 **/
22771function grapheme_strstr($haystack, $needle, $before_needle){}
22772
22773/**
22774 * Return part of a string
22775 *
22776 * @param string $string The input string. Must be valid UTF-8.
22777 * @param int $start Start position in default grapheme units. If
22778 *   $start is non-negative, the returned string will start at the
22779 *   $start'th position in $string, counting from zero. If $start is
22780 *   negative, the returned string will start at the $start'th grapheme
22781 *   unit from the end of string.
22782 * @param int $length Length in grapheme units. If $length is given and
22783 *   is positive, the string returned will contain at most $length
22784 *   grapheme units beginning from $start (depending on the length of
22785 *   string). If $string is less than or equal to $start grapheme units
22786 *   long, FALSE will be returned. If $length is given and is negative,
22787 *   then that many grapheme units will be omitted from the end of string
22788 *   (after the start position has been calculated when a start is
22789 *   negative). If $start denotes a position beyond this truncation, an
22790 *   empty string will be returned.
22791 * @return int
22792 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
22793 **/
22794function grapheme_substr($string, $start, $length){}
22795
22796/**
22797 * Valid Range for Gregorian Calendar 4714 B.C. to 9999 A.D.
22798 *
22799 * Although this function can handle dates all the way back to 4714 B.C.,
22800 * such use may not be meaningful. The Gregorian calendar was not
22801 * instituted until October 15, 1582 (or October 5, 1582 in the Julian
22802 * calendar). Some countries did not accept it until much later. For
22803 * example, Britain converted in 1752, The USSR in 1918 and Greece in
22804 * 1923. Most European countries used the Julian calendar prior to the
22805 * Gregorian.
22806 *
22807 * @param int $month The month as a number from 1 (for January) to 12
22808 *   (for December)
22809 * @param int $day The day as a number from 1 to 31
22810 * @param int $year The year as a number between -4714 and 9999
22811 * @return int
22812 * @since PHP 4, PHP 5
22813 **/
22814function gregoriantojd($month, $day, $year){}
22815
22816/**
22817 * Get the IP address we advertise ourselves as using.
22818 *
22819 * @param resource $context A context identifier, returned by {@link
22820 *   gupnp_context_new}.
22821 * @return string
22822 * @since PECL gupnp >= 0.1.0
22823 **/
22824function gupnp_context_get_host_ip($context){}
22825
22826/**
22827 * Get the port that the SOAP server is running on.
22828 *
22829 * @param resource $context A context identifier, returned by {@link
22830 *   gupnp_context_new}.
22831 * @return int
22832 * @since PECL gupnp >= 0.1.0
22833 **/
22834function gupnp_context_get_port($context){}
22835
22836/**
22837 * Get the event subscription timeout (in seconds), or 0 meaning there is
22838 * no timeout.
22839 *
22840 * @param resource $context A context identifier, returned by {@link
22841 *   gupnp_context_new}.
22842 * @return int
22843 * @since PECL gupnp >= 0.1.0
22844 **/
22845function gupnp_context_get_subscription_timeout($context){}
22846
22847/**
22848 * Start hosting {@link local_path} at {@link server_path}. Files with
22849 * the path {@link local_path}.LOCALE (if they exist) will be served up
22850 * when LOCALE is specified in the request's Accept-Language header.
22851 *
22852 * @param resource $context A context identifier, returned by {@link
22853 *   gupnp_context_new}.
22854 * @param string $local_path Path to the local file or folder to be
22855 *   hosted.
22856 * @param string $server_path Web server path where {@link local_path}
22857 *   should be hosted.
22858 * @return bool
22859 * @since PECL gupnp >= 0.1.0
22860 **/
22861function gupnp_context_host_path($context, $local_path, $server_path){}
22862
22863/**
22864 * Create a new context with the specified host_ip and port.
22865 *
22866 * @param string $host_ip The local host's IP address, or NULL to use
22867 *   the IP address of the first non-loopback network interface.
22868 * @param int $port Port to run on, or 0 if you don't care what port is
22869 *   used.
22870 * @return resource
22871 * @since PECL gupnp >= 0.1.0
22872 **/
22873function gupnp_context_new($host_ip, $port){}
22874
22875/**
22876 * Sets the event subscription timeout (in seconds) to time out. Note
22877 * that any client side subscriptions will automatically be renewed.
22878 *
22879 * @param resource $context A context identifier, returned by {@link
22880 *   gupnp_context_new}.
22881 * @param int $timeout The event subscription timeout in seconds. Use 0
22882 *   if you don't want subscriptions to time out.
22883 * @return void
22884 * @since PECL gupnp >= 0.1.0
22885 **/
22886function gupnp_context_set_subscription_timeout($context, $timeout){}
22887
22888/**
22889 * Sets a function to be called at regular intervals.
22890 *
22891 * @param resource $context A context identifier, returned by {@link
22892 *   gupnp_context_new}.
22893 * @param int $timeout A timeout in miliseconds.
22894 * @param mixed $callback The callback function calling every {@link
22895 *   timeout} period of time. Typically, callback function takes on
22896 *   {@link arg} parameter.
22897 * @param mixed $arg User data for {@link callback}.
22898 * @return bool
22899 * @since PECL gupnp >= 0.1.0
22900 **/
22901function gupnp_context_timeout_add($context, $timeout, $callback, $arg){}
22902
22903/**
22904 * Stop hosting the file or folder at {@link server_path}.
22905 *
22906 * @param resource $context A context identifier, returned by {@link
22907 *   gupnp_context_new}.
22908 * @param string $server_path Web server path where the file or folder
22909 *   is hosted.
22910 * @return bool
22911 * @since PECL gupnp >= 0.1.0
22912 **/
22913function gupnp_context_unhost_path($context, $server_path){}
22914
22915/**
22916 * Start the search and calls user-defined callback.
22917 *
22918 * @param resource $cpoint A control point identifier, returned by
22919 *   {@link gupnp_control_point_new}.
22920 * @return bool
22921 * @since PECL gupnp >= 0.1.0
22922 **/
22923function gupnp_control_point_browse_start($cpoint){}
22924
22925/**
22926 * Stop the search and calls user-defined callback.
22927 *
22928 * @param resource $cpoint A control point identifier, returned by
22929 *   {@link gupnp_control_point_new}.
22930 * @return bool
22931 * @since PECL gupnp >= 0.1.0
22932 **/
22933function gupnp_control_point_browse_stop($cpoint){}
22934
22935/**
22936 * Set control point callback function for signal.
22937 *
22938 * @param resource $cpoint A control point identifier, returned by
22939 *   {@link gupnp_control_point_new}.
22940 * @param int $signal The value of signal. Signal can be one of the
22941 *   following values: GUPNP_SIGNAL_DEVICE_PROXY_AVAILABLE Emitted
22942 *   whenever a new device has become available.
22943 *   GUPNP_SIGNAL_DEVICE_PROXY_UNAVAILABLE Emitted whenever a device is
22944 *   not available any more. GUPNP_SIGNAL_SERVICE_PROXY_AVAILABLE Emitted
22945 *   whenever a new service has become available.
22946 *   GUPNP_SIGNAL_SERVICE_PROXY_UNAVAILABLE Emitted whenever a service is
22947 *   not available any more.
22948 * @param mixed $callback
22949 * @param mixed $arg
22950 * @return bool
22951 * @since PECL gupnp >= 0.1.0
22952 **/
22953function gupnp_control_point_callback_set($cpoint, $signal, $callback, $arg){}
22954
22955/**
22956 * Create a new control point with the specified target.
22957 *
22958 * @param resource $context A context identifier, returned by {@link
22959 *   gupnp_context_new}.
22960 * @param string $target The search target. {@link target} should be a
22961 *   service or device name, such as
22962 *   urn:schemas-upnp-org:service:WANIPConnection:1 or
22963 *   urn:schemas-upnp-org:device:MediaRenderer:1.
22964 * @return resource
22965 * @since PECL gupnp >= 0.1.0
22966 **/
22967function gupnp_control_point_new($context, $target){}
22968
22969/**
22970 * Set device callback function for signal and action.
22971 *
22972 * @param resource $root_device A root device identifier, returned by
22973 *   {@link gupnp_root_device_new}.
22974 * @param int $signal The value of signal. Signal can be one of the
22975 *   following values: GUPNP_SIGNAL_ACTION_INVOKED Emitted whenever an
22976 *   action is invoked. Handler should process action and must call
22977 *   either {@link gupnp_service_action_return} or {@link
22978 *   gupnp_service_action_return_error}. GUPNP_SIGNAL_NOTIFY_FAILED
22979 *   Emitted whenever notification of a client fails.
22980 * @param string $action_name
22981 * @param mixed $callback
22982 * @param mixed $arg The name of action.
22983 * @return bool
22984 * @since PECL gupnp >= 0.1.0
22985 **/
22986function gupnp_device_action_callback_set($root_device, $signal, $action_name, $callback, $arg){}
22987
22988/**
22989 * Get info of root device.
22990 *
22991 * @param resource $root_device A root device identifier, returned by
22992 *   {@link gupnp_root_device_new}.
22993 * @return array
22994 * @since PECL gupnp >= 0.1.0
22995 **/
22996function gupnp_device_info_get($root_device){}
22997
22998/**
22999 * Get the service with type or false if no such device was found.
23000 *
23001 * @param resource $root_device A root device identifier, returned by
23002 *   {@link gupnp_root_device_new}.
23003 * @param string $type The type of the service to be retrieved.
23004 * @return resource
23005 * @since PECL gupnp >= 0.1.0
23006 **/
23007function gupnp_device_info_get_service($root_device, $type){}
23008
23009/**
23010 * Get whether or not {@link root_device} is available (announcing its
23011 * presence).
23012 *
23013 * @param resource $root_device A root device identifier, returned by
23014 *   {@link gupnp_root_device_new}.
23015 * @return bool
23016 * @since PECL gupnp >= 0.1.0
23017 **/
23018function gupnp_root_device_get_available($root_device){}
23019
23020/**
23021 * Get the relative location of root device.
23022 *
23023 * @param resource $root_device A root device identifier, returned by
23024 *   {@link gupnp_root_device_new}.
23025 * @return string
23026 * @since PECL gupnp >= 0.1.0
23027 **/
23028function gupnp_root_device_get_relative_location($root_device){}
23029
23030/**
23031 * Create a new root device, automatically downloading and parsing
23032 * location.
23033 *
23034 * @param resource $context A context identifier, returned by {@link
23035 *   gupnp_context_new}.
23036 * @param string $location Location of the description file for this
23037 *   device, relative to the HTTP root
23038 * @return resource
23039 * @since PECL gupnp >= 0.1.0
23040 **/
23041function gupnp_root_device_new($context, $location){}
23042
23043/**
23044 * Controls whether or not root_device is available (announcing its
23045 * presence).
23046 *
23047 * @param resource $root_device A root device identifier, returned by
23048 *   {@link gupnp_root_device_new}.
23049 * @param bool $available Set if {@link root_device} should be
23050 *   available.
23051 * @return bool
23052 * @since PECL gupnp >= 0.1.0
23053 **/
23054function gupnp_root_device_set_available($root_device, $available){}
23055
23056/**
23057 * Start root server's main loop.
23058 *
23059 * @param resource $root_device A root device identifier, returned by
23060 *   {@link gupnp_root_device_new}.
23061 * @return bool
23062 * @since PECL gupnp >= 0.1.0
23063 **/
23064function gupnp_root_device_start($root_device){}
23065
23066/**
23067 * Stop root server's main loop.
23068 *
23069 * @param resource $root_device A root device identifier, returned by
23070 *   {@link gupnp_root_device_new}.
23071 * @return bool
23072 * @since PECL gupnp >= 0.1.0
23073 **/
23074function gupnp_root_device_stop($root_device){}
23075
23076/**
23077 * Retrieves the specified action arguments.
23078 *
23079 * @param resource $action A service action identifier.
23080 * @param string $name The name of the variable to retrieve.
23081 * @param int $type The type of the variable to retrieve. Type can be
23082 *   one of the following values: GUPNP_TYPE_BOOLEAN Type of the variable
23083 *   is boolean. GUPNP_TYPE_INT Type of the variable is integer.
23084 *   GUPNP_TYPE_LONG Type of the variable is long. GUPNP_TYPE_DOUBLE Type
23085 *   of the variable is double. GUPNP_TYPE_FLOAT Type of the variable is
23086 *   float. GUPNP_TYPE_STRING Type of the variable is string.
23087 * @return mixed
23088 * @since PECL gupnp >= 0.1.0
23089 **/
23090function gupnp_service_action_get($action, $name, $type){}
23091
23092/**
23093 * Return succesfully.
23094 *
23095 * @param resource $action A service action identifier.
23096 * @return bool
23097 * @since PECL gupnp >= 0.1.0
23098 **/
23099function gupnp_service_action_return($action){}
23100
23101/**
23102 * Return error code.
23103 *
23104 * @param resource $action A service action identifier.
23105 * @param int $error_code The error code. Signal can be one of the
23106 *   following values or user defined: GUPNP_CONTROL_ERROR_INVALID_ACTION
23107 *   The action name was invalid. GUPNP_CONTROL_ERROR_INVALID_ARGS The
23108 *   action arguments were invalid. GUPNP_CONTROL_ERROR_OUT_OF_SYNC Out
23109 *   of sync (deprecated). GUPNP_CONTROL_ERROR_ACTION_FAILED The action
23110 *   failed.
23111 * @param string $error_description
23112 * @return bool
23113 * @since PECL gupnp >= 0.1.0
23114 **/
23115function gupnp_service_action_return_error($action, $error_code, $error_description){}
23116
23117/**
23118 * Sets the specified action return values.
23119 *
23120 * @param resource $action A service action identifier.
23121 * @param string $name The name of the variable to retrieve.
23122 * @param int $type The type of the variable to retrieve. Type can be
23123 *   one of the following values: GUPNP_TYPE_BOOLEAN Type of the variable
23124 *   is boolean. GUPNP_TYPE_INT Type of the variable is integer.
23125 *   GUPNP_TYPE_LONG Type of the variable is long. GUPNP_TYPE_DOUBLE Type
23126 *   of the variable is double. GUPNP_TYPE_FLOAT Type of the variable is
23127 *   float. GUPNP_TYPE_STRING Type of the variable is string.
23128 * @param mixed $value
23129 * @return bool
23130 * @since PECL gupnp >= 0.1.0
23131 **/
23132function gupnp_service_action_set($action, $name, $type, $value){}
23133
23134/**
23135 * Causes new notifications to be queued up until {@link
23136 * gupnp_service_thaw_notify} is called.
23137 *
23138 * @param resource $service A service identifier.
23139 * @return bool
23140 * @since PECL gupnp >= 0.1.0
23141 **/
23142function gupnp_service_freeze_notify($service){}
23143
23144/**
23145 * Get full info of service.
23146 *
23147 * @param resource $proxy A service proxy identifier.
23148 * @return array
23149 * @since PECL gupnp >= 0.1.0
23150 **/
23151function gupnp_service_info_get($proxy){}
23152
23153/**
23154 * Get resource introspection of service or register callback if
23155 * corresponding parameter was passed.
23156 *
23157 * @param resource $proxy A service proxy identifier.
23158 * @param mixed $callback The callback function to be called when
23159 *   introspection object is ready. Typically, callback function takes on
23160 *   three parameters. The {@link introspection} parameter's identifier
23161 *   being the first, {@link error} parameter's message being the second,
23162 *   and the {@link arg} is third.
23163 * @param mixed $arg User data for {@link callback}.
23164 * @return mixed
23165 * @since PECL gupnp >= 0.1.0
23166 **/
23167function gupnp_service_info_get_introspection($proxy, $callback, $arg){}
23168
23169/**
23170 * Returns the state variable data by the name {@link variable_name} in
23171 * this service.
23172 *
23173 * @param resource $introspection A introspection identifier.
23174 * @param string $variable_name The name of the variable to retreive.
23175 * @return array
23176 * @since PECL gupnp >= 0.1.0
23177 **/
23178function gupnp_service_introspection_get_state_variable($introspection, $variable_name){}
23179
23180/**
23181 * Notifies listening clients that the property have changed to the
23182 * specified values.
23183 *
23184 * @param resource $service A service identifier.
23185 * @param string $name The name of the variable.
23186 * @param int $type The type of the variable. Type can be one of the
23187 *   following values: GUPNP_TYPE_BOOLEAN Type of the variable is
23188 *   boolean. GUPNP_TYPE_INT Type of the variable is integer.
23189 *   GUPNP_TYPE_LONG Type of the variable is long. GUPNP_TYPE_DOUBLE Type
23190 *   of the variable is double. GUPNP_TYPE_FLOAT Type of the variable is
23191 *   float. GUPNP_TYPE_STRING Type of the variable is string.
23192 * @param mixed $value
23193 * @return bool
23194 * @since PECL gupnp >= 0.1.0
23195 **/
23196function gupnp_service_notify($service, $name, $type, $value){}
23197
23198/**
23199 * Send action with parameters to the service exposed by proxy
23200 * synchronously and get value.
23201 *
23202 * @param resource $proxy A service proxy identifier.
23203 * @param string $action An action.
23204 * @param string $name The action name.
23205 * @param int $type The type of the variable to retrieve. Type can be
23206 *   one of the following values: GUPNP_TYPE_BOOLEAN Type of the variable
23207 *   is boolean. GUPNP_TYPE_INT Type of the variable is integer.
23208 *   GUPNP_TYPE_LONG Type of the variable is long. GUPNP_TYPE_DOUBLE Type
23209 *   of the variable is double. GUPNP_TYPE_FLOAT Type of the variable is
23210 *   float. GUPNP_TYPE_STRING Type of the variable is string.
23211 * @return mixed
23212 * @since PECL gupnp >= 0.1.0
23213 **/
23214function gupnp_service_proxy_action_get($proxy, $action, $name, $type){}
23215
23216/**
23217 * Send action with parameters to the service exposed by proxy
23218 * synchronously and set value.
23219 *
23220 * @param resource $proxy A service proxy identifier.
23221 * @param string $action An action.
23222 * @param string $name The action name.
23223 * @param mixed $value The action value.
23224 * @param int $type The type of the action. Type can be one of the
23225 *   following values: GUPNP_TYPE_BOOLEAN Type of the variable is
23226 *   boolean. GUPNP_TYPE_INT Type of the variable is integer.
23227 *   GUPNP_TYPE_LONG Type of the variable is long. GUPNP_TYPE_DOUBLE Type
23228 *   of the variable is double. GUPNP_TYPE_FLOAT Type of the variable is
23229 *   float. GUPNP_TYPE_STRING Type of the variable is string.
23230 * @return bool
23231 * @since PECL gupnp >= 0.1.0
23232 **/
23233function gupnp_service_proxy_action_set($proxy, $action, $name, $value, $type){}
23234
23235/**
23236 * Sets up callback to be called whenever a change notification for
23237 * variable is recieved.
23238 *
23239 * @param resource $proxy A service proxy identifier.
23240 * @param string $value The variable to add notification for.
23241 * @param int $type The type of the variable. Type can be one of the
23242 *   following values: GUPNP_TYPE_BOOLEAN Type of the variable is
23243 *   boolean. GUPNP_TYPE_INT Type of the variable is integer.
23244 *   GUPNP_TYPE_LONG Type of the variable is long. GUPNP_TYPE_DOUBLE Type
23245 *   of the variable is double. GUPNP_TYPE_FLOAT Type of the variable is
23246 *   float. GUPNP_TYPE_STRING Type of the variable is string.
23247 * @param mixed $callback
23248 * @param mixed $arg
23249 * @return bool
23250 * @since PECL gupnp >= 0.1.0
23251 **/
23252function gupnp_service_proxy_add_notify($proxy, $value, $type, $callback, $arg){}
23253
23254/**
23255 * Set service proxy callback for signal.
23256 *
23257 * @param resource $proxy A service proxy identifier.
23258 * @param int $signal The value of signal.
23259 *   GUPNP_SIGNAL_SUBSCRIPTION_LOST Emitted whenever the subscription to
23260 *   this service has been lost due to an error condition.
23261 * @param mixed $callback
23262 * @param mixed $arg The callback function for the certain signal.
23263 *   Typically, callback function takes on two parameters. {@link error}
23264 *   parameter's message being the first, and the {@link arg} is second.
23265 * @return bool
23266 * @since PECL gupnp >= 0.1.0
23267 **/
23268function gupnp_service_proxy_callback_set($proxy, $signal, $callback, $arg){}
23269
23270/**
23271 * Check whether subscription is valid to the service.
23272 *
23273 * @param resource $proxy A service proxy identifier.
23274 * @return bool
23275 * @since PECL gupnp >= 0.1.0
23276 **/
23277function gupnp_service_proxy_get_subscribed($proxy){}
23278
23279/**
23280 * Cancels the variable change notification.
23281 *
23282 * @param resource $proxy A service proxy identifier.
23283 * @param string $value The variable to add notification for.
23284 * @return bool
23285 * @since PECL gupnp >= 0.1.0
23286 **/
23287function gupnp_service_proxy_remove_notify($proxy, $value){}
23288
23289/**
23290 * Send action action with parameters {@link in_params} to the service
23291 * exposed by proxy synchronously and return {@link out_params} with
23292 * values or on error.
23293 *
23294 * @param resource $proxy A service proxy identifier.
23295 * @param string $action An action.
23296 * @param array $in_params An array of in parameters. Each entry in
23297 *   {@link in_params} is supposed to an array containing name, type and
23298 *   value of the parameters.
23299 * @param array $out_params An array of out parameters. Each entry in
23300 *   {@link out_params} is supposed to an array containing name and type
23301 *   of the parameters.
23302 * @return array
23303 * @since PECL gupnp >= 0.2.0
23304 **/
23305function gupnp_service_proxy_send_action($proxy, $action, $in_params, $out_params){}
23306
23307/**
23308 * (Un)subscribes to the service.
23309 *
23310 * @param resource $proxy A service proxy identifier.
23311 * @param bool $subscribed Set to subscribe to this service.
23312 * @return bool
23313 * @since PECL gupnp >= 0.1.0
23314 **/
23315function gupnp_service_proxy_set_subscribed($proxy, $subscribed){}
23316
23317/**
23318 * Sends out any pending notifications and stops queuing of new ones.
23319 *
23320 * @param resource $service A service identifier.
23321 * @return bool
23322 * @since PECL gupnp >= 0.1.0
23323 **/
23324function gupnp_service_thaw_notify($service){}
23325
23326/**
23327 * Closes the given gz-file pointer.
23328 *
23329 * @param resource $zp The gz-file pointer. It must be valid, and must
23330 *   point to a file successfully opened by {@link gzopen}.
23331 * @return bool
23332 * @since PHP 4, PHP 5
23333 **/
23334function gzclose($zp){}
23335
23336/**
23337 * This function compress the given string using the ZLIB data format.
23338 *
23339 * For details on the ZLIB compression algorithm see the document "ZLIB
23340 * Compressed Data Format Specification version 3.3" (RFC 1950).
23341 *
23342 * @param string $data The data to compress.
23343 * @param int $level The level of compression. Can be given as 0 for no
23344 *   compression up to 9 for maximum compression.
23345 * @return string
23346 * @since PHP 4 >= 4.0.1, PHP 5
23347 **/
23348function gzcompress($data, $level){}
23349
23350/**
23351 * This function returns a decoded version of the input {@link data}.
23352 *
23353 * @param string $data The data to decode, encoded by {@link gzencode}.
23354 * @param int $length The maximum length of data to decode.
23355 * @return string
23356 **/
23357function gzdecode($data, $length){}
23358
23359/**
23360 * This function compress the given string using the DEFLATE data format.
23361 *
23362 * For details on the DEFLATE compression algorithm see the document
23363 * "DEFLATE Compressed Data Format Specification version 1.3" (RFC 1951).
23364 *
23365 * @param string $data The data to deflate.
23366 * @param int $level The level of compression. Can be given as 0 for no
23367 *   compression up to 9 for maximum compression. If not given, the
23368 *   default compression level will be the default compression level of
23369 *   the zlib library.
23370 * @return string
23371 * @since PHP 4 >= 4.0.4, PHP 5
23372 **/
23373function gzdeflate($data, $level){}
23374
23375/**
23376 * This function returns a compressed version of the input {@link data}
23377 * compatible with the output of the gzip program.
23378 *
23379 * For more information on the GZIP file format, see the document: GZIP
23380 * file format specification version 4.3 (RFC 1952).
23381 *
23382 * @param string $data The data to encode.
23383 * @param int $level The level of compression. Can be given as 0 for no
23384 *   compression up to 9 for maximum compression. If not given, the
23385 *   default compression level will be the default compression level of
23386 *   the zlib library.
23387 * @param int $encoding_mode The encoding mode. Can be FORCE_GZIP (the
23388 *   default) or FORCE_DEFLATE. If you use FORCE_DEFLATE, you get a
23389 *   standard zlib deflated string (inclusive zlib headers) after the
23390 *   gzip file header but without the trailing crc32 checksum.
23391 * @return string
23392 * @since PHP 4 >= 4.0.4, PHP 5
23393 **/
23394function gzencode($data, $level, $encoding_mode){}
23395
23396/**
23397 * Tests the given GZ file pointer for EOF.
23398 *
23399 * @param resource $zp The gz-file pointer. It must be valid, and must
23400 *   point to a file successfully opened by {@link gzopen}.
23401 * @return int
23402 * @since PHP 4, PHP 5
23403 **/
23404function gzeof($zp){}
23405
23406/**
23407 * This function is identical to {@link readgzfile}, except that it
23408 * returns the file in an array.
23409 *
23410 * @param string $filename The file name.
23411 * @param int $use_include_path You can set this optional parameter to
23412 *   1, if you want to search for the file in the include_path too.
23413 * @return array
23414 * @since PHP 4, PHP 5
23415 **/
23416function gzfile($filename, $use_include_path){}
23417
23418/**
23419 * Returns a string containing a single (uncompressed) character read
23420 * from the given gz-file pointer.
23421 *
23422 * @param resource $zp The gz-file pointer. It must be valid, and must
23423 *   point to a file successfully opened by {@link gzopen}.
23424 * @return string
23425 * @since PHP 4, PHP 5
23426 **/
23427function gzgetc($zp){}
23428
23429/**
23430 * Gets a (uncompressed) string of up to length - 1 bytes read from the
23431 * given file pointer. Reading ends when length - 1 bytes have been read,
23432 * on a newline, or on EOF (whichever comes first).
23433 *
23434 * @param resource $zp The gz-file pointer. It must be valid, and must
23435 *   point to a file successfully opened by {@link gzopen}.
23436 * @param int $length The length of data to get.
23437 * @return string
23438 * @since PHP 4, PHP 5
23439 **/
23440function gzgets($zp, $length){}
23441
23442/**
23443 * Identical to {@link gzgets}, except that {@link gzgetss} attempts to
23444 * strip any HTML and PHP tags from the text it reads.
23445 *
23446 * @param resource $zp The gz-file pointer. It must be valid, and must
23447 *   point to a file successfully opened by {@link gzopen}.
23448 * @param int $length The length of data to get.
23449 * @param string $allowable_tags You can use this optional parameter to
23450 *   specify tags which should not be stripped.
23451 * @return string
23452 * @since PHP 4, PHP 5
23453 **/
23454function gzgetss($zp, $length, $allowable_tags){}
23455
23456/**
23457 * This function inflate a deflated string.
23458 *
23459 * @param string $data The data compressed by {@link gzdeflate}.
23460 * @param int $length The maximum length of data to decode.
23461 * @return string
23462 * @since PHP 4 >= 4.0.4, PHP 5
23463 **/
23464function gzinflate($data, $length){}
23465
23466/**
23467 * Opens a gzip (.gz) file for reading or writing.
23468 *
23469 * {@link gzopen} can be used to read a file which is not in gzip format;
23470 * in this case {@link gzread} will directly read from the file without
23471 * decompression.
23472 *
23473 * @param string $filename The file name.
23474 * @param string $mode As in {@link fopen} (rb or wb) but can also
23475 *   include a compression level (wb9) or a strategy: f for filtered data
23476 *   as in wb6f, h for Huffman only compression as in wb1h. (See the
23477 *   description of deflateInit2 in zlib.h for more information about the
23478 *   strategy parameter.)
23479 * @param int $use_include_path You can set this optional parameter to
23480 *   1, if you want to search for the file in the include_path too.
23481 * @return resource
23482 * @since PHP 4, PHP 5
23483 **/
23484function gzopen($filename, $mode, $use_include_path){}
23485
23486/**
23487 * Reads to EOF on the given gz-file pointer from the current position
23488 * and writes the (uncompressed) results to standard output.
23489 *
23490 * @param resource $zp The gz-file pointer. It must be valid, and must
23491 *   point to a file successfully opened by {@link gzopen}.
23492 * @return int
23493 * @since PHP 4, PHP 5
23494 **/
23495function gzpassthru($zp){}
23496
23497/**
23498 * {@link gzputs} writes the contents of {@link string} to the given
23499 * gz-file.
23500 *
23501 * @param resource $zp The gz-file pointer. It must be valid, and must
23502 *   point to a file successfully opened by {@link gzopen}.
23503 * @param string $string The string to write.
23504 * @param int $length The number of uncompressed bytes to write. If
23505 *   supplied, writing will stop after {@link length} (uncompressed)
23506 *   bytes have been written or the end of {@link string} is reached,
23507 *   whichever comes first.
23508 * @return int
23509 * @since PHP 4, PHP 5
23510 **/
23511function gzputs($zp, $string, $length){}
23512
23513/**
23514 * {@link gzread} reads up to {@link length} bytes from the given gz-file
23515 * pointer. Reading stops when {@link length} (uncompressed) bytes have
23516 * been read or EOF is reached, whichever comes first.
23517 *
23518 * @param resource $zp The gz-file pointer. It must be valid, and must
23519 *   point to a file successfully opened by {@link gzopen}.
23520 * @param int $length The number of bytes to read.
23521 * @return string
23522 * @since PHP 4, PHP 5
23523 **/
23524function gzread($zp, $length){}
23525
23526/**
23527 * Sets the file position indicator of the given gz-file pointer to the
23528 * beginning of the file stream.
23529 *
23530 * @param resource $zp The gz-file pointer. It must be valid, and must
23531 *   point to a file successfully opened by {@link gzopen}.
23532 * @return bool
23533 * @since PHP 4, PHP 5
23534 **/
23535function gzrewind($zp){}
23536
23537/**
23538 * Sets the file position indicator for the given file pointer to the
23539 * given offset byte into the file stream. Equivalent to calling (in C)
23540 * gzseek(zp, offset, SEEK_SET).
23541 *
23542 * If the file is opened for reading, this function is emulated but can
23543 * be extremely slow. If the file is opened for writing, only forward
23544 * seeks are supported; {@link gzseek} then compresses a sequence of
23545 * zeroes up to the new starting position.
23546 *
23547 * @param resource $zp The gz-file pointer. It must be valid, and must
23548 *   point to a file successfully opened by {@link gzopen}.
23549 * @param int $offset The seeked offset.
23550 * @param int $whence {@link whence} values are: SEEK_SET - Set
23551 *   position equal to {@link offset} bytes. SEEK_CUR - Set position to
23552 *   current location plus {@link offset}. If {@link whence} is not
23553 *   specified, it is assumed to be SEEK_SET.
23554 * @return int
23555 * @since PHP 4, PHP 5
23556 **/
23557function gzseek($zp, $offset, $whence){}
23558
23559/**
23560 * Gets the position of the given file pointer; i.e., its offset into the
23561 * uncompressed file stream.
23562 *
23563 * @param resource $zp The gz-file pointer. It must be valid, and must
23564 *   point to a file successfully opened by {@link gzopen}.
23565 * @return int
23566 * @since PHP 4, PHP 5
23567 **/
23568function gztell($zp){}
23569
23570/**
23571 * This function uncompress a compressed string.
23572 *
23573 * @param string $data The data compressed by {@link gzcompress}.
23574 * @param int $length The maximum length of data to decode.
23575 * @return string
23576 * @since PHP 4 >= 4.0.1, PHP 5
23577 **/
23578function gzuncompress($data, $length){}
23579
23580/**
23581 * {@link gzwrite} writes the contents of {@link string} to the given
23582 * gz-file.
23583 *
23584 * @param resource $zp The gz-file pointer. It must be valid, and must
23585 *   point to a file successfully opened by {@link gzopen}.
23586 * @param string $string The string to write.
23587 * @param int $length The number of uncompressed bytes to write. If
23588 *   supplied, writing will stop after {@link length} (uncompressed)
23589 *   bytes have been written or the end of {@link string} is reached,
23590 *   whichever comes first.
23591 * @return int
23592 * @since PHP 4, PHP 5
23593 **/
23594function gzwrite($zp, $string, $length){}
23595
23596/**
23597 * @param string $algo Name of selected hashing algorithm (i.e. "md5",
23598 *   "sha256", "haval160,4", etc..)
23599 * @param string $data Message to be hashed.
23600 * @param bool $raw_output When set to , outputs raw binary data.
23601 *   outputs lowercase hexits.
23602 * @return string
23603 * @since PHP 5 >= 5.1.2, PECL hash >= 1.1
23604 **/
23605function hash($algo, $data, $raw_output){}
23606
23607/**
23608 * @return array
23609 * @since PHP 5 >= 5.1.2, PECL hash >= 1.1
23610 **/
23611function hash_algos(){}
23612
23613/**
23614 * @param resource $context Hashing context returned by {@link
23615 *   hash_init}.
23616 * @return resource
23617 * @since PHP 5 >= 5.3.0
23618 **/
23619function hash_copy($context){}
23620
23621/**
23622 * @param string $algo Name of selected hashing algorithm (i.e. "md5",
23623 *   "sha256", "haval160,4", etc..)
23624 * @param string $filename URL describing location of file to be
23625 *   hashed; Supports fopen wrappers.
23626 * @param bool $raw_output When set to , outputs raw binary data.
23627 *   outputs lowercase hexits.
23628 * @return string
23629 * @since PHP 5 >= 5.1.2, PECL hash >= 1.1
23630 **/
23631function hash_file($algo, $filename, $raw_output){}
23632
23633/**
23634 * @param resource $context Hashing context returned by {@link
23635 *   hash_init}.
23636 * @param bool $raw_output When set to , outputs raw binary data.
23637 *   outputs lowercase hexits.
23638 * @return string
23639 * @since PHP 5 >= 5.1.2, PECL hash >= 1.1
23640 **/
23641function hash_final($context, $raw_output){}
23642
23643/**
23644 * @param string $algo Name of selected hashing algorithm (i.e. "md5",
23645 *   "sha256", "haval160,4", etc..) See {@link hash_algos} for a list of
23646 *   supported algorithms.
23647 * @param string $data Message to be hashed.
23648 * @param string $key Shared secret key used for generating the HMAC
23649 *   variant of the message digest.
23650 * @param bool $raw_output When set to , outputs raw binary data.
23651 *   outputs lowercase hexits.
23652 * @return string
23653 * @since PHP 5 >= 5.1.2, PECL hash >= 1.1
23654 **/
23655function hash_hmac($algo, $data, $key, $raw_output){}
23656
23657/**
23658 * @param string $algo Name of selected hashing algorithm (i.e. "md5",
23659 *   "sha256", "haval160,4", etc..) See {@link hash_algos} for a list of
23660 *   supported algorithms.
23661 * @param string $filename URL describing location of file to be
23662 *   hashed; Supports fopen wrappers.
23663 * @param string $key Shared secret key used for generating the HMAC
23664 *   variant of the message digest.
23665 * @param bool $raw_output When set to , outputs raw binary data.
23666 *   outputs lowercase hexits.
23667 * @return string
23668 * @since PHP 5 >= 5.1.2, PECL hash >= 1.1
23669 **/
23670function hash_hmac_file($algo, $filename, $key, $raw_output){}
23671
23672/**
23673 * @param string $algo Name of selected hashing algorithm (i.e. "md5",
23674 *   "sha256", "haval160,4", etc..)
23675 * @param int $options Optional settings for hash generation, currently
23676 *   supports only one option: HASH_HMAC. When specified, the {@link key}
23677 *   must be specified.
23678 * @param string $key When HASH_HMAC is specified for {@link options},
23679 *   a shared secret key to be used with the HMAC hashing method must be
23680 *   supplied in this parameter.
23681 * @return resource
23682 * @since PHP 5 >= 5.1.2, PECL hash >= 1.1
23683 **/
23684function hash_init($algo, $options, $key){}
23685
23686/**
23687 * @param resource $context Hashing context returned by {@link
23688 *   hash_init}.
23689 * @param string $data Message to be included in the hash digest.
23690 * @return bool
23691 * @since PHP 5 >= 5.1.2, PECL hash >= 1.1
23692 **/
23693function hash_update($context, $data){}
23694
23695/**
23696 * @param resource $context Hashing context returned by {@link
23697 *   hash_init}.
23698 * @param string $filename URL describing location of file to be
23699 *   hashed; Supports fopen wrappers.
23700 * @param resource $context Stream context as returned by {@link
23701 *   stream_context_create}.
23702 * @return bool
23703 * @since PHP 5 >= 5.1.2, PECL hash >= 1.1
23704 **/
23705function hash_update_file($context, $filename, $context){}
23706
23707/**
23708 * @param resource $context Hashing context returned by {@link
23709 *   hash_init}.
23710 * @param resource $handle Open file handle as returned by any stream
23711 *   creation function.
23712 * @param int $length Maximum number of characters to copy from {@link
23713 *   handle} into the hashing context.
23714 * @return int
23715 * @since PHP 5 >= 5.1.2, PECL hash >= 1.1
23716 **/
23717function hash_update_stream($context, $handle, $length){}
23718
23719/**
23720 * {@link header} is used to send a raw HTTP header. See the HTTP/1.1
23721 * specification for more information on HTTP headers.
23722 *
23723 * Remember that {@link header} must be called before any actual output
23724 * is sent, either by normal HTML tags, blank lines in a file, or from
23725 * PHP. It is a very common error to read code with {@link include}, or
23726 * {@link require}, functions, or another file access function, and have
23727 * spaces or empty lines that are output before {@link header} is called.
23728 * The same problem exists when using a single PHP/HTML file.
23729 *
23730 * <html> <?php /* This will give an error. Note the output * above,
23731 * which is before the header() call * / header('Location:
23732 * http://www.example.com/'); ?>
23733 *
23734 * @param string $string The header string. There are two special-case
23735 *   header calls. The first is a header that starts with the string
23736 *   "HTTP/" (case is not significant), which will be used to figure out
23737 *   the HTTP status code to send. For example, if you have configured
23738 *   Apache to use a PHP script to handle requests for missing files
23739 *   (using the ErrorDocument directive), you may want to make sure that
23740 *   your script generates the proper status code.
23741 *
23742 *   <?php header("HTTP/1.0 404 Not Found"); ?>
23743 *
23744 *   The second special case is the "Location:" header. Not only does it
23745 *   send this header back to the browser, but it also returns a REDIRECT
23746 *   (302) status code to the browser unless the 201 or a 3xx status code
23747 *   has already been set.
23748 *
23749 *   <?php header("Location: http://www.example.com/"); /* Redirect
23750 *   browser * /
23751 *
23752 *   /* Make sure that code below does not get executed when we redirect.
23753 *   * / exit; ?>
23754 * @param bool $replace The optional {@link replace} parameter
23755 *   indicates whether the header should replace a previous similar
23756 *   header, or add a second header of the same type. By default it will
23757 *   replace, but if you pass in as the second argument you can force
23758 *   multiple headers of the same type. For example:
23759 *
23760 *   <?php header('WWW-Authenticate: Negotiate');
23761 *   header('WWW-Authenticate: NTLM', false); ?>
23762 * @param int $http_response_code Forces the HTTP response code to the
23763 *   specified value.
23764 * @return void
23765 * @since PHP 4, PHP 5
23766 **/
23767function header($string, $replace, $http_response_code){}
23768
23769/**
23770 * {@link headers_list} will return a list of headers to be sent to the
23771 * browser / client. To determine whether or not these headers have been
23772 * sent yet, use {@link headers_sent}.
23773 *
23774 * @return array
23775 * @since PHP 5
23776 **/
23777function headers_list(){}
23778
23779/**
23780 * Checks if or where headers have been sent.
23781 *
23782 * You can't add any more header lines using the {@link header} function
23783 * once the header block has already been sent. Using this function you
23784 * can at least prevent getting HTTP header related error messages.
23785 * Another option is to use Output Buffering.
23786 *
23787 * @param string $file If the optional {@link file} and {@link line}
23788 *   parameters are set, {@link headers_sent} will put the PHP source
23789 *   file name and line number where output started in the {@link file}
23790 *   and {@link line} variables.
23791 * @param int $line The line number where the output started.
23792 * @return bool
23793 * @since PHP 4, PHP 5
23794 **/
23795function headers_sent(&$file, &$line){}
23796
23797/**
23798 * Removes an HTTP header previously set using {@link header}.
23799 *
23800 * @param string $name The header name to be removed.
23801 * @return void
23802 * @since PHP 5 >= 5.3.0
23803 **/
23804function header_remove($name){}
23805
23806/**
23807 * Converts logical Hebrew text to visual text.
23808 *
23809 * The function tries to avoid breaking words.
23810 *
23811 * @param string $hebrew_text A Hebrew input string.
23812 * @param int $max_chars_per_line This optional parameter indicates
23813 *   maximum number of characters per line that will be returned.
23814 * @return string
23815 * @since PHP 4, PHP 5
23816 **/
23817function hebrev($hebrew_text, $max_chars_per_line){}
23818
23819/**
23820 * This function is similar to {@link hebrev} with the difference that it
23821 * converts newlines (\n) to "<br>\n".
23822 *
23823 * The function tries to avoid breaking words.
23824 *
23825 * @param string $hebrew_text A Hebrew input string.
23826 * @param int $max_chars_per_line This optional parameter indicates
23827 *   maximum number of characters per line that will be returned.
23828 * @return string
23829 * @since PHP 4, PHP 5
23830 **/
23831function hebrevc($hebrew_text, $max_chars_per_line){}
23832
23833/**
23834 * Returns the decimal equivalent of the hexadecimal number represented
23835 * by the {@link hex_string} argument. {@link hexdec} converts a
23836 * hexadecimal string to a decimal number.
23837 *
23838 * {@link hexdec} will ignore any non-hexadecimal characters it
23839 * encounters.
23840 *
23841 * @param string $hex_string The hexadecimal string to convert
23842 * @return number
23843 * @since PHP 4, PHP 5
23844 **/
23845function hexdec($hex_string){}
23846
23847/**
23848 * Prints out or returns a syntax highlighted version of the code
23849 * contained in {@link filename} using the colors defined in the built-in
23850 * syntax highlighter for PHP.
23851 *
23852 * Many servers are configured to automatically highlight files with a
23853 * phps extension. For example, example.phps when viewed will show the
23854 * syntax highlighted source of the file. To enable this, add this line
23855 * to the :
23856 *
23857 * @param string $filename Path to the PHP file to be highlighted.
23858 * @param bool $return Set this parameter to to make this function
23859 *   return the highlighted code.
23860 * @return mixed
23861 * @since PHP 4, PHP 5
23862 **/
23863function highlight_file($filename, $return){}
23864
23865/**
23866 * @param string $str The PHP code to be highlighted. This should
23867 *   include the opening tag.
23868 * @param bool $return Set this parameter to to make this function
23869 *   return the highlighted code.
23870 * @return mixed
23871 * @since PHP 4, PHP 5
23872 **/
23873function highlight_string($str, $return){}
23874
23875/**
23876 * This function is identical to {@link htmlspecialchars} in all ways,
23877 * except with {@link htmlentities}, all characters which have HTML
23878 * character entity equivalents are translated into these entities.
23879 *
23880 * If you're wanting to decode instead (the reverse) you can use {@link
23881 * html_entity_decode}.
23882 *
23883 * @param string $string The input string.
23884 * @param int $quote_style Like {@link htmlspecialchars}, the optional
23885 *   second {@link quote_style} parameter lets you define what will be
23886 *   done with 'single' and "double" quotes. It takes on one of three
23887 *   constants with the default being ENT_COMPAT: Available {@link
23888 *   quote_style} constants Constant Name Description ENT_COMPAT Will
23889 *   convert double-quotes and leave single-quotes alone. ENT_QUOTES Will
23890 *   convert both double and single quotes. ENT_NOQUOTES Will leave both
23891 *   double and single quotes unconverted.
23892 * @param string $charset Like {@link htmlspecialchars}, it takes an
23893 *   optional third argument {@link charset} which defines character set
23894 *   used in conversion. Presently, the ISO-8859-1 character set is used
23895 *   as the default.
23896 * @param bool $double_encode When {@link double_encode} is turned off
23897 *   PHP will not encode existing html entities. The default is to
23898 *   convert everything.
23899 * @return string
23900 * @since PHP 4, PHP 5
23901 **/
23902function htmlentities($string, $quote_style, $charset, $double_encode){}
23903
23904/**
23905 * Certain characters have special significance in HTML, and should be
23906 * represented by HTML entities if they are to preserve their meanings.
23907 * This function returns a string with some of these conversions made;
23908 * the translations made are those most useful for everyday web
23909 * programming. If you require all HTML character entities to be
23910 * translated, use {@link htmlentities} instead.
23911 *
23912 * The translations performed are: '&' (ampersand) becomes '&amp;' ''
23913 * (double quote) becomes '&quot;' when ENT_NOQUOTES is not set. '''
23914 * (single quote) becomes '&#039;' only when ENT_QUOTES is set. '<' (less
23915 * than) becomes '&lt;' '>' (greater than) becomes '&gt;'
23916 *
23917 * @param string $string The string being converted.
23918 * @param int $quote_style The optional second argument, {@link
23919 *   quote_style}, tells the function what to do with single and double
23920 *   quote characters. The default mode, ENT_COMPAT, is the backwards
23921 *   compatible mode which only translates the double-quote character and
23922 *   leaves the single-quote untranslated. If ENT_QUOTES is set, both
23923 *   single and double quotes are translated and if ENT_NOQUOTES is set
23924 *   neither single nor double quotes are translated.
23925 * @param string $charset Defines character set used in conversion. The
23926 *   default character set is ISO-8859-1. For the purposes of this
23927 *   function, the charsets ISO-8859-1, ISO-8859-15, UTF-8, cp866,
23928 *   cp1251, cp1252, and KOI8-R are effectively equivalent, as the
23929 *   characters affected by {@link htmlspecialchars} occupy the same
23930 *   positions in all of these charsets.
23931 * @param bool $double_encode When {@link double_encode} is turned off
23932 *   PHP will not encode existing html entities, the default is to
23933 *   convert everything.
23934 * @return string
23935 * @since PHP 4, PHP 5
23936 **/
23937function htmlspecialchars($string, $quote_style, $charset, $double_encode){}
23938
23939/**
23940 * This function is the opposite of {@link htmlspecialchars}. It converts
23941 * special HTML entities back to characters.
23942 *
23943 * The converted entities are: &amp;, &quot; (when ENT_NOQUOTES is not
23944 * set), &#039; (when ENT_QUOTES is set), &lt; and &gt;.
23945 *
23946 * @param string $string The string to decode
23947 * @param int $quote_style The quote style. One of the following
23948 *   constants: quote_style constants Constant Name Description
23949 *   ENT_COMPAT Will convert double-quotes and leave single-quotes alone
23950 *   (default) ENT_QUOTES Will convert both double and single quotes
23951 *   ENT_NOQUOTES Will leave both double and single quotes unconverted
23952 * @return string
23953 * @since PHP 5 >= 5.1.0
23954 **/
23955function htmlspecialchars_decode($string, $quote_style){}
23956
23957/**
23958 * {@link html_entity_decode} is the opposite of {@link htmlentities} in
23959 * that it converts all HTML entities to their applicable characters from
23960 * {@link string}.
23961 *
23962 * @param string $string The input string.
23963 * @param int $quote_style The optional second {@link quote_style}
23964 *   parameter lets you define what will be done with 'single' and
23965 *   "double" quotes. It takes on one of three constants with the default
23966 *   being ENT_COMPAT: Available {@link quote_style} constants Constant
23967 *   Name Description ENT_COMPAT Will convert double-quotes and leave
23968 *   single-quotes alone. ENT_QUOTES Will convert both double and single
23969 *   quotes. ENT_NOQUOTES Will leave both double and single quotes
23970 *   unconverted.
23971 * @param string $charset The ISO-8859-1 character set is used as
23972 *   default for the optional third {@link charset}. This defines the
23973 *   character set used in conversion.
23974 * @return string
23975 * @since PHP 4 >= 4.3.0, PHP 5
23976 **/
23977function html_entity_decode($string, $quote_style, $charset){}
23978
23979/**
23980 * Build a cookie string from an array/object like returned by {@link
23981 * http_parse_cookie}.
23982 *
23983 * @param array $cookie a cookie list like returned from {@link
23984 *   http_parse_cookie}
23985 * @return string
23986 * @since PECL pecl_http >= 1.2.0
23987 **/
23988function http_build_cookie($cookie){}
23989
23990/**
23991 * Generates a URL-encoded query string from the associative (or indexed)
23992 * array provided.
23993 *
23994 * @param array $formdata May be an array or object containing
23995 *   properties. The array form may be a simple one-dimensional
23996 *   structure, or an array of arrays (who in turn may contain other
23997 *   arrays).
23998 * @param string $numeric_prefix If numeric indices are used in the
23999 *   base array and this parameter is provided, it will be prepended to
24000 *   the numeric index for elements in the base array only. This is meant
24001 *   to allow for legal variable names when the data is decoded by PHP or
24002 *   another CGI application later on.
24003 * @param string $arg_separator arg_separator.output is used to
24004 *   separate arguments, unless this parameter is specified, and is then
24005 *   used.
24006 * @return string
24007 * @since PHP 5
24008 **/
24009function http_build_query($formdata, $numeric_prefix, $arg_separator){}
24010
24011/**
24012 * Opponent to parse_str().
24013 *
24014 * @param array $query associative array of query string parameters
24015 * @param string $prefix top level prefix
24016 * @param string $arg_separator argument separator to use (by default
24017 *   the INI setting arg_separator.output will be used, or & if neither
24018 *   is set
24019 * @return string
24020 * @since PECL pecl_http >= 0.23.0
24021 **/
24022function http_build_str($query, $prefix, $arg_separator){}
24023
24024/**
24025 * Build a URL.
24026 *
24027 * The parts of the second URL will be merged into the first according to
24028 * the flags argument.
24029 *
24030 * @param mixed $url (part(s) of) an URL in form of a string or
24031 *   associative array like {@link parse_url} returns
24032 * @param mixed $parts same as the first argument
24033 * @param int $flags a bitmask of binary or'ed HTTP_URL constants;
24034 *   HTTP_URL_REPLACE is the default
24035 * @param array $new_url if set, it will be filled with the parts of
24036 *   the composed url like {@link parse_url} would return
24037 * @return string
24038 * @since PECL pecl_http >= 0.21.0
24039 **/
24040function http_build_url($url, $parts, $flags, &$new_url){}
24041
24042/**
24043 * Attempts to cache the sent entity by its ETag, either supplied or
24044 * generated by the hash algorithm specified by the http.etag.mode.
24045 *
24046 * If the clients If-None-Match header matches the supplied/calculated
24047 * ETag, the body is considered cached on the clients side and a 304 Not
24048 * Modified status code is issued.
24049 *
24050 * A log entry is written to the cache log if the http.log.cache is set
24051 * and the cache attempt was successful.
24052 *
24053 * If this function is used outside the http_send_*() API, it facilitates
24054 * the {@link ob_etaghandler}.
24055 *
24056 * @param string $etag custom ETag
24057 * @return bool
24058 * @since PECL pecl_http >= 0.1.0
24059 **/
24060function http_cache_etag($etag){}
24061
24062/**
24063 * Attempts to cache the sent entity by its last modification date.
24064 *
24065 * If the supplied argument is greater than 0, it is handled as timestamp
24066 * and will be sent as date of last modification. If it is 0 or omitted,
24067 * the current time will be sent as Last-Modified date. If it's negative,
24068 * it is handled as expiration time in seconds, which means that if the
24069 * requested last modification date is not between the calculated
24070 * timespan, the Last-Modified header is updated and the actual body will
24071 * be sent.
24072 *
24073 * A log entry will be written to the cache log if the http.log.cache is
24074 * set and the cache attempt was successful.
24075 *
24076 * @param int $timestamp_or_expires Unix timestamp
24077 * @return bool
24078 * @since PECL pecl_http >= 0.1.0
24079 **/
24080function http_cache_last_modified($timestamp_or_expires){}
24081
24082/**
24083 * Decodes a string which is HTTP-chunked encoded.
24084 *
24085 * @param string $encoded chunked encoded string
24086 * @return string
24087 * @since PECL pecl_http >= 0.1.0
24088 **/
24089function http_chunked_decode($encoded){}
24090
24091/**
24092 * Compose a valid HTTP date regarding RFC 1123 looking like: Wed, 22 Dec
24093 * 2004 11:34:47 GMT.
24094 *
24095 * @param int $timestamp Unix timestamp; current time if omitted
24096 * @return string
24097 * @since PECL pecl_http >= 0.1.0
24098 **/
24099function http_date($timestamp){}
24100
24101/**
24102 * Compress data with gzip, zlib AKA deflate or raw deflate encoding.
24103 *
24104 * See the deflate constants table for possible values for the flags
24105 * parameter.
24106 *
24107 * @param string $data String containing the data that should be
24108 *   encoded
24109 * @param int $flags deflate options
24110 * @return string
24111 * @since PECL pecl_http >= 0.15.0
24112 **/
24113function http_deflate($data, $flags){}
24114
24115/**
24116 * Performs an HTTP GET request on the supplied url.
24117 *
24118 * @param string $url URL
24119 * @param array $options
24120 * @param array $info Will be filled with request/response information
24121 * @return string
24122 * @since PECL pecl_http >= 0.1.0
24123 **/
24124function http_get($url, $options, &$info){}
24125
24126/**
24127 * Get the raw request body (e.g. POST or PUT data).
24128 *
24129 * This function can not be used after {@link
24130 * http_get_request_body_stream} if the request method was another than
24131 * POST.
24132 *
24133 * @return string
24134 * @since PECL pecl_http >= 0.10.0
24135 **/
24136function http_get_request_body(){}
24137
24138/**
24139 * Create a stream to read the raw request body (e.g. POST or PUT data).
24140 *
24141 * This function can only be used once if the request method was another
24142 * than POST.
24143 *
24144 * @return resource
24145 * @since PECL pecl_http >= 0.22.0
24146 **/
24147function http_get_request_body_stream(){}
24148
24149/**
24150 * Get a list of incoming HTTP headers.
24151 *
24152 * @return array
24153 * @since PECL pecl_http >= 0.10.0
24154 **/
24155function http_get_request_headers(){}
24156
24157/**
24158 * Performs an HTTP HEAD request on the supplied url.
24159 *
24160 * @param string $url URL
24161 * @param array $options
24162 * @param array $info
24163 * @return string
24164 * @since PECL pecl_http >= 0.1.0
24165 **/
24166function http_head($url, $options, &$info){}
24167
24168/**
24169 * Decompress data compressed with either gzip, deflate AKA zlib or raw
24170 * deflate encoding.
24171 *
24172 * @param string $data string containing the compressed data
24173 * @return string
24174 * @since PECL pecl_http >= 0.15.0
24175 **/
24176function http_inflate($data){}
24177
24178/**
24179 * Matches the given ETag against the clients If-Match resp.
24180 * If-None-Match HTTP headers.
24181 *
24182 * @param string $etag the ETag to match
24183 * @param bool $for_range if set to , the header usually used to
24184 *   validate HTTP ranges will be checked
24185 * @return bool
24186 * @since PECL pecl_http >= 0.1.0
24187 **/
24188function http_match_etag($etag, $for_range){}
24189
24190/**
24191 * Matches the given Unix timestamp against the clients If-Modified-Since
24192 * resp. If-Unmodified-Since HTTP headers.
24193 *
24194 * @param int $timestamp Unix timestamp; current time, if omitted
24195 * @param bool $for_range if set to , the header usually used to
24196 *   validate HTTP ranges will be checked
24197 * @return bool
24198 * @since PECL pecl_http >= 0.1.0
24199 **/
24200function http_match_modified($timestamp, $for_range){}
24201
24202/**
24203 * Match an incoming HTTP header.
24204 *
24205 * @param string $header the header name (case-insensitive)
24206 * @param string $value the header value that should be compared
24207 * @param bool $match_case whether the value should be compared case
24208 *   sensitively
24209 * @return bool
24210 * @since PECL pecl_http >= 0.10.0
24211 **/
24212function http_match_request_header($header, $value, $match_case){}
24213
24214/**
24215 * This function negotiates the clients preferred charset based on its
24216 * Accept-Charset HTTP header. The qualifier is recognized and charsets
24217 * without qualifier are rated highest.
24218 *
24219 * @param array $supported array containing the supported charsets as
24220 *   values
24221 * @param array $result will be filled with an array containing the
24222 *   negotiation results
24223 * @return string
24224 * @since PECL pecl_http >= 0.1.0
24225 **/
24226function http_negotiate_charset($supported, &$result){}
24227
24228/**
24229 * This function negotiates the clients preferred content type based on
24230 * its Accept HTTP header. The qualifier is recognized and content types
24231 * without qualifier are rated highest.
24232 *
24233 * @param array $supported array containing the supported content types
24234 *   as values
24235 * @param array $result will be filled with an array containing the
24236 *   negotiation results
24237 * @return string
24238 * @since PECL pecl_http >= 0.19.0
24239 **/
24240function http_negotiate_content_type($supported, &$result){}
24241
24242/**
24243 * This function negotiates the clients preferred language based on its
24244 * Accept-Language HTTP header. The qualifier is recognized and languages
24245 * without qualifier are rated highest. The qualifier will be decreased
24246 * by 10% for partial matches (i.e. matching primary language).
24247 *
24248 * @param array $supported array containing the supported languages as
24249 *   values
24250 * @param array $result will be filled with an array containing the
24251 *   negotiation results
24252 * @return string
24253 * @since PECL pecl_http >= 0.1.0
24254 **/
24255function http_negotiate_language($supported, &$result){}
24256
24257/**
24258 * Parses HTTP cookies like sent in a response into a struct.
24259 *
24260 * @param string $cookie string containing the value of a Set-Cookie
24261 *   response header
24262 * @param int $flags parse flags (HTTP_COOKIE_PARSE_RAW)
24263 * @param array $allowed_extras array containing recognized extra keys;
24264 *   by default all unknown keys will be treated as cookie names
24265 * @return object
24266 * @since PECL pecl_http >= 0.20.0
24267 **/
24268function http_parse_cookie($cookie, $flags, $allowed_extras){}
24269
24270/**
24271 * Parses HTTP headers into an associative array.
24272 *
24273 * @param string $header string containing HTTP headers
24274 * @return array
24275 * @since PECL pecl_http >= 0.10.0
24276 **/
24277function http_parse_headers($header){}
24278
24279/**
24280 * Parses the HTTP {@link message} into a simple recursive object.
24281 *
24282 * @param string $message string containing a single HTTP message or
24283 *   several consecutive HTTP messages
24284 * @return object
24285 * @since PECL pecl_http >= 0.12.0
24286 **/
24287function http_parse_message($message){}
24288
24289/**
24290 * Parse parameter list.
24291 *
24292 * See the params parsing constants table for possible values of the
24293 * {@link flags} argument.
24294 *
24295 * @param string $param Parameters
24296 * @param int $flags Parse flags
24297 * @return object
24298 * @since PECL pecl_http >= 1.0.0
24299 **/
24300function http_parse_params($param, $flags){}
24301
24302/**
24303 * Clean up (close) persistent handles, optionally identified with ident.
24304 *
24305 * @param string $ident the identification string
24306 * @return string
24307 * @since PECL pecl_http >= 1.5.0
24308 **/
24309function http_persistent_handles_clean($ident){}
24310
24311/**
24312 * List statistics about persistent handles usage.
24313 *
24314 * @return object
24315 * @since PECL pecl_http >= 1.5.0
24316 **/
24317function http_persistent_handles_count(){}
24318
24319/**
24320 * Query or define the ident of persistent handles.
24321 *
24322 * @param string $ident the identification string
24323 * @return string
24324 * @since PECL pecl_http >= 1.5.0
24325 **/
24326function http_persistent_handles_ident($ident){}
24327
24328/**
24329 * Performs an HTTP POST request on the supplied url.
24330 *
24331 * @param string $url URL
24332 * @param string $data String containing the pre-encoded post data
24333 * @param array $options
24334 * @param array $info
24335 * @return string
24336 * @since PECL pecl_http >= 0.1.0
24337 **/
24338function http_post_data($url, $data, $options, &$info){}
24339
24340/**
24341 * Performs an HTTP POST request on the supplied url.
24342 *
24343 * @param string $url URL
24344 * @param array $data Associative array of POST values
24345 * @param array $files Array of files to post
24346 * @param array $options
24347 * @param array $info
24348 * @return string
24349 * @since PECL pecl_http >= 0.10.0
24350 **/
24351function http_post_fields($url, $data, $files, $options, &$info){}
24352
24353/**
24354 * Performs an HTTP PUT request on the supplied url.
24355 *
24356 * @param string $url URL
24357 * @param string $data PUT request body
24358 * @param array $options
24359 * @param array $info
24360 * @return string
24361 * @since PECL pecl_http >= 0.25.0
24362 **/
24363function http_put_data($url, $data, $options, &$info){}
24364
24365/**
24366 * Performs an HTTP PUT request on the supplied url.
24367 *
24368 * @param string $url URL
24369 * @param string $file The file to put
24370 * @param array $options
24371 * @param array $info
24372 * @return string
24373 * @since PECL pecl_http >= 0.10.0
24374 **/
24375function http_put_file($url, $file, $options, &$info){}
24376
24377/**
24378 * Performs an HTTP PUT request on the supplied url.
24379 *
24380 * @param string $url URL
24381 * @param resource $stream The stream to read the PUT request body from
24382 * @param array $options
24383 * @param array $info
24384 * @return string
24385 * @since PECL pecl_http >= 0.10.0
24386 **/
24387function http_put_stream($url, $stream, $options, &$info){}
24388
24389/**
24390 * Redirect to the given url.
24391 *
24392 * The supplied {@link url} will be expanded with {@link http_build_url},
24393 * the {@link params} array will be treated with {@link http_build_str}
24394 * and the session identification will be appended if {@link session} is
24395 * true. The HTTP response code will be set according to {@link status}.
24396 * You can use one of the redirect constants for convenience. Please see
24397 * RFC 2616 for which redirect response code to use in which situation.
24398 * By default PHP will decide which response status fits best.
24399 *
24400 * To be RFC compliant, Redirecting to <a>URL</a>. will be displayed, if
24401 * the client doesn't redirect immediately, and the request method was
24402 * another one than HEAD.
24403 *
24404 * A log entry will be written to the redirect log, if the
24405 * http.log.redirect is set and the redirect attempt was successful.
24406 *
24407 * @param string $url the URL to redirect to
24408 * @param array $params associative array of query parameters
24409 * @param bool $session whether to append session information
24410 * @param int $status custom response status code
24411 * @return void
24412 * @since PECL pecl_http >= 0.1.0
24413 **/
24414function http_redirect($url, $params, $session, $status){}
24415
24416/**
24417 * Performs a custom HTTP request on the supplied url.
24418 *
24419 * @param int $method Request method
24420 * @param string $url URL
24421 * @param string $body Request body
24422 * @param array $options
24423 * @param array $info
24424 * @return string
24425 * @since PECL pecl_http >= 1.0.0
24426 **/
24427function http_request($method, $url, $body, $options, &$info){}
24428
24429/**
24430 * Generate x-www-form-urlencoded resp. form-data encoded request body.
24431 *
24432 * @param array $fields POST fields
24433 * @param array $files POST files
24434 * @return string
24435 * @since PECL pecl_http >= 1.0.0
24436 **/
24437function http_request_body_encode($fields, $files){}
24438
24439/**
24440 * Check if a request method is registered (or available by default).
24441 *
24442 * @param mixed $method request method name or ID
24443 * @return int
24444 * @since PECL pecl_http >= 0.10.0
24445 **/
24446function http_request_method_exists($method){}
24447
24448/**
24449 * Get the literal string representation of a standard or registered
24450 * request method.
24451 *
24452 * @param int $method request method ID
24453 * @return string
24454 * @since PECL pecl_http >= 0.10.0
24455 **/
24456function http_request_method_name($method){}
24457
24458/**
24459 * Register a custom request method.
24460 *
24461 * @param string $method the request method name to register
24462 * @return int
24463 * @since PECL pecl_http >= 0.10.0
24464 **/
24465function http_request_method_register($method){}
24466
24467/**
24468 * Unregister a previously registered custom request method.
24469 *
24470 * @param mixed $method The request method name or ID
24471 * @return bool
24472 * @since PECL pecl_http >= 0.10.0
24473 **/
24474function http_request_method_unregister($method){}
24475
24476/**
24477 * Send the Content-Disposition.
24478 *
24479 * @param string $filename the file name the Save as... dialog should
24480 *   display
24481 * @param bool $inline if set to and the user agent knows how to handle
24482 *   the content type, it will probably not cause the popup window to be
24483 *   shown
24484 * @return bool
24485 * @since PECL pecl_http >= 0.10.0
24486 **/
24487function http_send_content_disposition($filename, $inline){}
24488
24489/**
24490 * Send the Content-Type of the sent entity.
24491 *
24492 * @param string $content_type the desired content type
24493 *   (primary/secondary)
24494 * @return bool
24495 * @since PECL pecl_http >= 0.10.0
24496 **/
24497function http_send_content_type($content_type){}
24498
24499/**
24500 * Sends raw data with support for (multiple) range requests.
24501 *
24502 * @param string $data data to send
24503 * @return bool
24504 * @since PECL pecl_http >= 0.1.0
24505 **/
24506function http_send_data($data){}
24507
24508/**
24509 * Sends a file with support for (multiple) range requests.
24510 *
24511 * This functions behaviour and further action is dependent on the
24512 * following s: http.send.not_found_404 http.log.not_found.
24513 *
24514 * If the http.send.not_found_404 is enabled and the http.log.not_found
24515 * points to a writable file, a log message is written when the {@link
24516 * file} was not found.
24517 *
24518 * @param string $file the file to send
24519 * @return bool
24520 * @since PECL pecl_http >= 0.1.0
24521 **/
24522function http_send_file($file){}
24523
24524/**
24525 * Send a Last-Modified header with a valid HTTP date.
24526 *
24527 * @param int $timestamp a Unix timestamp, converted to a valid HTTP
24528 *   date; if omitted, the current time will be sent
24529 * @return bool
24530 * @since PECL pecl_http >= 0.1.0
24531 **/
24532function http_send_last_modified($timestamp){}
24533
24534/**
24535 * Send HTTP status code.
24536 *
24537 * @param int $status HTTP status code (100-599)
24538 * @return bool
24539 * @since PECL pecl_http >= 0.1.0
24540 **/
24541function http_send_status($status){}
24542
24543/**
24544 * Sends an already opened stream with support for (multiple) range
24545 * requests.
24546 *
24547 * @param resource $stream stream to read from (must be seekable)
24548 * @return bool
24549 * @since PECL pecl_http >= 0.1.0
24550 **/
24551function http_send_stream($stream){}
24552
24553/**
24554 * Check for features that require external libraries.
24555 *
24556 * See the feature support constants table for possible values for the
24557 * {@link feature} argument.
24558 *
24559 * @param int $feature feature to probe for
24560 * @return int
24561 * @since PECL pecl_http >= 0.15.0
24562 **/
24563function http_support($feature){}
24564
24565/**
24566 * Sets the throttle delay and send buffer size.
24567 *
24568 * @param float $sec seconds to sleep after each chunk sent
24569 * @param int $bytes the chunk size in bytes
24570 * @return void
24571 * @since PECL pecl_http >= 0.10.0
24572 **/
24573function http_throttle($sec, $bytes){}
24574
24575/**
24576 * Opens a connection to the Hyperwave server on host {@link hostname}.
24577 * The protocol used is HGCSP.
24578 *
24579 * @param string $hostname The host name.
24580 * @param int $port If you do not pass a port number, 418 is used.
24581 * @return HW_API
24582 * @since PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN
24583 **/
24584function hwapi_hgcsp($hostname, $port){}
24585
24586/**
24587 * Creates a new instance of hw_api_attribute with the given name and
24588 * value.
24589 *
24590 * @param string $name The attribute name.
24591 * @param string $value The attribute value.
24592 * @return HW_API_Attribute
24593 * @since PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN
24594 **/
24595function hw_api_attribute($name, $value){}
24596
24597/**
24598 * Creates a new content object from the string {@link content}.
24599 *
24600 * @param string $content
24601 * @param string $mimetype The mimetype for the contents.
24602 * @return HW_API_Content
24603 * @since PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN
24604 **/
24605function hw_api_content($content, $mimetype){}
24606
24607/**
24608 * Creates a new instance of the class hw_api_object.
24609 *
24610 * @param array $parameter
24611 * @return hw_api_object
24612 * @since PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN
24613 **/
24614function hw_api_object($parameter){}
24615
24616/**
24617 * Converts an {@link object_array} into an object record. Multiple
24618 * attributes like 'Title' in different languages are treated properly.
24619 *
24620 * @param array $object_array The array.
24621 * @return string
24622 * @since PHP 4
24623 **/
24624function hw_array2objrec($object_array){}
24625
24626/**
24627 * @param int $link
24628 * @param int $objid
24629 * @param array $attributes
24630 * @return bool
24631 * @since PHP 4
24632 **/
24633function hw_changeobject($link, $objid, $attributes){}
24634
24635/**
24636 * Returns the identifiers of the collection children.
24637 *
24638 * @param int $connection The connection identifier.
24639 * @param int $objectID The object identifier.
24640 * @return array
24641 * @since PHP 4
24642 **/
24643function hw_children($connection, $objectID){}
24644
24645/**
24646 * Returns the object records of the collection children.
24647 *
24648 * @param int $connection The connection identifier.
24649 * @param int $objectID The object identifier.
24650 * @return array
24651 * @since PHP 4
24652 **/
24653function hw_childrenobj($connection, $objectID){}
24654
24655/**
24656 * Closes down the connection to a Hyperwave server.
24657 *
24658 * @param int $connection The connection identifier.
24659 * @return bool
24660 * @since PHP 4
24661 **/
24662function hw_close($connection){}
24663
24664/**
24665 * Opens a connection to a Hyperwave server. You can have multiple
24666 * connections open at once.
24667 *
24668 * @param string $host The server host name.
24669 * @param int $port The server port number.
24670 * @param string $username The Hyperwave user name. If omitted, no
24671 *   identification with the server will be done. It is similar to
24672 *   identify as user anonymous.
24673 * @param string $password The password for {@link username}. Keep in
24674 *   mind, that the password is not encrypted.
24675 * @return int
24676 * @since PHP 4
24677 **/
24678function hw_connect($host, $port, $username, $password){}
24679
24680/**
24681 * @param int $link
24682 * @return void
24683 * @since PHP 4
24684 **/
24685function hw_connection_info($link){}
24686
24687/**
24688 * Copies the objects with object ids as specified in the second
24689 * parameter to the collection with the id {@link destination id}.
24690 *
24691 * @param int $connection The connection identifier.
24692 * @param array $object_id_array An array of object ids.
24693 * @param int $destination_id The target collection id.
24694 * @return int
24695 * @since PHP 4
24696 **/
24697function hw_cp($connection, $object_id_array, $destination_id){}
24698
24699/**
24700 * Deletes the object with the given object id in the second parameter.
24701 * It will delete all instances of the object.
24702 *
24703 * @param int $connection The connection identifier.
24704 * @param int $object_to_delete The object identifier.
24705 * @return bool
24706 * @since PHP 4
24707 **/
24708function hw_deleteobject($connection, $object_to_delete){}
24709
24710/**
24711 * Returns an th object id of the document to which {@link anchorID}
24712 * belongs.
24713 *
24714 * @param int $connection The connection identifier.
24715 * @param int $anchorID The anchor identifier.
24716 * @return int
24717 * @since PHP 4
24718 **/
24719function hw_docbyanchor($connection, $anchorID){}
24720
24721/**
24722 * Returns an th object record of the document to which {@link anchorID}
24723 * belongs.
24724 *
24725 * @param int $connection The connection identifier.
24726 * @param int $anchorID The anchor identifier.
24727 * @return string
24728 * @since PHP 4
24729 **/
24730function hw_docbyanchorobj($connection, $anchorID){}
24731
24732/**
24733 * Returns the object record of the document.
24734 *
24735 * For backward compatibility, {@link hw_documentattributes} is also
24736 * accepted. This is deprecated, however.
24737 *
24738 * @param int $hw_document The document identifier.
24739 * @return string
24740 * @since PHP 4
24741 **/
24742function hw_document_attributes($hw_document){}
24743
24744/**
24745 * Returns the BODY tag of the document. If the document is an HTML
24746 * document the BODY tag should be printed before the document.
24747 *
24748 * For backward compatibility, {@link hw_documentbodytag} is also
24749 * accepted. This is deprecated, however.
24750 *
24751 * @param int $hw_document The document identifier.
24752 * @param string $prefix
24753 * @return string
24754 * @since PHP 4
24755 **/
24756function hw_document_bodytag($hw_document, $prefix){}
24757
24758/**
24759 * Gets the content of the document.
24760 *
24761 * @param int $hw_document The document identifier.
24762 * @return string
24763 * @since PHP 4
24764 **/
24765function hw_document_content($hw_document){}
24766
24767/**
24768 * Sets or replaces the content of the document. If the document is an
24769 * HTML document the content is everything after the BODY tag.
24770 * Information from the HEAD and BODY tag is in the stored in the object
24771 * record. If you provide this information in the content of the document
24772 * too, the Hyperwave server will change the object record accordingly
24773 * when the document is inserted. Probably not a very good idea. If this
24774 * functions fails the document will retain its old content.
24775 *
24776 * @param int $hw_document The document identifier.
24777 * @param string $content
24778 * @return bool
24779 * @since PHP 4
24780 **/
24781function hw_document_setcontent($hw_document, $content){}
24782
24783/**
24784 * Gets the size of the document.
24785 *
24786 * For backward compatibility, {@link hw_documentsize} is also accepted.
24787 * This is deprecated, however.
24788 *
24789 * @param int $hw_document The document identifier.
24790 * @return int
24791 * @since PHP 4
24792 **/
24793function hw_document_size($hw_document){}
24794
24795/**
24796 * @param int $link
24797 * @param int $id
24798 * @param int $msgid
24799 * @return string
24800 * @since PHP 4
24801 **/
24802function hw_dummy($link, $id, $msgid){}
24803
24804/**
24805 * Uploads the text document to the server. The object record of the
24806 * document may not be modified while the document is edited.
24807 *
24808 * This function will only works for pure text documents. It will not
24809 * open a special data connection and therefore blocks the control
24810 * connection during the transfer.
24811 *
24812 * @param int $connection The connection identifier.
24813 * @param int $hw_document The document identifier.
24814 * @return bool
24815 * @since PHP 4
24816 **/
24817function hw_edittext($connection, $hw_document){}
24818
24819/**
24820 * Returns the last error number, for the last command.
24821 *
24822 * @param int $connection The connection identifier.
24823 * @return int
24824 * @since PHP 4
24825 **/
24826function hw_error($connection){}
24827
24828/**
24829 * Returns a string containing the last error message related to the last
24830 * command.
24831 *
24832 * @param int $connection The connection identifier.
24833 * @return string
24834 * @since PHP 4
24835 **/
24836function hw_errormsg($connection){}
24837
24838/**
24839 * Frees the memory occupied by the Hyperwave document.
24840 *
24841 * @param int $hw_document The document identifier.
24842 * @return bool
24843 * @since PHP 4
24844 **/
24845function hw_free_document($hw_document){}
24846
24847/**
24848 * Returns an array of object ids with anchors of the specified document.
24849 *
24850 * @param int $connection The connection identifier.
24851 * @param int $objectID The document object id.
24852 * @return array
24853 * @since PHP 4
24854 **/
24855function hw_getanchors($connection, $objectID){}
24856
24857/**
24858 * Returns records with anchors of the document with object ID {@link
24859 * objectID}.
24860 *
24861 * @param int $connection The connection identifier.
24862 * @param int $objectID The object identifier.
24863 * @return array
24864 * @since PHP 4
24865 **/
24866function hw_getanchorsobj($connection, $objectID){}
24867
24868/**
24869 * Returns the object record for the object with ID {@link objectID}. It
24870 * will also lock the object, so other users cannot access it until it is
24871 * unlocked.
24872 *
24873 * @param int $connection The connection identifier.
24874 * @param int $objectID The object identifier.
24875 * @return string
24876 * @since PHP 4
24877 **/
24878function hw_getandlock($connection, $objectID){}
24879
24880/**
24881 * Returns object ids. Each object ID belongs to a child collection of
24882 * the collection with ID {@link objectID}. The function will not return
24883 * child documents.
24884 *
24885 * @param int $connection The connection identifier.
24886 * @param int $objectID The object identifier.
24887 * @return array
24888 * @since PHP 4
24889 **/
24890function hw_getchildcoll($connection, $objectID){}
24891
24892/**
24893 * Returns object records. Each object records belongs to a child
24894 * collection of the collection with ID {@link objectID}. The function
24895 * will not return child documents.
24896 *
24897 * @param int $connection The connection identifier.
24898 * @param int $objectID The object identifier.
24899 * @return array
24900 * @since PHP 4
24901 **/
24902function hw_getchildcollobj($connection, $objectID){}
24903
24904/**
24905 * Returns array of object ids for child documents of a collection.
24906 *
24907 * @param int $connection The connection identifier.
24908 * @param int $objectID The object identifier.
24909 * @return array
24910 * @since PHP 4
24911 **/
24912function hw_getchilddoccoll($connection, $objectID){}
24913
24914/**
24915 * Returns an array of object records for child documents of a
24916 * collection.
24917 *
24918 * @param int $connection The connection identifier.
24919 * @param int $objectID The object identifier.
24920 * @return array
24921 * @since PHP 4
24922 **/
24923function hw_getchilddoccollobj($connection, $objectID){}
24924
24925/**
24926 * Gets an object record. If the second parameter is an array of integer
24927 * the function will
24928 *
24929 * @param int $connection The connection identifier.
24930 * @param mixed $objectID The object identifier, or an array of
24931 *   identifiers.
24932 * @param string $query The query string has the following syntax:
24933 *
24934 *   <expr> ::= "(" <expr> ")" | "!" &lt;expr> | /* NOT * / <expr> "||"
24935 *   <expr> | /* OR * / <expr> "&amp;&amp;" <expr> | /* AND * /
24936 *   <attribute> <operator> <value>
24937 *
24938 *   <attribute> ::= /* any attribute name (Title, Author, DocumentType
24939 *   ...) * /
24940 *
24941 *   <operator> ::= "=" | /* equal * / "<" | /* less than (string
24942 *   compare) * / ">" | /* greater than (string compare) * / "~" /*
24943 *   regular expression matching * /
24944 *
24945 *   The query allows to further select certain objects from the list of
24946 *   given objects. Unlike the other query functions, this query may use
24947 *   not indexed attributes. How many object records are returned depends
24948 *   on the query and if access to the object is allowed.
24949 * @return mixed
24950 * @since PHP 4
24951 **/
24952function hw_getobject($connection, $objectID, $query){}
24953
24954/**
24955 * Searches for objects on the whole server and returns an array of
24956 * object ids.
24957 *
24958 * @param int $connection The connection identifier.
24959 * @param string $query The query will only work with indexed
24960 *   attributes.
24961 * @param int $max_hits The maximum number of matches is limited to
24962 *   {@link max_hits}. If {@link max_hits} is set to -1 the maximum
24963 *   number of matches is unlimited.
24964 * @return array
24965 * @since PHP 4
24966 **/
24967function hw_getobjectbyquery($connection, $query, $max_hits){}
24968
24969/**
24970 * Searches for objects in collection with ID {@link objectID} and
24971 * returns an array of object ids.
24972 *
24973 * @param int $connection The connection identifier.
24974 * @param int $objectID The collection id.
24975 * @param string $query The query will only work with indexed
24976 *   attributes.
24977 * @param int $max_hits The maximum number of matches is limited to
24978 *   {@link max_hits}. If {@link max_hits} is set to -1 the maximum
24979 *   number of matches is unlimited.
24980 * @return array
24981 * @since PHP 4
24982 **/
24983function hw_getobjectbyquerycoll($connection, $objectID, $query, $max_hits){}
24984
24985/**
24986 * Searches for objects in collection with ID {@link objectID} and
24987 * returns an array of object records.
24988 *
24989 * @param int $connection The connection identifier.
24990 * @param int $objectID The collection id.
24991 * @param string $query The query will only work with indexed
24992 *   attributes.
24993 * @param int $max_hits The maximum number of matches is limited to
24994 *   {@link max_hits}. If {@link max_hits} is set to -1 the maximum
24995 *   number of matches is unlimited.
24996 * @return array
24997 * @since PHP 4
24998 **/
24999function hw_getobjectbyquerycollobj($connection, $objectID, $query, $max_hits){}
25000
25001/**
25002 * Searches for objects on the whole server and returns an array of
25003 * object records.
25004 *
25005 * @param int $connection The connection identifier.
25006 * @param string $query The query will only work with indexed
25007 *   attributes.
25008 * @param int $max_hits The maximum number of matches is limited to
25009 *   {@link max_hits}. If {@link max_hits} is set to -1 the maximum
25010 *   number of matches is unlimited.
25011 * @return array
25012 * @since PHP 4
25013 **/
25014function hw_getobjectbyqueryobj($connection, $query, $max_hits){}
25015
25016/**
25017 * Returns the object identifiers of the parents of an object.
25018 *
25019 * @param int $connection The connection identifier.
25020 * @param int $objectID The object identifier.
25021 * @return array
25022 * @since PHP 4
25023 **/
25024function hw_getparents($connection, $objectID){}
25025
25026/**
25027 * Returns object records and statistical information about the object
25028 * records. Each object record belongs to a parent of the object with ID
25029 * {@link objectID}.
25030 *
25031 * @param int $connection The connection identifier.
25032 * @param int $objectID The object identifier.
25033 * @return array
25034 * @since PHP 4
25035 **/
25036function hw_getparentsobj($connection, $objectID){}
25037
25038/**
25039 * @param int $link
25040 * @param int $rootid
25041 * @param int $sourceid
25042 * @param int $destid
25043 * @return string
25044 * @since PHP 4
25045 **/
25046function hw_getrellink($link, $rootid, $sourceid, $destid){}
25047
25048/**
25049 * Gets a remote document.
25050 *
25051 * Remote documents in Hyperwave notation are documents retrieved from an
25052 * external source. Common remote documents are for example external web
25053 * pages or queries in a database.
25054 *
25055 * In order to be able to access external sources through remote
25056 * documents Hyperwave introduces the HGI (Hyperwave Gateway Interface)
25057 * which is similar to the CGI. Currently, only ftp, http-servers and
25058 * some databases can be accessed by the HGI.
25059 *
25060 * Calling {@link hw_getremote} returns the document from the external
25061 * source. If you want to use this function you should be very familiar
25062 * with HGIs. You should also consider to use PHP instead of Hyperwave to
25063 * access external sources. Adding database support by a Hyperwave
25064 * gateway should be more difficult than doing it in PHP.
25065 *
25066 * @param int $connection The connection identifier.
25067 * @param int $objectID The object identifier.
25068 * @return int
25069 * @since PHP 4
25070 **/
25071function hw_getremote($connection, $objectID){}
25072
25073/**
25074 * Returns the children of a remote document. Children of a remote
25075 * document are remote documents itself. This makes sense if a database
25076 * query has to be narrowed and is explained in Hyperwave Programmers'
25077 * Guide.
25078 *
25079 * If you want to use this function you should be very familiar with
25080 * HGIs. You should also consider to use PHP instead of Hyperwave to
25081 * access external sources. Adding database support by a Hyperwave
25082 * gateway should be more difficult than doing it in PHP.
25083 *
25084 * @param int $connection The connection identifier.
25085 * @param string $object_record The object record.
25086 * @return mixed
25087 * @since PHP 4
25088 **/
25089function hw_getremotechildren($connection, $object_record){}
25090
25091/**
25092 * Gets the object records of all anchors pointing to the object with ID
25093 * {@link objectID}.
25094 *
25095 * @param int $connection The connection identifier.
25096 * @param int $objectID The object identifier. The object can either be
25097 *   a document or an anchor of type destination.
25098 * @return array
25099 * @since PHP 4
25100 **/
25101function hw_getsrcbydestobj($connection, $objectID){}
25102
25103/**
25104 * Returns the document with object ID {@link objectID}. If the document
25105 * has anchors which can be inserted, they will be inserted already.
25106 *
25107 * This function will only work for pure text documents. It will not open
25108 * a special data connection and therefore blocks the control connection
25109 * during the transfer.
25110 *
25111 * @param int $connection The connection identifier.
25112 * @param int $objectID The object identifier.
25113 * @param mixed $rootIDprefix The optional parameter {@link
25114 *   rootID/prefix} can be a string or an integer. If it is an integer it
25115 *   determines how links are inserted into the document. The default is
25116 *   0 and will result in links that are constructed from the name of the
25117 *   link's destination object. This is useful for web applications. If a
25118 *   link points to an object with name 'internet_movie' the HTML link
25119 *   will be <A href="/internet_movie">. The actual location of the
25120 *   source and destination object in the document hierarchy is
25121 *   disregarded. You will have to set up your web browser, to rewrite
25122 *   that URL to for example '/my_script.php/internet_movie'.
25123 *   'my_script.php' will have to evaluate $PATH_INFO and retrieve the
25124 *   document. All links will have the prefix '/my_script.php/'. If you
25125 *   do not want this you can set the optional parameter {@link
25126 *   rootID/prefix} to any prefix which is used instead. Is this case it
25127 *   has to be a string. If {@link rootID/prefix} is an integer and
25128 *   unequal to 0 the link is constructed from all the names starting at
25129 *   the object with the id {@link rootID/prefix} separated by a slash
25130 *   relative to the current object. If for example the above document
25131 *   'internet_movie' is located at 'a-b-c-internet_movie' with '-' being
25132 *   the separator between hierarchy levels on the Hyperwave server and
25133 *   the source document is located at 'a-b-d-source' the resulting HTML
25134 *   link would be: <A HREF="../c/internet_movie">. This is useful if you
25135 *   want to download the whole server content onto disk and map the
25136 *   document hierarchy onto the file system.
25137 * @return int
25138 * @since PHP 4
25139 **/
25140function hw_gettext($connection, $objectID, $rootIDprefix){}
25141
25142/**
25143 * Returns the username of the connection.
25144 *
25145 * @param int $connection The connection identifier.
25146 * @return string
25147 * @since PHP 4
25148 **/
25149function hw_getusername($connection){}
25150
25151/**
25152 * Identifies as user with {@link username} and {@link password}.
25153 * Identification is only valid for the current session. I do not think
25154 * this function will be needed very often. In most cases it will be
25155 * easier to identify with the opening of the connection.
25156 *
25157 * @param int $link The connection identifier.
25158 * @param string $username The username.
25159 * @param string $password The password.
25160 * @return string
25161 * @since PHP 4
25162 **/
25163function hw_identify($link, $username, $password){}
25164
25165/**
25166 * Checks whether a set of objects (documents or collections) specified
25167 * by the {@link object_id_array} is part of the collections listed in
25168 * {@link collection_id_array}.
25169 *
25170 * @param int $connection The connection identifier.
25171 * @param array $object_id_array An array of object ids.
25172 * @param array $collection_id_array An array of collection ids.
25173 * @param int $return_collections When set to 0, the subset of object
25174 *   ids that is part of the collections (i.e., the documents or
25175 *   collections that are children of one or more collections of
25176 *   collection ids or their subcollections, recursively) is returned as
25177 *   an array. When set to 1, the set of collections that have one or
25178 *   more objects of this subset as children are returned as an array.
25179 *   This option allows a client to, e.g., highlight the part of the
25180 *   collection hierarchy that contains the matches of a previous query,
25181 *   in a graphical overview.
25182 * @return array
25183 * @since PHP 4
25184 **/
25185function hw_incollections($connection, $object_id_array, $collection_id_array, $return_collections){}
25186
25187/**
25188 * Returns information about the current connection.
25189 *
25190 * @param int $connection The connection identifier.
25191 * @return string
25192 * @since PHP 4
25193 **/
25194function hw_info($connection){}
25195
25196/**
25197 * Inserts a new collection with attributes as in {@link object_array}
25198 * into collection with object ID {@link objectID}.
25199 *
25200 * @param int $connection The connection identifier.
25201 * @param int $objectID
25202 * @param array $object_array
25203 * @return int
25204 * @since PHP 4
25205 **/
25206function hw_inscoll($connection, $objectID, $object_array){}
25207
25208/**
25209 * Inserts a new document with attributes as in {@link object_record}
25210 * into acollection.
25211 *
25212 * If you want to insert a general document of any kind use {@link
25213 * hw_insertdocument} instead.
25214 *
25215 * @param resource $connection The connection identifier.
25216 * @param int $parentID The collection id.
25217 * @param string $object_record Object attributes.
25218 * @param string $text If provided, this ascii text will be inserted
25219 *   too.
25220 * @return int
25221 * @since PHP 4
25222 **/
25223function hw_insdoc($connection, $parentID, $object_record, $text){}
25224
25225/**
25226 * @param int $hwdoc
25227 * @param array $anchorecs
25228 * @param array $dest
25229 * @param array $urlprefixes
25230 * @return bool
25231 * @since PHP 4 >= 4.0.4
25232 **/
25233function hw_insertanchors($hwdoc, $anchorecs, $dest, $urlprefixes){}
25234
25235/**
25236 * Uploads a document into the given collection.
25237 *
25238 * The document has to be created before with {@link hw_new_document}.
25239 * Make sure that the object record of the new document contains at least
25240 * the attributes: Type, DocumentType, Title and Name. Possibly you also
25241 * want to set the MimeType.
25242 *
25243 * @param int $connection The connection identifier.
25244 * @param int $parent_id The collection identifier.
25245 * @param int $hw_document The document identifier.
25246 * @return int
25247 * @since PHP 4
25248 **/
25249function hw_insertdocument($connection, $parent_id, $hw_document){}
25250
25251/**
25252 * Inserts an object into the server.
25253 *
25254 * Note: If you want to insert an Anchor, the attribute Position has
25255 * always been set either to a start/end value or to 'invisible'.
25256 * Invisible positions are needed if the annotation has no corresponding
25257 * link in the annotation text.
25258 *
25259 * @param int $connection The connection identifier.
25260 * @param string $object_rec The object can be any valid hyperwave
25261 *   object.
25262 * @param string $parameter See the HG-CSP documentation for a detailed
25263 *   information on how the parameters have to be.
25264 * @return int
25265 * @since PHP 4
25266 **/
25267function hw_insertobject($connection, $object_rec, $parameter){}
25268
25269/**
25270 * Maps a global object id on any hyperwave server, even those you did
25271 * not connect to with {@link hw_connect}, onto a virtual object id.
25272 *
25273 * This virtual object id can then be used as any other object id, e.g.
25274 * to obtain the object record with {@link hw_getobject}.
25275 *
25276 * Note: In order to use this function you will have to set the
25277 * F_DISTRIBUTED flag, which can currently only be set at compile time in
25278 * hg_comm.c. It is not set by default. Read the comment at the beginning
25279 * of hg_comm.c
25280 *
25281 * @param int $connection The connection identifier.
25282 * @param int $server_id The server id is the first part of the global
25283 *   object id (GOid) of the object which is actually the IP number as an
25284 *   integer.
25285 * @param int $object_id The object identifier.
25286 * @return int
25287 * @since PHP 4
25288 **/
25289function hw_mapid($connection, $server_id, $object_id){}
25290
25291/**
25292 * This command allows to remove, add, or modify individual attributes of
25293 * an object record. The object is specified by the Object ID {@link
25294 * object_to_change}. In order to modify an attribute one will have to
25295 * remove the old one and add a new one. {@link hw_modifyobject} will
25296 * always remove the attributes before it adds attributes unless the
25297 * value of the attribute to remove is not a string or array.
25298 *
25299 * The keys of both arrays are the attributes name. The value of each
25300 * array element can either be an array, a string or anything else. If it
25301 * is an array each attribute value is constructed by the key of each
25302 * element plus a colon and the value of each element. If it is a string
25303 * it is taken as the attribute value. An empty string will result in a
25304 * complete removal of that attribute. If the value is neither a string
25305 * nor an array but something else, e.g. an integer, no operation at all
25306 * will be performed on the attribute. This is necessary if you want to
25307 * add a completely new attribute not just a new value for an existing
25308 * attribute. If the remove array contained an empty string for that
25309 * attribute, the attribute would be tried to be removed which would fail
25310 * since it doesn't exist. The following addition of a new value for that
25311 * attribute would also fail. Setting the value for that attribute to
25312 * e.g. 0 would not even try to remove it and the addition will work.
25313 *
25314 * If you would like to change the attribute 'Name' with the current
25315 * value 'books' into 'articles' you will have to create two arrays and
25316 * call {@link hw_modifyobject}. modifying an attribute
25317 *
25318 * <?php // $connect is an existing connection to the Hyperwave server //
25319 * $objid is the ID of the object to modify $remarr = array("Name" =>
25320 * "books"); $addarr = array("Name" => "articles");
25321 * $hw_modifyobject($connect, $objid, $remarr, $addarr); ?>
25322 *
25323 * In order to delete/add a name=value pair from/to the object record
25324 * just pass the remove/add array and set the last/third parameter to an
25325 * empty array. If the attribute is the first one with that name to add,
25326 * set attribute value in the remove array to an integer. adding a
25327 * completely new attribute
25328 *
25329 * <?php // $connect is an existing connection to the Hyperwave server //
25330 * $objid is the ID of the object to modify $remarr = array("Name" => 0);
25331 * $addarr = array("Name" => "articles"); $hw_modifyobject($connect,
25332 * $objid, $remarr, $addarr); ?>
25333 *
25334 * Multilingual attributes, e.g. 'Title', can be modified in two ways.
25335 * Either by providing the attributes value in its native form
25336 * 'language':'title' or by providing an array with elements for each
25337 * language as described above. The above example would than be:
25338 * modifying Title attribute
25339 *
25340 * <?php $remarr = array("Title" => "en:Books"); $addarr = array("Title"
25341 * => "en:Articles"); $hw_modifyobject($connect, $objid, $remarr,
25342 * $addarr); ?>
25343 *
25344 * or modifying Title attribute
25345 *
25346 * <?php $remarr = array("Title" => array("en" => "Books")); $addarr =
25347 * array("Title" => array("en" => "Articles", "ge"=>"Artikel"));
25348 * $hw_modifyobject($connect, $objid, $remarr, $addarr); ?>
25349 *
25350 * This removes the English title 'Books' and adds the English title
25351 * 'Articles' and the German title 'Artikel'. removing attribute
25352 *
25353 * <?php $remarr = array("Title" => ""); $addarr = array("Title" =>
25354 * "en:Articles"); $hw_modifyobject($connect, $objid, $remarr, $addarr);
25355 * ?>
25356 *
25357 * This will remove all attributes with the name 'Title' and adds a new
25358 * 'Title' attribute. This comes in handy if you want to remove
25359 * attributes recursively. If you need to delete all attributes with a
25360 * certain name you will have to pass an empty string as the attribute
25361 * value. Only the attributes 'Title', 'Description' and 'Keyword' will
25362 * properly handle the language prefix. If those attributes don't carry a
25363 * language prefix, the prefix 'xx' will be assigned. The 'Name'
25364 * attribute is somewhat special. In some cases it cannot be complete
25365 * removed. You will get an error message 'Change of base attribute' (not
25366 * clear when this happens). Therefore you will always have to add a new
25367 * Name first and than remove the old one. You may not surround this
25368 * function by calls to {@link hw_getandlock} and {@link hw_unlock}.
25369 * {@link hw_modifyobject} does this internally.
25370 *
25371 * @param int $connection The connection identifier.
25372 * @param int $object_to_change The object to be changed.
25373 * @param array $remove An array of attributes to remove.
25374 * @param array $add An array of attributes to add.
25375 * @param int $mode The last parameter determines if the modification
25376 *   is performed recursively. 1 means recursive modification. If some of
25377 *   the objects cannot be modified they will be skipped without notice.
25378 *   {@link hw_error} may not indicate an error though some of the
25379 *   objects could not be modified.
25380 * @return bool
25381 * @since PHP 4
25382 **/
25383function hw_modifyobject($connection, $object_to_change, $remove, $add, $mode){}
25384
25385/**
25386 * Moves the specified objects from a collection to another.
25387 *
25388 * @param int $connection The connection identifier.
25389 * @param array $object_id_array An array of object ids.
25390 * @param int $source_id The source collection id.
25391 * @param int $destination_id The target collection id. If set to 0 the
25392 *   objects will be unlinked from the source collection. If this is the
25393 *   last instance of that object it will be deleted. If you want to
25394 *   delete all instances at once, use {@link hw_deleteobject}.
25395 * @return int
25396 * @since PHP 4
25397 **/
25398function hw_mv($connection, $object_id_array, $source_id, $destination_id){}
25399
25400/**
25401 * Returns a new Hyperwave document with the given document data and
25402 * object record.
25403 *
25404 * This function does not insert the document into the Hyperwave server.
25405 *
25406 * @param string $object_record The object record.
25407 * @param string $document_data The document data.
25408 * @param int $document_size The document size. Must be the length of
25409 *   {@link document_data}.
25410 * @return int
25411 * @since PHP 4
25412 **/
25413function hw_new_document($object_record, $document_data, $document_size){}
25414
25415/**
25416 * Converts an {@link object_record} into an object array.
25417 *
25418 * @param string $object_record The object record.
25419 * @param array $format An associative array with the attribute name as
25420 *   its key and the value being one of HW_ATTR_LANG or HW_ATTR_NONE.
25421 * @return array
25422 * @since PHP 4
25423 **/
25424function hw_objrec2array($object_record, $format){}
25425
25426/**
25427 * Prints the document without the BODY tag.
25428 *
25429 * For backward compatibility, {@link hw_outputdocument} is also
25430 * accepted. This is deprecated, however.
25431 *
25432 * @param int $hw_document The document identifier.
25433 * @return bool
25434 * @since PHP 4
25435 **/
25436function hw_output_document($hw_document){}
25437
25438/**
25439 * Opens a persistent connection to a Hyperwave server. You can have
25440 * multiple persistent connections open at once.
25441 *
25442 * @param string $host The server host name.
25443 * @param int $port The server port number.
25444 * @param string $username The Hyperwave user name. If omitted, no
25445 *   identification with the server will be done. It is similar to
25446 *   identify as user anonymous.
25447 * @param string $password The password for {@link username}. Keep in
25448 *   mind, that the password is not encrypted.
25449 * @return int
25450 * @since PHP 4
25451 **/
25452function hw_pconnect($host, $port, $username, $password){}
25453
25454/**
25455 * Gets the Hyperwave document with the given object ID. If the document
25456 * has anchors which can be inserted, they will have been inserted
25457 * already.
25458 *
25459 * The document will be transferred via a special data connection which
25460 * does not block the control connection.
25461 *
25462 * @param int $connection The connection identifier.
25463 * @param int $objectID The object identifier.
25464 * @param array $url_prefixes
25465 * @return int
25466 * @since PHP 4
25467 **/
25468function hw_pipedocument($connection, $objectID, $url_prefixes){}
25469
25470/**
25471 * Returns the object ID of the hyperroot collection. Currently this is
25472 * always 0. The child collection of the hyperroot is the root collection
25473 * of the connected server.
25474 *
25475 * @return int
25476 * @since PHP 4
25477 **/
25478function hw_root(){}
25479
25480/**
25481 * @param int $link
25482 * @param int $rootid
25483 * @return int
25484 * @since PHP 4
25485 **/
25486function hw_setlinkroot($link, $rootid){}
25487
25488/**
25489 * @param int $link
25490 * @return string
25491 * @since PHP 4
25492 **/
25493function hw_stat($link){}
25494
25495/**
25496 * Unlocks a document, so other users regain access.
25497 *
25498 * @param int $connection The connection identifier.
25499 * @param int $objectID The document object identifier.
25500 * @return bool
25501 * @since PHP 4
25502 **/
25503function hw_unlock($connection, $objectID){}
25504
25505/**
25506 * Gets the list of currently logged in users.
25507 *
25508 * @param int $connection The connection identifier.
25509 * @return array
25510 * @since PHP 4
25511 **/
25512function hw_who($connection){}
25513
25514/**
25515 * {@link hypot} returns the length of the hypotenuse of a right-angle
25516 * triangle with sides of length {@link x} and {@link y}, or the distance
25517 * of the point ({@link x}, {@link y}) from the origin. This is
25518 * equivalent to sqrt(x*x + y*y).
25519 *
25520 * @param float $x Length of first side
25521 * @param float $y Length of second side
25522 * @return float
25523 * @since PHP 4 >= 4.1.0, PHP 5
25524 **/
25525function hypot($x, $y){}
25526
25527/**
25528 * PHP 4 uses {@link server}, {@link dba_user_name} and {@link
25529 * dba_user_password} instead of {@link service_handle} parameter.
25530 *
25531 * @param resource $service_handle
25532 * @param string $user_name
25533 * @param string $password
25534 * @param string $first_name
25535 * @param string $middle_name
25536 * @param string $last_name
25537 * @return bool
25538 * @since PHP 4 >= 4.2.0, PHP 5
25539 **/
25540function ibase_add_user($service_handle, $user_name, $password, $first_name, $middle_name, $last_name){}
25541
25542/**
25543 * This function returns the number of rows that were affected by the
25544 * previous query (INSERT, UPDATE or DELETE) that was executed from
25545 * within the specified transaction context.
25546 *
25547 * @param resource $link_identifier A transaction context. If {@link
25548 *   link_identifier} is a connection resource, its default transaction
25549 *   is used.
25550 * @return int
25551 * @since PHP 5
25552 **/
25553function ibase_affected_rows($link_identifier){}
25554
25555/**
25556 * @param resource $service_handle
25557 * @param string $source_db
25558 * @param string $dest_file
25559 * @param int $options
25560 * @param bool $verbose
25561 * @return mixed
25562 * @since PHP 5
25563 **/
25564function ibase_backup($service_handle, $source_db, $dest_file, $options, $verbose){}
25565
25566/**
25567 * {@link ibase_blob_add} adds data into a blob created with {@link
25568 * ibase_blob_create}.
25569 *
25570 * @param resource $blob_handle A blob handle opened with {@link
25571 *   ibase_blob_create}.
25572 * @param string $data The data to be added.
25573 * @return void
25574 * @since PHP 4, PHP 5
25575 **/
25576function ibase_blob_add($blob_handle, $data){}
25577
25578/**
25579 * This function will discard a BLOB if it has not yet been closed by
25580 * {@link ibase_blob_close}.
25581 *
25582 * @param resource $blob_handle A BLOB handle opened with {@link
25583 *   ibase_blob_create}.
25584 * @return bool
25585 * @since PHP 4, PHP 5
25586 **/
25587function ibase_blob_cancel($blob_handle){}
25588
25589/**
25590 * This function closes a BLOB that has either been opened for reading by
25591 * {@link ibase_blob_open} or has been opened for writing by {@link
25592 * ibase_blob_create}.
25593 *
25594 * @param resource $blob_handle A BLOB handle opened with {@link
25595 *   ibase_blob_create} or {@link ibase_blob_open}.
25596 * @return mixed
25597 * @since PHP 4, PHP 5
25598 **/
25599function ibase_blob_close($blob_handle){}
25600
25601/**
25602 * {@link ibase_blob_create} creates a new BLOB for filling with data.
25603 *
25604 * @param resource $link_identifier An InterBase link identifier. If
25605 *   omitted, the last opened link is assumed.
25606 * @return resource
25607 * @since PHP 4, PHP 5
25608 **/
25609function ibase_blob_create($link_identifier){}
25610
25611/**
25612 * This function opens a BLOB for reading and sends its contents directly
25613 * to standard output (the browser, in most cases).
25614 *
25615 * @param string $blob_id An InterBase link identifier. If omitted, the
25616 *   last opened link is assumed.
25617 * @return bool
25618 * @since PHP 4, PHP 5
25619 **/
25620function ibase_blob_echo($blob_id){}
25621
25622/**
25623 * This function returns at most {@link len} bytes from a BLOB that has
25624 * been opened for reading by {@link ibase_blob_open}.
25625 *
25626 * @param resource $blob_handle A BLOB handle opened with {@link
25627 *   ibase_blob_open}.
25628 * @param int $len Size of returned data.
25629 * @return string
25630 * @since PHP 4, PHP 5
25631 **/
25632function ibase_blob_get($blob_handle, $len){}
25633
25634/**
25635 * This function creates a BLOB, reads an entire file into it, closes it
25636 * and returns the assigned BLOB id.
25637 *
25638 * @param resource $link_identifier An InterBase link identifier. If
25639 *   omitted, the last opened link is assumed.
25640 * @param resource $file_handle The file handle is a handle returned by
25641 *   {@link fopen}.
25642 * @return string
25643 * @since PHP 4, PHP 5
25644 **/
25645function ibase_blob_import($link_identifier, $file_handle){}
25646
25647/**
25648 * Returns the BLOB length and other useful information.
25649 *
25650 * @param resource $link_identifier An InterBase link identifier. If
25651 *   omitted, the last opened link is assumed.
25652 * @param string $blob_id A BLOB id.
25653 * @return array
25654 * @since PHP 4, PHP 5
25655 **/
25656function ibase_blob_info($link_identifier, $blob_id){}
25657
25658/**
25659 * Opens an existing BLOB for reading.
25660 *
25661 * @param resource $link_identifier An InterBase link identifier. If
25662 *   omitted, the last opened link is assumed.
25663 * @param string $blob_id A BLOB id.
25664 * @return resource
25665 * @since PHP 4, PHP 5
25666 **/
25667function ibase_blob_open($link_identifier, $blob_id){}
25668
25669/**
25670 * Closes the link to an InterBase database that's associated with a
25671 * connection id returned from {@link ibase_connect}. Default transaction
25672 * on link is committed, other transactions are rolled back.
25673 *
25674 * @param resource $connection_id An InterBase link identifier returned
25675 *   from {@link ibase_connect}. If omitted, the last opened link is
25676 *   assumed.
25677 * @return bool
25678 * @since PHP 4, PHP 5
25679 **/
25680function ibase_close($connection_id){}
25681
25682/**
25683 * Commits a transaction.
25684 *
25685 * @param resource $link_or_trans_identifier If called without an
25686 *   argument, this function commits the default transaction of the
25687 *   default link. If the argument is a connection identifier, the
25688 *   default transaction of the corresponding connection will be
25689 *   committed. If the argument is a transaction identifier, the
25690 *   corresponding transaction will be committed.
25691 * @return bool
25692 * @since PHP 4, PHP 5
25693 **/
25694function ibase_commit($link_or_trans_identifier){}
25695
25696/**
25697 * Commits a transaction without closing it.
25698 *
25699 * @param resource $link_or_trans_identifier If called without an
25700 *   argument, this function commits the default transaction of the
25701 *   default link. If the argument is a connection identifier, the
25702 *   default transaction of the corresponding connection will be
25703 *   committed. If the argument is a transaction identifier, the
25704 *   corresponding transaction will be committed. The transaction context
25705 *   will be retained, so statements executed from within this
25706 *   transaction will not be invalidated.
25707 * @return bool
25708 * @since PHP 5
25709 **/
25710function ibase_commit_ret($link_or_trans_identifier){}
25711
25712/**
25713 * Establishes a connection to an InterBase server.
25714 *
25715 * In case a second call is made to {@link ibase_connect} with the same
25716 * arguments, no new link will be established, but instead, the link
25717 * identifier of the already opened link will be returned. The link to
25718 * the server will be closed as soon as the execution of the script ends,
25719 * unless it's closed earlier by explicitly calling {@link ibase_close}.
25720 *
25721 * @param string $database The {@link database} argument has to be a
25722 *   valid path to database file on the server it resides on. If the
25723 *   server is not local, it must be prefixed with either 'hostname:'
25724 *   (TCP/IP), '//hostname/' (NetBEUI) or 'hostname@' (IPX/SPX),
25725 *   depending on the connection protocol used.
25726 * @param string $username The user name. Can be set with the
25727 *   ibase.default_user directive.
25728 * @param string $password The password for {@link username}. Can be
25729 *   set with the ibase.default_password directive.
25730 * @param string $charset {@link charset} is the default character set
25731 *   for a database.
25732 * @param int $buffers {@link buffers} is the number of database
25733 *   buffers to allocate for the server-side cache. If 0 or omitted,
25734 *   server chooses its own default.
25735 * @param int $dialect {@link dialect} selects the default SQL dialect
25736 *   for any statement executed within a connection, and it defaults to
25737 *   the highest one supported by client libraries. Functional only with
25738 *   InterBase 6 and up.
25739 * @param string $role Functional only with InterBase 5 and up.
25740 * @param int $sync
25741 * @return resource
25742 * @since PHP 4, PHP 5
25743 **/
25744function ibase_connect($database, $username, $password, $charset, $buffers, $dialect, $role, $sync){}
25745
25746/**
25747 * @param resource $service_handle
25748 * @param string $db
25749 * @param int $action
25750 * @param int $argument
25751 * @return string
25752 * @since PHP 5
25753 **/
25754function ibase_db_info($service_handle, $db, $action, $argument){}
25755
25756/**
25757 * PHP 4 uses {@link server}, {@link dba_user_name} and {@link
25758 * dba_user_password} instead of {@link service_handle} parameter.
25759 *
25760 * @param resource $service_handle
25761 * @param string $user_name
25762 * @return bool
25763 * @since PHP 4 >= 4.2.0, PHP 5
25764 **/
25765function ibase_delete_user($service_handle, $user_name){}
25766
25767/**
25768 * This functions drops a database that was opened by either {@link
25769 * ibase_connect} or {@link ibase_pconnect}. The database is closed and
25770 * deleted from the server.
25771 *
25772 * @param resource $connection An InterBase link identifier. If
25773 *   omitted, the last opened link is assumed.
25774 * @return bool
25775 * @since PHP 5
25776 **/
25777function ibase_drop_db($connection){}
25778
25779/**
25780 * Returns the error code that resulted from the most recent InterBase
25781 * function call.
25782 *
25783 * @return int
25784 * @since PHP 5
25785 **/
25786function ibase_errcode(){}
25787
25788/**
25789 * @return string
25790 * @since PHP 4, PHP 5
25791 **/
25792function ibase_errmsg(){}
25793
25794/**
25795 * Execute a query prepared by {@link ibase_prepare}.
25796 *
25797 * This is a lot more effective than using {@link ibase_query} if you are
25798 * repeating a same kind of query several times with only some parameters
25799 * changing.
25800 *
25801 * @param resource $query An InterBase query prepared by {@link
25802 *   ibase_prepare}.
25803 * @param mixed $bind_arg
25804 * @return resource
25805 * @since PHP 4, PHP 5
25806 **/
25807function ibase_execute($query, $bind_arg){}
25808
25809/**
25810 * Fetch a result row from a query as an associative array.
25811 *
25812 * {@link ibase_fetch_assoc} fetches one row of data from the {@link
25813 * result}. If two or more columns of the result have the same field
25814 * names, the last column will take precedence. To access the other
25815 * column(s) of the same name, you either need to access the result with
25816 * numeric indices by using {@link ibase_fetch_row} or use alias names in
25817 * your query.
25818 *
25819 * @param resource $result The result handle.
25820 * @param int $fetch_flag {@link fetch_flag} is a combination of the
25821 *   constants IBASE_TEXT and IBASE_UNIXTIME ORed together. Passing
25822 *   IBASE_TEXT will cause this function to return BLOB contents instead
25823 *   of BLOB ids. Passing IBASE_UNIXTIME will cause this function to
25824 *   return date/time values as Unix timestamps instead of as formatted
25825 *   strings.
25826 * @return array
25827 * @since PHP 4 >= 4.3.0, PHP 5
25828 **/
25829function ibase_fetch_assoc($result, $fetch_flag){}
25830
25831/**
25832 * Fetches a row as a pseudo-object from a given result identifier.
25833 *
25834 * Subsequent calls to {@link ibase_fetch_object} return the next row in
25835 * the result set.
25836 *
25837 * @param resource $result_id An InterBase result identifier obtained
25838 *   either by {@link ibase_query} or {@link ibase_execute}.
25839 * @param int $fetch_flag {@link fetch_flag} is a combination of the
25840 *   constants IBASE_TEXT and IBASE_UNIXTIME ORed together. Passing
25841 *   IBASE_TEXT will cause this function to return BLOB contents instead
25842 *   of BLOB ids. Passing IBASE_UNIXTIME will cause this function to
25843 *   return date/time values as Unix timestamps instead of as formatted
25844 *   strings.
25845 * @return object
25846 * @since PHP 4, PHP 5
25847 **/
25848function ibase_fetch_object($result_id, $fetch_flag){}
25849
25850/**
25851 * {@link ibase_fetch_row} fetches one row of data from the given result
25852 * set.
25853 *
25854 * Subsequent calls to {@link ibase_fetch_row} return the next row in the
25855 * result set, or if there are no more rows.
25856 *
25857 * @param resource $result_identifier An InterBase result identifier.
25858 * @param int $fetch_flag {@link fetch_flag} is a combination of the
25859 *   constants IBASE_TEXT and IBASE_UNIXTIME ORed together. Passing
25860 *   IBASE_TEXT will cause this function to return BLOB contents instead
25861 *   of BLOB ids. Passing IBASE_UNIXTIME will cause this function to
25862 *   return date/time values as Unix timestamps instead of as formatted
25863 *   strings.
25864 * @return array
25865 * @since PHP 4, PHP 5
25866 **/
25867function ibase_fetch_row($result_identifier, $fetch_flag){}
25868
25869/**
25870 * Returns an array with information about a field after a select query
25871 * has been run.
25872 *
25873 * @param resource $result An InterBase result identifier.
25874 * @param int $field_number Field offset.
25875 * @return array
25876 * @since PHP 4, PHP 5
25877 **/
25878function ibase_field_info($result, $field_number){}
25879
25880/**
25881 * This function causes the registered event handler specified by {@link
25882 * event} to be cancelled. The callback function will no longer be called
25883 * for the events it was registered to handle.
25884 *
25885 * @param resource $event An event resource, created by {@link
25886 *   ibase_set_event_handler}.
25887 * @return bool
25888 * @since PHP 5
25889 **/
25890function ibase_free_event_handler($event){}
25891
25892/**
25893 * Frees a prepared query.
25894 *
25895 * @param resource $query A query prepared with {@link ibase_prepare}.
25896 * @return bool
25897 * @since PHP 4, PHP 5
25898 **/
25899function ibase_free_query($query){}
25900
25901/**
25902 * Frees a result set.
25903 *
25904 * @param resource $result_identifier A result set created by {@link
25905 *   ibase_query} or {@link ibase_execute}.
25906 * @return bool
25907 * @since PHP 4, PHP 5
25908 **/
25909function ibase_free_result($result_identifier){}
25910
25911/**
25912 * @param string $generator
25913 * @param int $increment
25914 * @param resource $link_identifier
25915 * @return mixed
25916 * @since PHP 5
25917 **/
25918function ibase_gen_id($generator, $increment, $link_identifier){}
25919
25920/**
25921 * @param resource $service_handle
25922 * @param string $db
25923 * @param int $action
25924 * @param int $argument
25925 * @return bool
25926 * @since PHP 5
25927 **/
25928function ibase_maintain_db($service_handle, $db, $action, $argument){}
25929
25930/**
25931 * PHP 4 uses {@link server}, {@link dba_user_name} and {@link
25932 * dba_user_password} instead of {@link service_handle} parameter.
25933 *
25934 * @param resource $service_handle
25935 * @param string $user_name
25936 * @param string $password
25937 * @param string $first_name
25938 * @param string $middle_name
25939 * @param string $last_name
25940 * @return bool
25941 * @since PHP 4 >= 4.2.0, PHP 5
25942 **/
25943function ibase_modify_user($service_handle, $user_name, $password, $first_name, $middle_name, $last_name){}
25944
25945/**
25946 * This function assigns a name to a result set. This name can be used
25947 * later in UPDATE|DELETE ... WHERE CURRENT OF {@link name} statements.
25948 *
25949 * @param resource $result An InterBase result set.
25950 * @param string $name The name to be assigned.
25951 * @return bool
25952 * @since PHP 5
25953 **/
25954function ibase_name_result($result, $name){}
25955
25956/**
25957 * Get the number of fields in a result set.
25958 *
25959 * @param resource $result_id An InterBase result identifier.
25960 * @return int
25961 * @since PHP 4, PHP 5
25962 **/
25963function ibase_num_fields($result_id){}
25964
25965/**
25966 * This function returns the number of parameters in the prepared query
25967 * specified by {@link query}. This is the number of binding arguments
25968 * that must be present when calling {@link ibase_execute}.
25969 *
25970 * @param resource $query The prepared query handle.
25971 * @return int
25972 * @since PHP 5
25973 **/
25974function ibase_num_params($query){}
25975
25976/**
25977 * Returns an array with information about a parameter after a query has
25978 * been prepared.
25979 *
25980 * @param resource $query An InterBase prepared query handle.
25981 * @param int $param_number Parameter offset.
25982 * @return array
25983 * @since PHP 5
25984 **/
25985function ibase_param_info($query, $param_number){}
25986
25987/**
25988 * Opens a persistent connection to an InterBase database.
25989 *
25990 * {@link ibase_pconnect} acts very much like {@link ibase_connect} with
25991 * two major differences.
25992 *
25993 * First, when connecting, the function will first try to find a
25994 * (persistent) link that's already opened with the same parameters. If
25995 * one is found, an identifier for it will be returned instead of opening
25996 * a new connection.
25997 *
25998 * Second, the connection to the InterBase server will not be closed when
25999 * the execution of the script ends. Instead, the link will remain open
26000 * for future use ({@link ibase_close} will not close links established
26001 * by {@link ibase_pconnect}). This type of link is therefore called
26002 * 'persistent'.
26003 *
26004 * @param string $database The {@link database} argument has to be a
26005 *   valid path to database file on the server it resides on. If the
26006 *   server is not local, it must be prefixed with either 'hostname:'
26007 *   (TCP/IP), '//hostname/' (NetBEUI) or 'hostname@' (IPX/SPX),
26008 *   depending on the connection protocol used.
26009 * @param string $username The user name. Can be set with the
26010 *   ibase.default_user directive.
26011 * @param string $password The password for {@link username}. Can be
26012 *   set with the ibase.default_password directive.
26013 * @param string $charset {@link charset} is the default character set
26014 *   for a database.
26015 * @param int $buffers {@link buffers} is the number of database
26016 *   buffers to allocate for the server-side cache. If 0 or omitted,
26017 *   server chooses its own default.
26018 * @param int $dialect {@link dialect} selects the default SQL dialect
26019 *   for any statement executed within a connection, and it defaults to
26020 *   the highest one supported by client libraries. Functional only with
26021 *   InterBase 6 and up.
26022 * @param string $role Functional only with InterBase 5 and up.
26023 * @param int $sync
26024 * @return resource
26025 * @since PHP 4, PHP 5
26026 **/
26027function ibase_pconnect($database, $username, $password, $charset, $buffers, $dialect, $role, $sync){}
26028
26029/**
26030 * @param string $query An InterBase query.
26031 * @return resource
26032 * @since PHP 4, PHP 5
26033 **/
26034function ibase_prepare($query){}
26035
26036/**
26037 * @param resource $link_identifier An InterBase link identifier. If
26038 *   omitted, the last opened link is assumed.
26039 * @param string $query An InterBase query.
26040 * @param int $bind_args
26041 * @return resource
26042 * @since PHP 4, PHP 5
26043 **/
26044function ibase_query($link_identifier, $query, $bind_args){}
26045
26046/**
26047 * @param resource $service_handle
26048 * @param string $source_file
26049 * @param string $dest_db
26050 * @param int $options
26051 * @param bool $verbose
26052 * @return mixed
26053 * @since PHP 5
26054 **/
26055function ibase_restore($service_handle, $source_file, $dest_db, $options, $verbose){}
26056
26057/**
26058 * Rolls back a transaction.
26059 *
26060 * @param resource $link_or_trans_identifier If called without an
26061 *   argument, this function rolls back the default transaction of the
26062 *   default link. If the argument is a connection identifier, the
26063 *   default transaction of the corresponding connection will be rolled
26064 *   back. If the argument is a transaction identifier, the corresponding
26065 *   transaction will be rolled back.
26066 * @return bool
26067 * @since PHP 4, PHP 5
26068 **/
26069function ibase_rollback($link_or_trans_identifier){}
26070
26071/**
26072 * Rolls back a transaction without closing it.
26073 *
26074 * @param resource $link_or_trans_identifier If called without an
26075 *   argument, this function rolls back the default transaction of the
26076 *   default link. If the argument is a connection identifier, the
26077 *   default transaction of the corresponding connection will be rolled
26078 *   back. If the argument is a transaction identifier, the corresponding
26079 *   transaction will be rolled back. The transaction context will be
26080 *   retained, so statements executed from within this transaction will
26081 *   not be invalidated.
26082 * @return bool
26083 * @since PHP 5
26084 **/
26085function ibase_rollback_ret($link_or_trans_identifier){}
26086
26087/**
26088 * @param resource $service_handle
26089 * @param int $action
26090 * @return string
26091 * @since PHP 5
26092 **/
26093function ibase_server_info($service_handle, $action){}
26094
26095/**
26096 * @param string $host
26097 * @param string $dba_username
26098 * @param string $dba_password
26099 * @return resource
26100 * @since PHP 5
26101 **/
26102function ibase_service_attach($host, $dba_username, $dba_password){}
26103
26104/**
26105 * @param resource $service_handle
26106 * @return bool
26107 * @since PHP 5
26108 **/
26109function ibase_service_detach($service_handle){}
26110
26111/**
26112 * This function registers a PHP user function as event handler for the
26113 * specified events.
26114 *
26115 * @param callback $event_handler The callback is called with the event
26116 *   name and the link resource as arguments whenever one of the
26117 *   specified events is posted by the database. The callback must return
26118 *   if the event handler should be canceled. Any other return value is
26119 *   ignored. This function accepts up to 15 event arguments.
26120 * @param string $event_name1 An event name.
26121 * @param string $event_name2 At most 15 events allowed.
26122 * @return resource
26123 * @since PHP 5
26124 **/
26125function ibase_set_event_handler($event_handler, $event_name1, $event_name2){}
26126
26127/**
26128 * Sets the format of timestamp, date or time type columns returned from
26129 * queries.
26130 *
26131 * You can set defaults for these formats with the PHP configuration
26132 * directives ibase.timestampformat, ibase.dateformat and
26133 * ibase.timeformat.
26134 *
26135 * @param string $format Internally, the columns are formatted by
26136 *   c-function strftime(), so refer to its documentation regarding to
26137 *   the format of the string.
26138 * @param int $columntype {@link columntype} is one of the constants
26139 *   IBASE_TIMESTAMP, IBASE_DATE and IBASE_TIME. If omitted, defaults to
26140 *   IBASE_TIMESTAMP for backwards compatibility.
26141 * @return bool
26142 * @since PHP 4
26143 **/
26144function ibase_timefmt($format, $columntype){}
26145
26146/**
26147 * Begins a transaction.
26148 *
26149 * @param int $trans_args {@link trans_args} can be a combination of
26150 *   IBASE_READ, IBASE_WRITE, IBASE_COMMITTED, IBASE_CONSISTENCY,
26151 *   IBASE_CONCURRENCY, IBASE_REC_VERSION, IBASE_REC_NO_VERSION,
26152 *   IBASE_WAIT and IBASE_NOWAIT.
26153 * @param resource $link_identifier An InterBase link identifier. If
26154 *   omitted, the last opened link is assumed.
26155 * @return resource
26156 * @since PHP 4, PHP 5
26157 **/
26158function ibase_trans($trans_args, $link_identifier){}
26159
26160/**
26161 * This function suspends execution of the script until one of the
26162 * specified events is posted by the database. The name of the event that
26163 * was posted is returned. This function accepts up to 15 event
26164 * arguments.
26165 *
26166 * @param string $event_name1 The event name.
26167 * @param string $event_name2
26168 * @return string
26169 * @since PHP 5
26170 **/
26171function ibase_wait_event($event_name1, $event_name2){}
26172
26173/**
26174 * Performs a character set conversion on the string {@link str} from
26175 * {@link in_charset} to {@link out_charset}.
26176 *
26177 * @param string $in_charset The input charset.
26178 * @param string $out_charset The output charset. If you append the
26179 *   string //TRANSLIT to {@link out_charset} transliteration is
26180 *   activated. This means that when a character can't be represented in
26181 *   the target charset, it can be approximated through one or several
26182 *   similarly looking characters. If you append the string //IGNORE,
26183 *   characters that cannot be represented in the target charset are
26184 *   silently discarded. Otherwise, {@link str} is cut from the first
26185 *   illegal character and an E_NOTICE is generated.
26186 * @param string $str The string to be converted.
26187 * @return string
26188 * @since PHP 4 >= 4.0.5, PHP 5
26189 **/
26190function iconv($in_charset, $out_charset, $str){}
26191
26192/**
26193 * Retrieve internal configuration variables of iconv extension.
26194 *
26195 * @param string $type The value of the optional {@link type} can be:
26196 *   all input_encoding output_encoding internal_encoding
26197 * @return mixed
26198 * @since PHP 4 >= 4.0.5, PHP 5
26199 **/
26200function iconv_get_encoding($type){}
26201
26202/**
26203 * Decodes a MIME header field.
26204 *
26205 * @param string $encoded_header The encoded header, as a string.
26206 * @param int $mode {@link mode} determines the behaviour in the event
26207 *   {@link iconv_mime_decode} encounters a malformed MIME header field.
26208 *   You can specify any combination of the following bitmasks. Bitmasks
26209 *   acceptable to {@link iconv_mime_decode} Value Constant Description 1
26210 *   ICONV_MIME_DECODE_STRICT If set, the given header is decoded in full
26211 *   conformance with the standards defined in RFC2047. This option is
26212 *   disabled by default because there are a lot of broken mail user
26213 *   agents that don't follow the specification and don't produce correct
26214 *   MIME headers. 2 ICONV_MIME_DECODE_CONTINUE_ON_ERROR If set, {@link
26215 *   iconv_mime_decode_headers} attempts to ignore any grammatical errors
26216 *   and continue to process a given header.
26217 * @param string $charset The optional {@link charset} parameter
26218 *   specifies the character set to represent the result by. If omitted,
26219 *   iconv.internal_encoding will be used.
26220 * @return string
26221 * @since PHP 5
26222 **/
26223function iconv_mime_decode($encoded_header, $mode, $charset){}
26224
26225/**
26226 * Decodes multiple MIME header fields at once.
26227 *
26228 * @param string $encoded_headers The encoded headers, as a string.
26229 * @param int $mode {@link mode} determines the behaviour in the event
26230 *   {@link iconv_mime_decode_headers} encounters a malformed MIME header
26231 *   field. You can specify any combination of the following bitmasks.
26232 *   Bitmasks acceptable to {@link iconv_mime_decode_headers} Value
26233 *   Constant Description 1 ICONV_MIME_DECODE_STRICT If set, the given
26234 *   header is decoded in full conformance with the standards defined in
26235 *   RFC2047. This option is disabled by default because there are a lot
26236 *   of broken mail user agents that don't follow the specification and
26237 *   don't produce correct MIME headers. 2
26238 *   ICONV_MIME_DECODE_CONTINUE_ON_ERROR If set, {@link
26239 *   iconv_mime_decode_headers} attempts to ignore any grammatical errors
26240 *   and continue to process a given header.
26241 * @param string $charset The optional {@link charset} parameter
26242 *   specifies the character set to represent the result by. If omitted,
26243 *   iconv.internal_encoding will be used.
26244 * @return array
26245 * @since PHP 5
26246 **/
26247function iconv_mime_decode_headers($encoded_headers, $mode, $charset){}
26248
26249/**
26250 * Composes and returns a string that represents a valid MIME header
26251 * field, which looks like the following:
26252 *
26253 * Subject: =?ISO-8859-1?Q?Pr=FCfung_f=FCr?= Entwerfen von einer MIME
26254 * kopfzeile
26255 *
26256 * In the above example, "Subject" is the field name and the portion that
26257 * begins with "=?ISO-8859-1?..." is the field value.
26258 *
26259 * @param string $field_name The field name.
26260 * @param string $field_value The field value.
26261 * @param array $preferences You can control the behaviour of {@link
26262 *   iconv_mime_encode} by specifying an associative array that contains
26263 *   configuration items to the optional third parameter {@link
26264 *   preferences}. The items supported by {@link iconv_mime_encode} are
26265 *   listed below. Note that item names are treated case-sensitive.
26266 *   Configuration items supported by {@link iconv_mime_encode} Item Type
26267 *   Description Default value Example scheme string Specifies the method
26268 *   to encode a field value by. The value of this item may be either "B"
26269 *   or "Q", where "B" stands for base64 encoding scheme and "Q" stands
26270 *   for quoted-printable encoding scheme. B B input-charset string
26271 *   Specifies the character set in which the first parameter {@link
26272 *   field_name} and the second parameter {@link field_value} are
26273 *   presented. If not given, {@link iconv_mime_encode} assumes those
26274 *   parameters are presented to it in the iconv.internal_encoding ini
26275 *   setting. iconv.internal_encoding ISO-8859-1 output-charset string
26276 *   Specifies the character set to use to compose the MIME header. If
26277 *   not given, the same value as input-charset will be used.
26278 *   iconv.internal_encoding UTF-8 line-length integer Specifies the
26279 *   maximum length of the header lines. The resulting header is "folded"
26280 *   to a set of multiple lines in case the resulting header field would
26281 *   be longer than the value of this parameter, according to RFC2822 -
26282 *   Internet Message Format. If not given, the length will be limited to
26283 *   76 characters. 76 996 line-break-chars string Specifies the sequence
26284 *   of characters to append to each line as an end-of-line sign when
26285 *   "folding" is performed on a long header field. If not given, this
26286 *   defaults to "\r\n" (CR LF). Note that this parameter is always
26287 *   treated as an ASCII string regardless of the value of input-charset.
26288 *   \r\n \n
26289 * @return string
26290 * @since PHP 5
26291 **/
26292function iconv_mime_encode($field_name, $field_value, $preferences){}
26293
26294/**
26295 * Changes the value of the internal configuration variable specified by
26296 * {@link type} to {@link charset}.
26297 *
26298 * @param string $type The value of {@link type} can be any one of
26299 *   those: input_encoding output_encoding internal_encoding
26300 * @param string $charset The character set.
26301 * @return bool
26302 * @since PHP 4 >= 4.0.5, PHP 5
26303 **/
26304function iconv_set_encoding($type, $charset){}
26305
26306/**
26307 * In contrast to {@link strlen}, {@link iconv_strlen} counts the
26308 * occurrences of characters in the given byte sequence {@link str} on
26309 * the basis of the specified character set, the result of which is not
26310 * necessarily identical to the length of the string in byte.
26311 *
26312 * @param string $str The string.
26313 * @param string $charset If {@link charset} parameter is omitted,
26314 *   {@link str} is assumed to be encoded in iconv.internal_encoding.
26315 * @return int
26316 * @since PHP 5
26317 **/
26318function iconv_strlen($str, $charset){}
26319
26320/**
26321 * Finds position of first occurrence of a needle within a haystack.
26322 *
26323 * In contrast to {@link strpos}, the return value of {@link
26324 * iconv_strpos} is the number of characters that appear before the
26325 * needle, rather than the offset in bytes to the position where the
26326 * needle has been found. The characters are counted on the basis of the
26327 * specified character set {@link charset}.
26328 *
26329 * @param string $haystack The entire string.
26330 * @param string $needle The searched substring.
26331 * @param int $offset The optional {@link offset} parameter specifies
26332 *   the position from which the search should be performed.
26333 * @param string $charset If {@link charset} parameter is omitted,
26334 *   {@link string} are assumed to be encoded in iconv.internal_encoding.
26335 * @return int
26336 * @since PHP 5
26337 **/
26338function iconv_strpos($haystack, $needle, $offset, $charset){}
26339
26340/**
26341 * In contrast to {@link strpos}, the return value of {@link
26342 * iconv_strrpos} is the number of characters that appear before the
26343 * needle, rather than the offset in bytes to the position where the
26344 * needle has been found.
26345 *
26346 * @param string $haystack The entire string.
26347 * @param string $needle The searched substring.
26348 * @param string $charset If {@link charset} parameter is omitted,
26349 *   {@link string} are assumed to be encoded in iconv.internal_encoding.
26350 * @return int
26351 * @since PHP 5
26352 **/
26353function iconv_strrpos($haystack, $needle, $charset){}
26354
26355/**
26356 * Cuts a portion of {@link str} specified by the {@link offset} and
26357 * {@link length} parameters.
26358 *
26359 * @param string $str The original string.
26360 * @param int $offset If {@link offset} is non-negative, {@link
26361 *   iconv_substr} cuts the portion out of {@link str} beginning at
26362 *   {@link offset}'th character, counting from zero. If {@link offset}
26363 *   is negative, {@link iconv_substr} cuts out the portion beginning at
26364 *   the position, {@link offset} characters away from the end of {@link
26365 *   str}.
26366 * @param int $length If {@link length} is given and is positive, the
26367 *   return value will contain at most {@link length} characters of the
26368 *   portion that begins at {@link offset} (depending on the length of
26369 *   {@link string}). If negative {@link length} is passed, {@link
26370 *   iconv_substr} cuts the portion out of {@link str} from the {@link
26371 *   offset}'th character up to the character that is {@link length}
26372 *   characters away from the end of the string. In case {@link offset}
26373 *   is also negative, the start position is calculated beforehand
26374 *   according to the rule explained above.
26375 * @param string $charset If {@link charset} parameter is omitted,
26376 *   {@link string} are assumed to be encoded in iconv.internal_encoding.
26377 *   Note that {@link offset} and {@link length} parameters are always
26378 *   deemed to represent offsets that are calculated on the basis of the
26379 *   character set determined by {@link charset}, whilst the counterpart
26380 *   {@link substr} always takes these for byte offsets.
26381 * @return string
26382 * @since PHP 5
26383 **/
26384function iconv_substr($str, $offset, $length, $charset){}
26385
26386/**
26387 * {@link id3_get_frame_long_name} returns the long name for an ID3v2
26388 * frame.
26389 *
26390 * @param string $frameId An ID3v2 frame
26391 * @return string
26392 * @since PECL id3 >= 0.2
26393 **/
26394function id3_get_frame_long_name($frameId){}
26395
26396/**
26397 * {@link id3_get_frame_short_name} returns the short name for an ID3v2
26398 * frame.
26399 *
26400 * @param string $frameId An ID3v2 frame
26401 * @return string
26402 * @since PECL id3 >= 0.2
26403 **/
26404function id3_get_frame_short_name($frameId){}
26405
26406/**
26407 * {@link id3_get_genre_id} returns the id for a genre.
26408 *
26409 * @param string $genre An integer ranging from 0 to 147
26410 * @return int
26411 * @since PECL id3 >= 0.1
26412 **/
26413function id3_get_genre_id($genre){}
26414
26415/**
26416 * {@link id3_get_genre_list} returns an array containing all possible
26417 * genres that may be stored in an ID3 tag. This list has been created by
26418 * Eric Kemp and later extended by WinAmp.
26419 *
26420 * This function is useful to provide you users a list of genres from
26421 * which they may choose one. When updating the ID3 tag you will always
26422 * have to specify the genre as an integer ranging from 0 to 147.
26423 *
26424 * @return array
26425 * @since PECL id3 >= 0.1
26426 **/
26427function id3_get_genre_list(){}
26428
26429/**
26430 * {@link id3_get_genre_name} returns the name for a genre id.
26431 *
26432 * @param int $genre_id An integer ranging from 0 to 147
26433 * @return string
26434 * @since PECL id3 >= 0.1
26435 **/
26436function id3_get_genre_name($genre_id){}
26437
26438/**
26439 * {@link id3_get_tag} is used to get all information stored in the id3
26440 * tag of the specified file.
26441 *
26442 * @param string $filename The path to the MP3 file Instead of a
26443 *   filename you may also pass a valid stream resource
26444 * @param int $version Allows you to specify the version of the tag as
26445 *   MP3 files may contain both, version 1.x and version 2.x tags Since
26446 *   version 0.2 {@link id3_get_tag} also supports ID3 tags of version
26447 *   2.2, 2.3 and 2.4. To extract information from these tags, pass one
26448 *   of the constants ID3_V2_2, ID3_V2_3 or ID3_V2_4 as the second
26449 *   parameter. ID3 v2.x tags can contain a lot more information about
26450 *   the MP3 file than ID3 v1.x tags.
26451 * @return array
26452 * @since PECL id3 >= 0.1
26453 **/
26454function id3_get_tag($filename, $version){}
26455
26456/**
26457 * {@link id3_get_version} retrieves the version(s) of the ID3 tag(s) in
26458 * the MP3 file.
26459 *
26460 * If a file contains an ID3 v1.1 tag, it always contains a 1.0 tag, as
26461 * version 1.1 is just an extension of 1.0.
26462 *
26463 * @param string $filename The path to the MP3 file Instead of a
26464 *   filename you may also pass a valid stream resource
26465 * @return int
26466 * @since PECL id3 >= 0.1
26467 **/
26468function id3_get_version($filename){}
26469
26470/**
26471 * {@link id3_remove_tag} is used to remove the information stored of an
26472 * ID3 tag.
26473 *
26474 * @param string $filename The path to the MP3 file Instead of a
26475 *   filename you may also pass a valid stream resource
26476 * @param int $version Allows you to specify the version of the tag as
26477 *   MP3 files may contain both, version 1.x and version 2.x tags.
26478 * @return bool
26479 * @since PECL id3 >= 0.1
26480 **/
26481function id3_remove_tag($filename, $version){}
26482
26483/**
26484 * {@link id3_set_tag} is used to change the information stored of an ID3
26485 * tag. If no tag has been present, it will be added to the file.
26486 *
26487 * @param string $filename The path to the MP3 file Instead of a
26488 *   filename you may also pass a valid stream resource
26489 * @param array $tag An associative array of tag keys and values The
26490 *   following keys may be used in the associative array:
26491 *
26492 *   Keys in the associative array key possible value available in
26493 *   version title string with maximum of 30 characters v1.0, v1.1 artist
26494 *   string with maximum of 30 characters v1.0, v1.1 album string with
26495 *   maximum of 30 characters v1.0, v1.1 year 4 digits v1.0, v1.1 genre
26496 *   integer value between 0 and 147 v1.0, v1.1 comment string with
26497 *   maximum of 30 characters (28 in v1.1) v1.0, v1.1 track integer
26498 *   between 0 and 255 v1.1
26499 * @param int $version Allows you to specify the version of the tag as
26500 *   MP3 files may contain both, version 1.x and version 2.x tags
26501 * @return bool
26502 * @since PECL id3 >= 0.1
26503 **/
26504function id3_set_tag($filename, $tag, $version){}
26505
26506/**
26507 * Returns a number formatted according to the given format string using
26508 * the given integer {@link timestamp} or the current local time if no
26509 * timestamp is given. In other words, {@link timestamp} is optional and
26510 * defaults to the value of {@link time}.
26511 *
26512 * Unlike the function {@link date}, {@link idate} accepts just one char
26513 * in the {@link format} parameter.
26514 *
26515 * @param string $format The following characters are recognized in the
26516 *   {@link format} parameter string {@link format} character Description
26517 *   B Swatch Beat/Internet Time d Day of the month h Hour (12 hour
26518 *   format) H Hour (24 hour format) i Minutes I (uppercase i) returns 1
26519 *   if DST is activated, 0 otherwise L (uppercase l) returns 1 for leap
26520 *   year, 0 otherwise m Month number s Seconds t Days in current month U
26521 *   Seconds since the Unix Epoch - January 1 1970 00:00:00 UTC - this is
26522 *   the same as {@link time} w Day of the week (0 on Sunday) W ISO-8601
26523 *   week number of year, weeks starting on Monday y Year (1 or 2 digits
26524 *   - check note below) Y Year (4 digits) z Day of the year Z Timezone
26525 *   offset in seconds
26526 * @param int $timestamp
26527 * @return int
26528 * @since PHP 5
26529 **/
26530function idate($format, $timestamp){}
26531
26532/**
26533 * This function returns the error message string that corresponds to the
26534 * given error code.
26535 *
26536 * @param int $errorcode The error code as returned by {@link
26537 *   idn_to_ascii} or {@link idn_to_utf8}.
26538 * @return string
26539 * @since PECL idn >= 0.2
26540 **/
26541function idn_strerror($errorcode){}
26542
26543/**
26544 * This function converts a UTF-8 encoded domain name to ASCII according
26545 * to the IDNA toUnicode() specification. If the input has non-ASCII
26546 * characters, the output will be in the "xn--" ACE notation.
26547 *
26548 * @param string $utf8_domain The UTF-8 encoded domain name. If e.g. an
26549 *   ISO-8859-1 (aka Western Europe latin1) encoded string is passed it
26550 *   will be converted into an ACE encoded "xn--" string. It will not be
26551 *   the one you expected though!
26552 * @param int $errorcode Will be set to the IDNA error code.
26553 * @return string
26554 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.2
26555 **/
26556function idn_to_ascii($utf8_domain, &$errorcode){}
26557
26558/**
26559 * This function converts Unicode domain name from IDNA ASCII-compatible
26560 * format to plain Unicode.
26561 *
26562 * @param string $domain Domain to convert in IDNA ASCII-compatible
26563 *   format.
26564 * @param int $options Conversion options - combination of IDNA_*
26565 *   constants.
26566 * @return string
26567 **/
26568function idn_to_unicode($domain, $options){}
26569
26570/**
26571 * This function converts a ASCII encoded domain name to its original
26572 * UTF-8 version.
26573 *
26574 * @param string $ascii_domain The ASCII encoded domain name. Looks
26575 *   like "xn--..." if the it originally contained non-ASCII characters.
26576 * @param int $errorcode Will be set to the IDNA error code.
26577 * @return string
26578 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.2
26579 **/
26580function idn_to_utf8($ascii_domain, &$errorcode){}
26581
26582/**
26583 * Deletes the slob object on the given slob object-id {@link bid}.
26584 *
26585 * @param int $bid An existing slob id.
26586 * @return bool
26587 * @since PHP 4, PHP
26588 **/
26589function ifxus_close_slob($bid){}
26590
26591/**
26592 * Creates an slob object and opens it.
26593 *
26594 * @param int $mode A combination of IFX_LO_RDONLY, IFX_LO_WRONLY,
26595 *   IFX_LO_APPEND IFX_LO_RDWR, IFX_LO_BUFFER, IFX_LO_NOBUFFER.
26596 * @return int
26597 * @since PHP 4, PHP
26598 **/
26599function ifxus_create_slob($mode){}
26600
26601/**
26602 * Deletes the slob object.
26603 *
26604 * @param int $bid An existing slob id.
26605 * @return bool
26606 * @since PHP 4, PHP
26607 **/
26608function ifxus_free_slob($bid){}
26609
26610/**
26611 * Opens an slob object. {@link bid} should be an existing slob id.
26612 *
26613 * @param int $bid An existing slob id.
26614 * @param int $mode A combination of IFX_LO_RDONLY, IFX_LO_WRONLY,
26615 *   IFX_LO_APPEND IFX_LO_RDWR, IFX_LO_BUFFER, IFX_LO_NOBUFFER.
26616 * @return int
26617 * @since PHP 4, PHP
26618 **/
26619function ifxus_open_slob($bid, $mode){}
26620
26621/**
26622 * Reads {@link nbytes} of the slob object.
26623 *
26624 * @param int $bid An existing slob id.
26625 * @param int $nbytes The number of bytes to read.
26626 * @return string
26627 * @since PHP 4, PHP
26628 **/
26629function ifxus_read_slob($bid, $nbytes){}
26630
26631/**
26632 * Sets the current file or seek position of an open slob object.
26633 *
26634 * @param int $bid An existing slob id.
26635 * @param int $mode 0 = LO_SEEK_SET, 1 = LO_SEEK_CUR, 2 = LO_SEEK_END.
26636 * @param int $offset A byte offset.
26637 * @return int
26638 * @since PHP 4, PHP
26639 **/
26640function ifxus_seek_slob($bid, $mode, $offset){}
26641
26642/**
26643 * Returns the current file or seek position of an open slob object
26644 *
26645 * @param int $bid An existing slob id.
26646 * @return int
26647 * @since PHP 4, PHP
26648 **/
26649function ifxus_tell_slob($bid){}
26650
26651/**
26652 * Writes a string into the slob object.
26653 *
26654 * @param int $bid An existing slob id.
26655 * @param string $content The content to write, as a string.
26656 * @return int
26657 * @since PHP 4, PHP
26658 **/
26659function ifxus_write_slob($bid, $content){}
26660
26661/**
26662 * Returns the number of rows affected by a query associated with {@link
26663 * result_id}.
26664 *
26665 * For inserts, updates and deletes the number is the real number
26666 * (sqlerrd[2]) of affected rows. For selects it is an estimate
26667 * (sqlerrd[0]). Don't rely on it. The database server can never return
26668 * the actual number of rows that will be returned by a SELECT because it
26669 * has not even begun fetching them at this stage (just after the
26670 * "PREPARE" when the optimizer has determined the query plan).
26671 *
26672 * Useful after {@link ifx_prepare} to limit queries to reasonable result
26673 * sets.
26674 *
26675 * @param resource $result_id A valid result id returned by {@link
26676 *   ifx_query} or {@link ifx_prepare}.
26677 * @return int
26678 * @since PHP 4, PHP
26679 **/
26680function ifx_affected_rows($result_id){}
26681
26682/**
26683 * Set the default blob mode for all select queries.
26684 *
26685 * @param int $mode Mode "0" means save Byte-Blobs in memory, and mode
26686 *   "1" means save Byte-Blobs in a file.
26687 * @return bool
26688 * @since PHP 4, PHP
26689 **/
26690function ifx_blobinfile_mode($mode){}
26691
26692/**
26693 * Sets the default byte mode for all select-queries.
26694 *
26695 * @param int $mode Mode "0" will return a blob id, and mode "1" will
26696 *   return a varchar with text content.
26697 * @return bool
26698 * @since PHP 4, PHP
26699 **/
26700function ifx_byteasvarchar($mode){}
26701
26702/**
26703 * {@link ifx_close} closes the link to an Informix database that's
26704 * associated with the specified link identifier.
26705 *
26706 * Note that this isn't usually necessary, as non-persistent open links
26707 * are automatically closed at the end of the script's execution.
26708 *
26709 * {@link ifx_close} will not close persistent links generated by {@link
26710 * ifx_pconnect}.
26711 *
26712 * @param resource $link_identifier The link identifier. If not
26713 *   specified, the last opened link is assumed.
26714 * @return bool
26715 * @since PHP 4, PHP
26716 **/
26717function ifx_close($link_identifier){}
26718
26719/**
26720 * {@link ifx_connect} establishes a connection to an Informix server.
26721 *
26722 * In case a second call is made to {@link ifx_connect} with the same
26723 * arguments, no new link will be established, but instead, the link
26724 * identifier of the already opened link will be returned.
26725 *
26726 * The link to the server will be closed as soon as the execution of the
26727 * script ends, unless it's closed earlier by explicitly calling {@link
26728 * ifx_close}.
26729 *
26730 * @param string $database The database name, as a string.
26731 * @param string $userid The username, as a string.
26732 * @param string $password The password, as a string.
26733 * @return resource
26734 * @since PHP 4, PHP
26735 **/
26736function ifx_connect($database, $userid, $password){}
26737
26738/**
26739 * Duplicates the given blob object.
26740 *
26741 * @param int $bid A BLOB identifier.
26742 * @return int
26743 * @since PHP 4, PHP
26744 **/
26745function ifx_copy_blob($bid){}
26746
26747/**
26748 * Creates a blob object.
26749 *
26750 * @param int $type 1 = TEXT, 0 = BYTE
26751 * @param int $mode 0 = blob-object holds the content in memory, 1 =
26752 *   blob-object holds the content in file.
26753 * @param string $param if mode = 0: pointer to the content, if mode =
26754 *   1: pointer to the filestring.
26755 * @return int
26756 * @since PHP 4, PHP
26757 **/
26758function ifx_create_blob($type, $mode, $param){}
26759
26760/**
26761 * Creates an char object.
26762 *
26763 * @param string $param The char content.
26764 * @return int
26765 * @since PHP 4, PHP
26766 **/
26767function ifx_create_char($param){}
26768
26769/**
26770 * Executes a previously prepared query or opens a cursor for it.
26771 *
26772 * Does NOT free {@link result_id} on error.
26773 *
26774 * Also sets the real number of {@link ifx_affected_rows} for non-select
26775 * statements for retrieval by {@link ifx_affected_rows}.
26776 *
26777 * @param resource $result_id {@link result_id} is a valid resultid
26778 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
26779 *   queries only!).
26780 * @return bool
26781 * @since PHP 4, PHP
26782 **/
26783function ifx_do($result_id){}
26784
26785/**
26786 * Returns in a string one character describing the general results of a
26787 * statement and both SQLSTATE and SQLCODE associated with the most
26788 * recent SQL statement executed.
26789 *
26790 * @param resource $link_identifier The link identifier.
26791 * @return string
26792 * @since PHP 4, PHP
26793 **/
26794function ifx_error($link_identifier){}
26795
26796/**
26797 * Returns the Informix error message associated with the most recent
26798 * Informix error.
26799 *
26800 * @param int $errorcode If specified, the function will return the
26801 *   message corresponding to the specified code.
26802 * @return string
26803 * @since PHP 4, PHP
26804 **/
26805function ifx_errormsg($errorcode){}
26806
26807/**
26808 * Fetches one row of data from the result associated with the specified
26809 * result identifier.
26810 *
26811 * Subsequent calls to {@link ifx_fetch_row} would return the next row in
26812 * the result set, or if there are no more rows.
26813 *
26814 * @param resource $result_id {@link result_id} is a valid resultid
26815 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
26816 *   queries only!).
26817 * @param mixed $position An optional parameter for a "fetch" operation
26818 *   on "scroll" cursors: NEXT, PREVIOUS, CURRENT, FIRST, LAST or a
26819 *   number. If you specify a number, an "absolute" row fetch is
26820 *   executed. This parameter is optional, and only valid for SCROLL
26821 *   cursors.
26822 * @return array
26823 * @since PHP 4, PHP
26824 **/
26825function ifx_fetch_row($result_id, $position){}
26826
26827/**
26828 * Returns the Informix SQL fieldproperties of every field in the query
26829 * as an associative array. Properties are encoded as:
26830 * "SQLTYPE;length;precision;scale;ISNULLABLE" where SQLTYPE = the
26831 * Informix type like "SQLVCHAR" etc. and ISNULLABLE = "Y" or "N".
26832 *
26833 * @param resource $result_id {@link result_id} is a valid resultid
26834 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
26835 *   queries only!).
26836 * @return array
26837 * @since PHP 4, PHP
26838 **/
26839function ifx_fieldproperties($result_id){}
26840
26841/**
26842 * Returns an associative array with fieldnames as key and the SQL
26843 * fieldtypes as data for the query associated with {@link result_id}.
26844 *
26845 * @param resource $result_id {@link result_id} is a valid resultid
26846 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
26847 *   queries only!).
26848 * @return array
26849 * @since PHP 4, PHP
26850 **/
26851function ifx_fieldtypes($result_id){}
26852
26853/**
26854 * Deletes the blobobject for the given blob object-id.
26855 *
26856 * @param int $bid The BLOB object id.
26857 * @return bool
26858 * @since PHP 4, PHP
26859 **/
26860function ifx_free_blob($bid){}
26861
26862/**
26863 * Deletes the charobject for the given char object-id.
26864 *
26865 * @param int $bid The char object id.
26866 * @return bool
26867 * @since PHP 4, PHP
26868 **/
26869function ifx_free_char($bid){}
26870
26871/**
26872 * Releases resources for the query associated with {@link result_id}.
26873 *
26874 * @param resource $result_id {@link result_id} is a valid resultid
26875 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
26876 *   queries only!).
26877 * @return bool
26878 * @since PHP 4, PHP
26879 **/
26880function ifx_free_result($result_id){}
26881
26882/**
26883 * Returns a pseudo-row with sqlca.sqlerrd[0] ... sqlca.sqlerrd[5] after
26884 * the query associated with {@link result_id}.
26885 *
26886 * For inserts, updates and deletes the values returned are those as set
26887 * by the server after executing the query. This gives access to the
26888 * number of affected rows and the serial insert value. For SELECTs the
26889 * values are those saved after the PREPARE statement. This gives access
26890 * to the *estimated* number of affected rows. The use of this function
26891 * saves the overhead of executing a SELECT dbinfo('sqlca.sqlerrdx')
26892 * query, as it retrieves the values that were saved by the ifx driver at
26893 * the appropriate moment.
26894 *
26895 * @param resource $result_id {@link result_id} is a valid result id
26896 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
26897 *   queries only!).
26898 * @return array
26899 * @since PHP 4, PHP
26900 **/
26901function ifx_getsqlca($result_id){}
26902
26903/**
26904 * Returns the content of the blob object.
26905 *
26906 * @param int $bid The BLOB object id.
26907 * @return string
26908 * @since PHP 4, PHP
26909 **/
26910function ifx_get_blob($bid){}
26911
26912/**
26913 * Returns the content of the char object.
26914 *
26915 * @param int $bid The char object-id.
26916 * @return string
26917 * @since PHP 4, PHP
26918 **/
26919function ifx_get_char($bid){}
26920
26921/**
26922 * Formats and prints all rows of the {@link result_id} query into a HTML
26923 * table.
26924 *
26925 * @param resource $result_id {@link result_id} is a valid resultid
26926 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
26927 *   queries only!).
26928 * @param string $html_table_options This optional argument is a string
26929 *   of <table> tag options.
26930 * @return int
26931 * @since PHP 4, PHP
26932 **/
26933function ifx_htmltbl_result($result_id, $html_table_options){}
26934
26935/**
26936 * Sets the default return value of a NULL-value on a fetch row.
26937 *
26938 * @param int $mode Mode "0" returns "", and mode "1" returns "".
26939 * @return bool
26940 * @since PHP 4, PHP
26941 **/
26942function ifx_nullformat($mode){}
26943
26944/**
26945 * After preparing or executing a query, this call gives you the number
26946 * of columns in the query.
26947 *
26948 * @param resource $result_id {@link result_id} is a valid resultid
26949 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
26950 *   queries only!).
26951 * @return int
26952 * @since PHP 4, PHP
26953 **/
26954function ifx_num_fields($result_id){}
26955
26956/**
26957 * Gives the number of rows fetched so far for a query with {@link
26958 * result_id} after a {@link ifx_query} or {@link ifx_do} query.
26959 *
26960 * @param resource $result_id {@link result_id} is a valid resultid
26961 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
26962 *   queries only!).
26963 * @return int
26964 * @since PHP 4, PHP
26965 **/
26966function ifx_num_rows($result_id){}
26967
26968/**
26969 * {@link ifx_pconnect} acts very much like {@link ifx_connect} with two
26970 * major differences.
26971 *
26972 * First, when connecting, the function would first try to find a
26973 * (persistent) link that's already open with the same host, username and
26974 * password. If one is found, an identifier for it will be returned
26975 * instead of opening a new connection.
26976 *
26977 * Second, the connection to the SQL server will not be closed when the
26978 * execution of the script ends. Instead, the link will remain open for
26979 * future use ({@link ifx_close} will not close links established by
26980 * {@link ifx_pconnect}).
26981 *
26982 * This type of links is therefore called 'persistent'.
26983 *
26984 * @param string $database The database name, as a string.
26985 * @param string $userid The username, as a string.
26986 * @param string $password The password, as a string.
26987 * @return resource
26988 * @since PHP 4, PHP
26989 **/
26990function ifx_pconnect($database, $userid, $password){}
26991
26992/**
26993 * Prepares a {@link query} for later use with {@link ifx_do}.
26994 *
26995 * For "select-type" queries a cursor is declared and opened. Non-select
26996 * queries are "execute immediate".
26997 *
26998 * For either query type the number of (estimated or real) affected rows
26999 * is saved for retrieval by {@link ifx_affected_rows}.
27000 *
27001 * If the contents of the TEXT (or BYTE) column allow it, you can also
27002 * use ifx_textasvarchar(1) and ifx_byteasvarchar(1). This allows you to
27003 * treat TEXT (or BYTE) columns just as if they were ordinary (but long)
27004 * VARCHAR columns for select queries, and you don't need to bother with
27005 * blob id's.
27006 *
27007 * With ifx_textasvarchar(0) or ifx_byteasvarchar(0) (the default
27008 * situation), select queries will return BLOB columns as blob id's
27009 * (integer value). You can get the value of the blob as a string or file
27010 * with the blob functions (see below).
27011 *
27012 * @param string $query The query string.
27013 * @param resource $link_identifier The link identifier.
27014 * @param int $cursor_def This optional parameter allows you to make
27015 *   this a scroll and/or hold cursor. It's a bitmask and can be either
27016 *   IFX_SCROLL, IFX_HOLD, or both or'ed together.
27017 * @param mixed $blobidarray If you have BLOB (BYTE or TEXT) columns in
27018 *   the query, you can add a {@link blobidarray} parameter containing
27019 *   the corresponding "blob ids", and you should replace those columns
27020 *   with a "?" in the query text.
27021 * @return resource
27022 * @since PHP 4, PHP
27023 **/
27024function ifx_prepare($query, $link_identifier, $cursor_def, $blobidarray){}
27025
27026/**
27027 * Sends a {@link query} to the currently active database on the server
27028 * that's associated with the specified link identifier.
27029 *
27030 * For "select-type" queries a cursor is declared and opened. Non-select
27031 * queries are "execute immediate".
27032 *
27033 * For either query type the number of (estimated or real) affected rows
27034 * is saved for retrieval by {@link ifx_affected_rows}.
27035 *
27036 * If the contents of the TEXT (or BYTE) column allow it, you can also
27037 * use ifx_textasvarchar(1) and ifx_byteasvarchar(1). This allows you to
27038 * treat TEXT (or BYTE) columns just as if they were ordinary (but long)
27039 * VARCHAR columns for select queries, and you don't need to bother with
27040 * blob id's.
27041 *
27042 * With ifx_textasvarchar(0) or ifx_byteasvarchar(0) (the default
27043 * situation), select queries will return BLOB columns as blob id's
27044 * (integer value). You can get the value of the blob as a string or file
27045 * with the blob functions (see below).
27046 *
27047 * @param string $query The query string.
27048 * @param resource $link_identifier The link identifier.
27049 * @param int $cursor_type This optional parameter allows you to make
27050 *   this a scroll and/or hold cursor. It's a bitmask and can be either
27051 *   IFX_SCROLL, IFX_HOLD, or both or'ed together. I you omit this
27052 *   parameter the cursor is a normal sequential cursor.
27053 * @param mixed $blobidarray If you have BLOB (BYTE or TEXT) columns in
27054 *   the query, you can add a {@link blobidarray} parameter containing
27055 *   the corresponding "blob ids", and you should replace those columns
27056 *   with a "?" in the query text.
27057 * @return resource
27058 * @since PHP 4, PHP
27059 **/
27060function ifx_query($query, $link_identifier, $cursor_type, $blobidarray){}
27061
27062/**
27063 * Sets the default text mode for all select-queries.
27064 *
27065 * @param int $mode Mode "0" will return a blob id, and mode "1" will
27066 *   return a varchar with text content.
27067 * @return bool
27068 * @since PHP 4, PHP
27069 **/
27070function ifx_textasvarchar($mode){}
27071
27072/**
27073 * Updates the content of the blob object for the given blob object
27074 * {@link bid}.
27075 *
27076 * @param int $bid A BLOB object identifier.
27077 * @param string $content The new data, as a string.
27078 * @return bool
27079 * @since PHP 4, PHP
27080 **/
27081function ifx_update_blob($bid, $content){}
27082
27083/**
27084 * Updates the content of the char object for the given char object
27085 * {@link bid}.
27086 *
27087 * @param int $bid A char object identifier.
27088 * @param string $content The new data, as a string.
27089 * @return bool
27090 * @since PHP 4, PHP
27091 **/
27092function ifx_update_char($bid, $content){}
27093
27094/**
27095 * Sets whether a client disconnect should cause a script to be aborted.
27096 *
27097 * When running PHP as a command line script, and the script's tty goes
27098 * away without the script being terminated then the script will die the
27099 * next time it tries to write anything, unless {@link value} is set to
27100 *
27101 * @param string $value If set, this function will set the
27102 *   ignore_user_abort ini setting to the given {@link value}. If not,
27103 *   this function will only return the previous setting without changing
27104 *   it.
27105 * @return int
27106 * @since PHP 4, PHP 5
27107 **/
27108function ignore_user_abort($value){}
27109
27110/**
27111 * @param string $path
27112 * @param string $comment
27113 * @param string $server_ip
27114 * @param int $port
27115 * @param string $host_name
27116 * @param int $rights
27117 * @param int $start_server
27118 * @return int
27119 * @since PECL iisfunc SVN
27120 **/
27121function iis_add_server($path, $comment, $server_ip, $port, $host_name, $rights, $start_server){}
27122
27123/**
27124 * @param int $server_instance
27125 * @param string $virtual_path
27126 * @return int
27127 * @since PECL iisfunc SVN
27128 **/
27129function iis_get_dir_security($server_instance, $virtual_path){}
27130
27131/**
27132 * @param int $server_instance
27133 * @param string $virtual_path
27134 * @param string $script_extension
27135 * @return string
27136 * @since PECL iisfunc SVN
27137 **/
27138function iis_get_script_map($server_instance, $virtual_path, $script_extension){}
27139
27140/**
27141 * @param string $comment
27142 * @return int
27143 * @since PECL iisfunc SVN
27144 **/
27145function iis_get_server_by_comment($comment){}
27146
27147/**
27148 * Each virtual server in IIS is associated with an instance number.
27149 * {@link iis_get_server_by_path} finds the instance number from the
27150 * actual path to the root directory.
27151 *
27152 * @param string $path The path to the root directory
27153 * @return int
27154 * @since PECL iisfunc SVN
27155 **/
27156function iis_get_server_by_path($path){}
27157
27158/**
27159 * @param int $server_instance
27160 * @param string $virtual_path
27161 * @return int
27162 * @since PECL iisfunc SVN
27163 **/
27164function iis_get_server_rights($server_instance, $virtual_path){}
27165
27166/**
27167 * @param string $service_id
27168 * @return int
27169 * @since PECL iisfunc SVN
27170 **/
27171function iis_get_service_state($service_id){}
27172
27173/**
27174 * @param int $server_instance
27175 * @return int
27176 * @since PECL iisfunc SVN
27177 **/
27178function iis_remove_server($server_instance){}
27179
27180/**
27181 * @param int $server_instance
27182 * @param string $virtual_path
27183 * @param string $application_scope
27184 * @return int
27185 * @since PECL iisfunc SVN
27186 **/
27187function iis_set_app_settings($server_instance, $virtual_path, $application_scope){}
27188
27189/**
27190 * @param int $server_instance
27191 * @param string $virtual_path
27192 * @param int $directory_flags
27193 * @return int
27194 * @since PECL iisfunc SVN
27195 **/
27196function iis_set_dir_security($server_instance, $virtual_path, $directory_flags){}
27197
27198/**
27199 * @param int $server_instance
27200 * @param string $virtual_path
27201 * @param string $script_extension
27202 * @param string $engine_path
27203 * @param int $allow_scripting
27204 * @return int
27205 * @since PECL iisfunc SVN
27206 **/
27207function iis_set_script_map($server_instance, $virtual_path, $script_extension, $engine_path, $allow_scripting){}
27208
27209/**
27210 * @param int $server_instance
27211 * @param string $virtual_path
27212 * @param int $directory_flags
27213 * @return int
27214 * @since PECL iisfunc SVN
27215 **/
27216function iis_set_server_rights($server_instance, $virtual_path, $directory_flags){}
27217
27218/**
27219 * @param int $server_instance
27220 * @return int
27221 * @since PECL iisfunc SVN
27222 **/
27223function iis_start_server($server_instance){}
27224
27225/**
27226 * @param string $service_id
27227 * @return int
27228 * @since PECL iisfunc SVN
27229 **/
27230function iis_start_service($service_id){}
27231
27232/**
27233 * @param int $server_instance
27234 * @return int
27235 * @since PECL iisfunc SVN
27236 **/
27237function iis_stop_server($server_instance){}
27238
27239/**
27240 * @param string $service_id
27241 * @return int
27242 * @since PECL iisfunc SVN
27243 **/
27244function iis_stop_service($service_id){}
27245
27246/**
27247 * {@link image2wbmp} outputs or save a WBMP version of the given {@link
27248 * image}.
27249 *
27250 * @param resource $image Path to the saved file. If not given, the raw
27251 *   image stream will be outputted directly.
27252 * @param string $filename Threshold value, between 0 and 255
27253 *   (inclusive).
27254 * @param int $threshold
27255 * @return bool
27256 * @since PHP 4 >= 4.0.5, PHP 5
27257 **/
27258function image2wbmp($image, $filename, $threshold){}
27259
27260/**
27261 * {@link imagealphablending} allows for two different modes of drawing
27262 * on truecolor images. In blending mode, the alpha channel component of
27263 * the color supplied to all drawing function, such as {@link
27264 * imagesetpixel} determines how much of the underlying color should be
27265 * allowed to shine through. As a result, gd automatically blends the
27266 * existing color at that point with the drawing color, and stores the
27267 * result in the image. The resulting pixel is opaque. In non-blending
27268 * mode, the drawing color is copied literally with its alpha channel
27269 * information, replacing the destination pixel. Blending mode is not
27270 * available when drawing on palette images.
27271 *
27272 * @param resource $image Whether to enable the blending mode or not.
27273 *   On true color images the default value is otherwise the default
27274 *   value is
27275 * @param bool $blendmode
27276 * @return bool
27277 * @since PHP 4 >= 4.0.6, PHP 5
27278 **/
27279function imagealphablending($image, $blendmode){}
27280
27281/**
27282 * Activate the fast drawing antialiased methods for lines and wired
27283 * polygons. It does not support alpha components. It works using a
27284 * direct blend operation. It works only with truecolor images.
27285 *
27286 * Thickness and styled are not supported.
27287 *
27288 * Using antialiased primitives with transparent background color can end
27289 * with some unexpected results. The blend method uses the background
27290 * color as any other colors. The lack of alpha component support does
27291 * not allow an alpha based antialiasing method.
27292 *
27293 * @param resource $image Whether to enable antialiasing or not.
27294 * @param bool $enabled
27295 * @return bool
27296 * @since PHP 4 >= 4.3.2, PHP 5
27297 **/
27298function imageantialias($image, $enabled){}
27299
27300/**
27301 * {@link imagearc} draws an arc of circle centered at the given
27302 * coordinates.
27303 *
27304 * @param resource $image x-coordinate of the center.
27305 * @param int $cx y-coordinate of the center.
27306 * @param int $cy The arc width.
27307 * @param int $width The arc height.
27308 * @param int $height The arc start angle, in degrees.
27309 * @param int $start The arc end angle, in degrees. 0° is located at
27310 *   the three-o'clock position, and the arc is drawn clockwise.
27311 * @param int $end A color identifier created with {@link
27312 *   imagecolorallocate}.
27313 * @param int $color
27314 * @return bool
27315 * @since PHP 4, PHP 5
27316 **/
27317function imagearc($image, $cx, $cy, $width, $height, $start, $end, $color){}
27318
27319/**
27320 * {@link imagechar} draws the first character of {@link c} in the image
27321 * identified by {@link image} with its upper-left at {@link x},{@link y}
27322 * (top left is 0, 0) with the color {@link color}.
27323 *
27324 * @param resource $image x-coordinate of the start.
27325 * @param int $font y-coordinate of the start.
27326 * @param int $x The character to draw.
27327 * @param int $y A color identifier created with {@link
27328 *   imagecolorallocate}.
27329 * @param string $c
27330 * @param int $color
27331 * @return bool
27332 * @since PHP 4, PHP 5
27333 **/
27334function imagechar($image, $font, $x, $y, $c, $color){}
27335
27336/**
27337 * Draws the character {@link c} vertically at the specified coordinate
27338 * on the given {@link image}.
27339 *
27340 * @param resource $image x-coordinate of the start.
27341 * @param int $font y-coordinate of the start.
27342 * @param int $x The character to draw.
27343 * @param int $y A color identifier created with {@link
27344 *   imagecolorallocate}.
27345 * @param string $c
27346 * @param int $color
27347 * @return bool
27348 * @since PHP 4, PHP 5
27349 **/
27350function imagecharup($image, $font, $x, $y, $c, $color){}
27351
27352/**
27353 * Returns a color identifier representing the color composed of the
27354 * given RGB components.
27355 *
27356 * {@link imagecolorallocate} must be called to create each color that is
27357 * to be used in the image represented by {@link image}.
27358 *
27359 * @param resource $image Value of red component.
27360 * @param int $red Value of green component.
27361 * @param int $green Value of blue component.
27362 * @param int $blue
27363 * @return int
27364 * @since PHP 4, PHP 5
27365 **/
27366function imagecolorallocate($image, $red, $green, $blue){}
27367
27368/**
27369 * {@link imagecolorallocatealpha} behaves identically to {@link
27370 * imagecolorallocate} with the addition of the transparency parameter
27371 * {@link alpha}.
27372 *
27373 * @param resource $image Value of red component.
27374 * @param int $red Value of green component.
27375 * @param int $green Value of blue component.
27376 * @param int $blue A value between 0 and 127. 0 indicates completely
27377 *   opaque while 127 indicates completely transparent.
27378 * @param int $alpha
27379 * @return int
27380 * @since PHP 4 >= 4.3.2, PHP 5
27381 **/
27382function imagecolorallocatealpha($image, $red, $green, $blue, $alpha){}
27383
27384/**
27385 * Returns the index of the color of the pixel at the specified location
27386 * in the image specified by {@link image}.
27387 *
27388 * If PHP is compiled against GD library 2.0 or higher and the image is a
27389 * truecolor image, this function returns the RGB value of that pixel as
27390 * integer. Use bitshifting and masking to access the distinct red, green
27391 * and blue component values:
27392 *
27393 * @param resource $image x-coordinate of the point.
27394 * @param int $x y-coordinate of the point.
27395 * @param int $y
27396 * @return int
27397 * @since PHP 4, PHP 5
27398 **/
27399function imagecolorat($image, $x, $y){}
27400
27401/**
27402 * Returns the index of the color in the palette of the image which is
27403 * "closest" to the specified RGB value.
27404 *
27405 * The "distance" between the desired color and each color in the palette
27406 * is calculated as if the RGB values represented points in
27407 * three-dimensional space.
27408 *
27409 * If you created the image from a file, only colors used in the image
27410 * are resolved. Colors present only in the palette are not resolved.
27411 *
27412 * @param resource $image Value of red component.
27413 * @param int $red Value of green component.
27414 * @param int $green Value of blue component.
27415 * @param int $blue
27416 * @return int
27417 * @since PHP 4, PHP 5
27418 **/
27419function imagecolorclosest($image, $red, $green, $blue){}
27420
27421/**
27422 * Returns the index of the color in the palette of the image which is
27423 * "closest" to the specified RGB value and {@link alpha} level.
27424 *
27425 * @param resource $image Value of red component.
27426 * @param int $red Value of green component.
27427 * @param int $green Value of blue component.
27428 * @param int $blue A value between 0 and 127. 0 indicates completely
27429 *   opaque while 127 indicates completely transparent.
27430 * @param int $alpha
27431 * @return int
27432 * @since PHP 4 >= 4.0.6, PHP 5
27433 **/
27434function imagecolorclosestalpha($image, $red, $green, $blue, $alpha){}
27435
27436/**
27437 * Get the index of the color which has the hue, white and blackness
27438 * nearest the given color.
27439 *
27440 * @param resource $image Value of red component.
27441 * @param int $red Value of green component.
27442 * @param int $green Value of blue component.
27443 * @param int $blue
27444 * @return int
27445 * @since PHP 4 >= 4.0.1, PHP 5
27446 **/
27447function imagecolorclosesthwb($image, $red, $green, $blue){}
27448
27449/**
27450 * De-allocates a color previously allocated with {@link
27451 * imagecolorallocate} or {@link imagecolorallocatealpha}.
27452 *
27453 * @param resource $image The color identifier.
27454 * @param int $color
27455 * @return bool
27456 * @since PHP 4, PHP 5
27457 **/
27458function imagecolordeallocate($image, $color){}
27459
27460/**
27461 * Returns the index of the specified color in the palette of the image.
27462 *
27463 * If you created the image from a file, only colors used in the image
27464 * are resolved. Colors present only in the palette are not resolved.
27465 *
27466 * @param resource $image Value of red component.
27467 * @param int $red Value of green component.
27468 * @param int $green Value of blue component.
27469 * @param int $blue
27470 * @return int
27471 * @since PHP 4, PHP 5
27472 **/
27473function imagecolorexact($image, $red, $green, $blue){}
27474
27475/**
27476 * Returns the index of the specified color+alpha in the palette of the
27477 * image.
27478 *
27479 * @param resource $image Value of red component.
27480 * @param int $red Value of green component.
27481 * @param int $green Value of blue component.
27482 * @param int $blue A value between 0 and 127. 0 indicates completely
27483 *   opaque while 127 indicates completely transparent.
27484 * @param int $alpha
27485 * @return int
27486 * @since PHP 4 >= 4.0.6, PHP 5
27487 **/
27488function imagecolorexactalpha($image, $red, $green, $blue, $alpha){}
27489
27490/**
27491 * Makes the colors of the palette version of an image more closely match
27492 * the true color version.
27493 *
27494 * @param resource $image1 A truecolor image link resource.
27495 * @param resource $image2 A palette image link resource pointing to an
27496 *   image that has the same size as {@link image1}.
27497 * @return bool
27498 * @since PHP 4 >= 4.3.0, PHP 5
27499 **/
27500function imagecolormatch($image1, $image2){}
27501
27502/**
27503 * This function is guaranteed to return a color index for a requested
27504 * color, either the exact color or the closest possible alternative.
27505 *
27506 * If you created the image from a file, only colors used in the image
27507 * are resolved. Colors present only in the palette are not resolved.
27508 *
27509 * @param resource $image Value of red component.
27510 * @param int $red Value of green component.
27511 * @param int $green Value of blue component.
27512 * @param int $blue
27513 * @return int
27514 * @since PHP 4, PHP 5
27515 **/
27516function imagecolorresolve($image, $red, $green, $blue){}
27517
27518/**
27519 * This function is guaranteed to return a color index for a requested
27520 * color, either the exact color or the closest possible alternative.
27521 *
27522 * @param resource $image Value of red component.
27523 * @param int $red Value of green component.
27524 * @param int $green Value of blue component.
27525 * @param int $blue A value between 0 and 127. 0 indicates completely
27526 *   opaque while 127 indicates completely transparent.
27527 * @param int $alpha
27528 * @return int
27529 * @since PHP 4 >= 4.0.6, PHP 5
27530 **/
27531function imagecolorresolvealpha($image, $red, $green, $blue, $alpha){}
27532
27533/**
27534 * This sets the specified index in the palette to the specified color.
27535 * This is useful for creating flood-fill-like effects in palleted images
27536 * without the overhead of performing the actual flood-fill.
27537 *
27538 * @param resource $image An index in the palette.
27539 * @param int $index Value of red component.
27540 * @param int $red Value of green component.
27541 * @param int $green Value of blue component.
27542 * @param int $blue Value of alpha component.
27543 * @param int $alpha
27544 * @return void
27545 * @since PHP 4, PHP 5
27546 **/
27547function imagecolorset($image, $index, $red, $green, $blue, $alpha){}
27548
27549/**
27550 * Gets the color for a specified index.
27551 *
27552 * @param resource $image The color index.
27553 * @param int $index
27554 * @return array
27555 * @since PHP 4, PHP 5
27556 **/
27557function imagecolorsforindex($image, $index){}
27558
27559/**
27560 * Returns the number of colors in an image palette.
27561 *
27562 * @param resource $image An image resource, returned by one of the
27563 *   image creation functions, such as {@link imagecreatefromgif}.
27564 * @return int
27565 * @since PHP 4, PHP 5
27566 **/
27567function imagecolorstotal($image){}
27568
27569/**
27570 * Sets the transparent color in the given {@link image}.
27571 *
27572 * @param resource $image A color identifier created with {@link
27573 *   imagecolorallocate}.
27574 * @param int $color
27575 * @return int
27576 * @since PHP 4, PHP 5
27577 **/
27578function imagecolortransparent($image, $color){}
27579
27580/**
27581 * Applies a convolution matrix on the image, using the given coefficient
27582 * and offset.
27583 *
27584 * @param resource $image A 3x3 matrix: an array of three arrays of
27585 *   three floats.
27586 * @param array $matrix The divisor of the result of the convolution,
27587 *   used for normalization.
27588 * @param float $div Color offset.
27589 * @param float $offset
27590 * @return bool
27591 * @since PHP 5 >= 5.1.0
27592 **/
27593function imageconvolution($image, $matrix, $div, $offset){}
27594
27595/**
27596 * Copy a part of {@link src_im} onto {@link dst_im} starting at the x,y
27597 * coordinates {@link src_x}, {@link src_y } with a width of {@link
27598 * src_w} and a height of {@link src_h}. The portion defined will be
27599 * copied onto the x,y coordinates, {@link dst_x} and {@link dst_y}.
27600 *
27601 * @param resource $dst_im Destination image link resource.
27602 * @param resource $src_im Source image link resource.
27603 * @param int $dst_x x-coordinate of destination point.
27604 * @param int $dst_y y-coordinate of destination point.
27605 * @param int $src_x x-coordinate of source point.
27606 * @param int $src_y y-coordinate of source point.
27607 * @param int $src_w Source width.
27608 * @param int $src_h Source height.
27609 * @return bool
27610 * @since PHP 4, PHP 5
27611 **/
27612function imagecopy($dst_im, $src_im, $dst_x, $dst_y, $src_x, $src_y, $src_w, $src_h){}
27613
27614/**
27615 * Copy a part of {@link src_im} onto {@link dst_im} starting at the x,y
27616 * coordinates {@link src_x}, {@link src_y } with a width of {@link
27617 * src_w} and a height of {@link src_h}. The portion defined will be
27618 * copied onto the x,y coordinates, {@link dst_x} and {@link dst_y}.
27619 *
27620 * @param resource $dst_im Destination image link resource.
27621 * @param resource $src_im Source image link resource.
27622 * @param int $dst_x x-coordinate of destination point.
27623 * @param int $dst_y y-coordinate of destination point.
27624 * @param int $src_x x-coordinate of source point.
27625 * @param int $src_y y-coordinate of source point.
27626 * @param int $src_w Source width.
27627 * @param int $src_h Source height.
27628 * @param int $pct The two images will be merged according to {@link
27629 *   pct} which can range from 0 to 100. When {@link pct} = 0, no action
27630 *   is taken, when 100 this function behaves identically to {@link
27631 *   imagecopy} for pallete images, while it implements alpha
27632 *   transparency for true colour images.
27633 * @return bool
27634 * @since PHP 4 >= 4.0.1, PHP 5
27635 **/
27636function imagecopymerge($dst_im, $src_im, $dst_x, $dst_y, $src_x, $src_y, $src_w, $src_h, $pct){}
27637
27638/**
27639 * {@link imagecopymergegray} copy a part of {@link src_im} onto {@link
27640 * dst_im} starting at the x,y coordinates {@link src_x}, {@link src_y }
27641 * with a width of {@link src_w} and a height of {@link src_h}. The
27642 * portion defined will be copied onto the x,y coordinates, {@link dst_x}
27643 * and {@link dst_y}.
27644 *
27645 * This function is identical to {@link imagecopymerge} except that when
27646 * merging it preserves the hue of the source by converting the
27647 * destination pixels to gray scale before the copy operation.
27648 *
27649 * @param resource $dst_im Destination image link resource.
27650 * @param resource $src_im Source image link resource.
27651 * @param int $dst_x x-coordinate of destination point.
27652 * @param int $dst_y y-coordinate of destination point.
27653 * @param int $src_x x-coordinate of source point.
27654 * @param int $src_y y-coordinate of source point.
27655 * @param int $src_w Source width.
27656 * @param int $src_h Source height.
27657 * @param int $pct The {@link src_im} will be changed to grayscale
27658 *   according to {@link pct} where 0 is fully grayscale and 100 is
27659 *   unchanged. When {@link pct} = 100 this function behaves identically
27660 *   to {@link imagecopy} for pallete images, while it implements alpha
27661 *   transparency for true colour images.
27662 * @return bool
27663 * @since PHP 4 >= 4.0.6, PHP 5
27664 **/
27665function imagecopymergegray($dst_im, $src_im, $dst_x, $dst_y, $src_x, $src_y, $src_w, $src_h, $pct){}
27666
27667/**
27668 * {@link imagecopyresampled} copies a rectangular portion of one image
27669 * to another image, smoothly interpolating pixel values so that, in
27670 * particular, reducing the size of an image still retains a great deal
27671 * of clarity.
27672 *
27673 * In other words, {@link imagecopyresampled} will take an rectangular
27674 * area from {@link src_image} of width {@link src_w} and height {@link
27675 * src_h} at position ({@link src_x},{@link src_y}) and place it in a
27676 * rectangular area of {@link dst_image} of width {@link dst_w} and
27677 * height {@link dst_h} at position ({@link dst_x},{@link dst_y}).
27678 *
27679 * If the source and destination coordinates and width and heights
27680 * differ, appropriate stretching or shrinking of the image fragment will
27681 * be performed. The coordinates refer to the upper left corner. This
27682 * function can be used to copy regions within the same image (if {@link
27683 * dst_image} is the same as {@link src_image}) but if the regions
27684 * overlap the results will be unpredictable.
27685 *
27686 * @param resource $dst_image Destination image link resource.
27687 * @param resource $src_image Source image link resource.
27688 * @param int $dst_x x-coordinate of destination point.
27689 * @param int $dst_y y-coordinate of destination point.
27690 * @param int $src_x x-coordinate of source point.
27691 * @param int $src_y y-coordinate of source point.
27692 * @param int $dst_w Destination width.
27693 * @param int $dst_h Destination height.
27694 * @param int $src_w Source width.
27695 * @param int $src_h Source height.
27696 * @return bool
27697 * @since PHP 4 >= 4.0.6, PHP 5
27698 **/
27699function imagecopyresampled($dst_image, $src_image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h){}
27700
27701/**
27702 * {@link imagecopyresized} copies a rectangular portion of one image to
27703 * another image. {@link dst_image} is the destination image, {@link
27704 * src_image} is the source image identifier.
27705 *
27706 * In other words, {@link imagecopyresized} will take an rectangular area
27707 * from {@link src_image} of width {@link src_w} and height {@link src_h}
27708 * at position ({@link src_x},{@link src_y}) and place it in a
27709 * rectangular area of {@link dst_image} of width {@link dst_w} and
27710 * height {@link dst_h} at position ({@link dst_x},{@link dst_y}).
27711 *
27712 * If the source and destination coordinates and width and heights
27713 * differ, appropriate stretching or shrinking of the image fragment will
27714 * be performed. The coordinates refer to the upper left corner. This
27715 * function can be used to copy regions within the same image (if {@link
27716 * dst_image} is the same as {@link src_image}) but if the regions
27717 * overlap the results will be unpredictable.
27718 *
27719 * @param resource $dst_image Destination image link resource.
27720 * @param resource $src_image Source image link resource.
27721 * @param int $dst_x x-coordinate of destination point.
27722 * @param int $dst_y y-coordinate of destination point.
27723 * @param int $src_x x-coordinate of source point.
27724 * @param int $src_y y-coordinate of source point.
27725 * @param int $dst_w Destination width.
27726 * @param int $dst_h Destination height.
27727 * @param int $src_w Source width.
27728 * @param int $src_h Source height.
27729 * @return bool
27730 * @since PHP 4, PHP 5
27731 **/
27732function imagecopyresized($dst_image, $src_image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h){}
27733
27734/**
27735 * {@link imagecreate} returns an image identifier representing a blank
27736 * image of specified size.
27737 *
27738 * We recommend the use of {@link imagecreatetruecolor}.
27739 *
27740 * @param int $width The image width.
27741 * @param int $height The image height.
27742 * @return resource
27743 * @since PHP 4, PHP 5
27744 **/
27745function imagecreate($width, $height){}
27746
27747/**
27748 * Create a new image from GD file or URL.
27749 *
27750 * @param string $filename Path to the GD file.
27751 * @return resource
27752 * @since PHP 4 >= 4.0.7, PHP 5
27753 **/
27754function imagecreatefromgd($filename){}
27755
27756/**
27757 * Create a new image from GD2 file or URL.
27758 *
27759 * @param string $filename Path to the GD2 image.
27760 * @return resource
27761 * @since PHP 4 >= 4.0.7, PHP 5
27762 **/
27763function imagecreatefromgd2($filename){}
27764
27765/**
27766 * Create a new image from a given part of GD2 file or URL.
27767 *
27768 * @param string $filename Path to the GD2 image.
27769 * @param int $srcX x-coordinate of source point.
27770 * @param int $srcY y-coordinate of source point.
27771 * @param int $width Source width.
27772 * @param int $height Source height.
27773 * @return resource
27774 * @since PHP 4 >= 4.0.7, PHP 5
27775 **/
27776function imagecreatefromgd2part($filename, $srcX, $srcY, $width, $height){}
27777
27778/**
27779 * {@link imagecreatefromgif} returns an image identifier representing
27780 * the image obtained from the given filename.
27781 *
27782 * @param string $filename Path to the GIF image.
27783 * @return resource
27784 * @since PHP 4, PHP 5
27785 **/
27786function imagecreatefromgif($filename){}
27787
27788/**
27789 * {@link imagecreatefromjpeg} returns an image identifier representing
27790 * the image obtained from the given filename.
27791 *
27792 * @param string $filename Path to the JPEG image.
27793 * @return resource
27794 * @since PHP 4, PHP 5
27795 **/
27796function imagecreatefromjpeg($filename){}
27797
27798/**
27799 * {@link imagecreatefrompng} returns an image identifier representing
27800 * the image obtained from the given filename.
27801 *
27802 * @param string $filename Path to the PNG image.
27803 * @return resource
27804 * @since PHP 4, PHP 5
27805 **/
27806function imagecreatefrompng($filename){}
27807
27808/**
27809 * {@link imagecreatefromstring} returns an image identifier representing
27810 * the image obtained from the given {@link data}. These types will be
27811 * automatically detected if your build of PHP supports them: JPEG, PNG,
27812 * GIF, WBMP, and GD2.
27813 *
27814 * @param string $data A string containing the image data.
27815 * @return resource
27816 * @since PHP 4 >= 4.0.4, PHP 5
27817 **/
27818function imagecreatefromstring($data){}
27819
27820/**
27821 * {@link imagecreatefromwbmp} returns an image identifier representing
27822 * the image obtained from the given filename.
27823 *
27824 * @param string $filename Path to the WBMP image.
27825 * @return resource
27826 * @since PHP 4 >= 4.0.1, PHP 5
27827 **/
27828function imagecreatefromwbmp($filename){}
27829
27830/**
27831 * {@link imagecreatefromxbm} returns an image identifier representing
27832 * the image obtained from the given filename.
27833 *
27834 * @param string $filename Path to the XBM image.
27835 * @return resource
27836 * @since PHP 4 >= 4.0.1, PHP 5
27837 **/
27838function imagecreatefromxbm($filename){}
27839
27840/**
27841 * {@link imagecreatefromxpm} returns an image identifier representing
27842 * the image obtained from the given filename.
27843 *
27844 * @param string $filename Path to the XPM image.
27845 * @return resource
27846 * @since PHP 4 >= 4.0.1, PHP 5
27847 **/
27848function imagecreatefromxpm($filename){}
27849
27850/**
27851 * {@link imagecreatetruecolor} returns an image identifier representing
27852 * a black image of the specified size.
27853 *
27854 * Depending on your PHP and GD versions this function is defined or not.
27855 * With PHP 4.0.6 through 4.1.x this function always exists if the GD
27856 * module is loaded, but calling it without GD2 being installed PHP will
27857 * issue a fatal error and exit. With PHP 4.2.x this behaviour is
27858 * different in issuing a warning instead of an error. Other versions
27859 * only define this function, if the correct GD version is installed.
27860 *
27861 * @param int $width Image width.
27862 * @param int $height Image height.
27863 * @return resource
27864 * @since PHP 4 >= 4.0.6, PHP 5
27865 **/
27866function imagecreatetruecolor($width, $height){}
27867
27868/**
27869 * This function is deprecated. Use combination of {@link imagesetstyle}
27870 * and {@link imageline} instead.
27871 *
27872 * @param resource $image Upper left x coordinate.
27873 * @param int $x1 Upper left y coordinate 0, 0 is the top left corner
27874 *   of the image.
27875 * @param int $y1 Bottom right x coordinate.
27876 * @param int $x2 Bottom right y coordinate.
27877 * @param int $y2 The fill color. A color identifier created with
27878 *   {@link imagecolorallocate}.
27879 * @param int $color
27880 * @return bool
27881 * @since PHP 4, PHP 5
27882 **/
27883function imagedashedline($image, $x1, $y1, $x2, $y2, $color){}
27884
27885/**
27886 * {@link imagedestroy} frees any memory associated with image {@link
27887 * image}.
27888 *
27889 * @param resource $image
27890 * @return bool
27891 * @since PHP 4, PHP 5
27892 **/
27893function imagedestroy($image){}
27894
27895/**
27896 * Draws an ellipse centered at the specified coordinates.
27897 *
27898 * @param resource $image x-coordinate of the center.
27899 * @param int $cx y-coordinate of the center.
27900 * @param int $cy The ellipse width.
27901 * @param int $width The ellipse height.
27902 * @param int $height The color of the ellipse. A color identifier
27903 *   created with {@link imagecolorallocate}.
27904 * @param int $color
27905 * @return bool
27906 * @since PHP 4 >= 4.0.6, PHP 5
27907 **/
27908function imageellipse($image, $cx, $cy, $width, $height, $color){}
27909
27910/**
27911 * Performs a flood fill starting at the given coordinate (top left is 0,
27912 * 0) with the given {@link color} in the {@link image}.
27913 *
27914 * @param resource $image x-coordinate of start point.
27915 * @param int $x y-coordinate of start point.
27916 * @param int $y The fill color. A color identifier created with {@link
27917 *   imagecolorallocate}.
27918 * @param int $color
27919 * @return bool
27920 * @since PHP 4, PHP 5
27921 **/
27922function imagefill($image, $x, $y, $color){}
27923
27924/**
27925 * Draws a partial arc centered at the specified coordinate in the given
27926 * {@link image}.
27927 *
27928 * @param resource $image x-coordinate of the center.
27929 * @param int $cx y-coordinate of the center.
27930 * @param int $cy The arc width.
27931 * @param int $width The arc height.
27932 * @param int $height The arc start angle, in degrees.
27933 * @param int $start The arc end angle, in degrees. 0° is located at
27934 *   the three-o'clock position, and the arc is drawn clockwise.
27935 * @param int $end A color identifier created with {@link
27936 *   imagecolorallocate}.
27937 * @param int $color A bitwise OR of the following possibilities:
27938 *   IMG_ARC_PIE IMG_ARC_CHORD IMG_ARC_NOFILL IMG_ARC_EDGED IMG_ARC_PIE
27939 *   and IMG_ARC_CHORD are mutually exclusive; IMG_ARC_CHORD just
27940 *   connects the starting and ending angles with a straight line, while
27941 *   IMG_ARC_PIE produces a rounded edge. IMG_ARC_NOFILL indicates that
27942 *   the arc or chord should be outlined, not filled. IMG_ARC_EDGED, used
27943 *   together with IMG_ARC_NOFILL, indicates that the beginning and
27944 *   ending angles should be connected to the center - this is a good way
27945 *   to outline (rather than fill) a 'pie slice'.
27946 * @param int $style
27947 * @return bool
27948 * @since PHP 4 >= 4.0.6, PHP 5
27949 **/
27950function imagefilledarc($image, $cx, $cy, $width, $height, $start, $end, $color, $style){}
27951
27952/**
27953 * Draws an ellipse centered at the specified coordinate on the given
27954 * {@link image}.
27955 *
27956 * @param resource $image x-coordinate of the center.
27957 * @param int $cx y-coordinate of the center.
27958 * @param int $cy The ellipse width.
27959 * @param int $width The ellipse height.
27960 * @param int $height The fill color. A color identifier created with
27961 *   {@link imagecolorallocate}.
27962 * @param int $color
27963 * @return bool
27964 * @since PHP 4 >= 4.0.6, PHP 5
27965 **/
27966function imagefilledellipse($image, $cx, $cy, $width, $height, $color){}
27967
27968/**
27969 * {@link imagefilledpolygon} creates a filled polygon in the given
27970 * {@link image}.
27971 *
27972 * @param resource $image An array containing the x and y coordinates
27973 *   of the polygons vertices consecutively.
27974 * @param array $points Total number of vertices, which must be at
27975 *   least 3.
27976 * @param int $num_points A color identifier created with {@link
27977 *   imagecolorallocate}.
27978 * @param int $color
27979 * @return bool
27980 * @since PHP 4, PHP 5
27981 **/
27982function imagefilledpolygon($image, $points, $num_points, $color){}
27983
27984/**
27985 * Creates a rectangle filled with {@link color} in the given {@link
27986 * image} starting at point 1 and ending at point 2. 0, 0 is the top left
27987 * corner of the image.
27988 *
27989 * @param resource $image x-coordinate for point 1.
27990 * @param int $x1 y-coordinate for point 1.
27991 * @param int $y1 x-coordinate for point 2.
27992 * @param int $x2 y-coordinate for point 2.
27993 * @param int $y2 The fill color. A color identifier created with
27994 *   {@link imagecolorallocate}.
27995 * @param int $color
27996 * @return bool
27997 * @since PHP 4, PHP 5
27998 **/
27999function imagefilledrectangle($image, $x1, $y1, $x2, $y2, $color){}
28000
28001/**
28002 * {@link imagefilltoborder} performs a flood fill whose border color is
28003 * defined by {@link border}. The starting point for the fill is {@link
28004 * x}, {@link y} (top left is 0, 0) and the region is filled with color
28005 * {@link color}.
28006 *
28007 * @param resource $image x-coordinate of start.
28008 * @param int $x y-coordinate of start.
28009 * @param int $y The border color. A color identifier created with
28010 *   {@link imagecolorallocate}.
28011 * @param int $border The fill color. A color identifier created with
28012 *   {@link imagecolorallocate}.
28013 * @param int $color
28014 * @return bool
28015 * @since PHP 4, PHP 5
28016 **/
28017function imagefilltoborder($image, $x, $y, $border, $color){}
28018
28019/**
28020 * {@link imagefilter} applies the given filter {@link filtertype} on the
28021 * {@link image}.
28022 *
28023 * @param resource $image {@link filtertype} can be one of the
28024 *   following: IMG_FILTER_NEGATE: Reverses all colors of the image.
28025 *   IMG_FILTER_GRAYSCALE: Converts the image into grayscale.
28026 *   IMG_FILTER_BRIGHTNESS: Changes the brightness of the image. Use
28027 *   {@link arg1} to set the level of brightness. IMG_FILTER_CONTRAST:
28028 *   Changes the contrast of the image. Use {@link arg1} to set the level
28029 *   of contrast. IMG_FILTER_COLORIZE: Like IMG_FILTER_GRAYSCALE, except
28030 *   you can specify the color. Use {@link arg1}, {@link arg2} and {@link
28031 *   arg3} in the form of {@link red}, {@link blue}, {@link green} and
28032 *   {@link arg4} for the {@link alpha} channel. The range for each color
28033 *   is 0 to 255. IMG_FILTER_EDGEDETECT: Uses edge detection to highlight
28034 *   the edges in the image. IMG_FILTER_EMBOSS: Embosses the image.
28035 *   IMG_FILTER_GAUSSIAN_BLUR: Blurs the image using the Gaussian method.
28036 *   IMG_FILTER_SELECTIVE_BLUR: Blurs the image. IMG_FILTER_MEAN_REMOVAL:
28037 *   Uses mean removal to achieve a "sketchy" effect. IMG_FILTER_SMOOTH:
28038 *   Makes the image smoother. Use {@link arg1} to set the level of
28039 *   smoothness. IMG_FILTER_PIXELATE: Applies pixelation effect to the
28040 *   image, use {@link arg1} to set the block size and {@link arg2} to
28041 *   set the pixelation effect mode.
28042 * @param int $filtertype IMG_FILTER_BRIGHTNESS: Brightness level.
28043 *   IMG_FILTER_CONTRAST: Contrast level. IMG_FILTER_COLORIZE: Value of
28044 *   red component. IMG_FILTER_SMOOTH: Smoothness level.
28045 *   IMG_FILTER_PIXELATE: Block size in pixels.
28046 * @param int $arg1 IMG_FILTER_COLORIZE: Value of green component.
28047 *   IMG_FILTER_PIXELATE: Whether to use advanced pixelation effect or
28048 *   not (defaults to ).
28049 * @param int $arg2 IMG_FILTER_COLORIZE: Value of blue component.
28050 * @param int $arg3 IMG_FILTER_COLORIZE: Alpha channel, A value between
28051 *   0 and 127. 0 indicates completely opaque while 127 indicates
28052 *   completely transparent.
28053 * @param int $arg4
28054 * @return bool
28055 * @since PHP 5
28056 **/
28057function imagefilter($image, $filtertype, $arg1, $arg2, $arg3, $arg4){}
28058
28059/**
28060 * Returns the pixel height of a character in the specified font.
28061 *
28062 * @param int $font
28063 * @return int
28064 * @since PHP 4, PHP 5
28065 **/
28066function imagefontheight($font){}
28067
28068/**
28069 * Returns the pixel width of a character in font.
28070 *
28071 * @param int $font
28072 * @return int
28073 * @since PHP 4, PHP 5
28074 **/
28075function imagefontwidth($font){}
28076
28077/**
28078 * This function calculates and returns the bounding box in pixels for a
28079 * FreeType text.
28080 *
28081 * @param float $size The font size. Depending on your version of GD,
28082 *   this should be specified as the pixel size (GD1) or point size
28083 *   (GD2).
28084 * @param float $angle Angle in degrees in which {@link text} will be
28085 *   measured.
28086 * @param string $fontfile The name of the TrueType font file (can be a
28087 *   URL). Depending on which version of the GD library that PHP is
28088 *   using, it may attempt to search for files that do not begin with a
28089 *   leading '/' by appending '.ttf' to the filename and searching along
28090 *   a library-defined font path.
28091 * @param string $text The string to be measured.
28092 * @param array $extrainfo Possible array indexes for {@link extrainfo}
28093 *   Key Type Meaning linespacing float Defines drawing linespacing
28094 * @return array
28095 * @since PHP 4 >= 4.0.7, PHP 5
28096 **/
28097function imageftbbox($size, $angle, $fontfile, $text, $extrainfo){}
28098
28099/**
28100 * @param resource $image The font size to use in points.
28101 * @param float $size The angle in degrees, with 0 degrees being
28102 *   left-to-right reading text. Higher values represent a
28103 *   counter-clockwise rotation. For example, a value of 90 would result
28104 *   in bottom-to-top reading text.
28105 * @param float $angle The coordinates given by {@link x} and {@link y}
28106 *   will define the basepoint of the first character (roughly the
28107 *   lower-left corner of the character). This is different from the
28108 *   {@link imagestring}, where {@link x} and {@link y} define the
28109 *   upper-left corner of the first character. For example, "top left" is
28110 *   0, 0.
28111 * @param int $x The y-ordinate. This sets the position of the fonts
28112 *   baseline, not the very bottom of the character.
28113 * @param int $y The index of the desired color for the text, see
28114 *   {@link imagecolorexact}.
28115 * @param int $color The path to the TrueType font you wish to use.
28116 *   Depending on which version of the GD library PHP is using, when
28117 *   {@link fontfile} does not begin with a leading / then .ttf will be
28118 *   appended to the filename and the library will attempt to search for
28119 *   that filename along a library-defined font path. When using versions
28120 *   of the GD library lower than 2.0.18, a space character, rather than
28121 *   a semicolon, was used as the 'path separator' for different font
28122 *   files. Unintentional use of this feature will result in the warning
28123 *   message: Warning: Could not find/open font. For these affected
28124 *   versions, the only solution is moving the font to a path which does
28125 *   not contain spaces. In many cases where a font resides in the same
28126 *   directory as the script using it the following trick will alleviate
28127 *   any include problems.
28128 *
28129 *   <?php // Set the enviroment variable for GD putenv('GDFONTPATH=' .
28130 *   realpath('.'));
28131 *
28132 *   // Name the font to be used (note the lack of the .ttf extension)
28133 *   $font = 'SomeFont'; ?>
28134 * @param string $fontfile Text to be inserted into image.
28135 * @param string $text Possible array indexes for {@link extrainfo} Key
28136 *   Type Meaning linespacing float Defines drawing linespacing
28137 * @param array $extrainfo
28138 * @return array
28139 * @since PHP 4 >= 4.0.7, PHP 5
28140 **/
28141function imagefttext($image, $size, $angle, $x, $y, $color, $fontfile, $text, $extrainfo){}
28142
28143/**
28144 * Applies gamma correction to the given gd {@link image} given an input
28145 * and an output gamma.
28146 *
28147 * @param resource $image The input gamma.
28148 * @param float $inputgamma The output gamma.
28149 * @param float $outputgamma
28150 * @return bool
28151 * @since PHP 4, PHP 5
28152 **/
28153function imagegammacorrect($image, $inputgamma, $outputgamma){}
28154
28155/**
28156 * Outputs a GD image to the given {@link filename}.
28157 *
28158 * @param resource $image The path to save the file to. If not set or ,
28159 *   the raw image stream will be outputted directly.
28160 * @param string $filename
28161 * @return bool
28162 * @since PHP 4 >= 4.0.7, PHP 5
28163 **/
28164function imagegd($image, $filename){}
28165
28166/**
28167 * Outputs a GD2 image to the given {@link filename}.
28168 *
28169 * @param resource $image The path to save the file to. If not set or ,
28170 *   the raw image stream will be outputted directly.
28171 * @param string $filename Chunk size.
28172 * @param int $chunk_size Either IMG_GD2_RAW or IMG_GD2_COMPRESSED.
28173 *   Default is IMG_GD2_RAW.
28174 * @param int $type
28175 * @return bool
28176 * @since PHP 4 >= 4.0.7, PHP 5
28177 **/
28178function imagegd2($image, $filename, $chunk_size, $type){}
28179
28180/**
28181 * {@link imagegif} creates the GIF file in filename from the image
28182 * {@link image}. The {@link image} argument is the return from the
28183 * {@link imagecreate} or imagecreatefrom* function.
28184 *
28185 * The image format will be GIF87a unless the image has been made
28186 * transparent with {@link imagecolortransparent}, in which case the
28187 * image format will be GIF89a.
28188 *
28189 * @param resource $image The path to save the file to. If not set or ,
28190 *   the raw image stream will be outputted directly.
28191 * @param string $filename
28192 * @return bool
28193 * @since PHP 4, PHP 5
28194 **/
28195function imagegif($image, $filename){}
28196
28197/**
28198 * Grabs a screenshot of the whole screen.
28199 *
28200 * @return resource
28201 * @since PHP 5 >= 5.2.2
28202 **/
28203function imagegrabscreen(){}
28204
28205/**
28206 * Grabs a window or its client area using a windows handle (HWND
28207 * property in COM instance)
28208 *
28209 * @param int $window_handle The HWND window ID.
28210 * @param int $client_area Include the client area of the application
28211 *   window.
28212 * @return resource
28213 * @since PHP 5 >= 5.2.2
28214 **/
28215function imagegrabwindow($window_handle, $client_area){}
28216
28217/**
28218 * {@link imageinterlace} turns the interlace bit on or off.
28219 *
28220 * If the interlace bit is set and the image is used as a JPEG image, the
28221 * image is created as a progressive JPEG.
28222 *
28223 * @param resource $image If non-zero, the image will be interlaced,
28224 *   else the interlace bit is turned off.
28225 * @param int $interlace
28226 * @return int
28227 * @since PHP 4, PHP 5
28228 **/
28229function imageinterlace($image, $interlace){}
28230
28231/**
28232 * {@link imageistruecolor} finds whether the image {@link image} is a
28233 * truecolor image.
28234 *
28235 * @param resource $image
28236 * @return bool
28237 * @since PHP 4 >= 4.3.2, PHP 5
28238 **/
28239function imageistruecolor($image){}
28240
28241/**
28242 * {@link imagejpeg} creates a JPEG file from the given {@link image}.
28243 *
28244 * @param resource $image The path to save the file to. If not set or ,
28245 *   the raw image stream will be outputted directly. To skip this
28246 *   argument in order to provide the {@link quality} parameter, use .
28247 * @param string $filename {@link quality} is optional, and ranges from
28248 *   0 (worst quality, smaller file) to 100 (best quality, biggest file).
28249 *   The default is the default IJG quality value (about 75).
28250 * @param int $quality
28251 * @return bool
28252 * @since PHP 4, PHP 5
28253 **/
28254function imagejpeg($image, $filename, $quality){}
28255
28256/**
28257 * Set the alpha blending flag to use the bundled libgd layering effects.
28258 *
28259 * @param resource $image One of the following constants:
28260 *   IMG_EFFECT_REPLACE Use pixel replacement (equivalent of passing to
28261 *   {@link imagealphablending}) IMG_EFFECT_ALPHABLEND Use normal pixel
28262 *   blending (equivalent of passing to {@link imagealphablending})
28263 *   IMG_EFFECT_NORMAL Same as IMG_EFFECT_ALPHABLEND. IMG_EFFECT_OVERLAY
28264 *   Overlay has the effect that black background pixels will remain
28265 *   black, white background pixels will remain white, but grey
28266 *   background pixels will take the colour of the foreground pixel.
28267 * @param int $effect
28268 * @return bool
28269 * @since PHP 4 >= 4.3.0, PHP 5
28270 **/
28271function imagelayereffect($image, $effect){}
28272
28273/**
28274 * Draws a line between the two given points.
28275 *
28276 * @param resource $image x-coordinate for first point.
28277 * @param int $x1 y-coordinate for first point.
28278 * @param int $y1 x-coordinate for second point.
28279 * @param int $x2 y-coordinate for second point.
28280 * @param int $y2 The line color. A color identifier created with
28281 *   {@link imagecolorallocate}.
28282 * @param int $color
28283 * @return bool
28284 * @since PHP 4, PHP 5
28285 **/
28286function imageline($image, $x1, $y1, $x2, $y2, $color){}
28287
28288/**
28289 * {@link imageloadfont} loads a user-defined bitmap and returns its
28290 * identifier.
28291 *
28292 * @param string $file The font file format is currently binary and
28293 *   architecture dependent. This means you should generate the font
28294 *   files on the same type of CPU as the machine you are running PHP on.
28295 *
28296 *   Font file format byte position C data type description byte 0-3 int
28297 *   number of characters in the font byte 4-7 int value of first
28298 *   character in the font (often 32 for space) byte 8-11 int pixel width
28299 *   of each character byte 12-15 int pixel height of each character byte
28300 *   16- char array with character data, one byte per pixel in each
28301 *   character, for a total of (nchars*width*height) bytes.
28302 * @return int
28303 * @since PHP 4, PHP 5
28304 **/
28305function imageloadfont($file){}
28306
28307/**
28308 * {@link imagepalettecopy} copies the palette from the {@link source}
28309 * image to the {@link destination} image.
28310 *
28311 * @param resource $destination The destination image resource.
28312 * @param resource $source The source image resource.
28313 * @return void
28314 * @since PHP 4 >= 4.0.1, PHP 5
28315 **/
28316function imagepalettecopy($destination, $source){}
28317
28318/**
28319 * Outputs or saves a PNG image from the given {@link image}.
28320 *
28321 * @param resource $image The path to save the file to. If not set or ,
28322 *   the raw image stream will be outputted directly.
28323 * @param string $filename Compression level: from 0 (no compression)
28324 *   to 9.
28325 * @param int $quality Allows reducing the PNG file size. It is a
28326 *   bitmask field which may be set to any combination of the
28327 *   PNG_FILTER_XXX constants. PNG_NO_FILTER or PNG_ALL_FILTERS may also
28328 *   be used to respectively disable or activate all filters.
28329 * @param int $filters
28330 * @return bool
28331 * @since PHP 4, PHP 5
28332 **/
28333function imagepng($image, $filename, $quality, $filters){}
28334
28335/**
28336 * {@link imagepolygon} creates a polygon in the given {@link image}.
28337 *
28338 * @param resource $image An array containing the polygon's vertices,
28339 *   e.g.: points[0] = x0 points[1] = y0 points[2] = x1 points[3] = y1
28340 * @param array $points Total number of points (vertices).
28341 * @param int $num_points A color identifier created with {@link
28342 *   imagecolorallocate}.
28343 * @param int $color
28344 * @return bool
28345 * @since PHP 4, PHP 5
28346 **/
28347function imagepolygon($image, $points, $num_points, $color){}
28348
28349/**
28350 * Gives the bounding box of a text rectangle using PostScript Type1
28351 * fonts.
28352 *
28353 * The bounding box is calculated using information available from
28354 * character metrics, and unfortunately tends to differ slightly from the
28355 * results achieved by actually rasterizing the text. If the angle is 0
28356 * degrees, you can expect the text to need 1 pixel more to every
28357 * direction.
28358 *
28359 * @param string $text The text to be written.
28360 * @param resource $font A font resource, returned by {@link
28361 *   imagepsloadfont}.
28362 * @param int $size {@link size} is expressed in pixels.
28363 * @return array
28364 * @since PHP 4, PHP 5
28365 **/
28366function imagepsbbox($text, $font, $size){}
28367
28368/**
28369 * Loads a character encoding vector from a file and changes the fonts
28370 * encoding vector to it. As a PostScript fonts default vector lacks most
28371 * of the character positions above 127, you'll definitely want to change
28372 * this if you use an other language than English.
28373 *
28374 * If you find yourself using this function all the time, a much better
28375 * way to define the encoding is to set ps.default_encoding in the
28376 * configuration file to point to the right encoding file and all fonts
28377 * you load will automatically have the right encoding.
28378 *
28379 * @param resource $font_index A font resource, returned by {@link
28380 *   imagepsloadfont}.
28381 * @param string $encodingfile The exact format of this file is
28382 *   described in T1libs documentation. T1lib comes with two ready-to-use
28383 *   files, IsoLatin1.enc and IsoLatin2.enc.
28384 * @return bool
28385 * @since PHP 4, PHP 5
28386 **/
28387function imagepsencodefont($font_index, $encodingfile){}
28388
28389/**
28390 * Extend or condense a font ({@link font_index}), if the value of the
28391 * {@link extend} parameter is less than one you will be condensing the
28392 * font.
28393 *
28394 * @param resource $font_index A font resource, returned by {@link
28395 *   imagepsloadfont}.
28396 * @param float $extend Extension value, must be greater than 0.
28397 * @return bool
28398 * @since PHP 4, PHP 5
28399 **/
28400function imagepsextendfont($font_index, $extend){}
28401
28402/**
28403 * {@link imagepsfreefont} frees memory used by a PostScript Type 1 font.
28404 *
28405 * @param resource $font_index A font resource, returned by {@link
28406 *   imagepsloadfont}.
28407 * @return bool
28408 * @since PHP 4, PHP 5
28409 **/
28410function imagepsfreefont($font_index){}
28411
28412/**
28413 * Load a PostScript Type 1 font from the given {@link filename}.
28414 *
28415 * @param string $filename Path to the Postscript font file.
28416 * @return resource
28417 * @since PHP 4, PHP 5
28418 **/
28419function imagepsloadfont($filename){}
28420
28421/**
28422 * Slant a given font given.
28423 *
28424 * @param resource $font_index A font resource, returned by {@link
28425 *   imagepsloadfont}.
28426 * @param float $slant Slant level.
28427 * @return bool
28428 * @since PHP 4, PHP 5
28429 **/
28430function imagepsslantfont($font_index, $slant){}
28431
28432/**
28433 * Draws a text on an image using PostScript Type1 fonts.
28434 *
28435 * Refer to PostScript documentation about fonts and their measuring
28436 * system if you have trouble understanding how this works.
28437 *
28438 * @param resource $image The text to be written.
28439 * @param string $text A font resource, returned by {@link
28440 *   imagepsloadfont}.
28441 * @param resource $font_index {@link size} is expressed in pixels.
28442 * @param int $size The color in which the text will be painted.
28443 * @param int $foreground The color to which the text will try to fade
28444 *   in with antialiasing. No pixels with the color {@link background}
28445 *   are actually painted, so the background image does not need to be of
28446 *   solid color.
28447 * @param int $background x-coordinate for the lower-left corner of the
28448 *   first character.
28449 * @param int $x y-coordinate for the lower-left corner of the first
28450 *   character.
28451 * @param int $y Allows you to change the default value of a space in a
28452 *   font. This amount is added to the normal value and can also be
28453 *   negative. Expressed in character space units, where 1 unit is
28454 *   1/1000th of an em-square.
28455 * @param int $space {@link tightness} allows you to control the amount
28456 *   of white space between characters. This amount is added to the
28457 *   normal character width and can also be negative. Expressed in
28458 *   character space units, where 1 unit is 1/1000th of an em-square.
28459 * @param int $tightness {@link angle} is in degrees.
28460 * @param float $angle Allows you to control the number of colours used
28461 *   for antialiasing text. Allowed values are 4 and 16. The higher value
28462 *   is recommended for text sizes lower than 20, where the effect in
28463 *   text quality is quite visible. With bigger sizes, use 4. It's less
28464 *   computationally intensive.
28465 * @param int $antialias_steps
28466 * @return array
28467 * @since PHP 4, PHP 5
28468 **/
28469function imagepstext($image, $text, $font_index, $size, $foreground, $background, $x, $y, $space, $tightness, $angle, $antialias_steps){}
28470
28471/**
28472 * {@link imagerectangle} creates a rectangle starting at the specified
28473 * coordinates.
28474 *
28475 * @param resource $image Upper left x coordinate.
28476 * @param int $x1 Upper left y coordinate 0, 0 is the top left corner
28477 *   of the image.
28478 * @param int $y1 Bottom right x coordinate.
28479 * @param int $x2 Bottom right y coordinate.
28480 * @param int $y2 A color identifier created with {@link
28481 *   imagecolorallocate}.
28482 * @param int $color
28483 * @return bool
28484 * @since PHP 4, PHP 5
28485 **/
28486function imagerectangle($image, $x1, $y1, $x2, $y2, $color){}
28487
28488/**
28489 * Rotates the {@link image} image using the given {@link angle} in
28490 * degrees.
28491 *
28492 * The center of rotation is the center of the image, and the rotated
28493 * image may have different dimensions than the original image.
28494 *
28495 * @param resource $image Rotation angle, in degrees.
28496 * @param float $angle Specifies the color of the uncovered zone after
28497 *   the rotation
28498 * @param int $bgd_color If set and non-zero, transparent colors are
28499 *   ignored (otherwise kept).
28500 * @param int $ignore_transparent
28501 * @return resource
28502 * @since PHP 4 >= 4.3.0, PHP 5
28503 **/
28504function imagerotate($image, $angle, $bgd_color, $ignore_transparent){}
28505
28506/**
28507 * {@link imagesavealpha} sets the flag to attempt to save full alpha
28508 * channel information (as opposed to single-color transparency) when
28509 * saving PNG images.
28510 *
28511 * You have to unset alphablending (imagealphablending($im, false)), to
28512 * use it.
28513 *
28514 * Alpha channel is not supported by all browsers, if you have problem
28515 * with your browser, try to load your script with an alpha channel
28516 * compliant browser, e.g. latest Mozilla.
28517 *
28518 * @param resource $image Whether to save the alpha channel or not.
28519 *   Default to .
28520 * @param bool $saveflag
28521 * @return bool
28522 * @since PHP 4 >= 4.3.2, PHP 5
28523 **/
28524function imagesavealpha($image, $saveflag){}
28525
28526/**
28527 * {@link imagesetbrush} sets the brush image to be used by all line
28528 * drawing functions (such as {@link imageline} and {@link imagepolygon})
28529 * when drawing with the special colors IMG_COLOR_BRUSHED or
28530 * IMG_COLOR_STYLEDBRUSHED.
28531 *
28532 * @param resource $image An image resource.
28533 * @param resource $brush
28534 * @return bool
28535 * @since PHP 4 >= 4.0.6, PHP 5
28536 **/
28537function imagesetbrush($image, $brush){}
28538
28539/**
28540 * {@link imagesetpixel} draws a pixel at the specified coordinate.
28541 *
28542 * @param resource $image x-coordinate.
28543 * @param int $x y-coordinate.
28544 * @param int $y A color identifier created with {@link
28545 *   imagecolorallocate}.
28546 * @param int $color
28547 * @return bool
28548 * @since PHP 4, PHP 5
28549 **/
28550function imagesetpixel($image, $x, $y, $color){}
28551
28552/**
28553 * {@link imagesetstyle} sets the style to be used by all line drawing
28554 * functions (such as {@link imageline} and {@link imagepolygon}) when
28555 * drawing with the special color IMG_COLOR_STYLED or lines of images
28556 * with color IMG_COLOR_STYLEDBRUSHED.
28557 *
28558 * @param resource $image An array of pixel colors. You can use the
28559 *   IMG_COLOR_TRANSPARENT constant to add a transparent pixel.
28560 * @param array $style
28561 * @return bool
28562 * @since PHP 4 >= 4.0.6, PHP 5
28563 **/
28564function imagesetstyle($image, $style){}
28565
28566/**
28567 * {@link imagesetthickness} sets the thickness of the lines drawn when
28568 * drawing rectangles, polygons, ellipses etc. etc. to {@link thickness}
28569 * pixels.
28570 *
28571 * @param resource $image Thickness, in pixels.
28572 * @param int $thickness
28573 * @return bool
28574 * @since PHP 4 >= 4.0.6, PHP 5
28575 **/
28576function imagesetthickness($image, $thickness){}
28577
28578/**
28579 * {@link imagesettile} sets the tile image to be used by all region
28580 * filling functions (such as {@link imagefill} and {@link
28581 * imagefilledpolygon}) when filling with the special color
28582 * IMG_COLOR_TILED.
28583 *
28584 * A tile is an image used to fill an area with a repeated pattern. Any
28585 * GD image can be used as a tile, and by setting the transparent color
28586 * index of the tile image with {@link imagecolortransparent}, a tile
28587 * allows certain parts of the underlying area to shine through can be
28588 * created.
28589 *
28590 * @param resource $image The image resource to be used as a tile.
28591 * @param resource $tile
28592 * @return bool
28593 * @since PHP 4 >= 4.0.6, PHP 5
28594 **/
28595function imagesettile($image, $tile){}
28596
28597/**
28598 * Draws a {@link string} at the given coordinates.
28599 *
28600 * @param resource $image x-coordinate of the upper left corner.
28601 * @param int $font y-coordinate of the upper left corner.
28602 * @param int $x The string to be written.
28603 * @param int $y A color identifier created with {@link
28604 *   imagecolorallocate}.
28605 * @param string $string
28606 * @param int $color
28607 * @return bool
28608 * @since PHP 4, PHP 5
28609 **/
28610function imagestring($image, $font, $x, $y, $string, $color){}
28611
28612/**
28613 * Draws a {@link string} vertically at the given coordinates.
28614 *
28615 * @param resource $image x-coordinate of the bottom left corner.
28616 * @param int $font y-coordinate of the bottom left corner.
28617 * @param int $x The string to be written.
28618 * @param int $y A color identifier created with {@link
28619 *   imagecolorallocate}.
28620 * @param string $string
28621 * @param int $color
28622 * @return bool
28623 * @since PHP 4, PHP 5
28624 **/
28625function imagestringup($image, $font, $x, $y, $string, $color){}
28626
28627/**
28628 * Returns the width of the given {@link image} resource.
28629 *
28630 * @param resource $image
28631 * @return int
28632 * @since PHP 4, PHP 5
28633 **/
28634function imagesx($image){}
28635
28636/**
28637 * Returns the height of the given {@link image} resource.
28638 *
28639 * @param resource $image
28640 * @return int
28641 * @since PHP 4, PHP 5
28642 **/
28643function imagesy($image){}
28644
28645/**
28646 * {@link imagetruecolortopalette} converts a truecolor image to a
28647 * palette image. The code for this function was originally drawn from
28648 * the Independent JPEG Group library code, which is excellent. The code
28649 * has been modified to preserve as much alpha channel information as
28650 * possible in the resulting palette, in addition to preserving colors as
28651 * well as possible. This does not work as well as might be hoped. It is
28652 * usually best to simply produce a truecolor output image instead, which
28653 * guarantees the highest output quality.
28654 *
28655 * @param resource $image Indicates if the image should be dithered -
28656 *   if it is then dithering will be used which will result in a more
28657 *   speckled image but with better color approximation.
28658 * @param bool $dither Sets the maximum number of colors that should be
28659 *   retained in the palette.
28660 * @param int $ncolors
28661 * @return bool
28662 * @since PHP 4 >= 4.0.6, PHP 5
28663 **/
28664function imagetruecolortopalette($image, $dither, $ncolors){}
28665
28666/**
28667 * This function calculates and returns the bounding box in pixels for a
28668 * TrueType text.
28669 *
28670 * @param float $size The font size. Depending on your version of GD,
28671 *   this should be specified as the pixel size (GD1) or point size
28672 *   (GD2).
28673 * @param float $angle Angle in degrees in which {@link text} will be
28674 *   measured.
28675 * @param string $fontfile The name of the TrueType font file (can be a
28676 *   URL). Depending on which version of the GD library that PHP is
28677 *   using, it may attempt to search for files that do not begin with a
28678 *   leading '/' by appending '.ttf' to the filename and searching along
28679 *   a library-defined font path.
28680 * @param string $text The string to be measured.
28681 * @return array
28682 * @since PHP 4, PHP 5
28683 **/
28684function imagettfbbox($size, $angle, $fontfile, $text){}
28685
28686/**
28687 * Writes the given {@link text} into the image using TrueType fonts.
28688 *
28689 * @param resource $image The font size. Depending on your version of
28690 *   GD, this should be specified as the pixel size (GD1) or point size
28691 *   (GD2).
28692 * @param float $size The angle in degrees, with 0 degrees being
28693 *   left-to-right reading text. Higher values represent a
28694 *   counter-clockwise rotation. For example, a value of 90 would result
28695 *   in bottom-to-top reading text.
28696 * @param float $angle The coordinates given by {@link x} and {@link y}
28697 *   will define the basepoint of the first character (roughly the
28698 *   lower-left corner of the character). This is different from the
28699 *   {@link imagestring}, where {@link x} and {@link y} define the
28700 *   upper-left corner of the first character. For example, "top left" is
28701 *   0, 0.
28702 * @param int $x The y-ordinate. This sets the position of the fonts
28703 *   baseline, not the very bottom of the character.
28704 * @param int $y The color index. Using the negative of a color index
28705 *   has the effect of turning off antialiasing. See {@link
28706 *   imagecolorallocate}.
28707 * @param int $color The path to the TrueType font you wish to use.
28708 *   Depending on which version of the GD library PHP is using, when
28709 *   {@link fontfile} does not begin with a leading / then .ttf will be
28710 *   appended to the filename and the library will attempt to search for
28711 *   that filename along a library-defined font path. When using versions
28712 *   of the GD library lower than 2.0.18, a space character, rather than
28713 *   a semicolon, was used as the 'path separator' for different font
28714 *   files. Unintentional use of this feature will result in the warning
28715 *   message: Warning: Could not find/open font. For these affected
28716 *   versions, the only solution is moving the font to a path which does
28717 *   not contain spaces. In many cases where a font resides in the same
28718 *   directory as the script using it the following trick will alleviate
28719 *   any include problems.
28720 *
28721 *   <?php // Set the enviroment variable for GD putenv('GDFONTPATH=' .
28722 *   realpath('.'));
28723 *
28724 *   // Name the font to be used (note the lack of the .ttf extension)
28725 *   $font = 'SomeFont'; ?>
28726 * @param string $fontfile The text string in UTF-8 encoding. May
28727 *   include decimal numeric character references (of the form: &#8364;)
28728 *   to access characters in a font beyond position 127. The hexadecimal
28729 *   format (like &#xA9;) is supported. Strings in UTF-8 encoding can be
28730 *   passed directly. Named entities, such as &copy;, are not supported.
28731 *   Consider using {@link html_entity_decode} to decode these named
28732 *   entities into UTF-8 strings (html_entity_decode() supports this as
28733 *   of PHP 5.0.0). If a character is used in the string which is not
28734 *   supported by the font, a hollow rectangle will replace the
28735 *   character.
28736 * @param string $text
28737 * @return array
28738 * @since PHP 4, PHP 5
28739 **/
28740function imagettftext($image, $size, $angle, $x, $y, $color, $fontfile, $text){}
28741
28742/**
28743 * Returns the image types supported by the current PHP installation.
28744 *
28745 * @return int
28746 * @since PHP 4 >= 4.0.2, PHP 5
28747 **/
28748function imagetypes(){}
28749
28750/**
28751 * {@link imagewbmp} outputs or save a WBMP version of the given {@link
28752 * image}.
28753 *
28754 * @param resource $image The path to save the file to. If not set or ,
28755 *   the raw image stream will be outputted directly.
28756 * @param string $filename You can set the foreground color with this
28757 *   parameter by setting an identifier obtained from {@link
28758 *   imagecolorallocate}. The default foreground color is black.
28759 * @param int $foreground
28760 * @return bool
28761 * @since PHP 4 >= 4.0.1, PHP 5
28762 **/
28763function imagewbmp($image, $filename, $foreground){}
28764
28765/**
28766 * Outputs or save an XBM version of the given {@link image}.
28767 *
28768 * @param resource $image The path to save the file to. If not set or ,
28769 *   the raw image stream will be outputted directly.
28770 * @param string $filename You can set the foreground color with this
28771 *   parameter by setting an identifier obtained from {@link
28772 *   imagecolorallocate}. The default foreground color is black.
28773 * @param int $foreground
28774 * @return bool
28775 * @since PHP 5
28776 **/
28777function imagexbm($image, $filename, $foreground){}
28778
28779/**
28780 * Returns the extension for the given IMAGETYPE_XXX constant.
28781 *
28782 * @param int $imagetype One of the IMAGETYPE_XXX constant.
28783 * @param bool $include_dot Whether to prepend a dot to the extension
28784 *   or not. Default to .
28785 * @return string
28786 * @since PHP 5
28787 **/
28788function image_type_to_extension($imagetype, $include_dot){}
28789
28790/**
28791 * The {@link image_type_to_mime_type} function will determine the
28792 * Mime-Type for an IMAGETYPE constant.
28793 *
28794 * @param int $imagetype One of the IMAGETYPE_XXX constants.
28795 * @return string
28796 * @since PHP 4 >= 4.3.0, PHP 5
28797 **/
28798function image_type_to_mime_type($imagetype){}
28799
28800/**
28801 * Convert an 8bit string to a quoted-printable string (according to
28802 * RFC2045, section 6.7).
28803 *
28804 * @param string $string The 8bit string to convert
28805 * @return string
28806 * @since PHP 4, PHP 5
28807 **/
28808function imap_8bit($string){}
28809
28810/**
28811 * Returns all of the IMAP alert messages generated since the last {@link
28812 * imap_alerts} call, or the beginning of the page.
28813 *
28814 * When {@link imap_alerts} is called, the alert stack is subsequently
28815 * cleared. The IMAP specification requires that these messages be passed
28816 * to the user.
28817 *
28818 * @return array
28819 * @since PHP 4, PHP 5
28820 **/
28821function imap_alerts(){}
28822
28823/**
28824 * Appends a string {@link message} to the specified {@link mailbox}.
28825 *
28826 * @param resource $imap_stream The mailbox name, see {@link imap_open}
28827 *   for more information
28828 * @param string $mailbox The message to be append, as a string When
28829 *   talking to the Cyrus IMAP server, you must use "\r\n" as your
28830 *   end-of-line terminator instead of "\n" or the operation will fail
28831 * @param string $message If provided, the {@link options} will also be
28832 *   written to the {@link mailbox}
28833 * @param string $options If this parameter is set, it will set the
28834 *   INTERNALDATE on the appended message. The parameter should be a date
28835 *   string that conforms to the rfc2060 specifications for a date_time
28836 *   value.
28837 * @param string $internal_date
28838 * @return bool
28839 * @since PHP 4, PHP 5
28840 **/
28841function imap_append($imap_stream, $mailbox, $message, $options, $internal_date){}
28842
28843/**
28844 * Decodes the given BASE-64 encoded {@link text}.
28845 *
28846 * @param string $text The encoded text
28847 * @return string
28848 * @since PHP 4, PHP 5
28849 **/
28850function imap_base64($text){}
28851
28852/**
28853 * Convert an 8bit string to a base64 string according to RFC2045,
28854 * Section 6.8.
28855 *
28856 * @param string $string The 8bit string
28857 * @return string
28858 * @since PHP 4, PHP 5
28859 **/
28860function imap_binary($string){}
28861
28862/**
28863 * {@link imap_body} returns the body of the message, numbered {@link
28864 * msg_number} in the current mailbox.
28865 *
28866 * {@link imap_body} will only return a verbatim copy of the message
28867 * body. To extract single parts of a multipart MIME-encoded message you
28868 * have to use {@link imap_fetchstructure} to analyze its structure and
28869 * {@link imap_fetchbody} to extract a copy of a single body component.
28870 *
28871 * @param resource $imap_stream The message number
28872 * @param int $msg_number The optional {@link options} are a bit mask
28873 *   with one or more of the following: FT_UID - The {@link msg_number}
28874 *   is a UID FT_PEEK - Do not set the \Seen flag if not already set
28875 *   FT_INTERNAL - The return string is in internal format, will not
28876 *   canonicalize to CRLF.
28877 * @param int $options
28878 * @return string
28879 * @since PHP 4, PHP 5
28880 **/
28881function imap_body($imap_stream, $msg_number, $options){}
28882
28883/**
28884 * Read the structure of a specified body section of a specific message.
28885 *
28886 * @param resource $imap_stream The message number
28887 * @param int $msg_number The body section to read
28888 * @param string $section
28889 * @return object
28890 * @since PHP 4, PHP 5
28891 **/
28892function imap_bodystruct($imap_stream, $msg_number, $section){}
28893
28894/**
28895 * Checks information about the current mailbox.
28896 *
28897 * @param resource $imap_stream
28898 * @return object
28899 * @since PHP 4, PHP 5
28900 **/
28901function imap_check($imap_stream){}
28902
28903/**
28904 * This function causes a store to delete the specified {@link flag} to
28905 * the flags set for the messages in the specified {@link sequence}.
28906 *
28907 * @param resource $imap_stream A sequence of message numbers. You can
28908 *   enumerate desired messages with the X,Y syntax, or retrieve all
28909 *   messages within an interval with the X:Y syntax
28910 * @param string $sequence The flags which you can unset are "\\Seen",
28911 *   "\\Answered", "\\Flagged", "\\Deleted", and "\\Draft" (as defined by
28912 *   RFC2060)
28913 * @param string $flag {@link options} are a bit mask and may contain
28914 *   the single option: ST_UID - The sequence argument contains UIDs
28915 *   instead of sequence numbers
28916 * @param int $options
28917 * @return bool
28918 * @since PHP 4, PHP 5
28919 **/
28920function imap_clearflag_full($imap_stream, $sequence, $flag, $options){}
28921
28922/**
28923 * Closes the imap stream.
28924 *
28925 * @param resource $imap_stream If set to CL_EXPUNGE, the function will
28926 *   silently expunge the mailbox before closing, removing all messages
28927 *   marked for deletion. You can achieve the same thing by using {@link
28928 *   imap_expunge}
28929 * @param int $flag
28930 * @return bool
28931 * @since PHP 4, PHP 5
28932 **/
28933function imap_close($imap_stream, $flag){}
28934
28935/**
28936 * Creates a new mailbox specified by {@link mailbox}.
28937 *
28938 * @param resource $imap_stream The mailbox name, see {@link imap_open}
28939 *   for more information. Names containing international characters
28940 *   should be encoded by {@link imap_utf7_encode}
28941 * @param string $mailbox
28942 * @return bool
28943 * @since PHP 4, PHP 5
28944 **/
28945function imap_createmailbox($imap_stream, $mailbox){}
28946
28947/**
28948 * Marks messages listed in {@link msg_number} for deletion. Messages
28949 * marked for deletion will stay in the mailbox until either {@link
28950 * imap_expunge} is called or {@link imap_close} is called with the
28951 * optional parameter CL_EXPUNGE.
28952 *
28953 * @param resource $imap_stream The message number
28954 * @param int $msg_number You can set the FT_UID which tells the
28955 *   function to treat the {@link msg_number} argument as an UID.
28956 * @param int $options
28957 * @return bool
28958 * @since PHP 4, PHP 5
28959 **/
28960function imap_delete($imap_stream, $msg_number, $options){}
28961
28962/**
28963 * Deletes the specified {@link mailbox}.
28964 *
28965 * @param resource $imap_stream The mailbox name, see {@link imap_open}
28966 *   for more information
28967 * @param string $mailbox
28968 * @return bool
28969 * @since PHP 4, PHP 5
28970 **/
28971function imap_deletemailbox($imap_stream, $mailbox){}
28972
28973/**
28974 * Gets all of the IMAP errors (if any) that have occurred during this
28975 * page request or since the error stack was reset.
28976 *
28977 * When {@link imap_errors} is called, the error stack is subsequently
28978 * cleared.
28979 *
28980 * @return array
28981 * @since PHP 4, PHP 5
28982 **/
28983function imap_errors(){}
28984
28985/**
28986 * Deletes all the messages marked for deletion by {@link imap_delete},
28987 * {@link imap_mail_move}, or {@link imap_setflag_full}.
28988 *
28989 * @param resource $imap_stream
28990 * @return bool
28991 * @since PHP 4, PHP 5
28992 **/
28993function imap_expunge($imap_stream){}
28994
28995/**
28996 * Fetch of a particular section of the body of the specified messages.
28997 * Body parts are not decoded by this function.
28998 *
28999 * @param resource $imap_stream The message number
29000 * @param int $msg_number The part number. It is a string of integers
29001 *   delimited by period which index into a body part list as per the
29002 *   IMAP4 specification
29003 * @param string $section A bitmask with one or more of the following:
29004 *   FT_UID - The {@link msg_number} is a UID FT_PEEK - Do not set the
29005 *   \Seen flag if not already set FT_INTERNAL - The return string is in
29006 *   internal format, will not canonicalize to CRLF.
29007 * @param int $options
29008 * @return string
29009 * @since PHP 4, PHP 5
29010 **/
29011function imap_fetchbody($imap_stream, $msg_number, $section, $options){}
29012
29013/**
29014 * This function causes a fetch of the complete, unfiltered RFC2822
29015 * format header of the specified message.
29016 *
29017 * @param resource $imap_stream The message number
29018 * @param int $msg_number The possible {@link options} are: FT_UID -
29019 *   The {@link msgno} argument is a UID FT_INTERNAL - The return string
29020 *   is in "internal" format, without any attempt to canonicalize to CRLF
29021 *   newlines FT_PREFETCHTEXT - The RFC822.TEXT should be pre-fetched at
29022 *   the same time. This avoids an extra RTT on an IMAP connection if a
29023 *   full message text is desired (e.g. in a "save to local file"
29024 *   operation)
29025 * @param int $options
29026 * @return string
29027 * @since PHP 4, PHP 5
29028 **/
29029function imap_fetchheader($imap_stream, $msg_number, $options){}
29030
29031/**
29032 * Fetches all the structured information for a given message.
29033 *
29034 * @param resource $imap_stream The message number
29035 * @param int $msg_number This optional parameter only has a single
29036 *   option, FT_UID, which tells the function to treat the {@link
29037 *   msg_number} argument as a UID.
29038 * @param int $options
29039 * @return object
29040 * @since PHP 4, PHP 5
29041 **/
29042function imap_fetchstructure($imap_stream, $msg_number, $options){}
29043
29044/**
29045 * This function fetches mail headers for the given {@link sequence} and
29046 * returns an overview of their contents.
29047 *
29048 * @param resource $imap_stream A message sequence description. You can
29049 *   enumerate desired messages with the X,Y syntax, or retrieve all
29050 *   messages within an interval with the X:Y syntax
29051 * @param string $sequence {@link sequence} will contain a sequence of
29052 *   message indices or UIDs, if this parameter is set to FT_UID.
29053 * @param int $options
29054 * @return array
29055 * @since PHP 4, PHP 5
29056 **/
29057function imap_fetch_overview($imap_stream, $sequence, $options){}
29058
29059/**
29060 * Purges the cache of entries of a specific type.
29061 *
29062 * @param resource $imap_stream Specifies the cache to purge. It may
29063 *   one or a combination of the following constants: IMAP_GC_ELT
29064 *   (message cache elements), IMAP_GC_ENV (enveloppe and bodies),
29065 *   IMAP_GC_TEXTS (texts).
29066 * @param int $caches
29067 * @return string
29068 * @since PHP 5 >= 5.3.0
29069 **/
29070function imap_gc($imap_stream, $caches){}
29071
29072/**
29073 * Gets the ACL for a given mailbox.
29074 *
29075 * @param resource $imap_stream The mailbox name, see {@link imap_open}
29076 *   for more information
29077 * @param string $mailbox
29078 * @return array
29079 * @since PHP 5
29080 **/
29081function imap_getacl($imap_stream, $mailbox){}
29082
29083/**
29084 * Gets information on the mailboxes.
29085 *
29086 * @param resource $imap_stream {@link ref} should normally be just the
29087 *   server specification as described in {@link imap_open}
29088 * @param string $ref
29089 * @param string $pattern
29090 * @return array
29091 * @since PHP 4, PHP 5
29092 **/
29093function imap_getmailboxes($imap_stream, $ref, $pattern){}
29094
29095/**
29096 * Gets information about the subscribed mailboxes.
29097 *
29098 * Identical to {@link imap_getmailboxes}, except that it only returns
29099 * mailboxes that the user is subscribed to.
29100 *
29101 * @param resource $imap_stream {@link ref} should normally be just the
29102 *   server specification as described in {@link imap_open}
29103 * @param string $ref
29104 * @param string $pattern
29105 * @return array
29106 * @since PHP 4, PHP 5
29107 **/
29108function imap_getsubscribed($imap_stream, $ref, $pattern){}
29109
29110/**
29111 * Retrieve the quota level settings, and usage statics per mailbox.
29112 *
29113 * For a non-admin user version of this function, please see the {@link
29114 * imap_get_quotaroot} function of PHP.
29115 *
29116 * @param resource $imap_stream {@link quota_root} should normally be
29117 *   in the form of user.name where name is the mailbox you wish to
29118 *   retrieve information about.
29119 * @param string $quota_root
29120 * @return array
29121 * @since PHP 4 >= 4.0.5, PHP 5
29122 **/
29123function imap_get_quota($imap_stream, $quota_root){}
29124
29125/**
29126 * Retrieve the quota settings per user. The limit value represents the
29127 * total amount of space allowed for this user's total mailbox usage. The
29128 * usage value represents the user's current total mailbox capacity.
29129 *
29130 * @param resource $imap_stream {@link quota_root} should normally be
29131 *   in the form of which mailbox (i.e. INBOX).
29132 * @param string $quota_root
29133 * @return array
29134 * @since PHP 4 >= 4.3.0, PHP 5
29135 **/
29136function imap_get_quotaroot($imap_stream, $quota_root){}
29137
29138/**
29139 * Gets information about the given message number by reading its
29140 * headers.
29141 *
29142 * @param resource $imap_stream The message number
29143 * @param int $msg_number Number of characters for the fetchfrom
29144 *   property. Must be greater than or equal to zero.
29145 * @param int $fromlength Number of characters for the fetchsubject
29146 *   property Must be greater than or equal to zero.
29147 * @param int $subjectlength
29148 * @param string $defaulthost
29149 * @return object
29150 * @since PHP 4, PHP 5
29151 **/
29152function imap_header($imap_stream, $msg_number, $fromlength, $subjectlength, $defaulthost){}
29153
29154/**
29155 * Gets information about the given message number by reading its
29156 * headers.
29157 *
29158 * @param resource $imap_stream The message number
29159 * @param int $msg_number Number of characters for the fetchfrom
29160 *   property. Must be greater than or equal to zero.
29161 * @param int $fromlength Number of characters for the fetchsubject
29162 *   property Must be greater than or equal to zero.
29163 * @param int $subjectlength
29164 * @param string $defaulthost
29165 * @return object
29166 * @since PHP 4, PHP 5
29167 **/
29168function imap_headerinfo($imap_stream, $msg_number, $fromlength, $subjectlength, $defaulthost){}
29169
29170/**
29171 * Returns headers for all messages in a mailbox.
29172 *
29173 * @param resource $imap_stream
29174 * @return array
29175 * @since PHP 4, PHP 5
29176 **/
29177function imap_headers($imap_stream){}
29178
29179/**
29180 * Gets the full text of the last IMAP error message that occurred on the
29181 * current page. The error stack is untouched; calling {@link
29182 * imap_last_error} subsequently, with no intervening errors, will return
29183 * the same error.
29184 *
29185 * @return string
29186 * @since PHP 4, PHP 5
29187 **/
29188function imap_last_error(){}
29189
29190/**
29191 * Read the list of mailboxes.
29192 *
29193 * @param resource $imap_stream {@link ref} should normally be just the
29194 *   server specification as described in {@link imap_open}.
29195 * @param string $ref
29196 * @param string $pattern
29197 * @return array
29198 * @since PHP 4, PHP 5
29199 **/
29200function imap_list($imap_stream, $ref, $pattern){}
29201
29202/**
29203 * Read the list of mailboxes.
29204 *
29205 * @param resource $imap_stream {@link ref} should normally be just the
29206 *   server specification as described in {@link imap_open}.
29207 * @param string $ref
29208 * @param string $pattern
29209 * @return array
29210 * @since PHP 4, PHP 5
29211 **/
29212function imap_listmailbox($imap_stream, $ref, $pattern){}
29213
29214/**
29215 * Returns an array containing the names of the mailboxes that have
29216 * {@link content} in the text of the mailbox.
29217 *
29218 * This function is similar to {@link imap_listmailbox}, but it will
29219 * additionally check for the presence of the string {@link content}
29220 * inside the mailbox data.
29221 *
29222 * @param resource $imap_stream {@link ref} should normally be just the
29223 *   server specification as described in {@link imap_open}
29224 * @param string $ref
29225 * @param string $pattern The searched string
29226 * @param string $content
29227 * @return array
29228 * @since PHP 4, PHP 5
29229 **/
29230function imap_listscan($imap_stream, $ref, $pattern, $content){}
29231
29232/**
29233 * Gets an array of all the mailboxes that you have subscribed.
29234 *
29235 * @param resource $imap_stream {@link ref} should normally be just the
29236 *   server specification as described in {@link imap_open}
29237 * @param string $ref
29238 * @param string $pattern
29239 * @return array
29240 * @since PHP 4, PHP 5
29241 **/
29242function imap_listsubscribed($imap_stream, $ref, $pattern){}
29243
29244/**
29245 * Gets an array of all the mailboxes that you have subscribed.
29246 *
29247 * @param resource $imap_stream {@link ref} should normally be just the
29248 *   server specification as described in {@link imap_open}
29249 * @param string $ref
29250 * @param string $pattern
29251 * @return array
29252 * @since PHP 4, PHP 5
29253 **/
29254function imap_lsub($imap_stream, $ref, $pattern){}
29255
29256/**
29257 * This function allows sending of emails with correct handling of Cc and
29258 * Bcc receivers.
29259 *
29260 * The parameters {@link to}, {@link cc} and {@link bcc} are all strings
29261 * and are all parsed as RFC822 address lists.
29262 *
29263 * @param string $to The receiver
29264 * @param string $subject The mail subject
29265 * @param string $message The mail body
29266 * @param string $additional_headers As string with additional headers
29267 *   to be set on the mail
29268 * @param string $cc
29269 * @param string $bcc The receivers specified in {@link bcc} will get
29270 *   the mail, but are excluded from the headers.
29271 * @param string $rpath Use this parameter to specify return path upon
29272 *   mail delivery failure. This is useful when using PHP as a mail
29273 *   client for multiple users.
29274 * @return bool
29275 * @since PHP 4, PHP 5
29276 **/
29277function imap_mail($to, $subject, $message, $additional_headers, $cc, $bcc, $rpath){}
29278
29279/**
29280 * Checks the current mailbox status on the server. It is similar to
29281 * {@link imap_status}, but will additionally sum up the size of all
29282 * messages in the mailbox, which will take some additional time to
29283 * execute.
29284 *
29285 * @param resource $imap_stream
29286 * @return object
29287 * @since PHP 4, PHP 5
29288 **/
29289function imap_mailboxmsginfo($imap_stream){}
29290
29291/**
29292 * Create a MIME message based on the given {@link envelope} and {@link
29293 * body} sections.
29294 *
29295 * @param array $envelope An associative array of headers fields. Valid
29296 *   keys are: "remail", "return_path", "date", "from", "reply_to",
29297 *   "in_reply_to", "subject", "to", "cc", "bcc", "message_id" and
29298 *   "custom_headers" (which contains associative array of other
29299 *   headers).
29300 * @param array $body An indexed array of bodies A body is an
29301 *   associative array which can consist of the following keys: "type",
29302 *   "encoding", "charset", "type.parameters", "subtype", "id",
29303 *   "description", "disposition.type", "disposition", "contents.data",
29304 *   "lines", "bytes" and "md5".
29305 * @return string
29306 * @since PHP 4, PHP 5
29307 **/
29308function imap_mail_compose($envelope, $body){}
29309
29310/**
29311 * Copies mail messages specified by {@link msglist} to specified
29312 * mailbox.
29313 *
29314 * @param resource $imap_stream {@link msglist} is a range not just
29315 *   message numbers (as described in RFC2060).
29316 * @param string $msglist The mailbox name, see {@link imap_open} for
29317 *   more information
29318 * @param string $mailbox {@link options} is a bitmask of one or more
29319 *   of CP_UID - the sequence numbers contain UIDS CP_MOVE - Delete the
29320 *   messages from the current mailbox after copying
29321 * @param int $options
29322 * @return bool
29323 * @since PHP 4, PHP 5
29324 **/
29325function imap_mail_copy($imap_stream, $msglist, $mailbox, $options){}
29326
29327/**
29328 * Moves mail messages specified by {@link msglist} to the specified
29329 * {@link mailbox}.
29330 *
29331 * @param resource $imap_stream {@link msglist} is a range not just
29332 *   message numbers (as described in RFC2060).
29333 * @param string $msglist The mailbox name, see {@link imap_open} for
29334 *   more information
29335 * @param string $mailbox {@link options} is a bitmask and may contain
29336 *   the single option: CP_UID - the sequence numbers contain UIDS
29337 * @param int $options
29338 * @return bool
29339 * @since PHP 4, PHP 5
29340 **/
29341function imap_mail_move($imap_stream, $msglist, $mailbox, $options){}
29342
29343/**
29344 * Decodes MIME message header extensions that are non ASCII text (see
29345 * RFC2047).
29346 *
29347 * @param string $text The MIME text
29348 * @return array
29349 * @since PHP 4, PHP 5
29350 **/
29351function imap_mime_header_decode($text){}
29352
29353/**
29354 * Returns the message sequence number for the given {@link uid}.
29355 *
29356 * This function is the inverse of {@link imap_uid}.
29357 *
29358 * @param resource $imap_stream The message UID
29359 * @param int $uid
29360 * @return int
29361 * @since PHP 4, PHP 5
29362 **/
29363function imap_msgno($imap_stream, $uid){}
29364
29365/**
29366 * Gets the number of messages in the current mailbox.
29367 *
29368 * @param resource $imap_stream
29369 * @return int
29370 * @since PHP 4, PHP 5
29371 **/
29372function imap_num_msg($imap_stream){}
29373
29374/**
29375 * Gets the number of recent messages in the current mailbox.
29376 *
29377 * @param resource $imap_stream
29378 * @return int
29379 * @since PHP 4, PHP 5
29380 **/
29381function imap_num_recent($imap_stream){}
29382
29383/**
29384 * Opens an IMAP stream to a {@link mailbox}.
29385 *
29386 * This function can also be used to open streams to POP3 and NNTP
29387 * servers, but some functions and features are only available on IMAP
29388 * servers.
29389 *
29390 * @param string $mailbox A mailbox name consists of a server and a
29391 *   mailbox path on this server. The special name INBOX stands for the
29392 *   current users personal mailbox. Mailbox names that contain
29393 *   international characters besides those in the printable ASCII space
29394 *   have to be encoded width {@link imap_utf7_encode}. The server part,
29395 *   which is enclosed in '{' and '}', consists of the servers name or ip
29396 *   address, an optional port (prefixed by ':'), and an optional
29397 *   protocol specification (prefixed by '/'). The server part is
29398 *   mandatory in all mailbox parameters. All names which start with {
29399 *   are remote names, and are in the form "{" remote_system_name [":"
29400 *   port] [flags] "}" [mailbox_name] where: remote_system_name -
29401 *   Internet domain name or bracketed IP address of server. port -
29402 *   optional TCP port number, default is the default port for that
29403 *   service flags - optional flags, see following table. mailbox_name -
29404 *   remote mailbox name, default is INBOX
29405 *
29406 *   Optional flags for names Flag Description /service=service mailbox
29407 *   access service, default is "imap" /user=user remote user name for
29408 *   login on the server /authuser=user remote authentication user; if
29409 *   specified this is the user name whose password is used (e.g.
29410 *   administrator) /anonymous remote access as anonymous user /debug
29411 *   record protocol telemetry in application's debug log /secure do not
29412 *   transmit a plaintext password over the network /imap, /imap2,
29413 *   /imap2bis, /imap4, /imap4rev1 equivalent to /service=imap /pop3
29414 *   equivalent to /service=pop3 /nntp equivalent to /service=nntp /norsh
29415 *   do not use rsh or ssh to establish a preauthenticated IMAP session
29416 *   /ssl use the Secure Socket Layer to encrypt the session
29417 *   /validate-cert validate certificates from TLS/SSL server (this is
29418 *   the default behavior) /novalidate-cert do not validate certificates
29419 *   from TLS/SSL server, needed if server uses self-signed certificates
29420 *   /tls force use of start-TLS to encrypt the session, and reject
29421 *   connection to servers that do not support it /notls do not do
29422 *   start-TLS to encrypt the session, even with servers that support it
29423 *   /readonly request read-only mailbox open (IMAP only; ignored on
29424 *   NNTP, and an error with SMTP and POP3)
29425 * @param string $username The user name
29426 * @param string $password The password associated with the {@link
29427 *   username}
29428 * @param int $options The {@link options} are a bit mask with one or
29429 *   more of the following: OP_READONLY - Open mailbox read-only
29430 *   OP_ANONYMOUS - Don't use or update a .newsrc for news (NNTP only)
29431 *   OP_HALFOPEN - For IMAP and NNTP names, open a connection but don't
29432 *   open a mailbox. CL_EXPUNGE - Expunge mailbox automatically upon
29433 *   mailbox close (see also {@link imap_delete} and {@link
29434 *   imap_expunge}) OP_DEBUG - Debug protocol negotiations OP_SHORTCACHE
29435 *   - Short (elt-only) caching OP_SILENT - Don't pass up events
29436 *   (internal use) OP_PROTOTYPE - Return driver prototype OP_SECURE -
29437 *   Don't do non-secure authentication
29438 * @param int $n_retries Number of maximum connect attempts
29439 * @param array $params Connection parameters, the following (string)
29440 *   keys maybe used to set one or more connection parameters:
29441 *   DISABLE_AUTHENTICATOR - Disable authentication properties
29442 * @return resource
29443 * @since PHP 4, PHP 5
29444 **/
29445function imap_open($mailbox, $username, $password, $options, $n_retries, $params){}
29446
29447/**
29448 * {@link imap_ping} pings the stream to see if it's still active. It may
29449 * discover new mail; this is the preferred method for a periodic "new
29450 * mail check" as well as a "keep alive" for servers which have
29451 * inactivity timeout.
29452 *
29453 * @param resource $imap_stream
29454 * @return bool
29455 * @since PHP 4, PHP 5
29456 **/
29457function imap_ping($imap_stream){}
29458
29459/**
29460 * Convert a quoted-printable string to an 8 bit string according to
29461 * RFC2045, section 6.7.
29462 *
29463 * @param string $string A quoted-printable string
29464 * @return string
29465 * @since PHP 4, PHP 5
29466 **/
29467function imap_qprint($string){}
29468
29469/**
29470 * This function renames on old mailbox to new mailbox (see {@link
29471 * imap_open} for the format of {@link mbox} names).
29472 *
29473 * @param resource $imap_stream The old mailbox name, see {@link
29474 *   imap_open} for more information
29475 * @param string $old_mbox The new mailbox name, see {@link imap_open}
29476 *   for more information
29477 * @param string $new_mbox
29478 * @return bool
29479 * @since PHP 4, PHP 5
29480 **/
29481function imap_renamemailbox($imap_stream, $old_mbox, $new_mbox){}
29482
29483/**
29484 * Reopens the specified stream to a new {@link mailbox} on an IMAP or
29485 * NNTP server.
29486 *
29487 * @param resource $imap_stream The mailbox name, see {@link imap_open}
29488 *   for more information
29489 * @param string $mailbox The {@link options} are a bit mask with one
29490 *   or more of the following: OP_READONLY - Open mailbox read-only
29491 *   OP_ANONYMOUS - Don't use or update a .newsrc for news (NNTP only)
29492 *   OP_HALFOPEN - For IMAP and NNTP names, open a connection but don't
29493 *   open a mailbox. OP_EXPUNGE - Silently expunge recycle stream
29494 *   CL_EXPUNGE - Expunge mailbox automatically upon mailbox close (see
29495 *   also {@link imap_delete} and {@link imap_expunge})
29496 * @param int $options Number of maximum connect attempts
29497 * @param int $n_retries
29498 * @return bool
29499 * @since PHP 4, PHP 5
29500 **/
29501function imap_reopen($imap_stream, $mailbox, $options, $n_retries){}
29502
29503/**
29504 * Parses the address string as defined in RFC2822 and for each address.
29505 *
29506 * @param string $address A string containing addresses
29507 * @param string $default_host The default host name
29508 * @return array
29509 * @since PHP 4, PHP 5
29510 **/
29511function imap_rfc822_parse_adrlist($address, $default_host){}
29512
29513/**
29514 * Gets an object of various header elements, similar to {@link
29515 * imap_header}.
29516 *
29517 * @param string $headers The parsed headers data
29518 * @param string $defaulthost The default host name
29519 * @return object
29520 * @since PHP 4, PHP 5
29521 **/
29522function imap_rfc822_parse_headers($headers, $defaulthost){}
29523
29524/**
29525 * Returns a properly formatted email address as defined in RFC2822 given
29526 * the needed information.
29527 *
29528 * @param string $mailbox The mailbox name, see {@link imap_open} for
29529 *   more information
29530 * @param string $host The email host part
29531 * @param string $personal The name of the account owner
29532 * @return string
29533 * @since PHP 4, PHP 5
29534 **/
29535function imap_rfc822_write_address($mailbox, $host, $personal){}
29536
29537/**
29538 * Saves a part or the whole body of the specified message.
29539 *
29540 * @param resource $imap_stream The path to the saved file as a string,
29541 *   or a valid file descriptor returned by {@link fopen}.
29542 * @param mixed $file The message number
29543 * @param int $msg_number The part number. It is a string of integers
29544 *   delimited by period which index into a body part list as per the
29545 *   IMAP4 specification
29546 * @param string $part_number A bitmask with one or more of the
29547 *   following: FT_UID - The {@link msg_number} is a UID FT_PEEK - Do not
29548 *   set the \Seen flag if not already set FT_INTERNAL - The return
29549 *   string is in internal format, will not canonicalize to CRLF.
29550 * @param int $options
29551 * @return bool
29552 * @since PHP 5 >= 5.1.3
29553 **/
29554function imap_savebody($imap_stream, $file, $msg_number, $part_number, $options){}
29555
29556/**
29557 * Returns an array containing the names of the mailboxes that have
29558 * {@link content} in the text of the mailbox.
29559 *
29560 * This function is similar to {@link imap_listmailbox}, but it will
29561 * additionally check for the presence of the string {@link content}
29562 * inside the mailbox data.
29563 *
29564 * @param resource $imap_stream {@link ref} should normally be just the
29565 *   server specification as described in {@link imap_open}
29566 * @param string $ref
29567 * @param string $pattern The searched string
29568 * @param string $content
29569 * @return array
29570 * @since PHP 4, PHP 5
29571 **/
29572function imap_scanmailbox($imap_stream, $ref, $pattern, $content){}
29573
29574/**
29575 * This function performs a search on the mailbox currently opened in the
29576 * given IMAP stream.
29577 *
29578 * For example, to match all unanswered messages sent by Mom, you'd use:
29579 * "UNANSWERED FROM mom". Searches appear to be case insensitive. This
29580 * list of criteria is from a reading of the UW c-client source code and
29581 * may be incomplete or inaccurate (see also RFC2060, section 6.4.4).
29582 *
29583 * @param resource $imap_stream A string, delimited by spaces, in which
29584 *   the following keywords are allowed. Any multi-word arguments (e.g.
29585 *   FROM "joey smith") must be quoted. ALL - return all messages
29586 *   matching the rest of the criteria ANSWERED - match messages with the
29587 *   \\ANSWERED flag set BCC "string" - match messages with "string" in
29588 *   the Bcc: field BEFORE "date" - match messages with Date: before
29589 *   "date" BODY "string" - match messages with "string" in the body of
29590 *   the message CC "string" - match messages with "string" in the Cc:
29591 *   field DELETED - match deleted messages FLAGGED - match messages with
29592 *   the \\FLAGGED (sometimes referred to as Important or Urgent) flag
29593 *   set FROM "string" - match messages with "string" in the From: field
29594 *   KEYWORD "string" - match messages with "string" as a keyword NEW -
29595 *   match new messages OLD - match old messages ON "date" - match
29596 *   messages with Date: matching "date" RECENT - match messages with the
29597 *   \\RECENT flag set SEEN - match messages that have been read (the
29598 *   \\SEEN flag is set) SINCE "date" - match messages with Date: after
29599 *   "date" SUBJECT "string" - match messages with "string" in the
29600 *   Subject: TEXT "string" - match messages with text "string" TO
29601 *   "string" - match messages with "string" in the To: UNANSWERED -
29602 *   match messages that have not been answered UNDELETED - match
29603 *   messages that are not deleted UNFLAGGED - match messages that are
29604 *   not flagged UNKEYWORD "string" - match messages that do not have the
29605 *   keyword "string" UNSEEN - match messages which have not been read
29606 *   yet
29607 * @param string $criteria Valid values for {@link options} are SE_UID,
29608 *   which causes the returned array to contain UIDs instead of messages
29609 *   sequence numbers.
29610 * @param int $options
29611 * @param string $charset
29612 * @return array
29613 * @since PHP 4, PHP 5
29614 **/
29615function imap_search($imap_stream, $criteria, $options, $charset){}
29616
29617/**
29618 * Sets the ACL for a giving mailbox.
29619 *
29620 * @param resource $imap_stream The mailbox name, see {@link imap_open}
29621 *   for more information
29622 * @param string $mailbox The user to give the rights to.
29623 * @param string $id The rights to give to the user. Passing an empty
29624 *   string will delete acl.
29625 * @param string $rights
29626 * @return bool
29627 * @since PHP 4 >= 4.0.7, PHP 5
29628 **/
29629function imap_setacl($imap_stream, $mailbox, $id, $rights){}
29630
29631/**
29632 * Causes a store to add the specified {@link flag} to the flags set for
29633 * the messages in the specified {@link sequence}.
29634 *
29635 * @param resource $imap_stream A sequence of message numbers. You can
29636 *   enumerate desired messages with the X,Y syntax, or retrieve all
29637 *   messages within an interval with the X:Y syntax
29638 * @param string $sequence The flags which you can set are \Seen,
29639 *   \Answered, \Flagged, \Deleted, and \Draft as defined by RFC2060.
29640 * @param string $flag A bit mask that may contain the single option:
29641 *   ST_UID - The sequence argument contains UIDs instead of sequence
29642 *   numbers
29643 * @param int $options
29644 * @return bool
29645 * @since PHP 4, PHP 5
29646 **/
29647function imap_setflag_full($imap_stream, $sequence, $flag, $options){}
29648
29649/**
29650 * Sets an upper limit quota on a per mailbox basis.
29651 *
29652 * @param resource $imap_stream The mailbox to have a quota set. This
29653 *   should follow the IMAP standard format for a mailbox: user.name.
29654 * @param string $quota_root The maximum size (in KB) for the {@link
29655 *   quota_root}
29656 * @param int $quota_limit
29657 * @return bool
29658 * @since PHP 4 >= 4.0.5, PHP 5
29659 **/
29660function imap_set_quota($imap_stream, $quota_root, $quota_limit){}
29661
29662/**
29663 * Gets and sorts message numbers by the given parameters.
29664 *
29665 * @param resource $imap_stream Criteria can be one (and only one) of
29666 *   the following: SORTDATE - message Date SORTARRIVAL - arrival date
29667 *   SORTFROM - mailbox in first From address SORTSUBJECT - message
29668 *   subject SORTTO - mailbox in first To address SORTCC - mailbox in
29669 *   first cc address SORTSIZE - size of message in octets
29670 * @param int $criteria Set this to 1 for reverse sorting
29671 * @param int $reverse The {@link options} are a bitmask of one or more
29672 *   of the following: SE_UID - Return UIDs instead of sequence numbers
29673 *   SE_NOPREFETCH - Don't prefetch searched messages
29674 * @param int $options
29675 * @param string $search_criteria
29676 * @param string $charset
29677 * @return array
29678 * @since PHP 4, PHP 5
29679 **/
29680function imap_sort($imap_stream, $criteria, $reverse, $options, $search_criteria, $charset){}
29681
29682/**
29683 * Gets status information about the given {@link mailbox}.
29684 *
29685 * @param resource $imap_stream The mailbox name, see {@link imap_open}
29686 *   for more information
29687 * @param string $mailbox Valid flags are: SA_MESSAGES - set
29688 *   $status->messages to the number of messages in the mailbox SA_RECENT
29689 *   - set $status->recent to the number of recent messages in the
29690 *   mailbox SA_UNSEEN - set $status->unseen to the number of unseen
29691 *   (new) messages in the mailbox SA_UIDNEXT - set $status->uidnext to
29692 *   the next uid to be used in the mailbox SA_UIDVALIDITY - set
29693 *   $status->uidvalidity to a constant that changes when uids for the
29694 *   mailbox may no longer be valid SA_ALL - set all of the above
29695 * @param int $options
29696 * @return object
29697 * @since PHP 4, PHP 5
29698 **/
29699function imap_status($imap_stream, $mailbox, $options){}
29700
29701/**
29702 * Subscribe to a new mailbox.
29703 *
29704 * @param resource $imap_stream The mailbox name, see {@link imap_open}
29705 *   for more information
29706 * @param string $mailbox
29707 * @return bool
29708 * @since PHP 4, PHP 5
29709 **/
29710function imap_subscribe($imap_stream, $mailbox){}
29711
29712/**
29713 * Gets a tree of a threaded message.
29714 *
29715 * @param resource $imap_stream
29716 * @param int $options
29717 * @return array
29718 * @since PHP 4 >= 4.0.7, PHP 5
29719 **/
29720function imap_thread($imap_stream, $options){}
29721
29722/**
29723 * Sets or fetches the imap timeout.
29724 *
29725 * @param int $timeout_type One of the following: IMAP_OPENTIMEOUT,
29726 *   IMAP_READTIMEOUT, IMAP_WRITETIMEOUT, or IMAP_CLOSETIMEOUT.
29727 * @param int $timeout The timeout, in seconds.
29728 * @return mixed
29729 * @since PHP 4 >= 4.3.3, PHP 5
29730 **/
29731function imap_timeout($timeout_type, $timeout){}
29732
29733/**
29734 * This function returns the UID for the given message sequence number.
29735 * An UID is a unique identifier that will not change over time while a
29736 * message sequence number may change whenever the content of the mailbox
29737 * changes.
29738 *
29739 * This function is the inverse of {@link imap_msgno}.
29740 *
29741 * @param resource $imap_stream The message number.
29742 * @param int $msg_number
29743 * @return int
29744 * @since PHP 4, PHP 5
29745 **/
29746function imap_uid($imap_stream, $msg_number){}
29747
29748/**
29749 * Removes the deletion flag for a specified message, which is set by
29750 * {@link imap_delete} or {@link imap_mail_move}.
29751 *
29752 * @param resource $imap_stream The message number
29753 * @param int $msg_number
29754 * @param int $flags
29755 * @return bool
29756 * @since PHP 4, PHP 5
29757 **/
29758function imap_undelete($imap_stream, $msg_number, $flags){}
29759
29760/**
29761 * Unsubscribe from the specified {@link mailbox}.
29762 *
29763 * @param resource $imap_stream The mailbox name, see {@link imap_open}
29764 *   for more information
29765 * @param string $mailbox
29766 * @return bool
29767 * @since PHP 4, PHP 5
29768 **/
29769function imap_unsubscribe($imap_stream, $mailbox){}
29770
29771/**
29772 * Decodes modified UTF-7 {@link text} into ISO-8859-1 string.
29773 *
29774 * This function is needed to decode mailbox names that contain certain
29775 * characters which are not in range of printable ASCII characters.
29776 *
29777 * @param string $text A modified UTF-7 encoding string, as defined in
29778 *   RFC 2060, section 5.1.3 (original UTF-7 was defined in RFC1642).
29779 * @return string
29780 * @since PHP 4, PHP 5
29781 **/
29782function imap_utf7_decode($text){}
29783
29784/**
29785 * Converts {@link data} to modified UTF-7 text.
29786 *
29787 * This is needed to encode mailbox names that contain certain characters
29788 * which are not in range of printable ASCII characters.
29789 *
29790 * @param string $data An ISO-8859-1 string.
29791 * @return string
29792 * @since PHP 4, PHP 5
29793 **/
29794function imap_utf7_encode($data){}
29795
29796/**
29797 * Converts the given {@link mime_encoded_text} to UTF-8.
29798 *
29799 * @param string $mime_encoded_text A MIME encoded string. MIME
29800 *   encoding method and the UTF-8 specification are described in RFC2047
29801 *   and RFC2044 respectively.
29802 * @return string
29803 * @since PHP 4, PHP 5
29804 **/
29805function imap_utf8($mime_encoded_text){}
29806
29807/**
29808 * Join array elements with a {@link glue} string.
29809 *
29810 * @param string $glue Defaults to an empty string. This is not the
29811 *   preferred usage of {@link implode} as {@link glue} would be the
29812 *   second parameter and thus, the bad prototype would be used.
29813 * @param array $pieces The array of strings to implode.
29814 * @return string
29815 * @since PHP 4, PHP 5
29816 **/
29817function implode($glue, $pieces){}
29818
29819/**
29820 * Imports GET/POST/Cookie variables into the global scope. It is useful
29821 * if you disabled register_globals, but would like to see some variables
29822 * in the global scope.
29823 *
29824 * If you're interested in importing other variables into the global
29825 * scope, such as $_SERVER, consider using {@link extract}.
29826 *
29827 * @param string $types Using the {@link types} parameter, you can
29828 *   specify which request variables to import. You can use 'G', 'P' and
29829 *   'C' characters respectively for GET, POST and Cookie. These
29830 *   characters are not case sensitive, so you can also use any
29831 *   combination of 'g', 'p' and 'c'. POST includes the POST uploaded
29832 *   file information.
29833 * @param string $prefix Variable name prefix, prepended before all
29834 *   variable's name imported into the global scope. So if you have a GET
29835 *   value named "userid", and provide a prefix "pref_", then you'll get
29836 *   a global variable named $pref_userid.
29837 * @return bool
29838 * @since PHP 4 >= 4.1.0, PHP 5
29839 **/
29840function import_request_variables($types, $prefix){}
29841
29842/**
29843 * Get the inclued data.
29844 *
29845 * @return array
29846 **/
29847function inclued_get_data(){}
29848
29849/**
29850 * @param string $in_addr A 32bit IPv4, or 128bit IPv6 address.
29851 * @return string
29852 * @since PHP 5 >= 5.1.0
29853 **/
29854function inet_ntop($in_addr){}
29855
29856/**
29857 * This function converts a human readable IPv4 or IPv6 address (if PHP
29858 * was built with IPv6 support enabled) into an address family
29859 * appropriate 32bit or 128bit binary structure.
29860 *
29861 * @param string $address A human readable IPv4 or IPv6 address.
29862 * @return string
29863 * @since PHP 5 >= 5.1.0
29864 **/
29865function inet_pton($address){}
29866
29867/**
29868 * {@link ingres_autocommit} is called before opening a transaction
29869 * (before the first call to {@link ingres_query} or just after a call to
29870 * {@link ingres_rollback} or {@link ingres_commit}) to switch the
29871 * autocommit mode of the server on or off (when the script begins the
29872 * autocommit mode is off).
29873 *
29874 * When autocommit mode is on, every query is automatically committed by
29875 * the server, as if {@link ingres_commit} was called after every call to
29876 * {@link ingres_query}. To see if autocommit is enabled use, {@link
29877 * ingres_autocommit_state}.
29878 *
29879 * By default Ingres will rollback any uncommitted transactions at the
29880 * end of a request. Use this function or {@link ingres_commit} to ensure
29881 * your data is committed to the database.
29882 *
29883 * @param resource $link The connection link identifier
29884 * @return bool
29885 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
29886 **/
29887function ingres_autocommit($link){}
29888
29889/**
29890 * {@link ingres_autocommit_state} is called to determine whether the
29891 * current link has autocommit enabled or not.
29892 *
29893 * @param resource $link The connection link identifier
29894 * @return bool
29895 * @since PECL ingres >= 2.0.0
29896 **/
29897function ingres_autocommit_state($link){}
29898
29899/**
29900 * {@link ingres_charset} is called to determine the character set being
29901 * used by the Ingres client, from II_CHARSETxx (where xx is the
29902 * installation code).
29903 *
29904 * @param resource $link The connection link identifier
29905 * @return string
29906 * @since PECL ingres >= 2.1.0
29907 **/
29908function ingres_charset($link){}
29909
29910/**
29911 * {@link ingres_close} closes the connection to the Ingres server that
29912 * is associated with the specified link.
29913 *
29914 * {@link ingres_close} is usually unnecessary, as it will not close
29915 * persistent connections and all non-persistent connections are
29916 * automatically closed at the end of the script.
29917 *
29918 * @param resource $link The connection link identifier
29919 * @return bool
29920 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
29921 **/
29922function ingres_close($link){}
29923
29924/**
29925 * {@link ingres_commit} commits the currently open transaction, making
29926 * all changes made to the database permanent.
29927 *
29928 * This closes the transaction. A new transaction can be opened by
29929 * sending a query with {@link ingres_query}.
29930 *
29931 * You can also have the server commit automatically after every query by
29932 * calling {@link ingres_autocommit} before opening the transaction.
29933 *
29934 * By default Ingres will roll back any uncommitted transactions at the
29935 * end of a request. Use this function or {@link ingres_autocommit} to
29936 * ensure your that data is committed to the database.
29937 *
29938 * @param resource $link The connection link identifier
29939 * @return bool
29940 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
29941 **/
29942function ingres_commit($link){}
29943
29944/**
29945 * {@link ingres_connect} opens a connection with the given Ingres {@link
29946 * database}.
29947 *
29948 * The connection is closed when the script ends or when {@link
29949 * ingres_close} is called on this link.
29950 *
29951 * @param string $database The database name. Must follow the syntax:
29952 *   [vnode::]dbname[/svr_class]
29953 * @param string $username The Ingres user name
29954 * @param string $password The password associated with {@link
29955 *   username}
29956 * @param array $options {@link ingres_connect} options Option name
29957 *   Option type Description Example date_century_boundary integer The
29958 *   threshold by which a 2-digit year is determined to be in the current
29959 *   century or in the next century. Equivalent to
29960 *   II_DATE_CENTURY_BOUNDARY. 50 group string Specifies the group ID of
29961 *   the user, equivalent to the "-G" flag payroll role string The role
29962 *   ID of the application. If a role password is required, the parameter
29963 *   value should be specified as "role/password" effective_user string
29964 *   The ingres user account being impersonated, equivalent to the "-u"
29965 *   flag another_user dbms_password string The internal database
29966 *   password for the user connecting to Ingres s3cr3t table_structure
29967 *   string The default structure for new tables. Valid values for
29968 *   table_structure are: INGRES_STRUCTURE_BTREE INGRES_STRUCTURE_HASH
29969 *   INGRES_STRUCTURE_HEAP INGRES_STRUCTURE_ISAM INGRES_STRUCTURE_CBTREE
29970 *   INGRES_STRUCTURE_CISAM INGRES_STRUCTURE_CHASH INGRES_STRUCTURE_CHEAP
29971 *   INGRES_STRUCTURE_BTREE index_structure string The default structure
29972 *   for new secondary indexes. Valid values for index_structure are:
29973 *   INGRES_STRUCTURE_CBTREE INGRES_STRUCTURE_CISAM
29974 *   INGRES_STRUCTURE_CHASH INGRES_STRUCTURE_BTREE INGRES_STRUCTURE_HASH
29975 *   INGRES_STRUCTURE_ISAM INGRES_STRUCTURE_HASH login_local boolean
29976 *   Determines how the connection user ID and password are used when a
29977 *   VNODE is included in the target database string. If set to TRUE, the
29978 *   user ID and password are used to locally access the VNODE, and the
29979 *   VNODE login information is used to establish the DBMS connection. If
29980 *   set to FALSE, the process user ID is used to access the VNODE, and
29981 *   the connection user ID and password are used in place of the VNODE
29982 *   login information to establish the DBMS connection. This parameter
29983 *   is ignored if no VNODE is included in the target database string.
29984 *   The default is FALSE. TRUE timezone string Controls the timezone of
29985 *   the session. If not set it will default to the value defined by
29986 *   II_TIMEZONE_NAME. If II_TIMEZONE_NAME is not defined, NA-PACIFIC
29987 *   (GMT-8 with Daylight Savings) is used. date_format integer Sets the
29988 *   allowable input and output format for Ingres dates. Defaults to the
29989 *   value defined by II_DATE_FORMAT. If II_DATE_FORMAT is not set the
29990 *   default date format is US, e.g. mm/dd/yy. Valid values for
29991 *   date_format are: INGRES_DATE_DMY INGRES_DATE_FINISH
29992 *   INGRES_DATE_GERMAN INGRES_DATE_ISO INGRES_DATE_ISO4 INGRES_DATE_MDY
29993 *   INGRES_DATE_MULTINATIONAL INGRES_DATE_MULTINATIONAL4 INGRES_DATE_YMD
29994 *   INGRES_DATE_US INGRES_DATE_MULTINATIONAL4 decimal_separator string
29995 *   The character identifier for decimal data "," money_lort integer
29996 *   Leading or trailing currency sign. Valid values for money_lort are:
29997 *   INGRES_MONEY_LEADING INGRES_MONEY_TRAILING INGRES_MONEY_TRAILING
29998 *   money_sign string The currency symbol to be used with the MONEY
29999 *   datatype money_precision integer The precision of the MONEY datatype
30000 *   3 float4_precision integer Precision of the FLOAT4 datatype 10
30001 *   float8_precision integer Precision of the FLOAT8 data 10
30002 *   blob_segment_length integer The amount of data in bytes to fetch at
30003 *   a time when retrieving BLOB or CLOB data, defaults to 4096 bytes
30004 *   when not explicitly set 8192
30005 * @return resource
30006 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
30007 **/
30008function ingres_connect($database, $username, $password, $options){}
30009
30010/**
30011 * Returns a string with the active cursor name. If no cursor is active
30012 * then NULL is returned.
30013 *
30014 * @param resource $result The query result identifier
30015 * @return string
30016 * @since PECL ingres >= 1.1.0
30017 **/
30018function ingres_cursor($result){}
30019
30020/**
30021 * Returns an integer containing the last error number. If no error was
30022 * reported 0 is returned.
30023 *
30024 * If a {@link link} resource is passed to {@link ingres_errno} it
30025 * returns the last error recorded for the link. If no link is passed,
30026 * then {@link ingres_errno} returns the last error reported using the
30027 * default link.
30028 *
30029 * The function, {@link ingres_errno}, should always be called after
30030 * executing a database query. Calling another function before {@link
30031 * ingres_errno} is called will reset or change any error code from the
30032 * last Ingres function call.
30033 *
30034 * @param resource $link The connection link identifier
30035 * @return int
30036 * @since PECL ingres >= 1.1.0
30037 **/
30038function ingres_errno($link){}
30039
30040/**
30041 * Returns a string containing the last error, or NULL if no error has
30042 * occurred.
30043 *
30044 * If a {@link link} resource is passed to {@link ingres_error}, it
30045 * returns the last error recorded for the link. If no link is passed
30046 * then {@link ingres_error} returns the last error reported using the
30047 * default link.
30048 *
30049 * The function, {@link ingres_error}, should always be called after
30050 * executing any database query. Calling another function before {@link
30051 * ingres_error} is called will reset or change any error message from
30052 * the last Ingres function call.
30053 *
30054 * @param resource $link The connection link identifier
30055 * @return string
30056 * @since PECL ingres >= 1.1.0
30057 **/
30058function ingres_error($link){}
30059
30060/**
30061 * Returns a string containing the last SQLSTATE, or NULL if no error has
30062 * occurred.
30063 *
30064 * If a {@link link} resource is passed to {@link ingres_errsqlstate}, it
30065 * returns the last error recorded for the link. If no link is passed,
30066 * then {@link ingres_errsqlstate} returns the last error reported using
30067 * the default link.
30068 *
30069 * The function, {@link ingres_errsqlstate}, should always be called
30070 * after executing any database query. Calling another function before
30071 * {@link ingres_errsqlstate} is called will reset or change any error
30072 * message from the last Ingres function call.
30073 *
30074 * @param resource $link The connection link identifier
30075 * @return string
30076 * @since PECL ingres >= 1.1.0
30077 **/
30078function ingres_errsqlstate($link){}
30079
30080/**
30081 * {@link ingres_escape_string} is used to escape certain characters
30082 * within a string before it is sent to the database server.
30083 *
30084 * @param resource $link The connection link identifier
30085 * @param string $source_string The source string to be parsed
30086 * @return string
30087 * @since PECL ingres >= 2.1.0
30088 **/
30089function ingres_escape_string($link, $source_string){}
30090
30091/**
30092 * Execute a query prepared using {@link ingres_prepare}.
30093 *
30094 * @param resource $result The result query identifier
30095 * @param array $params An array of parameter values to be used with
30096 *   the query
30097 * @param string $types A string containing a sequence of types for the
30098 *   parameter values passed. See the types parameter in {@link
30099 *   ingres_query} for the list of type codes.
30100 * @return boolean
30101 * @since PECL ingres >= 1.1.0
30102 **/
30103function ingres_execute($result, $params, $types){}
30104
30105/**
30106 * This function is an extended version of {@link ingres_fetch_row}. In
30107 * addition to storing the data in the numeric indices of the result
30108 * array, it also stores the data in associative indices, using the field
30109 * names as keys.
30110 *
30111 * If two or more columns of the result have the same field names, the
30112 * last column will take precedence. To access the another column or
30113 * columns of the same name, you must use the numeric index of the column
30114 * or make an alias for the column. For example:
30115 *
30116 * <?php
30117 *
30118 * $result = ingres_query($link, "select ap_place as city, ap_ccode as
30119 * country from airport where ap_iatacode = 'VLL'"); $result =
30120 * ingres_fetch_array($result); $foo = $result["city"]; $bar =
30121 * $result["country"];
30122 *
30123 * ?>
30124 *
30125 * With regard to speed, the function is identical to {@link
30126 * ingres_fetch_object}, and almost as quick as {@link ingres_fetch_row}
30127 * (the difference is insignificant).
30128 *
30129 * By default, arrays created by {@link ingres_fetch_array} start from
30130 * position 1 and not 0 as with other DBMS extensions. The starting
30131 * position can be adjusted to 0 using the configuration parameter
30132 * ingres.array_index_start.
30133 *
30134 * @param resource $result The query result identifier
30135 * @param int $result_type The result type. This {@link result_type}
30136 *   can be INGRES_NUM for enumerated array, INGRES_ASSOC for associative
30137 *   array, or INGRES_BOTH (default).
30138 * @return array
30139 * @since PHP 5 = 1.0.0
30140 **/
30141function ingres_fetch_array($result, $result_type){}
30142
30143/**
30144 * This function is stores the data fetched from a query executed using
30145 * {@link ingres_query} in an associative array, using the field names as
30146 * keys.
30147 *
30148 * With regard to speed, the function is identical to {@link
30149 * ingres_fetch_object}, and almost as quick as {@link ingres_fetch_row}
30150 * (the difference is insignificant).
30151 *
30152 * By default, arrays created by {@link ingres_fetch_assoc} start from
30153 * position 1 and not 0 as with other DBMS extensions. The starting
30154 * position can be adjusted to 0 using the configuration parameter
30155 * ingres.array_index_start.
30156 *
30157 * @param resource $result The query result identifier
30158 * @return array
30159 * @since PECL ingres >= 2.2.2
30160 **/
30161function ingres_fetch_assoc($result){}
30162
30163/**
30164 * This function is similar to {@link ingres_fetch_array}, with one
30165 * difference - an object is returned instead of an array. Indirectly,
30166 * this means that you can access the data only by the field names and
30167 * not by their offsets (numbers are illegal property names).
30168 *
30169 * With regard to speed, the function is identical to {@link
30170 * ingres_fetch_array}, and almost as quick as {@link ingres_fetch_row}
30171 * (the difference is insignificant).
30172 *
30173 * @param resource $result The query result identifier
30174 * @param int $result_type (Optional argument.) {@link result_type} is
30175 *   a constant and can take the following values: INGRES_ASSOC,
30176 *   INGRES_NUM, and INGRES_BOTH.
30177 * @return object
30178 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
30179 **/
30180function ingres_fetch_object($result, $result_type){}
30181
30182/**
30183 * This function is used to retrieve the return value following the
30184 * execution of an Ingres database procedure (stored procedure).
30185 *
30186 * @param resource $result The result identifier for a query
30187 * @return int
30188 * @since PECL ingres >= 1.4.0
30189 **/
30190function ingres_fetch_proc_return($result){}
30191
30192/**
30193 * {@link ingres_fetch_row} returns an array that corresponds to the
30194 * fetched row, or if there are no more rows. Each result column is
30195 * stored in an array offset, starting at offset 1.
30196 *
30197 * Subsequent calls to {@link ingres_fetch_row} return the next row in
30198 * the result set, or if there are no more rows.
30199 *
30200 * By default, arrays created by {@link ingres_fetch_row} start from
30201 * position 1 and not 0 as with other DBMS extensions. The starting
30202 * position can be adjusted to 0 using the configuration parameter
30203 * ingres.array_index_start.
30204 *
30205 * @param resource $result The query result identifier
30206 * @return array
30207 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
30208 **/
30209function ingres_fetch_row($result){}
30210
30211/**
30212 * {@link ingres_field_length} returns the length of a field. This is the
30213 * number of bytes the server uses to store the field. For detailed
30214 * information, see the Ingres OpenAPI User Guide, Appendix "Data Types"
30215 * in the Ingres documentation.
30216 *
30217 * @param resource $result The query result identifier
30218 * @param int $index {@link index} is the column number whose length
30219 *   will be retrieved. The possible values of {@link index} depend upon
30220 *   the value of ingres.array_index_start. If ingres.array_index_start
30221 *   is 1 (the default) then {@link index} must be between 1 and the
30222 *   value returned by {@link ingres_num_fields}. If
30223 *   ingres.array_index_start is 0 then {@link index} must be between 0
30224 *   and {@link ingres_num_fields} - 1.
30225 * @return int
30226 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
30227 **/
30228function ingres_field_length($result, $index){}
30229
30230/**
30231 * {@link ingres_field_name} returns the name of a field in a query
30232 * result.
30233 *
30234 * @param resource $result The query result identifier
30235 * @param int $index {@link index} is the field whose name will be
30236 *   retrieved. The possible values of {@link index} depend upon the
30237 *   value of ingres.array_index_start. If ingres.array_index_start is 1
30238 *   (the default) then {@link index} must be between 1 and the value
30239 *   returned by {@link ingres_num_fields}. If ingres.array_index_start
30240 *   is 0 then {@link index} must be between 0 and {@link
30241 *   ingres_num_fields} - 1.
30242 * @return string
30243 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
30244 **/
30245function ingres_field_name($result, $index){}
30246
30247/**
30248 * Test if a field is nullable.
30249 *
30250 * @param resource $result The query result identifier
30251 * @param int $index {@link index} is the field whose nullability will
30252 *   be retrieved. The possible values of {@link index} depend upon the
30253 *   value of ingres.array_index_start. If ingres.array_index_start is 1
30254 *   (the default) then {@link index} must be between 1 and the value
30255 *   returned by {@link ingres_num_fields}. If ingres.array_index_start
30256 *   is 0 then {@link index} must be between 0 and {@link
30257 *   ingres_num_fields} - 1.
30258 * @return bool
30259 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
30260 **/
30261function ingres_field_nullable($result, $index){}
30262
30263/**
30264 * {@link ingres_field_precision} returns the precision of a field. This
30265 * value is used only for decimal, float, and money SQL data types. For
30266 * detailed information, see the Ingres OpenAPI User Guide, Appendix
30267 * "Data Types" in the Ingres documentation.
30268 *
30269 * @param resource $result The query result identifier
30270 * @param int $index {@link index} is the field whose precision will be
30271 *   retrieved. The possible values of {@link index} depend upon the
30272 *   value of ingres.array_index_start. If ingres.array_index_start is 1
30273 *   (the default) then {@link index} must be between 1 and the value
30274 *   returned by {@link ingres_num_fields}. If ingres.array_index_start
30275 *   is 0 then {@link index} must be between 0 and {@link
30276 *   ingres_num_fields} - 1.
30277 * @return int
30278 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
30279 **/
30280function ingres_field_precision($result, $index){}
30281
30282/**
30283 * {@link ingres_field_scale} returns the scale of a field. This value is
30284 * used only for the decimal SQL data type. For detailed information, see
30285 * the Ingres OpenAPI User Guide, Appendix "Data Types" in the Ingres
30286 * documentation.
30287 *
30288 * @param resource $result The query result identifier
30289 * @param int $index {@link index} is the field whose scale will be
30290 *   retrieved. The possible values of {@link index} depend upon the
30291 *   value of ingres.array_index_start. If ingres.array_index_start is 1
30292 *   (the default) then {@link index} must be between 1 and the value
30293 *   returned by {@link ingres_num_fields}. If ingres.array_index_start
30294 *   is 0 then {@link index} must be between 0 and {@link
30295 *   ingres_num_fields} - 1.
30296 * @return int
30297 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
30298 **/
30299function ingres_field_scale($result, $index){}
30300
30301/**
30302 * Get the type of a field in a query result.
30303 *
30304 * @param resource $result The query result identifier
30305 * @param int $index {@link index} is the field whose type will be
30306 *   retrieved. The possible values of {@link index} depend upon the
30307 *   value of ingres.array_index_start. If ingres.array_index_start is 1
30308 *   (the default) then {@link index} must be between 1 and the value
30309 *   returned by {@link ingres_num_fields}. If ingres.array_index_start
30310 *   is 0 then {@link index} must be between 0 and {@link
30311 *   ingres_num_fields} - 1.
30312 * @return string
30313 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
30314 **/
30315function ingres_field_type($result, $index){}
30316
30317/**
30318 * @param resource $result The query result identifier
30319 * @return bool
30320 * @since PECL ingres >= 2.0.0
30321 **/
30322function ingres_free_result($result){}
30323
30324/**
30325 * Get the next Ingres error for the last executed query. Each call to
30326 * {@link ingres_next_error} can be followed by a call to {@link
30327 * ingres_errno}, {@link ingres_error} or {@link ingres_errsqlstate} to
30328 * get the respective error number, error text, or SQL STATE. While
30329 * {@link ingres_next_error} returns , there are more errors to fetch.
30330 *
30331 * @param resource $link The connection link identifier
30332 * @return bool
30333 * @since PECL ingres >= 2.0.0
30334 **/
30335function ingres_next_error($link){}
30336
30337/**
30338 * {@link ingres_num_fields} returns the number of fields in the results
30339 * returned by the Ingres server after a call to {@link ingres_query}.
30340 *
30341 * @param resource $result The query result identifier
30342 * @return int
30343 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
30344 **/
30345function ingres_num_fields($result){}
30346
30347/**
30348 * This function primarily is meant to get the number of rows modified in
30349 * the database. However, it can be used to retrieve the number of rows
30350 * to fetch for a SELECT statement.
30351 *
30352 * @param resource $result The result identifier for a query
30353 * @return int
30354 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
30355 **/
30356function ingres_num_rows($result){}
30357
30358/**
30359 * Open a persistent connection to an Ingres database.
30360 *
30361 * There are only two differences between this function and {@link
30362 * ingres_connect}: First, when connecting, the function will initially
30363 * try to find a (persistent) link that is already opened with the same
30364 * parameters. If one is found, an identifier for it will be returned
30365 * instead of opening a new connection. Second, the connection to the
30366 * Ingres server will not be closed when the execution of the script
30367 * ends. Instead, the link will remain open for future use ({@link
30368 * ingres_close} will not close links established by {@link
30369 * ingres_pconnect}). This type of link is therefore called "persistent".
30370 *
30371 * @param string $database The database name. Must follow the syntax:
30372 *   [vnode::]dbname[/svr_class]
30373 * @param string $username The Ingres user name
30374 * @param string $password The password associated with {@link
30375 *   username}
30376 * @param array $options See {@link ingres_connect} for the list of
30377 *   options that can be passed
30378 * @return resource
30379 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
30380 **/
30381function ingres_pconnect($database, $username, $password, $options){}
30382
30383/**
30384 * Prepares a query for execution by {@link ingres_execute}.
30385 *
30386 * The query becomes part of the currently open transaction. If there is
30387 * no open transaction, {@link ingres_query} opens a new transaction. To
30388 * close the transaction, you can call either {@link ingres_commit} to
30389 * commit the changes made to the database or {@link ingres_rollback} to
30390 * cancel these changes. When the script ends, any open transaction is
30391 * rolled back (by calling {@link ingres_rollback}). You can also use
30392 * {@link ingres_autocommit} before opening a new transaction to have
30393 * every SQL query immediately committed.
30394 *
30395 * @param resource $link The connection link identifier
30396 * @param string $query A valid SQL query (see the Ingres SQL reference
30397 *   guide) in the Ingres documentation. See the query parameter in
30398 *   {@link ingres_query} for a list of SQL statements which cannot be
30399 *   executed using {@link ingres_prepare}
30400 * @return mixed
30401 * @since PECL ingres >= 1.1.0
30402 **/
30403function ingres_prepare($link, $query){}
30404
30405/**
30406 * {@link ingres_query} sends the given {@link query} to the Ingres
30407 * server.
30408 *
30409 * The query becomes part of the currently open transaction. If there is
30410 * no open transaction, {@link ingres_query} opens a new transaction. To
30411 * close the transaction, you can call either {@link ingres_commit} to
30412 * commit the changes made to the database or {@link ingres_rollback} to
30413 * cancel these changes. When the script ends, any open transaction is
30414 * rolled back (by calling {@link ingres_rollback}). You can also use
30415 * {@link ingres_autocommit} before opening a new transaction to have
30416 * every SQL query immediately committed.
30417 *
30418 * @param resource $link The connection link identifier.
30419 * @param string $query A valid SQL query (see the Ingres SQL reference
30420 *   guide) in the Ingres documentation. Data inside the query should be
30421 *   properly escaped. The following types of SQL queries cannot be sent
30422 *   with this function: close (see {@link ingres_close}) commit (see
30423 *   {@link ingres_commit}) connect (see {@link ingres_connect})
30424 *   disconnect (see {@link ingres_close}) get dbevent prepare to commit
30425 *   rollback (see {@link ingres_rollback}) savepoint set autocommit (see
30426 *   {@link ingres_autocommit}) all cursor-related queries are
30427 *   unsupported
30428 * @param array $params An array of parameter values to be used with
30429 *   the query
30430 * @param string $types A string containing a sequence of types for the
30431 *   parameter values passed. When ingres.describe is enabled, this
30432 *   parameter can be ignored as the driver automatically fetches the
30433 *   expected parameter types from the server.
30434 * @return mixed
30435 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
30436 **/
30437function ingres_query($link, $query, $params, $types){}
30438
30439/**
30440 * This function is used to position the cursor associated with the
30441 * result resource before issuing a fetch. If ingres.array_index_start is
30442 * set to 0 then the first row is 0 else it is 1. {@link
30443 * ingres_result_seek} can be used only with queries that make use of
30444 * scrollable cursors. It cannot be used with {@link
30445 * ingres_unbuffered_query}.
30446 *
30447 * @param resource $result The result identifier for a query
30448 * @param integer $position The row to position the cursor on. If
30449 *   ingres.array_index_start is set to 0, then the first row is 0, else
30450 *   it is 1
30451 * @return boolean
30452 * @since PECL ingres >= 2.1.0
30453 **/
30454function ingres_result_seek($result, $position){}
30455
30456/**
30457 * {@link ingres_rollback} rolls back the currently open transaction,
30458 * actually cancelling all changes made to the database during the
30459 * transaction.
30460 *
30461 * This closes the transaction. A new transaction can be opened by
30462 * sending a query with {@link ingres_query}.
30463 *
30464 * @param resource $link The connection link identifier
30465 * @return bool
30466 * @since PHP 4 >= 4.0.2, PHP 5 = 1.0.0
30467 **/
30468function ingres_rollback($link){}
30469
30470/**
30471 * {@link ingres_set_environment} is called to set environmental options
30472 * that affect the output of certain values from Ingres, such as the
30473 * timezone, date format, decimal character separator, and float
30474 * precision.
30475 *
30476 * @param resource $link The connection link identifier
30477 * @param array $options An enumerated array of option name/value
30478 *   pairs. The following table lists the option name and the expected
30479 *   type
30480 *
30481 *   Option name Option type Description Example date_century_boundary
30482 *   integer The threshold by which a 2-digit year is determined to be in
30483 *   the current century or in the next century. Equivalent to
30484 *   II_DATE_CENTURY_BOUNDARY 50 timezone string Controls the timezone of
30485 *   the session. If not set, it will default the value defined by
30486 *   II_TIMEZONE_NAME. If II_TIMEZONE_NAME is not defined, NA-PACIFIC
30487 *   (GMT-8 with Daylight Savings) is used. UNITED-KINGDOM date_format
30488 *   integer Sets the allowable input and output format for Ingres dates.
30489 *   Defaults to the value defined by II_DATE_FORMAT. If II_DATE_FORMAT
30490 *   is not set, the default date format is US, for example mm/dd/yy.
30491 *   Valid values for date_format are: INGRES_DATE_DMY INGRES_DATE_FINISH
30492 *   INGRES_DATE_GERMAN INGRES_DATE_ISO INGRES_DATE_ISO4 INGRES_DATE_MDY
30493 *   INGRES_DATE_MULTINATIONAL INGRES_DATE_MULTINATIONAL4 INGRES_DATE_YMD
30494 *   INGRES_DATE_US INGRES_DATE_ISO4 decimal_separator string The
30495 *   character identifier for decimal data "," money_lort integer Leading
30496 *   or trailing currency sign. Valid values for money_lort are:
30497 *   INGRES_MONEY_LEADING INGRES_MONEY_TRAILING INGRES_MONEY_LEADING
30498 *   money_sign string The currency symbol to be used with the MONEY
30499 *   datatype money_precision integer The precision of the MONEY datatype
30500 *   2 float4_precision integer Precision of the FLOAT4 datatype 10
30501 *   float8_precision integer Precision of the FLOAT8 data 10
30502 *   blob_segment_length integer The amount of data in bytes to fetch at
30503 *   a time when retrieving BLOB or CLOB data. Defaults to 4096 bytes
30504 *   when not set explicitly 8192
30505 * @return bool
30506 * @since PECL ingres >= 1.2.0
30507 **/
30508function ingres_set_environment($link, $options){}
30509
30510/**
30511 * {@link ingres_unbuffered_query} sends the given {@link query} to the
30512 * Ingres server.
30513 *
30514 * The query becomes part of the currently open transaction. If there is
30515 * no open transaction, {@link ingres_unbuffered_query} opens a new
30516 * transaction. To close the transaction, you can call either {@link
30517 * ingres_commit} to commit the changes made to the database or {@link
30518 * ingres_rollback} to cancel these changes. When the script ends, any
30519 * open transaction is rolled back (by calling {@link ingres_rollback}).
30520 * You can also use {@link ingres_autocommit} before opening a new
30521 * transaction to have every SQL query immediately committed. Ingres
30522 * allows only a single unbuffered statement to be active at any one
30523 * time. The extension will close any active unbuffered statements before
30524 * executing any SQL. In addition you cannot use {@link
30525 * ingres_result_seek} to position the row before fetching.
30526 *
30527 * @param resource $link The connection link identifier
30528 * @param string $query A valid SQL query (see the Ingres SQL reference
30529 *   guide) in the Ingres documentation. See the query parameter in
30530 *   {@link ingres_query} for a list of SQL statements that cannot be
30531 *   executed via {@link ingres_unbuffered_query}. Data inside the query
30532 *   should be properly escaped.
30533 * @param array $params An array of parameter values to be used with
30534 *   the query
30535 * @param string $types A string containing a sequence of types for the
30536 *   parameter values passed. See the types parameter in {@link
30537 *   ingres_query} for the list of type codes.
30538 * @return mixed
30539 **/
30540function ingres_unbuffered_query($link, $query, $params, $types){}
30541
30542/**
30543 * Sets the value of the given configuration option. The configuration
30544 * option will keep this new value during the script's execution, and
30545 * will be restored at the script's ending.
30546 *
30547 * @param string $varname Not all the available options can be changed
30548 *   using {@link ini_set}. There is a list of all available options in
30549 *   the appendix.
30550 * @param string $newvalue The new value for the option.
30551 * @return string
30552 * @since PHP 4, PHP 5
30553 **/
30554function ini_alter($varname, $newvalue){}
30555
30556/**
30557 * Returns the value of the configuration option on success.
30558 *
30559 * @param string $varname The configuration option name.
30560 * @return string
30561 * @since PHP 4, PHP 5
30562 **/
30563function ini_get($varname){}
30564
30565/**
30566 * Returns all the registered configuration options.
30567 *
30568 * @param string $extension An optional extension name. If set, the
30569 *   function return only options specific for that extension.
30570 * @param bool $details Retrieve details settings or only the current
30571 *   value for each setting. Default is (retrieve details).
30572 * @return array
30573 * @since PHP 4 >= 4.2.0, PHP 5
30574 **/
30575function ini_get_all($extension, $details){}
30576
30577/**
30578 * Restores a given configuration option to its original value.
30579 *
30580 * @param string $varname The configuration option name.
30581 * @return void
30582 * @since PHP 4, PHP 5
30583 **/
30584function ini_restore($varname){}
30585
30586/**
30587 * Sets the value of the given configuration option. The configuration
30588 * option will keep this new value during the script's execution, and
30589 * will be restored at the script's ending.
30590 *
30591 * @param string $varname Not all the available options can be changed
30592 *   using {@link ini_set}. There is a list of all available options in
30593 *   the appendix.
30594 * @param string $newvalue The new value for the option.
30595 * @return string
30596 * @since PHP 4, PHP 5
30597 **/
30598function ini_set($varname, $newvalue){}
30599
30600/**
30601 * {@link inotify_add_watch} adds a new watch or modify an existing watch
30602 * for the file or directory specified in {@link pathname}.
30603 *
30604 * Using {@link inotify_add_watch} on a watched object replaces the
30605 * existing watch. Using the IN_MASK_ADD constant adds (OR) events to the
30606 * existing watch.
30607 *
30608 * @param resource $inotify_instance
30609 * @param string $pathname File or directory to watch
30610 * @param int $mask Events to watch for. See .
30611 * @return int
30612 * @since PECL inotify >= 0.1.2
30613 **/
30614function inotify_add_watch($inotify_instance, $pathname, $mask){}
30615
30616/**
30617 * Initialize an inotify instance for use with {@link inotify_add_watch}
30618 *
30619 * @return resource
30620 * @since PECL inotify >= 0.1.2
30621 **/
30622function inotify_init(){}
30623
30624/**
30625 * This function allows to know if {@link inotify_read} will block or
30626 * not. If a number upper than zero is returned, there are pending events
30627 * and {@link inotify_read} will not block.
30628 *
30629 * @param resource $inotify_instance
30630 * @return int
30631 * @since PECL inotify >= 0.1.2
30632 **/
30633function inotify_queue_len($inotify_instance){}
30634
30635/**
30636 * Read inotify events from an inotify instance.
30637 *
30638 * @param resource $inotify_instance
30639 * @return array
30640 * @since PECL inotify >= 0.1.2
30641 **/
30642function inotify_read($inotify_instance){}
30643
30644/**
30645 * {@link inotify_rm_watch} removes the watch {@link watch_descriptor}
30646 * from the inotify instance {@link inotify_instance}.
30647 *
30648 * @param resource $inotify_instance
30649 * @param int $watch_descriptor Watch to remove from the instance
30650 * @return bool
30651 * @since PECL inotify >= 0.1.2
30652 **/
30653function inotify_rm_watch($inotify_instance, $watch_descriptor){}
30654
30655/**
30656 * Checks if the given interface has been defined.
30657 *
30658 * @param string $interface_name The interface name
30659 * @param bool $autoload Whether to call or not by default.
30660 * @return bool
30661 * @since PHP 5 >= 5.0.2
30662 **/
30663function interface_exists($interface_name, $autoload){}
30664
30665/**
30666 * Return ICU error code name.
30667 *
30668 * @param int $error_code
30669 * @return string
30670 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
30671 **/
30672function intl_error_name($error_code){}
30673
30674/**
30675 * Useful to handle errors occurred in static methods when there's no
30676 * object to get error code from.
30677 *
30678 * @return int
30679 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
30680 **/
30681function intl_get_error_code(){}
30682
30683/**
30684 * Get error message from last internationalization function called.
30685 *
30686 * @return string
30687 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
30688 **/
30689function intl_get_error_message(){}
30690
30691/**
30692 * @param int $error_code
30693 * @return bool
30694 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
30695 **/
30696function intl_is_failure($error_code){}
30697
30698/**
30699 * Returns the integer value of {@link var}, using the specified {@link
30700 * base} for the conversion (the default is base 10). {@link intval}
30701 * should not be used on objects, as doing so will emit an E_NOTICE level
30702 * error and return 1.
30703 *
30704 * @param mixed $var The scalar value being converted to an integer
30705 * @param int $base The base for the conversion
30706 * @return int
30707 * @since PHP 4, PHP 5
30708 **/
30709function intval($var, $base){}
30710
30711/**
30712 * Searches {@link haystack} for {@link needle}.
30713 *
30714 * @param mixed $needle The searched value.
30715 * @param array $haystack The array.
30716 * @param bool $strict If the third parameter {@link strict} is set to
30717 *   then the {@link in_array} function will also check the types of the
30718 *   {@link needle} in the {@link haystack}.
30719 * @return bool
30720 * @since PHP 4, PHP 5
30721 **/
30722function in_array($needle, $haystack, $strict){}
30723
30724/**
30725 * The function {@link ip2long} generates an IPv4 Internet network
30726 * address from its Internet standard format (dotted string)
30727 * representation.
30728 *
30729 * {@link ip2long} will also work with non-complete IP addresses. Read
30730 * for more info.
30731 *
30732 * @param string $ip_address A standard format address.
30733 * @return int
30734 * @since PHP 4, PHP 5
30735 **/
30736function ip2long($ip_address){}
30737
30738/**
30739 * Embeds binary IPTC data into a JPEG image.
30740 *
30741 * @param string $iptcdata The data to be written.
30742 * @param string $jpeg_file_name Path to the JPEG image.
30743 * @param int $spool Spool flag. If the spool flag is over 2 then the
30744 *   JPEG will be returned as a string.
30745 * @return mixed
30746 * @since PHP 4, PHP 5
30747 **/
30748function iptcembed($iptcdata, $jpeg_file_name, $spool){}
30749
30750/**
30751 * Parses an IPTC block into its single tags.
30752 *
30753 * @param string $iptcblock A binary IPTC block.
30754 * @return array
30755 * @since PHP 4, PHP 5
30756 **/
30757function iptcparse($iptcblock){}
30758
30759/**
30760 * Checks if the given {@link object} is of this class or has this class
30761 * as one of its parents.
30762 *
30763 * @param object $object The tested object
30764 * @param string $class_name The class name
30765 * @return bool
30766 * @since PHP 4 >= 4.2.0, PHP 5
30767 **/
30768function is_a($object, $class_name){}
30769
30770/**
30771 * Finds whether the given variable is an array.
30772 *
30773 * @param mixed $var The variable being evaluated.
30774 * @return bool
30775 * @since PHP 4, PHP 5
30776 **/
30777function is_array($var){}
30778
30779/**
30780 * Finds whether the given variable is a boolean.
30781 *
30782 * @param mixed $var The variable being evaluated.
30783 * @return bool
30784 * @since PHP 4, PHP 5
30785 **/
30786function is_bool($var){}
30787
30788/**
30789 * Verify that the contents of a variable can be called as a function.
30790 * This can check that a simple variable contains the name of a valid
30791 * function, or that an array contains a properly encoded object and
30792 * function name.
30793 *
30794 * @param callback $name Can be either the name of a function stored in
30795 *   a string variable, or an object and the name of a method within the
30796 *   object, like this: array($SomeObject, 'MethodName')
30797 * @param bool $syntax_only If set to the function only verifies that
30798 *   {@link name} might be a function or method. It will only reject
30799 *   simple variables that are not strings, or an array that does not
30800 *   have a valid structure to be used as a callback. The valid ones are
30801 *   supposed to have only 2 entries, the first of which is an object or
30802 *   a string, and the second a string.
30803 * @param string $callable_name Receives the "callable name". In the
30804 *   example below it is "someClass::someMethod". Note, however, that
30805 *   despite the implication that someClass::SomeMethod() is a callable
30806 *   static method, this is not the case.
30807 * @return bool
30808 * @since PHP 4 >= 4.0.6, PHP 5
30809 **/
30810function is_callable($name, $syntax_only, &$callable_name){}
30811
30812/**
30813 * Tells whether the given filename is a directory.
30814 *
30815 * @param string $filename Path to the file. If {@link filename} is a
30816 *   relative filename, it will be checked relative to the current
30817 *   working directory. If {@link filename} is a symbolic or hard link
30818 *   then the link will be resolved and checked. If you have enabled , or
30819 *   open_basedir further restrictions may apply.
30820 * @return bool
30821 * @since PHP 4, PHP 5
30822 **/
30823function is_dir($filename){}
30824
30825/**
30826 * Finds whether the type of the given variable is float.
30827 *
30828 * @param mixed $var The variable being evaluated.
30829 * @return bool
30830 * @since PHP 4, PHP 5
30831 **/
30832function is_double($var){}
30833
30834/**
30835 * Tells whether the filename is executable.
30836 *
30837 * @param string $filename Path to the file.
30838 * @return bool
30839 * @since PHP 4, PHP 5
30840 **/
30841function is_executable($filename){}
30842
30843/**
30844 * Tells whether the given file is a regular file.
30845 *
30846 * @param string $filename Path to the file.
30847 * @return bool
30848 * @since PHP 4, PHP 5
30849 **/
30850function is_file($filename){}
30851
30852/**
30853 * Checks whether {@link val} is a legal finite on this platform.
30854 *
30855 * @param float $val The value to check
30856 * @return bool
30857 * @since PHP 4 >= 4.2.0, PHP 5
30858 **/
30859function is_finite($val){}
30860
30861/**
30862 * Finds whether the type of the given variable is float.
30863 *
30864 * @param mixed $var The variable being evaluated.
30865 * @return bool
30866 * @since PHP 4, PHP 5
30867 **/
30868function is_float($var){}
30869
30870/**
30871 * Returns if {@link val} is infinite (positive or negative), like the
30872 * result of log(0) or any value too big to fit into a float on this
30873 * platform.
30874 *
30875 * @param float $val The value to check
30876 * @return bool
30877 * @since PHP 4 >= 4.2.0, PHP 5
30878 **/
30879function is_infinite($val){}
30880
30881/**
30882 * Finds whether the type of the given variable is integer.
30883 *
30884 * @param mixed $var The variable being evaluated.
30885 * @return bool
30886 * @since PHP 4, PHP 5
30887 **/
30888function is_int($var){}
30889
30890/**
30891 * Finds whether the type of the given variable is integer.
30892 *
30893 * @param mixed $var The variable being evaluated.
30894 * @return bool
30895 * @since PHP 4, PHP 5
30896 **/
30897function is_integer($var){}
30898
30899/**
30900 * Tells whether the given file is a symbolic link.
30901 *
30902 * @param string $filename Path to the file.
30903 * @return bool
30904 * @since PHP 4, PHP 5
30905 **/
30906function is_link($filename){}
30907
30908/**
30909 * Finds whether the type of the given variable is integer.
30910 *
30911 * @param mixed $var The variable being evaluated.
30912 * @return bool
30913 * @since PHP 4, PHP 5
30914 **/
30915function is_long($var){}
30916
30917/**
30918 * Checks whether {@link val} is 'not a number', like the result of
30919 * acos(1.01).
30920 *
30921 * @param float $val The value to check
30922 * @return bool
30923 * @since PHP 4 >= 4.2.0, PHP 5
30924 **/
30925function is_nan($val){}
30926
30927/**
30928 * Finds whether the given variable is .
30929 *
30930 * @param mixed $var The variable being evaluated.
30931 * @return bool
30932 * @since PHP 4 >= 4.0.4, PHP 5
30933 **/
30934function is_null($var){}
30935
30936/**
30937 * Finds whether the given variable is numeric. Numeric strings consist
30938 * of optional sign, any number of digits, optional decimal part and
30939 * optional exponential part. Thus +0123.45e6 is a valid numeric value.
30940 * Hexadecimal notation (0xFF) is allowed too but only without sign,
30941 * decimal and exponential part.
30942 *
30943 * @param mixed $var The variable being evaluated.
30944 * @return bool
30945 * @since PHP 4, PHP 5
30946 **/
30947function is_numeric($var){}
30948
30949/**
30950 * Finds whether the given variable is an object.
30951 *
30952 * @param mixed $var The variable being evaluated.
30953 * @return bool
30954 * @since PHP 4, PHP 5
30955 **/
30956function is_object($var){}
30957
30958/**
30959 * Tells whether a file exists and is readable.
30960 *
30961 * @param string $filename Path to the file.
30962 * @return bool
30963 * @since PHP 4, PHP 5
30964 **/
30965function is_readable($filename){}
30966
30967/**
30968 * Finds whether the type of the given variable is float.
30969 *
30970 * @param mixed $var The variable being evaluated.
30971 * @return bool
30972 * @since PHP 4, PHP 5
30973 **/
30974function is_real($var){}
30975
30976/**
30977 * Finds whether the given variable is a resource.
30978 *
30979 * @param mixed $var The variable being evaluated.
30980 * @return bool
30981 * @since PHP 4, PHP 5
30982 **/
30983function is_resource($var){}
30984
30985/**
30986 * Finds whether the given variable is a scalar.
30987 *
30988 * Scalar variables are those containing an integer, float, string or
30989 * boolean. Types array, object and resource are not scalar.
30990 *
30991 * @param mixed $var The variable being evaluated.
30992 * @return bool
30993 * @since PHP 4 >= 4.0.5, PHP 5
30994 **/
30995function is_scalar($var){}
30996
30997/**
30998 * This function is useful to check if the SOAP call failed, but without
30999 * using exceptions. To use it, create a SoapClient object with the
31000 * exceptions option set to zero or . In this case, the SOAP method will
31001 * return a special SoapFault object which encapsulates the fault details
31002 * (faultcode, faultstring, faultactor and faultdetails).
31003 *
31004 * If exceptions is not set then SOAP call will throw an exception on
31005 * error. {@link is_soap_fault} checks if the given parameter is a
31006 * SoapFault object.
31007 *
31008 * @param mixed $object The object to test.
31009 * @return bool
31010 * @since Unknown
31011 **/
31012function is_soap_fault($object){}
31013
31014/**
31015 * Finds whether the type given variable is string.
31016 *
31017 * @param mixed $var The variable being evaluated.
31018 * @return bool
31019 * @since PHP 4, PHP 5
31020 **/
31021function is_string($var){}
31022
31023/**
31024 * Checks if the given {@link object} has the class {@link class_name} as
31025 * one of its parents.
31026 *
31027 * @param mixed $object A class name or an object instance
31028 * @param string $class_name The class name
31029 * @return bool
31030 * @since PHP 4, PHP 5
31031 **/
31032function is_subclass_of($object, $class_name){}
31033
31034/**
31035 * Returns if the file named by {@link filename} was uploaded via HTTP
31036 * POST. This is useful to help ensure that a malicious user hasn't tried
31037 * to trick the script into working on files upon which it should not be
31038 * working--for instance, /etc/passwd.
31039 *
31040 * This sort of check is especially important if there is any chance that
31041 * anything done with uploaded files could reveal their contents to the
31042 * user, or even to other users on the same system.
31043 *
31044 * For proper working, the function {@link is_uploaded_file} needs an
31045 * argument like $_FILES['userfile']['tmp_name'], - the name of the
31046 * uploaded file on the clients machine $_FILES['userfile']['name'] does
31047 * not work.
31048 *
31049 * @param string $filename The filename being checked.
31050 * @return bool
31051 * @since PHP 4 >= 4.0.3, PHP 5
31052 **/
31053function is_uploaded_file($filename){}
31054
31055/**
31056 * Returns if the {@link filename} exists and is writable. The filename
31057 * argument may be a directory name allowing you to check if a directory
31058 * is writable.
31059 *
31060 * Keep in mind that PHP may be accessing the file as the user id that
31061 * the web server runs as (often 'nobody'). Safe mode limitations are not
31062 * taken into account.
31063 *
31064 * @param string $filename The filename being checked.
31065 * @return bool
31066 * @since PHP 4, PHP 5
31067 **/
31068function is_writable($filename){}
31069
31070/**
31071 * Returns if the {@link filename} exists and is writable. The filename
31072 * argument may be a directory name allowing you to check if a directory
31073 * is writable.
31074 *
31075 * Keep in mind that PHP may be accessing the file as the user id that
31076 * the web server runs as (often 'nobody'). Safe mode limitations are not
31077 * taken into account.
31078 *
31079 * @param string $filename The filename being checked.
31080 * @return bool
31081 * @since PHP 4, PHP 5
31082 **/
31083function is_writeable($filename){}
31084
31085/**
31086 * Calls a function for every element in an iterator.
31087 *
31088 * @param Traversable $iterator The class to iterate over.
31089 * @param callback $function The callback function to call on every
31090 *   element. The function must return in order to continue iterating
31091 *   over the {@link iterator}.
31092 * @param array $args Arguments to pass to the callback function.
31093 * @return int
31094 * @since PHP 5 >= 5.1.0
31095 **/
31096function iterator_apply($iterator, $function, $args){}
31097
31098/**
31099 * Count the elements in an iterator.
31100 *
31101 * @param Traversable $iterator The iterator being counted.
31102 * @return int
31103 * @since PHP 5 >= 5.1.0
31104 **/
31105function iterator_count($iterator){}
31106
31107/**
31108 * Copy the elements of an iterator into an array.
31109 *
31110 * @param Traversable $iterator The iterator being copied.
31111 * @param bool $use_keys Whether to use the iterator element keys as
31112 *   index.
31113 * @return array
31114 * @since PHP 5 >= 5.1.0
31115 **/
31116function iterator_to_array($iterator, $use_keys){}
31117
31118/**
31119 * Clears last Java exception.
31120 *
31121 * @return void
31122 * @since PHP 4 >= 4.0.2
31123 **/
31124function java_last_exception_clear(){}
31125
31126/**
31127 * Gets last Java exception.
31128 *
31129 * @return object
31130 * @since PHP 4 >= 4.0.2
31131 **/
31132function java_last_exception_get(){}
31133
31134/**
31135 * Returns the day of the week. Can return a string or an integer
31136 * depending on the mode.
31137 *
31138 * @param int $julianday A julian day number as integer
31139 * @param int $mode
31140 * @return mixed
31141 * @since PHP 4, PHP 5
31142 **/
31143function jddayofweek($julianday, $mode){}
31144
31145/**
31146 * Returns a string containing a month name. {@link mode} tells this
31147 * function which calendar to convert the Julian Day Count to, and what
31148 * type of month names are to be returned. Calendar modes Mode Meaning
31149 * Values 0 Gregorian - abbreviated Jan, Feb, Mar, Apr, May, Jun, Jul,
31150 * Aug, Sep, Oct, Nov, Dec 1 Gregorian January, February, March, April,
31151 * May, June, July, August, September, October, November, December 2
31152 * Julian - abbreviated Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct,
31153 * Nov, Dec 3 Julian January, February, March, April, May, June, July,
31154 * August, September, October, November, December 4 Jewish Tishri,
31155 * Heshvan, Kislev, Tevet, Shevat, AdarI, AdarII, Nisan, Iyyar, Sivan,
31156 * Tammuz, Av, Elul 5 French Republican Vendemiaire, Brumaire, Frimaire,
31157 * Nivose, Pluviose, Ventose, Germinal, Floreal, Prairial, Messidor,
31158 * Thermidor, Fructidor, Extra
31159 *
31160 * @param int $julianday The Julian Day to operate on
31161 * @param int $mode The calendar to take the month name from
31162 * @return string
31163 * @since PHP 4, PHP 5
31164 **/
31165function jdmonthname($julianday, $mode){}
31166
31167/**
31168 * Converts a Julian Day Count to the French Republican Calendar.
31169 *
31170 * @param int $juliandaycount A julian day number as integer
31171 * @return string
31172 * @since PHP 4, PHP 5
31173 **/
31174function jdtofrench($juliandaycount){}
31175
31176/**
31177 * Converts Julian Day Count to a string containing the Gregorian date in
31178 * the format of "month/day/year".
31179 *
31180 * @param int $julianday A julian day number as integer
31181 * @return string
31182 * @since PHP 4, PHP 5
31183 **/
31184function jdtogregorian($julianday){}
31185
31186/**
31187 * Converts a Julian Day Count to the Jewish Calendar.
31188 *
31189 * @param int $juliandaycount A julian day number as integer
31190 * @param bool $hebrew If the {@link hebrew} parameter is set to , the
31191 *   {@link fl} parameter is used for Hebrew, string based, output
31192 *   format.
31193 * @param int $fl The available formats are:
31194 *   CAL_JEWISH_ADD_ALAFIM_GERESH, CAL_JEWISH_ADD_ALAFIM,
31195 *   CAL_JEWISH_ADD_GERESHAYIM.
31196 * @return string
31197 * @since PHP 4, PHP 5
31198 **/
31199function jdtojewish($juliandaycount, $hebrew, $fl){}
31200
31201/**
31202 * Converts Julian Day Count to a string containing the Julian Calendar
31203 * Date in the format of "month/day/year".
31204 *
31205 * @param int $julianday A julian day number as integer
31206 * @return string
31207 * @since PHP 4, PHP 5
31208 **/
31209function jdtojulian($julianday){}
31210
31211/**
31212 * This function will return a Unix timestamp corresponding to the Julian
31213 * Day given in {@link jday} or if {@link jday} is not inside the Unix
31214 * epoch (Gregorian years between 1970 and 2037 or 2440588 <= {@link
31215 * jday} <= 2465342 ). The time returned is localtime (and not GMT).
31216 *
31217 * @param int $jday A julian day number between 2440588 and 2465342.
31218 * @return int
31219 * @since PHP 4, PHP 5
31220 **/
31221function jdtounix($jday){}
31222
31223/**
31224 * Although this function can handle dates all the way back to the year 1
31225 * (3761 B.C.), such use may not be meaningful. The Jewish calendar has
31226 * been in use for several thousand years, but in the early days there
31227 * was no formula to determine the start of a month. A new month was
31228 * started when the new moon was first observed.
31229 *
31230 * @param int $month The month as a number from 1 to 13
31231 * @param int $day The day as a number from 1 to 30
31232 * @param int $year The year as a number between 1 and 9999
31233 * @return int
31234 * @since PHP 4, PHP 5
31235 **/
31236function jewishtojd($month, $day, $year){}
31237
31238/**
31239 * Join array elements with a {@link glue} string.
31240 *
31241 * @param string $glue Defaults to an empty string. This is not the
31242 *   preferred usage of {@link implode} as {@link glue} would be the
31243 *   second parameter and thus, the bad prototype would be used.
31244 * @param array $pieces The array of strings to implode.
31245 * @return string
31246 * @since PHP 4, PHP 5
31247 **/
31248function join($glue, $pieces){}
31249
31250/**
31251 * Converts a JPEG file into a WBMP file.
31252 *
31253 * @param string $jpegname Path to JPEG file.
31254 * @param string $wbmpname Path to destination WBMP file.
31255 * @param int $dest_height Destination image height.
31256 * @param int $dest_width Destination image width.
31257 * @param int $threshold Threshold value, between 0 and 8 (inclusive).
31258 * @return bool
31259 * @since PHP 4 >= 4.0.5, PHP 5
31260 **/
31261function jpeg2wbmp($jpegname, $wbmpname, $dest_height, $dest_width, $threshold){}
31262
31263/**
31264 * Takes a JSON encoded string and converts it into a PHP variable.
31265 *
31266 * @param string $json The {@link json} string being decoded.
31267 * @param bool $assoc When , returned objects will be converted into
31268 *   associative arrays.
31269 * @param int $depth User specified recursion depth.
31270 * @param int $options Bitmask of JSON decode options. Currently only
31271 *   JSON_BIGINT_AS_STRING is supported (default is to cast large
31272 *   integers as floats)
31273 * @return mixed
31274 * @since PHP 5 >= 5.2.0, PECL json >= 1.2.0
31275 **/
31276function json_decode($json, $assoc, $depth, $options){}
31277
31278/**
31279 * Returns a string containing the JSON representation of {@link value}.
31280 *
31281 * @param mixed $value The {@link value} being encoded. Can be any type
31282 *   except a resource. This function only works with UTF-8 encoded data.
31283 * @param int $options Bitmask consisting of JSON_HEX_QUOT,
31284 *   JSON_HEX_TAG, JSON_HEX_AMP, JSON_HEX_APOS, JSON_FORCE_OBJECT.
31285 * @return string
31286 * @since PHP 5 >= 5.2.0, PECL json >= 1.2.0
31287 **/
31288function json_encode($value, $options){}
31289
31290/**
31291 * Returns the last error (if any) occurred by last JSON parsing.
31292 *
31293 * @return int
31294 * @since PHP 5 >= 5.3.0
31295 **/
31296function json_last_error(){}
31297
31298/**
31299 * Valid Range for Julian Calendar 4713 B.C. to 9999 A.D.
31300 *
31301 * Although this function can handle dates all the way back to 4713 B.C.,
31302 * such use may not be meaningful. The calendar was created in 46 B.C.,
31303 * but the details did not stabilize until at least 8 A.D., and perhaps
31304 * as late at the 4th century. Also, the beginning of a year varied from
31305 * one culture to another - not all accepted January as the first month.
31306 *
31307 * @param int $month The month as a number from 1 (for January) to 12
31308 *   (for December)
31309 * @param int $day The day as a number from 1 to 31
31310 * @param int $year The year as a number between -4713 and 9999
31311 * @return int
31312 * @since PHP 4, PHP 5
31313 **/
31314function juliantojd($month, $day, $year){}
31315
31316/**
31317 * {@link kadm5_chpass_principal} sets the new password {@link password}
31318 * for the {@link principal}.
31319 *
31320 * @param resource $handle A KADM5 handle.
31321 * @param string $principal The principal.
31322 * @param string $password The new password.
31323 * @return bool
31324 * @since PECL kadm5 >= 0.2.3
31325 **/
31326function kadm5_chpass_principal($handle, $principal, $password){}
31327
31328/**
31329 * Creates a {@link principal} with the given {@link password}.
31330 *
31331 * @param resource $handle A KADM5 handle.
31332 * @param string $principal The principal.
31333 * @param string $password If {@link password} is omitted or is , a
31334 *   random key will be generated.
31335 * @param array $options It is possible to specify several optional
31336 *   parameters within the array {@link options}. Allowed are the
31337 *   following options: KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION,
31338 *   KADM5_ATTRIBUTES, KADM5_MAX_LIFE, KADM5_KVNO, KADM5_POLICY,
31339 *   KADM5_CLEARPOLICY, KADM5_MAX_RLIFE.
31340 * @return bool
31341 * @since PECL kadm5 >= 0.2.3
31342 **/
31343function kadm5_create_principal($handle, $principal, $password, $options){}
31344
31345/**
31346 * Removes the {@link principal} from the Kerberos database.
31347 *
31348 * @param resource $handle A KADM5 handle.
31349 * @param string $principal The removed principal.
31350 * @return bool
31351 * @since PECL kadm5 >= 0.2.3
31352 **/
31353function kadm5_delete_principal($handle, $principal){}
31354
31355/**
31356 * Closes the connection to the admin server and releases all related
31357 * resources.
31358 *
31359 * @param resource $handle A KADM5 handle.
31360 * @return bool
31361 * @since PECL kadm5 >= 0.2.3
31362 **/
31363function kadm5_destroy($handle){}
31364
31365/**
31366 * Flush all changes to the Kerberos database, leaving the connection to
31367 * the Kerberos admin server open.
31368 *
31369 * @param resource $handle A KADM5 handle.
31370 * @return bool
31371 * @since PECL kadm5 >= 0.2.3
31372 **/
31373function kadm5_flush($handle){}
31374
31375/**
31376 * Gets an array containing the policies's names.
31377 *
31378 * @param resource $handle A KADM5 handle.
31379 * @return array
31380 * @since PECL kadm5 >= 0.2.3
31381 **/
31382function kadm5_get_policies($handle){}
31383
31384/**
31385 * Gets the principal's entries from the Kerberos database.
31386 *
31387 * @param resource $handle A KADM5 handle.
31388 * @param string $principal The principal.
31389 * @return array
31390 * @since PECL kadm5 >= 0.2.3
31391 **/
31392function kadm5_get_principal($handle, $principal){}
31393
31394/**
31395 * {@link kadm5_get_principals} returns an array containing the
31396 * principals's names.
31397 *
31398 * @param resource $handle A KADM5 handle.
31399 * @return array
31400 * @since PECL kadm5 >= 0.2.3
31401 **/
31402function kadm5_get_principals($handle){}
31403
31404/**
31405 * Opens a connection with the KADM5 library using the {@link principal}
31406 * and the given {@link password} to obtain initial credentials from the
31407 * {@link admin_server}.
31408 *
31409 * @param string $admin_server The server.
31410 * @param string $realm Defines the authentication domain for the
31411 *   connection.
31412 * @param string $principal The principal.
31413 * @param string $password If {@link password} is omitted or is , a
31414 *   random key will be generated.
31415 * @return resource
31416 * @since PECL kadm5 >= 0.2.3
31417 **/
31418function kadm5_init_with_password($admin_server, $realm, $principal, $password){}
31419
31420/**
31421 * Modifies a {@link principal} according to the given {@link options}.
31422 *
31423 * @param resource $handle A KADM5 handle.
31424 * @param string $principal The principal.
31425 * @param array $options It is possible to specify several optional
31426 *   parameters within the array {@link options}. Allowed are the
31427 *   following options: KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION,
31428 *   KADM5_ATTRIBUTES, KADM5_MAX_LIFE, KADM5_KVNO, KADM5_POLICY,
31429 *   KADM5_CLEARPOLICY, KADM5_MAX_RLIFE. KADM5_FAIL_AUTH_COUNT.
31430 * @return bool
31431 * @since PECL kadm5 >= 0.2.3
31432 **/
31433function kadm5_modify_principal($handle, $principal, $options){}
31434
31435/**
31436 * {@link key} returns the index element of the current array position.
31437 *
31438 * @param array $array The array.
31439 * @return mixed
31440 * @since PHP 4, PHP 5
31441 **/
31442function key(&$array){}
31443
31444/**
31445 * Sorts an array by key in reverse order, maintaining key to data
31446 * correlations. This is useful mainly for associative arrays.
31447 *
31448 * @param array $array The input array.
31449 * @param int $sort_flags You may modify the behavior of the sort using
31450 *   the optional parameter {@link sort_flags}, for details see {@link
31451 *   sort}.
31452 * @return bool
31453 * @since PHP 4, PHP 5
31454 **/
31455function krsort(&$array, $sort_flags){}
31456
31457/**
31458 * Sorts an array by key, maintaining key to data correlations. This is
31459 * useful mainly for associative arrays.
31460 *
31461 * @param array $array The input array.
31462 * @param int $sort_flags You may modify the behavior of the sort using
31463 *   the optional parameter {@link sort_flags}, for details see {@link
31464 *   sort}.
31465 * @return bool
31466 * @since PHP 4, PHP 5
31467 **/
31468function ksort(&$array, $sort_flags){}
31469
31470/**
31471 * Returns a string with the first character of {@link str} , lowercased
31472 * if that character is alphabetic.
31473 *
31474 * Note that 'alphabetic' is determined by the current locale. For
31475 * instance, in the default "C" locale characters such as umlaut-a ()
31476 * will not be converted.
31477 *
31478 * @param string $str The input string.
31479 * @return string
31480 * @since PHP 5 >= 5.3.0
31481 **/
31482function lcfirst($str){}
31483
31484/**
31485 * {@link lcg_value} returns a pseudo random number in the range of (0,
31486 * 1). The function combines two CGs with periods of 2^31 - 85 and 2^31 -
31487 * 249. The period of this function is equal to the product of both
31488 * primes.
31489 *
31490 * @return float
31491 * @since PHP 4, PHP 5
31492 **/
31493function lcg_value(){}
31494
31495/**
31496 * Attempts to change the group of the symlink {@link filename} to {@link
31497 * group}.
31498 *
31499 * Only the superuser may change the group of a symlink arbitrarily;
31500 * other users may change the group of a symlink to any group of which
31501 * that user is a member.
31502 *
31503 * @param string $filename Path to the symlink.
31504 * @param mixed $group The group specified by name or number.
31505 * @return bool
31506 * @since PHP 5 >= 5.1.2
31507 **/
31508function lchgrp($filename, $group){}
31509
31510/**
31511 * Attempts to change the owner of the symlink {@link filename} to user
31512 * {@link user}.
31513 *
31514 * Only the superuser may change the owner of a symlink.
31515 *
31516 * @param string $filename Path to the file.
31517 * @param mixed $user User name or number.
31518 * @return bool
31519 * @since PHP 5 >= 5.1.2
31520 **/
31521function lchown($filename, $user){}
31522
31523/**
31524 * Translate ISO-8859 characters to t61 characters.
31525 *
31526 * This function is useful if you have to talk to a legacy LDAPv2 server.
31527 *
31528 * @param string $value The text to be translated.
31529 * @return string
31530 * @since PHP 4 >= 4.0.2, PHP 5
31531 **/
31532function ldap_8859_to_t61($value){}
31533
31534/**
31535 * Add entries in the LDAP directory.
31536 *
31537 * @param resource $link_identifier An LDAP link identifier, returned
31538 *   by {@link ldap_connect}.
31539 * @param string $dn The distinguished name of an LDAP entity.
31540 * @param array $entry An array that specifies the information about
31541 *   the entry. The values in the entries are indexed by individual
31542 *   attributes. In case of multiple values for an attribute, they are
31543 *   indexed using integers starting with 0. <?php $entree["attribut1"] =
31544 *   "value"; $entree["attribut2"][0] = "value1"; $entree["attribut2"][1]
31545 *   = "value2"; ?>
31546 * @return bool
31547 * @since PHP 4, PHP 5
31548 **/
31549function ldap_add($link_identifier, $dn, $entry){}
31550
31551/**
31552 * Binds to the LDAP directory with specified RDN and password.
31553 *
31554 * @param resource $link_identifier An LDAP link identifier, returned
31555 *   by {@link ldap_connect}.
31556 * @param string $bind_rdn
31557 * @param string $bind_password
31558 * @return bool
31559 * @since PHP 4, PHP 5
31560 **/
31561function ldap_bind($link_identifier, $bind_rdn, $bind_password){}
31562
31563/**
31564 * Unbinds from the LDAP directory.
31565 *
31566 * @param resource $link_identifier An LDAP link identifier, returned
31567 *   by {@link ldap_connect}.
31568 * @return bool
31569 * @since PHP 4, PHP 5
31570 **/
31571function ldap_close($link_identifier){}
31572
31573/**
31574 * Compare {@link value} of {@link attribute} with value of same
31575 * attribute in an LDAP directory entry.
31576 *
31577 * @param resource $link_identifier An LDAP link identifier, returned
31578 *   by {@link ldap_connect}.
31579 * @param string $dn The distinguished name of an LDAP entity.
31580 * @param string $attribute The attribute name.
31581 * @param string $value The compared value.
31582 * @return mixed
31583 * @since PHP 4 >= 4.0.2, PHP 5
31584 **/
31585function ldap_compare($link_identifier, $dn, $attribute, $value){}
31586
31587/**
31588 * Establishes a connection to a LDAP server on a specified {@link
31589 * hostname} and {@link port}.
31590 *
31591 * @param string $hostname If you are using OpenLDAP 2.x.x you can
31592 *   specify a URL instead of the hostname. To use LDAP with SSL, compile
31593 *   OpenLDAP 2.x.x with SSL support, configure PHP with SSL, and set
31594 *   this parameter as ldaps://hostname/.
31595 * @param int $port The port to connect to. Not used when using URLs.
31596 * @return resource
31597 * @since PHP 4, PHP 5
31598 **/
31599function ldap_connect($hostname, $port){}
31600
31601/**
31602 * Returns the number of entries stored in the result of previous search
31603 * operations.
31604 *
31605 * @param resource $link_identifier An LDAP link identifier, returned
31606 *   by {@link ldap_connect}.
31607 * @param resource $result_identifier The internal LDAP result.
31608 * @return int
31609 * @since PHP 4, PHP 5
31610 **/
31611function ldap_count_entries($link_identifier, $result_identifier){}
31612
31613/**
31614 * Deletes a particular entry in LDAP directory.
31615 *
31616 * @param resource $link_identifier An LDAP link identifier, returned
31617 *   by {@link ldap_connect}.
31618 * @param string $dn The distinguished name of an LDAP entity.
31619 * @return bool
31620 * @since PHP 4, PHP 5
31621 **/
31622function ldap_delete($link_identifier, $dn){}
31623
31624/**
31625 * Turns the specified {@link dn}, into a more user-friendly form,
31626 * stripping off type names.
31627 *
31628 * @param string $dn The distinguished name of an LDAP entity.
31629 * @return string
31630 * @since PHP 4, PHP 5
31631 **/
31632function ldap_dn2ufn($dn){}
31633
31634/**
31635 * Returns the string error message explaining the error number {@link
31636 * errno}. While LDAP errno numbers are standardized, different libraries
31637 * return different or even localized textual error messages. Never check
31638 * for a specific error message text, but always use an error number to
31639 * check.
31640 *
31641 * @param int $errno The error number.
31642 * @return string
31643 * @since PHP 4, PHP 5
31644 **/
31645function ldap_err2str($errno){}
31646
31647/**
31648 * Returns the standardized error number returned by the last LDAP
31649 * command. This number can be converted into a textual error message
31650 * using {@link ldap_err2str}.
31651 *
31652 * @param resource $link_identifier An LDAP link identifier, returned
31653 *   by {@link ldap_connect}.
31654 * @return int
31655 * @since PHP 4, PHP 5
31656 **/
31657function ldap_errno($link_identifier){}
31658
31659/**
31660 * Returns the string error message explaining the error generated by the
31661 * last LDAP command for the given {@link link_identifier}. While LDAP
31662 * errno numbers are standardized, different libraries return different
31663 * or even localized textual error messages. Never check for a specific
31664 * error message text, but always use an error number to check.
31665 *
31666 * Unless you lower your warning level in your sufficiently or prefix
31667 * your LDAP commands with @ (at) characters to suppress warning output,
31668 * the errors generated will also show up in your HTML output.
31669 *
31670 * @param resource $link_identifier An LDAP link identifier, returned
31671 *   by {@link ldap_connect}.
31672 * @return string
31673 * @since PHP 4, PHP 5
31674 **/
31675function ldap_error($link_identifier){}
31676
31677/**
31678 * Splits the DN returned by {@link ldap_get_dn} and breaks it up into
31679 * its component parts. Each part is known as Relative Distinguished
31680 * Name, or RDN.
31681 *
31682 * @param string $dn The distinguished name of an LDAP entity.
31683 * @param int $with_attrib Used to request if the RDNs are returned
31684 *   with only values or their attributes as well. To get RDNs with the
31685 *   attributes (i.e. in attribute=value format) set {@link with_attrib}
31686 *   to 0 and to get only values set it to 1.
31687 * @return array
31688 * @since PHP 4, PHP 5
31689 **/
31690function ldap_explode_dn($dn, $with_attrib){}
31691
31692/**
31693 * Gets the first attribute in the given entry. Remaining attributes are
31694 * retrieved by calling {@link ldap_next_attribute} successively.
31695 *
31696 * Similar to reading entries, attributes are also read one by one from a
31697 * particular entry.
31698 *
31699 * @param resource $link_identifier An LDAP link identifier, returned
31700 *   by {@link ldap_connect}.
31701 * @param resource $result_entry_identifier
31702 * @return string
31703 * @since PHP 4, PHP 5
31704 **/
31705function ldap_first_attribute($link_identifier, $result_entry_identifier){}
31706
31707/**
31708 * Returns the entry identifier for first entry in the result. This entry
31709 * identifier is then supplied to {@link ldap_next_entry} routine to get
31710 * successive entries from the result.
31711 *
31712 * Entries in the LDAP result are read sequentially using the {@link
31713 * ldap_first_entry} and {@link ldap_next_entry} functions.
31714 *
31715 * @param resource $link_identifier An LDAP link identifier, returned
31716 *   by {@link ldap_connect}.
31717 * @param resource $result_identifier
31718 * @return resource
31719 * @since PHP 4, PHP 5
31720 **/
31721function ldap_first_entry($link_identifier, $result_identifier){}
31722
31723/**
31724 * @param resource $link
31725 * @param resource $result
31726 * @return resource
31727 * @since PHP 4 >= 4.0.5, PHP 5
31728 **/
31729function ldap_first_reference($link, $result){}
31730
31731/**
31732 * Frees up the memory allocated internally to store the result. All
31733 * result memory will be automatically freed when the script terminates.
31734 *
31735 * Typically all the memory allocated for the LDAP result gets freed at
31736 * the end of the script. In case the script is making successive
31737 * searches which return large result sets, {@link ldap_free_result}
31738 * could be called to keep the runtime memory usage by the script low.
31739 *
31740 * @param resource $result_identifier
31741 * @return bool
31742 * @since PHP 4, PHP 5
31743 **/
31744function ldap_free_result($result_identifier){}
31745
31746/**
31747 * Reads attributes and values from an entry in the search result.
31748 *
31749 * Having located a specific entry in the directory, you can find out
31750 * what information is held for that entry by using this call. You would
31751 * use this call for an application which "browses" directory entries
31752 * and/or where you do not know the structure of the directory entries.
31753 * In many applications you will be searching for a specific attribute
31754 * such as an email address or a surname, and won't care what other data
31755 * is held.
31756 *
31757 * return_value["count"] = number of attributes in the entry
31758 * return_value[0] = first attribute return_value[n] = nth attribute
31759 *
31760 * return_value["attribute"]["count"] = number of values for attribute
31761 * return_value["attribute"][0] = first value of the attribute
31762 * return_value["attribute"][i] = (i+1)th value of the attribute
31763 *
31764 * @param resource $link_identifier An LDAP link identifier, returned
31765 *   by {@link ldap_connect}.
31766 * @param resource $result_entry_identifier
31767 * @return array
31768 * @since PHP 4, PHP 5
31769 **/
31770function ldap_get_attributes($link_identifier, $result_entry_identifier){}
31771
31772/**
31773 * Finds out the DN of an entry in the result.
31774 *
31775 * @param resource $link_identifier An LDAP link identifier, returned
31776 *   by {@link ldap_connect}.
31777 * @param resource $result_entry_identifier
31778 * @return string
31779 * @since PHP 4, PHP 5
31780 **/
31781function ldap_get_dn($link_identifier, $result_entry_identifier){}
31782
31783/**
31784 * Reads multiple entries from the given result, and then reading the
31785 * attributes and multiple values.
31786 *
31787 * @param resource $link_identifier An LDAP link identifier, returned
31788 *   by {@link ldap_connect}.
31789 * @param resource $result_identifier
31790 * @return array
31791 * @since PHP 4, PHP 5
31792 **/
31793function ldap_get_entries($link_identifier, $result_identifier){}
31794
31795/**
31796 * Sets {@link retval} to the value of the specified option.
31797 *
31798 * @param resource $link_identifier An LDAP link identifier, returned
31799 *   by {@link ldap_connect}.
31800 * @param int $option The parameter {@link option} can be one of:
31801 *   Option Type LDAP_OPT_DEREF integer LDAP_OPT_SIZELIMIT integer
31802 *   LDAP_OPT_TIMELIMIT integer LDAP_OPT_NETWORK_TIMEOUT integer
31803 *   LDAP_OPT_PROTOCOL_VERSION integer LDAP_OPT_ERROR_NUMBER integer
31804 *   LDAP_OPT_REFERRALS bool LDAP_OPT_RESTART bool LDAP_OPT_HOST_NAME
31805 *   string LDAP_OPT_ERROR_STRING string LDAP_OPT_MATCHED_DN string
31806 *   LDAP_OPT_SERVER_CONTROLS array LDAP_OPT_CLIENT_CONTROLS array
31807 * @param mixed $retval This will be set to the option value.
31808 * @return bool
31809 * @since PHP 4 >= 4.0.4, PHP 5
31810 **/
31811function ldap_get_option($link_identifier, $option, &$retval){}
31812
31813/**
31814 * Reads all the values of the attribute in the entry in the result.
31815 *
31816 * This call needs a {@link result_entry_identifier}, so needs to be
31817 * preceded by one of the ldap search calls and one of the calls to get
31818 * an individual entry.
31819 *
31820 * You application will either be hard coded to look for certain
31821 * attributes (such as "surname" or "mail") or you will have to use the
31822 * {@link ldap_get_attributes} call to work out what attributes exist for
31823 * a given entry.
31824 *
31825 * @param resource $link_identifier An LDAP link identifier, returned
31826 *   by {@link ldap_connect}.
31827 * @param resource $result_entry_identifier
31828 * @param string $attribute
31829 * @return array
31830 * @since PHP 4, PHP 5
31831 **/
31832function ldap_get_values($link_identifier, $result_entry_identifier, $attribute){}
31833
31834/**
31835 * Reads all the values of the attribute in the entry in the result.
31836 *
31837 * This function is used exactly like {@link ldap_get_values} except that
31838 * it handles binary data and not string data.
31839 *
31840 * @param resource $link_identifier An LDAP link identifier, returned
31841 *   by {@link ldap_connect}.
31842 * @param resource $result_entry_identifier
31843 * @param string $attribute
31844 * @return array
31845 * @since PHP 4, PHP 5
31846 **/
31847function ldap_get_values_len($link_identifier, $result_entry_identifier, $attribute){}
31848
31849/**
31850 * Performs the search for a specified {@link filter} on the directory
31851 * with the scope LDAP_SCOPE_ONELEVEL.
31852 *
31853 * LDAP_SCOPE_ONELEVEL means that the search should only return
31854 * information that is at the level immediately below the {@link base_dn}
31855 * given in the call. (Equivalent to typing "ls" and getting a list of
31856 * files and folders in the current working directory.)
31857 *
31858 * @param resource $link_identifier An LDAP link identifier, returned
31859 *   by {@link ldap_connect}.
31860 * @param string $base_dn The base DN for the directory.
31861 * @param string $filter
31862 * @param array $attributes An array of the required attributes, e.g.
31863 *   array("mail", "sn", "cn"). Note that the "dn" is always returned
31864 *   irrespective of which attributes types are requested. Using this
31865 *   parameter is much more efficient than the default action (which is
31866 *   to return all attributes and their associated values). The use of
31867 *   this parameter should therefore be considered good practice.
31868 * @param int $attrsonly Should be set to 1 if only attribute types are
31869 *   wanted. If set to 0 both attributes types and attribute values are
31870 *   fetched which is the default behaviour.
31871 * @param int $sizelimit Enables you to limit the count of entries
31872 *   fetched. Setting this to 0 means no limit.
31873 * @param int $timelimit Sets the number of seconds how long is spend
31874 *   on the search. Setting this to 0 means no limit.
31875 * @param int $deref Specifies how aliases should be handled during the
31876 *   search. It can be one of the following: LDAP_DEREF_NEVER - (default)
31877 *   aliases are never dereferenced. LDAP_DEREF_SEARCHING - aliases
31878 *   should be dereferenced during the search but not when locating the
31879 *   base object of the search. LDAP_DEREF_FINDING - aliases should be
31880 *   dereferenced when locating the base object but not during the
31881 *   search. LDAP_DEREF_ALWAYS - aliases should be dereferenced always.
31882 * @return resource
31883 * @since PHP 4, PHP 5
31884 **/
31885function ldap_list($link_identifier, $base_dn, $filter, $attributes, $attrsonly, $sizelimit, $timelimit, $deref){}
31886
31887/**
31888 * Modify the existing entries in the LDAP directory. The structure of
31889 * the entry is same as in {@link ldap_add}.
31890 *
31891 * @param resource $link_identifier An LDAP link identifier, returned
31892 *   by {@link ldap_connect}.
31893 * @param string $dn The distinguished name of an LDAP entity.
31894 * @param array $entry
31895 * @return bool
31896 * @since PHP 4, PHP 5
31897 **/
31898function ldap_modify($link_identifier, $dn, $entry){}
31899
31900/**
31901 * Adds one or more attributes to the specified {@link dn}. It performs
31902 * the modification at the attribute level as opposed to the object
31903 * level. Object-level additions are done by the {@link ldap_add}
31904 * function.
31905 *
31906 * @param resource $link_identifier An LDAP link identifier, returned
31907 *   by {@link ldap_connect}.
31908 * @param string $dn The distinguished name of an LDAP entity.
31909 * @param array $entry
31910 * @return bool
31911 * @since PHP 4, PHP 5
31912 **/
31913function ldap_mod_add($link_identifier, $dn, $entry){}
31914
31915/**
31916 * Removes one or more attributes from the specified {@link dn}. It
31917 * performs the modification at the attribute level as opposed to the
31918 * object level. Object-level deletions are done by the {@link
31919 * ldap_delete} function.
31920 *
31921 * @param resource $link_identifier An LDAP link identifier, returned
31922 *   by {@link ldap_connect}.
31923 * @param string $dn The distinguished name of an LDAP entity.
31924 * @param array $entry
31925 * @return bool
31926 * @since PHP 4, PHP 5
31927 **/
31928function ldap_mod_del($link_identifier, $dn, $entry){}
31929
31930/**
31931 * Replaces one or more attributes from the specified {@link dn}. It
31932 * performs the modification at the attribute level as opposed to the
31933 * object level. Object-level modifications are done by the {@link
31934 * ldap_modify} function.
31935 *
31936 * @param resource $link_identifier An LDAP link identifier, returned
31937 *   by {@link ldap_connect}.
31938 * @param string $dn The distinguished name of an LDAP entity.
31939 * @param array $entry
31940 * @return bool
31941 * @since PHP 4, PHP 5
31942 **/
31943function ldap_mod_replace($link_identifier, $dn, $entry){}
31944
31945/**
31946 * Retrieves the attributes in an entry. The first call to {@link
31947 * ldap_next_attribute} is made with the {@link result_entry_identifier}
31948 * returned from {@link ldap_first_attribute}.
31949 *
31950 * @param resource $link_identifier An LDAP link identifier, returned
31951 *   by {@link ldap_connect}.
31952 * @param resource $result_entry_identifier
31953 * @return string
31954 * @since PHP 4, PHP 5
31955 **/
31956function ldap_next_attribute($link_identifier, $result_entry_identifier){}
31957
31958/**
31959 * Retrieve the entries stored in the result. Successive calls to the
31960 * {@link ldap_next_entry} return entries one by one till there are no
31961 * more entries. The first call to {@link ldap_next_entry} is made after
31962 * the call to {@link ldap_first_entry} with the {@link
31963 * result_entry_identifier} as returned from the {@link
31964 * ldap_first_entry}.
31965 *
31966 * @param resource $link_identifier An LDAP link identifier, returned
31967 *   by {@link ldap_connect}.
31968 * @param resource $result_entry_identifier
31969 * @return resource
31970 * @since PHP 4, PHP 5
31971 **/
31972function ldap_next_entry($link_identifier, $result_entry_identifier){}
31973
31974/**
31975 * @param resource $link
31976 * @param resource $entry
31977 * @return resource
31978 * @since PHP 4 >= 4.0.5, PHP 5
31979 **/
31980function ldap_next_reference($link, $entry){}
31981
31982/**
31983 * @param resource $link
31984 * @param resource $entry
31985 * @param array $referrals
31986 * @return bool
31987 * @since PHP 4 >= 4.0.5, PHP 5
31988 **/
31989function ldap_parse_reference($link, $entry, &$referrals){}
31990
31991/**
31992 * @param resource $link
31993 * @param resource $result
31994 * @param int $errcode
31995 * @param string $matcheddn
31996 * @param string $errmsg
31997 * @param array $referrals
31998 * @return bool
31999 * @since PHP 4 >= 4.0.5, PHP 5
32000 **/
32001function ldap_parse_result($link, $result, &$errcode, &$matcheddn, &$errmsg, &$referrals){}
32002
32003/**
32004 * Performs the search for a specified {@link filter} on the directory
32005 * with the scope LDAP_SCOPE_BASE. So it is equivalent to reading an
32006 * entry from the directory.
32007 *
32008 * @param resource $link_identifier An LDAP link identifier, returned
32009 *   by {@link ldap_connect}.
32010 * @param string $base_dn The base DN for the directory.
32011 * @param string $filter An empty filter is not allowed. If you want to
32012 *   retrieve absolutely all information for this entry, use a filter of
32013 *   objectClass=*. If you know which entry types are used on the
32014 *   directory server, you might use an appropriate filter such as
32015 *   objectClass=inetOrgPerson.
32016 * @param array $attributes An array of the required attributes, e.g.
32017 *   array("mail", "sn", "cn"). Note that the "dn" is always returned
32018 *   irrespective of which attributes types are requested. Using this
32019 *   parameter is much more efficient than the default action (which is
32020 *   to return all attributes and their associated values). The use of
32021 *   this parameter should therefore be considered good practice.
32022 * @param int $attrsonly Should be set to 1 if only attribute types are
32023 *   wanted. If set to 0 both attributes types and attribute values are
32024 *   fetched which is the default behaviour.
32025 * @param int $sizelimit Enables you to limit the count of entries
32026 *   fetched. Setting this to 0 means no limit.
32027 * @param int $timelimit Sets the number of seconds how long is spend
32028 *   on the search. Setting this to 0 means no limit.
32029 * @param int $deref Specifies how aliases should be handled during the
32030 *   search. It can be one of the following: LDAP_DEREF_NEVER - (default)
32031 *   aliases are never dereferenced. LDAP_DEREF_SEARCHING - aliases
32032 *   should be dereferenced during the search but not when locating the
32033 *   base object of the search. LDAP_DEREF_FINDING - aliases should be
32034 *   dereferenced when locating the base object but not during the
32035 *   search. LDAP_DEREF_ALWAYS - aliases should be dereferenced always.
32036 * @return resource
32037 * @since PHP 4, PHP 5
32038 **/
32039function ldap_read($link_identifier, $base_dn, $filter, $attributes, $attrsonly, $sizelimit, $timelimit, $deref){}
32040
32041/**
32042 * The entry specified by {@link dn} is renamed/moved.
32043 *
32044 * @param resource $link_identifier An LDAP link identifier, returned
32045 *   by {@link ldap_connect}.
32046 * @param string $dn The distinguished name of an LDAP entity.
32047 * @param string $newrdn The new RDN.
32048 * @param string $newparent The new parent/superior entry.
32049 * @param bool $deleteoldrdn If the old RDN value(s) is removed, else
32050 *   the old RDN value(s) is retained as non-distinguished values of the
32051 *   entry.
32052 * @return bool
32053 * @since PHP 4 >= 4.0.5, PHP 5
32054 **/
32055function ldap_rename($link_identifier, $dn, $newrdn, $newparent, $deleteoldrdn){}
32056
32057/**
32058 * @param resource $link
32059 * @param string $binddn
32060 * @param string $password
32061 * @param string $sasl_mech
32062 * @param string $sasl_realm
32063 * @param string $sasl_authc_id
32064 * @param string $sasl_authz_id
32065 * @param string $props
32066 * @return bool
32067 * @since PHP 5
32068 **/
32069function ldap_sasl_bind($link, $binddn, $password, $sasl_mech, $sasl_realm, $sasl_authc_id, $sasl_authz_id, $props){}
32070
32071/**
32072 * Performs the search for a specified filter on the directory with the
32073 * scope of LDAP_SCOPE_SUBTREE. This is equivalent to searching the
32074 * entire directory.
32075 *
32076 * From 4.0.5 on it's also possible to do parallel searches. To do this
32077 * you use an array of link identifiers, rather than a single identifier,
32078 * as the first argument. If you don't want the same base DN and the same
32079 * filter for all the searches, you can also use an array of base DNs
32080 * and/or an array of filters. Those arrays must be of the same size as
32081 * the link identifier array since the first entries of the arrays are
32082 * used for one search, the second entries are used for another, and so
32083 * on. When doing parallel searches an array of search result identifiers
32084 * is returned, except in case of error, then the entry corresponding to
32085 * the search will be . This is very much like the value normally
32086 * returned, except that a result identifier is always returned when a
32087 * search was made. There are some rare cases where the normal search
32088 * returns while the parallel search returns an identifier.
32089 *
32090 * @param resource $link_identifier An LDAP link identifier, returned
32091 *   by {@link ldap_connect}.
32092 * @param string $base_dn The base DN for the directory.
32093 * @param string $filter The search filter can be simple or advanced,
32094 *   using boolean operators in the format described in the LDAP
32095 *   documentation (see the Netscape Directory SDK for full information
32096 *   on filters).
32097 * @param array $attributes An array of the required attributes, e.g.
32098 *   array("mail", "sn", "cn"). Note that the "dn" is always returned
32099 *   irrespective of which attributes types are requested. Using this
32100 *   parameter is much more efficient than the default action (which is
32101 *   to return all attributes and their associated values). The use of
32102 *   this parameter should therefore be considered good practice.
32103 * @param int $attrsonly Should be set to 1 if only attribute types are
32104 *   wanted. If set to 0 both attributes types and attribute values are
32105 *   fetched which is the default behaviour.
32106 * @param int $sizelimit Enables you to limit the count of entries
32107 *   fetched. Setting this to 0 means no limit.
32108 * @param int $timelimit Sets the number of seconds how long is spend
32109 *   on the search. Setting this to 0 means no limit.
32110 * @param int $deref Specifies how aliases should be handled during the
32111 *   search. It can be one of the following: LDAP_DEREF_NEVER - (default)
32112 *   aliases are never dereferenced. LDAP_DEREF_SEARCHING - aliases
32113 *   should be dereferenced during the search but not when locating the
32114 *   base object of the search. LDAP_DEREF_FINDING - aliases should be
32115 *   dereferenced when locating the base object but not during the
32116 *   search. LDAP_DEREF_ALWAYS - aliases should be dereferenced always.
32117 * @return resource
32118 * @since PHP 4, PHP 5
32119 **/
32120function ldap_search($link_identifier, $base_dn, $filter, $attributes, $attrsonly, $sizelimit, $timelimit, $deref){}
32121
32122/**
32123 * Sets the value of the specified option to be {@link newval}.
32124 *
32125 * @param resource $link_identifier An LDAP link identifier, returned
32126 *   by {@link ldap_connect}.
32127 * @param int $option The parameter {@link option} can be one of:
32128 *   Option Type Available since LDAP_OPT_DEREF integer
32129 *   LDAP_OPT_SIZELIMIT integer LDAP_OPT_TIMELIMIT integer
32130 *   LDAP_OPT_NETWORK_TIMEOUT integer PHP 5.3.0 LDAP_OPT_PROTOCOL_VERSION
32131 *   integer LDAP_OPT_ERROR_NUMBER integer LDAP_OPT_REFERRALS bool
32132 *   LDAP_OPT_RESTART bool LDAP_OPT_HOST_NAME string
32133 *   LDAP_OPT_ERROR_STRING string LDAP_OPT_MATCHED_DN string
32134 *   LDAP_OPT_SERVER_CONTROLS array LDAP_OPT_CLIENT_CONTROLS array
32135 *   LDAP_OPT_SERVER_CONTROLS and LDAP_OPT_CLIENT_CONTROLS require a list
32136 *   of controls, this means that the value must be an array of controls.
32137 *   A control consists of an oid identifying the control, an optional
32138 *   value, and an optional flag for criticality. In PHP a control is
32139 *   given by an array containing an element with the key oid and string
32140 *   value, and two optional elements. The optional elements are key
32141 *   value with string value and key iscritical with boolean value.
32142 *   iscritical defaults to if not supplied. See
32143 *   draft-ietf-ldapext-ldap-c-api-xx.txt for details. See also the
32144 *   second example below.
32145 * @param mixed $newval The new value for the specified {@link option}.
32146 * @return bool
32147 * @since PHP 4 >= 4.0.4, PHP 5
32148 **/
32149function ldap_set_option($link_identifier, $option, $newval){}
32150
32151/**
32152 * @param resource $link
32153 * @param callback $callback
32154 * @return bool
32155 * @since PHP 4 >= 4.2.0, PHP 5
32156 **/
32157function ldap_set_rebind_proc($link, $callback){}
32158
32159/**
32160 * @param resource $link
32161 * @param resource $result
32162 * @param string $sortfilter
32163 * @return bool
32164 * @since PHP 4 >= 4.2.0, PHP 5
32165 **/
32166function ldap_sort($link, $result, $sortfilter){}
32167
32168/**
32169 * @param resource $link
32170 * @return bool
32171 * @since PHP 4 >= 4.2.0, PHP 5
32172 **/
32173function ldap_start_tls($link){}
32174
32175/**
32176 * @param string $value
32177 * @return string
32178 * @since PHP 4 >= 4.0.2, PHP 5
32179 **/
32180function ldap_t61_to_8859($value){}
32181
32182/**
32183 * Unbinds from the LDAP directory.
32184 *
32185 * @param resource $link_identifier An LDAP link identifier, returned
32186 *   by {@link ldap_connect}.
32187 * @return bool
32188 * @since PHP 4, PHP 5
32189 **/
32190function ldap_unbind($link_identifier){}
32191
32192/**
32193 * The Levenshtein distance is defined as the minimal number of
32194 * characters you have to replace, insert or delete to transform {@link
32195 * str1} into {@link str2}. The complexity of the algorithm is O(m*n),
32196 * where n and m are the length of {@link str1} and {@link str2} (rather
32197 * good when compared to {@link similar_text}, which is O(max(n,m)**3),
32198 * but still expensive).
32199 *
32200 * In its simplest form the function will take only the two strings as
32201 * parameter and will calculate just the number of insert, replace and
32202 * delete operations needed to transform {@link str1} into {@link str2}.
32203 *
32204 * A second variant will take three additional parameters that define the
32205 * cost of insert, replace and delete operations. This is more general
32206 * and adaptive than variant one, but not as efficient.
32207 *
32208 * @param string $str1 One of the strings being evaluated for
32209 *   Levenshtein distance.
32210 * @param string $str2 One of the strings being evaluated for
32211 *   Levenshtein distance.
32212 * @return int
32213 * @since PHP 4 >= 4.0.1, PHP 5
32214 **/
32215function levenshtein($str1, $str2){}
32216
32217/**
32218 * {@link libxml_clear_errors} clears the libxml error buffer.
32219 *
32220 * @return void
32221 * @since PHP 5 >= 5.1.0
32222 **/
32223function libxml_clear_errors(){}
32224
32225/**
32226 * Disable/enable the ability to load external entities.
32227 *
32228 * @param bool $disable Disable () or enable () libxml extensions (such
32229 *   as , and ) to load external entities.
32230 * @return ReturnType
32231 * @since PHP 5 >= 5.2.11
32232 **/
32233function libxml_disable_entity_loader($disable){}
32234
32235/**
32236 * Retrieve array of errors.
32237 *
32238 * @return array
32239 * @since PHP 5 >= 5.1.0
32240 **/
32241function libxml_get_errors(){}
32242
32243/**
32244 * Retrieve last error from libxml.
32245 *
32246 * @return LibXMLError
32247 * @since PHP 5 >= 5.1.0
32248 **/
32249function libxml_get_last_error(){}
32250
32251/**
32252 * Sets the streams context for the next libxml document load or write.
32253 *
32254 * @param resource $streams_context The stream context resource
32255 *   (created with {@link stream_context_create})
32256 * @return void
32257 * @since PHP 5
32258 **/
32259function libxml_set_streams_context($streams_context){}
32260
32261/**
32262 * {@link libxml_use_internal_errors} allows you to disable standard
32263 * libxml errors and enable user error handling.
32264 *
32265 * @param bool $use_errors Whether to enable user error handling.
32266 * @return bool
32267 * @since PHP 5 >= 5.1.0
32268 **/
32269function libxml_use_internal_errors($use_errors){}
32270
32271/**
32272 * {@link link} creates a hard link.
32273 *
32274 * @param string $from_path The link name.
32275 * @param string $to_path Target of the link.
32276 * @return bool
32277 * @since PHP 4, PHP 5
32278 **/
32279function link($from_path, $to_path){}
32280
32281/**
32282 * Gets information about a link.
32283 *
32284 * This function is used to verify if a link (pointed to by {@link path})
32285 * really exists (using the same method as the S_ISLNK macro defined in
32286 * stat.h).
32287 *
32288 * @param string $path Path to the link.
32289 * @return int
32290 * @since PHP 4, PHP 5
32291 **/
32292function linkinfo($path){}
32293
32294/**
32295 * Returns an associative array containing localized numeric and monetary
32296 * formatting information.
32297 *
32298 * @return array
32299 * @since PHP 4 >= 4.0.5, PHP 5
32300 **/
32301function localeconv(){}
32302
32303/**
32304 * Tries to find locale that can satisfy the language list that is
32305 * requested by the HTTP "Accept-Language" header.
32306 *
32307 * @param string $header The string containing the "Accept-Language"
32308 *   header according to format in RFC 2616.
32309 * @return string
32310 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32311 **/
32312function locale_accept_from_http($header){}
32313
32314/**
32315 * Returns a correctly ordered and delimited locale ID the keys identify
32316 * the particular locale ID subtags, and the values are the associated
32317 * subtag values.
32318 *
32319 * @param array $subtags an array containing a list of key-value pairs,
32320 *   where the keys identify the particular locale ID subtags, and the
32321 *   values are the associated subtag values. The 'variant' and 'private'
32322 *   subtags can take maximum 15 values whereas 'extlang' can take
32323 *   maximum 3 values.e.g. Variants are allowed with the suffix ranging
32324 *   from 0-14. Hence the keys for the input array can be variant0,
32325 *   variant1, ...,variant14. In the returned locale id, the subtag is
32326 *   ordered by suffix resulting in variant0 followed by variant1
32327 *   followed by variant2 and so on. The 'variant', 'private' and
32328 *   'extlang' multiple values can be specified both as array under
32329 *   specific key (e.g. 'variant') and as multiple numbered keys (e.g.
32330 *   'variant0', 'variant1', etc.).
32331 * @return string
32332 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32333 **/
32334function locale_compose($subtags){}
32335
32336/**
32337 * Checks if a $langtag filter matches with $locale according to RFC
32338 * 4647's basic filtering algorithm
32339 *
32340 * @param string $langtag The language tag to check
32341 * @param string $locale The language range to check against
32342 * @param bool $canonicalize If true, the arguments will be converted
32343 *   to canonical form before matching.
32344 * @return bool
32345 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32346 **/
32347function locale_filter_matches($langtag, $locale, $canonicalize){}
32348
32349/**
32350 * Gets the variants for the input locale
32351 *
32352 * @param string $locale The locale to extract the variants from
32353 * @return array
32354 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32355 **/
32356function locale_get_all_variants($locale){}
32357
32358/**
32359 * This function returns the default Locale, which is used by PHP to
32360 * localize certain features. Please note that this isn't influenced by
32361 * {@link setlocale} or the system settings.
32362 *
32363 * @return string
32364 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32365 **/
32366function locale_get_default(){}
32367
32368/**
32369 * Returns an appropriately localized display name for language of the
32370 * input locale. If is then the default locale is used.
32371 *
32372 * @param string $locale The locale to return a display language for
32373 * @param string $in_locale Optional format locale to use to display
32374 *   the language name
32375 * @return string
32376 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32377 **/
32378function locale_get_display_language($locale, $in_locale){}
32379
32380/**
32381 * Returns an appropriately localized display name for the input locale.
32382 * If is then the default locale is used.
32383 *
32384 * @param string $locale The locale to return a display name for.
32385 * @param string $in_locale optional format locale
32386 * @return string
32387 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32388 **/
32389function locale_get_display_name($locale, $in_locale){}
32390
32391/**
32392 * Returns an appropriately localized display name for region of the
32393 * input locale. If is then the default locale is used.
32394 *
32395 * @param string $locale The locale to return a display region for.
32396 * @param string $in_locale Optional format locale to use to display
32397 *   the region name
32398 * @return string
32399 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32400 **/
32401function locale_get_display_region($locale, $in_locale){}
32402
32403/**
32404 * Returns an appropriately localized display name for script of the
32405 * input locale. If is then the default locale is used.
32406 *
32407 * @param string $locale The locale to return a display script for
32408 * @param string $in_locale Optional format locale to use to display
32409 *   the script name
32410 * @return string
32411 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32412 **/
32413function locale_get_display_script($locale, $in_locale){}
32414
32415/**
32416 * Returns an appropriately localized display name for variants of the
32417 * input locale. If is then the default locale is used.
32418 *
32419 * @param string $locale The locale to return a display variant for
32420 * @param string $in_locale Optional format locale to use to display
32421 *   the variant name
32422 * @return string
32423 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32424 **/
32425function locale_get_display_variant($locale, $in_locale){}
32426
32427/**
32428 * Gets the keywords for the input locale.
32429 *
32430 * @param string $locale The locale to extract the keywords from
32431 * @return array
32432 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32433 **/
32434function locale_get_keywords($locale){}
32435
32436/**
32437 * Gets the primary language for the input locale
32438 *
32439 * @param string $locale The locale to extract the primary language
32440 *   code from
32441 * @return string
32442 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32443 **/
32444function locale_get_primary_language($locale){}
32445
32446/**
32447 * Gets the region for the input locale.
32448 *
32449 * @param string $locale The locale to extract the region code from
32450 * @return string
32451 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32452 **/
32453function locale_get_region($locale){}
32454
32455/**
32456 * Gets the script for the input locale.
32457 *
32458 * @param string $locale The locale to extract the script code from
32459 * @return string
32460 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32461 **/
32462function locale_get_script($locale){}
32463
32464/**
32465 * Searches the items in {@link langtag} for the best match to the
32466 * language range specified in {@link locale} according to RFC 4647's
32467 * lookup algorithm.
32468 *
32469 * @param array $langtag An array containing a list of language tags to
32470 *   compare to {@link locale}. Maximum 100 items allowed.
32471 * @param string $locale The locale to use as the language range when
32472 *   matching.
32473 * @param bool $canonicalize If true, the arguments will be converted
32474 *   to canonical form before matching.
32475 * @param string $default The locale to use if no match is found.
32476 * @return string
32477 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32478 **/
32479function locale_lookup($langtag, $locale, $canonicalize, $default){}
32480
32481/**
32482 * Returns a key-value array of locale ID subtag elements.
32483 *
32484 * @param string $locale The locale to extract the subtag array from.
32485 *   Note: The 'variant' and 'private' subtags can take maximum 15 values
32486 *   whereas 'extlang' can take maximum 3 values.
32487 * @return array
32488 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32489 **/
32490function locale_parse($locale){}
32491
32492/**
32493 * Sets the default Locale for PHP programs. Please note that this has
32494 * nothing to do with {@link setlocale} nor with the system locale.
32495 *
32496 * @param string $name The new Locale name. A comprehensive list of the
32497 *   supported locales is available at .
32498 * @return bool
32499 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
32500 **/
32501function locale_set_default($name){}
32502
32503/**
32504 * The {@link localtime} function returns an array identical to that of
32505 * the structure returned by the C function call.
32506 *
32507 * @param int $timestamp If set to or not supplied then the array is
32508 *   returned as a regular, numerically indexed array. If the argument is
32509 *   set to then {@link localtime} returns an associative array
32510 *   containing all the different elements of the structure returned by
32511 *   the C function call to localtime. The names of the different keys of
32512 *   the associative array are as follows:
32513 *
32514 *   "tm_sec" - seconds "tm_min" - minutes "tm_hour" - hour "tm_mday" -
32515 *   day of the month Months are from 0 (Jan) to 11 (Dec) and days of the
32516 *   week are from 0 (Sun) to 6 (Sat). "tm_mon" - month of the year,
32517 *   starting with 0 for January "tm_year" - Years since 1900 "tm_wday" -
32518 *   Day of the week "tm_yday" - Day of the year "tm_isdst" - Is daylight
32519 *   savings time in effect
32520 * @param bool $is_associative
32521 * @return array
32522 * @since PHP 4, PHP 5
32523 **/
32524function localtime($timestamp, $is_associative){}
32525
32526/**
32527 * If the optional {@link base} parameter is specified, {@link log}
32528 * returns logbase {@link arg}, otherwise {@link log} returns the natural
32529 * logarithm of {@link arg}.
32530 *
32531 * @param float $arg The value to calculate the logarithm for
32532 * @param float $base The optional logarithmic base to use (defaults to
32533 *   'e' and so to the natural logarithm).
32534 * @return float
32535 * @since PHP 4, PHP 5
32536 **/
32537function log($arg, $base){}
32538
32539/**
32540 * {@link log1p} returns log(1 + {@link number}) computed in a way that
32541 * is accurate even when the value of {@link number} is close to zero.
32542 * {@link log} might only return log(1) in this case due to lack of
32543 * precision.
32544 *
32545 * @param float $number The argument to process
32546 * @return float
32547 * @since PHP 4 >= 4.1.0, PHP 5
32548 **/
32549function log1p($number){}
32550
32551/**
32552 * Returns the base-10 logarithm of {@link arg}.
32553 *
32554 * @param float $arg The argument to process
32555 * @return float
32556 * @since PHP 4, PHP 5
32557 **/
32558function log10($arg){}
32559
32560/**
32561 * The function {@link long2ip} generates an Internet address in dotted
32562 * format (i.e.: aaa.bbb.ccc.ddd) from the proper address representation.
32563 *
32564 * @param string $proper_address A proper address representation.
32565 * @return string
32566 * @since PHP 4, PHP 5
32567 **/
32568function long2ip($proper_address){}
32569
32570/**
32571 * Gathers the statistics of the file or symbolic link named by {@link
32572 * filename}.
32573 *
32574 * @param string $filename Path to a file or a symbolic link.
32575 * @return array
32576 * @since PHP 4, PHP 5
32577 **/
32578function lstat($filename){}
32579
32580/**
32581 * Strip whitespace (or other characters) from the beginning of a string.
32582 *
32583 * @param string $str The input string.
32584 * @param string $charlist You can also specify the characters you want
32585 *   to strip, by means of the {@link charlist} parameter. Simply list
32586 *   all characters that you want to be stripped. With .. you can specify
32587 *   a range of characters.
32588 * @return string
32589 * @since PHP 4, PHP 5
32590 **/
32591function ltrim($str, $charlist){}
32592
32593/**
32594 * {@link lzf_compress} compresses the given {@link data} string using
32595 * LZF encoding.
32596 *
32597 * @param string $data The string to compress.
32598 * @return string
32599 * @since PECL lzf >= 0.1.0
32600 **/
32601function lzf_compress($data){}
32602
32603/**
32604 * {@link lzf_compress} decompresses the given {@link data} string
32605 * containing lzf encoded data.
32606 *
32607 * @param string $data The compressed string.
32608 * @return string
32609 * @since PECL lzf >= 0.1.0
32610 **/
32611function lzf_decompress($data){}
32612
32613/**
32614 * Determines what was LZF extension optimized for during compilation.
32615 *
32616 * @return int
32617 * @since PECL lzf >= 1.0.0
32618 **/
32619function lzf_optimized_for(){}
32620
32621/**
32622 * Set the current active configuration setting of magic_quotes_runtime.
32623 *
32624 * @param bool $new_setting for off, for on.
32625 * @return bool
32626 * @since PHP 4, PHP 5
32627 **/
32628function magic_quotes_runtime($new_setting){}
32629
32630/**
32631 * Sends an email.
32632 *
32633 * @param string $to Receiver, or receivers of the mail. The formatting
32634 *   of this string must comply with RFC 2822. Some examples are:
32635 *   user@example.com user@example.com, anotheruser@example.com User
32636 *   <user@example.com> User <user@example.com>, Another User
32637 *   <anotheruser@example.com>
32638 * @param string $subject Subject of the email to be sent.
32639 * @param string $message Message to be sent. Each line should be
32640 *   separated with a LF (\n). Lines should not be larger than 70
32641 *   characters.
32642 * @param string $additional_headers String to be inserted at the end
32643 *   of the email header. This is typically used to add extra headers
32644 *   (From, Cc, and Bcc). Multiple extra headers should be separated with
32645 *   a CRLF (\r\n).
32646 * @param string $additional_parameters The {@link
32647 *   additional_parameters} parameter can be used to pass additional
32648 *   flags as command line options to the program configured to be used
32649 *   when sending mail, as defined by the sendmail_path configuration
32650 *   setting. For example, this can be used to set the envelope sender
32651 *   address when using sendmail with the -f sendmail option. The user
32652 *   that the webserver runs as should be added as a trusted user to the
32653 *   sendmail configuration to prevent a 'X-Warning' header from being
32654 *   added to the message when the envelope sender (-f) is set using this
32655 *   method. For sendmail users, this file is /etc/mail/trusted-users.
32656 * @return bool
32657 * @since PHP 4, PHP 5
32658 **/
32659function mail($to, $subject, $message, $additional_headers, $additional_parameters){}
32660
32661/**
32662 * Figures out the best way of encoding the content read from the given
32663 * file pointer.
32664 *
32665 * @param resource $fp A valid file pointer, which must be seek-able.
32666 * @return string
32667 * @since PECL mailparse >= 0.9.0
32668 **/
32669function mailparse_determine_best_xfer_encoding($fp){}
32670
32671/**
32672 * Create a MIME mail resource.
32673 *
32674 * @return resource
32675 * @since PECL mailparse >= 0.9.0
32676 **/
32677function mailparse_msg_create(){}
32678
32679/**
32680 * @param resource $mimemail A valid MIME resource.
32681 * @param string $msgbody
32682 * @param callback $callbackfunc
32683 * @return void
32684 * @since PECL mailparse >= 0.9.0
32685 **/
32686function mailparse_msg_extract_part($mimemail, $msgbody, $callbackfunc){}
32687
32688/**
32689 * Extracts/decodes a message section from the supplied filename.
32690 *
32691 * The contents of the section will be decoded according to their
32692 * transfer encoding - base64, quoted-printable and uuencoded text are
32693 * supported.
32694 *
32695 * @param resource $mimemail A valid MIME resource, created with {@link
32696 *   mailparse_msg_create}.
32697 * @param mixed $filename Can be a file name or a valid stream
32698 *   resource.
32699 * @param callback $callbackfunc If set, this must be either a valid
32700 *   callback that will be passed the extracted section, or to make this
32701 *   function return the extracted section. If not specified, the
32702 *   contents will be sent to "stdout".
32703 * @return string
32704 * @since PECL mailparse >= 0.9.0
32705 **/
32706function mailparse_msg_extract_part_file($mimemail, $filename, $callbackfunc){}
32707
32708/**
32709 * @param resource $mimemail A valid MIME resource.
32710 * @param string $filename
32711 * @param callback $callbackfunc
32712 * @return string
32713 * @since PECL mailparse >= 0.9.0
32714 **/
32715function mailparse_msg_extract_whole_part_file($mimemail, $filename, $callbackfunc){}
32716
32717/**
32718 * Frees a MIME resource.
32719 *
32720 * @param resource $mimemail A valid MIME resource allocated by {@link
32721 *   mailparse_msg_create} or {@link mailparse_msg_parse_file}.
32722 * @return bool
32723 * @since PECL mailparse >= 0.9.0
32724 **/
32725function mailparse_msg_free($mimemail){}
32726
32727/**
32728 * @param resource $mimemail A valid MIME resource.
32729 * @param string $mimesection
32730 * @return resource
32731 * @since PECL mailparse >= 0.9.0
32732 **/
32733function mailparse_msg_get_part($mimemail, $mimesection){}
32734
32735/**
32736 * @param resource $mimemail A valid MIME resource.
32737 * @return array
32738 * @since PECL mailparse >= 0.9.0
32739 **/
32740function mailparse_msg_get_part_data($mimemail){}
32741
32742/**
32743 * @param resource $mimemail A valid MIME resource.
32744 * @return array
32745 * @since PECL mailparse >= 0.9.0
32746 **/
32747function mailparse_msg_get_structure($mimemail){}
32748
32749/**
32750 * Incrementally parse data into the supplied mime mail resource.
32751 *
32752 * This function allow you to stream portions of a file at a time, rather
32753 * than read and parse the whole thing.
32754 *
32755 * @param resource $mimemail A valid MIME resource.
32756 * @param string $data
32757 * @return bool
32758 * @since PECL mailparse >= 0.9.0
32759 **/
32760function mailparse_msg_parse($mimemail, $data){}
32761
32762/**
32763 * Parses a file. This is the optimal way of parsing a mail file that you
32764 * have on disk.
32765 *
32766 * @param string $filename Path to the file holding the message. The
32767 *   file is opened and streamed through the parser.
32768 * @return resource
32769 * @since PECL mailparse >= 0.9.0
32770 **/
32771function mailparse_msg_parse_file($filename){}
32772
32773/**
32774 * Parses a RFC 822 compliant recipient list, such as that found in the
32775 * To: header.
32776 *
32777 * @param string $addresses A string containing addresses, like in: Wez
32778 *   Furlong <wez@example.com>, doe@example.com
32779 * @return array
32780 * @since PECL mailparse >= 0.9.0
32781 **/
32782function mailparse_rfc822_parse_addresses($addresses){}
32783
32784/**
32785 * Streams data from the source file pointer, apply {@link encoding} and
32786 * write to the destination file pointer.
32787 *
32788 * @param resource $sourcefp A valid file handle. The file is streamed
32789 *   through the parser.
32790 * @param resource $destfp The destination file handle in which the
32791 *   encoded data will be written.
32792 * @param string $encoding One of the character encodings supported by
32793 *   the mbstring module.
32794 * @return bool
32795 * @since PECL mailparse >= 0.9.0
32796 **/
32797function mailparse_stream_encode($sourcefp, $destfp, $encoding){}
32798
32799/**
32800 * Scans the data from the given file pointer and extract each embedded
32801 * uuencoded file into a temporary file.
32802 *
32803 * @param resource $fp A valid file pointer.
32804 * @return array
32805 * @since PECL mailparse >= 0.9.0
32806 **/
32807function mailparse_uudecode_all($fp){}
32808
32809/**
32810 * If the first and only parameter is an array, {@link max} returns the
32811 * highest value in that array. If at least two parameters are provided,
32812 * {@link max} returns the biggest of these values.
32813 *
32814 * @param array $values An array containing the values.
32815 * @return mixed
32816 * @since PHP 4, PHP 5
32817 **/
32818function max($values){}
32819
32820/**
32821 * {@link maxdb_affected_rows} returns the number of rows affected by the
32822 * last INSERT, UPDATE, or DELETE query associated with the provided
32823 * {@link link} parameter. If this number cannot be determined, this
32824 * function will return -1.
32825 *
32826 * The {@link maxdb_affected_rows} function only works with queries which
32827 * modify a table. In order to return the number of rows from a SELECT
32828 * query, use the {@link maxdb_num_rows} function instead.
32829 *
32830 * @param resource $link
32831 * @return int
32832 * @since PECL maxdb >= 1.0
32833 **/
32834function maxdb_affected_rows($link){}
32835
32836/**
32837 * {@link maxdb_autocommit} is used to turn on or off auto-commit mode on
32838 * queries for the database connection represented by the {@link link}
32839 * resource.
32840 *
32841 * @param resource $link
32842 * @param bool $mode
32843 * @return bool
32844 * @since PECL maxdb >= 1.0
32845 **/
32846function maxdb_autocommit($link, $mode){}
32847
32848/**
32849 * (extended syntax):
32850 *
32851 * (extended syntax):
32852 *
32853 * {@link maxdb_bind_param} is used to bind variables for the parameter
32854 * markers in the SQL statement that was passed to {@link maxdb_prepare}.
32855 * The string {@link types} contains one or more characters which specify
32856 * the types for the corresponding bind variables.
32857 *
32858 * The extended syntax of {@link maxdb_bind_param} allows to give the
32859 * parameters as an array instead of a variable list of PHP variables to
32860 * the function. If the array variable has not been used before calling
32861 * {@link maxdb_bind_param}, it has to be initialized as an emtpy array.
32862 * See the examples how to use {@link maxdb_bind_param} with extended
32863 * syntax.
32864 *
32865 * Variables for SELECT INTO SQL statements can also be bound using
32866 * {@link maxdb_bind_param}. Parameters for database procedures can be
32867 * bound using {@link maxdb_bind_param}. See the examples how to use
32868 * {@link maxdb_bind_param} in this cases.
32869 *
32870 * If a variable bound as INTO variable to an SQL statement was used
32871 * before, the content of this variable is overwritten by the data of the
32872 * SELECT INTO statement. A reference to this variable will be invalid
32873 * after a call to {@link maxdb_bind_param}.
32874 *
32875 * For INOUT parameters of database procedures the content of the bound
32876 * INOUT variable is overwritten by the output value of the database
32877 * procedure. A reference to this variable will be invalid after a call
32878 * to {@link maxdb_bind_param}.
32879 *
32880 * Type specification chars Character Description i corresponding
32881 * variable has type integer d corresponding variable has type double s
32882 * corresponding variable has type string b corresponding variable is a
32883 * blob and will be sent in packages
32884 *
32885 * @param resource $stmt
32886 * @param string $types
32887 * @param mixed $var1
32888 * @return bool
32889 * @since PECL maxdb 1.0
32890 **/
32891function maxdb_bind_param($stmt, $types, &$var1){}
32892
32893/**
32894 * {@link maxdb_bind_result} is used to associate (bind) columns in the
32895 * result set to variables. When {@link maxdb_stmt_fetch} is called to
32896 * fetch data, the MaxDB client/server protocol places the data for the
32897 * bound columns into the specified variables {@link var1, ...}.
32898 *
32899 * @param resource $stmt
32900 * @param mixed $var1
32901 * @return bool
32902 * @since PECL maxdb 1.0
32903 **/
32904function maxdb_bind_result($stmt, &$var1){}
32905
32906/**
32907 * {@link maxdb_change_user} is used to change the user of the specified
32908 * database connection as given by the {@link link} parameter and to set
32909 * the current database to that specified by the {@link database}
32910 * parameter.
32911 *
32912 * In order to successfully change users a valid {@link username} and
32913 * {@link password} parameters must be provided and that user must have
32914 * sufficient permissions to access the desired database. If for any
32915 * reason authorization fails, the current user authentication will
32916 * remain.
32917 *
32918 * @param resource $link
32919 * @param string $user
32920 * @param string $password
32921 * @param string $database
32922 * @return bool
32923 * @since PECL maxdb >= 1.0
32924 **/
32925function maxdb_change_user($link, $user, $password, $database){}
32926
32927/**
32928 * Returns the current character set for the database connection
32929 * specified by the {@link link} parameter.
32930 *
32931 * @param resource $link
32932 * @return string
32933 * @since PECL maxdb >= 1.0
32934 **/
32935function maxdb_character_set_name($link){}
32936
32937/**
32938 * Returns the current character set for the database connection
32939 * specified by the {@link link} parameter.
32940 *
32941 * @param resource $link
32942 * @return string
32943 * @since PECL maxdb 1.0
32944 **/
32945function maxdb_client_encoding($link){}
32946
32947/**
32948 * The {@link maxdb_close} function closes a previously opened database
32949 * connection specified by the {@link link} parameter.
32950 *
32951 * @param resource $link
32952 * @return bool
32953 * @since PECL maxdb >= 1.0
32954 **/
32955function maxdb_close($link){}
32956
32957/**
32958 * This function has to be called after a sequence of {@link
32959 * maxdb_stmt_send_long_data}, that was started after {@link
32960 * maxdb_execute}.
32961 *
32962 * {@link param_nr} indicates which parameter to associate the end of
32963 * data with. Parameters are numbered beginning with 0.
32964 *
32965 * @param resource $stmt
32966 * @param int $param_nr
32967 * @return bool
32968 * @since PECL maxdb >= 1.0
32969 **/
32970function maxdb_close_long_data($stmt, $param_nr){}
32971
32972/**
32973 * Commits the current transaction for the database connection specified
32974 * by the {@link link} parameter.
32975 *
32976 * @param resource $link
32977 * @return bool
32978 * @since PECL maxdb >= 1.0
32979 **/
32980function maxdb_commit($link){}
32981
32982/**
32983 * The {@link maxdb_connect} function attempts to open a connection to
32984 * the MaxDB Server running on {@link host} which can be either a host
32985 * name or an IP address. Passing the string "localhost" to this
32986 * parameter, the local host is assumed. If successful, the {@link
32987 * maxdb_connect} will return an resource representing the connection to
32988 * the database.
32989 *
32990 * The {@link username} and {@link password} parameters specify the
32991 * username and password under which to connect to the MaxDB server. If
32992 * the password is not provided (the value is passed), the MaxDB server
32993 * will attempt to authenticate the user against the {@link
32994 * maxdb.default_pw} in .
32995 *
32996 * The {@link dbname} parameter if provided will specify the default
32997 * database to be used when performing queries. If not provied, the entry
32998 * {@link maxdb.default_db} in is used.
32999 *
33000 * The {@link port} and {@link socket} parameters are ignored for the
33001 * MaxDB server.
33002 *
33003 * @param string $host
33004 * @param string $username
33005 * @param string $passwd
33006 * @param string $dbname
33007 * @param int $port
33008 * @param string $socket
33009 * @return resource
33010 * @since PECL maxdb >= 1.0
33011 **/
33012function maxdb_connect($host, $username, $passwd, $dbname, $port, $socket){}
33013
33014/**
33015 * The {@link maxdb_connect_errno} function will return the last error
33016 * code number for last call to {@link maxdb_connect}. If no errors have
33017 * occured, this function will return zero.
33018 *
33019 * @return int
33020 * @since PECL maxdb >= 1.0
33021 **/
33022function maxdb_connect_errno(){}
33023
33024/**
33025 * The {@link maxdb_connect_error} function is identical to the
33026 * corresponding {@link maxdb_connect_errno} function in every way,
33027 * except instead of returning an integer error code the {@link
33028 * maxdb_connect_error} function will return a string representation of
33029 * the last error to occur for the last {@link maxdb_connect} call. If no
33030 * error has occured, this function will return an empty string.
33031 *
33032 * @return string
33033 * @since PECL maxdb >= 1.0
33034 **/
33035function maxdb_connect_error(){}
33036
33037/**
33038 * The {@link maxdb_data_seek} function seeks to an arbitrary result
33039 * pointer specified by the {@link offset} in the result set represented
33040 * by {@link result}. The {@link offset} parameter must be between zero
33041 * and the total number of rows minus one (0..{@link maxdb_num_rows} -
33042 * 1).
33043 *
33044 * @param resource $result
33045 * @param int $offset
33046 * @return bool
33047 * @since PECL maxdb >= 1.0
33048 **/
33049function maxdb_data_seek($result, $offset){}
33050
33051/**
33052 * The {@link maxdb_debug} can be used to trace the SQLDBC communication.
33053 * The following strings can be used as a parameter to {@link
33054 * maxdb_debug}:
33055 *
33056 * @param string $debug
33057 * @return void
33058 * @since PECL maxdb >= 1.0
33059 **/
33060function maxdb_debug($debug){}
33061
33062/**
33063 * @param resource $link
33064 * @return bool
33065 * @since PECL maxdb >= 1.0
33066 **/
33067function maxdb_disable_reads_from_master($link){}
33068
33069/**
33070 * @param resource $link
33071 * @return bool
33072 * @since PECL maxdb >= 1.0
33073 **/
33074function maxdb_disable_rpl_parse($link){}
33075
33076/**
33077 * @param resource $link
33078 * @return bool
33079 * @since PECL maxdb >= 1.0
33080 **/
33081function maxdb_dump_debug_info($link){}
33082
33083/**
33084 * @param string $dbname
33085 * @return resource
33086 * @since PECL maxdb >= 1.0
33087 **/
33088function maxdb_embedded_connect($dbname){}
33089
33090/**
33091 * @param resource $link
33092 * @return bool
33093 * @since PECL maxdb >= 1.0
33094 **/
33095function maxdb_enable_reads_from_master($link){}
33096
33097/**
33098 * @param resource $link
33099 * @return bool
33100 * @since PECL maxdb >= 1.0
33101 **/
33102function maxdb_enable_rpl_parse($link){}
33103
33104/**
33105 * The {@link maxdb_errno} function will return the last error code for
33106 * the most recent MaxDB function call that can succeed or fail with
33107 * respect to the database link defined by the {@link link} parameter. If
33108 * no errors have occured, this function will return zero.
33109 *
33110 * @param resource $link
33111 * @return int
33112 * @since PECL maxdb >= 1.0
33113 **/
33114function maxdb_errno($link){}
33115
33116/**
33117 * The {@link maxdb_error} function is identical to the corresponding
33118 * {@link maxdb_errno} function in every way, except instead of returning
33119 * an integer error code the {@link maxdb_error} function will return a
33120 * string representation of the last error to occur for the database
33121 * connection represented by the {@link link} parameter. If no error has
33122 * occured, this function will return an empty string.
33123 *
33124 * @param resource $link
33125 * @return string
33126 * @since PECL maxdb >= 1.0
33127 **/
33128function maxdb_error($link){}
33129
33130/**
33131 * This function is used to create a legal SQL string that you can use in
33132 * an SQL statement. The string escapestr is encoded to an escaped SQL
33133 * string, taking into account the current character set of the
33134 * connection.
33135 *
33136 * Characters encoded are ', ".
33137 *
33138 * @param resource $link
33139 * @param string $escapestr
33140 * @return string
33141 * @since PECL maxdb 1.0
33142 **/
33143function maxdb_escape_string($link, $escapestr){}
33144
33145/**
33146 * The {@link maxdb_execute} function executes a query that has been
33147 * previously prepared using the {@link maxdb_prepare} function
33148 * represented by the {@link stmt} resource. When executed any parameter
33149 * markers which exist will automatically be replaced with the appropiate
33150 * data.
33151 *
33152 * If the statement is UPDATE, DELETE, or INSERT, the total number of
33153 * affected rows can be determined by using the {@link
33154 * maxdb_stmt_affected_rows} function. Likewise, if the query yields a
33155 * result set the {@link maxdb_fetch} function is used.
33156 *
33157 * @param resource $stmt
33158 * @return bool
33159 * @since PECL maxdb 1.0
33160 **/
33161function maxdb_execute($stmt){}
33162
33163/**
33164 * {@link maxdb_fetch} returns row data using the variables bound by
33165 * {@link maxdb_stmt_bind_result}.
33166 *
33167 * @param resource $stmt
33168 * @return bool
33169 * @since PECL maxdb 1.0
33170 **/
33171function maxdb_fetch($stmt){}
33172
33173/**
33174 * Returns an array that corresponds to the fetched row or if there are
33175 * no more rows for the resultset represented by the {@link result}
33176 * parameter.
33177 *
33178 * {@link maxdb_fetch_array} is an extended version of the {@link
33179 * maxdb_fetch_row} function. In addition to storing the data in the
33180 * numeric indices of the result array, the {@link maxdb_fetch_array}
33181 * function can also store the data in associative indices, using the
33182 * field names of the result set as keys.
33183 *
33184 * If two or more columns of the result have the same field names, the
33185 * last column will take precedence and overwrite the earlier data. In
33186 * order to access multiple columns with the same name, the numerically
33187 * indexed version of the row must be used.
33188 *
33189 * The optional second argument {@link resulttype} is a constant
33190 * indicating what type of array should be produced from the current row
33191 * data. The possible values for this parameter are the constants
33192 * MAXDB_ASSOC, MAXDB_ASSOC_UPPER, MAXDB_ASSOC_LOWER, MAXDB_NUM, or
33193 * MAXDB_BOTH. By default the {@link maxdb_fetch_array} function will
33194 * assume MAXDB_BOTH, which is a combination of MAXDB_NUM and MAXDB_ASSOC
33195 * for this parameter.
33196 *
33197 * By using the MAXDB_ASSOC constant this function will behave
33198 * identically to the {@link maxdb_fetch_assoc}, while MAXDB_NUM will
33199 * behave identically to the {@link maxdb_fetch_row} function. The final
33200 * option MAXDB_BOTH will create a single array with the attributes of
33201 * both.
33202 *
33203 * By using the MAXDB_ASSOC_UPPER constant, the behaviour of this
33204 * function is identical to the use of MAXDB_ASSOC except the array index
33205 * of a column is the fieldname in upper case.
33206 *
33207 * By using the MAXDB_ASSOC_LOWER constant, the behaviour of this
33208 * function is identical to the use of MAXDB_ASSOC except the array index
33209 * of a column is the fieldname in lower case.
33210 *
33211 * @param resource $result
33212 * @param int $resulttype
33213 * @return mixed
33214 * @since PECL maxdb >= 1.0
33215 **/
33216function maxdb_fetch_array($result, $resulttype){}
33217
33218/**
33219 * Returns an associative array that corresponds to the fetched row or if
33220 * there are no more rows.
33221 *
33222 * The {@link maxdb_fetch_assoc} function is used to return an
33223 * associative array representing the next row in the result set for the
33224 * result represented by the {@link result} parameter, where each key in
33225 * the array represents the name of one of the result set's columns.
33226 *
33227 * If two or more columns of the result have the same field names, the
33228 * last column will take precedence. To access the other column(s) of the
33229 * same name, you either need to access the result with numeric indices
33230 * by using {@link maxdb_fetch_row} or add alias names.
33231 *
33232 * @param resource $result
33233 * @return array
33234 * @since PECL maxdb >= 1.0
33235 **/
33236function maxdb_fetch_assoc($result){}
33237
33238/**
33239 * The {@link maxdb_fetch_field} returns the definition of one column of
33240 * a result set as an resource. Call this function repeatedly to retrieve
33241 * information about all columns in the result set. {@link
33242 * maxdb_fetch_field} returns when no more fields are left.
33243 *
33244 * @param resource $result
33245 * @return mixed
33246 * @since PECL maxdb >= 1.0
33247 **/
33248function maxdb_fetch_field($result){}
33249
33250/**
33251 * This function serves an identical purpose to the {@link
33252 * maxdb_fetch_field} function with the single difference that, instead
33253 * of returning one resource at a time for each field, the columns are
33254 * returned as an array of resources.
33255 *
33256 * @param resource $result
33257 * @return mixed
33258 * @since PECL maxdb >= 1.0
33259 **/
33260function maxdb_fetch_fields($result){}
33261
33262/**
33263 * {@link maxdb_fetch_field_direct} returns an resource which contains
33264 * field definition information from specified resultset. The value of
33265 * fieldnr must be in the range from 0 to number of fields - 1.
33266 *
33267 * @param resource $result
33268 * @param int $fieldnr
33269 * @return mixed
33270 * @since PECL maxdb >= 1.0
33271 **/
33272function maxdb_fetch_field_direct($result, $fieldnr){}
33273
33274/**
33275 * The {@link maxdb_fetch_lengths} function returns an array containing
33276 * the lengths of every column of the current row within the result set
33277 * represented by the {@link result} parameter. If successful, a
33278 * numerically indexed array representing the lengths of each column is
33279 * returned.
33280 *
33281 * @param resource $result
33282 * @return array
33283 * @since PECL maxdb >= 1.0
33284 **/
33285function maxdb_fetch_lengths($result){}
33286
33287/**
33288 * The {@link maxdb_fetch_object} will return the current row result set
33289 * as an object where the attributes of the object represent the names of
33290 * the fields found within the result set. If no more rows exist in the
33291 * current result set, is returned.
33292 *
33293 * @param object $result
33294 * @return object
33295 * @since PECL maxdb >= 1.0
33296 **/
33297function maxdb_fetch_object($result){}
33298
33299/**
33300 * Returns an array that corresponds to the fetched row, or if there are
33301 * no more rows.
33302 *
33303 * {@link maxdb_fetch_row} fetches one row of data from the result set
33304 * represented by {@link result} and returns it as an enumerated array,
33305 * where each column is stored in an array offset starting from 0 (zero).
33306 * Each subsequent call to the {@link maxdb_fetch_row} function will
33307 * return the next row within the result set, or if there are no more
33308 * rows.
33309 *
33310 * @param resource $result
33311 * @return mixed
33312 * @since PECL maxdb >= 1.0
33313 **/
33314function maxdb_fetch_row($result){}
33315
33316/**
33317 * Returns the number of columns for the most recent query on the
33318 * connection represented by the {@link link} parameter. This function
33319 * can be useful when using the {@link maxdb_store_result} function to
33320 * determine if the query should have produced a non-empty result set or
33321 * not without knowing the nature of the query.
33322 *
33323 * @param resource $link
33324 * @return int
33325 * @since PECL maxdb >= 1.0
33326 **/
33327function maxdb_field_count($link){}
33328
33329/**
33330 * Sets the field cursor to the given offset. The next call to {@link
33331 * maxdb_fetch_field} will retrieve the field definition of the column
33332 * associated with that offset.
33333 *
33334 * @param resource $result
33335 * @param int $fieldnr
33336 * @return bool
33337 * @since PECL maxdb >= 1.0
33338 **/
33339function maxdb_field_seek($result, $fieldnr){}
33340
33341/**
33342 * Returns the position of the field cursor used for the last {@link
33343 * maxdb_fetch_field} call. This value can be used as an argument to
33344 * {@link maxdb_field_seek}.
33345 *
33346 * @param resource $result
33347 * @return int
33348 * @since PECL maxdb >= 1.0
33349 **/
33350function maxdb_field_tell($result){}
33351
33352/**
33353 * The {@link maxdb_free_result} function frees the memory associated
33354 * with the result represented by the {@link result} parameter, which was
33355 * allocated by {@link maxdb_query}, {@link maxdb_store_result} or {@link
33356 * maxdb_use_result}.
33357 *
33358 * @param resource $result
33359 * @return void
33360 * @since PECL maxdb >= 1.0
33361 **/
33362function maxdb_free_result($result){}
33363
33364/**
33365 * The {@link maxdb_get_client_info} function is used to return a string
33366 * representing the client version being used in the MaxDB extension.
33367 *
33368 * @return string
33369 * @since PECL maxdb >= 1.0
33370 **/
33371function maxdb_get_client_info(){}
33372
33373/**
33374 * Returns client version number as an integer.
33375 *
33376 * @return int
33377 * @since PECL maxdb >= 1.0
33378 **/
33379function maxdb_get_client_version(){}
33380
33381/**
33382 * The {@link maxdb_get_host_info} function returns a string describing
33383 * the connection represented by the {@link link} parameter is using.
33384 *
33385 * @param resource $link
33386 * @return string
33387 * @since PECL maxdb >= 1.0
33388 **/
33389function maxdb_get_host_info($link){}
33390
33391/**
33392 * If a statement passed to {@link maxdb_prepare} is one that produces a
33393 * result set, {@link maxdb_get_metadata} returns the result resource
33394 * that can be used to process the meta information such as total number
33395 * of fields and individual field information.
33396 *
33397 * The result set structure should be freed when you are done with it,
33398 * which you can do by passing it to {@link maxdb_free_result}
33399 *
33400 * @param resource $stmt
33401 * @return resource
33402 * @since PECL maxdb 1.0
33403 **/
33404function maxdb_get_metadata($stmt){}
33405
33406/**
33407 * Returns an integer representing the MaxDB protocol version used by the
33408 * connection represented by the {@link link} parameter.
33409 *
33410 * @param resource $link
33411 * @return int
33412 * @since PECL maxdb >= 1.0
33413 **/
33414function maxdb_get_proto_info($link){}
33415
33416/**
33417 * Returns a string representing the version of the MaxDB server that the
33418 * MaxDB extension is connected to (represented by the {@link link}
33419 * parameter).
33420 *
33421 * @param resource $link
33422 * @return string
33423 * @since PECL maxdb >= 1.0
33424 **/
33425function maxdb_get_server_info($link){}
33426
33427/**
33428 * The {@link maxdb_get_server_version} function returns the version of
33429 * the server connected to (represented by the {@link link} parameter) as
33430 * an integer.
33431 *
33432 * The form of this version number is main_version * 10000 +
33433 * minor_version * 100 + sub_version (i.e. version 7.5.0 is 70500).
33434 *
33435 * @param resource $link
33436 * @return int
33437 * @since PECL maxdb >= 1.0
33438 **/
33439function maxdb_get_server_version($link){}
33440
33441/**
33442 * The {@link maxdb_info} function returns a string providing information
33443 * about the last query executed. The nature of this string is provided
33444 * below:
33445 *
33446 * Possible maxdb_info return values Query type Example result string
33447 * INSERT INTO...SELECT... Records: 100 Duplicates: 0 Warnings: 0 INSERT
33448 * INTO...VALUES (...),(...),(...) Records: 3 Duplicates: 0 Warnings: 0
33449 * LOAD DATA INFILE ... Records: 1 Deleted: 0 Skipped: 0 Warnings: 0
33450 * ALTER TABLE ... Records: 3 Duplicates: 0 Warnings: 0 UPDATE ... Rows
33451 * matched: 40 Changed: 40 Warnings: 0
33452 *
33453 * @param resource $link
33454 * @return string
33455 * @since PECL maxdb >= 1.0
33456 **/
33457function maxdb_info($link){}
33458
33459/**
33460 * Allocates or initializes a MaxDB resource suitable for {@link
33461 * maxdb_options} and {@link maxdb_real_connect}.
33462 *
33463 * @return resource
33464 * @since PECL maxdb >= 1.0
33465 **/
33466function maxdb_init(){}
33467
33468/**
33469 * The {@link maxdb_insert_id} function returns the ID generated by a
33470 * query on a table with a column having the DEFAULT SERIAL attribute. If
33471 * the last query wasn't an INSERT or UPDATE statement or if the modified
33472 * table does not have a column with the DEFAULT SERIAL attribute, this
33473 * function will return zero.
33474 *
33475 * @param resource $link
33476 * @return mixed
33477 * @since PECL maxdb >= 1.0
33478 **/
33479function maxdb_insert_id($link){}
33480
33481/**
33482 * This function is used to disconnect from a MaxDB server specified by
33483 * the {@link processid} parameter.
33484 *
33485 * @param resource $link
33486 * @param int $processid
33487 * @return bool
33488 * @since PECL maxdb >= 1.0
33489 **/
33490function maxdb_kill($link, $processid){}
33491
33492/**
33493 * @param resource $link
33494 * @param string $query
33495 * @return bool
33496 * @since PECL maxdb >= 1.0
33497 **/
33498function maxdb_master_query($link, $query){}
33499
33500/**
33501 * {@link maxdb_more_results} indicates if one or more result sets are
33502 * available from a previous call to {@link maxdb_multi_query}.
33503 *
33504 * @param resource $link
33505 * @return bool
33506 * @since PECL maxdb >= 1.0
33507 **/
33508function maxdb_more_results($link){}
33509
33510/**
33511 * The {@link maxdb_multi_query} works like the function {@link
33512 * maxdb_query}. Multiple queries are not yet supported.
33513 *
33514 * @param resource $link
33515 * @param string $query
33516 * @return bool
33517 * @since PECL maxdb >= 1.0
33518 **/
33519function maxdb_multi_query($link, $query){}
33520
33521/**
33522 * Since multiple queries are not yet supported, {@link
33523 * maxdb_next_result} returns always .
33524 *
33525 * @param resource $link
33526 * @return bool
33527 * @since PECL maxdb >= 1.0
33528 **/
33529function maxdb_next_result($link){}
33530
33531/**
33532 * {@link maxdb_num_fields} returns the number of fields from specified
33533 * result set.
33534 *
33535 * @param resource $result
33536 * @return int
33537 * @since PECL maxdb >= 1.0
33538 **/
33539function maxdb_num_fields($result){}
33540
33541/**
33542 * Returns the number of rows in the result set.
33543 *
33544 * The use of {@link maxdb_num_rows} depends on whether you use buffered
33545 * or unbuffered result sets. In case you use unbuffered resultsets
33546 * {@link maxdb_num_rows} will not correct the correct number of rows
33547 * until all the rows in the result have been retrieved.
33548 *
33549 * @param resource $result
33550 * @return int
33551 * @since PECL maxdb >= 1.0
33552 **/
33553function maxdb_num_rows($result){}
33554
33555/**
33556 * {@link maxdb_options} can be used to set extra connect options and
33557 * affect behavior for a connection.
33558 *
33559 * This function may be called multiple times to set several options.
33560 *
33561 * {@link maxdb_options} should be called after {@link maxdb_init} and
33562 * before {@link maxdb_real_connect}.
33563 *
33564 * The parameter {@link option} is the option that you want to set, the
33565 * {@link value} is the value for the option. For detailed description of
33566 * the options see The parameter {@link option} can be one of the
33567 * following values: Valid options Name Description MAXDB_COMPNAME The
33568 * component name used to initialise the SQLDBC runtime environment.
33569 * MAXDB_APPLICATION The application to be connected to the database.
33570 * MAXDB_APPVERSION The version of the application. MAXDB_SQLMODE The SQL
33571 * mode. MAXDB_UNICODE TRUE, if the connection is an unicode (UCS2)
33572 * client or FALSE, if not. MAXDB_TIMEOUT The maximum allowed time of
33573 * inactivity after which the connection to the database is closed by the
33574 * system. MAXDB_ISOLATIONLEVEL Specifies whether and how shared locks
33575 * and exclusive locks are implicitly requested or released.
33576 * MAXDB_PACKETCOUNT The number of different request packets used for the
33577 * connection. MAXDB_STATEMENTCACHESIZE The number of prepared statements
33578 * to be cached for the connection for re-use. MAXDB_CURSORPREFIX The
33579 * prefix to use for result tables that are automatically named.
33580 *
33581 * @param resource $link
33582 * @param int $option
33583 * @param mixed $value
33584 * @return bool
33585 * @since PECL maxdb >= 1.0
33586 **/
33587function maxdb_options($link, $option, $value){}
33588
33589/**
33590 * {@link maxdb_param_count} returns the number of parameter markers
33591 * present in the prepared statement.
33592 *
33593 * @param resource $stmt
33594 * @return int
33595 * @since PECL maxdb 1.0
33596 **/
33597function maxdb_param_count($stmt){}
33598
33599/**
33600 * Checks whether the connection to the server is working. If it has gone
33601 * down, and global option maxdb.reconnect is enabled an automatic
33602 * reconnection is attempted.
33603 *
33604 * This function can be used by clients that remain idle for a long
33605 * while, to check whether the server has closed the connection and
33606 * reconnect if necessary.
33607 *
33608 * @param resource $link
33609 * @return bool
33610 * @since PECL maxdb >= 1.0
33611 **/
33612function maxdb_ping($link){}
33613
33614/**
33615 * {@link maxdb_prepare} prepares the SQL query pointed to by the
33616 * null-terminated string query, and returns a statement handle to be
33617 * used for further operations on the statement. The query must consist
33618 * of a single SQL statement.
33619 *
33620 * The parameter {@link query} can include one or more parameter markers
33621 * in the SQL statement by embedding question mark (?) characters at the
33622 * appropriate positions.
33623 *
33624 * The parameter markers must be bound to application variables using
33625 * {@link maxdb_stmt_bind_param} and/or {@link maxdb_stmt_bind_result}
33626 * before executing the statement or fetching rows.
33627 *
33628 * @param resource $link
33629 * @param string $query
33630 * @return resource
33631 * @since PECL maxdb >= 1.0
33632 **/
33633function maxdb_prepare($link, $query){}
33634
33635/**
33636 * The {@link maxdb_query} function is used to simplify the act of
33637 * performing a query against the database represented by the {@link
33638 * link} parameter.
33639 *
33640 * @param resource $link
33641 * @param string $query
33642 * @param int $resultmode
33643 * @return mixed
33644 * @since PECL maxdb >= 1.0
33645 **/
33646function maxdb_query($link, $query, $resultmode){}
33647
33648/**
33649 * {@link maxdb_real_connect} attempts to establish a connection to a
33650 * MaxDB database engine running on {@link hostname}.
33651 *
33652 * This function differs from {@link maxdb_connect}:
33653 *
33654 * @param resource $link
33655 * @param string $hostname
33656 * @param string $username
33657 * @param string $passwd
33658 * @param string $dbname
33659 * @param int $port
33660 * @param string $socket
33661 * @return bool
33662 * @since PECL maxdb >= 1.0
33663 **/
33664function maxdb_real_connect($link, $hostname, $username, $passwd, $dbname, $port, $socket){}
33665
33666/**
33667 * This function is used to create a legal SQL string that you can use in
33668 * an SQL statement. The string escapestr is encoded to an escaped SQL
33669 * string, taking into account the current character set of the
33670 * connection.
33671 *
33672 * Characters encoded are ', ".
33673 *
33674 * @param resource $link
33675 * @param string $escapestr
33676 * @return string
33677 * @since PECL maxdb >= 1.0
33678 **/
33679function maxdb_real_escape_string($link, $escapestr){}
33680
33681/**
33682 * The {@link maxdb_real_query} is functionally identical with the {@link
33683 * maxdb_query}.
33684 *
33685 * @param resource $link
33686 * @param string $query
33687 * @return bool
33688 * @since PECL maxdb >= 1.0
33689 **/
33690function maxdb_real_query($link, $query){}
33691
33692/**
33693 * @param int $flags One of the MAXDB_REPORT_XXX constants.
33694 * @return bool
33695 * @since PECL maxdb 1.0
33696 **/
33697function maxdb_report($flags){}
33698
33699/**
33700 * Rollbacks the current transaction for the database specified by the
33701 * {@link link} parameter.
33702 *
33703 * @param resource $link
33704 * @return bool
33705 * @since PECL maxdb >= 1.0
33706 **/
33707function maxdb_rollback($link){}
33708
33709/**
33710 * @param resource $link
33711 * @return int
33712 * @since PECL maxdb >= 1.0
33713 **/
33714function maxdb_rpl_parse_enabled($link){}
33715
33716/**
33717 * @param resource $link
33718 * @return bool
33719 * @since PECL maxdb >= 1.0
33720 **/
33721function maxdb_rpl_probe($link){}
33722
33723/**
33724 * @param resource $link
33725 * @return int
33726 * @since PECL maxdb >= 1.0
33727 **/
33728function maxdb_rpl_query_type($link){}
33729
33730/**
33731 * The {@link maxdb_select_db} function selects the default database
33732 * (specified by the {@link dbname} parameter) to be used when performing
33733 * queries against the database connection represented by the {@link
33734 * link} parameter.
33735 *
33736 * @param resource $link
33737 * @param string $dbname
33738 * @return bool
33739 * @since PECL maxdb >= 1.0
33740 **/
33741function maxdb_select_db($link, $dbname){}
33742
33743/**
33744 * Allows to send parameter data to the server in pieces (or chunks).
33745 * This function can be called multiple times to send the parts of a
33746 * character or binary data value for a column, which must be one of the
33747 * TEXT or BLOB datatypes.
33748 *
33749 * {@link param_nr} indicates which parameter to associate the data with.
33750 * Parameters are numbered beginning with 0. {@link data} is a string
33751 * containing data to be sent.
33752 *
33753 * @param resource $stmt
33754 * @param int $param_nr
33755 * @param string $data
33756 * @return bool
33757 * @since PECL maxdb >= 1.0
33758 **/
33759function maxdb_send_long_data($stmt, $param_nr, $data){}
33760
33761/**
33762 * @param resource $link
33763 * @param string $query
33764 * @return bool
33765 * @since PECL maxdb >= 1.0
33766 **/
33767function maxdb_send_query($link, $query){}
33768
33769/**
33770 * @return void
33771 * @since PECL maxdb >= 1.0
33772 **/
33773function maxdb_server_end(){}
33774
33775/**
33776 * @param array $server
33777 * @param array $groups
33778 * @return bool
33779 * @since PECL maxdb >= 1.0
33780 **/
33781function maxdb_server_init($server, $groups){}
33782
33783/**
33784 * {@link maxdb_set_opt} can be used to set extra connect options and
33785 * affect behavior for a connection.
33786 *
33787 * This function may be called multiple times to set several options.
33788 *
33789 * {@link maxdb_set_opt} should be called after {@link maxdb_init} and
33790 * before {@link maxdb_real_connect}.
33791 *
33792 * The parameter {@link option} is the option that you want to set, the
33793 * {@link value} is the value for the option. For detailed description of
33794 * the options see The parameter {@link option} can be one of the
33795 * following values: Valid options Name Description MAXDB_COMPNAME The
33796 * component name used to initialise the SQLDBC runtime environment.
33797 * MAXDB_APPLICATION The application to be connected to the database.
33798 * MAXDB_APPVERSION The version of the application. MAXDB_SQLMODE The SQL
33799 * mode. MAXDB_UNICODE TRUE, if the connection is an unicode (UCS2)
33800 * client or FALSE, if not. MAXDB_TIMEOUT The maximum allowed time of
33801 * inactivity after which the connection to the database is closed by the
33802 * system. MAXDB_ISOLATIONLEVEL Specifies whether and how shared locks
33803 * and exclusive locks are implicitly requested or released.
33804 * MAXDB_PACKETCOUNT The number of different request packets used for the
33805 * connection. MAXDB_STATEMENTCACHESIZE The number of prepared statements
33806 * to be cached for the connection for re-use. MAXDB_CURSORPREFIX The
33807 * prefix to use for result tables that are automatically named.
33808 *
33809 * @param resource $link
33810 * @param int $option
33811 * @param mixed $value
33812 * @return bool
33813 * @since PECL maxdb 1.0
33814 **/
33815function maxdb_set_opt($link, $option, $value){}
33816
33817/**
33818 * Returns a string containing the SQLSTATE error code for the last
33819 * error. The error code consists of five characters. '00000' means no
33820 * error. The values are specified by ANSI SQL and ODBC.
33821 *
33822 * @param resource $link
33823 * @return string
33824 * @since PECL maxdb >= 1.0
33825 **/
33826function maxdb_sqlstate($link){}
33827
33828/**
33829 * @param resource $link
33830 * @param string $key
33831 * @param string $cert
33832 * @param string $ca
33833 * @param string $capath
33834 * @param string $cipher
33835 * @return bool
33836 * @since PECL maxdb >= 1.0
33837 **/
33838function maxdb_ssl_set($link, $key, $cert, $ca, $capath, $cipher){}
33839
33840/**
33841 * {@link maxdb_stat} returns a string containing several information
33842 * about the MaxDB server running.
33843 *
33844 * @param resource $link
33845 * @return string
33846 * @since PECL maxdb >= 1.0
33847 **/
33848function maxdb_stat($link){}
33849
33850/**
33851 * {@link maxdb_stmt_affected_rows} returns the number of rows affected
33852 * by INSERT, UPDATE, or DELETE query. If the last query was invalid or
33853 * the number of rows can not determined, this function will return -1.
33854 *
33855 * @param resource $stmt
33856 * @return int
33857 * @since PECL maxdb >= 1.0
33858 **/
33859function maxdb_stmt_affected_rows($stmt){}
33860
33861/**
33862 * (extended syntax):
33863 *
33864 * (extended syntax):
33865 *
33866 * {@link maxdb_stmt_bind_param} is used to bind variables for the
33867 * parameter markers in the SQL statement that was passed to {@link
33868 * maxdb_prepare}. The string {@link types} contains one or more
33869 * characters which specify the types for the corresponding bind
33870 * variables.
33871 *
33872 * The extended syntax of {@link maxdb_stmt_bind_param} allows to give
33873 * the parameters as an array instead of a variable list of PHP variables
33874 * to the function. If the array variable has not been used before
33875 * calling {@link maxdb_stmt_bind_param}, it has to be initialized as an
33876 * emtpy array. See the examples how to use {@link maxdb_stmt_bind_param}
33877 * with extended syntax.
33878 *
33879 * Variables for SELECT INTO SQL statements can also be bound using
33880 * {@link maxdb_stmt_bind_param}. Parameters for database procedures can
33881 * be bound using {@link maxdb_stmt_bind_param}. See the examples how to
33882 * use {@link maxdb_stmt_bind_param} in this cases.
33883 *
33884 * If a variable bound as INTO variable to an SQL statement was used
33885 * before, the content of this variable is overwritten by the data of the
33886 * SELECT INTO statement. A reference to this variable will be invalid
33887 * after a call to {@link maxdb_stmt_bind_param}.
33888 *
33889 * For INOUT parameters of database procedures the content of the bound
33890 * INOUT variable is overwritten by the output value of the database
33891 * procedure. A reference to this variable will be invalid after a call
33892 * to {@link maxdb_stmt_bind_param}.
33893 *
33894 * Type specification chars Character Description i corresponding
33895 * variable has type integer d corresponding variable has type double s
33896 * corresponding variable has type string b corresponding variable is a
33897 * blob and will be sent in packages
33898 *
33899 * @param resource $stmt
33900 * @param string $types
33901 * @param mixed $var1
33902 * @return bool
33903 * @since PECL maxdb >= 1.0
33904 **/
33905function maxdb_stmt_bind_param($stmt, $types, &$var1){}
33906
33907/**
33908 * {@link maxdb_stmt_bind_result} is used to associate (bind) columns in
33909 * the result set to variables. When {@link maxdb_stmt_fetch} is called
33910 * to fetch data, the MaxDB client/server protocol places the data for
33911 * the bound columns into the specified variables {@link var1, ...}.
33912 *
33913 * @param resource $stmt
33914 * @param mixed $var1
33915 * @return bool
33916 * @since PECL maxdb >= 1.0
33917 **/
33918function maxdb_stmt_bind_result($stmt, &$var1){}
33919
33920/**
33921 * Closes a prepared statement. {@link maxdb_stmt_close} also deallocates
33922 * the statement handle pointed to by {@link stmt}. If the current
33923 * statement has pending or unread results, this function cancels them so
33924 * that the next query can be executed.
33925 *
33926 * @param resource $stmt
33927 * @return bool
33928 * @since PECL maxdb >= 1.0
33929 **/
33930function maxdb_stmt_close($stmt){}
33931
33932/**
33933 * This function has to be called after a sequence of {@link
33934 * maxdb_stmt_send_long_data}, that was started after {@link
33935 * maxdb_execute}.
33936 *
33937 * {@link param_nr} indicates which parameter to associate the end of
33938 * data with. Parameters are numbered beginning with 0.
33939 *
33940 * @param resource $stmt
33941 * @param int $param_nr
33942 * @return bool
33943 * @since PECL maxdb 1.0
33944 **/
33945function maxdb_stmt_close_long_data($stmt, $param_nr){}
33946
33947/**
33948 * The {@link maxdb_stmt_data_seek} function seeks to an arbitrary result
33949 * pointer specified by the {@link offset} in the statement result set
33950 * represented by {@link statement}. The {@link offset} parameter must be
33951 * between zero and the total number of rows minus one (0..{@link
33952 * maxdb_stmt_num_rows} - 1).
33953 *
33954 * @param resource $statement
33955 * @param int $offset
33956 * @return bool
33957 * @since PECL maxdb >= 1.0
33958 **/
33959function maxdb_stmt_data_seek($statement, $offset){}
33960
33961/**
33962 * For the statement specified by stmt, {@link maxdb_stmt_errno} returns
33963 * the error code for the most recently invoked statement function that
33964 * can succeed or fail.
33965 *
33966 * @param resource $stmt
33967 * @return int
33968 * @since PECL maxdb >= 1.0
33969 **/
33970function maxdb_stmt_errno($stmt){}
33971
33972/**
33973 * For the statement specified by stmt, {@link maxdb_stmt_error} returns
33974 * a containing the error message for the most recently invoked statement
33975 * function that can succeed or fail.
33976 *
33977 * @param resource $stmt
33978 * @return string
33979 * @since PECL maxdb >= 1.0
33980 **/
33981function maxdb_stmt_error($stmt){}
33982
33983/**
33984 * The {@link maxdb_stmt_execute} function executes a query that has been
33985 * previously prepared using the {@link maxdb_prepare} function
33986 * represented by the {@link stmt} resource. When executed any parameter
33987 * markers which exist will automatically be replaced with the appropiate
33988 * data.
33989 *
33990 * If the statement is UPDATE, DELETE, or INSERT, the total number of
33991 * affected rows can be determined by using the {@link
33992 * maxdb_stmt_affected_rows} function. Likewise, if the query yields a
33993 * result set the {@link maxdb_fetch} function is used.
33994 *
33995 * @param resource $stmt
33996 * @return bool
33997 * @since PECL maxdb >= 1.0
33998 **/
33999function maxdb_stmt_execute($stmt){}
34000
34001/**
34002 * {@link maxdb_stmt_fetch} returns row data using the variables bound by
34003 * {@link maxdb_stmt_bind_result}.
34004 *
34005 * @param resource $stmt
34006 * @return bool
34007 * @since PECL maxdb >= 1.0
34008 **/
34009function maxdb_stmt_fetch($stmt){}
34010
34011/**
34012 * The {@link maxdb_stmt_free_result} function frees the result memory
34013 * associated with the statement represented by the {@link stmt}
34014 * parameter, which was allocated by {@link maxdb_stmt_store_result}.
34015 *
34016 * @param resource $stmt
34017 * @return void
34018 * @since PECL maxdb >= 1.0
34019 **/
34020function maxdb_stmt_free_result($stmt){}
34021
34022/**
34023 * Allocates and initializes a statement resource suitable for {@link
34024 * maxdb_stmt_prepare}.
34025 *
34026 * @param resource $link
34027 * @return resource
34028 * @since PECL maxdb >= 1.0
34029 **/
34030function maxdb_stmt_init($link){}
34031
34032/**
34033 * Returns the number of rows in the result set.
34034 *
34035 * @param resource $stmt
34036 * @return int
34037 * @since PECL maxdb >= 1.0
34038 **/
34039function maxdb_stmt_num_rows($stmt){}
34040
34041/**
34042 * {@link maxdb_stmt_param_count} returns the number of parameter markers
34043 * present in the prepared statement.
34044 *
34045 * @param resource $stmt
34046 * @return int
34047 * @since PECL maxdb >= 1.0
34048 **/
34049function maxdb_stmt_param_count($stmt){}
34050
34051/**
34052 * {@link maxdb_stmt_prepare} prepares the SQL query pointed to by the
34053 * null-terminated string query. The statement resource has to be
34054 * allocated by {@link maxdb_stmt_init}. The query must consist of a
34055 * single SQL statement.
34056 *
34057 * The parameter {@link query} can include one or more parameter markers
34058 * in the SQL statement by embedding question mark (?) characters at the
34059 * appropriate positions.
34060 *
34061 * The parameter markers must be bound to application variables using
34062 * {@link maxdb_stmt_bind_param} and/or {@link maxdb_stmt_bind_result}
34063 * before executing the statement or fetching rows.
34064 *
34065 * @param resource $stmt
34066 * @param string $query
34067 * @return bool
34068 * @since PECL maxdb >= 1.0
34069 **/
34070function maxdb_stmt_prepare($stmt, $query){}
34071
34072/**
34073 * @param resource $stmt
34074 * @return bool
34075 * @since PECL maxdb >= 1.0
34076 **/
34077function maxdb_stmt_reset($stmt){}
34078
34079/**
34080 * If a statement passed to {@link maxdb_prepare} is one that produces a
34081 * result set, {@link maxdb_stmt_result_metadata} returns the result
34082 * resource that can be used to process the meta information such as
34083 * total number of fields and individual field information.
34084 *
34085 * The result set structure should be freed when you are done with it,
34086 * which you can do by passing it to {@link maxdb_free_result}
34087 *
34088 * @param resource $stmt
34089 * @return resource
34090 * @since PECL maxdb >= 1.0
34091 **/
34092function maxdb_stmt_result_metadata($stmt){}
34093
34094/**
34095 * Allows to send parameter data to the server in pieces (or chunks).
34096 * This function can be called multiple times to send the parts of a
34097 * character or binary data value for a column, which must be one of the
34098 * TEXT or BLOB datatypes.
34099 *
34100 * {@link param_nr} indicates which parameter to associate the data with.
34101 * Parameters are numbered beginning with 0. {@link data} is a string
34102 * containing data to be sent.
34103 *
34104 * @param resource $stmt
34105 * @param int $param_nr
34106 * @param string $data
34107 * @return bool
34108 * @since PECL maxdb 1.0
34109 **/
34110function maxdb_stmt_send_long_data($stmt, $param_nr, $data){}
34111
34112/**
34113 * Returns a string containing the SQLSTATE error code for the most
34114 * recently invoked prepared statement function that can succeed or fail.
34115 * The error code consists of five characters. '00000' means no error.
34116 * The values are specified by ANSI SQL and ODBC.
34117 *
34118 * @param resource $stmt
34119 * @return string
34120 * @since PECL maxdb >= 1.0
34121 **/
34122function maxdb_stmt_sqlstate($stmt){}
34123
34124/**
34125 * {@link maxdb_stmt_store_result} has no functionally effect and should
34126 * not be used for retrieving data from MaxDB server.
34127 *
34128 * @param resource $stmt
34129 * @return bool
34130 * @since PECL maxdb >= 1.0
34131 **/
34132function maxdb_stmt_store_result($stmt){}
34133
34134/**
34135 * This function has no functionally effect.
34136 *
34137 * @param resource $link
34138 * @return resource
34139 * @since PECL maxdb >= 1.0
34140 **/
34141function maxdb_store_result($link){}
34142
34143/**
34144 * The {@link maxdb_thread_id} function returns the thread ID for the
34145 * current connection which can then be killed using the {@link
34146 * maxdb_kill} function. If the connection is lost and you reconnect with
34147 * {@link maxdb_ping}, the thread ID will be other. Therefore you should
34148 * get the thread ID only when you need it.
34149 *
34150 * @param resource $link
34151 * @return int
34152 * @since PECL maxdb >= 1.0
34153 **/
34154function maxdb_thread_id($link){}
34155
34156/**
34157 * {@link maxdb_thread_safe} indicates whether the client library is
34158 * compiled as thread-safe.
34159 *
34160 * @return bool
34161 * @since PECL maxdb >= 7.6.06.04
34162 **/
34163function maxdb_thread_safe(){}
34164
34165/**
34166 * {@link maxdb_use_result} has no effect.
34167 *
34168 * @param resource $link
34169 * @return resource
34170 * @since PECL maxdb >= 1.0
34171 **/
34172function maxdb_use_result($link){}
34173
34174/**
34175 * {@link maxdb_warning_count} returns the number of warnings from the
34176 * last query in the connection represented by the {@link link}
34177 * parameter.
34178 *
34179 * @param resource $link
34180 * @return int
34181 * @since PECL maxdb >= 1.0
34182 **/
34183function maxdb_warning_count($link){}
34184
34185/**
34186 * Checks if the specified byte stream is valid for the specified
34187 * encoding. It is useful to prevent so-called "Invalid Encoding Attack".
34188 *
34189 * @param string $var The byte stream to check. If it is omitted, this
34190 *   function checks all the input from the beginning of the request.
34191 * @param string $encoding The expected encoding.
34192 * @return bool
34193 * @since PHP 4 >= 4.4.3, PHP 5 >= 5.1.3
34194 **/
34195function mb_check_encoding($var, $encoding){}
34196
34197/**
34198 * Performs case folding on a string, converted in the way specified by
34199 * {@link mode}.
34200 *
34201 * @param string $str The string being converted.
34202 * @param int $mode The mode of the conversion. It can be one of
34203 *   MB_CASE_UPPER, MB_CASE_LOWER, or MB_CASE_TITLE.
34204 * @param string $encoding
34205 * @return string
34206 * @since PHP 4 >= 4.3.0, PHP 5
34207 **/
34208function mb_convert_case($str, $mode, $encoding){}
34209
34210/**
34211 * Converts the character encoding of string {@link str} to {@link
34212 * to_encoding} from optionally {@link from_encoding}.
34213 *
34214 * @param string $str The string being encoded.
34215 * @param string $to_encoding The type of encoding that {@link str} is
34216 *   being converted to.
34217 * @param mixed $from_encoding Is specified by character code names
34218 *   before conversion. It is either an array, or a comma separated
34219 *   enumerated list. If {@link from_encoding} is not specified, the
34220 *   internal encoding will be used.
34221 *
34222 *   "auto" may be used, which expands to "ASCII,JIS,UTF-8,EUC-JP,SJIS".
34223 * @return string
34224 * @since PHP 4 >= 4.0.6, PHP 5
34225 **/
34226function mb_convert_encoding($str, $to_encoding, $from_encoding){}
34227
34228/**
34229 * Performs a "han-kaku" - "zen-kaku" conversion for string {@link str}.
34230 * This function is only useful for Japanese.
34231 *
34232 * @param string $str The string being converted.
34233 * @param string $option The conversion option. Specify with a
34234 *   combination of following options. Applicable Conversion Options
34235 *   Option Meaning r Convert "zen-kaku" alphabets to "han-kaku" R
34236 *   Convert "han-kaku" alphabets to "zen-kaku" n Convert "zen-kaku"
34237 *   numbers to "han-kaku" N Convert "han-kaku" numbers to "zen-kaku" a
34238 *   Convert "zen-kaku" alphabets and numbers to "han-kaku" A Convert
34239 *   "han-kaku" alphabets and numbers to "zen-kaku" (Characters included
34240 *   in "a", "A" options are U+0021 - U+007E excluding U+0022, U+0027,
34241 *   U+005C, U+007E) s Convert "zen-kaku" space to "han-kaku" (U+3000 ->
34242 *   U+0020) S Convert "han-kaku" space to "zen-kaku" (U+0020 -> U+3000)
34243 *   k Convert "zen-kaku kata-kana" to "han-kaku kata-kana" K Convert
34244 *   "han-kaku kata-kana" to "zen-kaku kata-kana" h Convert "zen-kaku
34245 *   hira-gana" to "han-kaku kata-kana" H Convert "han-kaku kata-kana" to
34246 *   "zen-kaku hira-gana" c Convert "zen-kaku kata-kana" to "zen-kaku
34247 *   hira-gana" C Convert "zen-kaku hira-gana" to "zen-kaku kata-kana" V
34248 *   Collapse voiced sound notation and convert them into a character.
34249 *   Use with "K","H"
34250 * @param string $encoding
34251 * @return string
34252 * @since PHP 4 >= 4.0.6, PHP 5
34253 **/
34254function mb_convert_kana($str, $option, $encoding){}
34255
34256/**
34257 * Converts character encoding of variables {@link vars} in encoding
34258 * {@link from_encoding} to encoding {@link to_encoding}.
34259 *
34260 * {@link mb_convert_variables} join strings in Array or Object to detect
34261 * encoding, since encoding detection tends to fail for short strings.
34262 * Therefore, it is impossible to mix encoding in single array or object.
34263 *
34264 * @param string $to_encoding The encoding that the string is being
34265 *   converted to.
34266 * @param mixed $from_encoding {@link from_encoding} is specified as an
34267 *   array or comma separated string, it tries to detect encoding from
34268 *   {@link from-coding}. When {@link from_encoding} is omitted,
34269 *   detect_order is used.
34270 * @param mixed $vars {@link vars} is the reference to the variable
34271 *   being converted. String, Array and Object are accepted. {@link
34272 *   mb_convert_variables} assumes all parameters have the same encoding.
34273 * @return string
34274 * @since PHP 4 >= 4.0.6, PHP 5
34275 **/
34276function mb_convert_variables($to_encoding, $from_encoding, &$vars){}
34277
34278/**
34279 * Decodes encoded-word string {@link str} in MIME header.
34280 *
34281 * @param string $str The string being decoded.
34282 * @return string
34283 * @since PHP 4 >= 4.0.6, PHP 5
34284 **/
34285function mb_decode_mimeheader($str){}
34286
34287/**
34288 * Convert numeric string reference of string {@link str} in a specified
34289 * block to character.
34290 *
34291 * @param string $str The string being decoded.
34292 * @param array $convmap {@link convmap} is an array that specifies the
34293 *   code area to convert.
34294 * @param string $encoding
34295 * @return string
34296 * @since PHP 4 >= 4.0.6, PHP 5
34297 **/
34298function mb_decode_numericentity($str, $convmap, $encoding){}
34299
34300/**
34301 * Detects character encoding in string {@link str}.
34302 *
34303 * @param string $str The string being detected.
34304 * @param mixed $encoding_list {@link encoding_list} is list of
34305 *   character encoding. Encoding order may be specified by array or
34306 *   comma separated list string. If {@link encoding_list} is omitted,
34307 *   detect_order is used.
34308 * @param bool $strict {@link strict} specifies whether to use the
34309 *   strict encoding detection or not. Default is .
34310 * @return string
34311 * @since PHP 4 >= 4.0.6, PHP 5
34312 **/
34313function mb_detect_encoding($str, $encoding_list, $strict){}
34314
34315/**
34316 * Sets the automatic character encoding detection order to {@link
34317 * encoding_list}.
34318 *
34319 * @param mixed $encoding_list {@link encoding_list} is an array or
34320 *   comma separated list of character encoding. ("auto" is expanded to
34321 *   "ASCII, JIS, UTF-8, EUC-JP, SJIS") If {@link encoding_list} is
34322 *   omitted, it returns the current character encoding detection order
34323 *   as array. This setting affects {@link mb_detect_encoding} and {@link
34324 *   mb_send_mail}. mbstring currently implements the following encoding
34325 *   detection filters. If there is an invalid byte sequence for the
34326 *   following encodings, encoding detection will fail. For ISO-8859-*,
34327 *   mbstring always detects as ISO-8859-*. For UTF-16, UTF-32, UCS2 and
34328 *   UCS4, encoding detection will fail always.
34329 *
34330 *   Useless detect order example
34331 *
34332 *   ; Always detect as ISO-8859-1 detect_order = ISO-8859-1, UTF-8
34333 *
34334 *   ; Always detect as UTF-8, since ASCII/UTF-7 values are ; valid for
34335 *   UTF-8 detect_order = UTF-8, ASCII, UTF-7
34336 * @return mixed
34337 * @since PHP 4 >= 4.0.6, PHP 5
34338 **/
34339function mb_detect_order($encoding_list){}
34340
34341/**
34342 * Encodes a given string {@link str} by the MIME header encoding scheme.
34343 *
34344 * @param string $str The string being encoded.
34345 * @param string $charset {@link charset} specifies the name of the
34346 *   character set in which {@link str} is represented in. The default
34347 *   value is determined by the current NLS setting (mbstring.language).
34348 *   {@link mb_internal_encoding} should be set to same encoding.
34349 * @param string $transfer_encoding {@link transfer_encoding} specifies
34350 *   the scheme of MIME encoding. It should be either "B" (Base64) or "Q"
34351 *   (Quoted-Printable). Falls back to "B" if not given.
34352 * @param string $linefeed {@link linefeed} specifies the EOL
34353 *   (end-of-line) marker with which {@link mb_encode_mimeheader}
34354 *   performs line-folding (a RFC term, the act of breaking a line longer
34355 *   than a certain length into multiple lines. The length is currently
34356 *   hard-coded to 74 characters). Falls back to "\r\n" (CRLF) if not
34357 *   given.
34358 * @param int $indent Indentation of the first line (number of
34359 *   characters in the header before {@link str}).
34360 * @return string
34361 * @since PHP 4 >= 4.0.6, PHP 5
34362 **/
34363function mb_encode_mimeheader($str, $charset, $transfer_encoding, $linefeed, $indent){}
34364
34365/**
34366 * Converts specified character codes in string {@link str} from HTML
34367 * numeric character reference to character code.
34368 *
34369 * @param string $str The string being encoded.
34370 * @param array $convmap {@link convmap} is array specifies code area
34371 *   to convert.
34372 * @param string $encoding
34373 * @return string
34374 * @since PHP 4 >= 4.0.6, PHP 5
34375 **/
34376function mb_encode_numericentity($str, $convmap, $encoding){}
34377
34378/**
34379 * Returns an array of aliases for a known {@link encoding} type.
34380 *
34381 * @param string $encoding The encoding type being checked, for
34382 *   aliases.
34383 * @return array
34384 * @since PHP 5 >= 5.3.0
34385 **/
34386function mb_encoding_aliases($encoding){}
34387
34388/**
34389 * @param string $pattern The search pattern.
34390 * @param string $string The search string.
34391 * @param array $regs Contains a substring of the matched string.
34392 * @return int
34393 * @since PHP 4 >= 4.2.0, PHP 5
34394 **/
34395function mb_ereg($pattern, $string, $regs){}
34396
34397/**
34398 * @param string $pattern The regular expression pattern.
34399 * @param string $string The string being searched.
34400 * @param array $regs Contains a substring of the matched string.
34401 * @return int
34402 * @since PHP 4 >= 4.2.0, PHP 5
34403 **/
34404function mb_eregi($pattern, $string, $regs){}
34405
34406/**
34407 * @param string $pattern The regular expression pattern. Multibyte
34408 *   characters may be used. The case will be ignored.
34409 * @param string $replace The replacement text.
34410 * @param string $string The searched string.
34411 * @param string $option
34412 * @return string
34413 * @since PHP 4 >= 4.2.0, PHP 5
34414 **/
34415function mb_eregi_replace($pattern, $replace, $string, $option){}
34416
34417/**
34418 * A regular expression match for a multibyte string
34419 *
34420 * @param string $pattern The regular expression pattern.
34421 * @param string $string The string being evaluated.
34422 * @param string $option
34423 * @return bool
34424 * @since PHP 4 >= 4.2.0, PHP 5
34425 **/
34426function mb_ereg_match($pattern, $string, $option){}
34427
34428/**
34429 * @param string $pattern The regular expression pattern. Multibyte
34430 *   characters may be used in {@link pattern}.
34431 * @param string $replacement The replacement text.
34432 * @param string $string The string being checked.
34433 * @param string $option
34434 * @return string
34435 * @since PHP 4 >= 4.2.0, PHP 5
34436 **/
34437function mb_ereg_replace($pattern, $replacement, $string, $option){}
34438
34439/**
34440 * Performs a multibyte regular expression match for a predefined
34441 * multibyte string.
34442 *
34443 * @param string $pattern The search pattern.
34444 * @param string $option The search option.
34445 * @return bool
34446 * @since PHP 4 >= 4.2.0, PHP 5
34447 **/
34448function mb_ereg_search($pattern, $option){}
34449
34450/**
34451 * @return int
34452 * @since PHP 4 >= 4.2.0, PHP 5
34453 **/
34454function mb_ereg_search_getpos(){}
34455
34456/**
34457 * @return array
34458 * @since PHP 4 >= 4.2.0, PHP 5
34459 **/
34460function mb_ereg_search_getregs(){}
34461
34462/**
34463 * {@link mb_ereg_search_init} sets {@link string} and {@link pattern}
34464 * for a multibyte regular expression. These values are used for {@link
34465 * mb_ereg_search}, {@link mb_ereg_search_pos}, and {@link
34466 * mb_ereg_search_regs}.
34467 *
34468 * @param string $string The search string.
34469 * @param string $pattern The search pattern.
34470 * @param string $option The search option.
34471 * @return bool
34472 * @since PHP 4 >= 4.2.0, PHP 5
34473 **/
34474function mb_ereg_search_init($string, $pattern, $option){}
34475
34476/**
34477 * Returns position and length of a matched part of the multibyte regular
34478 * expression for a predefined multibyte string
34479 *
34480 * The string for match is specified by {@link mb_ereg_search_init}. If
34481 * it is not specified, the previous one will be used.
34482 *
34483 * @param string $pattern The search pattern.
34484 * @param string $option The search option.
34485 * @return array
34486 * @since PHP 4 >= 4.2.0, PHP 5
34487 **/
34488function mb_ereg_search_pos($pattern, $option){}
34489
34490/**
34491 * Returns the matched part of a multibyte regular expression.
34492 *
34493 * @param string $pattern The search pattern.
34494 * @param string $option The search option.
34495 * @return array
34496 * @since PHP 4 >= 4.2.0, PHP 5
34497 **/
34498function mb_ereg_search_regs($pattern, $option){}
34499
34500/**
34501 * @param int $position The position to set.
34502 * @return bool
34503 * @since PHP 4 >= 4.2.0, PHP 5
34504 **/
34505function mb_ereg_search_setpos($position){}
34506
34507/**
34508 * @param string $type If {@link type} isn't specified or is specified
34509 *   to "all", an array having the elements "internal_encoding",
34510 *   "http_output", "http_input", "func_overload", "mail_charset",
34511 *   "mail_header_encoding", "mail_body_encoding" will be returned. If
34512 *   {@link type} is specified as "http_output", "http_input",
34513 *   "internal_encoding", "func_overload", the specified setting
34514 *   parameter will be returned.
34515 * @return mixed
34516 * @since PHP 4 >= 4.2.0, PHP 5
34517 **/
34518function mb_get_info($type){}
34519
34520/**
34521 * @param string $type Input string specifies the input type. "G" for
34522 *   GET, "P" for POST, "C" for COOKIE, "S" for string, "L" for list, and
34523 *   "I" for the whole list (will return array). If type is omitted, it
34524 *   returns the last input type processed.
34525 * @return mixed
34526 * @since PHP 4 >= 4.0.6, PHP 5
34527 **/
34528function mb_http_input($type){}
34529
34530/**
34531 * Set/Get the HTTP output character encoding. Output after this function
34532 * is converted to {@link encoding}.
34533 *
34534 * @param string $encoding If {@link encoding} is set, {@link
34535 *   mb_http_output} sets the HTTP output character encoding to {@link
34536 *   encoding}. If {@link encoding} is omitted, {@link mb_http_output}
34537 *   returns the current HTTP output character encoding.
34538 * @return mixed
34539 * @since PHP 4 >= 4.0.6, PHP 5
34540 **/
34541function mb_http_output($encoding){}
34542
34543/**
34544 * Set/Get the internal character encoding
34545 *
34546 * @param string $encoding {@link encoding} is the character encoding
34547 *   name used for the HTTP input character encoding conversion, HTTP
34548 *   output character encoding conversion, and the default character
34549 *   encoding for string functions defined by the mbstring module.
34550 * @return mixed
34551 * @since PHP 4 >= 4.0.6, PHP 5
34552 **/
34553function mb_internal_encoding($encoding){}
34554
34555/**
34556 * Set/Get the current language.
34557 *
34558 * @param string $language Used for encoding e-mail messages. Valid
34559 *   languages are "Japanese", "ja","English","en" and "uni" (UTF-8).
34560 *   {@link mb_send_mail} uses this setting to encode e-mail. Language
34561 *   and its setting is ISO-2022-JP/Base64 for Japanese, UTF-8/Base64 for
34562 *   uni, ISO-8859-1/quoted printable for English.
34563 * @return mixed
34564 * @since PHP 4 >= 4.0.6, PHP 5
34565 **/
34566function mb_language($language){}
34567
34568/**
34569 * Returns an array containing all supported encodings.
34570 *
34571 * @return array
34572 * @since PHP 5
34573 **/
34574function mb_list_encodings(){}
34575
34576/**
34577 * {@link mb_output_handler} is {@link ob_start} callback function.
34578 * {@link mb_output_handler} converts characters in the output buffer
34579 * from internal character encoding to HTTP output character encoding.
34580 *
34581 * @param string $contents The contents of the output buffer.
34582 * @param int $status The status of the output buffer.
34583 * @return string
34584 * @since PHP 4 >= 4.0.6, PHP 5
34585 **/
34586function mb_output_handler($contents, $status){}
34587
34588/**
34589 * Parses GET/POST/COOKIE data and sets global variables. Since PHP does
34590 * not provide raw POST/COOKIE data, it can only be used for GET data for
34591 * now. It parses URL encoded data, detects encoding, converts coding to
34592 * internal encoding and set values to the {@link result} array or global
34593 * variables.
34594 *
34595 * @param string $encoded_string The URL encoded data.
34596 * @param array $result An array containing decoded and character
34597 *   encoded converted values.
34598 * @return bool
34599 * @since PHP 4 >= 4.0.6, PHP 5
34600 **/
34601function mb_parse_str($encoded_string, &$result){}
34602
34603/**
34604 * Get a MIME charset string for a specific encoding.
34605 *
34606 * @param string $encoding The encoding being checked.
34607 * @return string
34608 * @since PHP 4 >= 4.0.6, PHP 5
34609 **/
34610function mb_preferred_mime_name($encoding){}
34611
34612/**
34613 * Returns the current encoding for a multibyte regex as a string.
34614 *
34615 * @param string $encoding
34616 * @return mixed
34617 * @since PHP 4 >= 4.2.0, PHP 5
34618 **/
34619function mb_regex_encoding($encoding){}
34620
34621/**
34622 * @param string $options The options to set. This is a a string where
34623 *   each character is an option. To set a mode, the mode character must
34624 *   be the last one set, however there can only be set one mode but
34625 *   multiple options.
34626 * @return string
34627 * @since PHP 4 >= 4.3.0, PHP 5
34628 **/
34629function mb_regex_set_options($options){}
34630
34631/**
34632 * Sends email. Headers and messages are converted and encoded according
34633 * to the {@link mb_language} setting. It's a wrapper function for {@link
34634 * mail}, so see also {@link mail} for details.
34635 *
34636 * @param string $to The mail addresses being sent to. Multiple
34637 *   recipients may be specified by putting a comma between each address
34638 *   in {@link to}. This parameter is not automatically encoded.
34639 * @param string $subject The subject of the mail.
34640 * @param string $message The message of the mail.
34641 * @param string $additional_headers {@link additional_headers} is
34642 *   inserted at the end of the header. This is typically used to add
34643 *   extra headers. Multiple extra headers are separated with a newline
34644 *   ("\n").
34645 * @param string $additional_parameter {@link additional_parameter} is
34646 *   a MTA command line parameter. It is useful when setting the correct
34647 *   Return-Path header when using sendmail.
34648 * @return bool
34649 * @since PHP 4 >= 4.0.6, PHP 5
34650 **/
34651function mb_send_mail($to, $subject, $message, $additional_headers, $additional_parameter){}
34652
34653/**
34654 * @param string $pattern The regular expression pattern.
34655 * @param string $string The string being split.
34656 * @param int $limit
34657 * @return array
34658 * @since PHP 4 >= 4.2.0, PHP 5
34659 **/
34660function mb_split($pattern, $string, $limit){}
34661
34662/**
34663 * {@link mb_strcut} performs equivalent operation as {@link mb_substr}
34664 * with different method. If {@link start} position is multi-byte
34665 * character's second byte or larger, it starts from first byte of
34666 * multi-byte character.
34667 *
34668 * It subtracts string from {@link str} that is shorter than {@link
34669 * length} AND character that is not part of multi-byte string or not
34670 * being middle of shift sequence.
34671 *
34672 * @param string $str The string being cut.
34673 * @param int $start The position that begins the cut.
34674 * @param int $length The string being decoded.
34675 * @param string $encoding
34676 * @return string
34677 * @since PHP 4 >= 4.0.6, PHP 5
34678 **/
34679function mb_strcut($str, $start, $length, $encoding){}
34680
34681/**
34682 * Truncates string {@link str} to specified {@link width}.
34683 *
34684 * @param string $str The string being decoded.
34685 * @param int $start The start position offset. Number of characters
34686 *   from the beginning of string. (First character is 0)
34687 * @param int $width The width of the desired trim.
34688 * @param string $trimmarker A string that is added to the end of
34689 *   string when string is truncated.
34690 * @param string $encoding
34691 * @return string
34692 * @since PHP 4 >= 4.0.6, PHP 5
34693 **/
34694function mb_strimwidth($str, $start, $width, $trimmarker, $encoding){}
34695
34696/**
34697 * {@link mb_stripos} returns the numeric position of the first
34698 * occurrence of {@link needle} in the {@link haystack} string. Unlike
34699 * {@link mb_strpos}, {@link mb_stripos} is case-insensitive. If {@link
34700 * needle} is not found, it returns .
34701 *
34702 * @param string $haystack The string from which to get the position of
34703 *   the first occurrence of {@link needle}
34704 * @param string $needle The string to find in {@link haystack}
34705 * @param int $offset The position in {@link haystack} to start
34706 *   searching
34707 * @param string $encoding Character encoding name to use. If it is
34708 *   omitted, internal character encoding is used.
34709 * @return int
34710 * @since PHP 5 >= 5.2.0
34711 **/
34712function mb_stripos($haystack, $needle, $offset, $encoding){}
34713
34714/**
34715 * {@link mb_stristr} finds the first occurrence of {@link needle} in
34716 * {@link haystack} and returns the portion of {@link haystack}. Unlike
34717 * {@link mb_strstr}, {@link mb_stristr} is case-insensitive. If {@link
34718 * needle} is not found, it returns .
34719 *
34720 * @param string $haystack The string from which to get the first
34721 *   occurrence of {@link needle}
34722 * @param string $needle The string to find in {@link haystack}
34723 * @param bool $part Determines which portion of {@link haystack} this
34724 *   function returns. If set to , it returns all of {@link haystack}
34725 *   from the beginning to the first occurrence of {@link needle}. If set
34726 *   to , it returns all of {@link haystack} from the first occurrence of
34727 *   {@link needle} to the end,
34728 * @param string $encoding Character encoding name to use. If it is
34729 *   omitted, internal character encoding is used.
34730 * @return string
34731 * @since PHP 5 >= 5.2.0
34732 **/
34733function mb_stristr($haystack, $needle, $part, $encoding){}
34734
34735/**
34736 * Gets the length of a string.
34737 *
34738 * @param string $str The string being checked for length.
34739 * @param string $encoding
34740 * @return int
34741 * @since PHP 4 >= 4.0.6, PHP 5
34742 **/
34743function mb_strlen($str, $encoding){}
34744
34745/**
34746 * Finds position of the first occurrence of a string in a string.
34747 *
34748 * Performs a multi-byte safe {@link strpos} operation based on number of
34749 * characters. The first character's position is 0, the second character
34750 * position is 1, and so on.
34751 *
34752 * @param string $haystack The string being checked.
34753 * @param string $needle The position counted from the beginning of
34754 *   {@link haystack}.
34755 * @param int $offset The search offset. If it is not specified, 0 is
34756 *   used.
34757 * @param string $encoding
34758 * @return int
34759 * @since PHP 4 >= 4.0.6, PHP 5
34760 **/
34761function mb_strpos($haystack, $needle, $offset, $encoding){}
34762
34763/**
34764 * {@link mb_strrchr} finds the last occurrence of {@link needle} in
34765 * {@link haystack} and returns the portion of {@link haystack}. If
34766 * {@link needle} is not found, it returns .
34767 *
34768 * @param string $haystack The string from which to get the last
34769 *   occurrence of {@link needle}
34770 * @param string $needle The string to find in {@link haystack}
34771 * @param bool $part Determines which portion of {@link haystack} this
34772 *   function returns. If set to , it returns all of {@link haystack}
34773 *   from the beginning to the last occurrence of {@link needle}. If set
34774 *   to , it returns all of {@link haystack} from the last occurrence of
34775 *   {@link needle} to the end,
34776 * @param string $encoding Character encoding name to use. If it is
34777 *   omitted, internal character encoding is used.
34778 * @return string
34779 * @since PHP 5 >= 5.2.0
34780 **/
34781function mb_strrchr($haystack, $needle, $part, $encoding){}
34782
34783/**
34784 * {@link mb_strrichr} finds the last occurrence of {@link needle} in
34785 * {@link haystack} and returns the portion of {@link haystack}. Unlike
34786 * {@link mb_strrchr}, {@link mb_strrichr} is case-insensitive. If {@link
34787 * needle} is not found, it returns .
34788 *
34789 * @param string $haystack The string from which to get the last
34790 *   occurrence of {@link needle}
34791 * @param string $needle The string to find in {@link haystack}
34792 * @param bool $part Determines which portion of {@link haystack} this
34793 *   function returns. If set to , it returns all of {@link haystack}
34794 *   from the beginning to the last occurrence of {@link needle}. If set
34795 *   to , it returns all of {@link haystack} from the last occurrence of
34796 *   {@link needle} to the end,
34797 * @param string $encoding Character encoding name to use. If it is
34798 *   omitted, internal character encoding is used.
34799 * @return string
34800 * @since PHP 5 >= 5.2.0
34801 **/
34802function mb_strrichr($haystack, $needle, $part, $encoding){}
34803
34804/**
34805 * {@link mb_strripos} performs multi-byte safe {@link strripos}
34806 * operation based on number of characters. {@link needle} position is
34807 * counted from the beginning of {@link haystack}. First character's
34808 * position is 0. Second character position is 1. Unlike {@link
34809 * mb_strrpos}, {@link mb_strripos} is case-insensitive.
34810 *
34811 * @param string $haystack The string from which to get the position of
34812 *   the last occurrence of {@link needle}
34813 * @param string $needle The string to find in {@link haystack}
34814 * @param int $offset The position in {@link haystack} to start
34815 *   searching
34816 * @param string $encoding Character encoding name to use. If it is
34817 *   omitted, internal character encoding is used.
34818 * @return int
34819 * @since PHP 5 >= 5.2.0
34820 **/
34821function mb_strripos($haystack, $needle, $offset, $encoding){}
34822
34823/**
34824 * Performs a multibyte safe {@link strrpos} operation based on the
34825 * number of characters. {@link needle} position is counted from the
34826 * beginning of {@link haystack}. First character's position is 0. Second
34827 * character position is 1.
34828 *
34829 * @param string $haystack The string being checked, for the last
34830 *   occurrence of {@link needle}
34831 * @param string $needle The string to find in {@link haystack}.
34832 * @param int $offset
34833 * @param string $encoding
34834 * @return int
34835 * @since PHP 4 >= 4.0.6, PHP 5
34836 **/
34837function mb_strrpos($haystack, $needle, $offset, $encoding){}
34838
34839/**
34840 * {@link mb_strstr} finds the first occurrence of {@link needle} in
34841 * {@link haystack} and returns the portion of {@link haystack}. If
34842 * {@link needle} is not found, it returns .
34843 *
34844 * @param string $haystack The string from which to get the first
34845 *   occurrence of {@link needle}
34846 * @param string $needle The string to find in {@link haystack}
34847 * @param bool $part Determines which portion of {@link haystack} this
34848 *   function returns. If set to , it returns all of {@link haystack}
34849 *   from the beginning to the first occurrence of {@link needle}. If set
34850 *   to , it returns all of {@link haystack} from the first occurrence of
34851 *   {@link needle} to the end,
34852 * @param string $encoding Character encoding name to use. If it is
34853 *   omitted, internal character encoding is used.
34854 * @return string
34855 * @since PHP 5 >= 5.2.0
34856 **/
34857function mb_strstr($haystack, $needle, $part, $encoding){}
34858
34859/**
34860 * Returns {@link str} with all alphabetic characters converted to
34861 * lowercase.
34862 *
34863 * @param string $str The string being lowercased.
34864 * @param string $encoding
34865 * @return string
34866 * @since PHP 4 >= 4.3.0, PHP 5
34867 **/
34868function mb_strtolower($str, $encoding){}
34869
34870/**
34871 * Returns {@link str} with all alphabetic characters converted to
34872 * uppercase.
34873 *
34874 * @param string $str The string being uppercased.
34875 * @param string $encoding
34876 * @return string
34877 * @since PHP 4 >= 4.3.0, PHP 5
34878 **/
34879function mb_strtoupper($str, $encoding){}
34880
34881/**
34882 * Returns the width of string {@link str}.
34883 *
34884 * Multi-byte characters are usually twice the width of single byte
34885 * characters.
34886 *
34887 * Characters width Chars Width U+0000 - U+0019 0 U+0020 - U+1FFF 1
34888 * U+2000 - U+FF60 2 U+FF61 - U+FF9F 1 U+FFA0 - 2
34889 *
34890 * @param string $str The string being decoded.
34891 * @param string $encoding
34892 * @return int
34893 * @since PHP 4 >= 4.0.6, PHP 5
34894 **/
34895function mb_strwidth($str, $encoding){}
34896
34897/**
34898 * Specifies a substitution character when input character encoding is
34899 * invalid or character code does not exist in output character encoding.
34900 * Invalid characters may be substituted (no output), string or integer
34901 * value (Unicode character code value).
34902 *
34903 * This setting affects {@link mb_convert_encoding}, {@link
34904 * mb_convert_variables}, {@link mb_output_handler}, and {@link
34905 * mb_send_mail}.
34906 *
34907 * @param mixed $substrchar Specify the Unicode value as an integer, or
34908 *   as one of the following strings: "none" : no output "long" : Output
34909 *   character code value (Example: U+3000, JIS+7E7E) "entity" : Output
34910 *   character entity (Example: Ȁ)
34911 * @return mixed
34912 * @since PHP 4 >= 4.0.6, PHP 5
34913 **/
34914function mb_substitute_character($substrchar){}
34915
34916/**
34917 * Performs a multi-byte safe {@link substr} operation based on number of
34918 * characters. Position is counted from the beginning of {@link str}.
34919 * First character's position is 0. Second character position is 1, and
34920 * so on.
34921 *
34922 * @param string $str The string being checked.
34923 * @param int $start The first position used in {@link str}.
34924 * @param int $length The maximum length of the returned string.
34925 * @param string $encoding
34926 * @return string
34927 * @since PHP 4 >= 4.0.6, PHP 5
34928 **/
34929function mb_substr($str, $start, $length, $encoding){}
34930
34931/**
34932 * Counts the number of times the {@link needle} substring occurs in the
34933 * {@link haystack} string.
34934 *
34935 * @param string $haystack The string being checked.
34936 * @param string $needle The string being found.
34937 * @param string $encoding
34938 * @return int
34939 * @since PHP 4 >= 4.3.0, PHP 5
34940 **/
34941function mb_substr_count($haystack, $needle, $encoding){}
34942
34943/**
34944 * The first prototype is when linked against libmcrypt 2.2.x, the second
34945 * when linked against libmcrypt 2.4.x or higher. The {@link mode} should
34946 * be either MCRYPT_ENCRYPT or MCRYPT_DECRYPT.
34947 *
34948 * This function should not be used anymore, see {@link mcrypt_generic}
34949 * and {@link mdecrypt_generic} for replacements.
34950 *
34951 * @param int $cipher
34952 * @param string $key
34953 * @param string $data
34954 * @param int $mode
34955 * @param string $iv
34956 * @return string
34957 * @since PHP 4, PHP 5
34958 **/
34959function mcrypt_cbc($cipher, $key, $data, $mode, $iv){}
34960
34961/**
34962 * The first prototype is when linked against libmcrypt 2.2.x, the second
34963 * when linked against libmcrypt 2.4.x or higher. The {@link mode} should
34964 * be either MCRYPT_ENCRYPT or MCRYPT_DECRYPT.
34965 *
34966 * This function should not be used anymore, see {@link mcrypt_generic}
34967 * and {@link mdecrypt_generic} for replacements.
34968 *
34969 * @param int $cipher
34970 * @param string $key
34971 * @param string $data
34972 * @param int $mode
34973 * @param string $iv
34974 * @return string
34975 * @since PHP 4, PHP 5
34976 **/
34977function mcrypt_cfb($cipher, $key, $data, $mode, $iv){}
34978
34979/**
34980 * Create an initialization vector (IV) from a random source.
34981 *
34982 * The IV is only meant to give an alternative seed to the encryption
34983 * routines. This IV does not need to be secret at all, though it can be
34984 * desirable. You even can send it along with your ciphertext without
34985 * losing security.
34986 *
34987 * @param int $size Determines the size of the IV, parameter {@link
34988 *   source} (defaults to random value) specifies the source of the IV.
34989 * @param int $source The source can be MCRYPT_RAND (system random
34990 *   number generator), MCRYPT_DEV_RANDOM (read data from /dev/random)
34991 *   and MCRYPT_DEV_URANDOM (read data from /dev/urandom). Prior to
34992 *   5.3.0, MCRYPT_RAND was the only one supported on Windows.
34993 * @return string
34994 * @since PHP 4, PHP 5
34995 **/
34996function mcrypt_create_iv($size, $source){}
34997
34998/**
34999 * Decrypts the {@link data} and returns the unencrypted data.
35000 *
35001 * @param string $cipher {@link cipher} is one of the MCRYPT_ciphername
35002 *   constants of the name of the algorithm as string.
35003 * @param string $key {@link key} is the key with which the data is
35004 *   encrypted. If it's smaller that the required keysize, it is padded
35005 *   with '\0'.
35006 * @param string $data {@link data} is the data that will be decrypted
35007 *   with the given cipher and mode. If the size of the data is not n *
35008 *   blocksize, the data will be padded with '\0'.
35009 * @param string $mode {@link mode} is one of the MCRYPT_MODE_modename
35010 *   constants of one of "ecb", "cbc", "cfb", "ofb", "nofb" or "stream".
35011 * @param string $iv The {@link iv} parameter is used for the
35012 *   initialisation in CBC, CFB, OFB modes, and in some algorithms in
35013 *   STREAM mode. If you do not supply an IV, while it is needed for an
35014 *   algorithm, the function issues a warning and uses an IV with all
35015 *   bytes set to '\0'.
35016 * @return string
35017 * @since PHP 4 >= 4.0.2, PHP 5
35018 **/
35019function mcrypt_decrypt($cipher, $key, $data, $mode, $iv){}
35020
35021/**
35022 * The first prototype is when linked against libmcrypt 2.2.x, the second
35023 * when linked against libmcrypt 2.4.x or higher. The {@link mode} should
35024 * be either MCRYPT_ENCRYPT or MCRYPT_DECRYPT.
35025 *
35026 * This function is deprecated and should not be used anymore, see {@link
35027 * mcrypt_generic} and {@link mdecrypt_generic} for replacements.
35028 *
35029 * @param int $cipher
35030 * @param string $key
35031 * @param string $data
35032 * @param int $mode
35033 * @return string
35034 * @since PHP 4, PHP 5
35035 **/
35036function mcrypt_ecb($cipher, $key, $data, $mode){}
35037
35038/**
35039 * Encrypts the data and returns it.
35040 *
35041 * @param string $cipher One of the MCRYPT_ciphername constants of the
35042 *   name of the algorithm as string.
35043 * @param string $key The key with which the data will be encrypted. If
35044 *   it's smaller that the required keysize, it is padded with '\0'. It
35045 *   is better not to use ASCII strings for keys. It is recommended to
35046 *   use the mhash functions to create a key from a string.
35047 * @param string $data The data that will be encrypted with the given
35048 *   cipher and mode. If the size of the data is not n * blocksize, the
35049 *   data will be padded with '\0'. The returned crypttext can be larger
35050 *   that the size of the data that is given by {@link data}.
35051 * @param string $mode One of the MCRYPT_MODE_modename constants of one
35052 *   of "ecb", "cbc", "cfb", "ofb", "nofb" or "stream".
35053 * @param string $iv Used for the initialisation in CBC, CFB, OFB
35054 *   modes, and in some algorithms in STREAM mode. If you do not supply
35055 *   an IV, while it is needed for an algorithm, the function issues a
35056 *   warning and uses an IV with all bytes set to '\0'.
35057 * @return string
35058 * @since PHP 4 >= 4.0.2, PHP 5
35059 **/
35060function mcrypt_encrypt($cipher, $key, $data, $mode, $iv){}
35061
35062/**
35063 * This function returns the name of the algorithm.
35064 *
35065 * @param resource $td The encryption descriptor.
35066 * @return string
35067 * @since PHP 4 >= 4.0.2, PHP 5
35068 **/
35069function mcrypt_enc_get_algorithms_name($td){}
35070
35071/**
35072 * Gets the blocksize of the opened algorithm.
35073 *
35074 * @param resource $td The encryption descriptor.
35075 * @return int
35076 * @since PHP 4 >= 4.0.2, PHP 5
35077 **/
35078function mcrypt_enc_get_block_size($td){}
35079
35080/**
35081 * This function returns the size of the IV of the algorithm specified by
35082 * the encryption descriptor in bytes. An IV is used in cbc, cfb and ofb
35083 * modes, and in some algorithms in stream mode.
35084 *
35085 * @param resource $td The encryption descriptor.
35086 * @return int
35087 * @since PHP 4 >= 4.0.2, PHP 5
35088 **/
35089function mcrypt_enc_get_iv_size($td){}
35090
35091/**
35092 * Gets the maximum supported key size of the algorithm in bytes.
35093 *
35094 * @param resource $td The encryption descriptor.
35095 * @return int
35096 * @since PHP 4 >= 4.0.2, PHP 5
35097 **/
35098function mcrypt_enc_get_key_size($td){}
35099
35100/**
35101 * This function returns the name of the mode.
35102 *
35103 * @param resource $td The encryption descriptor.
35104 * @return string
35105 * @since PHP 4 >= 4.0.2, PHP 5
35106 **/
35107function mcrypt_enc_get_modes_name($td){}
35108
35109/**
35110 * Gets the supported key sizes of the opened algorithm.
35111 *
35112 * @param resource $td The encryption descriptor.
35113 * @return array
35114 * @since PHP 4 >= 4.0.2, PHP 5
35115 **/
35116function mcrypt_enc_get_supported_key_sizes($td){}
35117
35118/**
35119 * Tells whether the algorithm of the opened mode is a block algorithm.
35120 *
35121 * @param resource $td The encryption descriptor.
35122 * @return bool
35123 * @since PHP 4 >= 4.0.2, PHP 5
35124 **/
35125function mcrypt_enc_is_block_algorithm($td){}
35126
35127/**
35128 * Tells whether the algorithm of the opened mode works on blocks (e.g.
35129 * for stream, and for cbc, cfb, ofb)..
35130 *
35131 * @param resource $td The encryption descriptor.
35132 * @return bool
35133 * @since PHP 4 >= 4.0.2, PHP 5
35134 **/
35135function mcrypt_enc_is_block_algorithm_mode($td){}
35136
35137/**
35138 * Tells whether the opened mode outputs blocks (e.g. for cbc and ecb,
35139 * and for cfb and stream).
35140 *
35141 * @param resource $td The encryption descriptor.
35142 * @return bool
35143 * @since PHP 4 >= 4.0.2, PHP 5
35144 **/
35145function mcrypt_enc_is_block_mode($td){}
35146
35147/**
35148 * This function runs the self test on the algorithm specified by the
35149 * descriptor {@link td}.
35150 *
35151 * @param resource $td The encryption descriptor.
35152 * @return int
35153 * @since PHP 4 >= 4.0.2, PHP 5
35154 **/
35155function mcrypt_enc_self_test($td){}
35156
35157/**
35158 * This function encrypts data. The data is padded with "\0" to make sure
35159 * the length of the data is n * blocksize. This function returns the
35160 * encrypted data. Note that the length of the returned string can in
35161 * fact be longer then the input, due to the padding of the data.
35162 *
35163 * If you want to store the encrypted data in a database make sure to
35164 * store the entire string as returned by mcrypt_generic, or the string
35165 * will not entirely decrypt properly. If your original string is 10
35166 * characters long and the block size is 8 (use {@link
35167 * mcrypt_enc_get_block_size} to determine the blocksize), you would need
35168 * at least 16 characters in your database field. Note the string
35169 * returned by {@link mdecrypt_generic} will be 16 characters as
35170 * well...use rtrim($str, "\0") to remove the padding.
35171 *
35172 * If you are for example storing the data in a MySQL database remember
35173 * that varchar fields automatically have trailing spaces removed during
35174 * insertion. As encrypted data can end in a space (ASCII 32), the data
35175 * will be damaged by this removal. Store data in a tinyblob/tinytext (or
35176 * larger) field instead.
35177 *
35178 * @param resource $td The encryption descriptor. The encryption handle
35179 *   should always be initialized with {@link mcrypt_generic_init} with a
35180 *   key and an IV before calling this function. Where the encryption is
35181 *   done, you should free the encryption buffers by calling {@link
35182 *   mcrypt_generic_deinit}. See {@link mcrypt_module_open} for an
35183 *   example.
35184 * @param string $data The data to encrypt.
35185 * @return string
35186 * @since PHP 4 >= 4.0.2, PHP 5
35187 **/
35188function mcrypt_generic($td, $data){}
35189
35190/**
35191 * This function terminates encryption specified by the encryption
35192 * descriptor ({@link td}). It clears all buffers, but does not close the
35193 * module. You need to call {@link mcrypt_module_close} yourself. (But
35194 * PHP does this for you at the end of the script.)
35195 *
35196 * @param resource $td The encryption descriptor.
35197 * @return bool
35198 * @since PHP 4 >= 4.0.7, PHP 5
35199 **/
35200function mcrypt_generic_deinit($td){}
35201
35202/**
35203 * This function is deprecated, use {@link mcrypt_generic_deinit}
35204 * instead. It can cause crashes when used with {@link
35205 * mcrypt_module_close} due to multiple buffer frees.
35206 *
35207 * This function terminates encryption specified by the encryption
35208 * descriptor ({@link td}). Actually it clears all buffers, and closes
35209 * all the modules used. Returns on error, or on success.
35210 *
35211 * @param resource $td
35212 * @return bool
35213 * @since PHP 4 >= 4.0.2, PHP 5
35214 **/
35215function mcrypt_generic_end($td){}
35216
35217/**
35218 * You need to call this function before every call to {@link
35219 * mcrypt_generic} or {@link mdecrypt_generic}.
35220 *
35221 * @param resource $td The encryption descriptor.
35222 * @param string $key The maximum length of the key should be the one
35223 *   obtained by calling {@link mcrypt_enc_get_key_size} and every value
35224 *   smaller than this is legal.
35225 * @param string $iv The IV should normally have the size of the
35226 *   algorithms block size, but you must obtain the size by calling
35227 *   {@link mcrypt_enc_get_iv_size}. IV is ignored in ECB. IV MUST exist
35228 *   in CFB, CBC, STREAM, nOFB and OFB modes. It needs to be random and
35229 *   unique (but not secret). The same IV must be used for
35230 *   encryption/decryption. If you do not want to use it you should set
35231 *   it to zeros, but this is not recommended.
35232 * @return int
35233 * @since PHP 4 >= 4.0.2, PHP 5
35234 **/
35235function mcrypt_generic_init($td, $key, $iv){}
35236
35237/**
35238 * The first prototype is when linked against libmcrypt 2.2.x, the second
35239 * when linked against libmcrypt 2.4.x or 2.5.x.
35240 *
35241 * {@link mcrypt_get_block_size} is used to get the size of a block of
35242 * the specified {@link cipher} (in combination with an encryption mode).
35243 *
35244 * It is more useful to use the {@link mcrypt_enc_get_block_size}
35245 * function as this uses the resource returned by {@link
35246 * mcrypt_module_open}.
35247 *
35248 * @param int $cipher One of the MCRYPT_ciphername constants or the
35249 *   name of the algorithm as string.
35250 * @return int
35251 * @since PHP 4, PHP 5
35252 **/
35253function mcrypt_get_block_size($cipher){}
35254
35255/**
35256 * {@link mcrypt_get_cipher_name} is used to get the name of the
35257 * specified cipher.
35258 *
35259 * {@link mcrypt_get_cipher_name} takes the cipher number as an argument
35260 * (libmcrypt 2.2.x) or takes the cipher name as an argument (libmcrypt
35261 * 2.4.x or higher) and returns the name of the cipher or , if the cipher
35262 * does not exist.
35263 *
35264 * @param int $cipher One of the MCRYPT_ciphername constants or the
35265 *   name of the algorithm as string.
35266 * @return string
35267 * @since PHP 4, PHP 5
35268 **/
35269function mcrypt_get_cipher_name($cipher){}
35270
35271/**
35272 * Gets the size of the IV belonging to a specific {@link cipher}/{@link
35273 * mode} combination.
35274 *
35275 * It is more useful to use the {@link mcrypt_enc_get_iv_size} function
35276 * as this uses the resource returned by {@link mcrypt_module_open}.
35277 *
35278 * @param string $cipher One of the MCRYPT_ciphername constants of the
35279 *   name of the algorithm as string.
35280 * @param string $mode {@link mode} is one of the MCRYPT_MODE_modename
35281 *   constants or one of "ecb", "cbc", "cfb", "ofb", "nofb" or "stream".
35282 *   The IV is ignored in ECB mode as this mode does not require it. You
35283 *   will need to have the same IV (think: starting point) both at
35284 *   encryption and decryption stages, otherwise your encryption will
35285 *   fail.
35286 * @return int
35287 * @since PHP 4 >= 4.0.2, PHP 5
35288 **/
35289function mcrypt_get_iv_size($cipher, $mode){}
35290
35291/**
35292 * The first prototype is when linked against libmcrypt 2.2.x, the second
35293 * when linked against libmcrypt 2.4.x or 2.5.x.
35294 *
35295 * {@link mcrypt_get_key_size} is used to get the size of a key of the
35296 * specified {@link cipher} (in combination with an encryption mode).
35297 *
35298 * This example shows how to use this function when linked against
35299 * libmcrypt 2.4.x and 2.5.x. It is more useful to use the {@link
35300 * mcrypt_enc_get_key_size} function as this uses the resource returned
35301 * by {@link mcrypt_module_open}.
35302 *
35303 * {@link mcrypt_get_key_size} example
35304 *
35305 * <?php echo mcrypt_get_key_size('tripledes', 'ecb'); ?>
35306 *
35307 * Prints: 24
35308 *
35309 * See also: {@link mcrypt_get_block_size}, {@link
35310 * mcrypt_enc_get_key_size} and {@link mcrypt_encrypt}.
35311 *
35312 * @param int $cipher
35313 * @return int
35314 * @since PHP 4, PHP 5
35315 **/
35316function mcrypt_get_key_size($cipher){}
35317
35318/**
35319 * Gets the list of all supported algorithms in the {@link lib_dir}
35320 * parameter.
35321 *
35322 * @param string $lib_dir Specifies the directory where all algorithms
35323 *   are located. If not specifies, the value of the
35324 *   mcrypt.algorithms_dir directive is used.
35325 * @return array
35326 * @since PHP 4 >= 4.0.2, PHP 5
35327 **/
35328function mcrypt_list_algorithms($lib_dir){}
35329
35330/**
35331 * Gets the list of all supported modes in the {@link lib_dir} parameter.
35332 *
35333 * @param string $lib_dir Specifies the directory where all modes are
35334 *   located. If not specifies, the value of the mcrypt.modes_dir
35335 *   directive is used.
35336 * @return array
35337 * @since PHP 4 >= 4.0.2, PHP 5
35338 **/
35339function mcrypt_list_modes($lib_dir){}
35340
35341/**
35342 * Closes the specified encryption handle.
35343 *
35344 * @param resource $td The encryption descriptor.
35345 * @return bool
35346 * @since PHP 4 >= 4.0.2, PHP 5
35347 **/
35348function mcrypt_module_close($td){}
35349
35350/**
35351 * Gets the blocksize of the specified algorithm.
35352 *
35353 * @param string $algorithm The algorithm name.
35354 * @param string $lib_dir This optional parameter can contain the
35355 *   location where the mode module is on the system.
35356 * @return int
35357 * @since PHP 4 >= 4.0.2, PHP 5
35358 **/
35359function mcrypt_module_get_algo_block_size($algorithm, $lib_dir){}
35360
35361/**
35362 * Gets the maximum supported keysize of the opened mode.
35363 *
35364 * @param string $algorithm The algorithm name.
35365 * @param string $lib_dir This optional parameter can contain the
35366 *   location where the mode module is on the system.
35367 * @return int
35368 * @since PHP 4 >= 4.0.2, PHP 5
35369 **/
35370function mcrypt_module_get_algo_key_size($algorithm, $lib_dir){}
35371
35372/**
35373 * Returns an array with the key sizes supported by the specified
35374 * algorithm. If it returns an empty array then all key sizes between 1
35375 * and {@link mcrypt_module_get_algo_key_size} are supported by the
35376 * algorithm.
35377 *
35378 * @param string $algorithm The algorithm to used.
35379 * @param string $lib_dir The optional {@link lib_dir} parameter can
35380 *   contain the location of where the algorithm module is on the system.
35381 * @return array
35382 * @since PHP 4 >= 4.0.2, PHP 5
35383 **/
35384function mcrypt_module_get_supported_key_sizes($algorithm, $lib_dir){}
35385
35386/**
35387 * This function returns if the specified algorithm is a block algorithm,
35388 * or is it is a stream algorithm.
35389 *
35390 * @param string $algorithm The algorithm to check.
35391 * @param string $lib_dir The optional {@link lib_dir} parameter can
35392 *   contain the location of where the algorithm module is on the system.
35393 * @return bool
35394 * @since PHP 4 >= 4.0.2, PHP 5
35395 **/
35396function mcrypt_module_is_block_algorithm($algorithm, $lib_dir){}
35397
35398/**
35399 * This function returns if the mode is for use with block algorithms,
35400 * otherwise it returns . (e.g. for stream, and for cbc, cfb, ofb).
35401 *
35402 * @param string $mode The mode to check.
35403 * @param string $lib_dir The optional {@link lib_dir} parameter can
35404 *   contain the location of where the algorithm module is on the system.
35405 * @return bool
35406 * @since PHP 4 >= 4.0.2, PHP 5
35407 **/
35408function mcrypt_module_is_block_algorithm_mode($mode, $lib_dir){}
35409
35410/**
35411 * This function returns if the mode outputs blocks of bytes or if it
35412 * outputs just bytes. (e.g. for cbc and ecb, and for cfb and stream).
35413 *
35414 * @param string $mode The mode to check.
35415 * @param string $lib_dir The optional {@link lib_dir} parameter can
35416 *   contain the location of where the algorithm module is on the system.
35417 * @return bool
35418 * @since PHP 4 >= 4.0.2, PHP 5
35419 **/
35420function mcrypt_module_is_block_mode($mode, $lib_dir){}
35421
35422/**
35423 * This function opens the module of the algorithm and the mode to be
35424 * used. The name of the algorithm is specified in algorithm, e.g.
35425 * "twofish" or is one of the MCRYPT_ciphername constants. The module is
35426 * closed by calling {@link mcrypt_module_close}.
35427 *
35428 * @param string $algorithm The algorithm to be used.
35429 * @param string $algorithm_directory The {@link algorithm_directory}
35430 *   and {@link mode_directory} are used to locate the encryption
35431 *   modules. When you supply a directory name, it is used. When you set
35432 *   one of these to the empty string (""), the value set by the {@link
35433 *   mcrypt.algorithms_dir} or {@link mcrypt.modes_dir} ini-directive is
35434 *   used. When these are not set, the default directories that are used
35435 *   are the ones that were compiled in into libmcrypt (usually
35436 *   /usr/local/lib/libmcrypt).
35437 * @param string $mode The mode to be used.
35438 * @param string $mode_directory
35439 * @return resource
35440 * @since PHP 4 >= 4.0.2, PHP 5
35441 **/
35442function mcrypt_module_open($algorithm, $algorithm_directory, $mode, $mode_directory){}
35443
35444/**
35445 * This function runs the self test on the algorithm specified.
35446 *
35447 * @param string $algorithm The algorithm to test.
35448 * @param string $lib_dir The optional {@link lib_dir} parameter can
35449 *   contain the location of where the algorithm module is on the system.
35450 * @return bool
35451 * @since PHP 4 >= 4.0.2, PHP 5
35452 **/
35453function mcrypt_module_self_test($algorithm, $lib_dir){}
35454
35455/**
35456 * The first prototype is when linked against libmcrypt 2.2.x, the second
35457 * when linked against libmcrypt 2.4.x or higher. The {@link mode} should
35458 * be either MCRYPT_ENCRYPT or MCRYPT_DECRYPT.
35459 *
35460 * This function should not be used anymore, see {@link mcrypt_generic}
35461 * and {@link mdecrypt_generic} for replacements.
35462 *
35463 * @param int $cipher
35464 * @param string $key
35465 * @param string $data
35466 * @param int $mode
35467 * @param string $iv
35468 * @return string
35469 * @since PHP 4, PHP 5
35470 **/
35471function mcrypt_ofb($cipher, $key, $data, $mode, $iv){}
35472
35473/**
35474 * Calculates the MD5 hash of {@link str} using the RSA Data Security,
35475 * Inc. MD5 Message-Digest Algorithm, and returns that hash.
35476 *
35477 * @param string $str The string.
35478 * @param bool $raw_output If the optional {@link raw_output} is set to
35479 *   , then the md5 digest is instead returned in raw binary format with
35480 *   a length of 16.
35481 * @return string
35482 * @since PHP 4, PHP 5
35483 **/
35484function md5($str, $raw_output){}
35485
35486/**
35487 * Calculates the MD5 hash of the file specified by the {@link filename}
35488 * parameter using the RSA Data Security, Inc. MD5 Message-Digest
35489 * Algorithm, and returns that hash. The hash is a 32-character
35490 * hexadecimal number.
35491 *
35492 * @param string $filename The filename
35493 * @param bool $raw_output When , returns the digest in raw binary
35494 *   format with a length of 16.
35495 * @return string
35496 * @since PHP 4 >= 4.2.0, PHP 5
35497 **/
35498function md5_file($filename, $raw_output){}
35499
35500/**
35501 * This function decrypts data. Note that the length of the returned
35502 * string can in fact be longer then the unencrypted string, due to the
35503 * padding of the data.
35504 *
35505 * @param resource $td An encryption descriptor returned by {@link
35506 *   mcrypt_module_open}
35507 * @param string $data Encrypted data.
35508 * @return string
35509 * @since PHP 4 >= 4.0.2, PHP 5
35510 **/
35511function mdecrypt_generic($td, $data){}
35512
35513/**
35514 * {@link memcache_debug} turns on debug output if parameter {@link
35515 * on_off} is equal to and turns off if it's . {@link memcache_debug} is
35516 * accessible only if PHP was built with --enable-debug option and always
35517 * returns in this case. Otherwise, this function has no effect and
35518 * always returns .
35519 *
35520 * @param bool $on_off Turns debug output on if equals to . Turns debug
35521 *   output off if equals to .
35522 * @return bool
35523 **/
35524function memcache_debug($on_off){}
35525
35526/**
35527 * Returns the peak of memory, in bytes, that's been allocated to your
35528 * PHP script.
35529 *
35530 * @param bool $real_usage Set this to to get the real size of memory
35531 *   allocated from system. If not set or only the memory used by
35532 *   emalloc() is reported.
35533 * @return int
35534 * @since PHP 5 >= 5.2.0
35535 **/
35536function memory_get_peak_usage($real_usage){}
35537
35538/**
35539 * Returns the amount of memory, in bytes, that's currently being
35540 * allocated to your PHP script.
35541 *
35542 * @param bool $real_usage Set this to to get the real size of memory
35543 *   allocated from system. If not set or only the memory used by
35544 *   emalloc() is reported.
35545 * @return int
35546 * @since PHP 4 >= 4.3.2, PHP 5
35547 **/
35548function memory_get_usage($real_usage){}
35549
35550/**
35551 * Calculates the metaphone key of {@link str}.
35552 *
35553 * Similar to {@link soundex} metaphone creates the same key for similar
35554 * sounding words. It's more accurate than {@link soundex} as it knows
35555 * the basic rules of English pronunciation. The metaphone generated keys
35556 * are of variable length.
35557 *
35558 * Metaphone was developed by Lawrence Philips <lphilips at verity dot
35559 * com>. It is described in ["Practical Algorithms for Programmers",
35560 * Binstock & Rex, Addison Wesley, 1995].
35561 *
35562 * @param string $str The input string.
35563 * @param int $phonemes This parameter restricts the returned metaphone
35564 *   key to {@link phonemes} characters in length. The default value of 0
35565 *   means no restriction.
35566 * @return string
35567 * @since PHP 4, PHP 5
35568 **/
35569function metaphone($str, $phonemes){}
35570
35571/**
35572 * Checks if the class method exists in the given {@link object}.
35573 *
35574 * @param mixed $object An object instance or a class name
35575 * @param string $method_name The method name
35576 * @return bool
35577 * @since PHP 4, PHP 5
35578 **/
35579function method_exists($object, $method_name){}
35580
35581/**
35582 * {@link mhash} applies a hash function specified by {@link hash} to the
35583 * {@link data}.
35584 *
35585 * @param int $hash The hash id. One of the MHASH_XXX constants.
35586 * @param string $data The user input, as a string.
35587 * @param string $key If specified, the function will return the
35588 *   resulting HMAC instead. HMAC is keyed hashing for message
35589 *   authentication, or simply a message digest that depends on the
35590 *   specified key. Not all algorithms supported in mhash can be used in
35591 *   HMAC mode.
35592 * @return string
35593 * @since PHP 4, PHP 5
35594 **/
35595function mhash($hash, $data, $key){}
35596
35597/**
35598 * Gets the highest available hash id.
35599 *
35600 * @return int
35601 * @since PHP 4, PHP 5
35602 **/
35603function mhash_count(){}
35604
35605/**
35606 * Gets the size of a block of the specified {@link hash}.
35607 *
35608 * @param int $hash The hash id. One of the MHASH_XXX constants.
35609 * @return int
35610 * @since PHP 4, PHP 5
35611 **/
35612function mhash_get_block_size($hash){}
35613
35614/**
35615 * Gets the name of the specified {@link hash}.
35616 *
35617 * @param int $hash The hash id. One of the MHASH_XXX constants.
35618 * @return string
35619 * @since PHP 4, PHP 5
35620 **/
35621function mhash_get_hash_name($hash){}
35622
35623/**
35624 * Generates a key according to the {@link hash} given a user provided
35625 * {@link password}.
35626 *
35627 * This is the Salted S2K algorithm as specified in the OpenPGP document
35628 * (RFC 2440).
35629 *
35630 * Keep in mind that user supplied passwords are not really suitable to
35631 * be used as keys in cryptographic algorithms, since users normally
35632 * choose keys they can write on keyboard. These passwords use only 6 to
35633 * 7 bits per character (or less). It is highly recommended to use some
35634 * kind of transformation (like this function) to the user supplied key.
35635 *
35636 * @param int $hash The hash id used to create the key. One of the
35637 *   MHASH_XXX constants.
35638 * @param string $password User supplied password.
35639 * @param string $salt Must be different and random enough for every
35640 *   key you generate in order to create different keys. That salt must
35641 *   be known when you check the keys, thus it is a good idea to append
35642 *   the key to it. Salt has a fixed length of 8 bytes and will be padded
35643 *   with zeros if you supply less bytes.
35644 * @param int $bytes The key length, in bytes.
35645 * @return string
35646 * @since PHP 4 >= 4.0.4, PHP 5
35647 **/
35648function mhash_keygen_s2k($hash, $password, $salt, $bytes){}
35649
35650/**
35651 * {@link microtime} returns the current Unix timestamp with
35652 * microseconds. This function is only available on operating systems
35653 * that support the gettimeofday() system call.
35654 *
35655 * @param bool $get_as_float When called without the optional argument,
35656 *   this function returns the string "msec sec" where sec is the current
35657 *   time measured in the number of seconds since the Unix Epoch (0:00:00
35658 *   January 1, 1970 GMT), and msec is the microseconds part. Both
35659 *   portions of the string are returned in units of seconds. If the
35660 *   optional {@link get_as_float} is set to then a float (in seconds) is
35661 *   returned.
35662 * @return mixed
35663 * @since PHP 4, PHP 5
35664 **/
35665function microtime($get_as_float){}
35666
35667/**
35668 * Returns the MIME content type for a file as determined by using
35669 * information from the magic.mime file.
35670 *
35671 * @param string $filename Path to the tested file.
35672 * @return string
35673 * @since PHP 4 >= 4.3.0, PHP 5
35674 **/
35675function mime_content_type($filename){}
35676
35677/**
35678 * If the first and only parameter is an array, {@link min} returns the
35679 * lowest value in that array. If at least two parameters are provided,
35680 * {@link min} returns the smallest of these values.
35681 *
35682 * @param array $values An array containing the values.
35683 * @return mixed
35684 * @since PHP 4, PHP 5
35685 **/
35686function min($values){}
35687
35688/**
35689 * @param string $char
35690 * @return int
35691 * @since PHP 5
35692 **/
35693function ming_keypress($char){}
35694
35695/**
35696 * Sets the threshold error for drawing cubic beziers.
35697 *
35698 * @param int $threshold The Threshold. Lower is more accurate, hence
35699 *   larger file size.
35700 * @return void
35701 * @since PHP 4 >= 4.0.5, PHP 5, PECL ming SVN
35702 **/
35703function ming_setcubicthreshold($threshold){}
35704
35705/**
35706 * Sets the scale of the output SWF. Inside the SWF file, coordinates are
35707 * measured in TWIPS, rather than PIXELS. There are 20 TWIPS in 1 pixel.
35708 *
35709 * @param float $scale The scale to be set.
35710 * @return void
35711 * @since PHP 4 >= 4.0.5, PHP 5, PECL ming SVN
35712 **/
35713function ming_setscale($scale){}
35714
35715/**
35716 * Sets the SWF output compression level.
35717 *
35718 * @param int $level The new compression level. Should be a value
35719 *   between 1 and 9 inclusive.
35720 * @return void
35721 * @since PHP 5.2.1-5.3.0, PECL ming SVN
35722 **/
35723function ming_setswfcompression($level){}
35724
35725/**
35726 * @param int $use
35727 * @return void
35728 * @since PHP 5
35729 **/
35730function ming_useconstants($use){}
35731
35732/**
35733 * Sets the SWF version to be used in the movie. This affect the
35734 * bahaviour of Action Script.
35735 *
35736 * @param int $version SWF version to use.
35737 * @return void
35738 * @since PHP 4 >= 4.2.0, PHP 5
35739 **/
35740function ming_useswfversion($version){}
35741
35742/**
35743 * Attempts to create the directory specified by pathname.
35744 *
35745 * @param string $pathname The directory path.
35746 * @param int $mode The mode is 0777 by default, which means the widest
35747 *   possible access. For more information on modes, read the details on
35748 *   the {@link chmod} page. Note that you probably want to specify the
35749 *   mode as an octal number, which means it should have a leading zero.
35750 *   The mode is also modified by the current umask, which you can change
35751 *   using {@link umask}.
35752 * @param bool $recursive Allows the creation of nested directories
35753 *   specified in the {@link pathname}. Defaults to .
35754 * @param resource $context
35755 * @return bool
35756 * @since PHP 4, PHP 5
35757 **/
35758function mkdir($pathname, $mode, $recursive, $context){}
35759
35760/**
35761 * Returns the Unix timestamp corresponding to the arguments given. This
35762 * timestamp is a long integer containing the number of seconds between
35763 * the Unix Epoch (January 1 1970 00:00:00 GMT) and the time specified.
35764 *
35765 * Arguments may be left out in order from right to left; any arguments
35766 * thus omitted will be set to the current value according to the local
35767 * date and time.
35768 *
35769 * @param int $hour The number of the hour.
35770 * @param int $minute The number of the minute.
35771 * @param int $second The number of seconds past the minute.
35772 * @param int $month The number of the month.
35773 * @param int $day The number of the day.
35774 * @param int $year The number of the year, may be a two or four digit
35775 *   value, with values between 0-69 mapping to 2000-2069 and 70-100 to
35776 *   1970-2000. On systems where time_t is a 32bit signed integer, as
35777 *   most common today, the valid range for {@link year} is somewhere
35778 *   between 1901 and 2038. However, before PHP 5.1.0 this range was
35779 *   limited from 1970 to 2038 on some systems (e.g. Windows).
35780 * @param int $is_dst This parameter can be set to 1 if the time is
35781 *   during daylight savings time (DST), 0 if it is not, or -1 (the
35782 *   default) if it is unknown whether the time is within daylight
35783 *   savings time or not. If it's unknown, PHP tries to figure it out
35784 *   itself. This can cause unexpected (but not incorrect) results. Some
35785 *   times are invalid if DST is enabled on the system PHP is running on
35786 *   or {@link is_dst} is set to 1. If DST is enabled in e.g. 2:00, all
35787 *   times between 2:00 and 3:00 are invalid and {@link mktime} returns
35788 *   an undefined (usually negative) value. Some systems (e.g. Solaris 8)
35789 *   enable DST at midnight so time 0:30 of the day when DST is enabled
35790 *   is evaluated as 23:30 of the previous day.
35791 * @return int
35792 * @since PHP 4, PHP 5
35793 **/
35794function mktime($hour, $minute, $second, $month, $day, $year, $is_dst){}
35795
35796/**
35797 * {@link money_format} returns a formatted version of {@link number}.
35798 * This function wraps the C library function {@link strfmon}, with the
35799 * difference that this implementation converts only one number at a
35800 * time.
35801 *
35802 * @param string $format The format specification consists of the
35803 *   following sequence: a % character optional flags optional field
35804 *   width optional left precision optional right precision a required
35805 *   conversion character
35806 * @param float $number The character = followed by a (single byte)
35807 *   character f to be used as the numeric fill character. The default
35808 *   fill character is space.
35809 * @return string
35810 * @since PHP 4 >= 4.3.0, PHP 5
35811 **/
35812function money_format($format, $number){}
35813
35814/**
35815 * This function checks to ensure that the file designated by {@link
35816 * filename} is a valid upload file (meaning that it was uploaded via
35817 * PHP's HTTP POST upload mechanism). If the file is valid, it will be
35818 * moved to the filename given by {@link destination}.
35819 *
35820 * This sort of check is especially important if there is any chance that
35821 * anything done with uploaded files could reveal their contents to the
35822 * user, or even to other users on the same system.
35823 *
35824 * @param string $filename The filename of the uploaded file.
35825 * @param string $destination The destination of the moved file.
35826 * @return bool
35827 * @since PHP 4 >= 4.0.3, PHP 5
35828 **/
35829function move_uploaded_file($filename, $destination){}
35830
35831/**
35832 * The {@link mqseries_back} (MQBACK) call indicates to the queue manager
35833 * that all the message gets and puts that have occurred since the last
35834 * syncpoint are to be backed out. Messages put as part of a unit of work
35835 * are deleted; messages retrieved as part of a unit of work are
35836 * reinstated on the queue.
35837 *
35838 * Using {@link mqseries_back} only works in conjunction with {@link
35839 * mqseries_begin} and only function when connecting directly to a Queueu
35840 * manager. Not via the mqclient interface.
35841 *
35842 * @param resource $hconn Connection handle. This handle represents the
35843 *   connection to the queue manager.
35844 * @param resource $compCode Completion code.
35845 * @param resource $reason Reason code qualifying the compCode.
35846 * @return void
35847 * @since PECL mqseries >= 0.10.0
35848 **/
35849function mqseries_back($hconn, &$compCode, &$reason){}
35850
35851/**
35852 * The {@link mqseries_begin} (MQBEGIN) call begins a unit of work that
35853 * is coordinated by the queue manager, and that may involve external
35854 * resource managers.
35855 *
35856 * Using {@link mqseries_begin} starts the unit of work. Either {@link
35857 * mqseries_back} or {@link mqseries_cmit} ends the unit of work.
35858 *
35859 * @param resource $hconn Connection handle. This handle represents the
35860 *   connection to the queue manager.
35861 * @param array $beginOptions Completion code.
35862 * @param resource $compCode Reason code qualifying the compCode.
35863 * @param resource $reason
35864 * @return void
35865 * @since PECL mqseries >= 0.10.0
35866 **/
35867function mqseries_begin($hconn, $beginOptions, &$compCode, &$reason){}
35868
35869/**
35870 * The {@link mqseries_close} (MQCLOSE) call relinquishes access to an
35871 * object, and is the inverse of the {@link mqseries_open} (MQOPEN) call.
35872 *
35873 * @param resource $hconn Connection handle. This handle represents the
35874 *   connection to the queue manager.
35875 * @param resource $hobj Object handle. This handle represents the
35876 *   object to be used.
35877 * @param int $options
35878 * @param resource $compCode Completion code.
35879 * @param resource $reason Reason code qualifying the compCode.
35880 * @return void
35881 * @since PECL mqseries >= 0.10.0
35882 **/
35883function mqseries_close($hconn, $hobj, $options, &$compCode, &$reason){}
35884
35885/**
35886 * The {@link mqseries_cmit} (MQCMIT) call indicates to the queue manager
35887 * that the application has reached a syncpoint, and that all of the
35888 * message gets and puts that have occurred since the last syncpoint are
35889 * to be made permanent. Messages put as part of a unit of work are made
35890 * available to other applications; messages retrieved as part of a unit
35891 * of work are deleted.
35892 *
35893 * @param resource $hconn Connection handle. This handle represents the
35894 *   connection to the queue manager.
35895 * @param resource $compCode Completion code.
35896 * @param resource $reason Reason code qualifying the compCode.
35897 * @return void
35898 * @since PECL mqseries >= 0.10.0
35899 **/
35900function mqseries_cmit($hconn, &$compCode, &$reason){}
35901
35902/**
35903 * The {@link mqseries_conn} (MQCONN) call connects an application
35904 * program to a queue manager. It provides a queue manager connection
35905 * handle, which is used by the application on subsequent message queuing
35906 * calls.
35907 *
35908 * @param string $qManagerName Name of queue manager. Name of the queue
35909 *   manager the application wishes to connect.
35910 * @param resource $hconn Connection handle. This handle represents the
35911 *   connection to the queue manager.
35912 * @param resource $compCode Completion code.
35913 * @param resource $reason Reason code qualifying the compCode.
35914 * @return void
35915 * @since PECL mqseries >= 0.10.0
35916 **/
35917function mqseries_conn($qManagerName, &$hconn, &$compCode, &$reason){}
35918
35919/**
35920 * The {@link mqseries_connx} (MQCONNX) call connects an application
35921 * program to a queue manager. It provides a queue manager connection
35922 * handle, which is used by the application on subsequent MQ calls.
35923 *
35924 * @param string $qManagerName Name of queue manager. Name of the queue
35925 *   manager the application wishes to connect.
35926 * @param array $connOptions Options that control the action of
35927 *   function See also the MQCNO structure.
35928 * @param resource $hconn Connection handle. This handle represents the
35929 *   connection to the queue manager.
35930 * @param resource $compCode Completion code.
35931 * @param resource $reason Reason code qualifying the compCode.
35932 * @return void
35933 * @since PECL mqseries >= 0.10.0
35934 **/
35935function mqseries_connx($qManagerName, &$connOptions, &$hconn, &$compCode, &$reason){}
35936
35937/**
35938 * The {@link mqseries_disc} (MQDISC) call breaks the connection between
35939 * the queue manager and the application program, and is the inverse of
35940 * the {@link mqseries_conn} (MQCONN) or {@link mqseries_connx} (MQCONNX)
35941 * call.
35942 *
35943 * @param resource $hconn Connection handle. This handle represents the
35944 *   connection to the queue manager.
35945 * @param resource $compCode Completion code.
35946 * @param resource $reason Reason code qualifying the compCode.
35947 * @return void
35948 * @since PECL mqseries >= 0.10.0
35949 **/
35950function mqseries_disc($hconn, &$compCode, &$reason){}
35951
35952/**
35953 * The {@link mqseries_get} (MQGET) call retrieves a message from a local
35954 * queue that has been opened using the {@link mqseries_open} (MQOPEN)
35955 * call
35956 *
35957 * @param resource $hConn Connection handle. This handle represents the
35958 *   connection to the queue manager.
35959 * @param resource $hObj Object handle. This handle represents the
35960 *   object to be used.
35961 * @param array $md Message descriptor (MQMD).
35962 * @param array $gmo Get message options (MQGMO).
35963 * @param int $bufferLength Expected length of the result buffer
35964 * @param string $msg Buffer holding the message that was retrieved
35965 *   from the object.
35966 * @param int $data_length Actual buffer length
35967 * @param resource $compCode Completion code.
35968 * @param resource $reason Reason code qualifying the compCode.
35969 * @return void
35970 * @since PECL mqseries >= 0.10.0
35971 **/
35972function mqseries_get($hConn, $hObj, &$md, &$gmo, &$bufferLength, &$msg, &$data_length, &$compCode, &$reason){}
35973
35974/**
35975 * The {@link mqseries_inq} (MQINQ) call returns an array of integers and
35976 * a set of character strings containing the attributes of an object.
35977 *
35978 * @param resource $hconn Connection handle. This handle represents the
35979 *   connection to the queue manager.
35980 * @param resource $hobj Object handle. This handle represents the
35981 *   object to be used.
35982 * @param int $selectorCount Count of selectors.
35983 * @param array $selectors Array of attribute selectors.
35984 * @param int $intAttrCount Count of integer attributes.
35985 * @param resource $intAttr Array of integer attributes.
35986 * @param int $charAttrLength Length of character attributes buffer.
35987 * @param resource $charAttr Character attributes.
35988 * @param resource $compCode Completion code.
35989 * @param resource $reason Reason code qualifying the compCode.
35990 * @return void
35991 * @since PECL mqseries >= 0.10.0
35992 **/
35993function mqseries_inq($hconn, $hobj, $selectorCount, $selectors, $intAttrCount, &$intAttr, $charAttrLength, &$charAttr, &$compCode, &$reason){}
35994
35995/**
35996 * The {@link mqseries_open} (MQOPEN) call establishes access to an
35997 * object.
35998 *
35999 * @param resource $hconn Connection handle. This handle represents the
36000 *   connection to the queue manager.
36001 * @param array $objDesc Object descriptor. (MQOD)
36002 * @param int $option Options that control the action of the function.
36003 * @param resource $hobj Object handle. This handle represents the
36004 *   object to be used.
36005 * @param resource $compCode Completion code.
36006 * @param resource $reason Reason code qualifying the compCode.
36007 * @return void
36008 * @since PECL mqseries >= 0.10.0
36009 **/
36010function mqseries_open($hconn, &$objDesc, $option, &$hobj, &$compCode, &$reason){}
36011
36012/**
36013 * The {@link mqseries_put} (MQPUT) call puts a message on a queue or
36014 * distribution list. The queue or distribution list must already be
36015 * open.
36016 *
36017 * @param resource $hConn Connection handle. This handle represents the
36018 *   connection to the queue manager.
36019 * @param resource $hObj Object handle. This handle represents the
36020 *   object to be used.
36021 * @param array $md Message descriptor (MQMD).
36022 * @param array $pmo Put message options (MQPMO).
36023 * @param string $message The actual message to put onto the queue.
36024 * @param resource $compCode Completion code.
36025 * @param resource $reason Reason code qualifying the compCode.
36026 * @return void
36027 * @since PECL mqseries >= 0.10.0
36028 **/
36029function mqseries_put($hConn, $hObj, &$md, &$pmo, $message, &$compCode, &$reason){}
36030
36031/**
36032 * The {@link mqseries_put1} (MQPUT1) call puts one message on a queue.
36033 * The queue need not be open.
36034 *
36035 * @param resource $hconn Connection handle. This handle represents the
36036 *   connection to the queue manager.
36037 * @param resource $objDesc Object descriptor. (MQOD) This is a
36038 *   structure which identifies the queue to which the message is added.
36039 * @param resource $msgDesc Message descriptor (MQMD).
36040 * @param resource $pmo Put message options (MQPMO).
36041 * @param string $buffer Completion code.
36042 * @param resource $compCode Reason code qualifying the compCode.
36043 * @param resource $reason
36044 * @return void
36045 * @since PECL mqseries >= 0.10.0
36046 **/
36047function mqseries_put1($hconn, &$objDesc, &$msgDesc, &$pmo, $buffer, &$compCode, &$reason){}
36048
36049/**
36050 * The {@link mqseries_set} (MQSET) call is used to change the attributes
36051 * of an object represented by a handle. The object must be a queue.
36052 *
36053 * @param resource $hconn Connection handle. This handle represents the
36054 *   connection to the queue manager.
36055 * @param resource $hobj Completion code.
36056 * @param int $selectorcount Reason code qualifying the compCode.
36057 * @param array $selectors
36058 * @param int $intattrcount
36059 * @param array $intattrs
36060 * @param int $charattrlength
36061 * @param array $charattrs
36062 * @param resource $compCode
36063 * @param resource $reason
36064 * @return void
36065 * @since PECL mqseries >= 0.10.0
36066 **/
36067function mqseries_set($hconn, $hobj, $selectorcount, $selectors, $intattrcount, $intattrs, $charattrlength, $charattrs, &$compCode, &$reason){}
36068
36069/**
36070 * {@link mqseries_strerror} returns the message that correspond to the
36071 * reason result code.
36072 *
36073 * @param int $reason Reason code qualifying the compCode.
36074 * @return string
36075 * @since PECL mqseries >= 0.10.0
36076 **/
36077function mqseries_strerror($reason){}
36078
36079/**
36080 * @param string $host
36081 * @param string $port
36082 * @return bool
36083 * @since PHP 4 >= 4.2.0, PHP 5
36084 **/
36085function msession_connect($host, $port){}
36086
36087/**
36088 * @return int
36089 * @since PHP 4 >= 4.2.0, PHP 5
36090 **/
36091function msession_count(){}
36092
36093/**
36094 * @param string $session
36095 * @param string $classname
36096 * @param string $data
36097 * @return bool
36098 * @since PHP 4 >= 4.2.0, PHP 5
36099 **/
36100function msession_create($session, $classname, $data){}
36101
36102/**
36103 * @param string $name
36104 * @return bool
36105 * @since PHP 4 >= 4.2.0, PHP 5
36106 **/
36107function msession_destroy($name){}
36108
36109/**
36110 * @return void
36111 * @since PHP 4 >= 4.2.0, PHP 5
36112 **/
36113function msession_disconnect(){}
36114
36115/**
36116 * @param string $name
36117 * @param string $value
36118 * @return array
36119 * @since PHP 4 >= 4.2.0, PHP 5
36120 **/
36121function msession_find($name, $value){}
36122
36123/**
36124 * @param string $session
36125 * @param string $name
36126 * @param string $value
36127 * @return string
36128 * @since PHP 4 >= 4.2.0, PHP 5
36129 **/
36130function msession_get($session, $name, $value){}
36131
36132/**
36133 * @param string $session
36134 * @return array
36135 * @since PHP 4 >= 4.2.0, PHP 5
36136 **/
36137function msession_get_array($session){}
36138
36139/**
36140 * @param string $session
36141 * @return string
36142 * @since PHP 4 >= 4.2.0, PHP 5
36143 **/
36144function msession_get_data($session){}
36145
36146/**
36147 * @param string $session
36148 * @param string $name
36149 * @return string
36150 * @since PHP 4 >= 4.2.0, PHP 5
36151 **/
36152function msession_inc($session, $name){}
36153
36154/**
36155 * @return array
36156 * @since PHP 4 >= 4.2.0, PHP 5
36157 **/
36158function msession_list(){}
36159
36160/**
36161 * Used for searching sessions with common attributes.
36162 *
36163 * @param string $name The name being searched.
36164 * @return array
36165 * @since PHP 4 >= 4.2.0, PHP 5
36166 **/
36167function msession_listvar($name){}
36168
36169/**
36170 * @param string $name
36171 * @return int
36172 * @since PHP 4 >= 4.2.0, PHP 5
36173 **/
36174function msession_lock($name){}
36175
36176/**
36177 * @param string $session
36178 * @param string $val
36179 * @param string $param
36180 * @return string
36181 * @since PHP 4 >= 4.2.0, PHP 5
36182 **/
36183function msession_plugin($session, $val, $param){}
36184
36185/**
36186 * @param int $param
36187 * @return string
36188 * @since PHP 4 >= 4.2.0, PHP 5
36189 **/
36190function msession_randstr($param){}
36191
36192/**
36193 * @param string $session
36194 * @param string $name
36195 * @param string $value
36196 * @return bool
36197 * @since PHP 4 >= 4.2.0, PHP 5
36198 **/
36199function msession_set($session, $name, $value){}
36200
36201/**
36202 * @param string $session
36203 * @param array $tuples
36204 * @return void
36205 * @since PHP 4 >= 4.2.0, PHP 5
36206 **/
36207function msession_set_array($session, $tuples){}
36208
36209/**
36210 * @param string $session
36211 * @param string $value
36212 * @return bool
36213 * @since PHP 4 >= 4.2.0, PHP 5
36214 **/
36215function msession_set_data($session, $value){}
36216
36217/**
36218 * @param string $session
36219 * @param int $param
36220 * @return int
36221 * @since PHP 4 >= 4.2.0, PHP 5
36222 **/
36223function msession_timeout($session, $param){}
36224
36225/**
36226 * @param int $param
36227 * @param string $classname
36228 * @param string $data
36229 * @return string
36230 * @since PHP 4 >= 4.2.0, PHP 5
36231 **/
36232function msession_uniq($param, $classname, $data){}
36233
36234/**
36235 * @param string $session
36236 * @param int $key
36237 * @return int
36238 * @since PHP 4 >= 4.2.0, PHP 5
36239 **/
36240function msession_unlock($session, $key){}
36241
36242/**
36243 * Constructs a new Message Formatter
36244 *
36245 * @param string $locale The locale to use when formatting arguments
36246 * @param string $pattern The pattern string to stick arguments into.
36247 *   The pattern uses an 'apostrophe-friendly' syntax; it is run through
36248 *   umsg_autoQuoteApostrophe before being interpreted.
36249 * @return MessageFormatter
36250 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
36251 **/
36252function msgfmt_create($locale, $pattern){}
36253
36254/**
36255 * Format the message by substituting the data into the format string
36256 * according to the locale rules
36257 *
36258 * @param MessageFormatter $fmt The message formatter
36259 * @param array $args Arguments to insert into the format string
36260 * @return string
36261 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
36262 **/
36263function msgfmt_format($fmt, $args){}
36264
36265/**
36266 * Quick formatting function that formats the string without having to
36267 * explicitly create the formatter object. Use this function when the
36268 * format operation is done only once and does not need and parameters or
36269 * state to be kept.
36270 *
36271 * @param string $locale The locale to use for formatting
36272 *   locale-dependent parts
36273 * @param string $pattern The pattern string to insert things into. The
36274 *   pattern uses an 'apostrophe-friendly' syntax; it is run through
36275 *   umsg_autoQuoteApostrophe before being interpreted.
36276 * @param array $args The array of values to insert into the format
36277 *   string
36278 * @return string
36279 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
36280 **/
36281function msgfmt_format_message($locale, $pattern, $args){}
36282
36283/**
36284 * Get the error code from last operation.
36285 *
36286 * @param MessageFormatter $fmt The message formatter
36287 * @return int
36288 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
36289 **/
36290function msgfmt_get_error_code($fmt){}
36291
36292/**
36293 * Get the error text from the last operation.
36294 *
36295 * @param MessageFormatter $fmt The message formatter
36296 * @return string
36297 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
36298 **/
36299function msgfmt_get_error_message($fmt){}
36300
36301/**
36302 * Get the locale for which the formatter was created.
36303 *
36304 * @param NumberFormatter $formatter The formatter resource
36305 * @return string
36306 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
36307 **/
36308function msgfmt_get_locale($formatter){}
36309
36310/**
36311 * Get the pattern used by the formatter
36312 *
36313 * @param MessageFormatter $fmt The message formatter
36314 * @return string
36315 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
36316 **/
36317function msgfmt_get_pattern($fmt){}
36318
36319/**
36320 * Parses input string and return any extracted items as an array.
36321 *
36322 * @param MessageFormatter $fmt The message formatter
36323 * @param string $value The string to parse
36324 * @return array
36325 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
36326 **/
36327function msgfmt_parse($fmt, $value){}
36328
36329/**
36330 * Parses input string without explicitly creating the formatter object.
36331 * Use this function when the format operation is done only once and does
36332 * not need and parameters or state to be kept.
36333 *
36334 * @param string $locale The locale to use for parsing locale-dependent
36335 *   parts
36336 * @param string $value The string to parse for items
36337 * @return array
36338 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
36339 **/
36340function msgfmt_parse_message($locale, $value){}
36341
36342/**
36343 * Set the pattern used by the formatter
36344 *
36345 * @param MessageFormatter $fmt The message formatter
36346 * @param string $pattern The pattern string to use in this message
36347 *   formatter. The pattern uses an 'apostrophe-friendly' syntax; it is
36348 *   run through umsg_autoQuoteApostrophe before being interpreted.
36349 * @return bool
36350 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
36351 **/
36352function msgfmt_set_pattern($fmt, $pattern){}
36353
36354/**
36355 * {@link msg_get_queue} returns an id that can be used to access the
36356 * System V message queue with the given {@link key}. The first call
36357 * creates the message queue with the optional {@link perms}. A second
36358 * call to {@link msg_get_queue} for the same {@link key} will return a
36359 * different message queue identifier, but both identifiers access the
36360 * same underlying message queue.
36361 *
36362 * @param int $key Message queue numeric ID
36363 * @param int $perms Queue permissions. Default to 0666. If the message
36364 *   queue already exists, the {@link perms} will be ignored.
36365 * @return resource
36366 * @since PHP 4 >= 4.3.0, PHP 5
36367 **/
36368function msg_get_queue($key, $perms){}
36369
36370/**
36371 * Checks whether the message queue {@link key} exists.
36372 *
36373 * @param int $key Queue key.
36374 * @return bool
36375 * @since PHP 5 >= 5.3.0
36376 **/
36377function msg_queue_exists($key){}
36378
36379/**
36380 * {@link msg_receive} will receive the first message from the specified
36381 * {@link queue} of the type specified by {@link desiredmsgtype}.
36382 *
36383 * @param resource $queue
36384 * @param int $desiredmsgtype If {@link desiredmsgtype} is 0, the
36385 *   message from the front of the queue is returned. If {@link
36386 *   desiredmsgtype} is greater than 0, then the first message of that
36387 *   type is returned. If {@link desiredmsgtype} is less than 0, the
36388 *   first message on the queue with the lowest type less than or equal
36389 *   to the absolute value of {@link desiredmsgtype} will be read. If no
36390 *   messages match the criteria, your script will wait until a suitable
36391 *   message arrives on the queue. You can prevent the script from
36392 *   blocking by specifying MSG_IPC_NOWAIT in the {@link flags}
36393 *   parameter.
36394 * @param int $msgtype The type of the message that was received will
36395 *   be stored in this parameter.
36396 * @param int $maxsize The maximum size of message to be accepted is
36397 *   specified by the {@link maxsize}; if the message in the queue is
36398 *   larger than this size the function will fail (unless you set {@link
36399 *   flags} as described below).
36400 * @param mixed $message The received message will be stored in {@link
36401 *   message}, unless there were errors receiving the message.
36402 * @param bool $unserialize If set to , the message is treated as
36403 *   though it was serialized using the same mechanism as the session
36404 *   module. The message will be unserialized and then returned to your
36405 *   script. This allows you to easily receive arrays or complex object
36406 *   structures from other PHP scripts, or if you are using the WDDX
36407 *   serializer, from any WDDX compatible source. If {@link unserialize}
36408 *   is , the message will be returned as a binary-safe string.
36409 * @param int $flags The optional {@link flags} allows you to pass
36410 *   flags to the low-level msgrcv system call. It defaults to 0, but you
36411 *   may specify one or more of the following values (by adding or ORing
36412 *   them together). Flag values for msg_receive MSG_IPC_NOWAIT If there
36413 *   are no messages of the {@link desiredmsgtype}, return immediately
36414 *   and do not wait. The function will fail and return an integer value
36415 *   corresponding to MSG_ENOMSG. MSG_EXCEPT Using this flag in
36416 *   combination with a {@link desiredmsgtype} greater than 0 will cause
36417 *   the function to receive the first message that is not equal to
36418 *   {@link desiredmsgtype}. MSG_NOERROR If the message is longer than
36419 *   {@link maxsize}, setting this flag will truncate the message to
36420 *   {@link maxsize} and will not signal an error.
36421 * @param int $errorcode If the function fails, the optional {@link
36422 *   errorcode} will be set to the value of the system errno variable.
36423 * @return bool
36424 * @since PHP 4 >= 4.3.0, PHP 5
36425 **/
36426function msg_receive($queue, $desiredmsgtype, &$msgtype, $maxsize, &$message, $unserialize, $flags, &$errorcode){}
36427
36428/**
36429 * {@link msg_remove_queue} destroys the message queue specified by the
36430 * {@link queue}. Only use this function when all processes have finished
36431 * working with the message queue and you need to release the system
36432 * resources held by it.
36433 *
36434 * @param resource $queue Message queue resource handle
36435 * @return bool
36436 * @since PHP 4 >= 4.3.0, PHP 5
36437 **/
36438function msg_remove_queue($queue){}
36439
36440/**
36441 * {@link msg_send} sends a {@link message} of type {@link msgtype}
36442 * (which MUST be greater than 0) to the message queue specified by
36443 * {@link queue}.
36444 *
36445 * @param resource $queue
36446 * @param int $msgtype
36447 * @param mixed $message
36448 * @param bool $serialize The optional {@link serialize} controls how
36449 *   the {@link message} is sent. {@link serialize} defaults to which
36450 *   means that the {@link message} is serialized using the same
36451 *   mechanism as the session module before being sent to the queue. This
36452 *   allows complex arrays and objects to be sent to other PHP scripts,
36453 *   or if you are using the WDDX serializer, to any WDDX compatible
36454 *   client.
36455 * @param bool $blocking If the message is too large to fit in the
36456 *   queue, your script will wait until another process reads messages
36457 *   from the queue and frees enough space for your message to be sent.
36458 *   This is called blocking; you can prevent blocking by setting the
36459 *   optional {@link blocking} parameter to , in which case {@link
36460 *   msg_send} will immediately return if the message is too big for the
36461 *   queue, and set the optional {@link errorcode} to MSG_EAGAIN,
36462 *   indicating that you should try to send your message again a little
36463 *   later on.
36464 * @param int $errorcode
36465 * @return bool
36466 * @since PHP 4 >= 4.3.0, PHP 5
36467 **/
36468function msg_send($queue, $msgtype, $message, $serialize, $blocking, &$errorcode){}
36469
36470/**
36471 * {@link msg_set_queue} allows you to change the values of the
36472 * msg_perm.uid, msg_perm.gid, msg_perm.mode and msg_qbytes fields of the
36473 * underlying message queue data structure.
36474 *
36475 * Changing the data structure will require that PHP be running as the
36476 * same user that created the queue, owns the queue (as determined by the
36477 * existing msg_perm.xxx fields), or be running with root privileges.
36478 * root privileges are required to raise the msg_qbytes values above the
36479 * system defined limit.
36480 *
36481 * @param resource $queue Message queue resource handle
36482 * @param array $data You specify the values you require by setting the
36483 *   value of the keys that you require in the {@link data} array.
36484 * @return bool
36485 * @since PHP 4 >= 4.3.0, PHP 5
36486 **/
36487function msg_set_queue($queue, $data){}
36488
36489/**
36490 * {@link msg_stat_queue} returns the message queue meta data for the
36491 * message queue specified by the {@link queue}. This is useful, for
36492 * example, to determine which process sent the message that was just
36493 * received.
36494 *
36495 * @param resource $queue Message queue resource handle
36496 * @return array
36497 * @since PHP 4 >= 4.3.0, PHP 5
36498 **/
36499function msg_stat_queue($queue){}
36500
36501/**
36502 * {@link msql} selects a database and executes a query on it.
36503 *
36504 * @param string $database The name of the mSQL database.
36505 * @param string $query The SQL query.
36506 * @param resource $link_identifier
36507 * @return resource
36508 * @since PHP 4, PHP 5
36509 **/
36510function msql($database, $query, $link_identifier){}
36511
36512/**
36513 * Returns number of affected rows by the last SELECT, UPDATE or DELETE
36514 * query associated with {@link result}.
36515 *
36516 * @param resource $result
36517 * @return int
36518 * @since PHP 4, PHP 5
36519 **/
36520function msql_affected_rows($result){}
36521
36522/**
36523 * {@link msql_close} closes the non-persistent connection to the mSQL
36524 * server that's associated with the specified link identifier.
36525 *
36526 * Using {@link msql_close} isn't usually necessary, as non-persistent
36527 * open links are automatically closed at the end of the script's
36528 * execution. See also freeing resources.
36529 *
36530 * @param resource $link_identifier
36531 * @return bool
36532 * @since PHP 4, PHP 5
36533 **/
36534function msql_close($link_identifier){}
36535
36536/**
36537 * {@link msql_connect} establishes a connection to a mSQL server.
36538 *
36539 * In case a second call is made to {@link msql_connect} with the same
36540 * arguments, no new link will be established, but instead, the link
36541 * identifier of the already opened link will be returned.
36542 *
36543 * The link to the server will be closed as soon as the execution of the
36544 * script ends, unless it's closed earlier by explicitly calling {@link
36545 * msql_close}.
36546 *
36547 * @param string $hostname The hostname can also include a port number.
36548 *   e.g. hostname,port. If not specified, the connection is established
36549 *   by the means of a Unix domain socket, being then more efficient then
36550 *   a localhost TCP socket connection.
36551 * @return resource
36552 * @since PHP 4, PHP 5
36553 **/
36554function msql_connect($hostname){}
36555
36556/**
36557 * {@link msql_createdb} attempts to create a new database on the mSQL
36558 * server.
36559 *
36560 * @param string $database_name The name of the mSQL database.
36561 * @param resource $link_identifier
36562 * @return bool
36563 * @since PHP 4, PHP 5
36564 **/
36565function msql_createdb($database_name, $link_identifier){}
36566
36567/**
36568 * {@link msql_create_db} attempts to create a new database on the mSQL
36569 * server.
36570 *
36571 * @param string $database_name The name of the mSQL database.
36572 * @param resource $link_identifier
36573 * @return bool
36574 * @since PHP 4, PHP 5
36575 **/
36576function msql_create_db($database_name, $link_identifier){}
36577
36578/**
36579 * {@link msql_data_seek} moves the internal row pointer of the mSQL
36580 * result associated with the specified query identifier to point to the
36581 * specified row number. The next call to {@link msql_fetch_row} would
36582 * return that row.
36583 *
36584 * @param resource $result The seeked row number.
36585 * @param int $row_number
36586 * @return bool
36587 * @since PHP 4, PHP 5
36588 **/
36589function msql_data_seek($result, $row_number){}
36590
36591/**
36592 * {@link msql_dbname} returns the contents of one cell from a mSQL
36593 * result set.
36594 *
36595 * When working on large result sets, you should consider using one of
36596 * the functions that fetch an entire row (specified below). As these
36597 * functions return the contents of multiple cells in one function call,
36598 * they are often much quicker than {@link msql_dbname}.
36599 *
36600 * Recommended high-performance alternatives: {@link msql_fetch_row},
36601 * {@link msql_fetch_array}, and {@link msql_fetch_object}.
36602 *
36603 * @param resource $result The row offset.
36604 * @param int $row Can be the field's offset, or the field's name, or
36605 *   the field's table dot field's name (tablename.fieldname.). If the
36606 *   column name has been aliased ('select foo as bar from ...'), use the
36607 *   alias instead of the column name.
36608 * @param mixed $field
36609 * @return string
36610 * @since PHP 4, PHP 5
36611 **/
36612function msql_dbname($result, $row, $field){}
36613
36614/**
36615 * {@link msql_db_query} selects a database and executes a query on it.
36616 *
36617 * @param string $database The name of the mSQL database.
36618 * @param string $query The SQL query.
36619 * @param resource $link_identifier
36620 * @return resource
36621 * @since PHP 4, PHP 5
36622 **/
36623function msql_db_query($database, $query, $link_identifier){}
36624
36625/**
36626 * {@link msql_drop_db} attempts to drop (remove) a database from the
36627 * mSQL server.
36628 *
36629 * @param string $database_name The name of the database.
36630 * @param resource $link_identifier
36631 * @return bool
36632 * @since PHP 4, PHP 5
36633 **/
36634function msql_drop_db($database_name, $link_identifier){}
36635
36636/**
36637 * {@link msql_error} returns the last issued error by the mSQL server.
36638 * Note that only the last error message is accessible with {@link
36639 * msql_error}.
36640 *
36641 * @return string
36642 * @since PHP 4, PHP 5
36643 **/
36644function msql_error(){}
36645
36646/**
36647 * {@link msql_fetch_array} is an extended version of {@link
36648 * msql_fetch_row}. In addition to storing the data in the numeric
36649 * indices of the result array, it also stores the data in associative
36650 * indices, using the field names as keys.
36651 *
36652 * An important thing to note is that using {@link msql_fetch_array} is
36653 * NOT significantly slower than using {@link msql_fetch_row}, while it
36654 * provides a significant added value.
36655 *
36656 * @param resource $result A constant that can take the following
36657 *   values: MSQL_ASSOC, MSQL_NUM, and MSQL_BOTH with MSQL_BOTH being the
36658 *   default.
36659 * @param int $result_type
36660 * @return array
36661 * @since PHP 4, PHP 5
36662 **/
36663function msql_fetch_array($result, $result_type){}
36664
36665/**
36666 * {@link msql_fetch_field} can be used in order to obtain information
36667 * about fields in a certain query result.
36668 *
36669 * @param resource $result The field offset. If not specified, the next
36670 *   field that wasn't yet retrieved by {@link msql_fetch_field} is
36671 *   retrieved.
36672 * @param int $field_offset
36673 * @return object
36674 * @since PHP 4, PHP 5
36675 **/
36676function msql_fetch_field($result, $field_offset){}
36677
36678/**
36679 * {@link msql_fetch_object} is similar to {@link msql_fetch_array}, with
36680 * one difference - an object is returned, instead of an array.
36681 * Indirectly, that means that you can only access the data by the field
36682 * names, and not by their offsets (numbers are illegal property names).
36683 *
36684 * Speed-wise, the function is identical to {@link msql_fetch_array}, and
36685 * almost as quick as {@link msql_fetch_row} (the difference is
36686 * insignificant).
36687 *
36688 * @param resource $result
36689 * @return object
36690 * @since PHP 4, PHP 5
36691 **/
36692function msql_fetch_object($result){}
36693
36694/**
36695 * {@link msql_fetch_row} fetches one row of data from the result
36696 * associated with the specified query identifier. The row is returned as
36697 * an array. Each result column is stored in an array offset, starting at
36698 * offset 0.
36699 *
36700 * Subsequent call to {@link msql_fetch_row} would return the next row in
36701 * the result set, or if there are no more rows.
36702 *
36703 * @param resource $result
36704 * @return array
36705 * @since PHP 4, PHP 5
36706 **/
36707function msql_fetch_row($result){}
36708
36709/**
36710 * {@link msql_fieldflags} returns the field flags of the specified
36711 * field.
36712 *
36713 * @param resource $result
36714 * @param int $field_offset
36715 * @return string
36716 * @since PHP 4, PHP 5
36717 **/
36718function msql_fieldflags($result, $field_offset){}
36719
36720/**
36721 * {@link msql_fieldlen} returns the length of the specified field.
36722 *
36723 * @param resource $result
36724 * @param int $field_offset
36725 * @return int
36726 * @since PHP 4, PHP 5
36727 **/
36728function msql_fieldlen($result, $field_offset){}
36729
36730/**
36731 * {@link msql_fieldname} gets the name of the specified field index.
36732 *
36733 * @param resource $result
36734 * @param int $field_offset
36735 * @return string
36736 * @since PHP 4, PHP 5
36737 **/
36738function msql_fieldname($result, $field_offset){}
36739
36740/**
36741 * Returns the name of the table that the specified field is in.
36742 *
36743 * @param resource $result
36744 * @param int $field_offset
36745 * @return int
36746 * @since PHP 4, PHP 5
36747 **/
36748function msql_fieldtable($result, $field_offset){}
36749
36750/**
36751 * {@link msql_fieldtype} gets the type of the specified field index.
36752 *
36753 * @param resource $result
36754 * @param int $field_offset
36755 * @return string
36756 * @since PHP 4, PHP 5
36757 **/
36758function msql_fieldtype($result, $field_offset){}
36759
36760/**
36761 * {@link msql_field_flags} returns the field flags of the specified
36762 * field.
36763 *
36764 * @param resource $result
36765 * @param int $field_offset
36766 * @return string
36767 * @since PHP 4, PHP 5
36768 **/
36769function msql_field_flags($result, $field_offset){}
36770
36771/**
36772 * {@link msql_field_len} returns the length of the specified field.
36773 *
36774 * @param resource $result
36775 * @param int $field_offset
36776 * @return int
36777 * @since PHP 4, PHP 5
36778 **/
36779function msql_field_len($result, $field_offset){}
36780
36781/**
36782 * {@link msql_field_name} gets the name of the specified field index.
36783 *
36784 * @param resource $result
36785 * @param int $field_offset
36786 * @return string
36787 * @since PHP 4, PHP 5
36788 **/
36789function msql_field_name($result, $field_offset){}
36790
36791/**
36792 * Seeks to the specified field offset. If the next call to {@link
36793 * msql_fetch_field} won't include a field offset, this field would be
36794 * returned.
36795 *
36796 * @param resource $result
36797 * @param int $field_offset
36798 * @return bool
36799 * @since PHP 4, PHP 5
36800 **/
36801function msql_field_seek($result, $field_offset){}
36802
36803/**
36804 * Returns the name of the table that the specified field is in.
36805 *
36806 * @param resource $result
36807 * @param int $field_offset
36808 * @return int
36809 * @since PHP 4, PHP 5
36810 **/
36811function msql_field_table($result, $field_offset){}
36812
36813/**
36814 * {@link msql_field_type} gets the type of the specified field index.
36815 *
36816 * @param resource $result
36817 * @param int $field_offset
36818 * @return string
36819 * @since PHP 4, PHP 5
36820 **/
36821function msql_field_type($result, $field_offset){}
36822
36823/**
36824 * {@link msql_free_result} frees the memory associated with {@link
36825 * query_identifier}. When PHP completes a request, this memory is freed
36826 * automatically, so you only need to call this function when you want to
36827 * make sure you don't use too much memory while the script is running.
36828 *
36829 * @param resource $result
36830 * @return bool
36831 * @since PHP 4, PHP 5
36832 **/
36833function msql_free_result($result){}
36834
36835/**
36836 * {@link msql_list_tables} lists the databases available on the
36837 * specified {@link link_identifier}.
36838 *
36839 * @param resource $link_identifier
36840 * @return resource
36841 * @since PHP 4, PHP 5
36842 **/
36843function msql_list_dbs($link_identifier){}
36844
36845/**
36846 * {@link msql_list_fields} returns information about the given table.
36847 *
36848 * @param string $database The name of the database.
36849 * @param string $tablename The name of the table.
36850 * @param resource $link_identifier
36851 * @return resource
36852 * @since PHP 4, PHP 5
36853 **/
36854function msql_list_fields($database, $tablename, $link_identifier){}
36855
36856/**
36857 * {@link msql_list_tables} lists the tables on the specified {@link
36858 * database}.
36859 *
36860 * @param string $database The name of the database.
36861 * @param resource $link_identifier
36862 * @return resource
36863 * @since PHP 4, PHP 5
36864 **/
36865function msql_list_tables($database, $link_identifier){}
36866
36867/**
36868 * {@link msql_numfields} returns the number of fields in a result set.
36869 *
36870 * @param resource $result
36871 * @return int
36872 * @since PHP 4, PHP 5
36873 **/
36874function msql_numfields($result){}
36875
36876/**
36877 * {@link msql_numrows} returns the number of rows in a result set.
36878 *
36879 * @param resource $query_identifier
36880 * @return int
36881 * @since PHP 4, PHP 5
36882 **/
36883function msql_numrows($query_identifier){}
36884
36885/**
36886 * {@link msql_num_fields} returns the number of fields in a result set.
36887 *
36888 * @param resource $result
36889 * @return int
36890 * @since PHP 4, PHP 5
36891 **/
36892function msql_num_fields($result){}
36893
36894/**
36895 * {@link msql_num_rows} returns the number of rows in a result set.
36896 *
36897 * @param resource $query_identifier
36898 * @return int
36899 * @since PHP 4, PHP 5
36900 **/
36901function msql_num_rows($query_identifier){}
36902
36903/**
36904 * {@link msql_pconnect} acts very much like {@link msql_connect} with
36905 * two major differences.
36906 *
36907 * First, when connecting, the function would first try to find a
36908 * (persistent) link that's already open with the same host. If one is
36909 * found, an identifier for it will be returned instead of opening a new
36910 * connection.
36911 *
36912 * Second, the connection to the SQL server will not be closed when the
36913 * execution of the script ends. Instead, the link will remain open for
36914 * future use ({@link msql_close} will not close links established by
36915 * this function).
36916 *
36917 * @param string $hostname The hostname can also include a port number.
36918 *   e.g. hostname,port. If not specified, the connection is established
36919 *   by the means of a Unix domain socket, being more efficient than a
36920 *   localhost TCP socket connection.
36921 * @return resource
36922 * @since PHP 4, PHP 5
36923 **/
36924function msql_pconnect($hostname){}
36925
36926/**
36927 * {@link msql_query} sends a query to the currently active database on
36928 * the server that's associated with the specified link identifier.
36929 *
36930 * @param string $query The SQL query.
36931 * @param resource $link_identifier
36932 * @return resource
36933 * @since PHP 4, PHP 5
36934 **/
36935function msql_query($query, $link_identifier){}
36936
36937/**
36938 * {@link msql_result} returns the contents of one cell from a mSQL
36939 * result set.
36940 *
36941 * When working on large result sets, you should consider using one of
36942 * the functions that fetch an entire row (specified below). As these
36943 * functions return the contents of multiple cells in one function call,
36944 * they are often much quicker than {@link msql_result}.
36945 *
36946 * Recommended high-performance alternatives: {@link msql_fetch_row},
36947 * {@link msql_fetch_array}, and {@link msql_fetch_object}.
36948 *
36949 * @param resource $result The row offset.
36950 * @param int $row Can be the field's offset, or the field's name, or
36951 *   the field's table dot field's name (tablename.fieldname.). If the
36952 *   column name has been aliased ('select foo as bar from ...'), use the
36953 *   alias instead of the column name.
36954 * @param mixed $field
36955 * @return string
36956 * @since PHP 4, PHP 5
36957 **/
36958function msql_result($result, $row, $field){}
36959
36960/**
36961 * {@link msql_select_db} sets the current active database on the server
36962 * that's associated with the specified {@link link_identifier}.
36963 *
36964 * Subsequent calls to {@link msql_query} will be made on the active
36965 * database.
36966 *
36967 * @param string $database_name The database name.
36968 * @param resource $link_identifier
36969 * @return bool
36970 * @since PHP 4, PHP 5
36971 **/
36972function msql_select_db($database_name, $link_identifier){}
36973
36974/**
36975 * {@link msql_tablename} returns the contents of one cell from a mSQL
36976 * result set.
36977 *
36978 * When working on large result sets, you should consider using one of
36979 * the functions that fetch an entire row (specified below). As these
36980 * functions return the contents of multiple cells in one function call,
36981 * they are often much quicker than {@link msql_tablename}.
36982 *
36983 * Recommended high-performance alternatives: {@link msql_fetch_row},
36984 * {@link msql_fetch_array}, and {@link msql_fetch_object}.
36985 *
36986 * @param resource $result The row offset.
36987 * @param int $row Can be the field's offset, or the field's name, or
36988 *   the field's table dot field's name (tablename.fieldname.). If the
36989 *   column name has been aliased ('select foo as bar from ...'), use the
36990 *   alias instead of the column name.
36991 * @param mixed $field
36992 * @return string
36993 * @since PHP 4, PHP 5
36994 **/
36995function msql_tablename($result, $row, $field){}
36996
36997/**
36998 * Binds a parameter to a stored procedure or a remote stored procedure.
36999 *
37000 * @param resource $stmt Statement resource, obtained with {@link
37001 *   mssql_init}.
37002 * @param string $param_name The parameter name, as a string.
37003 * @param mixed $var The PHP variable you'll bind the MSSQL parameter
37004 *   to. It is passed by reference, to retrieve OUTPUT and RETVAL values
37005 *   after the procedure execution.
37006 * @param int $type One of: SQLTEXT, SQLVARCHAR, SQLCHAR, SQLINT1,
37007 *   SQLINT2, SQLINT4, SQLBIT, SQLFLT4, SQLFLT8, SQLFLTN.
37008 * @param bool $is_output Whether the value is an OUTPUT parameter or
37009 *   not. If it's an OUTPUT parameter and you don't mention it, it will
37010 *   be treated as a normal input parameter and no error will be thrown.
37011 * @param bool $is_null Whether the parameter is or not. Passing the
37012 *   value as {@link var} will not do the job.
37013 * @param int $maxlen Used with char/varchar values. You have to
37014 *   indicate the length of the data so if the parameter is a
37015 *   varchar(50), the type must be SQLVARCHAR and this value 50.
37016 * @return bool
37017 * @since PHP 4 >= 4.0.7, PHP 5, PECL odbtp >= 1.1.1
37018 **/
37019function mssql_bind($stmt, $param_name, &$var, $type, $is_output, $is_null, $maxlen){}
37020
37021/**
37022 * Closes the link to a MS SQL Server database that's associated with the
37023 * specified link identifier. If the link identifier isn't specified, the
37024 * last opened link is assumed.
37025 *
37026 * Note that this isn't usually necessary, as non-persistent open links
37027 * are automatically closed at the end of the script's execution.
37028 *
37029 * @param resource $link_identifier A MS SQL link identifier, returned
37030 *   by {@link mssql_connect}. This function will not close persistent
37031 *   links generated by {@link mssql_pconnect}.
37032 * @return bool
37033 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37034 **/
37035function mssql_close($link_identifier){}
37036
37037/**
37038 * {@link mssql_connect} establishes a connection to a MS SQL server.
37039 *
37040 * The link to the server will be closed as soon as the execution of the
37041 * script ends, unless it's closed earlier by explicitly calling {@link
37042 * mssql_close}.
37043 *
37044 * @param string $servername The MS SQL server. It can also include a
37045 *   port number. e.g. hostname,port.
37046 * @param string $username The username.
37047 * @param string $password The password.
37048 * @param bool $new_link If a second call is made to {@link
37049 *   mssql_connect} with the same arguments, no new link will be
37050 *   established, but instead, the link identifier of the already opened
37051 *   link will be returned. This parameter modifies this behavior and
37052 *   makes {@link mssql_connect} always open a new link, even if {@link
37053 *   mssql_connect} was called before with the same parameters.
37054 * @return resource
37055 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37056 **/
37057function mssql_connect($servername, $username, $password, $new_link){}
37058
37059/**
37060 * {@link mssql_data_seek} moves the internal row pointer of the MS SQL
37061 * result associated with the specified result identifier to point to the
37062 * specified row number, first row being number 0. The next call to
37063 * {@link mssql_fetch_row} would return that row.
37064 *
37065 * @param resource $result_identifier The result resource that is being
37066 *   evaluated.
37067 * @param int $row_number The desired row number of the new result
37068 *   pointer.
37069 * @return bool
37070 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37071 **/
37072function mssql_data_seek($result_identifier, $row_number){}
37073
37074/**
37075 * Executes a stored procedure on a MS SQL server database
37076 *
37077 * @param resource $stmt Statement handle obtained with {@link
37078 *   mssql_init}.
37079 * @param bool $skip_results Whenever to skip the results or not.
37080 * @return mixed
37081 * @since PHP 4 >= 4.0.7, PHP 5, PECL odbtp >= 1.1.1
37082 **/
37083function mssql_execute($stmt, $skip_results){}
37084
37085/**
37086 * {@link mssql_fetch_array} is an extended version of {@link
37087 * mssql_fetch_row}. In addition to storing the data in the numeric
37088 * indices of the result array, it also stores the data in associative
37089 * indices, using the field names as keys.
37090 *
37091 * An important thing to note is that using {@link mssql_fetch_array} is
37092 * NOT significantly slower than using {@link mssql_fetch_row}, while it
37093 * provides a significant added value.
37094 *
37095 * @param resource $result The result resource that is being evaluated.
37096 *   This result comes from a call to {@link mssql_query}.
37097 * @param int $result_type The type of array that is to be fetched.
37098 *   It's a constant and can take the following values: MSSQL_ASSOC,
37099 *   MSSQL_NUM, and MSSQL_BOTH.
37100 * @return array
37101 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37102 **/
37103function mssql_fetch_array($result, $result_type){}
37104
37105/**
37106 * Returns an associative array that corresponds to the fetched row and
37107 * moves the internal data pointer ahead. {@link mssql_fetch_assoc} is
37108 * equivalent to calling {@link mssql_fetch_array} with MSSQL_ASSOC for
37109 * the optional second parameter.
37110 *
37111 * @param resource $result_id The result resource that is being
37112 *   evaluated. This result comes from a call to {@link mssql_query}.
37113 * @return array
37114 * @since PHP 4 >= 4.2.0, PHP 5, PECL odbtp >= 1.1.1
37115 **/
37116function mssql_fetch_assoc($result_id){}
37117
37118/**
37119 * Returns the next batch of records
37120 *
37121 * @param resource $result The result resource that is being evaluated.
37122 *   This result comes from a call to {@link mssql_query}.
37123 * @return int
37124 * @since PHP 4 >= 4.0.4, PHP 5, PECL odbtp >= 1.1.1
37125 **/
37126function mssql_fetch_batch($result){}
37127
37128/**
37129 * {@link mssql_fetch_field} can be used in order to obtain information
37130 * about fields in a certain query result.
37131 *
37132 * @param resource $result The result resource that is being evaluated.
37133 *   This result comes from a call to {@link mssql_query}.
37134 * @param int $field_offset The numerical field offset. If the field
37135 *   offset is not specified, the next field that was not yet retrieved
37136 *   by this function is retrieved. The {@link field_offset} starts at 0.
37137 * @return object
37138 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37139 **/
37140function mssql_fetch_field($result, $field_offset){}
37141
37142/**
37143 * {@link mssql_fetch_object} is similar to {@link mssql_fetch_array},
37144 * with one difference - an object is returned, instead of an array.
37145 * Indirectly, that means that you can only access the data by the field
37146 * names, and not by their offsets (numbers are illegal property names).
37147 *
37148 * Speed-wise, the function is identical to {@link mssql_fetch_array},
37149 * and almost as quick as {@link mssql_fetch_row} (the difference is
37150 * insignificant).
37151 *
37152 * @param resource $result The result resource that is being evaluated.
37153 *   This result comes from a call to {@link mssql_query}.
37154 * @return object
37155 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37156 **/
37157function mssql_fetch_object($result){}
37158
37159/**
37160 * {@link mssql_fetch_row} fetches one row of data from the result
37161 * associated with the specified result identifier. The row is returned
37162 * as an array. Each result column is stored in an array offset, starting
37163 * at offset 0.
37164 *
37165 * Subsequent call to {@link mssql_fetch_row} would return the next row
37166 * in the result set, or if there are no more rows.
37167 *
37168 * @param resource $result The result resource that is being evaluated.
37169 *   This result comes from a call to {@link mssql_query}.
37170 * @return array
37171 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37172 **/
37173function mssql_fetch_row($result){}
37174
37175/**
37176 * Returns the length of field no. {@link offset} in {@link result}.
37177 *
37178 * @param resource $result The result resource that is being evaluated.
37179 *   This result comes from a call to {@link mssql_query}.
37180 * @param int $offset The field offset, starts at 0. If omitted, the
37181 *   current field is used.
37182 * @return int
37183 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37184 **/
37185function mssql_field_length($result, $offset){}
37186
37187/**
37188 * Returns the name of field no. {@link offset} in {@link result}.
37189 *
37190 * @param resource $result The result resource that is being evaluated.
37191 *   This result comes from a call to {@link mssql_query}.
37192 * @param int $offset The field offset, starts at 0. If omitted, the
37193 *   current field is used.
37194 * @return string
37195 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37196 **/
37197function mssql_field_name($result, $offset){}
37198
37199/**
37200 * Seeks to the specified field offset. If the next call to {@link
37201 * mssql_fetch_field} won't include a field offset, this field would be
37202 * returned.
37203 *
37204 * @param resource $result The result resource that is being evaluated.
37205 *   This result comes from a call to {@link mssql_query}.
37206 * @param int $field_offset The field offset, starts at 0.
37207 * @return bool
37208 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37209 **/
37210function mssql_field_seek($result, $field_offset){}
37211
37212/**
37213 * Returns the type of field no. {@link offset} in {@link result}.
37214 *
37215 * @param resource $result The result resource that is being evaluated.
37216 *   This result comes from a call to {@link mssql_query}.
37217 * @param int $offset The field offset, starts at 0. If omitted, the
37218 *   current field is used.
37219 * @return string
37220 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37221 **/
37222function mssql_field_type($result, $offset){}
37223
37224/**
37225 * {@link mssql_free_result} only needs to be called if you are worried
37226 * about using too much memory while your script is running. All result
37227 * memory will automatically be freed when the script ends. You may call
37228 * {@link mssql_free_result} with the result identifier as an argument
37229 * and the associated result memory will be freed.
37230 *
37231 * @param resource $result The result resource that is being freed.
37232 *   This result comes from a call to {@link mssql_query}.
37233 * @return bool
37234 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37235 **/
37236function mssql_free_result($result){}
37237
37238/**
37239 * {@link mssql_free_statement} only needs to be called if you are
37240 * worried about using too much memory while your script is running. All
37241 * statement memory will automatically be freed when the script ends. You
37242 * may call {@link mssql_free_statement} with the statement identifier as
37243 * an argument and the associated statement memory will be freed.
37244 *
37245 * @param resource $stmt Statement resource, obtained with {@link
37246 *   mssql_init}.
37247 * @return bool
37248 * @since PHP 4 >= 4.3.2, PHP 5, PECL odbtp >= 1.1.1
37249 **/
37250function mssql_free_statement($stmt){}
37251
37252/**
37253 * Gets the last message from the MS-SQL server
37254 *
37255 * @return string
37256 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37257 **/
37258function mssql_get_last_message(){}
37259
37260/**
37261 * Converts a 16 byte binary GUID to a string.
37262 *
37263 * @param string $binary A 16 byte binary GUID.
37264 * @param bool $short_format Whenever to use short format.
37265 * @return string
37266 * @since PHP 4 >= 4.0.7, PHP 5, PECL odbtp >= 1.1.1
37267 **/
37268function mssql_guid_string($binary, $short_format){}
37269
37270/**
37271 * Initializes a stored procedure or a remote stored procedure.
37272 *
37273 * @param string $sp_name Stored procedure name, like ownew.sp_name or
37274 *   otherdb.owner.sp_name.
37275 * @param resource $link_identifier A MS SQL link identifier, returned
37276 *   by {@link mssql_connect}.
37277 * @return resource
37278 * @since PHP 4 >= 4.0.7, PHP 5, PECL odbtp >= 1.1.1
37279 **/
37280function mssql_init($sp_name, $link_identifier){}
37281
37282/**
37283 * Sets the minimum error severity.
37284 *
37285 * @param int $severity The new error severity.
37286 * @return void
37287 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37288 **/
37289function mssql_min_error_severity($severity){}
37290
37291/**
37292 * Sets the minimum message severity.
37293 *
37294 * @param int $severity The new message severity.
37295 * @return void
37296 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37297 **/
37298function mssql_min_message_severity($severity){}
37299
37300/**
37301 * When sending more than one SQL statement to the server or executing a
37302 * stored procedure with multiple results, it will cause the server to
37303 * return multiple result sets. This function will test for additional
37304 * results available form the server. If an additional result set exists
37305 * it will free the existing result set and prepare to fetch the rows
37306 * from the new result set.
37307 *
37308 * @param resource $result_id The result resource that is being
37309 *   evaluated. This result comes from a call to {@link mssql_query}.
37310 * @return bool
37311 * @since PHP 4 >= 4.0.5, PHP 5, PECL odbtp >= 1.1.1
37312 **/
37313function mssql_next_result($result_id){}
37314
37315/**
37316 * {@link mssql_num_fields} returns the number of fields in a result set.
37317 *
37318 * @param resource $result The result resource that is being evaluated.
37319 *   This result comes from a call to {@link mssql_query}.
37320 * @return int
37321 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37322 **/
37323function mssql_num_fields($result){}
37324
37325/**
37326 * {@link mssql_num_rows} returns the number of rows in a result set.
37327 *
37328 * @param resource $result The result resource that is being evaluated.
37329 *   This result comes from a call to {@link mssql_query}.
37330 * @return int
37331 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37332 **/
37333function mssql_num_rows($result){}
37334
37335/**
37336 * {@link mssql_pconnect} acts very much like {@link mssql_connect} with
37337 * two major differences.
37338 *
37339 * First, when connecting, the function would first try to find a
37340 * (persistent) link that's already open with the same host, username and
37341 * password. If one is found, an identifier for it will be returned
37342 * instead of opening a new connection.
37343 *
37344 * Second, the connection to the SQL server will not be closed when the
37345 * execution of the script ends. Instead, the link will remain open for
37346 * future use ({@link mssql_close} will not close links established by
37347 * {@link mssql_pconnect}).
37348 *
37349 * This type of links is therefore called 'persistent'.
37350 *
37351 * @param string $servername The MS SQL server. It can also include a
37352 *   port number. e.g. hostname:port.
37353 * @param string $username The username.
37354 * @param string $password The password.
37355 * @param bool $new_link If a second call is made to {@link
37356 *   mssql_pconnect} with the same arguments, no new link will be
37357 *   established, but instead, the link identifier of the already opened
37358 *   link will be returned. This parameter modifies this behavior and
37359 *   makes {@link mssql_pconnect} always open a new link, even if {@link
37360 *   mssql_pconnect} was called before with the same parameters.
37361 * @return resource
37362 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37363 **/
37364function mssql_pconnect($servername, $username, $password, $new_link){}
37365
37366/**
37367 * {@link mssql_query} sends a query to the currently active database on
37368 * the server that's associated with the specified link identifier.
37369 *
37370 * @param string $query An SQL query.
37371 * @param resource $link_identifier A MS SQL link identifier, returned
37372 *   by {@link mssql_connect} or {@link mssql_pconnect}. If the link
37373 *   identifier isn't specified, the last opened link is assumed. If no
37374 *   link is open, the function tries to establish a link as if {@link
37375 *   mssql_connect} was called, and use it.
37376 * @param int $batch_size The number of records to batch in the buffer.
37377 * @return mixed
37378 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37379 **/
37380function mssql_query($query, $link_identifier, $batch_size){}
37381
37382/**
37383 * {@link mssql_result} returns the contents of one cell from a MS SQL
37384 * result set.
37385 *
37386 * @param resource $result The result resource that is being evaluated.
37387 *   This result comes from a call to {@link mssql_query}.
37388 * @param int $row The row number.
37389 * @param mixed $field Can be the field's offset, the field's name or
37390 *   the field's table dot field's name (tablename.fieldname). If the
37391 *   column name has been aliased ('select foo as bar from...'), it uses
37392 *   the alias instead of the column name.
37393 * @return string
37394 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37395 **/
37396function mssql_result($result, $row, $field){}
37397
37398/**
37399 * Returns the number of records affected by the last write query.
37400 *
37401 * @param resource $link_identifier A MS SQL link identifier, returned
37402 *   by {@link mssql_connect} or {@link mssql_pconnect}.
37403 * @return int
37404 * @since PHP 4 >= 4.0.4, PHP 5, PECL odbtp >= 1.1.1
37405 **/
37406function mssql_rows_affected($link_identifier){}
37407
37408/**
37409 * {@link mssql_select_db} sets the current active database on the server
37410 * that's associated with the specified link identifier.
37411 *
37412 * Every subsequent call to {@link mssql_query} will be made on the
37413 * active database.
37414 *
37415 * @param string $database_name The database name. To escape the name
37416 *   of a database that contains spaces, hyphens ("-"), or any other
37417 *   exceptional characters, the database name must be enclosed in
37418 *   brackets, as is shown in the example, below. This technique must
37419 *   also be applied when selecting a database name that is also a
37420 *   reserved word (such as primary).
37421 * @param resource $link_identifier A MS SQL link identifier, returned
37422 *   by {@link mssql_connect} or {@link mssql_pconnect}. If no link
37423 *   identifier is specified, the last opened link is assumed. If no link
37424 *   is open, the function will try to establish a link as if {@link
37425 *   mssql_connect} was called, and use it.
37426 * @return bool
37427 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
37428 **/
37429function mssql_select_db($database_name, $link_identifier){}
37430
37431/**
37432 * @return int
37433 * @since PHP 4, PHP 5
37434 **/
37435function mt_getrandmax(){}
37436
37437/**
37438 * @return int
37439 * @since PHP 4, PHP 5
37440 **/
37441function mt_rand(){}
37442
37443/**
37444 * Seeds the random number generator with {@link seed} or with a random
37445 * value if no {@link seed} is given.
37446 *
37447 * @param int $seed An optional seed value
37448 * @return void
37449 * @since PHP 4, PHP 5
37450 **/
37451function mt_srand($seed){}
37452
37453/**
37454 * Returns the number of rows affected by the last INSERT, UPDATE,
37455 * REPLACE or DELETE query.
37456 *
37457 * For SELECT statements {@link mysqli_affected_rows} works like {@link
37458 * mysqli_num_rows}.
37459 *
37460 * @param mysqli $link
37461 * @return int
37462 * @since PHP 5
37463 **/
37464function mysqli_affected_rows($link){}
37465
37466/**
37467 * Turns on or off auto-commit mode on queries for the database
37468 * connection.
37469 *
37470 * To determine the current state of autocommit use the SQL command
37471 * SELECT @@autocommit.
37472 *
37473 * @param mysqli $link Whether to turn on auto-commit or not.
37474 * @param bool $mode
37475 * @return bool
37476 * @since PHP 5
37477 **/
37478function mysqli_autocommit($link, $mode){}
37479
37480/**
37481 * Changes the user of the specified database connection and sets the
37482 * current database.
37483 *
37484 * In order to successfully change users a valid {@link username} and
37485 * {@link password} parameters must be provided and that user must have
37486 * sufficient permissions to access the desired database. If for any
37487 * reason authorization fails, the current user authentication will
37488 * remain.
37489 *
37490 * @param mysqli $link The MySQL user name.
37491 * @param string $user The MySQL password.
37492 * @param string $password The database to change to. If desired, the
37493 *   value may be passed resulting in only changing the user and not
37494 *   selecting a database. To select a database in this case use the
37495 *   {@link mysqli_select_db} function.
37496 * @param string $database
37497 * @return bool
37498 * @since PHP 5
37499 **/
37500function mysqli_change_user($link, $user, $password, $database){}
37501
37502/**
37503 * Returns the current character set for the database connection.
37504 *
37505 * @param mysqli $link
37506 * @return string
37507 * @since PHP 5
37508 **/
37509function mysqli_character_set_name($link){}
37510
37511/**
37512 * Closes a previously opened database connection.
37513 *
37514 * @param mysqli $link
37515 * @return bool
37516 * @since PHP 5
37517 **/
37518function mysqli_close($link){}
37519
37520/**
37521 * Commits the current transaction for the database connection.
37522 *
37523 * @param mysqli $link
37524 * @return bool
37525 * @since PHP 5
37526 **/
37527function mysqli_commit($link){}
37528
37529/**
37530 * Opens a connection to the MySQL Server running on.
37531 *
37532 * @param string $host Can be either a host name or an IP address.
37533 *   Passing the value or the string "localhost" to this parameter, the
37534 *   local host is assumed. When possible, pipes will be used instead of
37535 *   the TCP/IP protocol. Prepending host by p: opens a persistent
37536 *   connection. {@link mysqli_change_user} is automatically called on
37537 *   connections opened from the connection pool.
37538 * @param string $username The MySQL user name.
37539 * @param string $passwd If not provided or , the MySQL server will
37540 *   attempt to authenticate the user against those user records which
37541 *   have no password only. This allows one username to be used with
37542 *   different permissions (depending on if a password as provided or
37543 *   not).
37544 * @param string $dbname If provided will specify the default database
37545 *   to be used when performing queries.
37546 * @param int $port Specifies the port number to attempt to connect to
37547 *   the MySQL server.
37548 * @param string $socket Specifies the socket or named pipe that should
37549 *   be used.
37550 * @return mysqli
37551 * @since PHP 5
37552 **/
37553function mysqli_connect($host, $username, $passwd, $dbname, $port, $socket){}
37554
37555/**
37556 * Returns the last error code number from the last call to {@link
37557 * mysqli_connect}.
37558 *
37559 * @return int
37560 * @since PHP 5
37561 **/
37562function mysqli_connect_errno(){}
37563
37564/**
37565 * Returns the last error message string from the last call to {@link
37566 * mysqli_connect}.
37567 *
37568 * @return string
37569 * @since PHP 5
37570 **/
37571function mysqli_connect_error(){}
37572
37573/**
37574 * The {@link mysqli_data_seek} function seeks to an arbitrary result
37575 * pointer specified by the {@link offset} in the result set.
37576 *
37577 * @param mysqli_result $result The field offset. Must be between zero
37578 *   and the total number of rows minus one (0..{@link mysqli_num_rows} -
37579 *   1).
37580 * @param int $offset
37581 * @return bool
37582 * @since PHP 5
37583 **/
37584function mysqli_data_seek($result, $offset){}
37585
37586/**
37587 * Performs debugging operations using the Fred Fish debugging library.
37588 *
37589 * @param string $message A string representing the debugging operation
37590 *   to perform
37591 * @return bool
37592 * @since PHP 5
37593 **/
37594function mysqli_debug($message){}
37595
37596/**
37597 * @param mysqli $link
37598 * @return bool
37599 * @since PHP 5
37600 **/
37601function mysqli_disable_reads_from_master($link){}
37602
37603/**
37604 * @param mysqli $link
37605 * @return bool
37606 * @since PHP 5
37607 **/
37608function mysqli_disable_rpl_parse($link){}
37609
37610/**
37611 * This function is designed to be executed by an user with the SUPER
37612 * privilege and is used to dump debugging information into the log for
37613 * the MySQL Server relating to the connection.
37614 *
37615 * @param mysqli $link
37616 * @return bool
37617 * @since PHP 5
37618 **/
37619function mysqli_dump_debug_info($link){}
37620
37621/**
37622 * @return void
37623 * @since PHP 5 >= 5.1.0
37624 **/
37625function mysqli_embedded_server_end(){}
37626
37627/**
37628 * @param bool $start
37629 * @param array $arguments
37630 * @param array $groups
37631 * @return bool
37632 * @since PHP 5 >= 5.1.0
37633 **/
37634function mysqli_embedded_server_start($start, $arguments, $groups){}
37635
37636/**
37637 * @param mysqli $link
37638 * @return bool
37639 * @since PHP 5
37640 **/
37641function mysqli_enable_reads_from_master($link){}
37642
37643/**
37644 * @param mysqli $link
37645 * @return bool
37646 * @since PHP 5
37647 **/
37648function mysqli_enable_rpl_parse($link){}
37649
37650/**
37651 * Returns the last error code for the most recent MySQLi function call
37652 * that can succeed or fail.
37653 *
37654 * Client error message numbers are listed in the MySQL errmsg.h header
37655 * file, server error message numbers are listed in mysqld_error.h. In
37656 * the MySQL source distribution you can find a complete list of error
37657 * messages and error numbers in the file Docs/mysqld_error.txt.
37658 *
37659 * @param mysqli $link
37660 * @return int
37661 * @since PHP 5
37662 **/
37663function mysqli_errno($link){}
37664
37665/**
37666 * Returns the last error message for the most recent MySQLi function
37667 * call that can succeed or fail.
37668 *
37669 * @param mysqli $link
37670 * @return string
37671 * @since PHP 5
37672 **/
37673function mysqli_error($link){}
37674
37675/**
37676 * {@link mysqli_fetch_all} fetches all result rows and returns the
37677 * result set as an associative array, a numeric array, or both.
37678 *
37679 * @param mysqli_result $result This optional parameter is a constant
37680 *   indicating what type of array should be produced from the current
37681 *   row data. The possible values for this parameter are the constants
37682 *   MYSQLI_ASSOC, MYSQLI_NUM, or MYSQLI_BOTH.
37683 * @param int $resulttype
37684 * @return mixed
37685 * @since PHP 5 >= 5.3.0
37686 **/
37687function mysqli_fetch_all($result, $resulttype){}
37688
37689/**
37690 * Returns an array that corresponds to the fetched row or if there are
37691 * no more rows for the resultset represented by the {@link result}
37692 * parameter.
37693 *
37694 * {@link mysqli_fetch_array} is an extended version of the {@link
37695 * mysqli_fetch_row} function. In addition to storing the data in the
37696 * numeric indices of the result array, the {@link mysqli_fetch_array}
37697 * function can also store the data in associative indices, using the
37698 * field names of the result set as keys.
37699 *
37700 * If two or more columns of the result have the same field names, the
37701 * last column will take precedence and overwrite the earlier data. In
37702 * order to access multiple columns with the same name, the numerically
37703 * indexed version of the row must be used.
37704 *
37705 * @param mysqli_result $result This optional parameter is a constant
37706 *   indicating what type of array should be produced from the current
37707 *   row data. The possible values for this parameter are the constants
37708 *   MYSQLI_ASSOC, MYSQLI_NUM, or MYSQLI_BOTH. By using the MYSQLI_ASSOC
37709 *   constant this function will behave identically to the {@link
37710 *   mysqli_fetch_assoc}, while MYSQLI_NUM will behave identically to the
37711 *   {@link mysqli_fetch_row} function. The final option MYSQLI_BOTH will
37712 *   create a single array with the attributes of both.
37713 * @param int $resulttype
37714 * @return mixed
37715 * @since PHP 5
37716 **/
37717function mysqli_fetch_array($result, $resulttype){}
37718
37719/**
37720 * Returns an associative array that corresponds to the fetched row or if
37721 * there are no more rows.
37722 *
37723 * @param mysqli_result $result
37724 * @return array
37725 * @since PHP 5
37726 **/
37727function mysqli_fetch_assoc($result){}
37728
37729/**
37730 * Returns the definition of one column of a result set as an object.
37731 * Call this function repeatedly to retrieve information about all
37732 * columns in the result set.
37733 *
37734 * @param mysqli_result $result
37735 * @return object
37736 * @since PHP 5
37737 **/
37738function mysqli_fetch_field($result){}
37739
37740/**
37741 * This function serves an identical purpose to the {@link
37742 * mysqli_fetch_field} function with the single difference that, instead
37743 * of returning one object at a time for each field, the columns are
37744 * returned as an array of objects.
37745 *
37746 * @param mysqli_result $result
37747 * @return array
37748 * @since PHP 5
37749 **/
37750function mysqli_fetch_fields($result){}
37751
37752/**
37753 * Returns an object which contains field definition information from the
37754 * specified result set.
37755 *
37756 * @param mysqli_result $result The field number. This value must be in
37757 *   the range from 0 to number of fields - 1.
37758 * @param int $fieldnr
37759 * @return object
37760 * @since PHP 5
37761 **/
37762function mysqli_fetch_field_direct($result, $fieldnr){}
37763
37764/**
37765 * The {@link mysqli_fetch_lengths} function returns an array containing
37766 * the lengths of every column of the current row within the result set.
37767 *
37768 * @param mysqli_result $result
37769 * @return array
37770 * @since PHP 5
37771 **/
37772function mysqli_fetch_lengths($result){}
37773
37774/**
37775 * The {@link mysqli_fetch_object} will return the current row result set
37776 * as an object where the attributes of the object represent the names of
37777 * the fields found within the result set.
37778 *
37779 * @param mysqli_result $result The name of the class to instantiate,
37780 *   set the properties of and return. If not specified, a stdClass
37781 *   object is returned.
37782 * @param string $class_name An optional array of parameters to pass to
37783 *   the constructor for {@link class_name} objects.
37784 * @param array $params
37785 * @return object
37786 * @since PHP 5
37787 **/
37788function mysqli_fetch_object($result, $class_name, $params){}
37789
37790/**
37791 * Fetches one row of data from the result set and returns it as an
37792 * enumerated array, where each column is stored in an array offset
37793 * starting from 0 (zero). Each subsequent call to this function will
37794 * return the next row within the result set, or if there are no more
37795 * rows.
37796 *
37797 * @param mysqli_result $result
37798 * @return mixed
37799 * @since PHP 5
37800 **/
37801function mysqli_fetch_row($result){}
37802
37803/**
37804 * Returns the number of columns for the most recent query on the
37805 * connection represented by the {@link link} parameter. This function
37806 * can be useful when using the {@link mysqli_store_result} function to
37807 * determine if the query should have produced a non-empty result set or
37808 * not without knowing the nature of the query.
37809 *
37810 * @param mysqli $link
37811 * @return int
37812 * @since PHP 5
37813 **/
37814function mysqli_field_count($link){}
37815
37816/**
37817 * Sets the field cursor to the given offset. The next call to {@link
37818 * mysqli_fetch_field} will retrieve the field definition of the column
37819 * associated with that offset.
37820 *
37821 * @param mysqli_result $result The field number. This value must be in
37822 *   the range from 0 to number of fields - 1.
37823 * @param int $fieldnr
37824 * @return bool
37825 * @since PHP 5
37826 **/
37827function mysqli_field_seek($result, $fieldnr){}
37828
37829/**
37830 * Returns the position of the field cursor used for the last {@link
37831 * mysqli_fetch_field} call. This value can be used as an argument to
37832 * {@link mysqli_field_seek}.
37833 *
37834 * @param mysqli_result $result
37835 * @return int
37836 * @since PHP 5
37837 **/
37838function mysqli_field_tell($result){}
37839
37840/**
37841 * Frees the memory associated with the result.
37842 *
37843 * @param mysqli_result $result
37844 * @return void
37845 * @since PHP 5
37846 **/
37847function mysqli_free_result($result){}
37848
37849/**
37850 * Returns client Zval cache statistics.
37851 *
37852 * @return array
37853 * @since PHP 5 >= 5.3.0
37854 **/
37855function mysqli_get_cache_stats(){}
37856
37857/**
37858 * Returns a character set object providing several properties of the
37859 * current active character set.
37860 *
37861 * @param mysqli $link
37862 * @return object
37863 * @since PHP 5 >= 5.1.0
37864 **/
37865function mysqli_get_charset($link){}
37866
37867/**
37868 * Returns a string that represents the MySQL client library version.
37869 *
37870 * @param mysqli $link
37871 * @return string
37872 * @since PHP 5
37873 **/
37874function mysqli_get_client_info($link){}
37875
37876/**
37877 * Returns client per-process statistics.
37878 *
37879 * @return array
37880 * @since PHP 5 >= 5.3.0
37881 **/
37882function mysqli_get_client_stats(){}
37883
37884/**
37885 * Returns client version number as an integer.
37886 *
37887 * @param mysqli $link
37888 * @return int
37889 * @since PHP 5
37890 **/
37891function mysqli_get_client_version($link){}
37892
37893/**
37894 * Returns statistics about the client connection.
37895 *
37896 * @param mysqli $link
37897 * @return array
37898 * @since PHP 5 >= 5.3.0
37899 **/
37900function mysqli_get_connection_stats($link){}
37901
37902/**
37903 * Returns a string describing the connection represented by the {@link
37904 * link} parameter (including the server host name).
37905 *
37906 * @param mysqli $link
37907 * @return string
37908 * @since PHP 5
37909 **/
37910function mysqli_get_host_info($link){}
37911
37912/**
37913 * Returns an integer representing the MySQL protocol version used by the
37914 * connection represented by the {@link link} parameter.
37915 *
37916 * @param mysqli $link
37917 * @return int
37918 * @since PHP 5
37919 **/
37920function mysqli_get_proto_info($link){}
37921
37922/**
37923 * Returns a string representing the version of the MySQL server that the
37924 * MySQLi extension is connected to.
37925 *
37926 * @param mysqli $link
37927 * @return string
37928 * @since PHP 5
37929 **/
37930function mysqli_get_server_info($link){}
37931
37932/**
37933 * The {@link mysqli_get_server_version} function returns the version of
37934 * the server connected to (represented by the {@link link} parameter) as
37935 * an integer.
37936 *
37937 * @param mysqli $link
37938 * @return int
37939 * @since PHP 5
37940 **/
37941function mysqli_get_server_version($link){}
37942
37943/**
37944 * @param mysqli $link
37945 * @return mysqli_warning
37946 * @since PHP 5 >= 5.1.0
37947 **/
37948function mysqli_get_warnings($link){}
37949
37950/**
37951 * The {@link mysqli_info} function returns a string providing
37952 * information about the last query executed. The nature of this string
37953 * is provided below:
37954 *
37955 * Possible mysqli_info return values Query type Example result string
37956 * INSERT INTO...SELECT... Records: 100 Duplicates: 0 Warnings: 0 INSERT
37957 * INTO...VALUES (...),(...),(...) Records: 3 Duplicates: 0 Warnings: 0
37958 * LOAD DATA INFILE ... Records: 1 Deleted: 0 Skipped: 0 Warnings: 0
37959 * ALTER TABLE ... Records: 3 Duplicates: 0 Warnings: 0 UPDATE ... Rows
37960 * matched: 40 Changed: 40 Warnings: 0
37961 *
37962 * @param mysqli $link
37963 * @return string
37964 * @since PHP 5
37965 **/
37966function mysqli_info($link){}
37967
37968/**
37969 * Allocates or initializes a MYSQL object suitable for {@link
37970 * mysqli_options} and {@link mysqli_real_connect}.
37971 *
37972 * @return mysqli
37973 * @since PHP 5
37974 **/
37975function mysqli_init(){}
37976
37977/**
37978 * The {@link mysqli_insert_id} function returns the ID generated by a
37979 * query on a table with a column having the AUTO_INCREMENT attribute. If
37980 * the last query wasn't an INSERT or UPDATE statement or if the modified
37981 * table does not have a column with the AUTO_INCREMENT attribute, this
37982 * function will return zero.
37983 *
37984 * @param mysqli $link
37985 * @return mixed
37986 * @since PHP 5
37987 **/
37988function mysqli_insert_id($link){}
37989
37990/**
37991 * This function is used to ask the server to kill a MySQL thread
37992 * specified by the {@link processid} parameter. This value must be
37993 * retrieved by calling the {@link mysqli_thread_id} function.
37994 *
37995 * To stop a running query you should use the SQL command KILL QUERY
37996 * processid.
37997 *
37998 * @param mysqli $link
37999 * @param int $processid
38000 * @return bool
38001 * @since PHP 5
38002 **/
38003function mysqli_kill($link, $processid){}
38004
38005/**
38006 * @param mysqli $link
38007 * @param string $query
38008 * @return bool
38009 * @since PHP 5
38010 **/
38011function mysqli_master_query($link, $query){}
38012
38013/**
38014 * Indicates if one or more result sets are available from a previous
38015 * call to {@link mysqli_multi_query}.
38016 *
38017 * @param mysqli $link
38018 * @return bool
38019 * @since PHP 5
38020 **/
38021function mysqli_more_results($link){}
38022
38023/**
38024 * Executes one or multiple queries which are concatenated by a
38025 * semicolon.
38026 *
38027 * To retrieve the resultset from the first query you can use {@link
38028 * mysqli_use_result} or {@link mysqli_store_result}. All subsequent
38029 * query results can be processed using {@link mysqli_more_results} and
38030 * {@link mysqli_next_result}.
38031 *
38032 * @param mysqli $link The query, as a string. Data inside the query
38033 *   should be properly escaped.
38034 * @param string $query
38035 * @return bool
38036 * @since PHP 5
38037 **/
38038function mysqli_multi_query($link, $query){}
38039
38040/**
38041 * Prepares next result set from a previous call to {@link
38042 * mysqli_multi_query} which can be retrieved by {@link
38043 * mysqli_store_result} or {@link mysqli_use_result}.
38044 *
38045 * @param mysqli $link
38046 * @return bool
38047 * @since PHP 5
38048 **/
38049function mysqli_next_result($link){}
38050
38051/**
38052 * Returns the number of fields from specified result set.
38053 *
38054 * @param mysqli_result $result
38055 * @return int
38056 * @since PHP 5
38057 **/
38058function mysqli_num_fields($result){}
38059
38060/**
38061 * Returns the number of rows in the result set.
38062 *
38063 * The use of {@link mysqli_num_rows} depends on whether you use buffered
38064 * or unbuffered result sets. In case you use unbuffered resultsets
38065 * {@link mysqli_num_rows} will not return the correct number of rows
38066 * until all the rows in the result have been retrieved.
38067 *
38068 * @param mysqli_result $result
38069 * @return int
38070 * @since PHP 5
38071 **/
38072function mysqli_num_rows($result){}
38073
38074/**
38075 * Used to set extra connect options and affect behavior for a
38076 * connection.
38077 *
38078 * This function may be called multiple times to set several options.
38079 *
38080 * {@link mysqli_options} should be called after {@link mysqli_init} and
38081 * before {@link mysqli_real_connect}.
38082 *
38083 * @param mysqli $link The option that you want to set. It can be one
38084 *   of the following values: Valid options Name Description
38085 *   MYSQLI_OPT_CONNECT_TIMEOUT connection timeout in seconds (supported
38086 *   on Windows with TCP/IP since PHP 5.3.1) MYSQLI_OPT_LOCAL_INFILE
38087 *   enable/disable use of LOAD LOCAL INFILE MYSQLI_INIT_COMMAND command
38088 *   to execute after when connecting to MySQL server
38089 *   MYSQLI_READ_DEFAULT_FILE Read options from named option file instead
38090 *   of my.cnf MYSQLI_READ_DEFAULT_GROUP Read options from the named
38091 *   group from my.cnf or the file specified with
38092 *   MYSQL_READ_DEFAULT_FILE.
38093 * @param int $option The value for the option.
38094 * @param mixed $value
38095 * @return bool
38096 * @since PHP 5
38097 **/
38098function mysqli_options($link, $option, $value){}
38099
38100/**
38101 * Checks whether the connection to the server is working. If it has gone
38102 * down, and global option mysqli.reconnect is enabled an automatic
38103 * reconnection is attempted.
38104 *
38105 * This function can be used by clients that remain idle for a long
38106 * while, to check whether the server has closed the connection and
38107 * reconnect if necessary.
38108 *
38109 * @param mysqli $link
38110 * @return bool
38111 * @since PHP 5
38112 **/
38113function mysqli_ping($link){}
38114
38115/**
38116 * Poll connections.
38117 *
38118 * @param array $read
38119 * @param array $error
38120 * @param array $reject
38121 * @param int $sec Number of seconds to wait, must be non-negative.
38122 * @param int $usec Number of microseconds to wait, must be
38123 *   non-negative.
38124 * @return int
38125 * @since PHP 5 >= 5.3.0
38126 **/
38127function mysqli_poll(&$read, &$error, &$reject, $sec, $usec){}
38128
38129/**
38130 * Prepares the SQL query, and returns a statement handle to be used for
38131 * further operations on the statement. The query must consist of a
38132 * single SQL statement.
38133 *
38134 * The parameter markers must be bound to application variables using
38135 * {@link mysqli_stmt_bind_param} and/or {@link mysqli_stmt_bind_result}
38136 * before executing the statement or fetching rows.
38137 *
38138 * @param mysqli $link The query, as a string. This parameter can
38139 *   include one or more parameter markers in the SQL statement by
38140 *   embedding question mark (?) characters at the appropriate positions.
38141 * @param string $query
38142 * @return mysqli_stmt
38143 * @since PHP 5
38144 **/
38145function mysqli_prepare($link, $query){}
38146
38147/**
38148 * Performs a {@link query} against the database.
38149 *
38150 * Functionally, using this function is identical to calling {@link
38151 * mysqli_real_query} followed either by {@link mysqli_use_result} or
38152 * {@link mysqli_store_result}.
38153 *
38154 * @param mysqli $link The query string. Data inside the query should
38155 *   be properly escaped.
38156 * @param string $query Either the constant MYSQLI_USE_RESULT or
38157 *   MYSQLI_STORE_RESULT depending on the desired behavior. By default,
38158 *   MYSQLI_STORE_RESULT is used. If you use MYSQLI_USE_RESULT all
38159 *   subsequent calls will return error Commands out of sync unless you
38160 *   call {@link mysqli_free_result} With MYSQLI_ASYNC (available with
38161 *   mysqlnd), it is possible to perform query asynchronously. {@link
38162 *   mysqli_poll} is then used to get results from such queries.
38163 * @param int $resultmode
38164 * @return mixed
38165 * @since PHP 5
38166 **/
38167function mysqli_query($link, $query, $resultmode){}
38168
38169/**
38170 * Establish a connection to a MySQL database engine.
38171 *
38172 * This function differs from {@link mysqli_connect}:
38173 *
38174 * @param mysqli $link Can be either a host name or an IP address.
38175 *   Passing the value or the string "localhost" to this parameter, the
38176 *   local host is assumed. When possible, pipes will be used instead of
38177 *   the TCP/IP protocol.
38178 * @param string $host The MySQL user name.
38179 * @param string $username If provided or , the MySQL server will
38180 *   attempt to authenticate the user against those user records which
38181 *   have no password only. This allows one username to be used with
38182 *   different permissions (depending on if a password as provided or
38183 *   not).
38184 * @param string $passwd If provided will specify the default database
38185 *   to be used when performing queries.
38186 * @param string $dbname Specifies the port number to attempt to
38187 *   connect to the MySQL server.
38188 * @param int $port Specifies the socket or named pipe that should be
38189 *   used.
38190 * @param string $socket With the parameter {@link flags} you can set
38191 *   different connection options:
38192 * @param int $flags
38193 * @return bool
38194 * @since PHP 5
38195 **/
38196function mysqli_real_connect($link, $host, $username, $passwd, $dbname, $port, $socket, $flags){}
38197
38198/**
38199 * This function is used to create a legal SQL string that you can use in
38200 * an SQL statement. The given string is encoded to an escaped SQL
38201 * string, taking into account the current character set of the
38202 * connection.
38203 *
38204 * @param mysqli $link The string to be escaped. Characters encoded are
38205 *   NUL (ASCII 0), \n, \r, \, ', ", and Control-Z.
38206 * @param string $escapestr
38207 * @return string
38208 * @since PHP 5
38209 **/
38210function mysqli_real_escape_string($link, $escapestr){}
38211
38212/**
38213 * Executes a single query against the database whose result can then be
38214 * retrieved or stored using the {@link mysqli_store_result} or {@link
38215 * mysqli_use_result} functions.
38216 *
38217 * In order to determine if a given query should return a result set or
38218 * not, see {@link mysqli_field_count}.
38219 *
38220 * @param mysqli $link The query, as a string. Data inside the query
38221 *   should be properly escaped.
38222 * @param string $query
38223 * @return bool
38224 * @since PHP 5
38225 **/
38226function mysqli_real_query($link, $query){}
38227
38228/**
38229 * Get result from async query.
38230 *
38231 * @param mysql $link
38232 * @return mysqli_result
38233 * @since PHP 5 >= 5.3.0
38234 **/
38235function mysqli_reap_async_query($link){}
38236
38237/**
38238 * {@link mysqli_report} is a powerful function to improve your queries
38239 * and code during development and testing phase. Depending on the flags
38240 * it reports errors from mysqli function calls or queries which don't
38241 * use an index (or use a bad index).
38242 *
38243 * @param int $flags Supported flags Name Description MYSQLI_REPORT_OFF
38244 *   Turns reporting off MYSQLI_REPORT_ERROR Report errors from mysqli
38245 *   function calls MYSQLI_REPORT_STRICT Report warnings from mysqli
38246 *   function calls MYSQLI_REPORT_INDEX Report if no index or bad index
38247 *   was used in a query MYSQLI_REPORT_ALL Set all options (report all)
38248 * @return bool
38249 * @since PHP 5
38250 **/
38251function mysqli_report($flags){}
38252
38253/**
38254 * Rollbacks the current transaction for the database.
38255 *
38256 * @param mysqli $link
38257 * @return bool
38258 * @since PHP 5
38259 **/
38260function mysqli_rollback($link){}
38261
38262/**
38263 * @param mysqli $link
38264 * @return int
38265 * @since PHP 5
38266 **/
38267function mysqli_rpl_parse_enabled($link){}
38268
38269/**
38270 * @param mysqli $link
38271 * @return bool
38272 * @since PHP 5
38273 **/
38274function mysqli_rpl_probe($link){}
38275
38276/**
38277 * Returns MYSQLI_RPL_MASTER, MYSQLI_RPL_SLAVE or MYSQLI_RPL_ADMIN
38278 * depending on a query type. INSERT, UPDATE and similar are master
38279 * queries, SELECT is slave, and FLUSH, REPAIR and similar are admin.
38280 *
38281 * @param mysqli $link
38282 * @param string $query
38283 * @return int
38284 * @since PHP 5
38285 **/
38286function mysqli_rpl_query_type($link, $query){}
38287
38288/**
38289 * Selects the default database to be used when performing queries
38290 * against the database connection.
38291 *
38292 * @param mysqli $link The database name.
38293 * @param string $dbname
38294 * @return bool
38295 * @since PHP 5
38296 **/
38297function mysqli_select_db($link, $dbname){}
38298
38299/**
38300 * @param mysqli $link
38301 * @param string $query
38302 * @return bool
38303 * @since PHP 5
38304 **/
38305function mysqli_send_query($link, $query){}
38306
38307/**
38308 * Sets the default character set to be used when sending data from and
38309 * to the database server.
38310 *
38311 * @param mysqli $link The charset to be set as default.
38312 * @param string $charset
38313 * @return bool
38314 * @since PHP 5 >= 5.0.5
38315 **/
38316function mysqli_set_charset($link, $charset){}
38317
38318/**
38319 * Deactivates a LOAD DATA INFILE LOCAL handler previously set with
38320 * {@link mysqli_set_local_infile_handler}.
38321 *
38322 * @param mysqli $link
38323 * @return void
38324 * @since PHP 5
38325 **/
38326function mysqli_set_local_infile_default($link){}
38327
38328/**
38329 * Set callback function for LOAD DATA LOCAL INFILE command
38330 *
38331 * The callbacks task is to read input from the file specified in the
38332 * LOAD DATA LOCAL INFILE and to reformat it into the format understood
38333 * by LOAD DATA INFILE.
38334 *
38335 * The returned data needs to match the format specified in the LOAD DATA
38336 *
38337 * @param mysqli $link A callback function or object method taking the
38338 *   following parameters:
38339 * @param callback $read_func A PHP stream associated with the SQL
38340 *   commands INFILE
38341 * @return bool
38342 * @since PHP 5
38343 **/
38344function mysqli_set_local_infile_handler($link, $read_func){}
38345
38346/**
38347 * @param mysqli $link
38348 * @param string $query
38349 * @return bool
38350 * @since PHP 5
38351 **/
38352function mysqli_slave_query($link, $query){}
38353
38354/**
38355 * Returns a string containing the SQLSTATE error code for the last
38356 * error. The error code consists of five characters. '00000' means no
38357 * error. The values are specified by ANSI SQL and ODBC. For a list of
38358 * possible values, see .
38359 *
38360 * @param mysqli $link
38361 * @return string
38362 * @since PHP 5
38363 **/
38364function mysqli_sqlstate($link){}
38365
38366/**
38367 * Used for establishing secure connections using SSL. It must be called
38368 * before {@link mysqli_real_connect}. This function does nothing unless
38369 * OpenSSL support is enabled.
38370 *
38371 * Note that MySQL Native Driver does not support SSL, so calling this
38372 * function when using MySQL Native Driver will result in an error. MySQL
38373 * Native Driver is enabled by default on Microsoft Windows from PHP
38374 * version 5.3 onwards.
38375 *
38376 * @param mysqli $link The path name to the key file.
38377 * @param string $key The path name to the certificate file.
38378 * @param string $cert The path name to the certificate authority file.
38379 * @param string $ca The pathname to a directory that contains trusted
38380 *   SSL CA certificates in PEM format.
38381 * @param string $capath A list of allowable ciphers to use for SSL
38382 *   encryption.
38383 * @param string $cipher
38384 * @return bool
38385 * @since PHP 5
38386 **/
38387function mysqli_ssl_set($link, $key, $cert, $ca, $capath, $cipher){}
38388
38389/**
38390 * {@link mysqli_stat} returns a string containing information similar to
38391 * that provided by the 'mysqladmin status' command. This includes uptime
38392 * in seconds and the number of running threads, questions, reloads, and
38393 * open tables.
38394 *
38395 * @param mysqli $link
38396 * @return string
38397 * @since PHP 5
38398 **/
38399function mysqli_stat($link){}
38400
38401/**
38402 * Returns the number of rows affected by INSERT, UPDATE, or DELETE
38403 * query.
38404 *
38405 * This function only works with queries which update a table. In order
38406 * to get the number of rows from a SELECT query, use {@link
38407 * mysqli_stmt_num_rows} instead.
38408 *
38409 * @param mysqli_stmt $stmt
38410 * @return int
38411 * @since PHP 5
38412 **/
38413function mysqli_stmt_affected_rows($stmt){}
38414
38415/**
38416 * Gets the current value of a statement attribute.
38417 *
38418 * @param mysqli_stmt $stmt The attribute that you want to get.
38419 * @param int $attr
38420 * @return int
38421 * @since PHP 5
38422 **/
38423function mysqli_stmt_attr_get($stmt, $attr){}
38424
38425/**
38426 * Used to modify the behavior of a prepared statement. This function may
38427 * be called multiple times to set several attributes.
38428 *
38429 * @param mysqli_stmt $stmt The attribute that you want to set. It can
38430 *   have one of the following values: Attribute values Character
38431 *   Description MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH If set to 1, causes
38432 *   {@link mysqli_stmt_store_result} to update the metadata
38433 *   MYSQL_FIELD->max_length value. MYSQLI_STMT_ATTR_CURSOR_TYPE Type of
38434 *   cursor to open for statement when {@link mysqli_stmt_execute} is
38435 *   invoked. {@link mode} can be MYSQLI_CURSOR_TYPE_NO_CURSOR (the
38436 *   default) or MYSQLI_CURSOR_TYPE_READ_ONLY.
38437 *   MYSQLI_STMT_ATTR_PREFETCH_ROWS Number of rows to fetch from server
38438 *   at a time when using a cursor. {@link mode} can be in the range from
38439 *   1 to the maximum value of unsigned long. The default is 1. If you
38440 *   use the MYSQLI_STMT_ATTR_CURSOR_TYPE option with
38441 *   MYSQLI_CURSOR_TYPE_READ_ONLY, a cursor is opened for the statement
38442 *   when you invoke {@link mysqli_stmt_execute}. If there is already an
38443 *   open cursor from a previous {@link mysqli_stmt_execute} call, it
38444 *   closes the cursor before opening a new one. {@link
38445 *   mysqli_stmt_reset} also closes any open cursor before preparing the
38446 *   statement for re-execution. {@link mysqli_stmt_free_result} closes
38447 *   any open cursor. If you open a cursor for a prepared statement,
38448 *   {@link mysqli_stmt_store_result} is unnecessary.
38449 * @param int $attr The value to assign to the attribute.
38450 * @param int $mode
38451 * @return bool
38452 * @since PHP 5
38453 **/
38454function mysqli_stmt_attr_set($stmt, $attr, $mode){}
38455
38456/**
38457 * Bind variables for the parameter markers in the SQL statement that was
38458 * passed to {@link mysqli_prepare}.
38459 *
38460 * @param mysqli_stmt $stmt A string that contains one or more
38461 *   characters which specify the types for the corresponding bind
38462 *   variables: Type specification chars Character Description i
38463 *   corresponding variable has type integer d corresponding variable has
38464 *   type double s corresponding variable has type string b corresponding
38465 *   variable is a blob and will be sent in packets
38466 * @param string $types The number of variables and length of string
38467 *   {@link types} must match the parameters in the statement.
38468 * @param mixed $var1
38469 * @return bool
38470 * @since PHP 5
38471 **/
38472function mysqli_stmt_bind_param($stmt, $types, &$var1){}
38473
38474/**
38475 * Binds columns in the result set to variables.
38476 *
38477 * When {@link mysqli_stmt_fetch} is called to fetch data, the MySQL
38478 * client/server protocol places the data for the bound columns into the
38479 * specified variables {@link var1, ...}.
38480 *
38481 * @param mysqli_stmt $stmt The variable to be bound.
38482 * @param mixed $var1
38483 * @return bool
38484 * @since PHP 5
38485 **/
38486function mysqli_stmt_bind_result($stmt, &$var1){}
38487
38488/**
38489 * Closes a prepared statement. {@link mysqli_stmt_close} also
38490 * deallocates the statement handle. If the current statement has pending
38491 * or unread results, this function cancels them so that the next query
38492 * can be executed.
38493 *
38494 * @param mysqli_stmt $stmt
38495 * @return bool
38496 * @since PHP 5
38497 **/
38498function mysqli_stmt_close($stmt){}
38499
38500/**
38501 * Seeks to an arbitrary result pointer in the statement result set.
38502 *
38503 * {@link mysqli_stmt_store_result} must be called prior to {@link
38504 * mysqli_stmt_data_seek}.
38505 *
38506 * @param mysqli_stmt $stmt Must be between zero and the total number
38507 *   of rows minus one (0.. {@link mysqli_stmt_num_rows} - 1).
38508 * @param int $offset
38509 * @return void
38510 * @since PHP 5
38511 **/
38512function mysqli_stmt_data_seek($stmt, $offset){}
38513
38514/**
38515 * Returns the error code for the most recently invoked statement
38516 * function that can succeed or fail.
38517 *
38518 * Client error message numbers are listed in the MySQL errmsg.h header
38519 * file, server error message numbers are listed in mysqld_error.h. In
38520 * the MySQL source distribution you can find a complete list of error
38521 * messages and error numbers in the file Docs/mysqld_error.txt.
38522 *
38523 * @param mysqli_stmt $stmt
38524 * @return int
38525 * @since PHP 5
38526 **/
38527function mysqli_stmt_errno($stmt){}
38528
38529/**
38530 * Returns a containing the error message for the most recently invoked
38531 * statement function that can succeed or fail.
38532 *
38533 * @param mysqli_stmt $stmt
38534 * @return string
38535 * @since PHP 5
38536 **/
38537function mysqli_stmt_error($stmt){}
38538
38539/**
38540 * Executes a query that has been previously prepared using the {@link
38541 * mysqli_prepare} function. When executed any parameter markers which
38542 * exist will automatically be replaced with the appropriate data.
38543 *
38544 * If the statement is UPDATE, DELETE, or INSERT, the total number of
38545 * affected rows can be determined by using the {@link
38546 * mysqli_stmt_affected_rows} function. Likewise, if the query yields a
38547 * result set the {@link mysqli_stmt_fetch} function is used.
38548 *
38549 * @param mysqli_stmt $stmt
38550 * @return bool
38551 * @since PHP 5
38552 **/
38553function mysqli_stmt_execute($stmt){}
38554
38555/**
38556 * Fetch the result from a prepared statement into the variables bound by
38557 * {@link mysqli_stmt_bind_result}.
38558 *
38559 * @param mysqli_stmt $stmt
38560 * @return bool
38561 * @since PHP 5
38562 **/
38563function mysqli_stmt_fetch($stmt){}
38564
38565/**
38566 * @param mysqli_stmt $stmt
38567 * @return int
38568 * @since PHP 5
38569 **/
38570function mysqli_stmt_field_count($stmt){}
38571
38572/**
38573 * Frees the result memory associated with the statement, which was
38574 * allocated by {@link mysqli_stmt_store_result}.
38575 *
38576 * @param mysqli_stmt $stmt
38577 * @return void
38578 * @since PHP 5
38579 **/
38580function mysqli_stmt_free_result($stmt){}
38581
38582/**
38583 * @param mysqli_stmt $stmt
38584 * @return object
38585 * @since PHP 5 >= 5.1.0
38586 **/
38587function mysqli_stmt_get_warnings($stmt){}
38588
38589/**
38590 * Allocates and initializes a statement object suitable for {@link
38591 * mysqli_stmt_prepare}.
38592 *
38593 * @param mysqli $link
38594 * @return mysqli_stmt
38595 * @since PHP 5
38596 **/
38597function mysqli_stmt_init($link){}
38598
38599/**
38600 * @param mysqli_stmt $stmt
38601 * @return mixed
38602 * @since PHP 5
38603 **/
38604function mysqli_stmt_insert_id($stmt){}
38605
38606/**
38607 * Returns the number of rows in the result set. The use of {@link
38608 * mysqli_stmt_num_rows} depends on whether or not you used {@link
38609 * mysqli_stmt_store_result} to buffer the entire result set in the
38610 * statement handle.
38611 *
38612 * If you use {@link mysqli_stmt_store_result}, {@link
38613 * mysqli_stmt_num_rows} may be called immediately.
38614 *
38615 * @param mysqli_stmt $stmt
38616 * @return int
38617 * @since PHP 5
38618 **/
38619function mysqli_stmt_num_rows($stmt){}
38620
38621/**
38622 * Returns the number of parameter markers present in the prepared
38623 * statement.
38624 *
38625 * @param mysqli_stmt $stmt
38626 * @return int
38627 * @since PHP 5
38628 **/
38629function mysqli_stmt_param_count($stmt){}
38630
38631/**
38632 * Prepares the SQL query pointed to by the null-terminated string query.
38633 *
38634 * The parameter markers must be bound to application variables using
38635 * {@link mysqli_stmt_bind_param} and/or {@link mysqli_stmt_bind_result}
38636 * before executing the statement or fetching rows.
38637 *
38638 * @param mysqli_stmt $stmt The query, as a string. It must consist of
38639 *   a single SQL statement. You can include one or more parameter
38640 *   markers in the SQL statement by embedding question mark (?)
38641 *   characters at the appropriate positions.
38642 * @param string $query
38643 * @return bool
38644 * @since PHP 5
38645 **/
38646function mysqli_stmt_prepare($stmt, $query){}
38647
38648/**
38649 * Resets a prepared statement on client and server to state after
38650 * prepare.
38651 *
38652 * It resets the statement on the server, data sent using {@link
38653 * mysqli_stmt_send_long_data}, unbuffered result sets and current
38654 * errors. It does not clear bindings or stored result sets. Stored
38655 * result sets will be cleared when executing the prepared statement (or
38656 * closing it).
38657 *
38658 * To prepare a statement with another query use function {@link
38659 * mysqli_stmt_prepare}.
38660 *
38661 * @param mysqli_stmt $stmt
38662 * @return bool
38663 * @since PHP 5
38664 **/
38665function mysqli_stmt_reset($stmt){}
38666
38667/**
38668 * If a statement passed to {@link mysqli_prepare} is one that produces a
38669 * result set, {@link mysqli_stmt_result_metadata} returns the result
38670 * object that can be used to process the meta information such as total
38671 * number of fields and individual field information.
38672 *
38673 * The result set structure should be freed when you are done with it,
38674 * which you can do by passing it to {@link mysqli_free_result}
38675 *
38676 * @param mysqli_stmt $stmt
38677 * @return mysqli_result
38678 * @since PHP 5
38679 **/
38680function mysqli_stmt_result_metadata($stmt){}
38681
38682/**
38683 * Allows to send parameter data to the server in pieces (or chunks),
38684 * e.g. if the size of a blob exceeds the size of max_allowed_packet.
38685 * This function can be called multiple times to send the parts of a
38686 * character or binary data value for a column, which must be one of the
38687 * TEXT or BLOB datatypes.
38688 *
38689 * @param mysqli_stmt $stmt Indicates which parameter to associate the
38690 *   data with. Parameters are numbered beginning with 0.
38691 * @param int $param_nr A string containing data to be sent.
38692 * @param string $data
38693 * @return bool
38694 * @since PHP 5
38695 **/
38696function mysqli_stmt_send_long_data($stmt, $param_nr, $data){}
38697
38698/**
38699 * Returns a string containing the SQLSTATE error code for the most
38700 * recently invoked prepared statement function that can succeed or fail.
38701 * The error code consists of five characters. '00000' means no error.
38702 * The values are specified by ANSI SQL and ODBC. For a list of possible
38703 * values, see .
38704 *
38705 * @param mysqli_stmt $stmt
38706 * @return string
38707 * @since PHP 5
38708 **/
38709function mysqli_stmt_sqlstate($stmt){}
38710
38711/**
38712 * You must call {@link mysqli_stmt_store_result} for every query that
38713 * successfully produces a result set (SELECT, SHOW, DESCRIBE, EXPLAIN),
38714 * and only if you want to buffer the complete result set by the client,
38715 * so that the subsequent {@link mysqli_stmt_fetch} call returns buffered
38716 * data.
38717 *
38718 * @param mysqli_stmt $stmt
38719 * @return bool
38720 * @since PHP 5
38721 **/
38722function mysqli_stmt_store_result($stmt){}
38723
38724/**
38725 * Transfers the result set from the last query on the database
38726 * connection represented by the {@link link} parameter to be used with
38727 * the {@link mysqli_data_seek} function.
38728 *
38729 * @param mysqli $link
38730 * @return mysqli_result
38731 * @since PHP 5
38732 **/
38733function mysqli_store_result($link){}
38734
38735/**
38736 * The {@link mysqli_thread_id} function returns the thread ID for the
38737 * current connection which can then be killed using the {@link
38738 * mysqli_kill} function. If the connection is lost and you reconnect
38739 * with {@link mysqli_ping}, the thread ID will be other. Therefore you
38740 * should get the thread ID only when you need it.
38741 *
38742 * @param mysqli $link
38743 * @return int
38744 * @since PHP 5
38745 **/
38746function mysqli_thread_id($link){}
38747
38748/**
38749 * Tells whether the client library is compiled as thread-safe.
38750 *
38751 * @return bool
38752 * @since PHP 5
38753 **/
38754function mysqli_thread_safe(){}
38755
38756/**
38757 * Used to initiate the retrieval of a result set from the last query
38758 * executed using the {@link mysqli_real_query} function on the database
38759 * connection.
38760 *
38761 * Either this or the {@link mysqli_store_result} function must be called
38762 * before the results of a query can be retrieved, and one or the other
38763 * must be called to prevent the next query on that database connection
38764 * from failing.
38765 *
38766 * @param mysqli $link
38767 * @return mysqli_result
38768 * @since PHP 5
38769 **/
38770function mysqli_use_result($link){}
38771
38772/**
38773 * Returns the number of warnings from the last query in the connection.
38774 *
38775 * @param mysqli $link
38776 * @return int
38777 * @since PHP 5
38778 **/
38779function mysqli_warning_count($link){}
38780
38781/**
38782 * Get the number of affected rows by the last INSERT, UPDATE, REPLACE or
38783 * DELETE query associated with {@link link_identifier}.
38784 *
38785 * @param resource $link_identifier
38786 * @return int
38787 * @since PHP 4, PHP 5
38788 **/
38789function mysql_affected_rows($link_identifier){}
38790
38791/**
38792 * Retrieves the character_set variable from MySQL.
38793 *
38794 * @param resource $link_identifier
38795 * @return string
38796 * @since PHP 4 >= 4.3.0, PHP 5
38797 **/
38798function mysql_client_encoding($link_identifier){}
38799
38800/**
38801 * {@link mysql_close} closes the non-persistent connection to the MySQL
38802 * server that's associated with the specified link identifier. If {@link
38803 * link_identifier} isn't specified, the last opened link is used.
38804 *
38805 * Using {@link mysql_close} isn't usually necessary, as non-persistent
38806 * open links are automatically closed at the end of the script's
38807 * execution. See also freeing resources.
38808 *
38809 * @param resource $link_identifier
38810 * @return bool
38811 * @since PHP 4, PHP 5
38812 **/
38813function mysql_close($link_identifier){}
38814
38815/**
38816 * Opens or reuses a connection to a MySQL server.
38817 *
38818 * @param string $server The MySQL server. It can also include a port
38819 *   number. e.g. "hostname:port" or a path to a local socket e.g.
38820 *   ":/path/to/socket" for the localhost. If the PHP directive
38821 *   mysql.default_host is undefined (default), then the default value is
38822 *   'localhost:3306'. In , this parameter is ignored and value
38823 *   'localhost:3306' is always used.
38824 * @param string $username The username. Default value is defined by
38825 *   mysql.default_user. In , this parameter is ignored and the name of
38826 *   the user that owns the server process is used.
38827 * @param string $password The password. Default value is defined by
38828 *   mysql.default_password. In , this parameter is ignored and empty
38829 *   password is used.
38830 * @param bool $new_link If a second call is made to {@link
38831 *   mysql_connect} with the same arguments, no new link will be
38832 *   established, but instead, the link identifier of the already opened
38833 *   link will be returned. The {@link new_link} parameter modifies this
38834 *   behavior and makes {@link mysql_connect} always open a new link,
38835 *   even if {@link mysql_connect} was called before with the same
38836 *   parameters. In , this parameter is ignored.
38837 * @param int $client_flags The {@link client_flags} parameter can be a
38838 *   combination of the following constants: 128 (enable LOAD DATA LOCAL
38839 *   handling), MYSQL_CLIENT_SSL, MYSQL_CLIENT_COMPRESS,
38840 *   MYSQL_CLIENT_IGNORE_SPACE or MYSQL_CLIENT_INTERACTIVE. Read the
38841 *   section about for further information. In , this parameter is
38842 *   ignored.
38843 * @return resource
38844 * @since PHP 4, PHP 5
38845 **/
38846function mysql_connect($server, $username, $password, $new_link, $client_flags){}
38847
38848/**
38849 * {@link mysql_create_db} attempts to create a new database on the
38850 * server associated with the specified link identifier.
38851 *
38852 * @param string $database_name The name of the database being created.
38853 * @param resource $link_identifier
38854 * @return bool
38855 * @since PHP 4, PHP 5
38856 **/
38857function mysql_create_db($database_name, $link_identifier){}
38858
38859/**
38860 * {@link mysql_data_seek} moves the internal row pointer of the MySQL
38861 * result associated with the specified result identifier to point to the
38862 * specified row number. The next call to a MySQL fetch function, such as
38863 * {@link mysql_fetch_assoc}, would return that row.
38864 *
38865 * {@link row_number} starts at 0. The {@link row_number} should be a
38866 * value in the range from 0 to {@link mysql_num_rows} - 1. However if
38867 * the result set is empty ({@link mysql_num_rows} == 0), a seek to 0
38868 * will fail with a E_WARNING and {@link mysql_data_seek} will return .
38869 *
38870 * @param resource $result The desired row number of the new result
38871 *   pointer.
38872 * @param int $row_number
38873 * @return bool
38874 * @since PHP 4, PHP 5
38875 **/
38876function mysql_data_seek($result, $row_number){}
38877
38878/**
38879 * Retrieve the database name from a call to {@link mysql_list_dbs}.
38880 *
38881 * @param resource $result The result pointer from a call to {@link
38882 *   mysql_list_dbs}.
38883 * @param int $row The index into the result set.
38884 * @param mixed $field The field name.
38885 * @return string
38886 * @since PHP 4, PHP 5
38887 **/
38888function mysql_db_name($result, $row, $field){}
38889
38890/**
38891 * {@link mysql_db_query} selects a database, and executes a query on it.
38892 *
38893 * @param string $database The name of the database that will be
38894 *   selected.
38895 * @param string $query The MySQL query. Data inside the query should
38896 *   be properly escaped.
38897 * @param resource $link_identifier
38898 * @return resource
38899 * @since PHP 4, PHP 5
38900 **/
38901function mysql_db_query($database, $query, $link_identifier){}
38902
38903/**
38904 * {@link mysql_drop_db} attempts to drop (remove) an entire database
38905 * from the server associated with the specified link identifier. This
38906 * function is deprecated, it is preferable to use {@link mysql_query} to
38907 * issue an sql DROP DATABASE statement instead.
38908 *
38909 * @param string $database_name The name of the database that will be
38910 *   deleted.
38911 * @param resource $link_identifier
38912 * @return bool
38913 * @since PHP 4, PHP 5
38914 **/
38915function mysql_drop_db($database_name, $link_identifier){}
38916
38917/**
38918 * Returns the error number from the last MySQL function.
38919 *
38920 * Errors coming back from the MySQL database backend no longer issue
38921 * warnings. Instead, use {@link mysql_errno} to retrieve the error code.
38922 * Note that this function only returns the error code from the most
38923 * recently executed MySQL function (not including {@link mysql_error}
38924 * and {@link mysql_errno}), so if you want to use it, make sure you
38925 * check the value before calling another MySQL function.
38926 *
38927 * @param resource $link_identifier
38928 * @return int
38929 * @since PHP 4, PHP 5
38930 **/
38931function mysql_errno($link_identifier){}
38932
38933/**
38934 * Returns the error text from the last MySQL function. Errors coming
38935 * back from the MySQL database backend no longer issue warnings.
38936 * Instead, use {@link mysql_error} to retrieve the error text. Note that
38937 * this function only returns the error text from the most recently
38938 * executed MySQL function (not including {@link mysql_error} and {@link
38939 * mysql_errno}), so if you want to use it, make sure you check the value
38940 * before calling another MySQL function.
38941 *
38942 * @param resource $link_identifier
38943 * @return string
38944 * @since PHP 4, PHP 5
38945 **/
38946function mysql_error($link_identifier){}
38947
38948/**
38949 * This function will escape the {@link unescaped_string}, so that it is
38950 * safe to place it in a {@link mysql_query}. This function is
38951 * deprecated.
38952 *
38953 * This function is identical to {@link mysql_real_escape_string} except
38954 * that {@link mysql_real_escape_string} takes a connection handler and
38955 * escapes the string according to the current character set. {@link
38956 * mysql_escape_string} does not take a connection argument and does not
38957 * respect the current charset setting.
38958 *
38959 * @param string $unescaped_string The string that is to be escaped.
38960 * @return string
38961 * @since PHP 4 >= 4.0.3, PHP 5
38962 **/
38963function mysql_escape_string($unescaped_string){}
38964
38965/**
38966 * Returns an array that corresponds to the fetched row and moves the
38967 * internal data pointer ahead.
38968 *
38969 * @param resource $result The type of array that is to be fetched.
38970 *   It's a constant and can take the following values: MYSQL_ASSOC,
38971 *   MYSQL_NUM, and MYSQL_BOTH.
38972 * @param int $result_type
38973 * @return array
38974 * @since PHP 4, PHP 5
38975 **/
38976function mysql_fetch_array($result, $result_type){}
38977
38978/**
38979 * Returns an associative array that corresponds to the fetched row and
38980 * moves the internal data pointer ahead. {@link mysql_fetch_assoc} is
38981 * equivalent to calling {@link mysql_fetch_array} with MYSQL_ASSOC for
38982 * the optional second parameter. It only returns an associative array.
38983 *
38984 * @param resource $result
38985 * @return array
38986 * @since PHP 4 >= 4.0.3, PHP 5
38987 **/
38988function mysql_fetch_assoc($result){}
38989
38990/**
38991 * Returns an object containing field information. This function can be
38992 * used to obtain information about fields in the provided query result.
38993 *
38994 * @param resource $result The numerical field offset. If the field
38995 *   offset is not specified, the next field that was not yet retrieved
38996 *   by this function is retrieved. The {@link field_offset} starts at 0.
38997 * @param int $field_offset
38998 * @return object
38999 * @since PHP 4, PHP 5
39000 **/
39001function mysql_fetch_field($result, $field_offset){}
39002
39003/**
39004 * Returns an array that corresponds to the lengths of each field in the
39005 * last row fetched by MySQL.
39006 *
39007 * {@link mysql_fetch_lengths} stores the lengths of each result column
39008 * in the last row returned by {@link mysql_fetch_row}, {@link
39009 * mysql_fetch_assoc}, {@link mysql_fetch_array}, and {@link
39010 * mysql_fetch_object} in an array, starting at offset 0.
39011 *
39012 * @param resource $result
39013 * @return array
39014 * @since PHP 4, PHP 5
39015 **/
39016function mysql_fetch_lengths($result){}
39017
39018/**
39019 * Returns an object with properties that correspond to the fetched row
39020 * and moves the internal data pointer ahead.
39021 *
39022 * @param resource $result The name of the class to instantiate, set
39023 *   the properties of and return. If not specified, a stdClass object is
39024 *   returned.
39025 * @param string $class_name An optional array of parameters to pass to
39026 *   the constructor for {@link class_name} objects.
39027 * @param array $params
39028 * @return object
39029 * @since PHP 4, PHP 5
39030 **/
39031function mysql_fetch_object($result, $class_name, $params){}
39032
39033/**
39034 * Returns a numerical array that corresponds to the fetched row and
39035 * moves the internal data pointer ahead.
39036 *
39037 * @param resource $result
39038 * @return array
39039 * @since PHP 4, PHP 5
39040 **/
39041function mysql_fetch_row($result){}
39042
39043/**
39044 * {@link mysql_field_flags} returns the field flags of the specified
39045 * field. The flags are reported as a single word per flag separated by a
39046 * single space, so that you can split the returned value using {@link
39047 * explode}.
39048 *
39049 * @param resource $result
39050 * @param int $field_offset
39051 * @return string
39052 * @since PHP 4, PHP 5
39053 **/
39054function mysql_field_flags($result, $field_offset){}
39055
39056/**
39057 * {@link mysql_field_len} returns the length of the specified field.
39058 *
39059 * @param resource $result
39060 * @param int $field_offset
39061 * @return int
39062 * @since PHP 4, PHP 5
39063 **/
39064function mysql_field_len($result, $field_offset){}
39065
39066/**
39067 * {@link mysql_field_name} returns the name of the specified field
39068 * index.
39069 *
39070 * @param resource $result
39071 * @param int $field_offset
39072 * @return string
39073 * @since PHP 4, PHP 5
39074 **/
39075function mysql_field_name($result, $field_offset){}
39076
39077/**
39078 * Seeks to the specified field offset. If the next call to {@link
39079 * mysql_fetch_field} doesn't include a field offset, the field offset
39080 * specified in {@link mysql_field_seek} will be returned.
39081 *
39082 * @param resource $result
39083 * @param int $field_offset
39084 * @return bool
39085 * @since PHP 4, PHP 5
39086 **/
39087function mysql_field_seek($result, $field_offset){}
39088
39089/**
39090 * Returns the name of the table that the specified field is in.
39091 *
39092 * @param resource $result
39093 * @param int $field_offset
39094 * @return string
39095 * @since PHP 4, PHP 5
39096 **/
39097function mysql_field_table($result, $field_offset){}
39098
39099/**
39100 * {@link mysql_field_type} is similar to the {@link mysql_field_name}
39101 * function. The arguments are identical, but the field type is returned
39102 * instead.
39103 *
39104 * @param resource $result
39105 * @param int $field_offset
39106 * @return string
39107 * @since PHP 4, PHP 5
39108 **/
39109function mysql_field_type($result, $field_offset){}
39110
39111/**
39112 * {@link mysql_free_result} will free all memory associated with the
39113 * result identifier {@link result}.
39114 *
39115 * {@link mysql_free_result} only needs to be called if you are concerned
39116 * about how much memory is being used for queries that return large
39117 * result sets. All associated result memory is automatically freed at
39118 * the end of the script's execution.
39119 *
39120 * @param resource $result
39121 * @return bool
39122 * @since PHP 4, PHP 5
39123 **/
39124function mysql_free_result($result){}
39125
39126/**
39127 * {@link mysql_get_client_info} returns a string that represents the
39128 * client library version.
39129 *
39130 * @return string
39131 * @since PHP 4 >= 4.0.5, PHP 5
39132 **/
39133function mysql_get_client_info(){}
39134
39135/**
39136 * Describes the type of connection in use for the connection, including
39137 * the server host name.
39138 *
39139 * @param resource $link_identifier
39140 * @return string
39141 * @since PHP 4 >= 4.0.5, PHP 5
39142 **/
39143function mysql_get_host_info($link_identifier){}
39144
39145/**
39146 * Retrieves the MySQL protocol.
39147 *
39148 * @param resource $link_identifier
39149 * @return int
39150 * @since PHP 4 >= 4.0.5, PHP 5
39151 **/
39152function mysql_get_proto_info($link_identifier){}
39153
39154/**
39155 * Retrieves the MySQL server version.
39156 *
39157 * @param resource $link_identifier
39158 * @return string
39159 * @since PHP 4 >= 4.0.5, PHP 5
39160 **/
39161function mysql_get_server_info($link_identifier){}
39162
39163/**
39164 * Returns detailed information about the last query.
39165 *
39166 * @param resource $link_identifier
39167 * @return string
39168 * @since PHP 4 >= 4.3.0, PHP 5
39169 **/
39170function mysql_info($link_identifier){}
39171
39172/**
39173 * Retrieves the ID generated for an AUTO_INCREMENT column by the
39174 * previous query (usually INSERT).
39175 *
39176 * @param resource $link_identifier
39177 * @return int
39178 * @since PHP 4, PHP 5
39179 **/
39180function mysql_insert_id($link_identifier){}
39181
39182/**
39183 * Returns a result pointer containing the databases available from the
39184 * current mysql daemon.
39185 *
39186 * @param resource $link_identifier
39187 * @return resource
39188 * @since PHP 4, PHP 5
39189 **/
39190function mysql_list_dbs($link_identifier){}
39191
39192/**
39193 * Retrieves information about the given table name.
39194 *
39195 * This function is deprecated. It is preferable to use {@link
39196 * mysql_query} to issue an SQL SHOW COLUMNS FROM table [LIKE 'name']
39197 * statement instead.
39198 *
39199 * @param string $database_name The name of the database that's being
39200 *   queried.
39201 * @param string $table_name The name of the table that's being
39202 *   queried.
39203 * @param resource $link_identifier
39204 * @return resource
39205 * @since PHP 4, PHP 5
39206 **/
39207function mysql_list_fields($database_name, $table_name, $link_identifier){}
39208
39209/**
39210 * Retrieves the current MySQL server threads.
39211 *
39212 * @param resource $link_identifier
39213 * @return resource
39214 * @since PHP 4 >= 4.3.0, PHP 5
39215 **/
39216function mysql_list_processes($link_identifier){}
39217
39218/**
39219 * Retrieves a list of table names from a MySQL database.
39220 *
39221 * This function is deprecated. It is preferable to use {@link
39222 * mysql_query} to issue an SQL SHOW TABLES [FROM db_name] [LIKE
39223 * 'pattern'] statement instead.
39224 *
39225 * @param string $database The name of the database
39226 * @param resource $link_identifier
39227 * @return resource
39228 * @since PHP 4, PHP 5
39229 **/
39230function mysql_list_tables($database, $link_identifier){}
39231
39232/**
39233 * Retrieves the number of fields from a query.
39234 *
39235 * @param resource $result
39236 * @return int
39237 * @since PHP 4, PHP 5
39238 **/
39239function mysql_num_fields($result){}
39240
39241/**
39242 * Retrieves the number of rows from a result set. This command is only
39243 * valid for statements like SELECT or SHOW that return an actual result
39244 * set. To retrieve the number of rows affected by a INSERT, UPDATE,
39245 * REPLACE or DELETE query, use {@link mysql_affected_rows}.
39246 *
39247 * @param resource $result
39248 * @return int
39249 * @since PHP 4, PHP 5
39250 **/
39251function mysql_num_rows($result){}
39252
39253/**
39254 * Establishes a persistent connection to a MySQL server.
39255 *
39256 * {@link mysql_pconnect} acts very much like {@link mysql_connect} with
39257 * two major differences.
39258 *
39259 * First, when connecting, the function would first try to find a
39260 * (persistent) link that's already open with the same host, username and
39261 * password. If one is found, an identifier for it will be returned
39262 * instead of opening a new connection.
39263 *
39264 * Second, the connection to the SQL server will not be closed when the
39265 * execution of the script ends. Instead, the link will remain open for
39266 * future use ({@link mysql_close} will not close links established by
39267 * {@link mysql_pconnect}).
39268 *
39269 * This type of link is therefore called 'persistent'.
39270 *
39271 * @param string $server The MySQL server. It can also include a port
39272 *   number. e.g. "hostname:port" or a path to a local socket e.g.
39273 *   ":/path/to/socket" for the localhost. If the PHP directive
39274 *   mysql.default_host is undefined (default), then the default value is
39275 *   'localhost:3306'
39276 * @param string $username The username. Default value is the name of
39277 *   the user that owns the server process.
39278 * @param string $password The password. Default value is an empty
39279 *   password.
39280 * @param int $client_flags The {@link client_flags} parameter can be a
39281 *   combination of the following constants: 128 (enable LOAD DATA LOCAL
39282 *   handling), MYSQL_CLIENT_SSL, MYSQL_CLIENT_COMPRESS,
39283 *   MYSQL_CLIENT_IGNORE_SPACE or MYSQL_CLIENT_INTERACTIVE.
39284 * @return resource
39285 * @since PHP 4, PHP 5
39286 **/
39287function mysql_pconnect($server, $username, $password, $client_flags){}
39288
39289/**
39290 * Checks whether or not the connection to the server is working. If it
39291 * has gone down, an automatic reconnection is attempted. This function
39292 * can be used by scripts that remain idle for a long while, to check
39293 * whether or not the server has closed the connection and reconnect if
39294 * necessary.
39295 *
39296 * @param resource $link_identifier
39297 * @return bool
39298 * @since PHP 4 >= 4.3.0, PHP 5
39299 **/
39300function mysql_ping($link_identifier){}
39301
39302/**
39303 * {@link mysql_query} sends a unique query (multiple queries are not
39304 * supported) to the currently active database on the server that's
39305 * associated with the specified {@link link_identifier}.
39306 *
39307 * @param string $query An SQL query The query string should not end
39308 *   with a semicolon. Data inside the query should be properly escaped.
39309 * @param resource $link_identifier
39310 * @return resource
39311 * @since PHP 4, PHP 5
39312 **/
39313function mysql_query($query, $link_identifier){}
39314
39315/**
39316 * Escapes special characters in the {@link unescaped_string}, taking
39317 * into account the current character set of the connection so that it is
39318 * safe to place it in a {@link mysql_query}. If binary data is to be
39319 * inserted, this function must be used.
39320 *
39321 * {@link mysql_real_escape_string} calls MySQL's library function
39322 * mysql_real_escape_string, which prepends backslashes to the following
39323 * characters: \x00, \n, \r, \, ', " and \x1a.
39324 *
39325 * This function must always (with few exceptions) be used to make data
39326 * safe before sending a query to MySQL.
39327 *
39328 * @param string $unescaped_string The string that is to be escaped.
39329 * @param resource $link_identifier
39330 * @return string
39331 * @since PHP 4 >= 4.3.0, PHP 5
39332 **/
39333function mysql_real_escape_string($unescaped_string, $link_identifier){}
39334
39335/**
39336 * Retrieves the contents of one cell from a MySQL result set.
39337 *
39338 * When working on large result sets, you should consider using one of
39339 * the functions that fetch an entire row (specified below). As these
39340 * functions return the contents of multiple cells in one function call,
39341 * they're MUCH quicker than {@link mysql_result}. Also, note that
39342 * specifying a numeric offset for the field argument is much quicker
39343 * than specifying a fieldname or tablename.fieldname argument.
39344 *
39345 * @param resource $result The row number from the result that's being
39346 *   retrieved. Row numbers start at 0.
39347 * @param int $row The name or offset of the field being retrieved. It
39348 *   can be the field's offset, the field's name, or the field's table
39349 *   dot field name (tablename.fieldname). If the column name has been
39350 *   aliased ('select foo as bar from...'), use the alias instead of the
39351 *   column name. If undefined, the first field is retrieved.
39352 * @param mixed $field
39353 * @return string
39354 * @since PHP 4, PHP 5
39355 **/
39356function mysql_result($result, $row, $field){}
39357
39358/**
39359 * Sets the current active database on the server that's associated with
39360 * the specified link identifier. Every subsequent call to {@link
39361 * mysql_query} will be made on the active database.
39362 *
39363 * @param string $database_name The name of the database that is to be
39364 *   selected.
39365 * @param resource $link_identifier
39366 * @return bool
39367 * @since PHP 4, PHP 5
39368 **/
39369function mysql_select_db($database_name, $link_identifier){}
39370
39371/**
39372 * Sets the default character set for the current connection.
39373 *
39374 * @param string $charset A valid character set name.
39375 * @param resource $link_identifier
39376 * @return bool
39377 * @since PHP 5 >= 5.2.3
39378 **/
39379function mysql_set_charset($charset, $link_identifier){}
39380
39381/**
39382 * {@link mysql_stat} returns the current server status.
39383 *
39384 * @param resource $link_identifier
39385 * @return string
39386 * @since PHP 4 >= 4.3.0, PHP 5
39387 **/
39388function mysql_stat($link_identifier){}
39389
39390/**
39391 * Retrieves the table name from a {@link result}.
39392 *
39393 * This function deprecated. It is preferable to use {@link mysql_query}
39394 * to issue an SQL SHOW TABLES [FROM db_name] [LIKE 'pattern'] statement
39395 * instead.
39396 *
39397 * @param resource $result A result pointer resource that's returned
39398 *   from {@link mysql_list_tables}.
39399 * @param int $i The integer index (row/table number)
39400 * @return string
39401 * @since PHP 4, PHP 5
39402 **/
39403function mysql_tablename($result, $i){}
39404
39405/**
39406 * Retrieves the current thread ID. If the connection is lost, and a
39407 * reconnect with {@link mysql_ping} is executed, the thread ID will
39408 * change. This means only retrieve the thread ID when needed.
39409 *
39410 * @param resource $link_identifier
39411 * @return int
39412 * @since PHP 4 >= 4.3.0, PHP 5
39413 **/
39414function mysql_thread_id($link_identifier){}
39415
39416/**
39417 * {@link mysql_unbuffered_query} sends the SQL query {@link query} to
39418 * MySQL without automatically fetching and buffering the result rows as
39419 * {@link mysql_query} does. This saves a considerable amount of memory
39420 * with SQL queries that produce large result sets, and you can start
39421 * working on the result set immediately after the first row has been
39422 * retrieved as you don't have to wait until the complete SQL query has
39423 * been performed. To use {@link mysql_unbuffered_query} while multiple
39424 * database connections are open, you must specify the optional parameter
39425 * {@link link_identifier} to identify which connection you want to use.
39426 *
39427 * @param string $query The SQL query to execute. Data inside the query
39428 *   should be properly escaped.
39429 * @param resource $link_identifier
39430 * @return resource
39431 * @since PHP 4 >= 4.0.6, PHP 5
39432 **/
39433function mysql_unbuffered_query($query, $link_identifier){}
39434
39435/**
39436 * @param resource $conn
39437 * @param int $identifier
39438 * @return int
39439 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39440 **/
39441function m_checkstatus($conn, $identifier){}
39442
39443/**
39444 * @param resource $conn Its description
39445 * @param int $array
39446 * @return int
39447 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39448 **/
39449function m_completeauthorizations($conn, &$array){}
39450
39451/**
39452 * @param resource $conn
39453 * @return int
39454 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39455 **/
39456function m_connect($conn){}
39457
39458/**
39459 * @param resource $conn
39460 * @return string
39461 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39462 **/
39463function m_connectionerror($conn){}
39464
39465/**
39466 * @param resource $conn
39467 * @param int $identifier
39468 * @return bool
39469 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39470 **/
39471function m_deletetrans($conn, $identifier){}
39472
39473/**
39474 * @param resource $conn
39475 * @return bool
39476 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39477 **/
39478function m_destroyconn($conn){}
39479
39480/**
39481 * @return void
39482 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39483 **/
39484function m_destroyengine(){}
39485
39486/**
39487 * @param resource $conn
39488 * @param int $identifier
39489 * @param string $column
39490 * @param int $row
39491 * @return string
39492 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39493 **/
39494function m_getcell($conn, $identifier, $column, $row){}
39495
39496/**
39497 * @param resource $conn
39498 * @param int $identifier
39499 * @param int $column
39500 * @param int $row
39501 * @return string
39502 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39503 **/
39504function m_getcellbynum($conn, $identifier, $column, $row){}
39505
39506/**
39507 * @param resource $conn
39508 * @param int $identifier
39509 * @return string
39510 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39511 **/
39512function m_getcommadelimited($conn, $identifier){}
39513
39514/**
39515 * @param resource $conn
39516 * @param int $identifier
39517 * @param int $column_num
39518 * @return string
39519 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39520 **/
39521function m_getheader($conn, $identifier, $column_num){}
39522
39523/**
39524 * @return resource
39525 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39526 **/
39527function m_initconn(){}
39528
39529/**
39530 * @param string $location
39531 * @return int
39532 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39533 **/
39534function m_initengine($location){}
39535
39536/**
39537 * @param resource $conn
39538 * @param int $identifier
39539 * @return int
39540 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39541 **/
39542function m_iscommadelimited($conn, $identifier){}
39543
39544/**
39545 * @param resource $conn
39546 * @param int $secs
39547 * @return bool
39548 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39549 **/
39550function m_maxconntimeout($conn, $secs){}
39551
39552/**
39553 * @param resource $conn
39554 * @return int
39555 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39556 **/
39557function m_monitor($conn){}
39558
39559/**
39560 * @param resource $conn
39561 * @param int $identifier
39562 * @return int
39563 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39564 **/
39565function m_numcolumns($conn, $identifier){}
39566
39567/**
39568 * @param resource $conn
39569 * @param int $identifier
39570 * @return int
39571 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39572 **/
39573function m_numrows($conn, $identifier){}
39574
39575/**
39576 * @param resource $conn
39577 * @param int $identifier
39578 * @return int
39579 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39580 **/
39581function m_parsecommadelimited($conn, $identifier){}
39582
39583/**
39584 * @param resource $conn
39585 * @param int $identifier
39586 * @return array
39587 * @since PHP 5 >= 5.0.5, PECL mcve >= 1.0.0
39588 **/
39589function m_responsekeys($conn, $identifier){}
39590
39591/**
39592 * @param resource $conn
39593 * @param int $identifier
39594 * @param string $key
39595 * @return string
39596 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39597 **/
39598function m_responseparam($conn, $identifier, $key){}
39599
39600/**
39601 * @param resource $conn
39602 * @param int $identifier
39603 * @return int
39604 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39605 **/
39606function m_returnstatus($conn, $identifier){}
39607
39608/**
39609 * @param resource $conn
39610 * @param int $tf
39611 * @return int
39612 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39613 **/
39614function m_setblocking($conn, $tf){}
39615
39616/**
39617 * @param resource $conn
39618 * @param string $directory
39619 * @return int
39620 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39621 **/
39622function m_setdropfile($conn, $directory){}
39623
39624/**
39625 * @param resource $conn
39626 * @param string $host
39627 * @param int $port
39628 * @return int
39629 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39630 **/
39631function m_setip($conn, $host, $port){}
39632
39633/**
39634 * @param resource $conn
39635 * @param string $host
39636 * @param int $port
39637 * @return int
39638 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39639 **/
39640function m_setssl($conn, $host, $port){}
39641
39642/**
39643 * @param resource $conn
39644 * @param string $cafile
39645 * @return int
39646 * @since PHP 5 >= 5.0.5, PECL mcve >= 1.0.0
39647 **/
39648function m_setssl_cafile($conn, $cafile){}
39649
39650/**
39651 * @param resource $conn
39652 * @param string $sslkeyfile
39653 * @param string $sslcertfile
39654 * @return int
39655 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39656 **/
39657function m_setssl_files($conn, $sslkeyfile, $sslcertfile){}
39658
39659/**
39660 * @param resource $conn
39661 * @param int $seconds
39662 * @return int
39663 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39664 **/
39665function m_settimeout($conn, $seconds){}
39666
39667/**
39668 * @param string $filename
39669 * @return string
39670 * @since PECL mcve >= 5.2.0
39671 **/
39672function m_sslcert_gen_hash($filename){}
39673
39674/**
39675 * @param resource $conn
39676 * @return int
39677 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39678 **/
39679function m_transactionssent($conn){}
39680
39681/**
39682 * @param resource $conn
39683 * @return int
39684 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39685 **/
39686function m_transinqueue($conn){}
39687
39688/**
39689 * @param resource $conn
39690 * @param int $identifier
39691 * @param string $key
39692 * @param string $value
39693 * @return int
39694 * @since PHP 5 >= 5.0.5, PECL mcve >= 1.0.0
39695 **/
39696function m_transkeyval($conn, $identifier, $key, $value){}
39697
39698/**
39699 * @param resource $conn
39700 * @return int
39701 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39702 **/
39703function m_transnew($conn){}
39704
39705/**
39706 * @param resource $conn
39707 * @param int $identifier
39708 * @return int
39709 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39710 **/
39711function m_transsend($conn, $identifier){}
39712
39713/**
39714 * @param int $microsecs
39715 * @return int
39716 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39717 **/
39718function m_uwait($microsecs){}
39719
39720/**
39721 * @param resource $conn
39722 * @param int $tf
39723 * @return int
39724 * @since PHP 5 >= 5.0.5, PECL mcve >= 1.0.0
39725 **/
39726function m_validateidentifier($conn, $tf){}
39727
39728/**
39729 * @param resource $conn
39730 * @param int $tf
39731 * @return bool
39732 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39733 **/
39734function m_verifyconnection($conn, $tf){}
39735
39736/**
39737 * @param resource $conn
39738 * @param int $tf
39739 * @return bool
39740 * @since PHP 4 >= 4.3.9, PHP 5 = 1.0.0
39741 **/
39742function m_verifysslcert($conn, $tf){}
39743
39744/**
39745 * {@link natcasesort} is a case insensitive version of {@link natsort}.
39746 *
39747 * This function implements a sort algorithm that orders alphanumeric
39748 * strings in the way a human being would while maintaining key/value
39749 * associations. This is described as a "natural ordering".
39750 *
39751 * @param array $array The input array.
39752 * @return bool
39753 * @since PHP 4, PHP 5
39754 **/
39755function natcasesort(&$array){}
39756
39757/**
39758 * This function implements a sort algorithm that orders alphanumeric
39759 * strings in the way a human being would while maintaining key/value
39760 * associations. This is described as a "natural ordering". An example of
39761 * the difference between this algorithm and the regular computer string
39762 * sorting algorithms (used in {@link sort}) can be seen in the example
39763 * below.
39764 *
39765 * @param array $array The input array.
39766 * @return bool
39767 * @since PHP 4, PHP 5
39768 **/
39769function natsort(&$array){}
39770
39771/**
39772 * @param int $ch
39773 * @return int
39774 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39775 **/
39776function ncurses_addch($ch){}
39777
39778/**
39779 * @param string $s
39780 * @param int $n
39781 * @return int
39782 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39783 **/
39784function ncurses_addchnstr($s, $n){}
39785
39786/**
39787 * @param string $s
39788 * @return int
39789 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39790 **/
39791function ncurses_addchstr($s){}
39792
39793/**
39794 * @param string $s
39795 * @param int $n
39796 * @return int
39797 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39798 **/
39799function ncurses_addnstr($s, $n){}
39800
39801/**
39802 * @param string $text
39803 * @return int
39804 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39805 **/
39806function ncurses_addstr($text){}
39807
39808/**
39809 * @param int $fg
39810 * @param int $bg
39811 * @return int
39812 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39813 **/
39814function ncurses_assume_default_colors($fg, $bg){}
39815
39816/**
39817 * @param int $attributes
39818 * @return int
39819 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39820 **/
39821function ncurses_attroff($attributes){}
39822
39823/**
39824 * @param int $attributes
39825 * @return int
39826 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39827 **/
39828function ncurses_attron($attributes){}
39829
39830/**
39831 * @param int $attributes
39832 * @return int
39833 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39834 **/
39835function ncurses_attrset($attributes){}
39836
39837/**
39838 * @return int
39839 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39840 **/
39841function ncurses_baudrate(){}
39842
39843/**
39844 * {@link ncurses_beep} sends an audible alert (bell) and if its not
39845 * possible flashes the screen.
39846 *
39847 * @return int
39848 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39849 **/
39850function ncurses_beep(){}
39851
39852/**
39853 * @param int $attrchar
39854 * @return int
39855 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39856 **/
39857function ncurses_bkgd($attrchar){}
39858
39859/**
39860 * @param int $attrchar
39861 * @return void
39862 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39863 **/
39864function ncurses_bkgdset($attrchar){}
39865
39866/**
39867 * Draws the specified lines and corners around the main window.
39868 *
39869 * Use {@link ncurses_wborder} for borders around subwindows!
39870 *
39871 * @param int $left
39872 * @param int $right
39873 * @param int $top
39874 * @param int $bottom
39875 * @param int $tl_corner Top left corner
39876 * @param int $tr_corner Top right corner
39877 * @param int $bl_corner Bottom left corner
39878 * @param int $br_corner Bottom right corner
39879 * @return int
39880 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39881 **/
39882function ncurses_border($left, $right, $top, $bottom, $tl_corner, $tr_corner, $bl_corner, $br_corner){}
39883
39884/**
39885 * @param resource $panel
39886 * @return int
39887 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39888 **/
39889function ncurses_bottom_panel($panel){}
39890
39891/**
39892 * Checks whether the terminal has color capabilities and whether the
39893 * programmer can change color definitions using {@link
39894 * ncurses_init_color}. ncurses must be initialized using {@link
39895 * ncurses_init} before calling this function.
39896 *
39897 * @return bool
39898 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39899 **/
39900function ncurses_can_change_color(){}
39901
39902/**
39903 * Disables line buffering and character processing (interrupt and flow
39904 * control characters are unaffected), making characters typed by the
39905 * user immediately available to the program.
39906 *
39907 * @return bool
39908 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39909 **/
39910function ncurses_cbreak(){}
39911
39912/**
39913 * Clears the screen completely without setting blanks.
39914 *
39915 * Note: {@link ncurses_clear} clears the screen without setting blanks,
39916 * which have the current background rendition. To clear screen with
39917 * blanks, use {@link ncurses_erase}.
39918 *
39919 * @return bool
39920 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39921 **/
39922function ncurses_clear(){}
39923
39924/**
39925 * Erases all lines from cursor to end of screen and creates blanks.
39926 * Blanks created by {@link ncurses_clrtobot} have the current background
39927 * rendition.
39928 *
39929 * @return bool
39930 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39931 **/
39932function ncurses_clrtobot(){}
39933
39934/**
39935 * Erases the current line from cursor position to the end. Blanks
39936 * created by {@link ncurses_clrtoeol} have the current background
39937 * rendition.
39938 *
39939 * @return bool
39940 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39941 **/
39942function ncurses_clrtoeol(){}
39943
39944/**
39945 * Retrieves the red, green, and blue components for the given color
39946 * definition. Terminal color capabilities must be initialized with
39947 * {@link ncurses_start_color} prior to calling this function.
39948 *
39949 * @param int $color The number of the color to retrieve information
39950 *   for. May be one of the pre-defined color constants.
39951 * @param int $r A reference to which to return the red component of
39952 *   the color. The value returned to the reference will be between 0 and
39953 *   1000.
39954 * @param int $g A reference to which to return the green component of
39955 *   the color. The value returned to the reference will be between 0 and
39956 *   1000.
39957 * @param int $b A reference to which to return the blue component of
39958 *   the color. The value returned to the reference will be between 0 and
39959 *   1000.
39960 * @return int
39961 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39962 **/
39963function ncurses_color_content($color, &$r, &$g, &$b){}
39964
39965/**
39966 * Sets the active foreground and background colors. Any characters
39967 * written after this function is invoked will have these colors. This
39968 * function requires terminal colors to be supported and initialized
39969 * using {@link ncurses_start_color} beforehand.
39970 *
39971 * ncurses uses color pairs to specify both foreground and background
39972 * colors. Use {@link ncurses_init_pair} to define a color pair.
39973 *
39974 * @param int $pair The color pair from which to get the foreground and
39975 *   background colors to set as the active colors.
39976 * @return int
39977 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39978 **/
39979function ncurses_color_set($pair){}
39980
39981/**
39982 * @param int $visibility
39983 * @return int
39984 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39985 **/
39986function ncurses_curs_set($visibility){}
39987
39988/**
39989 * @param string $definition
39990 * @param int $keycode
39991 * @return int
39992 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
39993 **/
39994function ncurses_define_key($definition, $keycode){}
39995
39996/**
39997 * Saves the current terminal modes for program (in curses) for use by
39998 * {@link ncurses_reset_prog_mode}.
39999 *
40000 * @return bool
40001 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40002 **/
40003function ncurses_def_prog_mode(){}
40004
40005/**
40006 * Saves the current terminal modes for shell (not in curses) for use by
40007 * {@link ncurses_reset_shell_mode}.
40008 *
40009 * @return bool
40010 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40011 **/
40012function ncurses_def_shell_mode(){}
40013
40014/**
40015 * @param int $milliseconds
40016 * @return int
40017 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40018 **/
40019function ncurses_delay_output($milliseconds){}
40020
40021/**
40022 * Deletes the character under the cursor. All characters to the right of
40023 * the cursor on the same line are moved to the left one position and the
40024 * last character on the line is filled with a blank. The cursor position
40025 * does not change.
40026 *
40027 * @return bool
40028 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40029 **/
40030function ncurses_delch(){}
40031
40032/**
40033 * Deletes the current line under cursorposition. All lines below the
40034 * current line are moved up one line. The bottom line of window is
40035 * cleared. Cursor position does not change.
40036 *
40037 * @return bool
40038 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40039 **/
40040function ncurses_deleteln(){}
40041
40042/**
40043 * @param resource $window
40044 * @return bool
40045 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40046 **/
40047function ncurses_delwin($window){}
40048
40049/**
40050 * @param resource $panel
40051 * @return bool
40052 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40053 **/
40054function ncurses_del_panel($panel){}
40055
40056/**
40057 * Compares the virtual screen to the physical screen and updates the
40058 * physical screen. This way is more effective than using multiple
40059 * refresh calls.
40060 *
40061 * @return bool
40062 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40063 **/
40064function ncurses_doupdate(){}
40065
40066/**
40067 * Enables echo mode. All characters typed by user are echoed by {@link
40068 * ncurses_getch}.
40069 *
40070 * @return bool
40071 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40072 **/
40073function ncurses_echo(){}
40074
40075/**
40076 * @param int $character
40077 * @return int
40078 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40079 **/
40080function ncurses_echochar($character){}
40081
40082/**
40083 * @return int
40084 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40085 **/
40086function ncurses_end(){}
40087
40088/**
40089 * Fills the terminal screen with blanks.
40090 *
40091 * Created blanks have the current background rendition, set by {@link
40092 * ncurses_bkgd}.
40093 *
40094 * @return bool
40095 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40096 **/
40097function ncurses_erase(){}
40098
40099/**
40100 * Returns the current erase character.
40101 *
40102 * @return string
40103 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40104 **/
40105function ncurses_erasechar(){}
40106
40107/**
40108 * @return void
40109 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40110 **/
40111function ncurses_filter(){}
40112
40113/**
40114 * Flashes the screen, and if its not possible, sends an audible alert
40115 * (bell).
40116 *
40117 * @return bool
40118 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40119 **/
40120function ncurses_flash(){}
40121
40122/**
40123 * Throws away any typeahead that has been typed and has not yet been
40124 * read by your program.
40125 *
40126 * @return bool
40127 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40128 **/
40129function ncurses_flushinp(){}
40130
40131/**
40132 * @return int
40133 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40134 **/
40135function ncurses_getch(){}
40136
40137/**
40138 * Gets the horizontal and vertical size of the given {@link window} into
40139 * the given variables.
40140 *
40141 * Variables must be passed as reference, so they are updated when the
40142 * user changes the terminal size.
40143 *
40144 * @param resource $window The measured window
40145 * @param int $y This will be set to the window width
40146 * @param int $x This will be set to the window height
40147 * @return void
40148 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40149 **/
40150function ncurses_getmaxyx($window, &$y, &$x){}
40151
40152/**
40153 * {@link ncurses_getmouse} reads mouse event out of queue.
40154 *
40155 * @param array $mevent Event options will be delivered in this
40156 *   parameter which has to be an array, passed by reference (see example
40157 *   below). On success an associative array with following keys will be
40158 *   delivered: "id" : Id to distinguish multiple devices "x" : screen
40159 *   relative x-position in character cells "y" : screen relative
40160 *   y-position in character cells "z" : currently not supported "mmask"
40161 *   : Mouse action
40162 * @return bool
40163 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40164 **/
40165function ncurses_getmouse(&$mevent){}
40166
40167/**
40168 * @param resource $window
40169 * @param int $y
40170 * @param int $x
40171 * @return void
40172 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40173 **/
40174function ncurses_getyx($window, &$y, &$x){}
40175
40176/**
40177 * @param int $tenth
40178 * @return int
40179 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40180 **/
40181function ncurses_halfdelay($tenth){}
40182
40183/**
40184 * Checks whether the terminal has color capabilities. This function can
40185 * be used to write terminal-independent programs. ncurses must be
40186 * initialized using {@link ncurses_init} before calling this function.
40187 *
40188 * @return bool
40189 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40190 **/
40191function ncurses_has_colors(){}
40192
40193/**
40194 * Checks whether the terminal has insert and delete capabilities.
40195 *
40196 * @return bool
40197 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40198 **/
40199function ncurses_has_ic(){}
40200
40201/**
40202 * Checks whether the terminal has insert- and delete-line-capabilities.
40203 *
40204 * @return bool
40205 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40206 **/
40207function ncurses_has_il(){}
40208
40209/**
40210 * @param int $keycode
40211 * @return int
40212 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40213 **/
40214function ncurses_has_key($keycode){}
40215
40216/**
40217 * @param resource $panel
40218 * @return int
40219 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40220 **/
40221function ncurses_hide_panel($panel){}
40222
40223/**
40224 * @param int $charattr
40225 * @param int $n
40226 * @return int
40227 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40228 **/
40229function ncurses_hline($charattr, $n){}
40230
40231/**
40232 * Returns the character from the current position.
40233 *
40234 * @return string
40235 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40236 **/
40237function ncurses_inch(){}
40238
40239/**
40240 * Initializes the ncurses interface. This function must be used before
40241 * any other ncurses function call.
40242 *
40243 * Note that {@link ncurses_end} must be called before exiting from the
40244 * program, or the terminal will not be restored to its proper non-visual
40245 * mode.
40246 *
40247 * @return void
40248 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40249 **/
40250function ncurses_init(){}
40251
40252/**
40253 * Defines or redefines the given color. When this function is called,
40254 * all occurrences of the given color on the screen, if any, immediately
40255 * change to the new definition.
40256 *
40257 * Color capabilities must be supported by the terminal and initialized
40258 * using {@link ncurses_start_color} prior to calling this function. In
40259 * addition, the terminal must have color changing capabilities; use
40260 * {@link ncurses_can_change_color} to check for this.
40261 *
40262 * @param int $color The identification number of the color to
40263 *   redefine. It may be one of the default color constants.
40264 * @param int $r A color value, between 0 and 1000, for the red
40265 *   component.
40266 * @param int $g A color value, between 0 and 1000, for the green
40267 *   component.
40268 * @param int $b A color value, between 0 and 1000, for the blue
40269 *   component.
40270 * @return int
40271 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40272 **/
40273function ncurses_init_color($color, $r, $g, $b){}
40274
40275/**
40276 * Defines or redefines the given color pair to have the given foreground
40277 * and background colors. If the color pair was previously initialized,
40278 * the screen is refreshed and all occurrences of it are changed to
40279 * reflect the new definition.
40280 *
40281 * Color capabilities must be initialized using {@link
40282 * ncurses_start_color} before calling this function. The first color
40283 * pair (color pair 0) is assumed to be white on black by default, but
40284 * can be changed using {@link ncurses_assume_default_colors}.
40285 *
40286 * @param int $pair The number of the color pair to define.
40287 * @param int $fg The foreground color for the color pair. May be one
40288 *   of the pre-defined colors or one defined by {@link
40289 *   ncurses_init_color} if the terminal has color changing capabilities.
40290 * @param int $bg The background color for the color pair. May be one
40291 *   of the pre-defined colors or one defined by {@link
40292 *   ncurses_init_color} if the terminal has color changing capabilities.
40293 * @return int
40294 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40295 **/
40296function ncurses_init_pair($pair, $fg, $bg){}
40297
40298/**
40299 * @param int $character
40300 * @return int
40301 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40302 **/
40303function ncurses_insch($character){}
40304
40305/**
40306 * @param int $count
40307 * @return int
40308 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40309 **/
40310function ncurses_insdelln($count){}
40311
40312/**
40313 * Inserts a new line above the current line. The bottom line will be
40314 * lost.
40315 *
40316 * @return int
40317 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40318 **/
40319function ncurses_insertln(){}
40320
40321/**
40322 * @param string $text
40323 * @return int
40324 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40325 **/
40326function ncurses_insstr($text){}
40327
40328/**
40329 * Reads a string from the terminal screen and returns the number of
40330 * characters read from the current character position until end of line.
40331 *
40332 * @param string $buffer The characters. Attributes will be stripped.
40333 * @return int
40334 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40335 **/
40336function ncurses_instr(&$buffer){}
40337
40338/**
40339 * Checks if ncurses is in endwin mode.
40340 *
40341 * @return bool
40342 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40343 **/
40344function ncurses_isendwin(){}
40345
40346/**
40347 * @param int $keycode
40348 * @param bool $enable
40349 * @return int
40350 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40351 **/
40352function ncurses_keyok($keycode, $enable){}
40353
40354/**
40355 * @param resource $window
40356 * @param bool $bf
40357 * @return int
40358 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40359 **/
40360function ncurses_keypad($window, $bf){}
40361
40362/**
40363 * Returns the current line kill character.
40364 *
40365 * @return string
40366 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40367 **/
40368function ncurses_killchar(){}
40369
40370/**
40371 * Returns a verbose description of the terminal.
40372 *
40373 * @return string
40374 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40375 **/
40376function ncurses_longname(){}
40377
40378/**
40379 * @param resource $window
40380 * @param bool $_8bit
40381 * @return int
40382 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40383 **/
40384function ncurses_meta($window, $_8bit){}
40385
40386/**
40387 * @param int $milliseconds
40388 * @return int
40389 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40390 **/
40391function ncurses_mouseinterval($milliseconds){}
40392
40393/**
40394 * Sets mouse events to be reported. By default no mouse events will be
40395 * reported.
40396 *
40397 * Mouse events are represented by NCURSES_KEY_MOUSE in the {@link
40398 * ncurses_wgetch} input stream. To read the event data and pop the event
40399 * of queue, call {@link ncurses_getmouse}.
40400 *
40401 * @param int $newmask Mouse mask options can be set with the following
40402 *   predefined constants: NCURSES_BUTTON1_PRESSED
40403 *   NCURSES_BUTTON1_RELEASED NCURSES_BUTTON1_CLICKED
40404 *   NCURSES_BUTTON1_DOUBLE_CLICKED NCURSES_BUTTON1_TRIPLE_CLICKED
40405 *   NCURSES_BUTTON2_PRESSED NCURSES_BUTTON2_RELEASED
40406 *   NCURSES_BUTTON2_CLICKED NCURSES_BUTTON2_DOUBLE_CLICKED
40407 *   NCURSES_BUTTON2_TRIPLE_CLICKED NCURSES_BUTTON3_PRESSED
40408 *   NCURSES_BUTTON3_RELEASED NCURSES_BUTTON3_CLICKED
40409 *   NCURSES_BUTTON3_DOUBLE_CLICKED NCURSES_BUTTON3_TRIPLE_CLICKED
40410 *   NCURSES_BUTTON4_PRESSED NCURSES_BUTTON4_RELEASED
40411 *   NCURSES_BUTTON4_CLICKED NCURSES_BUTTON4_DOUBLE_CLICKED
40412 *   NCURSES_BUTTON4_TRIPLE_CLICKED NCURSES_BUTTON_SHIFT>
40413 *   NCURSES_BUTTON_CTRL NCURSES_BUTTON_ALT NCURSES_ALL_MOUSE_EVENTS
40414 *   NCURSES_REPORT_MOUSE_POSITION As a side effect, setting a zero
40415 *   mousemask in {@link newmask} turns off the mouse pointer. Setting a
40416 *   non zero value turns mouse pointer on.
40417 * @param int $oldmask This will be set to the previous value of the
40418 *   mouse event mask.
40419 * @return int
40420 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40421 **/
40422function ncurses_mousemask($newmask, &$oldmask){}
40423
40424/**
40425 * @param int $y
40426 * @param int $x
40427 * @param bool $toscreen
40428 * @return bool
40429 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40430 **/
40431function ncurses_mouse_trafo(&$y, &$x, $toscreen){}
40432
40433/**
40434 * @param int $y
40435 * @param int $x
40436 * @return int
40437 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40438 **/
40439function ncurses_move($y, $x){}
40440
40441/**
40442 * @param resource $panel
40443 * @param int $startx
40444 * @param int $starty
40445 * @return int
40446 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40447 **/
40448function ncurses_move_panel($panel, $startx, $starty){}
40449
40450/**
40451 * @param int $y
40452 * @param int $x
40453 * @param int $c
40454 * @return int
40455 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40456 **/
40457function ncurses_mvaddch($y, $x, $c){}
40458
40459/**
40460 * @param int $y
40461 * @param int $x
40462 * @param string $s
40463 * @param int $n
40464 * @return int
40465 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40466 **/
40467function ncurses_mvaddchnstr($y, $x, $s, $n){}
40468
40469/**
40470 * @param int $y
40471 * @param int $x
40472 * @param string $s
40473 * @return int
40474 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40475 **/
40476function ncurses_mvaddchstr($y, $x, $s){}
40477
40478/**
40479 * @param int $y
40480 * @param int $x
40481 * @param string $s
40482 * @param int $n
40483 * @return int
40484 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40485 **/
40486function ncurses_mvaddnstr($y, $x, $s, $n){}
40487
40488/**
40489 * @param int $y
40490 * @param int $x
40491 * @param string $s
40492 * @return int
40493 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40494 **/
40495function ncurses_mvaddstr($y, $x, $s){}
40496
40497/**
40498 * @param int $old_y
40499 * @param int $old_x
40500 * @param int $new_y
40501 * @param int $new_x
40502 * @return int
40503 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40504 **/
40505function ncurses_mvcur($old_y, $old_x, $new_y, $new_x){}
40506
40507/**
40508 * @param int $y
40509 * @param int $x
40510 * @return int
40511 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40512 **/
40513function ncurses_mvdelch($y, $x){}
40514
40515/**
40516 * @param int $y
40517 * @param int $x
40518 * @return int
40519 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40520 **/
40521function ncurses_mvgetch($y, $x){}
40522
40523/**
40524 * @param int $y
40525 * @param int $x
40526 * @param int $attrchar
40527 * @param int $n
40528 * @return int
40529 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40530 **/
40531function ncurses_mvhline($y, $x, $attrchar, $n){}
40532
40533/**
40534 * @param int $y
40535 * @param int $x
40536 * @return int
40537 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40538 **/
40539function ncurses_mvinch($y, $x){}
40540
40541/**
40542 * @param int $y
40543 * @param int $x
40544 * @param int $attrchar
40545 * @param int $n
40546 * @return int
40547 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40548 **/
40549function ncurses_mvvline($y, $x, $attrchar, $n){}
40550
40551/**
40552 * @param resource $window
40553 * @param int $y
40554 * @param int $x
40555 * @param string $text
40556 * @return int
40557 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40558 **/
40559function ncurses_mvwaddstr($window, $y, $x, $text){}
40560
40561/**
40562 * @param int $milliseconds
40563 * @return int
40564 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40565 **/
40566function ncurses_napms($milliseconds){}
40567
40568/**
40569 * @param int $rows
40570 * @param int $cols
40571 * @return resource
40572 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40573 **/
40574function ncurses_newpad($rows, $cols){}
40575
40576/**
40577 * Creates a new window to draw elements in.
40578 *
40579 * When creating additional windows, remember to use {@link
40580 * ncurses_getmaxyx} to check for available space, as terminal size is
40581 * individual and may vary.
40582 *
40583 * @param int $rows Number of rows
40584 * @param int $cols Number of columns
40585 * @param int $y y-coordinate of the origin
40586 * @param int $x x-coordinate of the origin
40587 * @return resource
40588 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40589 **/
40590function ncurses_newwin($rows, $cols, $y, $x){}
40591
40592/**
40593 * @param resource $window
40594 * @return resource
40595 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40596 **/
40597function ncurses_new_panel($window){}
40598
40599/**
40600 * @return bool
40601 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40602 **/
40603function ncurses_nl(){}
40604
40605/**
40606 * Returns terminal to normal (cooked) mode. Initially the terminal may
40607 * or may not in cbreak mode as the mode is inherited. Therefore a
40608 * program should call {@link ncurses_cbreak} and {@link
40609 * ncurses_nocbreak} explicitly.
40610 *
40611 * @return bool
40612 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40613 **/
40614function ncurses_nocbreak(){}
40615
40616/**
40617 * Prevents echoing of user typed characters.
40618 *
40619 * @return bool
40620 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40621 **/
40622function ncurses_noecho(){}
40623
40624/**
40625 * @return bool
40626 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40627 **/
40628function ncurses_nonl(){}
40629
40630/**
40631 * @return void
40632 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40633 **/
40634function ncurses_noqiflush(){}
40635
40636/**
40637 * Switches the terminal out of raw mode. Raw mode is similar to cbreak
40638 * mode, in that characters typed are immediately passed through to the
40639 * user program. The differences that are that in raw mode, the
40640 * interrupt, quit, suspend and flow control characters are all passed
40641 * through uninterpreted, instead of generating a signal.
40642 *
40643 * @return bool
40644 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40645 **/
40646function ncurses_noraw(){}
40647
40648/**
40649 * Retrieves the foreground and background colors that constitute the
40650 * given color pair. Terminal color capabilities must be initialized with
40651 * {@link ncurses_start_color} prior to calling this function.
40652 *
40653 * @param int $pair The number of the color pair to retrieve
40654 *   information for.
40655 * @param int $f A reference to which to return the foreground color of
40656 *   the color pair. The information returned will be a color number
40657 *   referring to one of the pre-defined colors or a color defined
40658 *   previously by {@link ncurses_init_color} if the terminal supports
40659 *   color changing.
40660 * @param int $b A reference to which to return the background color of
40661 *   the color pair. The information returned will be a color number
40662 *   referring to one of the pre-defined colors or a color defined
40663 *   previously by {@link ncurses_init_color} if the terminal supports
40664 *   color changing.
40665 * @return int
40666 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40667 **/
40668function ncurses_pair_content($pair, &$f, &$b){}
40669
40670/**
40671 * @param resource $panel
40672 * @return resource
40673 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40674 **/
40675function ncurses_panel_above($panel){}
40676
40677/**
40678 * @param resource $panel
40679 * @return resource
40680 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40681 **/
40682function ncurses_panel_below($panel){}
40683
40684/**
40685 * @param resource $panel
40686 * @return resource
40687 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40688 **/
40689function ncurses_panel_window($panel){}
40690
40691/**
40692 * @param resource $pad
40693 * @param int $pminrow
40694 * @param int $pmincol
40695 * @param int $sminrow
40696 * @param int $smincol
40697 * @param int $smaxrow
40698 * @param int $smaxcol
40699 * @return int
40700 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40701 **/
40702function ncurses_pnoutrefresh($pad, $pminrow, $pmincol, $sminrow, $smincol, $smaxrow, $smaxcol){}
40703
40704/**
40705 * @param resource $pad
40706 * @param int $pminrow
40707 * @param int $pmincol
40708 * @param int $sminrow
40709 * @param int $smincol
40710 * @param int $smaxrow
40711 * @param int $smaxcol
40712 * @return int
40713 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40714 **/
40715function ncurses_prefresh($pad, $pminrow, $pmincol, $sminrow, $smincol, $smaxrow, $smaxcol){}
40716
40717/**
40718 * @param string $text
40719 * @return int
40720 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40721 **/
40722function ncurses_putp($text){}
40723
40724/**
40725 * @return void
40726 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40727 **/
40728function ncurses_qiflush(){}
40729
40730/**
40731 * Places the terminal in raw mode. Raw mode is similar to cbreak mode,
40732 * in that characters typed are immediately passed through to the user
40733 * program. The differences that are that in raw mode, the interrupt,
40734 * quit, suspend and flow control characters are all passed through
40735 * uninterpreted, instead of generating a signal.
40736 *
40737 * @return bool
40738 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40739 **/
40740function ncurses_raw(){}
40741
40742/**
40743 * @param int $ch
40744 * @return int
40745 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40746 **/
40747function ncurses_refresh($ch){}
40748
40749/**
40750 * @param resource $panel
40751 * @param resource $window
40752 * @return int
40753 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40754 **/
40755function ncurses_replace_panel($panel, $window){}
40756
40757/**
40758 * Restores the terminal state, which was previously saved by calling
40759 * {@link ncurses_savetty}.
40760 *
40761 * @return bool
40762 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40763 **/
40764function ncurses_resetty(){}
40765
40766/**
40767 * @return int
40768 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40769 **/
40770function ncurses_reset_prog_mode(){}
40771
40772/**
40773 * @return int
40774 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40775 **/
40776function ncurses_reset_shell_mode(){}
40777
40778/**
40779 * Saves the current terminal state. The saved terminal state can be
40780 * restored with {@link ncurses_resetty}.
40781 *
40782 * @return bool
40783 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40784 **/
40785function ncurses_savetty(){}
40786
40787/**
40788 * @param int $count
40789 * @return int
40790 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40791 **/
40792function ncurses_scrl($count){}
40793
40794/**
40795 * @param string $filename
40796 * @return int
40797 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40798 **/
40799function ncurses_scr_dump($filename){}
40800
40801/**
40802 * @param string $filename
40803 * @return int
40804 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40805 **/
40806function ncurses_scr_init($filename){}
40807
40808/**
40809 * @param string $filename
40810 * @return int
40811 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40812 **/
40813function ncurses_scr_restore($filename){}
40814
40815/**
40816 * @param string $filename
40817 * @return int
40818 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40819 **/
40820function ncurses_scr_set($filename){}
40821
40822/**
40823 * @param resource $panel
40824 * @return int
40825 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40826 **/
40827function ncurses_show_panel($panel){}
40828
40829/**
40830 * Returns the current soft label key attribute.
40831 *
40832 * @return int
40833 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40834 **/
40835function ncurses_slk_attr(){}
40836
40837/**
40838 * @param int $intarg
40839 * @return int
40840 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40841 **/
40842function ncurses_slk_attroff($intarg){}
40843
40844/**
40845 * @param int $intarg
40846 * @return int
40847 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40848 **/
40849function ncurses_slk_attron($intarg){}
40850
40851/**
40852 * @param int $intarg
40853 * @return int
40854 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40855 **/
40856function ncurses_slk_attrset($intarg){}
40857
40858/**
40859 * The function {@link ncurses_slk_clear} clears soft label keys from
40860 * screen.
40861 *
40862 * @return bool
40863 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40864 **/
40865function ncurses_slk_clear(){}
40866
40867/**
40868 * @param int $intarg
40869 * @return int
40870 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40871 **/
40872function ncurses_slk_color($intarg){}
40873
40874/**
40875 * Initializes soft label key functions
40876 *
40877 * This function must be called before {@link ncurses_init} or {@link
40878 * ncurses_newwin} is called.
40879 *
40880 * @param int $format If {@link ncurses_init} eventually uses a line
40881 *   from stdscr to emulate the soft labels, then this parameter
40882 *   determines how the labels are arranged of the screen. 0 indicates a
40883 *   3-2-3 arrangement of the labels, 1 indicates a 4-4 arrangement and 2
40884 *   indicates the PC like 4-4-4 mode, but in addition an index line will
40885 *   be created.
40886 * @return bool
40887 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40888 **/
40889function ncurses_slk_init($format){}
40890
40891/**
40892 * @return bool
40893 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40894 **/
40895function ncurses_slk_noutrefresh(){}
40896
40897/**
40898 * Copies soft label keys from virtual screen to physical screen.
40899 *
40900 * @return int
40901 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40902 **/
40903function ncurses_slk_refresh(){}
40904
40905/**
40906 * Restores the soft label keys after {@link ncurses_slk_clear} has been
40907 * performed.
40908 *
40909 * @return int
40910 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40911 **/
40912function ncurses_slk_restore(){}
40913
40914/**
40915 * @param int $labelnr
40916 * @param string $label
40917 * @param int $format
40918 * @return bool
40919 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40920 **/
40921function ncurses_slk_set($labelnr, $label, $format){}
40922
40923/**
40924 * Forces all the soft labels to be output the next time a {@link
40925 * ncurses_slk_noutrefresh} is performed.
40926 *
40927 * @return int
40928 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40929 **/
40930function ncurses_slk_touch(){}
40931
40932/**
40933 * @return int
40934 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40935 **/
40936function ncurses_standend(){}
40937
40938/**
40939 * @return int
40940 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40941 **/
40942function ncurses_standout(){}
40943
40944/**
40945 * Initializes color functionality in ncurses. This function must be
40946 * called before any color manipulation functions are called and after
40947 * {@link ncurses_init} is called. It is good practice to call this
40948 * function right after {@link ncurses_init}.
40949 *
40950 * @return int
40951 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40952 **/
40953function ncurses_start_color(){}
40954
40955/**
40956 * @return bool
40957 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40958 **/
40959function ncurses_termattrs(){}
40960
40961/**
40962 * Returns terminals shortname.
40963 *
40964 * @return string
40965 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40966 **/
40967function ncurses_termname(){}
40968
40969/**
40970 * @param int $millisec
40971 * @return void
40972 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40973 **/
40974function ncurses_timeout($millisec){}
40975
40976/**
40977 * @param resource $panel
40978 * @return int
40979 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40980 **/
40981function ncurses_top_panel($panel){}
40982
40983/**
40984 * @param int $fd
40985 * @return int
40986 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40987 **/
40988function ncurses_typeahead($fd){}
40989
40990/**
40991 * @param int $keycode
40992 * @return int
40993 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
40994 **/
40995function ncurses_ungetch($keycode){}
40996
40997/**
40998 * Pushes a KEY_MOUSE event onto the unput queue and associates with this
40999 * event the given state sata and screen-relative character cell
41000 * coordinates, specified in {@link mevent}.
41001 *
41002 * @param array $mevent An associative array specifying the event
41003 *   options: "id" : Id to distinguish multiple devices "x" : screen
41004 *   relative x-position in character cells "y" : screen relative
41005 *   y-position in character cells "z" : currently not supported "mmask"
41006 *   : Mouse action
41007 * @return bool
41008 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41009 **/
41010function ncurses_ungetmouse($mevent){}
41011
41012/**
41013 * @return void
41014 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41015 **/
41016function ncurses_update_panels(){}
41017
41018/**
41019 * @return bool
41020 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41021 **/
41022function ncurses_use_default_colors(){}
41023
41024/**
41025 * @param bool $flag
41026 * @return void
41027 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41028 **/
41029function ncurses_use_env($flag){}
41030
41031/**
41032 * @param bool $flag
41033 * @return int
41034 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41035 **/
41036function ncurses_use_extended_names($flag){}
41037
41038/**
41039 * @param int $intarg
41040 * @return int
41041 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41042 **/
41043function ncurses_vidattr($intarg){}
41044
41045/**
41046 * @param int $charattr
41047 * @param int $n
41048 * @return int
41049 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41050 **/
41051function ncurses_vline($charattr, $n){}
41052
41053/**
41054 * @param resource $window
41055 * @param int $ch
41056 * @return int
41057 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41058 **/
41059function ncurses_waddch($window, $ch){}
41060
41061/**
41062 * @param resource $window
41063 * @param string $str
41064 * @param int $n
41065 * @return int
41066 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41067 **/
41068function ncurses_waddstr($window, $str, $n){}
41069
41070/**
41071 * @param resource $window
41072 * @param int $attrs
41073 * @return int
41074 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41075 **/
41076function ncurses_wattroff($window, $attrs){}
41077
41078/**
41079 * @param resource $window
41080 * @param int $attrs
41081 * @return int
41082 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41083 **/
41084function ncurses_wattron($window, $attrs){}
41085
41086/**
41087 * @param resource $window
41088 * @param int $attrs
41089 * @return int
41090 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41091 **/
41092function ncurses_wattrset($window, $attrs){}
41093
41094/**
41095 * Draws the specified lines and corners around the passed {@link
41096 * window}.
41097 *
41098 * Use {@link ncurses_border} for borders around the main window.
41099 *
41100 * @param resource $window The window on which we operate
41101 * @param int $left
41102 * @param int $right
41103 * @param int $top
41104 * @param int $bottom
41105 * @param int $tl_corner Top left corner
41106 * @param int $tr_corner Top right corner
41107 * @param int $bl_corner Bottom left corner
41108 * @param int $br_corner Bottom right corner
41109 * @return int
41110 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41111 **/
41112function ncurses_wborder($window, $left, $right, $top, $bottom, $tl_corner, $tr_corner, $bl_corner, $br_corner){}
41113
41114/**
41115 * @param resource $window
41116 * @return int
41117 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41118 **/
41119function ncurses_wclear($window){}
41120
41121/**
41122 * @param resource $window
41123 * @param int $color_pair
41124 * @return int
41125 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41126 **/
41127function ncurses_wcolor_set($window, $color_pair){}
41128
41129/**
41130 * @param resource $window
41131 * @return int
41132 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41133 **/
41134function ncurses_werase($window){}
41135
41136/**
41137 * @param resource $window
41138 * @return int
41139 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41140 **/
41141function ncurses_wgetch($window){}
41142
41143/**
41144 * @param resource $window
41145 * @param int $charattr
41146 * @param int $n
41147 * @return int
41148 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41149 **/
41150function ncurses_whline($window, $charattr, $n){}
41151
41152/**
41153 * @param resource $window
41154 * @param int $y
41155 * @param int $x
41156 * @param bool $toscreen
41157 * @return bool
41158 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41159 **/
41160function ncurses_wmouse_trafo($window, &$y, &$x, $toscreen){}
41161
41162/**
41163 * @param resource $window
41164 * @param int $y
41165 * @param int $x
41166 * @return int
41167 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41168 **/
41169function ncurses_wmove($window, $y, $x){}
41170
41171/**
41172 * @param resource $window
41173 * @return int
41174 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41175 **/
41176function ncurses_wnoutrefresh($window){}
41177
41178/**
41179 * @param resource $window
41180 * @return int
41181 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41182 **/
41183function ncurses_wrefresh($window){}
41184
41185/**
41186 * @param resource $window
41187 * @return int
41188 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41189 **/
41190function ncurses_wstandend($window){}
41191
41192/**
41193 * @param resource $window
41194 * @return int
41195 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41196 **/
41197function ncurses_wstandout($window){}
41198
41199/**
41200 * @param resource $window
41201 * @param int $charattr
41202 * @param int $n
41203 * @return int
41204 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
41205 **/
41206function ncurses_wvline($window, $charattr, $n){}
41207
41208/**
41209 * This function sends a beep to the terminal.
41210 *
41211 * @return void
41212 * @since PECL newt >= 0.1
41213 **/
41214function newt_bell(){}
41215
41216/**
41217 * Creates a new button.
41218 *
41219 * @param int $left X-coordinate of the button.
41220 * @param int $top Y-coordinate of the button.
41221 * @param string $text The text which should be displayed in the
41222 *   button.
41223 * @return resource
41224 * @since PECL newt >= 0.1
41225 **/
41226function newt_button($left, $top, $text){}
41227
41228/**
41229 * This function returns a grid containing the buttons created.
41230 *
41231 * @param array $buttons
41232 * @return resource
41233 * @since PECL newt >= 0.1
41234 **/
41235function newt_button_bar(&$buttons){}
41236
41237/**
41238 * Open a centered window of the specified size.
41239 *
41240 * @param int $width Window width
41241 * @param int $height Window height
41242 * @param string $title Window title
41243 * @return int
41244 * @since PECL newt >= 0.1
41245 **/
41246function newt_centered_window($width, $height, $title){}
41247
41248/**
41249 * @param int $left
41250 * @param int $top
41251 * @param string $text
41252 * @param string $def_value
41253 * @param string $seq
41254 * @return resource
41255 * @since PECL newt >= 0.1
41256 **/
41257function newt_checkbox($left, $top, $text, $def_value, $seq){}
41258
41259/**
41260 * This function returns the character in the sequence which indicates
41261 * the current value of the checkbox.
41262 *
41263 * @param resource $checkbox
41264 * @return string
41265 * @since PECL newt >= 0.1
41266 **/
41267function newt_checkbox_get_value($checkbox){}
41268
41269/**
41270 * This function allows to set various flags on checkbox resource.
41271 *
41272 * @param resource $checkbox
41273 * @param int $flags
41274 * @param int $sense
41275 * @return void
41276 * @since PECL newt >= 0.1
41277 **/
41278function newt_checkbox_set_flags($checkbox, $flags, $sense){}
41279
41280/**
41281 * This function allows to set the current value of the checkbox
41282 * resource.
41283 *
41284 * @param resource $checkbox
41285 * @param string $value
41286 * @return void
41287 * @since PECL newt >= 0.1
41288 **/
41289function newt_checkbox_set_value($checkbox, $value){}
41290
41291/**
41292 * @param int $left
41293 * @param int $top
41294 * @param int $height
41295 * @param int $flags
41296 * @return resource
41297 * @since PECL newt >= 0.1
41298 **/
41299function newt_checkbox_tree($left, $top, $height, $flags){}
41300
41301/**
41302 * This function allows to add new item to the checkbox tree.
41303 *
41304 * @param resource $checkboxtree
41305 * @param string $text
41306 * @param mixed $data
41307 * @param int $flags
41308 * @param int $index
41309 * @return void
41310 * @since PECL newt >= 0.1
41311 **/
41312function newt_checkbox_tree_add_item($checkboxtree, $text, $data, $flags, $index){}
41313
41314/**
41315 * Finds an item in the checkbox tree by item's data.
41316 *
41317 * @param resource $checkboxtree
41318 * @param mixed $data
41319 * @return array
41320 * @since PECL newt >= 0.1
41321 **/
41322function newt_checkbox_tree_find_item($checkboxtree, $data){}
41323
41324/**
41325 * This method returns checkbox tree selected tem.
41326 *
41327 * @param resource $checkboxtree
41328 * @return mixed
41329 * @since PECL newt >= 0.1
41330 **/
41331function newt_checkbox_tree_get_current($checkboxtree){}
41332
41333/**
41334 * @param resource $checkboxtree
41335 * @param mixed $data
41336 * @return string
41337 * @since PECL newt >= 0.1
41338 **/
41339function newt_checkbox_tree_get_entry_value($checkboxtree, $data){}
41340
41341/**
41342 * @param resource $checkboxtree
41343 * @param string $seqnum
41344 * @return array
41345 * @since PECL newt >= 0.1
41346 **/
41347function newt_checkbox_tree_get_multi_selection($checkboxtree, $seqnum){}
41348
41349/**
41350 * @param resource $checkboxtree
41351 * @return array
41352 * @since PECL newt >= 0.1
41353 **/
41354function newt_checkbox_tree_get_selection($checkboxtree){}
41355
41356/**
41357 * @param int $left
41358 * @param int $top
41359 * @param int $height
41360 * @param string $seq
41361 * @param int $flags
41362 * @return resource
41363 * @since PECL newt >= 0.1
41364 **/
41365function newt_checkbox_tree_multi($left, $top, $height, $seq, $flags){}
41366
41367/**
41368 * @param resource $checkboxtree
41369 * @param mixed $data
41370 * @return void
41371 * @since PECL newt >= 0.1
41372 **/
41373function newt_checkbox_tree_set_current($checkboxtree, $data){}
41374
41375/**
41376 * @param resource $checkboxtree
41377 * @param mixed $data
41378 * @param string $text
41379 * @return void
41380 * @since PECL newt >= 0.1
41381 **/
41382function newt_checkbox_tree_set_entry($checkboxtree, $data, $text){}
41383
41384/**
41385 * @param resource $checkboxtree
41386 * @param mixed $data
41387 * @param string $value
41388 * @return void
41389 * @since PECL newt >= 0.1
41390 **/
41391function newt_checkbox_tree_set_entry_value($checkboxtree, $data, $value){}
41392
41393/**
41394 * @param resource $checkbox_tree
41395 * @param int $width
41396 * @return void
41397 * @since PECL newt >= 0.1
41398 **/
41399function newt_checkbox_tree_set_width($checkbox_tree, $width){}
41400
41401/**
41402 * Discards the contents of the terminal's input buffer without waiting
41403 * for additional input.
41404 *
41405 * @return void
41406 * @since PECL newt >= 0.1
41407 **/
41408function newt_clear_key_buffer(){}
41409
41410/**
41411 * @return void
41412 * @since PECL newt >= 0.1
41413 **/
41414function newt_cls(){}
41415
41416/**
41417 * @param int $left
41418 * @param int $top
41419 * @param string $text
41420 * @return resource
41421 * @since PECL newt >= 0.1
41422 **/
41423function newt_compact_button($left, $top, $text){}
41424
41425/**
41426 * @param resource $component
41427 * @param mixed $func_name
41428 * @param mixed $data
41429 * @return void
41430 * @since PECL newt >= 0.1
41431 **/
41432function newt_component_add_callback($component, $func_name, $data){}
41433
41434/**
41435 * @param resource $component
41436 * @param bool $takes_focus
41437 * @return void
41438 * @since PECL newt >= 0.1
41439 **/
41440function newt_component_takes_focus($component, $takes_focus){}
41441
41442/**
41443 * @param int $cols
41444 * @param int $rows
41445 * @return resource
41446 * @since PECL newt >= 0.1
41447 **/
41448function newt_create_grid($cols, $rows){}
41449
41450/**
41451 * @return void
41452 * @since PECL newt >= 0.1
41453 **/
41454function newt_cursor_off(){}
41455
41456/**
41457 * @return void
41458 * @since PECL newt >= 0.1
41459 **/
41460function newt_cursor_on(){}
41461
41462/**
41463 * @param int $microseconds
41464 * @return void
41465 * @since PECL newt >= 0.1
41466 **/
41467function newt_delay($microseconds){}
41468
41469/**
41470 * @param resource $form
41471 * @return void
41472 * @since PECL newt >= 0.1
41473 **/
41474function newt_draw_form($form){}
41475
41476/**
41477 * Displays the string text at the position indicated.
41478 *
41479 * @param int $left Column number
41480 * @param int $top Line number
41481 * @param string $text Text to display.
41482 * @return void
41483 * @since PECL newt >= 0.1
41484 **/
41485function newt_draw_root_text($left, $top, $text){}
41486
41487/**
41488 * @param int $left
41489 * @param int $top
41490 * @param int $width
41491 * @param string $init_value
41492 * @param int $flags
41493 * @return resource
41494 * @since PECL newt >= 0.1
41495 **/
41496function newt_entry($left, $top, $width, $init_value, $flags){}
41497
41498/**
41499 * @param resource $entry
41500 * @return string
41501 * @since PECL newt >= 0.1
41502 **/
41503function newt_entry_get_value($entry){}
41504
41505/**
41506 * @param resource $entry
41507 * @param string $value
41508 * @param bool $cursor_at_end
41509 * @return void
41510 * @since PECL newt >= 0.1
41511 **/
41512function newt_entry_set($entry, $value, $cursor_at_end){}
41513
41514/**
41515 * @param resource $entry
41516 * @param callback $filter
41517 * @param mixed $data
41518 * @return void
41519 * @since PECL newt >= 0.1
41520 **/
41521function newt_entry_set_filter($entry, $filter, $data){}
41522
41523/**
41524 * @param resource $entry
41525 * @param int $flags
41526 * @param int $sense
41527 * @return void
41528 * @since PECL newt >= 0.1
41529 **/
41530function newt_entry_set_flags($entry, $flags, $sense){}
41531
41532/**
41533 * Uninitializes newt interface. This function be called, when program is
41534 * ready to exit.
41535 *
41536 * @return int
41537 * @since PECL newt >= 0.1
41538 **/
41539function newt_finished(){}
41540
41541/**
41542 * Create a new form.
41543 *
41544 * @param resource $vert_bar Vertical scrollbar which should be
41545 *   associated with the form
41546 * @param string $help Help text string
41547 * @param int $flags Various flags
41548 * @return resource
41549 * @since PECL newt >= 0.1
41550 **/
41551function newt_form($vert_bar, $help, $flags){}
41552
41553/**
41554 * Adds a single component to the {@link form}.
41555 *
41556 * @param resource $form Form to which component will be added
41557 * @param resource $component Component to add to the form
41558 * @return void
41559 * @since PECL newt >= 0.1
41560 **/
41561function newt_form_add_component($form, $component){}
41562
41563/**
41564 * Adds several components to the {@link form}.
41565 *
41566 * @param resource $form Form to which components will be added
41567 * @param array $components Array of components to add to the form
41568 * @return void
41569 * @since PECL newt >= 0.1
41570 **/
41571function newt_form_add_components($form, $components){}
41572
41573/**
41574 * @param resource $form
41575 * @param int $key
41576 * @return void
41577 * @since PECL newt >= 0.1
41578 **/
41579function newt_form_add_hot_key($form, $key){}
41580
41581/**
41582 * This function frees the memory resources used by the form and all of
41583 * the components which have been added to the form (including those
41584 * components which are on subforms). Once a form has been destroyed,
41585 * none of the form's components can be used.
41586 *
41587 * @param resource $form Form component, which is going to be destroyed
41588 * @return void
41589 * @since PECL newt >= 0.1
41590 **/
41591function newt_form_destroy($form){}
41592
41593/**
41594 * @param resource $form
41595 * @return resource
41596 * @since PECL newt >= 0.1
41597 **/
41598function newt_form_get_current($form){}
41599
41600/**
41601 * This function runs the form passed to it.
41602 *
41603 * @param resource $form Form component
41604 * @param array $exit_struct Array, used for returning information
41605 *   after running the form component. Keys and values are described in
41606 *   the following table: Form Exit Structure Index Key Value Type
41607 *   Description reason integer The reason, why the form has been exited.
41608 *   Possible values are defined here. watch resource Resource link,
41609 *   specified in {@link newt_form_watch_fd} key integer Hotkey component
41610 *   resource Component, which caused the form to exit
41611 * @return void
41612 * @since PECL newt >= 0.1
41613 **/
41614function newt_form_run($form, &$exit_struct){}
41615
41616/**
41617 * @param resource $from
41618 * @param int $background
41619 * @return void
41620 * @since PECL newt >= 0.1
41621 **/
41622function newt_form_set_background($from, $background){}
41623
41624/**
41625 * @param resource $form
41626 * @param int $height
41627 * @return void
41628 * @since PECL newt >= 0.1
41629 **/
41630function newt_form_set_height($form, $height){}
41631
41632/**
41633 * @param resource $form
41634 * @return void
41635 * @since PECL newt >= 0.1
41636 **/
41637function newt_form_set_size($form){}
41638
41639/**
41640 * @param resource $form
41641 * @param int $milliseconds
41642 * @return void
41643 * @since PECL newt >= 0.1
41644 **/
41645function newt_form_set_timer($form, $milliseconds){}
41646
41647/**
41648 * @param resource $form
41649 * @param int $width
41650 * @return void
41651 * @since PECL newt >= 0.1
41652 **/
41653function newt_form_set_width($form, $width){}
41654
41655/**
41656 * @param resource $form
41657 * @param resource $stream
41658 * @param int $flags
41659 * @return void
41660 * @since PECL newt >= 0.1
41661 **/
41662function newt_form_watch_fd($form, $stream, $flags){}
41663
41664/**
41665 * Fills in the passed references with the current size of the terminal.
41666 *
41667 * @param int $cols Number of columns in the terminal
41668 * @param int $rows Number of rows in the terminal
41669 * @return void
41670 * @since PECL newt >= 0.1
41671 **/
41672function newt_get_screen_size(&$cols, &$rows){}
41673
41674/**
41675 * @param resource $grid
41676 * @param resource $form
41677 * @param bool $recurse
41678 * @return void
41679 * @since PECL newt >= 0.1
41680 **/
41681function newt_grid_add_components_to_form($grid, $form, $recurse){}
41682
41683/**
41684 * @param resource $text
41685 * @param resource $middle
41686 * @param resource $buttons
41687 * @return resource
41688 * @since PECL newt >= 0.1
41689 **/
41690function newt_grid_basic_window($text, $middle, $buttons){}
41691
41692/**
41693 * @param resource $grid
41694 * @param bool $recurse
41695 * @return void
41696 * @since PECL newt >= 0.1
41697 **/
41698function newt_grid_free($grid, $recurse){}
41699
41700/**
41701 * @param resouce $grid
41702 * @param int $width
41703 * @param int $height
41704 * @return void
41705 * @since PECL newt >= 0.1
41706 **/
41707function newt_grid_get_size($grid, &$width, &$height){}
41708
41709/**
41710 * @param int $element1_type
41711 * @param resource $element1
41712 * @return resource
41713 * @since PECL newt >= 0.1
41714 **/
41715function newt_grid_h_close_stacked($element1_type, $element1){}
41716
41717/**
41718 * @param int $element1_type
41719 * @param resource $element1
41720 * @return resource
41721 * @since PECL newt >= 0.1
41722 **/
41723function newt_grid_h_stacked($element1_type, $element1){}
41724
41725/**
41726 * @param resource $grid
41727 * @param int $left
41728 * @param int $top
41729 * @return void
41730 * @since PECL newt >= 0.1
41731 **/
41732function newt_grid_place($grid, $left, $top){}
41733
41734/**
41735 * @param resource $grid
41736 * @param int $col
41737 * @param int $row
41738 * @param int $type
41739 * @param resource $val
41740 * @param int $pad_left
41741 * @param int $pad_top
41742 * @param int $pad_right
41743 * @param int $pad_bottom
41744 * @param int $anchor
41745 * @param int $flags
41746 * @return void
41747 * @since PECL newt >= 0.1
41748 **/
41749function newt_grid_set_field($grid, $col, $row, $type, $val, $pad_left, $pad_top, $pad_right, $pad_bottom, $anchor, $flags){}
41750
41751/**
41752 * @param resource $text
41753 * @param resource $middle
41754 * @param resource $buttons
41755 * @return resource
41756 * @since PECL newt >= 0.1
41757 **/
41758function newt_grid_simple_window($text, $middle, $buttons){}
41759
41760/**
41761 * @param int $element1_type
41762 * @param resource $element1
41763 * @return resource
41764 * @since PECL newt >= 0.1
41765 **/
41766function newt_grid_v_close_stacked($element1_type, $element1){}
41767
41768/**
41769 * @param int $element1_type
41770 * @param resource $element1
41771 * @return resource
41772 * @since PECL newt >= 0.1
41773 **/
41774function newt_grid_v_stacked($element1_type, $element1){}
41775
41776/**
41777 * @param resource $grid
41778 * @param string $title
41779 * @return void
41780 * @since PECL newt >= 0.1
41781 **/
41782function newt_grid_wrapped_window($grid, $title){}
41783
41784/**
41785 * @param resource $grid
41786 * @param string $title
41787 * @param int $left
41788 * @param int $top
41789 * @return void
41790 * @since PECL newt >= 0.1
41791 **/
41792function newt_grid_wrapped_window_at($grid, $title, $left, $top){}
41793
41794/**
41795 * Initializes the newt interface. This function must be called before
41796 * any other newt function.
41797 *
41798 * @return int
41799 * @since PECL newt >= 0.1
41800 **/
41801function newt_init(){}
41802
41803/**
41804 * @param int $left
41805 * @param int $top
41806 * @param string $text
41807 * @return resource
41808 * @since PECL newt >= 0.1
41809 **/
41810function newt_label($left, $top, $text){}
41811
41812/**
41813 * @param resource $label
41814 * @param string $text
41815 * @return void
41816 * @since PECL newt >= 0.1
41817 **/
41818function newt_label_set_text($label, $text){}
41819
41820/**
41821 * @param int $left
41822 * @param int $top
41823 * @param int $height
41824 * @param int $flags
41825 * @return resource
41826 * @since PECL newt >= 0.1
41827 **/
41828function newt_listbox($left, $top, $height, $flags){}
41829
41830/**
41831 * @param resource $listbox
41832 * @param string $text
41833 * @param mixed $data
41834 * @return void
41835 * @since PECL newt >= 0.1
41836 **/
41837function newt_listbox_append_entry($listbox, $text, $data){}
41838
41839/**
41840 * @param resource $listobx
41841 * @return void
41842 * @since PECL newt >= 0.1
41843 **/
41844function newt_listbox_clear($listobx){}
41845
41846/**
41847 * @param resource $listbox
41848 * @return void
41849 * @since PECL newt >= 0.1
41850 **/
41851function newt_listbox_clear_selection($listbox){}
41852
41853/**
41854 * @param resource $listbox
41855 * @param mixed $key
41856 * @return void
41857 * @since PECL newt >= 0.1
41858 **/
41859function newt_listbox_delete_entry($listbox, $key){}
41860
41861/**
41862 * @param resource $listbox
41863 * @return string
41864 * @since PECL newt >= 0.1
41865 **/
41866function newt_listbox_get_current($listbox){}
41867
41868/**
41869 * @param resource $listbox
41870 * @return array
41871 * @since PECL newt >= 0.1
41872 **/
41873function newt_listbox_get_selection($listbox){}
41874
41875/**
41876 * @param resource $listbox
41877 * @param string $text
41878 * @param mixed $data
41879 * @param mixed $key
41880 * @return void
41881 * @since PECL newt >= 0.1
41882 **/
41883function newt_listbox_insert_entry($listbox, $text, $data, $key){}
41884
41885/**
41886 * @param resource $listbox
41887 * @return int
41888 * @since PECL newt >= 0.1
41889 **/
41890function newt_listbox_item_count($listbox){}
41891
41892/**
41893 * @param resource $listbox
41894 * @param mixed $key
41895 * @param int $sense
41896 * @return void
41897 * @since PECL newt >= 0.1
41898 **/
41899function newt_listbox_select_item($listbox, $key, $sense){}
41900
41901/**
41902 * @param resource $listbox
41903 * @param int $num
41904 * @return void
41905 * @since PECL newt >= 0.1
41906 **/
41907function newt_listbox_set_current($listbox, $num){}
41908
41909/**
41910 * @param resource $listbox
41911 * @param mixed $key
41912 * @return void
41913 * @since PECL newt >= 0.1
41914 **/
41915function newt_listbox_set_current_by_key($listbox, $key){}
41916
41917/**
41918 * @param resource $listbox
41919 * @param int $num
41920 * @param mixed $data
41921 * @return void
41922 * @since PECL newt >= 0.1
41923 **/
41924function newt_listbox_set_data($listbox, $num, $data){}
41925
41926/**
41927 * @param resource $listbox
41928 * @param int $num
41929 * @param string $text
41930 * @return void
41931 * @since PECL newt >= 0.1
41932 **/
41933function newt_listbox_set_entry($listbox, $num, $text){}
41934
41935/**
41936 * @param resource $listbox
41937 * @param int $width
41938 * @return void
41939 * @since PECL newt >= 0.1
41940 **/
41941function newt_listbox_set_width($listbox, $width){}
41942
41943/**
41944 * @param int $left
41945 * @param int $top
41946 * @param string $text
41947 * @param bool $is_default
41948 * @param resouce $prev_item
41949 * @param mixed $data
41950 * @param int $flags
41951 * @return resource
41952 * @since PECL newt >= 0.1
41953 **/
41954function newt_listitem($left, $top, $text, $is_default, $prev_item, $data, $flags){}
41955
41956/**
41957 * @param resource $item
41958 * @return mixed
41959 * @since PECL newt >= 0.1
41960 **/
41961function newt_listitem_get_data($item){}
41962
41963/**
41964 * @param resource $item
41965 * @param string $text
41966 * @return void
41967 * @since PECL newt >= 0.1
41968 **/
41969function newt_listitem_set($item, $text){}
41970
41971/**
41972 * Open a window of the specified size and position.
41973 *
41974 * @param int $left Location of the upper left-hand corner of the
41975 *   window (column number)
41976 * @param int $top Location of the upper left-hand corner of the window
41977 *   (row number)
41978 * @param int $width Window width
41979 * @param int $height Window height
41980 * @param string $title Window title
41981 * @return int
41982 * @since PECL newt >= 0.1
41983 **/
41984function newt_open_window($left, $top, $width, $height, $title){}
41985
41986/**
41987 * Replaces the current help line with the one from the stack.
41988 *
41989 * @return void
41990 * @since PECL newt >= 0.1
41991 **/
41992function newt_pop_help_line(){}
41993
41994/**
41995 * Removes the top window from the display, and redraws the display areas
41996 * which the window overwrote.
41997 *
41998 * @return void
41999 * @since PECL newt >= 0.1
42000 **/
42001function newt_pop_window(){}
42002
42003/**
42004 * Saves the current help line on a stack, and displays the new line.
42005 *
42006 * @param string $text New help text message
42007 * @return void
42008 * @since PECL newt >= 0.1
42009 **/
42010function newt_push_help_line($text){}
42011
42012/**
42013 * @param int $left
42014 * @param int $top
42015 * @param string $text
42016 * @param bool $is_default
42017 * @param resource $prev_button
42018 * @return resource
42019 * @since PECL newt >= 0.1
42020 **/
42021function newt_radiobutton($left, $top, $text, $is_default, $prev_button){}
42022
42023/**
42024 * @param resource $set_member
42025 * @return resource
42026 * @since PECL newt >= 0.1
42027 **/
42028function newt_radio_get_current($set_member){}
42029
42030/**
42031 * @return void
42032 * @since PECL newt >= 0.1
42033 **/
42034function newt_redraw_help_line(){}
42035
42036/**
42037 * @param string $text
42038 * @param int $width
42039 * @param int $flex_down
42040 * @param int $flex_up
42041 * @param int $actual_width
42042 * @param int $actual_height
42043 * @return string
42044 * @since PECL newt >= 0.1
42045 **/
42046function newt_reflow_text($text, $width, $flex_down, $flex_up, &$actual_width, &$actual_height){}
42047
42048/**
42049 * To increase performance, newt only updates the display when it needs
42050 * to, not when the program tells it to write to the terminal.
42051 * Applications can force newt to immediately update modified portions of
42052 * the screen by calling this function.
42053 *
42054 * @return void
42055 * @since PECL newt >= 0.1
42056 **/
42057function newt_refresh(){}
42058
42059/**
42060 * @param bool $redraw
42061 * @return void
42062 * @since PECL newt >= 0.1
42063 **/
42064function newt_resize_screen($redraw){}
42065
42066/**
42067 * Resume using the newt interface after calling {@link newt_suspend}.
42068 *
42069 * @return void
42070 * @since PECL newt >= 0.1
42071 **/
42072function newt_resume(){}
42073
42074/**
42075 * This function runs the form passed to it.
42076 *
42077 * @param resource $form Form component
42078 * @return resource
42079 * @since PECL newt >= 0.1
42080 **/
42081function newt_run_form($form){}
42082
42083/**
42084 * @param int $left
42085 * @param int $top
42086 * @param int $width
42087 * @param int $full_value
42088 * @return resource
42089 * @since PECL newt >= 0.1
42090 **/
42091function newt_scale($left, $top, $width, $full_value){}
42092
42093/**
42094 * @param resource $scale
42095 * @param int $amount
42096 * @return void
42097 * @since PECL newt >= 0.1
42098 **/
42099function newt_scale_set($scale, $amount){}
42100
42101/**
42102 * @param resource $scrollbar
42103 * @param int $where
42104 * @param int $total
42105 * @return void
42106 * @since PECL newt >= 0.1
42107 **/
42108function newt_scrollbar_set($scrollbar, $where, $total){}
42109
42110/**
42111 * @param mixed $function
42112 * @return void
42113 * @since PECL newt >= 0.1
42114 **/
42115function newt_set_help_callback($function){}
42116
42117/**
42118 * Set a callback function which gets invoked when user presses the
42119 * suspend key (normally ^Z). If no suspend callback is registered, the
42120 * suspend keystroke is ignored.
42121 *
42122 * @param callback $function A callback function, which accepts one
42123 *   argument: data
42124 * @param mixed $data This data is been passed to the callback function
42125 * @return void
42126 * @since PECL newt >= 0.1
42127 **/
42128function newt_set_suspend_callback($function, $data){}
42129
42130/**
42131 * Tells newt to return the terminal to its initial state. Once this is
42132 * done, the application can suspend itself (by sending itself a SIGTSTP,
42133 * fork a child program, or do whatever else it likes).
42134 *
42135 * @return void
42136 * @since PECL newt >= 0.1
42137 **/
42138function newt_suspend(){}
42139
42140/**
42141 * @param int $left
42142 * @param int $top
42143 * @param int $width
42144 * @param int $height
42145 * @param int $flags
42146 * @return resource
42147 * @since PECL newt >= 0.1
42148 **/
42149function newt_textbox($left, $top, $width, $height, $flags){}
42150
42151/**
42152 * @param resource $textbox
42153 * @return int
42154 * @since PECL newt >= 0.1
42155 **/
42156function newt_textbox_get_num_lines($textbox){}
42157
42158/**
42159 * @param int $left
42160 * @param int $top
42161 * @param char $text
42162 * @param int $width
42163 * @param int $flex_down
42164 * @param int $flex_up
42165 * @param int $flags
42166 * @return resource
42167 * @since PECL newt >= 0.1
42168 **/
42169function newt_textbox_reflowed($left, $top, $text, $width, $flex_down, $flex_up, $flags){}
42170
42171/**
42172 * @param resource $textbox
42173 * @param int $height
42174 * @return void
42175 * @since PECL newt >= 0.1
42176 **/
42177function newt_textbox_set_height($textbox, $height){}
42178
42179/**
42180 * @param resource $textbox
42181 * @param string $text
42182 * @return void
42183 * @since PECL newt >= 0.1
42184 **/
42185function newt_textbox_set_text($textbox, $text){}
42186
42187/**
42188 * @param int $left
42189 * @param int $top
42190 * @param int $height
42191 * @param int $normal_colorset
42192 * @param int $thumb_colorset
42193 * @return resource
42194 * @since PECL newt >= 0.1
42195 **/
42196function newt_vertical_scrollbar($left, $top, $height, $normal_colorset, $thumb_colorset){}
42197
42198/**
42199 * This function doesn't return until a key has been pressed. The
42200 * keystroke is then ignored. If a key is already in the terminal's
42201 * buffer, this function discards a keystroke and returns immediately.
42202 *
42203 * @return void
42204 * @since PECL newt >= 0.1
42205 **/
42206function newt_wait_for_key(){}
42207
42208/**
42209 * @param string $title
42210 * @param string $button1_text
42211 * @param string $button2_text
42212 * @param string $format
42213 * @param mixed $args
42214 * @return int
42215 * @since PECL newt >= 0.1
42216 **/
42217function newt_win_choice($title, $button1_text, $button2_text, $format, $args){}
42218
42219/**
42220 * @param string $title
42221 * @param string $text
42222 * @param int $suggested_width
42223 * @param int $flex_down
42224 * @param int $flex_up
42225 * @param int $data_width
42226 * @param array $items
42227 * @param string $button1
42228 * @return int
42229 * @since PECL newt >= 0.1
42230 **/
42231function newt_win_entries($title, $text, $suggested_width, $flex_down, $flex_up, $data_width, &$items, $button1){}
42232
42233/**
42234 * @param string $title
42235 * @param string $text
42236 * @param int $suggestedWidth
42237 * @param int $flexDown
42238 * @param int $flexUp
42239 * @param int $maxListHeight
42240 * @param array $items
42241 * @param int $listItem
42242 * @param string $button1
42243 * @return int
42244 * @since PECL newt >= 0.1
42245 **/
42246function newt_win_menu($title, $text, $suggestedWidth, $flexDown, $flexUp, $maxListHeight, $items, &$listItem, $button1){}
42247
42248/**
42249 * @param string $title
42250 * @param string $button_text
42251 * @param string $format
42252 * @param mixed $args
42253 * @return void
42254 * @since PECL newt >= 0.1
42255 **/
42256function newt_win_message($title, $button_text, $format, $args){}
42257
42258/**
42259 * @param string $title
42260 * @param string $button_text
42261 * @param string $format
42262 * @param array $args
42263 * @return void
42264 * @since PECL newt >= 0.1
42265 **/
42266function newt_win_messagev($title, $button_text, $format, $args){}
42267
42268/**
42269 * @param string $title Its description
42270 * @param string $button1_text Its description
42271 * @param string $button2_text Its description
42272 * @param string $button3_text Its description
42273 * @param string $format Its description
42274 * @param mixed $args Its description
42275 * @return int
42276 * @since PECL newt >= 0.1
42277 **/
42278function newt_win_ternary($title, $button1_text, $button2_text, $button3_text, $format, $args){}
42279
42280/**
42281 * {@link next} behaves like {@link current}, with one difference. It
42282 * advances the internal array pointer one place forward before returning
42283 * the element value. That means it returns the next array value and
42284 * advances the internal array pointer by one.
42285 *
42286 * @param array $array The array being affected.
42287 * @return mixed
42288 * @since PHP 4, PHP 5
42289 **/
42290function next(&$array){}
42291
42292/**
42293 * The plural version of {@link gettext}. Some languages have more than
42294 * one form for plural messages dependent on the count.
42295 *
42296 * @param string $msgid1
42297 * @param string $msgid2
42298 * @param int $n
42299 * @return string
42300 * @since PHP 4 >= 4.2.0, PHP 5
42301 **/
42302function ngettext($msgid1, $msgid2, $n){}
42303
42304/**
42305 * Returns {@link string} with '<br />' or '<br>' inserted before all
42306 * newlines.
42307 *
42308 * @param string $string The input string.
42309 * @param bool $is_xhtml Whenever to use XHTML compatible line breaks
42310 *   or not.
42311 * @return string
42312 * @since PHP 4, PHP 5
42313 **/
42314function nl2br($string, $is_xhtml){}
42315
42316/**
42317 * {@link nl_langinfo} is used to access individual elements of the
42318 * locale categories. Unlike {@link localeconv}, which returns all of the
42319 * elements, {@link nl_langinfo} allows you to select any specific
42320 * element.
42321 *
42322 * @param int $item {@link item} may be an integer value of the element
42323 *   or the constant name of the element. The following is a list of
42324 *   constant names for {@link item} that may be used and their
42325 *   description. Some of these constants may not be defined or hold no
42326 *   value for certain locales. nl_langinfo Constants Constant
42327 *   Description LC_TIME Category Constants ABDAY_(1-7) Abbreviated name
42328 *   of n-th day of the week. DAY_(1-7) Name of the n-th day of the week
42329 *   (DAY_1 = Sunday). ABMON_(1-12) Abbreviated name of the n-th month of
42330 *   the year. MON_(1-12) Name of the n-th month of the year. AM_STR
42331 *   String for Ante meridian. PM_STR String for Post meridian. D_T_FMT
42332 *   String that can be used as the format string for {@link strftime} to
42333 *   represent time and date. D_FMT String that can be used as the format
42334 *   string for {@link strftime} to represent date. T_FMT String that can
42335 *   be used as the format string for {@link strftime} to represent time.
42336 *   T_FMT_AMPM String that can be used as the format string for {@link
42337 *   strftime} to represent time in 12-hour format with ante/post
42338 *   meridian. ERA Alternate era. ERA_YEAR Year in alternate era format.
42339 *   ERA_D_T_FMT Date and time in alternate era format (string can be
42340 *   used in {@link strftime}). ERA_D_FMT Date in alternate era format
42341 *   (string can be used in {@link strftime}). ERA_T_FMT Time in
42342 *   alternate era format (string can be used in {@link strftime}).
42343 *   LC_MONETARY Category Constants INT_CURR_SYMBOL International
42344 *   currency symbol. CURRENCY_SYMBOL Local currency symbol. CRNCYSTR
42345 *   Same value as CURRENCY_SYMBOL. MON_DECIMAL_POINT Decimal point
42346 *   character. MON_THOUSANDS_SEP Thousands separator (groups of three
42347 *   digits). MON_GROUPING Like "grouping" element. POSITIVE_SIGN Sign
42348 *   for positive values. NEGATIVE_SIGN Sign for negative values.
42349 *   INT_FRAC_DIGITS International fractional digits. FRAC_DIGITS Local
42350 *   fractional digits. P_CS_PRECEDES Returns 1 if CURRENCY_SYMBOL
42351 *   precedes a positive value. P_SEP_BY_SPACE Returns 1 if a space
42352 *   separates CURRENCY_SYMBOL from a positive value. N_CS_PRECEDES
42353 *   Returns 1 if CURRENCY_SYMBOL precedes a negative value.
42354 *   N_SEP_BY_SPACE Returns 1 if a space separates CURRENCY_SYMBOL from a
42355 *   negative value. P_SIGN_POSN Returns 0 if parentheses surround the
42356 *   quantity and CURRENCY_SYMBOL. Returns 1 if the sign string precedes
42357 *   the quantity and CURRENCY_SYMBOL. Returns 2 if the sign string
42358 *   follows the quantity and CURRENCY_SYMBOL. Returns 3 if the sign
42359 *   string immediately precedes the CURRENCY_SYMBOL. Returns 4 if the
42360 *   sign string immediately follows the CURRENCY_SYMBOL. N_SIGN_POSN
42361 *   LC_NUMERIC Category Constants DECIMAL_POINT Decimal point character.
42362 *   RADIXCHAR Same value as DECIMAL_POINT. THOUSANDS_SEP Separator
42363 *   character for thousands (groups of three digits). THOUSEP Same value
42364 *   as THOUSANDS_SEP. GROUPING LC_MESSAGES Category Constants YESEXPR
42365 *   Regex string for matching "yes" input. NOEXPR Regex string for
42366 *   matching "no" input. YESSTR Output string for "yes". NOSTR Output
42367 *   string for "no". LC_CTYPE Category Constants CODESET Return a string
42368 *   with the name of the character encoding.
42369 * @return string
42370 * @since PHP 4 >= 4.1.0, PHP 5
42371 **/
42372function nl_langinfo($item){}
42373
42374/**
42375 * Checks if the provided string is already in the specified
42376 * normalization form.
42377 *
42378 * @param string $input The input string to normalize
42379 * @param string $form One of the normalization forms.
42380 * @return bool
42381 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42382 **/
42383function normalizer_is_normalized($input, $form){}
42384
42385/**
42386 * Normalizes the input provided and returns the normalized string
42387 *
42388 * @param string $input The input string to normalize
42389 * @param string $form One of the normalization forms.
42390 * @return string
42391 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42392 **/
42393function normalizer_normalize($input, $form){}
42394
42395/**
42396 * @param string $server
42397 * @param string $mailbox
42398 * @param int $msg_number
42399 * @return array
42400 * @since PHP 4 >= 4.0.5
42401 **/
42402function notes_body($server, $mailbox, $msg_number){}
42403
42404/**
42405 * @param string $from_database_name
42406 * @param string $to_database_name
42407 * @return bool
42408 * @since PHP 4 >= 4.0.5
42409 **/
42410function notes_copy_db($from_database_name, $to_database_name){}
42411
42412/**
42413 * @param string $database_name
42414 * @return bool
42415 * @since PHP 4 >= 4.0.5
42416 **/
42417function notes_create_db($database_name){}
42418
42419/**
42420 * @param string $database_name
42421 * @param string $form_name
42422 * @return bool
42423 * @since PHP 4 >= 4.0.5
42424 **/
42425function notes_create_note($database_name, $form_name){}
42426
42427/**
42428 * @param string $database_name
42429 * @return bool
42430 * @since PHP 4 >= 4.0.5
42431 **/
42432function notes_drop_db($database_name){}
42433
42434/**
42435 * @param string $database_name
42436 * @param string $name
42437 * @param string $type
42438 * @return int
42439 * @since PHP 4 >= 4.0.5
42440 **/
42441function notes_find_note($database_name, $name, $type){}
42442
42443/**
42444 * @param string $server
42445 * @param string $mailbox
42446 * @param int $msg_number
42447 * @return object
42448 * @since PHP 4 >= 4.0.5
42449 **/
42450function notes_header_info($server, $mailbox, $msg_number){}
42451
42452/**
42453 * @param string $db
42454 * @return bool
42455 * @since PHP 4 >= 4.0.5
42456 **/
42457function notes_list_msgs($db){}
42458
42459/**
42460 * @param string $database_name
42461 * @param string $user_name
42462 * @param string $note_id
42463 * @return bool
42464 * @since PHP 4 >= 4.0.5
42465 **/
42466function notes_mark_read($database_name, $user_name, $note_id){}
42467
42468/**
42469 * @param string $database_name
42470 * @param string $user_name
42471 * @param string $note_id
42472 * @return bool
42473 * @since PHP 4 >= 4.0.5
42474 **/
42475function notes_mark_unread($database_name, $user_name, $note_id){}
42476
42477/**
42478 * @param string $database_name
42479 * @param string $name
42480 * @return bool
42481 * @since PHP 4 >= 4.0.5
42482 **/
42483function notes_nav_create($database_name, $name){}
42484
42485/**
42486 * @param string $database_name
42487 * @param string $keywords
42488 * @return array
42489 * @since PHP 4 >= 4.0.5
42490 **/
42491function notes_search($database_name, $keywords){}
42492
42493/**
42494 * @param string $database_name
42495 * @param string $user_name
42496 * @return array
42497 * @since PHP 4 >= 4.0.5
42498 **/
42499function notes_unread($database_name, $user_name){}
42500
42501/**
42502 * @param string $database_name
42503 * @return float
42504 * @since PHP 4 >= 4.0.5
42505 **/
42506function notes_version($database_name){}
42507
42508/**
42509 * {@link nsapi_request_headers} gets all the HTTP headers in the current
42510 * request. This is only supported when PHP runs as a NSAPI module.
42511 *
42512 * @return array
42513 * @since PHP 4 >= 4.3.3, PHP 5
42514 **/
42515function nsapi_request_headers(){}
42516
42517/**
42518 * Gets all the NSAPI response headers.
42519 *
42520 * @return array
42521 * @since PHP 4 >= 4.3.3, PHP 5
42522 **/
42523function nsapi_response_headers(){}
42524
42525/**
42526 * {@link nsapi_virtual} is an NSAPI-specific function which is
42527 * equivalent to <!--#include virtual...--> in SSI (.shtml files). It
42528 * does an NSAPI sub-request. It is useful for including CGI scripts or
42529 * .shtml files, or anything else that you'd parse through webserver.
42530 *
42531 * To run the sub-request, all buffers are terminated and flushed to the
42532 * browser, pending headers are sent too.
42533 *
42534 * You cannot make recursive requests with this function to other PHP
42535 * scripts. If you want to include PHP scripts, use {@link include} or
42536 * {@link require}.
42537 *
42538 * @param string $uri The URI of the script.
42539 * @return bool
42540 * @since PHP 4 >= 4.3.3, PHP 5
42541 **/
42542function nsapi_virtual($uri){}
42543
42544/**
42545 * @param string $clent
42546 * @param string $data
42547 * @return string
42548 * @since PECL spplus >= 1.0.0
42549 **/
42550function nthmac($clent, $data){}
42551
42552/**
42553 * This function accepts either one, two, or four parameters (not three):
42554 *
42555 * If only one parameter is given, {@link number} will be formatted
42556 * without decimals, but with a comma (",") between every group of
42557 * thousands.
42558 *
42559 * If two parameters are given, {@link number} will be formatted with
42560 * {@link decimals} decimals with a dot (".") in front, and a comma (",")
42561 * between every group of thousands.
42562 *
42563 * If all four parameters are given, {@link number} will be formatted
42564 * with {@link decimals} decimals, {@link dec_point} instead of a dot
42565 * (".") before the decimals and {@link thousands_sep} instead of a comma
42566 * (",") between every group of thousands.
42567 *
42568 * @param float $number The number being formatted.
42569 * @param int $decimals Sets the number of decimal points.
42570 * @return string
42571 * @since PHP 4, PHP 5
42572 **/
42573function number_format($number, $decimals){}
42574
42575/**
42576 * Creates a number formatter.
42577 *
42578 * @param string $locale Locale in which the number would be formatted
42579 *   (locale name, e.g. en_CA).
42580 * @param int $style Style of the formatting, one of the format style
42581 *   constants. If NumberFormatter::PATTERN_DECIMAL or
42582 *   NumberFormatter::PATTERN_RULEBASED is passed then the number format
42583 *   is opened using the given pattern, which must conform to the syntax
42584 *   described in ICU DecimalFormat documentation or ICU
42585 *   RuleBasedNumberFormat documentation, respectively.
42586 * @param string $pattern Pattern string in case chosen style requires
42587 *   pattern.
42588 * @return NumberFormatter
42589 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42590 **/
42591function numfmt_create($locale, $style, $pattern){}
42592
42593/**
42594 * Format a numeric value according to the formatter rules.
42595 *
42596 * @param NumberFormatter $fmt NumberFormatter object.
42597 * @param number $value The value to format. Can be integer or double,
42598 *   other values will be converted to a numeric value.
42599 * @param int $type The formatting type to use.
42600 * @return string
42601 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42602 **/
42603function numfmt_format($fmt, $value, $type){}
42604
42605/**
42606 * Format the currency value according to the formatter rules.
42607 *
42608 * @param NumberFormatter $fmt NumberFormatter object.
42609 * @param float $value The numeric currency value.
42610 * @param string $currency The 3-letter ISO 4217 currency code
42611 *   indicating the currency to use.
42612 * @return string
42613 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42614 **/
42615function numfmt_format_currency($fmt, $value, $currency){}
42616
42617/**
42618 * Get a numeric attribute associated with the formatter. An example of a
42619 * numeric attribute is the number of integer digits the formatter will
42620 * produce.
42621 *
42622 * @param NumberFormatter $fmt NumberFormatter object.
42623 * @param int $attr Attribute specifier - one of the numeric attribute
42624 *   constants.
42625 * @return int
42626 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42627 **/
42628function numfmt_get_attribute($fmt, $attr){}
42629
42630/**
42631 * Get error code from the last function performed by the formatter.
42632 *
42633 * @param NumberFormatter $fmt NumberFormatter object.
42634 * @return int
42635 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42636 **/
42637function numfmt_get_error_code($fmt){}
42638
42639/**
42640 * Get error message from the last function performed by the formatter.
42641 *
42642 * @param NumberFormatter $fmt NumberFormatter object.
42643 * @return string
42644 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42645 **/
42646function numfmt_get_error_message($fmt){}
42647
42648/**
42649 * Get formatter locale name.
42650 *
42651 * @param NumberFormatter $fmt NumberFormatter object.
42652 * @param int $type You can choose between valid and actual locale (
42653 *   Locale::VALID_LOCALE, Locale::ACTUAL_LOCALE, respectively). The
42654 *   default is the actual locale.
42655 * @return string
42656 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42657 **/
42658function numfmt_get_locale($fmt, $type){}
42659
42660/**
42661 * Extract pattern used by the formatter.
42662 *
42663 * @param NumberFormatter $fmt NumberFormatter object.
42664 * @return string
42665 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42666 **/
42667function numfmt_get_pattern($fmt){}
42668
42669/**
42670 * Get a symbol associated with the formatter. The formatter uses symbols
42671 * to represent the special locale-dependent characters in a number, for
42672 * example the percent sign. This API is not supported for rule-based
42673 * formatters.
42674 *
42675 * @param NumberFormatter $fmt NumberFormatter object.
42676 * @param int $attr Symbol specifier, one of the format symbol
42677 *   constants.
42678 * @return string
42679 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42680 **/
42681function numfmt_get_symbol($fmt, $attr){}
42682
42683/**
42684 * Get a text attribute associated with the formatter. An example of a
42685 * text attribute is the suffix for positive numbers. If the formatter
42686 * does not understand the attribute, U_UNSUPPORTED_ERROR error is
42687 * produced. Rule-based formatters only understand
42688 * NumberFormatter::DEFAULT_RULESET and NumberFormatter::PUBLIC_RULESETS.
42689 *
42690 * @param NumberFormatter $fmt NumberFormatter object.
42691 * @param int $attr Attribute specifier - one of the text attribute
42692 *   constants.
42693 * @return string
42694 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42695 **/
42696function numfmt_get_text_attribute($fmt, $attr){}
42697
42698/**
42699 * Parse a string into a number using the current formatter rules.
42700 *
42701 * @param NumberFormatter $fmt NumberFormatter object.
42702 * @param string $value The formatting type to use. By default,
42703 *   NumberFormatter::TYPE_DOUBLE is used.
42704 * @param int $type Offset in the string at which to begin parsing. On
42705 *   return, this value will hold the offset at which parsing ended.
42706 * @param int $position
42707 * @return mixed
42708 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42709 **/
42710function numfmt_parse($fmt, $value, $type, &$position){}
42711
42712/**
42713 * Parse a string into a double and a currency using the current
42714 * formatter.
42715 *
42716 * @param NumberFormatter $fmt NumberFormatter object.
42717 * @param string $value Parameter to receive the currency name
42718 *   (3-letter ISO 4217 currency code).
42719 * @param string $currency Offset in the string at which to begin
42720 *   parsing. On return, this value will hold the offset at which parsing
42721 *   ended.
42722 * @param int $position
42723 * @return float
42724 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42725 **/
42726function numfmt_parse_currency($fmt, $value, &$currency, &$position){}
42727
42728/**
42729 * Set a numeric attribute associated with the formatter. An example of a
42730 * numeric attribute is the number of integer digits the formatter will
42731 * produce.
42732 *
42733 * @param NumberFormatter $fmt NumberFormatter object.
42734 * @param int $attr Attribute specifier - one of the numeric attribute
42735 *   constants.
42736 * @param int $value The attribute value.
42737 * @return bool
42738 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42739 **/
42740function numfmt_set_attribute($fmt, $attr, $value){}
42741
42742/**
42743 * Set the pattern used by the formatter. Can not be used on a rule-based
42744 * formatter.
42745 *
42746 * @param NumberFormatter $fmt NumberFormatter object.
42747 * @param string $pattern Pattern in syntax described in ICU
42748 *   DecimalFormat documentation.
42749 * @return bool
42750 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42751 **/
42752function numfmt_set_pattern($fmt, $pattern){}
42753
42754/**
42755 * Set a symbol associated with the formatter. The formatter uses symbols
42756 * to represent the special locale-dependent characters in a number, for
42757 * example the percent sign. This API is not supported for rule-based
42758 * formatters.
42759 *
42760 * @param NumberFormatter $fmt NumberFormatter object.
42761 * @param int $attr Symbol specifier, one of the format symbol
42762 *   constants.
42763 * @param string $value Text for the symbol.
42764 * @return bool
42765 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42766 **/
42767function numfmt_set_symbol($fmt, $attr, $value){}
42768
42769/**
42770 * Set a text attribute associated with the formatter. An example of a
42771 * text attribute is the suffix for positive numbers. If the formatter
42772 * does not understand the attribute, U_UNSUPPORTED_ERROR error is
42773 * produced. Rule-based formatters only understand
42774 * NumberFormatter::DEFAULT_RULESET and NumberFormatter::PUBLIC_RULESETS.
42775 *
42776 * @param NumberFormatter $fmt NumberFormatter object.
42777 * @param int $attr Attribute specifier - one of the text attribute
42778 *   constants.
42779 * @param string $value Text for the attribute value.
42780 * @return bool
42781 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
42782 **/
42783function numfmt_set_text_attribute($fmt, $attr, $value){}
42784
42785/**
42786 * Generates a Signature Base String according to pecl/oauth.
42787 *
42788 * @param string $http_method The HTTP method.
42789 * @param string $uri URI to encode.
42790 * @param array $request_parameters Array of request parameters.
42791 * @return string
42792 * @since PECL OAuth >=0.99.7
42793 **/
42794function oauth_get_sbs($http_method, $uri, $request_parameters){}
42795
42796/**
42797 * Encodes a URI to RFC 3986.
42798 *
42799 * @param string $uri URI to encode.
42800 * @return string
42801 * @since PECL OAuth >=0.99.2
42802 **/
42803function oauth_urlencode($uri){}
42804
42805/**
42806 * This function discards the contents of the output buffer.
42807 *
42808 * This function does not destroy the output buffer like {@link
42809 * ob_end_clean} does.
42810 *
42811 * @return void
42812 * @since PHP 4 >= 4.2.0, PHP 5
42813 **/
42814function ob_clean(){}
42815
42816/**
42817 * The deflate output buffer handler can only be used once.
42818 *
42819 * It conflicts with {@link ob_gzhandler} and zlib.output_compression as
42820 * well and should not be used after mbstring extension's {@link
42821 * mb_output_handler} and session extension's URL-Rewriter (AKA
42822 * session.use_trans_sid).
42823 *
42824 * @param string $data
42825 * @param int $mode
42826 * @return string
42827 * @since PECL pecl_http >= 0.21.0
42828 **/
42829function ob_deflatehandler($data, $mode){}
42830
42831/**
42832 * This function discards the contents of the topmost output buffer and
42833 * turns off this output buffering. If you want to further process the
42834 * buffer's contents you have to call {@link ob_get_contents} before
42835 * {@link ob_end_clean} as the buffer contents are discarded when {@link
42836 * ob_end_clean} is called.
42837 *
42838 * @return bool
42839 * @since PHP 4, PHP 5
42840 **/
42841function ob_end_clean(){}
42842
42843/**
42844 * This function will send the contents of the topmost output buffer (if
42845 * any) and turn this output buffer off. If you want to further process
42846 * the buffer's contents you have to call {@link ob_get_contents} before
42847 * {@link ob_end_flush} as the buffer contents are discarded after {@link
42848 * ob_end_flush} is called.
42849 *
42850 * @return bool
42851 * @since PHP 4, PHP 5
42852 **/
42853function ob_end_flush(){}
42854
42855/**
42856 * Output buffer handler generating an ETag with the hash algorithm
42857 * specified with the http.etag.mode.
42858 *
42859 * This output handler is used by {@link http_cache_etag}.
42860 *
42861 * @param string $data
42862 * @param int $mode
42863 * @return string
42864 * @since PECL pecl_http >= 0.10.0
42865 **/
42866function ob_etaghandler($data, $mode){}
42867
42868/**
42869 * This function will send the contents of the output buffer (if any). If
42870 * you want to further process the buffer's contents you have to call
42871 * {@link ob_get_contents} before {@link ob_flush} as the buffer contents
42872 * are discarded after {@link ob_flush} is called.
42873 *
42874 * This function does not destroy the output buffer like {@link
42875 * ob_end_flush} does.
42876 *
42877 * @return void
42878 * @since PHP 4 >= 4.2.0, PHP 5
42879 **/
42880function ob_flush(){}
42881
42882/**
42883 * Gets the current buffer contents and delete current output buffer.
42884 *
42885 * {@link ob_get_clean} essentially executes both {@link ob_get_contents}
42886 * and {@link ob_end_clean}.
42887 *
42888 * @return string
42889 * @since PHP 4 >= 4.3.0, PHP 5
42890 **/
42891function ob_get_clean(){}
42892
42893/**
42894 * Gets the contents of the output buffer without clearing it.
42895 *
42896 * @return string
42897 * @since PHP 4, PHP 5
42898 **/
42899function ob_get_contents(){}
42900
42901/**
42902 * {@link ob_get_flush} flushes the output buffer, return it as a string
42903 * and turns off output buffering.
42904 *
42905 * @return string
42906 * @since PHP 4 >= 4.3.0, PHP 5
42907 **/
42908function ob_get_flush(){}
42909
42910/**
42911 * This will return the length of the contents in the output buffer.
42912 *
42913 * @return int
42914 * @since PHP 4 >= 4.0.2, PHP 5
42915 **/
42916function ob_get_length(){}
42917
42918/**
42919 * Returns the nesting level of the output buffering mechanism.
42920 *
42921 * @return int
42922 * @since PHP 4 >= 4.2.0, PHP 5
42923 **/
42924function ob_get_level(){}
42925
42926/**
42927 * {@link ob_get_status} returns status information on either the top
42928 * level output buffer or all active output buffer levels if {@link
42929 * full_status} is set to .
42930 *
42931 * @param bool $full_status to return all active output buffer levels.
42932 *   If or not set, only the top level output buffer is returned.
42933 * @return array
42934 * @since PHP 4 >= 4.2.0, PHP 5
42935 **/
42936function ob_get_status($full_status){}
42937
42938/**
42939 * {@link ob_gzhandler} is intended to be used as a callback function for
42940 * {@link ob_start} to help facilitate sending gz-encoded data to web
42941 * browsers that support compressed web pages. Before {@link
42942 * ob_gzhandler} actually sends compressed data, it determines what type
42943 * of content encoding the browser will accept ("gzip", "deflate" or none
42944 * at all) and will return its output accordingly. All browsers are
42945 * supported since it's up to the browser to send the correct header
42946 * saying that it accepts compressed web pages. If a browser doesn't
42947 * support compressed pages this function returns .
42948 *
42949 * @param string $buffer
42950 * @param int $mode
42951 * @return string
42952 * @since PHP 4 >= 4.0.4, PHP 5
42953 **/
42954function ob_gzhandler($buffer, $mode){}
42955
42956/**
42957 * Converts the string encoded in {@link internal_encoding} to {@link
42958 * output_encoding}.
42959 *
42960 * {@link internal_encoding} and {@link output_encoding} should be
42961 * defined in the file or in {@link iconv_set_encoding}.
42962 *
42963 * @param string $contents
42964 * @param int $status
42965 * @return string
42966 * @since PHP 4 >= 4.0.5, PHP 5
42967 **/
42968function ob_iconv_handler($contents, $status){}
42969
42970/**
42971 * {@link ob_implicit_flush} will turn implicit flushing on or off.
42972 * Implicit flushing will result in a flush operation after every output
42973 * call, so that explicit calls to {@link flush} will no longer be
42974 * needed.
42975 *
42976 * @param int $flag to turn implicit flushing on, otherwise.
42977 * @return void
42978 * @since PHP 4, PHP 5
42979 **/
42980function ob_implicit_flush($flag){}
42981
42982/**
42983 * Same restrictions as with {@link ob_deflatehandler} apply.
42984 *
42985 * @param string $data
42986 * @param int $mode
42987 * @return string
42988 * @since PECL pecl_http >= 0.21.0
42989 **/
42990function ob_inflatehandler($data, $mode){}
42991
42992/**
42993 * Lists all output handlers in use.
42994 *
42995 * @return array
42996 * @since PHP 4 >= 4.3.0, PHP 5
42997 **/
42998function ob_list_handlers(){}
42999
43000/**
43001 * This function will turn output buffering on. While output buffering is
43002 * active no output is sent from the script (other than headers), instead
43003 * the output is stored in an internal buffer.
43004 *
43005 * The contents of this internal buffer may be copied into a string
43006 * variable using {@link ob_get_contents}. To output what is stored in
43007 * the internal buffer, use {@link ob_end_flush}. Alternatively, {@link
43008 * ob_end_clean} will silently discard the buffer contents.
43009 *
43010 * Output buffers are stackable, that is, you may call {@link ob_start}
43011 * while another {@link ob_start} is active. Just make sure that you call
43012 * {@link ob_end_flush} the appropriate number of times. If multiple
43013 * output callback functions are active, output is being filtered
43014 * sequentially through each of them in nesting order.
43015 *
43016 * @param callback $output_callback An optional {@link output_callback}
43017 *   function may be specified. This function takes a string as a
43018 *   parameter and should return a string. The function will be called
43019 *   when the output buffer is flushed (sent) or cleaned (with {@link
43020 *   ob_flush}, {@link ob_clean} or similar function) or when the output
43021 *   buffer is flushed to the browser at the end of the request. When
43022 *   {@link output_callback} is called, it will receive the contents of
43023 *   the output buffer as its parameter and is expected to return a new
43024 *   output buffer as a result, which will be sent to the browser. If the
43025 *   {@link output_callback} is not a callable function, this function
43026 *   will return . If the callback function has two parameters, the
43027 *   second parameter is filled with a bit-field consisting of
43028 *   PHP_OUTPUT_HANDLER_START, PHP_OUTPUT_HANDLER_CONT and
43029 *   PHP_OUTPUT_HANDLER_END. If {@link output_callback} returns original
43030 *   input is sent to the browser. The {@link output_callback} parameter
43031 *   may be bypassed by passing a value. {@link ob_end_clean}, {@link
43032 *   ob_end_flush}, {@link ob_clean}, {@link ob_flush} and {@link
43033 *   ob_start} may not be called from a callback function. If you call
43034 *   them from callback function, the behavior is undefined. If you would
43035 *   like to delete the contents of a buffer, return "" (a null string)
43036 *   from callback function. You can't even call functions using the
43037 *   output buffering functions like print_r($expression, true) or
43038 *   highlight_file($filename, true) from a callback function.
43039 * @param int $chunk_size If the optional parameter {@link chunk_size}
43040 *   is passed, the buffer will be flushed after any output call which
43041 *   causes the buffer's length to equal or exceed {@link chunk_size}.
43042 *   Default value 0 means that the function is called only in the end,
43043 *   other special value 1 sets {@link chunk_size} to 4096.
43044 * @param bool $erase If the optional parameter {@link erase} is set to
43045 *   , the buffer will not be deleted until the script finishes. This
43046 *   causes that flushing and cleaning functions would issue a notice and
43047 *   return if called.
43048 * @return bool
43049 * @since PHP 4, PHP 5
43050 **/
43051function ob_start($output_callback, $chunk_size, $erase){}
43052
43053/**
43054 * Callback function for {@link ob_start} to repair the buffer.
43055 *
43056 * @param string $input The buffer.
43057 * @param int $mode The buffer mode.
43058 * @return string
43059 * @since PHP 5
43060 **/
43061function ob_tidyhandler($input, $mode){}
43062
43063/**
43064 * This function is deprecated. Recommended alternatives: {@link
43065 * oci_fetch_array}, {@link oci_fetch_object}, {@link oci_fetch_assoc}
43066 * and {@link oci_fetch_row}.
43067 *
43068 * @param resource $statement
43069 * @param array $result
43070 * @param int $mode
43071 * @return int
43072 * @since PHP 4, PHP 5, PECL OCI8 >= 1.0.0
43073 **/
43074function ocifetchinto($statement, &$result, $mode){}
43075
43076/**
43077 * Binds the PHP array {@link var_array} to the Oracle placeholder {@link
43078 * name}, which points to Oracle PL/SQL array. Whether it will be used
43079 * for input or output will be determined at run-time.
43080 *
43081 * @param resource $statement A valid OCI statement identifier.
43082 * @param string $name The Oracle placeholder.
43083 * @param array $var_array An array.
43084 * @param int $max_table_length Sets the maximum length both for
43085 *   incoming and result arrays.
43086 * @param int $max_item_length Sets maximum length for array items. If
43087 *   not specified or equals to -1, {@link oci_bind_array_by_name} will
43088 *   use find the longest element in the incoming array and will use it
43089 *   as maximum length for array items.
43090 * @param int $type Should be used to set the type of PL/SQL array
43091 *   items. See list of available types below:
43092 *
43093 *   SQLT_NUM - for arrays of NUMBER. SQLT_INT - for arrays of INTEGER
43094 *   (Note: INTEGER it is actually a synonym for NUMBER(38), but SQLT_NUM
43095 *   type won't work in this case even though they are synonyms).
43096 *   SQLT_FLT - for arrays of FLOAT. SQLT_AFC - for arrays of CHAR.
43097 *   SQLT_CHR - for arrays of VARCHAR2. SQLT_VCS - for arrays of VARCHAR.
43098 *   SQLT_AVC - for arrays of CHARZ. SQLT_STR - for arrays of STRING.
43099 *   SQLT_LVC - for arrays of LONG VARCHAR. SQLT_ODT - for arrays of
43100 *   DATE.
43101 * @return bool
43102 * @since PHP 5 >= 5.1.2, PECL OCI8 >= 1.2.0
43103 **/
43104function oci_bind_array_by_name($statement, $name, &$var_array, $max_table_length, $max_item_length, $type){}
43105
43106/**
43107 * Binds a PHP variable {@link variable} to the Oracle bind variable
43108 * placeholder {@link bv_name}. Binding is important for Oracle database
43109 * performance and also as a way to avoid SQL Injection security issues.
43110 *
43111 * Binding allows the database to reuse the statement context and caches
43112 * from previous executions of the statement, even if another user or
43113 * process originally executed it. Binding reduces SQL Injection concerns
43114 * because the data associated with a bind variable is never treated as
43115 * part of the SQL statement. It does not need quoting or escaping.
43116 *
43117 * PHP variables that have been bound can be changed and the statement
43118 * re-executed without needing to re-parse the statement or re-bind.
43119 *
43120 * In Oracle, bind variables are commonly divided into IN binds for
43121 * values that are passed into the database, and OUT binds for values
43122 * that are returned to PHP. A bind variable may be both IN and OUT.
43123 * Whether a bind variable will be used for input or output is determined
43124 * at run-time.
43125 *
43126 * You must specify {@link maxlength} when using an OUT bind so that PHP
43127 * allocates enough memory to hold the returned value.
43128 *
43129 * For IN binds it is recommended to set the {@link maxlength} length if
43130 * the statement is re-executed multiple times with different values for
43131 * the PHP variable. Otherwise Oracle may truncate data to the length of
43132 * the initial PHP variable value. If you don't know what the maximum
43133 * length will be, then re-call {@link oci_bind_by_name} with the current
43134 * data size prior to each {@link oci_execute} call. Binding an
43135 * unnecessarily large length will have an impact on process memory in
43136 * the database.
43137 *
43138 * A bind call tells Oracle which memory address to read data from. For
43139 * IN binds that address needs to contain valid data when {@link
43140 * oci_execute} is called. This means that the variable bound must remain
43141 * in scope until execution. If it doesn't, unexpected results or errors
43142 * such as "ORA-01460: unimplemented or unreasonable conversion
43143 * requested" may occur. For OUT binds one symptom is no value being set
43144 * in the PHP variable.
43145 *
43146 * For a statement that is repeatedly executed, binding values that never
43147 * change may reduce the ability of the Oracle optimizer to choose the
43148 * best statement execution plan. Long running statements that are rarely
43149 * re-executed may not benefit from binding. However in both cases,
43150 * binding might be safer than joining strings into a SQL statement, as
43151 * this can be a security risk if unfiltered user text is concatenated.
43152 *
43153 * @param resource $statement A valid OCI8 statement identifer.
43154 * @param string $bv_name The colon-prefixed bind variable placeholder
43155 *   used in the statement. The colon is optional in {@link bv_name}.
43156 *   Oracle does not use question marks for placeholders.
43157 * @param mixed $variable The PHP variable to be associated with {@link
43158 *   bv_name}
43159 * @param int $maxlength Sets the maximum length for the data. If you
43160 *   set it to -1, this function will use the current length of {@link
43161 *   variable} to set the maximum length. In this case the {@link
43162 *   variable} must exist and contain data when {@link oci_bind_by_name}
43163 *   is called.
43164 * @param int $type The datatype that Oracle will treat the data as.
43165 *   The default {@link type} used is SQLT_CHR. Oracle will convert the
43166 *   data between this type and the database column (or PL/SQL variable
43167 *   type), when possible. If you need to bind an abstract datatype
43168 *   (LOB/ROWID/BFILE) you need to allocate it first using the {@link
43169 *   oci_new_descriptor} function. The {@link length} is not used for
43170 *   abstract datatypes and should be set to -1. Possible values for
43171 *   {@link type} are: SQLT_BFILEE or OCI_B_BFILE - for BFILEs;
43172 *   SQLT_CFILEE or OCI_B_CFILEE - for CFILEs; SQLT_CLOB or OCI_B_CLOB -
43173 *   for CLOBs; SQLT_BLOB or OCI_B_BLOB - for BLOBs; SQLT_RDD or
43174 *   OCI_B_ROWID - for ROWIDs; SQLT_NTY or OCI_B_NTY - for named
43175 *   datatypes; SQLT_INT or OCI_B_INT - for integers; SQLT_CHR - for
43176 *   VARCHARs; SQLT_BIN or OCI_B_BIN - for RAW columns; SQLT_LNG - for
43177 *   LONG columns; SQLT_LBI - for LONG RAW columns; SQLT_RSET - for
43178 *   cursors created with {@link oci_new_cursor}.
43179 * @return bool
43180 * @since PHP 5, PECL OCI8 >= 1.1.0
43181 **/
43182function oci_bind_by_name($statement, $bv_name, &$variable, $maxlength, $type){}
43183
43184/**
43185 * Invalidates a cursor, freeing all associated resources and cancels the
43186 * ability to read from it.
43187 *
43188 * @param resource $statement An OCI statement.
43189 * @return bool
43190 * @since PHP 5, PECL OCI8 >= 1.1.0
43191 **/
43192function oci_cancel($statement){}
43193
43194/**
43195 * Unsets {@link connection}. The underlying database connection is
43196 * closed if no other resources are using it and if it was created with
43197 * {@link oci_connect} or {@link oci_new_connect}.
43198 *
43199 * It is recommended to close connections that are no longer needed
43200 * because this makes database resources available for other users.
43201 *
43202 * @param resource $connection An Oracle connection identifier returned
43203 *   by {@link oci_connect}, {@link oci_pconnect}, or {@link
43204 *   oci_new_connect}.
43205 * @return bool
43206 * @since PHP 5, PECL OCI8 >= 1.1.0
43207 **/
43208function oci_close($connection){}
43209
43210/**
43211 * Commits the outstanding transaction for the Oracle {@link connection}.
43212 * A commit ends the current transaction and makes permanent all changes.
43213 * It releases all locks held.
43214 *
43215 * A transaction begins when the first SQL statement that changes data is
43216 * executed with {@link oci_execute} using the OCI_NO_AUTO_COMMIT flag.
43217 * Further data changes made by other statements become part of the same
43218 * transaction. Data changes made in a transaction are temporary until
43219 * the transaction is committed or rolled back. Other users of the
43220 * database will not see the changes until they are committed.
43221 *
43222 * When inserting or updating data, using transactions is recommended for
43223 * relational data consistency and for performance reasons.
43224 *
43225 * @param resource $connection An Oracle connection identifier,
43226 *   returned by {@link oci_connect}, {@link oci_pconnect}, or {@link
43227 *   oci_new_connect}.
43228 * @return bool
43229 * @since PHP 5, PECL OCI8 >= 1.1.0
43230 **/
43231function oci_commit($connection){}
43232
43233/**
43234 * Returns a connection identifier needed for most other OCI8 operations.
43235 *
43236 * See Connection Handling for general information on connection
43237 * management and connection pooling.
43238 *
43239 * From PHP 5.1.2 (PECL OCI8 1.1) {@link oci_close} can be used to close
43240 * the connection.
43241 *
43242 * The second and subsequent calls to {@link oci_connect} with the same
43243 * parameters will return the connection handle returned from the first
43244 * call. This means that transactions in one handle are also in the other
43245 * handles, because they use the same underlying database connection. If
43246 * two handles need to be transactionally isolated from each other, use
43247 * {@link oci_new_connect} instead.
43248 *
43249 * @param string $username The Oracle user name.
43250 * @param string $password The password for {@link username}.
43251 * @param string $connection_string
43252 * @param string $character_set
43253 * @param int $session_mode
43254 * @return resource
43255 * @since PHP 5, PECL OCI8 >= 1.1.0
43256 **/
43257function oci_connect($username, $password, $connection_string, $character_set, $session_mode){}
43258
43259/**
43260 * Associates a PHP variable with a column for query fetches using {@link
43261 * oci_fetch}.
43262 *
43263 * The {@link oci_define_by_name} call must occur before executing {@link
43264 * oci_execute}.
43265 *
43266 * @param resource $statement
43267 * @param string $column_name The column name used in the query. Use
43268 *   uppercase for Oracle's default, non-case sensitive column names. Use
43269 *   the exact column name case for case-sensitive column names.
43270 * @param mixed $variable The PHP variable that will contain the
43271 *   returned column value.
43272 * @param int $type The data type to be returned. Generally not needed.
43273 *   Note that Oracle-style data conversions are not performed. For
43274 *   example, SQLT_INT will be ignored and the returned data type will
43275 *   still be SQLT_CHR. You can optionally use {@link oci_new_descriptor}
43276 *   to allocate LOB/ROWID/BFILE descriptors.
43277 * @return bool
43278 * @since PHP 5, PECL OCI8 >= 1.1.0
43279 **/
43280function oci_define_by_name($statement, $column_name, &$variable, $type){}
43281
43282/**
43283 * Returns the last error found.
43284 *
43285 * The function should be called immediately after an error occurs.
43286 * Errors are cleared by a successful statement.
43287 *
43288 * @param resource $resource For most errors, {@link resource} is the
43289 *   resource handle that was passed to the failing function call. For
43290 *   connection errors with {@link oci_connect}, {@link oci_new_connect}
43291 *   or {@link oci_pconnect} do not pass {@link resource}.
43292 * @return array
43293 * @since PHP 5, PECL OCI8 >= 1.1.0
43294 **/
43295function oci_error($resource){}
43296
43297/**
43298 * Executes a {@link statement} previously returned from {@link
43299 * oci_parse}.
43300 *
43301 * After execution, statements like INSERT will have data committed to
43302 * the database by default. For statements like SELECT, execution
43303 * performs the logic of the query. Query results can subsequently be
43304 * fetched in PHP with functions like {@link oci_fetch_array}.
43305 *
43306 * Each parsed statement may be executed multiple times, saving the cost
43307 * of re-parsing. This is commonly used for INSERT statements when data
43308 * is bound with {@link oci_bind_by_name}.
43309 *
43310 * @param resource $statement A valid OCI statement identifier.
43311 * @param int $mode An optional second parameter can be one of the
43312 *   following constants: Execution Modes Constant Description
43313 *   OCI_COMMIT_ON_SUCCESS Automatically commit all outstanding changes
43314 *   for this connection when the statement has succeeded. This is the
43315 *   default. OCI_DEFAULT Obsolete as of PHP 5.3.2 (PECL OCI8 1.4) but
43316 *   still available for backward compatibility. Use the equivalent
43317 *   OCI_NO_AUTO_COMMIT in new code. OCI_DESCRIBE_ONLY Make query meta
43318 *   data available to functions like {@link oci_field_name} but do not
43319 *   create a result set. Any subsequent fetch call such as {@link
43320 *   oci_fetch_array} will fail. OCI_NO_AUTO_COMMIT Do not automatically
43321 *   commit changes. Prior to PHP 5.3.2 (PECL OCI8 1.4) use OCI_DEFAULT
43322 *   which is an alias for OCI_NO_AUTO_COMMIT. Using OCI_NO_AUTO_COMMIT
43323 *   mode starts a transaction. Transactions are automatically rolled
43324 *   back when the connection is closed, or when the script ends.
43325 *   Explicitly call {@link oci_commit} to commit a transaction, or
43326 *   {@link oci_rollback} to abort it. When inserting or updating data,
43327 *   using transactions is recommended for relational data consistency
43328 *   and for performance reasons. If OCI_NO_AUTO_COMMIT mode is used for
43329 *   any statement including queries, and {@link oci_commit} or {@link
43330 *   oci_rollback} is not subsequently called, then OCI8 will perform a
43331 *   rollback at the end of the script even if no data was changed. To
43332 *   avoid an unnecessary rollback, many scripts do not use
43333 *   OCI_NO_AUTO_COMMIT mode for queries or PL/SQL. Be careful to ensure
43334 *   the appropriate transactional consistency for the application when
43335 *   using {@link oci_execute} with different modes in the same script.
43336 * @return bool
43337 * @since PHP 5, PECL OCI8 >= 1.1.0
43338 **/
43339function oci_execute($statement, $mode){}
43340
43341/**
43342 * Fetches the next row from a query into internal buffers accessible
43343 * either with {@link oci_result}, or by using variables previously
43344 * defined with {@link oci_define_by_name}.
43345 *
43346 * See {@link oci_fetch_array} for general information about fetching
43347 * data.
43348 *
43349 * @param resource $statement
43350 * @return bool
43351 * @since PHP 5, PECL OCI8 >= 1.1.0
43352 **/
43353function oci_fetch($statement){}
43354
43355/**
43356 * Fetches multiple rows from a query into a two-dimensional array. By
43357 * default, all rows are returned.
43358 *
43359 * This function can be called only once for each query executed with
43360 * {@link oci_execute}.
43361 *
43362 * @param resource $statement
43363 * @param array $output The variable to contain the returned rows. LOB
43364 *   columns are returned as strings, where Oracle supports conversion.
43365 *   See {@link oci_fetch_array} for more information on how data and
43366 *   types are fetched.
43367 * @param int $skip The number of initial rows to discard when fetching
43368 *   the result. The default value is 0, so the first row onwards is
43369 *   returned.
43370 * @param int $maxrows The number of rows to return. The default is -1
43371 *   meaning return all the rows from {@link skip} + 1 onwards.
43372 * @param int $flags Parameter {@link flags} indicates the array
43373 *   structure and whether associative arrays should be used. {@link
43374 *   oci_fetch_all} Array Structure Modes Constant Description
43375 *   OCI_FETCHSTATEMENT_BY_ROW The outer array will contain one sub-array
43376 *   per query row. OCI_FETCHSTATEMENT_BY_COLUMN The outer array will
43377 *   contain one sub-array per query column. This is the default. Arrays
43378 *   can be indexed by column heading or numerically. {@link
43379 *   oci_fetch_all} Array Index Modes Constant Description OCI_NUM
43380 *   Numeric indexes are used for each column's array. OCI_ASSOC
43381 *   Associative indexes are used for each column's array. This is the
43382 *   default. Use the addition operator + to choose a combination of
43383 *   array structure and index modes. Oracle's default, non-case
43384 *   sensitive column names will have uppercase array keys.
43385 *   Case-sensitive column names will have array keys using the exact
43386 *   column case. Use {@link var_dump} on {@link output}to verify the
43387 *   appropriate case to use for each query. Queries that have more than
43388 *   one column with the same name should use column aliases. Otherwise
43389 *   only one of the columns will appear in an associative array.
43390 * @return int
43391 * @since PHP 5, PECL OCI8 >= 1.1.0
43392 **/
43393function oci_fetch_all($statement, &$output, $skip, $maxrows, $flags){}
43394
43395/**
43396 * Returns an array containing the next result-set row of a query. Each
43397 * array entry corresponds to a column of the row. This function is
43398 * typically called in a loop until it returns , indicating no more rows
43399 * exist.
43400 *
43401 * @param resource $statement
43402 * @param int $mode An optional second parameter can be any combination
43403 *   of the following constants: {@link oci_fetch_array} Modes Constant
43404 *   Description OCI_BOTH Returns an array with both associative and
43405 *   numeric indices. This is the same as OCI_ASSOC + OCI_NUM and is the
43406 *   default behavior. OCI_ASSOC Returns an associative array. OCI_NUM
43407 *   Returns a numeric array. OCI_RETURN_NULLS Creates elements for
43408 *   fields. The element values will be a PHP . OCI_RETURN_LOBS Returns
43409 *   the contents of LOBs instead of the LOB descriptors. The default
43410 *   {@link mode} is OCI_BOTH. Use the addition operator + to specify
43411 *   more than one mode at a time.
43412 * @return array
43413 * @since PHP 5, PECL OCI8 >= 1.1.0
43414 **/
43415function oci_fetch_array($statement, $mode){}
43416
43417/**
43418 * Returns an associative array containing the next result-set row of a
43419 * query. Each array entry corresponds to a column of the row. This
43420 * function is typically called in a loop until it returns , indicating
43421 * no more rows exist.
43422 *
43423 * Calling {@link oci_fetch_assoc} is identical to calling {@link
43424 * oci_fetch_array} with OCI_ASSOC + OCI_RETURN_NULLS.
43425 *
43426 * @param resource $statement
43427 * @return array
43428 * @since PHP 5, PECL OCI8 >= 1.1.0
43429 **/
43430function oci_fetch_assoc($statement){}
43431
43432/**
43433 * Returns an object containing the next result-set row of a query. Each
43434 * attribute of the object corresponds to a column of the row. This
43435 * function is typically called in a loop until it returns , indicating
43436 * no more rows exist.
43437 *
43438 * @param resource $statement
43439 * @return object
43440 * @since PHP 5, PECL OCI8 >= 1.1.0
43441 **/
43442function oci_fetch_object($statement){}
43443
43444/**
43445 * Returns a numerically indexed array containing the next result-set row
43446 * of a query. Each array entry corresponds to a column of the row. This
43447 * function is typically called in a loop until it returns , indicating
43448 * no more rows exist.
43449 *
43450 * Calling {@link oci_fetch_row} is identical to calling {@link
43451 * oci_fetch_array} with OCI_NUM + OCI_RETURN_NULLS.
43452 *
43453 * @param resource $statement
43454 * @return array
43455 * @since PHP 5, PECL OCI8 >= 1.1.0
43456 **/
43457function oci_fetch_row($statement){}
43458
43459/**
43460 * Checks if the given {@link field} from the {@link statement} is .
43461 *
43462 * @param resource $statement A valid OCI statement identifier.
43463 * @param mixed $field Can be a field's index or a field's name
43464 *   (uppercased).
43465 * @return bool
43466 * @since PHP 5, PECL OCI8 >= 1.1.0
43467 **/
43468function oci_field_is_null($statement, $field){}
43469
43470/**
43471 * Returns the name of the {@link field}.
43472 *
43473 * @param resource $statement A valid OCI statement identifier.
43474 * @param int $field Can be the field's index (1-based) or name.
43475 * @return string
43476 * @since PHP 5, PECL OCI8 >= 1.1.0
43477 **/
43478function oci_field_name($statement, $field){}
43479
43480/**
43481 * Returns precision of the {@link field}.
43482 *
43483 * For FLOAT columns, precision is nonzero and scale is -127. If
43484 * precision is 0, then column is NUMBER. Else it's NUMBER(precision,
43485 * scale).
43486 *
43487 * @param resource $statement A valid OCI statement identifier.
43488 * @param int $field Can be the field's index (1-based) or name.
43489 * @return int
43490 * @since PHP 5, PECL OCI8 >= 1.1.0
43491 **/
43492function oci_field_precision($statement, $field){}
43493
43494/**
43495 * Returns the scale of the column with {@link field} index.
43496 *
43497 * For FLOAT columns, precision is nonzero and scale is -127. If
43498 * precision is 0, then column is NUMBER. Else it's NUMBER(precision,
43499 * scale).
43500 *
43501 * @param resource $statement A valid OCI statement identifier.
43502 * @param int $field Can be the field's index (1-based) or name.
43503 * @return int
43504 * @since PHP 5, PECL OCI8 >= 1.1.0
43505 **/
43506function oci_field_scale($statement, $field){}
43507
43508/**
43509 * Returns the size of a {@link field}.
43510 *
43511 * @param resource $statement A valid OCI statement identifier.
43512 * @param mixed $field Can be the field's index (1-based) or name.
43513 * @return int
43514 * @since PHP 5, PECL OCI8 >= 1.1.0
43515 **/
43516function oci_field_size($statement, $field){}
43517
43518/**
43519 * Returns a field's data type.
43520 *
43521 * @param resource $statement A valid OCI statement identifier.
43522 * @param int $field Can be the field's index (1-based) or name.
43523 * @return mixed
43524 * @since PHP 5, PECL OCI8 >= 1.1.0
43525 **/
43526function oci_field_type($statement, $field){}
43527
43528/**
43529 * Returns Oracle's raw data type of the {@link field}.
43530 *
43531 * However, if you want to get field's type, then {@link oci_field_type}
43532 * will suit you better.
43533 *
43534 * @param resource $statement A valid OCI statement identifier.
43535 * @param int $field Can be the field's index (1-based) or name.
43536 * @return int
43537 * @since PHP 5, PECL OCI8 >= 1.1.0
43538 **/
43539function oci_field_type_raw($statement, $field){}
43540
43541/**
43542 * Frees resources associated with Oracle's cursor or statement, which
43543 * was received from as a result of {@link oci_parse} or obtained from
43544 * Oracle.
43545 *
43546 * @param resource $statement A valid OCI statement identifier.
43547 * @return bool
43548 * @since PHP 5, PECL OCI8 >= 1.1.0
43549 **/
43550function oci_free_statement($statement){}
43551
43552/**
43553 * Enables or disables internal debug output.
43554 *
43555 * @param bool $onoff Set this to to turn debug output off or to turn
43556 *   it on.
43557 * @return void
43558 * @since PHP 5, PECL OCI8 >= 1.1.0
43559 **/
43560function oci_internal_debug($onoff){}
43561
43562/**
43563 * Copies a large object or a part of a large object to another large
43564 * object. Old LOB-recipient data will be overwritten.
43565 *
43566 * If you need to copy a particular part of a LOB to a particular
43567 * position of a LOB, use {@link oci_lob_seek} to move LOB internal
43568 * pointers.
43569 *
43570 * @param OCI-Lob $lob_to The destination LOB.
43571 * @param OCI-Lob $lob_from The copied LOB.
43572 * @param int $length Indicates the length of data to be copied.
43573 * @return bool
43574 * @since PHP 5, PECL OCI8 >= 1.1.0
43575 **/
43576function oci_lob_copy($lob_to, $lob_from, $length){}
43577
43578/**
43579 * Compares two LOB/FILE locators.
43580 *
43581 * @param OCI-Lob $lob1 A LOB identifier.
43582 * @param OCI-Lob $lob2 A LOB identifier.
43583 * @return bool
43584 * @since PHP 5, PECL OCI8 >= 1.1.0
43585 **/
43586function oci_lob_is_equal($lob1, $lob2){}
43587
43588/**
43589 * Allocates a new collection object.
43590 *
43591 * @param resource $connection An Oracle connection identifier,
43592 *   returned by {@link oci_connect} or {@link oci_pconnect}.
43593 * @param string $tdo Should be a valid named type (uppercase).
43594 * @param string $schema Should point to the scheme, where the named
43595 *   type was created. The name of the current user is the default value.
43596 * @return OCI-Collection
43597 * @since PHP 5, PECL OCI8 >= 1.1.0
43598 **/
43599function oci_new_collection($connection, $tdo, $schema){}
43600
43601/**
43602 * Establishes a new connection to an Oracle server and logs on.
43603 *
43604 * Unlike {@link oci_connect} and {@link oci_pconnect}, {@link
43605 * oci_new_connect} does not cache connections and will always return a
43606 * brand-new freshly opened connection handle. This is useful if your
43607 * application needs transactional isolation between two sets of queries.
43608 *
43609 * @param string $username The Oracle user name.
43610 * @param string $password The password for {@link username}.
43611 * @param string $connection_string
43612 * @param string $character_set
43613 * @param int $session_mode
43614 * @return resource
43615 * @since PHP 5, PECL OCI8 >= 1.1.0
43616 **/
43617function oci_new_connect($username, $password, $connection_string, $character_set, $session_mode){}
43618
43619/**
43620 * Allocates a new statement handle on the specified connection.
43621 *
43622 * @param resource $connection An Oracle connection identifier,
43623 *   returned by {@link oci_connect} or {@link oci_pconnect}.
43624 * @return resource
43625 * @since PHP 5, PECL OCI8 >= 1.1.0
43626 **/
43627function oci_new_cursor($connection){}
43628
43629/**
43630 * Allocates resources to hold descriptor or LOB locator.
43631 *
43632 * @param resource $connection An Oracle connection identifier,
43633 *   returned by {@link oci_connect} or {@link oci_pconnect}.
43634 * @param int $type Valid values for {@link type} are: OCI_DTYPE_FILE,
43635 *   OCI_DTYPE_LOB and OCI_DTYPE_ROWID.
43636 * @return OCI-Lob
43637 * @since PHP 5, PECL OCI8 >= 1.1.0
43638 **/
43639function oci_new_descriptor($connection, $type){}
43640
43641/**
43642 * Gets the number of columns in the given {@link statement}.
43643 *
43644 * @param resource $statement A valid OCI statement identifier.
43645 * @return int
43646 * @since PHP 5, PECL OCI8 >= 1.1.0
43647 **/
43648function oci_num_fields($statement){}
43649
43650/**
43651 * Gets the number of rows affected during statement execution.
43652 *
43653 * @param resource $statement A valid OCI statement identifier.
43654 * @return int
43655 * @since PHP 5, PECL OCI8 >= 1.1.0
43656 **/
43657function oci_num_rows($statement){}
43658
43659/**
43660 * Prepares {@link sql_text} using {@link connection} and returns the
43661 * statement identifier, which can be used with {@link oci_bind_by_name},
43662 * {@link oci_execute} and other functions.
43663 *
43664 * Statement identifiers can be freed with {@link oci_free_statement} or
43665 * by setting the variable to null.
43666 *
43667 * @param resource $connection An Oracle connection identifier,
43668 *   returned by {@link oci_connect}, {@link oci_pconnect}, or {@link
43669 *   oci_new_connect}.
43670 * @param string $sql_text The SQL or PL/SQL statement. SQL statements
43671 *   should not end with a semi-colon (;). PL/SQL statements should end
43672 *   with a semi-colon (;).
43673 * @return resource
43674 * @since PHP 5, PECL OCI8 >= 1.1.0
43675 **/
43676function oci_parse($connection, $sql_text){}
43677
43678/**
43679 * Changes password for user with {@link username}.
43680 *
43681 * @param resource $connection An Oracle connection identifier,
43682 *   returned by {@link oci_connect} or {@link oci_pconnect}.
43683 * @param string $username The Oracle user name.
43684 * @param string $old_password The old password.
43685 * @param string $new_password The new password to be set.
43686 * @return bool
43687 * @since PHP 5, PECL OCI8 >= 1.1.0
43688 **/
43689function oci_password_change($connection, $username, $old_password, $new_password){}
43690
43691/**
43692 * Creates a persistent connection to an Oracle server and logs on.
43693 *
43694 * Persistent connections are cached and re-used between requests,
43695 * resulting in reduced overhead on each page load; a typical PHP
43696 * application will have a single persistent connection open against an
43697 * Oracle server per Apache child process (or PHP FastCGI/CGI process).
43698 * See the Persistent Database Connections section for more information.
43699 *
43700 * @param string $username The Oracle user name.
43701 * @param string $password The password for {@link username}.
43702 * @param string $connection_string
43703 * @param string $character_set
43704 * @param int $session_mode
43705 * @return resource
43706 * @since PHP 5, PECL OCI8 >= 1.1.0
43707 **/
43708function oci_pconnect($username, $password, $connection_string, $character_set, $session_mode){}
43709
43710/**
43711 * Returns the data from {@link field} in the current row, fetched by
43712 * {@link oci_fetch}.
43713 *
43714 * @param resource $statement
43715 * @param mixed $field Can be either use the column number (1-based) or
43716 *   the column name (in uppercase).
43717 * @return mixed
43718 * @since PHP 5, PECL OCI8 >= 1.1.0
43719 **/
43720function oci_result($statement, $field){}
43721
43722/**
43723 * Reverts all uncommitted changes for the Oracle {@link connection} and
43724 * ends the transaction. It releases all locks held. All Oracle
43725 * SAVEPOINTS are erased.
43726 *
43727 * A transaction begins when the first SQL statement that changes data is
43728 * executed with {@link oci_execute} using the OCI_NO_AUTO_COMMIT flag.
43729 * Further data changes made by other statements become part of the same
43730 * transaction. Data changes made in a transaction are temporary until
43731 * the transaction is committed or rolled back. Other users of the
43732 * database will not see the changes until they are committed.
43733 *
43734 * When inserting or updating data, using transactions is recommended for
43735 * relational data consistency and for performance reasons.
43736 *
43737 * @param resource $connection An Oracle connection identifier,
43738 *   returned by {@link oci_connect}, {@link oci_pconnect} or {@link
43739 *   oci_new_connect}.
43740 * @return bool
43741 * @since PHP 5, PECL OCI8 >= 1.1.0
43742 **/
43743function oci_rollback($connection){}
43744
43745/**
43746 * Returns a string with version information of the Oracle server, which
43747 * uses the provided {@link connection}.
43748 *
43749 * @param resource $connection
43750 * @return string
43751 * @since PHP 5, PECL OCI8 >= 1.1.0
43752 **/
43753function oci_server_version($connection){}
43754
43755/**
43756 * Sets the action name for Oracle tracing.
43757 *
43758 * The action name is registered with the database when the next
43759 * 'roundtrip' from PHP to the database occurs, typically when an SQL
43760 * statement is executed.
43761 *
43762 * The action name can subsequently be queried from database
43763 * administration views such as V$SESSION. It can be used for tracing and
43764 * monitoring such as with V$SQLAREA and
43765 * DBMS_MONITOR.SERV_MOD_ACT_STAT_ENABLE.
43766 *
43767 * The value may be retained across persistent connections.
43768 *
43769 * @param resource $connection
43770 * @param string $action_name User chosen string up to 32 bytes long.
43771 * @return bool
43772 * @since PHP 5.3.2, PECL OCI8 >= 1.4.0
43773 **/
43774function oci_set_action($connection, $action_name){}
43775
43776/**
43777 * Sets the client identifier used by various database components to
43778 * identify lightweight application users who authenticate as the same
43779 * database user.
43780 *
43781 * The client identifier is registered with the database when the next
43782 * 'roundtrip' from PHP to the database occurs, typically when an SQL
43783 * statement is executed.
43784 *
43785 * The identifier can subsequently be queried from database
43786 * administration views such as V$SESSION. It can be used with
43787 * DBMS_MONITOR.CLIENT_ID_TRACE_ENABLE for tracing. It can be used for
43788 * auditing.
43789 *
43790 * The value may be retained across persistent connections.
43791 *
43792 * @param resource $connection
43793 * @param string $client_identifier User chosen string up to 64 bytes
43794 *   long.
43795 * @return bool
43796 * @since PHP 5.3.2, PECL OCI8 >= 1.4.0
43797 **/
43798function oci_set_client_identifier($connection, $client_identifier){}
43799
43800/**
43801 * Sets the client information for Oracle tracing.
43802 *
43803 * The client information is registered with the database when the next
43804 * 'roundtrip' from PHP to the database occurs, typically when an SQL
43805 * statement is executed.
43806 *
43807 * The client information can subsequently be queried from database
43808 * administration views such as V$SESSION.
43809 *
43810 * The value may be retained across persistent connections.
43811 *
43812 * @param resource $connection
43813 * @param string $client_info User chosen string up to 64 bytes long.
43814 * @return bool
43815 * @since PHP 5.3.2, PECL OCI8 >= 1.4.0
43816 **/
43817function oci_set_client_info($connection, $client_info){}
43818
43819/**
43820 * Sets the database "edition" of objects to be used by a subsequent
43821 * connections.
43822 *
43823 * Oracle Editions allow concurrent versions of applications to run using
43824 * the same schema and object names. This is useful for upgrading live
43825 * systems.
43826 *
43827 * Call {@link oci_set_edition} before calling {@link oci_connect},
43828 * {@link oci_pconnect} or {@link oci_new_connect}.
43829 *
43830 * If an edition is set that is not valid in the database, connection
43831 * will fail even if {@link oci_set_edition} returns success.
43832 *
43833 * When using persistent connections, if a connection with the requested
43834 * edition setting already exists, it is reused. Otherwise, a different
43835 * persistent connection is created
43836 *
43837 * @param string $edition Oracle Database edition name previously
43838 *   created with the SQL "CREATE EDITION" command.
43839 * @return bool
43840 * @since PHP 5.3.2, PECL OCI8 >= 1.4.0
43841 **/
43842function oci_set_edition($edition){}
43843
43844/**
43845 * Sets the module name for Oracle tracing.
43846 *
43847 * The module name is registered with the database when the next
43848 * 'roundtrip' from PHP to the database occurs, typically when an SQL
43849 * statement is executed.
43850 *
43851 * The name can subsequently be queried from database administration
43852 * views such as V$SESSION. It can be used for tracing and monitoring
43853 * such as with V$SQLAREA and DBMS_MONITOR.SERV_MOD_ACT_STAT_ENABLE.
43854 *
43855 * The value may be retained across persistent connections.
43856 *
43857 * @param resource $connection
43858 * @param string $module_name User chosen string up to 48 bytes long.
43859 * @return bool
43860 * @since PHP 5.3.2, PECL OCI8 >= 1.4.0
43861 **/
43862function oci_set_module_name($connection, $module_name){}
43863
43864/**
43865 * Sets the number of rows to be buffered by the Oracle Client libraries
43866 * after a successful query call to {@link oci_execute} and for each
43867 * subsequent internal fetch request to the database. For queries
43868 * returning a large number of rows, performance can be significantly
43869 * improved by increasing the prefetch count above the default
43870 * oci8.default_prefetch value.
43871 *
43872 * Prefetching is Oracle's efficient way of returning more than one data
43873 * row from the database in each network request. This can result in
43874 * better network and CPU utilization. The buffering of rows is internal
43875 * to OCI8 and the behavior of OCI8 fetching functions is unchanged
43876 * regardless of the prefetch count. For example, {@link oci_fetch_row}
43877 * will always return one row. The prefetch buffer is per-statement and
43878 * is not used by re-executed statements or by other connections.
43879 *
43880 * Call {@link oci_set_prefetch} before calling {@link oci_execute}.
43881 *
43882 * A tuning goal is to set the prefetch value to a reasonable size for
43883 * the network and database to handle. For queries returning a very large
43884 * number of rows, overall system efficiency might be better if rows are
43885 * retrieved from the database in several chunks (i.e set the prefetch
43886 * value smaller than the number of rows). This allows the database to
43887 * handle other users' statements while the PHP script is processing the
43888 * current set of rows.
43889 *
43890 * Query prefetching was introduced in Oracle 8i. REF CURSOR prefetching
43891 * was introduced in Oracle 11gR2 and occurs when PHP is linked with
43892 * Oracle 11gR2 Client libraries and connected to 11gR2 or previous
43893 * versions of the database. Nested cursor prefetching was introduced in
43894 * Oracle 11gR2 and requires both the Oracle Client libraries and the
43895 * database to be version 11gR2.
43896 *
43897 * Prefetching is not supported when queries contain LONG or LOB columns.
43898 * The prefetch value is ignored and single-row fetches will be used in
43899 * all the situations when prefetching is not supported.
43900 *
43901 * @param resource $statement
43902 * @param int $rows The number of rows to be prefetched, >= 0
43903 * @return bool
43904 * @since PHP 5, PECL OCI8 >= 1.1.0
43905 **/
43906function oci_set_prefetch($statement, $rows){}
43907
43908/**
43909 * Returns a keyword identifying the type of the OCI8 {@link statement}.
43910 *
43911 * @param resource $statement A valid OCI8 statement identifier from
43912 *   {@link oci_parse}.
43913 * @return string
43914 * @since PHP 5, PECL OCI8 >= 1.1.0
43915 **/
43916function oci_statement_type($statement){}
43917
43918/**
43919 * Returns the decimal equivalent of the octal number represented by the
43920 * {@link octal_string} argument.
43921 *
43922 * @param string $octal_string The octal string to convert
43923 * @return number
43924 * @since PHP 4, PHP 5
43925 **/
43926function octdec($octal_string){}
43927
43928/**
43929 * Toggles autocommit behaviour.
43930 *
43931 * By default, auto-commit is on for a connection. Disabling auto-commit
43932 * is equivalent with starting a transaction.
43933 *
43934 * @param resource $connection_id
43935 * @param bool $OnOff If {@link OnOff} is , auto-commit is enabled, if
43936 *   it is auto-commit is disabled.
43937 * @return mixed
43938 * @since PHP 4, PHP 5
43939 **/
43940function odbc_autocommit($connection_id, $OnOff){}
43941
43942/**
43943 * Enables handling of binary column data. ODBC SQL types affected are
43944 * BINARY, VARBINARY, and LONGVARBINARY.
43945 *
43946 * When binary SQL data is converted to character C data, each byte (8
43947 * bits) of source data is represented as two ASCII characters. These
43948 * characters are the ASCII character representation of the number in its
43949 * hexadecimal form. For example, a binary 00000001 is converted to "01"
43950 * and a binary 11111111 is converted to "FF". LONGVARBINARY handling
43951 * binmode longreadlen result ODBC_BINMODE_PASSTHRU 0 passthru
43952 * ODBC_BINMODE_RETURN 0 passthru ODBC_BINMODE_CONVERT 0 passthru
43953 * ODBC_BINMODE_PASSTHRU 0 passthru ODBC_BINMODE_PASSTHRU >0 passthru
43954 * ODBC_BINMODE_RETURN >0 return as is ODBC_BINMODE_CONVERT >0 return as
43955 * char
43956 *
43957 * If {@link odbc_fetch_into} is used, passthru means that an empty
43958 * string is returned for these columns.
43959 *
43960 * @param resource $result_id The result identifier. If {@link
43961 *   result_id} is 0, the settings apply as default for new results.
43962 *   Default for longreadlen is 4096 and {@link mode} defaults to
43963 *   ODBC_BINMODE_RETURN. Handling of binary long columns is also
43964 *   affected by {@link odbc_longreadlen}.
43965 * @param int $mode Possible values for {@link mode} are:
43966 *   ODBC_BINMODE_PASSTHRU: Passthru BINARY data ODBC_BINMODE_RETURN:
43967 *   Return as is ODBC_BINMODE_CONVERT: Convert to char and return
43968 * @return bool
43969 * @since PHP 4, PHP 5
43970 **/
43971function odbc_binmode($result_id, $mode){}
43972
43973/**
43974 * Closes down the connection to the database server.
43975 *
43976 * @param resource $connection_id
43977 * @return void
43978 * @since PHP 4, PHP 5
43979 **/
43980function odbc_close($connection_id){}
43981
43982/**
43983 * {@link odbc_close_all} will close down all connections to database
43984 * server(s).
43985 *
43986 * @return void
43987 * @since PHP 4, PHP 5
43988 **/
43989function odbc_close_all(){}
43990
43991/**
43992 * Lists columns and associated privileges for the given table.
43993 *
43994 * @param resource $connection_id
43995 * @param string $qualifier The qualifier.
43996 * @param string $owner The owner.
43997 * @param string $table_name The table name.
43998 * @param string $column_name The {@link column_name} argument accepts
43999 *   search patterns ('%' to match zero or more characters and '_' to
44000 *   match a single character).
44001 * @return resource
44002 * @since PHP 4, PHP 5
44003 **/
44004function odbc_columnprivileges($connection_id, $qualifier, $owner, $table_name, $column_name){}
44005
44006/**
44007 * Lists all columns in the requested range.
44008 *
44009 * @param resource $connection_id
44010 * @param string $qualifier The qualifier.
44011 * @param string $schema The owner.
44012 * @param string $table_name The table name.
44013 * @param string $column_name The column name.
44014 * @return resource
44015 * @since PHP 4, PHP 5
44016 **/
44017function odbc_columns($connection_id, $qualifier, $schema, $table_name, $column_name){}
44018
44019/**
44020 * Commits all pending transactions on the connection.
44021 *
44022 * @param resource $connection_id
44023 * @return bool
44024 * @since PHP 4, PHP 5
44025 **/
44026function odbc_commit($connection_id){}
44027
44028/**
44029 * @param string $dsn The database source name for the connection.
44030 *   Alternatively, a DNS-less connection string can be used.
44031 * @param string $user The username.
44032 * @param string $password The password.
44033 * @param int $cursor_type This sets the type of cursor to be used for
44034 *   this connection. This parameter is not normally needed, but can be
44035 *   useful for working around problems with some ODBC drivers.
44036 *
44037 *   SQL_CUR_USE_IF_NEEDED SQL_CUR_USE_ODBC SQL_CUR_USE_DRIVER
44038 * @return resource
44039 * @since PHP 4, PHP 5
44040 **/
44041function odbc_connect($dsn, $user, $password, $cursor_type){}
44042
44043/**
44044 * Gets the cursorname for the given result_id.
44045 *
44046 * @param resource $result_id The result identifier.
44047 * @return string
44048 * @since PHP 4, PHP 5
44049 **/
44050function odbc_cursor($result_id){}
44051
44052/**
44053 * This function will return the list of available DNS (after calling it
44054 * several times).
44055 *
44056 * @param resource $connection_id
44057 * @param int $fetch_type The {@link fetch_type} can be one of two
44058 *   constant types: SQL_FETCH_FIRST, SQL_FETCH_NEXT. Use SQL_FETCH_FIRST
44059 *   the first time this function is called, thereafter use the
44060 *   SQL_FETCH_NEXT.
44061 * @return array
44062 * @since PHP 4 >= 4.3.0, PHP 5
44063 **/
44064function odbc_data_source($connection_id, $fetch_type){}
44065
44066/**
44067 * Sends an SQL statement to the database server.
44068 *
44069 * @param resource $connection_id
44070 * @param string $query_string The SQL statement.
44071 * @param int $flags This parameter is currently not used.
44072 * @return resource
44073 * @since PHP 4, PHP 5
44074 **/
44075function odbc_do($connection_id, $query_string, $flags){}
44076
44077/**
44078 * @param resource $connection_id
44079 * @return string
44080 * @since PHP 4 >= 4.0.5, PHP 5
44081 **/
44082function odbc_error($connection_id){}
44083
44084/**
44085 * @param resource $connection_id
44086 * @return string
44087 * @since PHP 4 >= 4.0.5, PHP 5
44088 **/
44089function odbc_errormsg($connection_id){}
44090
44091/**
44092 * Sends an SQL statement to the database server.
44093 *
44094 * @param resource $connection_id
44095 * @param string $query_string The SQL statement.
44096 * @param int $flags This parameter is currently not used.
44097 * @return resource
44098 * @since PHP 4, PHP 5
44099 **/
44100function odbc_exec($connection_id, $query_string, $flags){}
44101
44102/**
44103 * Executes a statement prepared with {@link odbc_prepare}.
44104 *
44105 * @param resource $result_id The result id resource, from {@link
44106 *   odbc_prepare}.
44107 * @param array $parameters_array Parameters in {@link parameter_array}
44108 *   will be substituted for placeholders in the prepared statement in
44109 *   order. Elements of this array will be converted to strings by
44110 *   calling this function. Any parameters in {@link parameter_array}
44111 *   which start and end with single quotes will be taken as the name of
44112 *   a file to read and send to the database server as the data for the
44113 *   appropriate placeholder.
44114 * @return bool
44115 * @since PHP 4, PHP 5
44116 **/
44117function odbc_execute($result_id, $parameters_array){}
44118
44119/**
44120 * Fetch an associative array from an ODBC query. See the changelog below
44121 * for when this function is available.
44122 *
44123 * @param resource $result The result resource from {@link odbc_exec}.
44124 * @param int $rownumber Optionally choose which row number to
44125 *   retrieve.
44126 * @return array
44127 * @since PHP 4 >= 4.0.2, PHP 5
44128 **/
44129function odbc_fetch_array($result, $rownumber){}
44130
44131/**
44132 * Fetch one result row into array.
44133 *
44134 * @param resource $result_id The result resource.
44135 * @param array $result_array The result array that can be of any type
44136 *   since it will be converted to type array. The array will contain the
44137 *   column values starting at array index 0.
44138 * @param int $rownumber The row number.
44139 * @return int
44140 * @since PHP 4, PHP 5
44141 **/
44142function odbc_fetch_into($result_id, &$result_array, $rownumber){}
44143
44144/**
44145 * Fetch an object from an ODBC query. See the changelog below for when
44146 * this function is available.
44147 *
44148 * @param resource $result The result resource from {@link odbc_exec}.
44149 * @param int $rownumber Optionally choose which row number to
44150 *   retrieve.
44151 * @return object
44152 * @since PHP 4 >= 4.0.2, PHP 5
44153 **/
44154function odbc_fetch_object($result, $rownumber){}
44155
44156/**
44157 * Fetches a row of the data that was returned by {@link odbc_do} or
44158 * {@link odbc_exec}. After {@link odbc_fetch_row} is called, the fields
44159 * of that row can be accessed with {@link odbc_result}.
44160 *
44161 * @param resource $result_id The result identifier.
44162 * @param int $row_number If {@link row_number} is not specified,
44163 *   {@link odbc_fetch_row} will try to fetch the next row in the result
44164 *   set. Calls to {@link odbc_fetch_row} with and without {@link
44165 *   row_number} can be mixed. To step through the result more than once,
44166 *   you can call {@link odbc_fetch_row} with {@link row_number} 1, and
44167 *   then continue doing {@link odbc_fetch_row} without {@link
44168 *   row_number} to review the result. If a driver doesn't support
44169 *   fetching rows by number, the {@link row_number} parameter is
44170 *   ignored.
44171 * @return bool
44172 * @since PHP 4, PHP 5
44173 **/
44174function odbc_fetch_row($result_id, $row_number){}
44175
44176/**
44177 * Gets the length of the field referenced by number in the given result
44178 * identifier.
44179 *
44180 * @param resource $result_id The result identifier.
44181 * @param int $field_number The field number. Field numbering starts at
44182 *   1.
44183 * @return int
44184 * @since PHP 4, PHP 5
44185 **/
44186function odbc_field_len($result_id, $field_number){}
44187
44188/**
44189 * Gets the name of the field occupying the given column number in the
44190 * given result identifier.
44191 *
44192 * @param resource $result_id The result identifier.
44193 * @param int $field_number The field number. Field numbering starts at
44194 *   1.
44195 * @return string
44196 * @since PHP 4, PHP 5
44197 **/
44198function odbc_field_name($result_id, $field_number){}
44199
44200/**
44201 * Gets the number of the column slot that corresponds to the named field
44202 * in the given result identifier.
44203 *
44204 * @param resource $result_id The result identifier.
44205 * @param string $field_name The field name.
44206 * @return int
44207 * @since PHP 4, PHP 5
44208 **/
44209function odbc_field_num($result_id, $field_name){}
44210
44211/**
44212 * Gets the length of the field referenced by number in the given result
44213 * identifier.
44214 *
44215 * @param resource $result_id The result identifier.
44216 * @param int $field_number The field number. Field numbering starts at
44217 *   1.
44218 * @return int
44219 * @since PHP 4, PHP 5
44220 **/
44221function odbc_field_precision($result_id, $field_number){}
44222
44223/**
44224 * Gets the scale of the field referenced by number in the given result
44225 * identifier.
44226 *
44227 * @param resource $result_id The result identifier.
44228 * @param int $field_number The field number. Field numbering starts at
44229 *   1.
44230 * @return int
44231 * @since PHP 4, PHP 5
44232 **/
44233function odbc_field_scale($result_id, $field_number){}
44234
44235/**
44236 * Gets the SQL type of the field referenced by number in the given
44237 * result identifier.
44238 *
44239 * @param resource $result_id The result identifier.
44240 * @param int $field_number The field number. Field numbering starts at
44241 *   1.
44242 * @return string
44243 * @since PHP 4, PHP 5
44244 **/
44245function odbc_field_type($result_id, $field_number){}
44246
44247/**
44248 * Retrieves a list of foreign keys in the specified table or a list of
44249 * foreign keys in other tables that refer to the primary key in the
44250 * specified table
44251 *
44252 * @param resource $connection_id
44253 * @param string $pk_qualifier The primary key qualifier.
44254 * @param string $pk_owner The primary key owner.
44255 * @param string $pk_table The primary key table.
44256 * @param string $fk_qualifier The foreign key qualifier.
44257 * @param string $fk_owner The foreign key owner.
44258 * @param string $fk_table The foreign key table.
44259 * @return resource
44260 * @since PHP 4, PHP 5
44261 **/
44262function odbc_foreignkeys($connection_id, $pk_qualifier, $pk_owner, $pk_table, $fk_qualifier, $fk_owner, $fk_table){}
44263
44264/**
44265 * Free resources associated with a result.
44266 *
44267 * {@link odbc_free_result} only needs to be called if you are worried
44268 * about using too much memory while your script is running. All result
44269 * memory will automatically be freed when the script is finished.
44270 *
44271 * @param resource $result_id The result identifier.
44272 * @return bool
44273 * @since PHP 4, PHP 5
44274 **/
44275function odbc_free_result($result_id){}
44276
44277/**
44278 * Retrieves information about data types supported by the data source.
44279 *
44280 * @param resource $connection_id
44281 * @param int $data_type The data type, which can be used to restrict
44282 *   the information to a single data type.
44283 * @return resource
44284 * @since PHP 4, PHP 5
44285 **/
44286function odbc_gettypeinfo($connection_id, $data_type){}
44287
44288/**
44289 * Enables handling of LONG and LONGVARBINARY columns.
44290 *
44291 * @param resource $result_id The result identifier.
44292 * @param int $length The number of bytes returned to PHP is controlled
44293 *   by the parameter length. If it is set to 0, Long column data is
44294 *   passed through to the client.
44295 * @return bool
44296 * @since PHP 4, PHP 5
44297 **/
44298function odbc_longreadlen($result_id, $length){}
44299
44300/**
44301 * Checks if there are more result sets available as well as allowing
44302 * access to the next result set via {@link odbc_fetch_array}, {@link
44303 * odbc_fetch_row}, {@link odbc_result}, etc.
44304 *
44305 * @param resource $result_id The result identifier.
44306 * @return bool
44307 * @since PHP 4 >= 4.0.5, PHP 5
44308 **/
44309function odbc_next_result($result_id){}
44310
44311/**
44312 * Gets the number of fields (columns) in an ODBC result.
44313 *
44314 * @param resource $result_id The result identifier returned by {@link
44315 *   odbc_exec}.
44316 * @return int
44317 * @since PHP 4, PHP 5
44318 **/
44319function odbc_num_fields($result_id){}
44320
44321/**
44322 * Gets the number of rows in a result. For INSERT, UPDATE and DELETE
44323 * statements {@link odbc_num_rows} returns the number of rows affected.
44324 * For a SELECT clause this can be the number of rows available.
44325 *
44326 * @param resource $result_id The result identifier returned by {@link
44327 *   odbc_exec}.
44328 * @return int
44329 * @since PHP 4, PHP 5
44330 **/
44331function odbc_num_rows($result_id){}
44332
44333/**
44334 * Opens a persistent database connection.
44335 *
44336 * This function is much like {@link odbc_connect}, except that the
44337 * connection is not really closed when the script has finished. Future
44338 * requests for a connection with the same {@link dsn}, {@link user},
44339 * {@link password} combination (via {@link odbc_connect} and {@link
44340 * odbc_pconnect}) can reuse the persistent connection.
44341 *
44342 * @param string $dsn
44343 * @param string $user
44344 * @param string $password
44345 * @param int $cursor_type
44346 * @return resource
44347 * @since PHP 4, PHP 5
44348 **/
44349function odbc_pconnect($dsn, $user, $password, $cursor_type){}
44350
44351/**
44352 * Prepares a statement for execution. The result identifier can be used
44353 * later to execute the statement with {@link odbc_execute}.
44354 *
44355 * Some databases (such as IBM DB2, MS SQL Server, and Oracle) support
44356 * stored procedures that accept parameters of type IN, INOUT, and OUT as
44357 * defined by the ODBC specification. However, the Unified ODBC driver
44358 * currently only supports parameters of type IN to stored procedures.
44359 *
44360 * @param resource $connection_id
44361 * @param string $query_string The query string statement being
44362 *   prepared.
44363 * @return resource
44364 * @since PHP 4, PHP 5
44365 **/
44366function odbc_prepare($connection_id, $query_string){}
44367
44368/**
44369 * Returns a result identifier that can be used to fetch the column names
44370 * that comprise the primary key for a table.
44371 *
44372 * @param resource $connection_id
44373 * @param string $qualifier
44374 * @param string $owner
44375 * @param string $table
44376 * @return resource
44377 * @since PHP 4, PHP 5
44378 **/
44379function odbc_primarykeys($connection_id, $qualifier, $owner, $table){}
44380
44381/**
44382 * Retrieve information about parameters to procedures.
44383 *
44384 * @param resource $connection_id
44385 * @return resource
44386 * @since PHP 4, PHP 5
44387 **/
44388function odbc_procedurecolumns($connection_id){}
44389
44390/**
44391 * Lists all procedures in the requested range.
44392 *
44393 * @param resource $connection_id
44394 * @return resource
44395 * @since PHP 4, PHP 5
44396 **/
44397function odbc_procedures($connection_id){}
44398
44399/**
44400 * Get result data
44401 *
44402 * @param resource $result_id The ODBC resource.
44403 * @param mixed $field The field name being retrieved. It can either be
44404 *   an integer containing the column number of the field you want; or it
44405 *   can be a string containing the name of the field.
44406 * @return mixed
44407 * @since PHP 4, PHP 5
44408 **/
44409function odbc_result($result_id, $field){}
44410
44411/**
44412 * Prints all rows from a result identifier produced by {@link
44413 * odbc_exec}. The result is printed in HTML table format.
44414 *
44415 * @param resource $result_id The result identifier.
44416 * @param string $format Additional overall table formatting.
44417 * @return int
44418 * @since PHP 4, PHP 5
44419 **/
44420function odbc_result_all($result_id, $format){}
44421
44422/**
44423 * Rolls back all pending statements on the connection.
44424 *
44425 * @param resource $connection_id
44426 * @return bool
44427 * @since PHP 4, PHP 5
44428 **/
44429function odbc_rollback($connection_id){}
44430
44431/**
44432 * This function allows fiddling with the ODBC options for a particular
44433 * connection or query result. It was written to help find work around to
44434 * problems in quirky ODBC drivers. You should probably only use this
44435 * function if you are an ODBC programmer and understand the effects the
44436 * various options will have. You will certainly need a good ODBC
44437 * reference to explain all the different options and values that can be
44438 * used. Different driver versions support different options.
44439 *
44440 * Because the effects may vary depending on the ODBC driver, use of this
44441 * function in scripts to be made publicly available is strongly
44442 * discouraged. Also, some ODBC options are not available to this
44443 * function because they must be set before the connection is established
44444 * or the query is prepared. However, if on a particular job it can make
44445 * PHP work so your boss doesn't tell you to use a commercial product,
44446 * that's all that really matters.
44447 *
44448 * @param resource $id Is a connection id or result id on which to
44449 *   change the settings. For SQLSetConnectOption(), this is a connection
44450 *   id. For SQLSetStmtOption(), this is a result id.
44451 * @param int $function Is the ODBC function to use. The value should
44452 *   be 1 for SQLSetConnectOption() and 2 for SQLSetStmtOption().
44453 * @param int $option The option to set.
44454 * @param int $param The value for the given {@link option}.
44455 * @return bool
44456 * @since PHP 4, PHP 5
44457 **/
44458function odbc_setoption($id, $function, $option, $param){}
44459
44460/**
44461 * Retrieves either the optimal set of columns that uniquely identifies a
44462 * row in the table, or columns that are automatically updated when any
44463 * value in the row is updated by a transaction.
44464 *
44465 * @param resource $connection_id
44466 * @param int $type
44467 * @param string $qualifier The qualifier.
44468 * @param string $owner The owner.
44469 * @param string $table The table.
44470 * @param int $scope The scope, which orders the result set.
44471 * @param int $nullable The nullable option.
44472 * @return resource
44473 * @since PHP 4, PHP 5
44474 **/
44475function odbc_specialcolumns($connection_id, $type, $qualifier, $owner, $table, $scope, $nullable){}
44476
44477/**
44478 * Get statistics about a table and its indexes.
44479 *
44480 * @param resource $connection_id
44481 * @param string $qualifier The qualifier.
44482 * @param string $owner The owner.
44483 * @param string $table_name The table name.
44484 * @param int $unique The unique attribute.
44485 * @param int $accuracy The accuracy.
44486 * @return resource
44487 * @since PHP 4, PHP 5
44488 **/
44489function odbc_statistics($connection_id, $qualifier, $owner, $table_name, $unique, $accuracy){}
44490
44491/**
44492 * Lists tables in the requested range and the privileges associated with
44493 * each table.
44494 *
44495 * @param resource $connection_id
44496 * @param string $qualifier The qualifier.
44497 * @param string $owner The owner. Accepts the following search
44498 *   patterns: ('%' to match zero or more characters and '_' to match a
44499 *   single character)
44500 * @param string $name The name. Accepts the following search patterns:
44501 *   ('%' to match zero or more characters and '_' to match a single
44502 *   character)
44503 * @return resource
44504 * @since PHP 4, PHP 5
44505 **/
44506function odbc_tableprivileges($connection_id, $qualifier, $owner, $name){}
44507
44508/**
44509 * Lists all tables in the requested range.
44510 *
44511 * To support enumeration of qualifiers, owners, and table types, the
44512 * following special semantics for the {@link qualifier}, {@link owner},
44513 * {@link name}, and {@link table_type} are available: If {@link
44514 * qualifier} is a single percent character (%) and {@link owner} and
44515 * {@link name} are empty strings, then the result set contains a list of
44516 * valid qualifiers for the data source. (All columns except the
44517 * TABLE_QUALIFIER column contain NULLs.) If {@link owner} is a single
44518 * percent character (%) and {@link qualifier} and {@link name} are empty
44519 * strings, then the result set contains a list of valid owners for the
44520 * data source. (All columns except the TABLE_OWNER column contain
44521 * NULLs.) If {@link table_type} is a single percent character (%) and
44522 * {@link qualifier}, {@link owner} and {@link name} are empty strings,
44523 * then the result set contains a list of valid table types for the data
44524 * source. (All columns except the TABLE_TYPE column contain NULLs.)
44525 *
44526 * @param resource $connection_id
44527 * @param string $qualifier The qualifier.
44528 * @param string $owner The owner. Accepts search patterns ('%' to
44529 *   match zero or more characters and '_' to match a single character).
44530 * @param string $name The name. Accepts search patterns ('%' to match
44531 *   zero or more characters and '_' to match a single character).
44532 * @param string $types If {@link table_type} is not an empty string,
44533 *   it must contain a list of comma-separated values for the types of
44534 *   interest; each value may be enclosed in single quotes (') or
44535 *   unquoted. For example, "'TABLE','VIEW'" or "TABLE, VIEW". If the
44536 *   data source does not support a specified table type, {@link
44537 *   odbc_tables} does not return any results for that type.
44538 * @return resource
44539 * @since PHP 4, PHP 5
44540 **/
44541function odbc_tables($connection_id, $qualifier, $owner, $name, $types){}
44542
44543/**
44544 * @return resource
44545 * @since PECL openal >= 0.1.0
44546 **/
44547function openal_buffer_create(){}
44548
44549/**
44550 * @param resource $buffer An Open AL(Buffer) resource (previously
44551 *   created by {@link openal_buffer_create}).
44552 * @param int $format Format of {@link data}, one of: AL_FORMAT_MONO8,
44553 *   AL_FORMAT_MONO16, AL_FORMAT_STEREO8 AL_FORMAT_STEREO16
44554 * @param string $data Block of binary audio data in the {@link format}
44555 *   and {@link freq} specified.
44556 * @param int $freq Frequency of {@link data} given in Hz.
44557 * @return bool
44558 * @since PECL openal >= 0.1.0
44559 **/
44560function openal_buffer_data($buffer, $format, $data, $freq){}
44561
44562/**
44563 * @param resource $buffer An Open AL(Buffer) resource (previously
44564 *   created by {@link openal_buffer_create}).
44565 * @return bool
44566 * @since PECL openal >= 0.1.0
44567 **/
44568function openal_buffer_destroy($buffer){}
44569
44570/**
44571 * @param resource $buffer An Open AL(Buffer) resource (previously
44572 *   created by {@link openal_buffer_create}).
44573 * @param int $property Specific property, one of: AL_FREQUENCY,
44574 *   AL_BITS, AL_CHANNELS AL_SIZE.
44575 * @return int
44576 * @since PECL openal >= 0.1.0
44577 **/
44578function openal_buffer_get($buffer, $property){}
44579
44580/**
44581 * @param resource $buffer An Open AL(Buffer) resource (previously
44582 *   created by {@link openal_buffer_create}).
44583 * @param string $wavfile Path to .wav file on local file system.
44584 * @return bool
44585 * @since PECL openal >= 0.1.0
44586 **/
44587function openal_buffer_loadwav($buffer, $wavfile){}
44588
44589/**
44590 * @param resource $device An Open AL(Device) resource (previously
44591 *   created by {@link openal_device_open}).
44592 * @return resource
44593 * @since PECL openal >= 0.1.0
44594 **/
44595function openal_context_create($device){}
44596
44597/**
44598 * @param resource $context An Open AL(Context) resource (previously
44599 *   created by {@link openal_context_create}).
44600 * @return bool
44601 * @since PECL openal >= 0.1.0
44602 **/
44603function openal_context_current($context){}
44604
44605/**
44606 * @param resource $context An Open AL(Context) resource (previously
44607 *   created by {@link openal_context_create}).
44608 * @return bool
44609 * @since PECL openal >= 0.1.0
44610 **/
44611function openal_context_destroy($context){}
44612
44613/**
44614 * @param resource $context An Open AL(Context) resource (previously
44615 *   created by {@link openal_context_create}).
44616 * @return bool
44617 * @since PECL openal >= 0.1.0
44618 **/
44619function openal_context_process($context){}
44620
44621/**
44622 * @param resource $context An Open AL(Context) resource (previously
44623 *   created by {@link openal_context_create}).
44624 * @return bool
44625 * @since PECL openal >= 0.1.0
44626 **/
44627function openal_context_suspend($context){}
44628
44629/**
44630 * @param resource $device An Open AL(Device) resource (previously
44631 *   created by {@link openal_device_open}) to be closed.
44632 * @return bool
44633 * @since PECL openal >= 0.1.0
44634 **/
44635function openal_device_close($device){}
44636
44637/**
44638 * @param string $device_desc Open an audio device optionally specified
44639 *   by {@link device_desc}. If {@link device_desc} is not specified the
44640 *   first available audio device will be used.
44641 * @return resource
44642 * @since PECL openal >= 0.1.0
44643 **/
44644function openal_device_open($device_desc){}
44645
44646/**
44647 * @param int $property Property to retrieve, one of: AL_GAIN (float),
44648 *   AL_POSITION (array(float,float,float)), AL_VELOCITY
44649 *   (array(float,float,float)) AL_ORIENTATION
44650 *   (array(float,float,float)).
44651 * @return mixed
44652 * @since PECL openal >= 0.1.0
44653 **/
44654function openal_listener_get($property){}
44655
44656/**
44657 * @param int $property Property to set, one of: AL_GAIN (float),
44658 *   AL_POSITION (array(float,float,float)), AL_VELOCITY
44659 *   (array(float,float,float)) AL_ORIENTATION
44660 *   (array(float,float,float)).
44661 * @param mixed $setting Value to set, either float, or an array of
44662 *   floats as appropriate.
44663 * @return bool
44664 * @since PECL openal >= 0.1.0
44665 **/
44666function openal_listener_set($property, $setting){}
44667
44668/**
44669 * @return resource
44670 * @since PECL openal >= 0.1.0
44671 **/
44672function openal_source_create(){}
44673
44674/**
44675 * @param resource $source An Open AL(Source) resource (previously
44676 *   created by {@link openal_source_create}).
44677 * @return bool
44678 * @since PECL openal >= 0.1.0
44679 **/
44680function openal_source_destroy($source){}
44681
44682/**
44683 * @param resource $source An Open AL(Source) resource (previously
44684 *   created by {@link openal_source_create}).
44685 * @param int $property Property to get, one of: AL_SOURCE_RELATIVE
44686 *   (int), AL_SOURCE_STATE (int), AL_PITCH (float), AL_GAIN (float),
44687 *   AL_MIN_GAIN (float), AL_MAX_GAIN (float), AL_MAX_DISTANCE (float),
44688 *   AL_ROLLOFF_FACTOR (float), AL_CONE_OUTER_GAIN (float),
44689 *   AL_CONE_INNER_ANGLE (float), AL_CONE_OUTER_ANGLE (float),
44690 *   AL_REFERENCE_DISTANCE (float), AL_POSITION
44691 *   (array(float,float,float)), AL_VELOCITY (array(float,float,float)),
44692 *   AL_DIRECTION (array(float,float,float)).
44693 * @return mixed
44694 * @since PECL openal >= 0.1.0
44695 **/
44696function openal_source_get($source, $property){}
44697
44698/**
44699 * @param resource $source An Open AL(Source) resource (previously
44700 *   created by {@link openal_source_create}).
44701 * @return bool
44702 * @since PECL openal >= 0.1.0
44703 **/
44704function openal_source_pause($source){}
44705
44706/**
44707 * @param resource $source An Open AL(Source) resource (previously
44708 *   created by {@link openal_source_create}).
44709 * @return bool
44710 * @since PECL openal >= 0.1.0
44711 **/
44712function openal_source_play($source){}
44713
44714/**
44715 * @param resource $source An Open AL(Source) resource (previously
44716 *   created by {@link openal_source_create}).
44717 * @return bool
44718 * @since PECL openal >= 0.1.0
44719 **/
44720function openal_source_rewind($source){}
44721
44722/**
44723 * @param resource $source An Open AL(Source) resource (previously
44724 *   created by {@link openal_source_create}).
44725 * @param int $property Property to set, one of: AL_BUFFER
44726 *   (OpenAL(Source)), AL_LOOPING (bool), AL_SOURCE_RELATIVE (int),
44727 *   AL_SOURCE_STATE (int), AL_PITCH (float), AL_GAIN (float),
44728 *   AL_MIN_GAIN (float), AL_MAX_GAIN (float), AL_MAX_DISTANCE (float),
44729 *   AL_ROLLOFF_FACTOR (float), AL_CONE_OUTER_GAIN (float),
44730 *   AL_CONE_INNER_ANGLE (float), AL_CONE_OUTER_ANGLE (float),
44731 *   AL_REFERENCE_DISTANCE (float), AL_POSITION
44732 *   (array(float,float,float)), AL_VELOCITY (array(float,float,float)),
44733 *   AL_DIRECTION (array(float,float,float)).
44734 * @param mixed $setting Value to assign to specified {@link property}.
44735 *   Refer to the description of {@link property} for a description of
44736 *   the value(s) expected.
44737 * @return bool
44738 * @since PECL openal >= 0.1.0
44739 **/
44740function openal_source_set($source, $property, $setting){}
44741
44742/**
44743 * @param resource $source An Open AL(Source) resource (previously
44744 *   created by {@link openal_source_create}).
44745 * @return bool
44746 * @since PECL openal >= 0.1.0
44747 **/
44748function openal_source_stop($source){}
44749
44750/**
44751 * @param resource $source An Open AL(Source) resource (previously
44752 *   created by {@link openal_source_create}).
44753 * @param int $format Format of {@link data}, one of: AL_FORMAT_MONO8,
44754 *   AL_FORMAT_MONO16, AL_FORMAT_STEREO8 AL_FORMAT_STEREO16
44755 * @param int $rate Frequency of data to stream given in Hz.
44756 * @return resource
44757 * @since PECL openal >= 0.1.0
44758 **/
44759function openal_stream($source, $format, $rate){}
44760
44761/**
44762 * Opens up a directory handle to be used in subsequent {@link closedir},
44763 * {@link readdir}, and {@link rewinddir} calls.
44764 *
44765 * @param string $path The directory path that is to be opened
44766 * @param resource $context For a description of the {@link context}
44767 *   parameter, refer to the streams section of the manual.
44768 * @return resource
44769 * @since PHP 4, PHP 5
44770 **/
44771function opendir($path, $context){}
44772
44773/**
44774 * {@link openlog} opens a connection to the system logger for a program.
44775 *
44776 * The use of {@link openlog} is optional. It will automatically be
44777 * called by {@link syslog} if necessary, in which case {@link ident}
44778 * will default to .
44779 *
44780 * @param string $ident The string {@link ident} is added to each
44781 *   message.
44782 * @param int $option The {@link option} argument is used to indicate
44783 *   what logging options will be used when generating a log message.
44784 *   {@link openlog} Options Constant Description LOG_CONS if there is an
44785 *   error while sending data to the system logger, write directly to the
44786 *   system console LOG_NDELAY open the connection to the logger
44787 *   immediately LOG_ODELAY (default) delay opening the connection until
44788 *   the first message is logged LOG_PERROR print log message also to
44789 *   standard error LOG_PID include PID with each message You can use one
44790 *   or more of this options. When using multiple options you need to OR
44791 *   them, i.e. to open the connection immediately, write to the console
44792 *   and include the PID in each message, you will use: LOG_CONS |
44793 *   LOG_NDELAY | LOG_PID
44794 * @param int $facility The {@link facility} argument is used to
44795 *   specify what type of program is logging the message. This allows you
44796 *   to specify (in your machine's syslog configuration) how messages
44797 *   coming from different facilities will be handled. {@link openlog}
44798 *   Facilities Constant Description LOG_AUTH security/authorization
44799 *   messages (use LOG_AUTHPRIV instead in systems where that constant is
44800 *   defined) LOG_AUTHPRIV security/authorization messages (private)
44801 *   LOG_CRON clock daemon (cron and at) LOG_DAEMON other system daemons
44802 *   LOG_KERN kernel messages LOG_LOCAL0 ... LOG_LOCAL7 reserved for
44803 *   local use, these are not available in Windows LOG_LPR line printer
44804 *   subsystem LOG_MAIL mail subsystem LOG_NEWS USENET news subsystem
44805 *   LOG_SYSLOG messages generated internally by syslogd LOG_USER generic
44806 *   user-level messages LOG_UUCP UUCP subsystem
44807 * @return bool
44808 * @since PHP 4, PHP 5
44809 **/
44810function openlog($ident, $option, $facility){}
44811
44812/**
44813 * {@link openssl_csr_export} takes the Certificate Signing Request
44814 * represented by {@link csr} and stores it as ascii-armoured text into
44815 * {@link out}, which is passed by reference.
44816 *
44817 * @param resource $csr
44818 * @param string $out
44819 * @param bool $notext
44820 * @return bool
44821 * @since PHP 4 >= 4.2.0, PHP 5
44822 **/
44823function openssl_csr_export($csr, &$out, $notext){}
44824
44825/**
44826 * {@link openssl_csr_export_to_file} takes the Certificate Signing
44827 * Request represented by {@link csr} and saves it as ascii-armoured text
44828 * into the file named by {@link outfilename}.
44829 *
44830 * @param resource $csr
44831 * @param string $outfilename Path to the output file.
44832 * @param bool $notext
44833 * @return bool
44834 * @since PHP 4 >= 4.2.0, PHP 5
44835 **/
44836function openssl_csr_export_to_file($csr, $outfilename, $notext){}
44837
44838/**
44839 * @param mixed $csr
44840 * @param bool $use_shortnames
44841 * @return resource
44842 * @since PHP 5 >= 5.2.0
44843 **/
44844function openssl_csr_get_public_key($csr, $use_shortnames){}
44845
44846/**
44847 * @param mixed $csr
44848 * @param bool $use_shortnames
44849 * @return array
44850 * @since PHP 5 >= 5.2.0
44851 **/
44852function openssl_csr_get_subject($csr, $use_shortnames){}
44853
44854/**
44855 * {@link openssl_csr_new} generates a new CSR (Certificate Signing
44856 * Request) based on the information provided by {@link dn}, which
44857 * represents the Distinguished Name to be used in the certificate.
44858 *
44859 * @param array $dn The Distinguished Name to be used in the
44860 *   certificate.
44861 * @param resource $privkey {@link privkey} should be set to a private
44862 *   key that was previously generated by {@link openssl_pkey_new} (or
44863 *   otherwise obtained from the other openssl_pkey family of functions).
44864 *   The corresponding public portion of the key will be used to sign the
44865 *   CSR.
44866 * @param array $configargs By default, the information in your system
44867 *   openssl.conf is used to initialize the request; you can specify a
44868 *   configuration file section by setting the config_section_section key
44869 *   of {@link configargs}. You can also specify an alternative openssl
44870 *   configuration file by setting the value of the config key to the
44871 *   path of the file you want to use. The following keys, if present in
44872 *   {@link configargs} behave as their equivalents in the openssl.conf,
44873 *   as listed in the table below. Configuration overrides {@link
44874 *   configargs} key type openssl.conf equivalent description digest_alg
44875 *   string default_md Selects which digest method to use x509_extensions
44876 *   string x509_extensions Selects which extensions should be used when
44877 *   creating an x509 certificate req_extensions string req_extensions
44878 *   Selects which extensions should be used when creating a CSR
44879 *   private_key_bits integer default_bits Specifies how many bits should
44880 *   be used to generate a private key private_key_type integer none
44881 *   Specifies the type of private key to create. This can be one of
44882 *   OPENSSL_KEYTYPE_DSA, OPENSSL_KEYTYPE_DH or OPENSSL_KEYTYPE_RSA. The
44883 *   default value is OPENSSL_KEYTYPE_RSA which is currently the only
44884 *   supported key type. encrypt_key boolean encrypt_key Should an
44885 *   exported key (with passphrase) be encrypted?
44886 * @param array $extraattribs {@link extraattribs} is used to specify
44887 *   additional configuration options for the CSR. Both {@link dn} and
44888 *   {@link extraattribs} are associative arrays whose keys are converted
44889 *   to OIDs and applied to the relevant part of the request.
44890 * @return mixed
44891 * @since PHP 4 >= 4.2.0, PHP 5
44892 **/
44893function openssl_csr_new($dn, &$privkey, $configargs, $extraattribs){}
44894
44895/**
44896 * {@link openssl_csr_sign} generates an x509 certificate resource from
44897 * the given CSR.
44898 *
44899 * @param mixed $csr A CSR previously generated by {@link
44900 *   openssl_csr_new}. It can also be the path to a PEM encoded CSR when
44901 *   specified as file://path/to/csr or an exported string generated by
44902 *   {@link openssl_csr_export}.
44903 * @param mixed $cacert The generated certificate will be signed by
44904 *   {@link cacert}. If {@link cacert} is , the generated certificate
44905 *   will be a self-signed certificate.
44906 * @param mixed $priv_key {@link priv_key} is the private key that
44907 *   corresponds to {@link cacert}.
44908 * @param int $days {@link days} specifies the length of time for which
44909 *   the generated certificate will be valid, in days.
44910 * @param array $configargs You can finetune the CSR signing by {@link
44911 *   configargs}. See {@link openssl_csr_new} for more information about
44912 *   {@link configargs}.
44913 * @param int $serial An optional the serial number of issued
44914 *   certificate. If not specified it will default to 0.
44915 * @return resource
44916 * @since PHP 4 >= 4.2.0, PHP 5
44917 **/
44918function openssl_csr_sign($csr, $cacert, $priv_key, $days, $configargs, $serial){}
44919
44920/**
44921 * Takes a raw or base64 encoded string and decrypts it using a given
44922 * method and key.
44923 *
44924 * @param string $data The data.
44925 * @param string $method The cipher method.
44926 * @param string $password The password.
44927 * @param string $raw_input Setting to will take a raw encoded string,
44928 *   otherwise a base64 string is assumed for the {@link data} parameter.
44929 * @return string
44930 * @since PHP 5 >= 5.3.0
44931 **/
44932function openssl_decrypt($data, $method, $password, $raw_input){}
44933
44934/**
44935 * @param string $pub_key Public key
44936 * @param resource $dh_key DH key
44937 * @return string
44938 **/
44939function openssl_dh_compute_key($pub_key, $dh_key){}
44940
44941/**
44942 * Computes a digest hash value for the given data using a given method,
44943 * and returns a raw or binhex encoded string.
44944 *
44945 * @param string $data The data.
44946 * @param string $method The digest method.
44947 * @param bool $raw_output Setting to will return as raw output data,
44948 *   otherwise the return value is binhex encoded.
44949 * @return string
44950 * @since PHP 5 >= 5.3.0
44951 **/
44952function openssl_digest($data, $method, $raw_output){}
44953
44954/**
44955 * Encrypts given data with given method and key, returns a raw or base64
44956 * encoded string
44957 *
44958 * @param string $data The data.
44959 * @param string $method The cipher method.
44960 * @param string $password The password.
44961 * @param bool $raw_output Setting to will return as raw output data,
44962 *   otherwise the return value is base64 encoded.
44963 * @return string
44964 * @since PHP 5 >= 5.3.0
44965 **/
44966function openssl_encrypt($data, $method, $password, $raw_output){}
44967
44968/**
44969 * {@link openssl_error_string} returns the last error from the openSSL
44970 * library. Error messages are stacked, so this function should be called
44971 * multiple times to collect all of the information.
44972 *
44973 * @return string
44974 * @since PHP 4 >= 4.0.6, PHP 5
44975 **/
44976function openssl_error_string(){}
44977
44978/**
44979 * {@link openssl_free_key} frees the key associated with the specified
44980 * {@link key_identifier} from memory.
44981 *
44982 * @param resource $key_identifier
44983 * @return void
44984 * @since PHP 4 >= 4.0.4, PHP 5
44985 **/
44986function openssl_free_key($key_identifier){}
44987
44988/**
44989 * Gets a list of available cipher methods.
44990 *
44991 * @param bool $aliases Set to if cipher aliases should be included
44992 *   within the returned array.
44993 * @return array
44994 * @since PHP 5 >= 5.3.0
44995 **/
44996function openssl_get_cipher_methods($aliases){}
44997
44998/**
44999 * Gets a list of available digest methods.
45000 *
45001 * @param bool $aliases Set to if digest aliases should be included
45002 *   within the returned array.
45003 * @return array
45004 * @since PHP 5 >= 5.3.0
45005 **/
45006function openssl_get_md_methods($aliases){}
45007
45008/**
45009 * {@link openssl_get_privatekey} parses {@link key} and prepares it for
45010 * use by other functions.
45011 *
45012 * @param mixed $key {@link key} can be one of the following: a string
45013 *   having the format file://path/to/file.pem. The named file must
45014 *   contain a PEM encoded certificate/private key (it may contain both).
45015 *   A PEM formatted private key.
45016 * @param string $passphrase The optional parameter {@link passphrase}
45017 *   must be used if the specified key is encrypted (protected by a
45018 *   passphrase).
45019 * @return resource
45020 * @since PHP 4 >= 4.0.4, PHP 5
45021 **/
45022function openssl_get_privatekey($key, $passphrase){}
45023
45024/**
45025 * {@link openssl_get_publickey} extracts the public key from {@link
45026 * certificate} and prepares it for use by other functions.
45027 *
45028 * @param mixed $certificate {@link certificate} can be one of the
45029 *   following: an X.509 certificate resource a string having the format
45030 *   file://path/to/file.pem. The named file must contain a PEM encoded
45031 *   certificate/private key (it may contain both). A PEM formatted
45032 *   private key.
45033 * @return resource
45034 * @since PHP 4 >= 4.0.4, PHP 5
45035 **/
45036function openssl_get_publickey($certificate){}
45037
45038/**
45039 * {@link openssl_open} opens (decrypts) {@link sealed_data} using the
45040 * private key associated with the key identifier {@link priv_key_id} and
45041 * the envelope key {@link env_key}, and fills {@link open_data} with the
45042 * decrypted data. The envelope key is generated when the data are sealed
45043 * and can only be used by one specific private key. See {@link
45044 * openssl_seal} for more information.
45045 *
45046 * @param string $sealed_data
45047 * @param string $open_data If the call is successful the opened data
45048 *   is returned in this parameter.
45049 * @param string $env_key
45050 * @param mixed $priv_key_id
45051 * @return bool
45052 * @since PHP 4 >= 4.0.4, PHP 5
45053 **/
45054function openssl_open($sealed_data, &$open_data, $env_key, $priv_key_id){}
45055
45056/**
45057 * Decrypts the S/MIME encrypted message contained in the file specified
45058 * by {@link infilename} using the certificate and its associated private
45059 * key specified by {@link recipcert} and {@link recipkey}.
45060 *
45061 * @param string $infilename
45062 * @param string $outfilename The decrypted message is written to the
45063 *   file specified by {@link outfilename}.
45064 * @param mixed $recipcert
45065 * @param mixed $recipkey
45066 * @return bool
45067 * @since PHP 4 >= 4.0.6, PHP 5
45068 **/
45069function openssl_pkcs7_decrypt($infilename, $outfilename, $recipcert, $recipkey){}
45070
45071/**
45072 * {@link openssl_pkcs7_encrypt} takes the contents of the file named
45073 * {@link infile} and encrypts them using an RC2 40-bit cipher so that
45074 * they can only be read by the intended recipients specified by {@link
45075 * recipcerts}.
45076 *
45077 * @param string $infile
45078 * @param string $outfile
45079 * @param mixed $recipcerts Either a lone X.509 certificate, or an
45080 *   array of X.509 certificates.
45081 * @param array $headers {@link headers} is an array of headers that
45082 *   will be prepended to the data after it has been encrypted. {@link
45083 *   headers} can be either an associative array keyed by header name, or
45084 *   an indexed array, where each element contains a single header line.
45085 * @param int $flags {@link flags} can be used to specify options that
45086 *   affect the encoding process - see PKCS7 constants.
45087 * @param int $cipherid Cipher can be selected with {@link cipherid}.
45088 * @return bool
45089 * @since PHP 4 >= 4.0.6, PHP 5
45090 **/
45091function openssl_pkcs7_encrypt($infile, $outfile, $recipcerts, $headers, $flags, $cipherid){}
45092
45093/**
45094 * {@link openssl_pkcs7_sign} takes the contents of the file named {@link
45095 * infilename} and signs them using the certificate and its matching
45096 * private key specified by {@link signcert} and {@link privkey}
45097 * parameters.
45098 *
45099 * @param string $infilename
45100 * @param string $outfilename
45101 * @param mixed $signcert
45102 * @param mixed $privkey
45103 * @param array $headers {@link headers} is an array of headers that
45104 *   will be prepended to the data after it has been signed (see {@link
45105 *   openssl_pkcs7_encrypt} for more information about the format of this
45106 *   parameter).
45107 * @param int $flags {@link flags} can be used to alter the output -
45108 *   see PKCS7 constants.
45109 * @param string $extracerts {@link extracerts} specifies the name of a
45110 *   file containing a bunch of extra certificates to include in the
45111 *   signature which can for example be used to help the recipient to
45112 *   verify the certificate that you used.
45113 * @return bool
45114 * @since PHP 4 >= 4.0.6, PHP 5
45115 **/
45116function openssl_pkcs7_sign($infilename, $outfilename, $signcert, $privkey, $headers, $flags, $extracerts){}
45117
45118/**
45119 * {@link openssl_pkcs7_verify} reads the S/MIME message contained in the
45120 * given file and examines the digital signature.
45121 *
45122 * @param string $filename Path to the message.
45123 * @param int $flags {@link flags} can be used to affect how the
45124 *   signature is verified - see PKCS7 constants for more information.
45125 * @param string $outfilename If the {@link outfilename} is specified,
45126 *   it should be a string holding the name of a file into which the
45127 *   certificates of the persons that signed the messages will be stored
45128 *   in PEM format.
45129 * @param array $cainfo If the {@link cainfo} is specified, it should
45130 *   hold information about the trusted CA certificates to use in the
45131 *   verification process - see certificate verification for more
45132 *   information about this parameter.
45133 * @param string $extracerts If the {@link extracerts} is specified, it
45134 *   is the filename of a file containing a bunch of certificates to use
45135 *   as untrusted CAs.
45136 * @param string $content You can specify a filename with {@link
45137 *   content} that will be filled with the verified data, but with the
45138 *   signature information stripped.
45139 * @return mixed
45140 * @since PHP 4 >= 4.0.6, PHP 5
45141 **/
45142function openssl_pkcs7_verify($filename, $flags, $outfilename, $cainfo, $extracerts, $content){}
45143
45144/**
45145 * {@link openssl_pkcs12_export} stores {@link x509} into a string named
45146 * by {@link out} in a PKCS#12 file format.
45147 *
45148 * @param mixed $x509 On success, this will hold the PKCS#12.
45149 * @param string $out Private key component of PKCS#12 file.
45150 * @param mixed $priv_key Encryption password for unlocking the PKCS#12
45151 *   file.
45152 * @param string $pass
45153 * @param array $args
45154 * @return bool
45155 * @since PHP 5 >= 5.2.2
45156 **/
45157function openssl_pkcs12_export($x509, &$out, $priv_key, $pass, $args){}
45158
45159/**
45160 * {@link openssl_pkcs12_export_to_file} stores {@link x509} into a file
45161 * named by {@link filename} in a PKCS#12 file format.
45162 *
45163 * @param mixed $x509 Path to the output file.
45164 * @param string $filename Private key component of PKCS#12 file.
45165 * @param mixed $priv_key Encryption password for unlocking the PKCS#12
45166 *   file.
45167 * @param string $pass
45168 * @param array $args
45169 * @return bool
45170 * @since PHP 5 >= 5.2.2
45171 **/
45172function openssl_pkcs12_export_to_file($x509, $filename, $priv_key, $pass, $args){}
45173
45174/**
45175 * {@link openssl_pkcs12_read} parses the PKCS#12 certificate store
45176 * supplied by {@link pkcs12} into a array named {@link certs}.
45177 *
45178 * @param string $pkcs12
45179 * @param array $certs On success, this will hold the Certificate Store
45180 *   Data.
45181 * @param string $pass Encryption password for unlocking the PKCS#12
45182 *   file.
45183 * @return bool
45184 * @since PHP 5 >= 5.2.2
45185 **/
45186function openssl_pkcs12_read($pkcs12, &$certs, $pass){}
45187
45188/**
45189 * {@link openssl_pkey_export} exports {@link key} as a PEM encoded
45190 * string and stores it into {@link out} (which is passed by reference).
45191 *
45192 * @param mixed $key
45193 * @param string $out
45194 * @param string $passphrase The key is optionally protected by {@link
45195 *   passphrase}.
45196 * @param array $configargs {@link configargs} can be used to fine-tune
45197 *   the export process by specifying and/or overriding options for the
45198 *   openssl configuration file. See {@link openssl_csr_new} for more
45199 *   information about {@link configargs}.
45200 * @return bool
45201 * @since PHP 4 >= 4.2.0, PHP 5
45202 **/
45203function openssl_pkey_export($key, &$out, $passphrase, $configargs){}
45204
45205/**
45206 * {@link openssl_pkey_export_to_file} saves an ascii-armoured (PEM
45207 * encoded) rendition of {@link key} into the file named by {@link
45208 * outfilename}.
45209 *
45210 * @param mixed $key
45211 * @param string $outfilename Path to the output file.
45212 * @param string $passphrase The key can be optionally protected by a
45213 *   {@link passphrase}.
45214 * @param array $configargs {@link configargs} can be used to fine-tune
45215 *   the export process by specifying and/or overriding options for the
45216 *   openssl configuration file. See {@link openssl_csr_new} for more
45217 *   information about {@link configargs}.
45218 * @return bool
45219 * @since PHP 4 >= 4.2.0, PHP 5
45220 **/
45221function openssl_pkey_export_to_file($key, $outfilename, $passphrase, $configargs){}
45222
45223/**
45224 * This function frees a private key created by {@link openssl_pkey_new}.
45225 *
45226 * @param resource $key Resource holding the key.
45227 * @return void
45228 * @since PHP 4 >= 4.2.0, PHP 5
45229 **/
45230function openssl_pkey_free($key){}
45231
45232/**
45233 * This function returns the key details (bits, key, type).
45234 *
45235 * @param resource $key Resource holding the key.
45236 * @return array
45237 * @since PHP 5 >= 5.2.0
45238 **/
45239function openssl_pkey_get_details($key){}
45240
45241/**
45242 * {@link openssl_get_privatekey} parses {@link key} and prepares it for
45243 * use by other functions.
45244 *
45245 * @param mixed $key {@link key} can be one of the following: a string
45246 *   having the format file://path/to/file.pem. The named file must
45247 *   contain a PEM encoded certificate/private key (it may contain both).
45248 *   A PEM formatted private key.
45249 * @param string $passphrase The optional parameter {@link passphrase}
45250 *   must be used if the specified key is encrypted (protected by a
45251 *   passphrase).
45252 * @return resource
45253 * @since PHP 4 >= 4.2.0, PHP 5
45254 **/
45255function openssl_pkey_get_private($key, $passphrase){}
45256
45257/**
45258 * {@link openssl_get_publickey} extracts the public key from {@link
45259 * certificate} and prepares it for use by other functions.
45260 *
45261 * @param mixed $certificate {@link certificate} can be one of the
45262 *   following: an X.509 certificate resource a string having the format
45263 *   file://path/to/file.pem. The named file must contain a PEM encoded
45264 *   certificate/private key (it may contain both). A PEM formatted
45265 *   private key.
45266 * @return resource
45267 * @since PHP 4 >= 4.2.0, PHP 5
45268 **/
45269function openssl_pkey_get_public($certificate){}
45270
45271/**
45272 * {@link openssl_pkey_new} generates a new private and public key pair.
45273 * The public component of the key can be obtained using {@link
45274 * openssl_pkey_get_public}.
45275 *
45276 * @param array $configargs You can finetune the key generation (such
45277 *   as specifying the number of bits) using {@link configargs}. See
45278 *   {@link openssl_csr_new} for more information about {@link
45279 *   configargs}.
45280 * @return resource
45281 * @since PHP 4 >= 4.2.0, PHP 5
45282 **/
45283function openssl_pkey_new($configargs){}
45284
45285/**
45286 * {@link openssl_private_decrypt} decrypts {@link data} that was
45287 * previous encrypted via {@link openssl_public_encrypt} and stores the
45288 * result into {@link decrypted}.
45289 *
45290 * You can use this function e.g. to decrypt data which were supposed
45291 * only to you.
45292 *
45293 * @param string $data
45294 * @param string $decrypted
45295 * @param mixed $key {@link key} must be the private key corresponding
45296 *   that was used to encrypt the data.
45297 * @param int $padding {@link padding} can be one of
45298 *   OPENSSL_PKCS1_PADDING, OPENSSL_SSLV23_PADDING,
45299 *   OPENSSL_PKCS1_OAEP_PADDING, OPENSSL_NO_PADDING.
45300 * @return bool
45301 * @since PHP 4 >= 4.0.6, PHP 5
45302 **/
45303function openssl_private_decrypt($data, &$decrypted, $key, $padding){}
45304
45305/**
45306 * {@link openssl_private_encrypt} encrypts {@link data} with private
45307 * {@link key} and stores the result into {@link crypted}. Encrypted data
45308 * can be decrypted via {@link openssl_public_decrypt}.
45309 *
45310 * This function can be used e.g. to sign data (or its hash) to prove
45311 * that it is not written by someone else.
45312 *
45313 * @param string $data
45314 * @param string $crypted
45315 * @param mixed $key
45316 * @param int $padding {@link padding} can be one of
45317 *   OPENSSL_PKCS1_PADDING, OPENSSL_NO_PADDING.
45318 * @return bool
45319 * @since PHP 4 >= 4.0.6, PHP 5
45320 **/
45321function openssl_private_encrypt($data, &$crypted, $key, $padding){}
45322
45323/**
45324 * {@link openssl_public_decrypt} decrypts {@link data} that was previous
45325 * encrypted via {@link openssl_private_encrypt} and stores the result
45326 * into {@link decrypted}.
45327 *
45328 * You can use this function e.g. to check if the message was written by
45329 * the owner of the private key.
45330 *
45331 * @param string $data
45332 * @param string $decrypted
45333 * @param mixed $key {@link key} must be the public key corresponding
45334 *   that was used to encrypt the data.
45335 * @param int $padding {@link padding} can be one of
45336 *   OPENSSL_PKCS1_PADDING, OPENSSL_NO_PADDING.
45337 * @return bool
45338 * @since PHP 4 >= 4.0.6, PHP 5
45339 **/
45340function openssl_public_decrypt($data, &$decrypted, $key, $padding){}
45341
45342/**
45343 * {@link openssl_public_encrypt} encrypts {@link data} with public
45344 * {@link key} and stores the result into {@link crypted}. Encrypted data
45345 * can be decrypted via {@link openssl_private_decrypt}.
45346 *
45347 * This function can be used e.g. to encrypt message which can be then
45348 * read only by owner of the private key. It can be also used to store
45349 * secure data in database.
45350 *
45351 * @param string $data
45352 * @param string $crypted This will hold the result of the encryption.
45353 * @param mixed $key The public key.
45354 * @param int $padding {@link padding} can be one of
45355 *   OPENSSL_PKCS1_PADDING, OPENSSL_SSLV23_PADDING,
45356 *   OPENSSL_PKCS1_OAEP_PADDING, OPENSSL_NO_PADDING.
45357 * @return bool
45358 * @since PHP 4 >= 4.0.6, PHP 5
45359 **/
45360function openssl_public_encrypt($data, &$crypted, $key, $padding){}
45361
45362/**
45363 * Generates a string of pseudo-random bytes, with the number of bytes
45364 * determined by the {@link length} parameter.
45365 *
45366 * It also indicates if a cryptographically strong algorithm was used to
45367 * produce the pseudo-random bytes, and does this via the optional {@link
45368 * crypto_strong} parameter. It's rare for this to be , but some systems
45369 * may be broken or old.
45370 *
45371 * @param string $length The length of the desired string of bytes.
45372 *   Must be a positive integer. PHP will try to cast this parameter to a
45373 *   non-null integer to use it.
45374 * @param bool $crypto_strong If passed into the function, this will
45375 *   hold a boolean value that determines if the algorithm used was
45376 *   "cryptographically strong", e.g., safe for usage with GPG,
45377 *   passwords, etc. if it did, otherwise
45378 * @return string
45379 * @since PHP 5 >= 5.3.0
45380 **/
45381function openssl_random_pseudo_bytes($length, &$crypto_strong){}
45382
45383/**
45384 * {@link openssl_seal} seals (encrypts) {@link data} by using RC4 with a
45385 * randomly generated secret key. The key is encrypted with each of the
45386 * public keys associated with the identifiers in {@link pub_key_ids} and
45387 * each encrypted key is returned in {@link env_keys}. This means that
45388 * one can send sealed data to multiple recipients (provided one has
45389 * obtained their public keys). Each recipient must receive both the
45390 * sealed data and the envelope key that was encrypted with the
45391 * recipient's public key.
45392 *
45393 * @param string $data
45394 * @param string $sealed_data
45395 * @param array $env_keys
45396 * @param array $pub_key_ids
45397 * @return int
45398 * @since PHP 4 >= 4.0.4, PHP 5
45399 **/
45400function openssl_seal($data, &$sealed_data, &$env_keys, $pub_key_ids){}
45401
45402/**
45403 * {@link openssl_sign} computes a signature for the specified {@link
45404 * data} by using SHA1 for hashing followed by encryption using the
45405 * private key associated with {@link priv_key_id}. Note that the data
45406 * itself is not encrypted.
45407 *
45408 * @param string $data
45409 * @param string $signature If the call was successful the signature is
45410 *   returned in {@link signature}.
45411 * @param mixed $priv_key_id
45412 * @param int $signature_alg For more information see the list of
45413 *   Signature Algorithms.
45414 * @return bool
45415 * @since PHP 4 >= 4.0.4, PHP 5
45416 **/
45417function openssl_sign($data, &$signature, $priv_key_id, $signature_alg){}
45418
45419/**
45420 * {@link openssl_verify} verifies that the {@link signature} is correct
45421 * for the specified {@link data} using the public key associated with
45422 * {@link pub_key_id}. This must be the public key corresponding to the
45423 * private key used for signing.
45424 *
45425 * @param string $data
45426 * @param string $signature
45427 * @param mixed $pub_key_id
45428 * @param int $signature_alg For more information see the list of
45429 *   Signature Algorithms.
45430 * @return int
45431 * @since PHP 4 >= 4.0.4, PHP 5
45432 **/
45433function openssl_verify($data, $signature, $pub_key_id, $signature_alg){}
45434
45435/**
45436 * {@link openssl_x509_checkpurpose} examines a certificate to see if it
45437 * can be used for the specified {@link purpose}.
45438 *
45439 * @param mixed $x509cert The examined certificate.
45440 * @param int $purpose {@link openssl_x509_checkpurpose} purposes
45441 *   Constant Description X509_PURPOSE_SSL_CLIENT Can the certificate be
45442 *   used for the client side of an SSL connection?
45443 *   X509_PURPOSE_SSL_SERVER Can the certificate be used for the server
45444 *   side of an SSL connection? X509_PURPOSE_NS_SSL_SERVER Can the cert
45445 *   be used for Netscape SSL server? X509_PURPOSE_SMIME_SIGN Can the
45446 *   cert be used to sign S/MIME email? X509_PURPOSE_SMIME_ENCRYPT Can
45447 *   the cert be used to encrypt S/MIME email? X509_PURPOSE_CRL_SIGN Can
45448 *   the cert be used to sign a certificate revocation list (CRL)?
45449 *   X509_PURPOSE_ANY Can the cert be used for Any/All purposes? These
45450 *   options are not bitfields - you may specify one only!
45451 * @param array $cainfo {@link cainfo} should be an array of trusted CA
45452 *   files/dirs as described in Certificate Verification.
45453 * @param string $untrustedfile If specified, this should be the name
45454 *   of a PEM encoded file holding certificates that can be used to help
45455 *   verify the certificate, although no trust is placed in the
45456 *   certificates that come from that file.
45457 * @return int
45458 * @since PHP 4 >= 4.0.6, PHP 5
45459 **/
45460function openssl_x509_checkpurpose($x509cert, $purpose, $cainfo, $untrustedfile){}
45461
45462/**
45463 * Checks whether the given {@link key} is the private key that
45464 * corresponds to {@link cert}.
45465 *
45466 * @param mixed $cert The certificate.
45467 * @param mixed $key The private key.
45468 * @return bool
45469 * @since PHP 4 >= 4.2.0, PHP 5
45470 **/
45471function openssl_x509_check_private_key($cert, $key){}
45472
45473/**
45474 * {@link openssl_x509_export} stores {@link x509} into a string named by
45475 * {@link output} in a PEM encoded format.
45476 *
45477 * @param mixed $x509 On success, this will hold the PEM.
45478 * @param string $output
45479 * @param bool $notext
45480 * @return bool
45481 * @since PHP 4 >= 4.2.0, PHP 5
45482 **/
45483function openssl_x509_export($x509, &$output, $notext){}
45484
45485/**
45486 * {@link openssl_x509_export_to_file} stores {@link x509} into a file
45487 * named by {@link outfilename} in a PEM encoded format.
45488 *
45489 * @param mixed $x509 Path to the output file.
45490 * @param string $outfilename
45491 * @param bool $notext
45492 * @return bool
45493 * @since PHP 4 >= 4.2.0, PHP 5
45494 **/
45495function openssl_x509_export_to_file($x509, $outfilename, $notext){}
45496
45497/**
45498 * {@link openssl_x509_free} frees the certificate associated with the
45499 * specified {@link x509cert} resource from memory.
45500 *
45501 * @param resource $x509cert
45502 * @return void
45503 * @since PHP 4 >= 4.0.6, PHP 5
45504 **/
45505function openssl_x509_free($x509cert){}
45506
45507/**
45508 * {@link openssl_x509_parse} returns information about the supplied
45509 * {@link x509cert}, including fields such as subject name, issuer name,
45510 * purposes, valid from and valid to dates etc.
45511 *
45512 * @param mixed $x509cert
45513 * @param bool $shortnames {@link shortnames} controls how the data is
45514 *   indexed in the array - if {@link shortnames} is (the default) then
45515 *   fields will be indexed with the short name form, otherwise, the long
45516 *   name form will be used - e.g.: CN is the shortname form of
45517 *   commonName.
45518 * @return array
45519 * @since PHP 4 >= 4.0.6, PHP 5
45520 **/
45521function openssl_x509_parse($x509cert, $shortnames){}
45522
45523/**
45524 * {@link openssl_x509_read} parses the certificate supplied by {@link
45525 * x509certdata} and returns a resource identifier for it.
45526 *
45527 * @param mixed $x509certdata
45528 * @return resource
45529 * @since PHP 4 >= 4.0.6, PHP 5
45530 **/
45531function openssl_x509_read($x509certdata){}
45532
45533/**
45534 * Returns the ASCII value of the first character of {@link string}.
45535 *
45536 * This function complements {@link chr}.
45537 *
45538 * @param string $string A character.
45539 * @return int
45540 * @since PHP 4, PHP 5
45541 **/
45542function ord($string){}
45543
45544/**
45545 * This function adds another name/value pair to the URL rewrite
45546 * mechanism. The name and value will be added to URLs (as GET parameter)
45547 * and forms (as hidden input fields) the same way as the session ID when
45548 * transparent URL rewriting is enabled with session.use_trans_sid.
45549 * Please note that absolute URLs (http://example.com/..) aren't
45550 * rewritten.
45551 *
45552 * This function's behavior is controlled by the url_rewriter.tags
45553 * parameter.
45554 *
45555 * @param string $name The variable name.
45556 * @param string $value The variable value.
45557 * @return bool
45558 * @since PHP 4 >= 4.3.0, PHP 5
45559 **/
45560function output_add_rewrite_var($name, $value){}
45561
45562/**
45563 * This function resets the URL rewriter and removes all rewrite
45564 * variables previously set by the {@link output_add_rewrite_var}
45565 * function or the session mechanism (if session.use_trans_sid was set on
45566 * {@link session_start}).
45567 *
45568 * @return bool
45569 * @since PHP 4 >= 4.3.0, PHP 5
45570 **/
45571function output_reset_rewrite_vars(){}
45572
45573/**
45574 * The {@link overload} function will enable property and method call
45575 * overloading for a class identified by {@link class_name}.
45576 *
45577 * @param string $class_name The overloaded class name, as a string
45578 * @return void
45579 * @since PHP 4 >= 4.3.0
45580 **/
45581function overload($class_name){}
45582
45583/**
45584 * Overrides built-in functions by replacing them in the symbol table.
45585 *
45586 * @param string $function_name The function to override.
45587 * @param string $function_args The function arguments, as a comma
45588 *   separated string. Usually you will want to pass this parameter, as
45589 *   well as the {@link function_code} parameter, as a single quote
45590 *   delimited string. The reason for using single quoted strings, is to
45591 *   protect the variable names from parsing, otherwise, if you use
45592 *   double quotes there will be a need to escape the variable names,
45593 *   e.g. \$your_var.
45594 * @param string $function_code The new code for the function.
45595 * @return bool
45596 * @since PECL apd >= 0.2
45597 **/
45598function override_function($function_name, $function_args, $function_code){}
45599
45600/**
45601 * Closes the specified {@link connection} to Ovrimos. This has the
45602 * effect of rolling back uncommitted transactions.
45603 *
45604 * @param int $connection The Ovrimos connection identifier, returned
45605 *   by {@link ovrimos_connect}.
45606 * @return void
45607 * @since PHP 4 >= 4.0.3, PHP 5
45608 **/
45609function ovrimos_close($connection){}
45610
45611/**
45612 * Commits the transaction.
45613 *
45614 * @param int $connection_id The Ovrimos connection identifier,
45615 *   returned by {@link ovrimos_connect}.
45616 * @return bool
45617 * @since PHP 4 >= 4.0.3, PHP 5
45618 **/
45619function ovrimos_commit($connection_id){}
45620
45621/**
45622 * Connects to the specified database.
45623 *
45624 * @param string $host A host name or IP address.
45625 * @param string $dborport Either a database name, or the port number
45626 *   to connect to.
45627 * @param string $user The user name.
45628 * @param string $password Password associated with {@link user}.
45629 * @return int
45630 * @since PHP 4 >= 4.0.3, PHP 5
45631 **/
45632function ovrimos_connect($host, $dborport, $user, $password){}
45633
45634/**
45635 * Gets the name of the cursor. Useful when wishing to perform positioned
45636 * updates or deletes.
45637 *
45638 * @param int $result_id A result identifier, returned by {@link
45639 *   ovrimos_execute} or {@link ovrimos_exec}.
45640 * @return string
45641 * @since PHP 4 >= 4.0.3, PHP 5
45642 **/
45643function ovrimos_cursor($result_id){}
45644
45645/**
45646 * Executes an SQL statement (query or update) and returns a result
45647 * identifier.
45648 *
45649 * @param int $connection_id The Ovrimos connection identifier,
45650 *   returned by {@link ovrimos_connect}.
45651 * @param string $query The SQL statement. Evidently, it should not
45652 *   contain parameters. Use {@link ovrimos_prepare} for prepared
45653 *   statements.
45654 * @return int
45655 * @since PHP 4 >= 4.0.3, PHP 5
45656 **/
45657function ovrimos_exec($connection_id, $query){}
45658
45659/**
45660 * Executes a prepared statement.
45661 *
45662 * @param int $result_id An Ovrimos result identifier prepared with
45663 *   {@link ovrimos_prepare}.
45664 * @param array $parameters_array If the prepared statement contained
45665 *   parameters (question marks in the statement), the correct number of
45666 *   parameters should be passed in an array.
45667 * @return bool
45668 * @since PHP 4 >= 4.0.3, PHP 5
45669 **/
45670function ovrimos_execute($result_id, $parameters_array){}
45671
45672/**
45673 * Fetches a row from the given result set, into {@link result_array}.
45674 *
45675 * @param int $result_id A result identifier, returned by {@link
45676 *   ovrimos_execute} or {@link ovrimos_exec}.
45677 * @param array $result_array You must provide an array by reference.
45678 *   It will be filled with the fetched values.
45679 * @param string $how Determines how the rows are fetched. This can be
45680 *   one of the following strings (case is not significant): Option Notes
45681 *   Next Forward direction from current position. This is the default
45682 *   value. Prev Backward direction from current position. First Forward
45683 *   direction from the start. Last Backward direction from the end.
45684 *   Absolute Absolute position from the start. Requires {@link
45685 *   rownumber}.
45686 * @param int $rownumber The row number, first one is 0. Only needed
45687 *   when {@link how} is set to Absolute.
45688 * @return bool
45689 * @since PHP 4 >= 4.0.3, PHP 5
45690 **/
45691function ovrimos_fetch_into($result_id, &$result_array, $how, $rownumber){}
45692
45693/**
45694 * Fetches a row from the result set. Column values should be retrieved
45695 * with other calls.
45696 *
45697 * @param int $result_id A result identifier, returned by {@link
45698 *   ovrimos_execute} or {@link ovrimos_exec}.
45699 * @param int $how Determines how the rows are fetched. This can be one
45700 *   of the following strings (case is not significant): Option Notes
45701 *   Next Forward direction from current position. This is the default
45702 *   value. Prev Backward direction from current position. First Forward
45703 *   direction from the start. Last Backward direction from the end.
45704 *   Absolute Absolute position from the start. Requires {@link
45705 *   rownumber}.
45706 * @param int $row_number The row number, first one is 0. Only needed
45707 *   when {@link how} is set to Absolute.
45708 * @return bool
45709 * @since PHP 4 >= 4.0.3, PHP 5
45710 **/
45711function ovrimos_fetch_row($result_id, $how, $row_number){}
45712
45713/**
45714 * Gets the length of the specified output column.
45715 *
45716 * @param int $result_id A result identifier, returned by {@link
45717 *   ovrimos_execute} or {@link ovrimos_exec}.
45718 * @param int $field_number The field number. Starts at 1.
45719 * @return int
45720 * @since PHP 4 >= 4.0.3, PHP 5
45721 **/
45722function ovrimos_field_len($result_id, $field_number){}
45723
45724/**
45725 * Returns the output column name at the index specified.
45726 *
45727 * @param int $result_id A result identifier, returned by {@link
45728 *   ovrimos_execute} or {@link ovrimos_exec}.
45729 * @param int $field_number The field number. Starts at 1.
45730 * @return string
45731 * @since PHP 4 >= 4.0.3, PHP 5
45732 **/
45733function ovrimos_field_name($result_id, $field_number){}
45734
45735/**
45736 * Returns the 1-based index of the specified output column.
45737 *
45738 * @param int $result_id A result identifier, returned by {@link
45739 *   ovrimos_execute} or {@link ovrimos_exec}.
45740 * @param string $field_name The field name.
45741 * @return int
45742 * @since PHP 4 >= 4.0.3, PHP 5
45743 **/
45744function ovrimos_field_num($result_id, $field_name){}
45745
45746/**
45747 * Returns the type of the output column
45748 *
45749 * @param int $result_id A result identifier, returned by {@link
45750 *   ovrimos_execute} or {@link ovrimos_exec}.
45751 * @param int $field_number A 1-based index.
45752 * @return int
45753 * @since PHP 4 >= 4.0.3, PHP 5
45754 **/
45755function ovrimos_field_type($result_id, $field_number){}
45756
45757/**
45758 * Frees the specified result identifier.
45759 *
45760 * @param int $result_id A result identifier, returned by {@link
45761 *   ovrimos_execute} or {@link ovrimos_exec}.
45762 * @return bool
45763 * @since PHP 4 >= 4.0.3, PHP 5
45764 **/
45765function ovrimos_free_result($result_id){}
45766
45767/**
45768 * Specifies how many bytes are to be retrieved from long datatypes (long
45769 * varchar and long varbinary).
45770 *
45771 * @param int $result_id A result identifier, returned by {@link
45772 *   ovrimos_execute} or {@link ovrimos_exec}.
45773 * @param int $length The number of bytes to retrieve. Default is zero.
45774 * @return bool
45775 * @since PHP 4 >= 4.0.3, PHP 5
45776 **/
45777function ovrimos_longreadlen($result_id, $length){}
45778
45779/**
45780 * Returns the number of columns in the specified result identifier.
45781 *
45782 * @param int $result_id A result identifier, returned by {@link
45783 *   ovrimos_execute} or {@link ovrimos_exec}.
45784 * @return int
45785 * @since PHP 4 >= 4.0.3, PHP 5
45786 **/
45787function ovrimos_num_fields($result_id){}
45788
45789/**
45790 * Gets the number of rows affected by update operations.
45791 *
45792 * @param int $result_id A result identifier, returned by {@link
45793 *   ovrimos_execute} or {@link ovrimos_exec}.
45794 * @return int
45795 * @since PHP 4 >= 4.0.3, PHP 5
45796 **/
45797function ovrimos_num_rows($result_id){}
45798
45799/**
45800 * Prepares an SQL statement.
45801 *
45802 * @param int $connection_id The Ovrimos connection identifier,
45803 *   returned by {@link ovrimos_connect}.
45804 * @param string $query The SQL statement.
45805 * @return int
45806 * @since PHP 4 >= 4.0.3, PHP 5
45807 **/
45808function ovrimos_prepare($connection_id, $query){}
45809
45810/**
45811 * Retrieves the output column specified by {@link field}.
45812 *
45813 * @param int $result_id A result identifier, returned by {@link
45814 *   ovrimos_execute} or {@link ovrimos_exec}.
45815 * @param mixed $field Either as a string with the field name or as an
45816 *   1-based index.
45817 * @return string
45818 * @since PHP 4 >= 4.0.3, PHP 5
45819 **/
45820function ovrimos_result($result_id, $field){}
45821
45822/**
45823 * Prints the whole result set as an HTML table.
45824 *
45825 * @param int $result_id A result identifier, returned by {@link
45826 *   ovrimos_execute} or {@link ovrimos_exec}.
45827 * @param string $format Optional HTML attributes for the generated
45828 *   table element.
45829 * @return int
45830 * @since PHP 4 >= 4.0.3, PHP 5
45831 **/
45832function ovrimos_result_all($result_id, $format){}
45833
45834/**
45835 * Rolls back the transaction.
45836 *
45837 * @param int $connection_id The Ovrimos connection identifier,
45838 *   returned by {@link ovrimos_connect}.
45839 * @return bool
45840 * @since PHP 4 >= 4.0.3, PHP 5
45841 **/
45842function ovrimos_rollback($connection_id){}
45843
45844/**
45845 * Pack given arguments into binary string according to {@link format}.
45846 *
45847 * The idea for this function was taken from Perl and all formatting
45848 * codes work the same as in Perl. However, there are some formatting
45849 * codes that are missing such as Perl's "u" format code.
45850 *
45851 * Note that the distinction between signed and unsigned values only
45852 * affects the function {@link unpack}, where as function {@link pack}
45853 * gives the same result for signed and unsigned format codes.
45854 *
45855 * Also note that PHP internally stores integer values as signed values
45856 * of a machine-dependent size. If you give it an unsigned integer value
45857 * too large to be stored that way it is converted to a float which often
45858 * yields an undesired result.
45859 *
45860 * @param string $format The {@link format} string consists of format
45861 *   codes followed by an optional repeater argument. The repeater
45862 *   argument can be either an integer value or * for repeating to the
45863 *   end of the input data. For a, A, h, H the repeat count specifies how
45864 *   many characters of one data argument are taken, for @ it is the
45865 *   absolute position where to put the next data, for everything else
45866 *   the repeat count specifies how many data arguments are consumed and
45867 *   packed into the resulting binary string. Currently implemented
45868 *   formats are: {@link pack} format characters Code Description a
45869 *   NUL-padded string A SPACE-padded string h Hex string, low nibble
45870 *   first H Hex string, high nibble first csigned char C unsigned char s
45871 *   signed short (always 16 bit, machine byte order) S unsigned short
45872 *   (always 16 bit, machine byte order) n unsigned short (always 16 bit,
45873 *   big endian byte order) v unsigned short (always 16 bit, little
45874 *   endian byte order) i signed integer (machine dependent size and byte
45875 *   order) I unsigned integer (machine dependent size and byte order) l
45876 *   signed long (always 32 bit, machine byte order) L unsigned long
45877 *   (always 32 bit, machine byte order) N unsigned long (always 32 bit,
45878 *   big endian byte order) V unsigned long (always 32 bit, little endian
45879 *   byte order) f float (machine dependent size and representation) d
45880 *   double (machine dependent size and representation) x NUL byte X Back
45881 *   up one byte @ NUL-fill to absolute position
45882 * @param mixed $args
45883 * @return string
45884 * @since PHP 4, PHP 5
45885 **/
45886function pack($format, $args){}
45887
45888/**
45889 * @param string $filename A string containing the name of the file to
45890 *   compile. Similar to the argument to {@link include}.
45891 * @param array $errors A 2D hash of errors (including fatal errors)
45892 *   encountered during compilation. Returned by reference.
45893 * @param int $options One of either PARSEKIT_QUIET or PARSEKIT_SIMPLE.
45894 *   To produce varying degrees of verbosity in the returned output.
45895 * @return array
45896 * @since PECL parsekit >= 0.2.0
45897 **/
45898function parsekit_compile_file($filename, &$errors, $options){}
45899
45900/**
45901 * @param string $phpcode A string containing phpcode. Similar to the
45902 *   argument to {@link eval}.
45903 * @param array $errors A 2D hash of errors (including fatal errors)
45904 *   encountered during compilation. Returned by reference.
45905 * @param int $options One of either PARSEKIT_QUIET or PARSEKIT_SIMPLE.
45906 *   To produce varying degrees of verbosity in the returned output.
45907 * @return array
45908 * @since PECL parsekit >= 0.2.0
45909 **/
45910function parsekit_compile_string($phpcode, &$errors, $options){}
45911
45912/**
45913 * @param mixed $function A string describing a function, or an array
45914 *   describing a class/method.
45915 * @return array
45916 * @since PECL parsekit >= 0.3.0
45917 **/
45918function parsekit_func_arginfo($function){}
45919
45920/**
45921 * {@link parse_ini_file} loads in the ini file specified in {@link
45922 * filename}, and returns the settings in it in an associative array.
45923 *
45924 * The structure of the ini file is the same as the 's.
45925 *
45926 * @param string $filename The filename of the ini file being parsed.
45927 * @param bool $process_sections By setting the {@link
45928 *   process_sections} parameter to , you get a multidimensional array,
45929 *   with the section names and settings included. The default for {@link
45930 *   process_sections} is
45931 * @param int $scanner_mode Can either be INI_SCANNER_NORMAL (default)
45932 *   or INI_SCANNER_RAW. If INI_SCANNER_RAW is supplied, then option
45933 *   values will not be parsed.
45934 * @return array
45935 * @since PHP 4, PHP 5
45936 **/
45937function parse_ini_file($filename, $process_sections, $scanner_mode){}
45938
45939/**
45940 * {@link parse_ini_string} returns the settings in string {@link ini} in
45941 * an associative array.
45942 *
45943 * The structure of the ini string is the same as the 's.
45944 *
45945 * @param string $ini The contents of the ini file being parsed.
45946 * @param bool $process_sections By setting the {@link
45947 *   process_sections} parameter to , you get a multidimensional array,
45948 *   with the section names and settings included. The default for {@link
45949 *   process_sections} is
45950 * @param int $scanner_mode Can either be INI_SCANNER_NORMAL (default)
45951 *   or INI_SCANNER_RAW. If INI_SCANNER_RAW is supplied, then option
45952 *   values will not be parsed.
45953 * @return array
45954 * @since PHP 5 >= 5.3.0
45955 **/
45956function parse_ini_string($ini, $process_sections, $scanner_mode){}
45957
45958/**
45959 * Parses {@link str} as if it were the query string passed via a URL and
45960 * sets variables in the current scope.
45961 *
45962 * @param string $str The input string.
45963 * @param array $arr If the second parameter {@link arr} is present,
45964 *   variables are stored in this variable as array elements instead.
45965 * @return void
45966 * @since PHP 4, PHP 5
45967 **/
45968function parse_str($str, &$arr){}
45969
45970/**
45971 * This function parses a URL and returns an associative array containing
45972 * any of the various components of the URL that are present.
45973 *
45974 * This function is not meant to validate the given URL, it only breaks
45975 * it up into the above listed parts. Partial URLs are also accepted,
45976 * {@link parse_url} tries its best to parse them correctly.
45977 *
45978 * @param string $url The URL to parse. Invalid characters are replaced
45979 *   by _.
45980 * @param int $component Specify one of PHP_URL_SCHEME, PHP_URL_HOST,
45981 *   PHP_URL_PORT, PHP_URL_USER, PHP_URL_PASS, PHP_URL_PATH,
45982 *   PHP_URL_QUERY or PHP_URL_FRAGMENT to retrieve just a specific URL
45983 *   component as a string.
45984 * @return mixed
45985 * @since PHP 4, PHP 5
45986 **/
45987function parse_url($url, $component){}
45988
45989/**
45990 * The {@link passthru} function is similar to the {@link exec} function
45991 * in that it executes a {@link command}. This function should be used in
45992 * place of {@link exec} or {@link system} when the output from the Unix
45993 * command is binary data which needs to be passed directly back to the
45994 * browser. A common use for this is to execute something like the
45995 * pbmplus utilities that can output an image stream directly. By setting
45996 * the Content-type to image/gif and then calling a pbmplus program to
45997 * output a gif, you can create PHP scripts that output images directly.
45998 *
45999 * @param string $command The command that will be executed.
46000 * @param int $return_var If the {@link return_var} argument is
46001 *   present, the return status of the Unix command will be placed here.
46002 * @return void
46003 * @since PHP 4, PHP 5
46004 **/
46005function passthru($command, &$return_var){}
46006
46007/**
46008 * {@link pathinfo} returns an associative array containing information
46009 * about {@link path}.
46010 *
46011 * @param string $path The path being checked.
46012 * @param int $options You can specify which elements are returned with
46013 *   optional parameter {@link options}. It composes from
46014 *   PATHINFO_DIRNAME, PATHINFO_BASENAME, PATHINFO_EXTENSION and
46015 *   PATHINFO_FILENAME. It defaults to return all elements.
46016 * @return mixed
46017 * @since PHP 4 >= 4.0.3, PHP 5
46018 **/
46019function pathinfo($path, $options){}
46020
46021/**
46022 * Closes a file pointer to a pipe opened by {@link popen}.
46023 *
46024 * @param resource $handle The file pointer must be valid, and must
46025 *   have been returned by a successful call to {@link popen}.
46026 * @return int
46027 * @since PHP 4, PHP 5
46028 **/
46029function pclose($handle){}
46030
46031/**
46032 * Creates a timer that will send a SIGALRM signal to the process after
46033 * the given number of seconds. Any call to {@link pcntl_alarm} will
46034 * cancel any previously set alarm.
46035 *
46036 * @param int $seconds The number of seconds to wait. If {@link
46037 *   seconds} is zero, no new alarm is created.
46038 * @return int
46039 * @since PHP 4 >= 4.3.0, PHP 5
46040 **/
46041function pcntl_alarm($seconds){}
46042
46043/**
46044 * Executes the program with the given arguments.
46045 *
46046 * @param string $path {@link path} must be the path to a binary
46047 *   executable or a script with a valid path pointing to an executable
46048 *   in the shebang ( #!/usr/local/bin/perl for example) as the first
46049 *   line. See your system's man execve(2) page for additional
46050 *   information.
46051 * @param array $args {@link args} is an array of argument strings
46052 *   passed to the program.
46053 * @param array $envs {@link envs} is an array of strings which are
46054 *   passed as environment to the program. The array is in the format of
46055 *   name => value, the key being the name of the environmental variable
46056 *   and the value being the value of that variable.
46057 * @return void
46058 * @since PHP 4 >= 4.2.0, PHP 5
46059 **/
46060function pcntl_exec($path, $args, $envs){}
46061
46062/**
46063 * The {@link pcntl_fork} function creates a child process that differs
46064 * from the parent process only in its PID and PPID. Please see your
46065 * system's fork(2) man page for specific details as to how fork works on
46066 * your system.
46067 *
46068 * @return int
46069 * @since PHP 4 >= 4.1.0, PHP 5
46070 **/
46071function pcntl_fork(){}
46072
46073/**
46074 * {@link pcntl_getpriority} gets the priority of {@link pid}. Because
46075 * priority levels can differ between system types and kernel versions,
46076 * please see your system's getpriority(2) man page for specific details.
46077 *
46078 * @param int $pid If not specified, the pid of the current process is
46079 *   used.
46080 * @param int $process_identifier One of PRIO_PGRP, PRIO_USER or
46081 *   PRIO_PROCESS.
46082 * @return int
46083 * @since PHP 5
46084 **/
46085function pcntl_getpriority($pid, $process_identifier){}
46086
46087/**
46088 * {@link pcntl_setpriority} sets the priority of {@link pid}.
46089 *
46090 * @param int $priority {@link priority} is generally a value in the
46091 *   range -20 to 20. The default priority is 0 while a lower numerical
46092 *   value causes more favorable scheduling. Because priority levels can
46093 *   differ between system types and kernel versions, please see your
46094 *   system's setpriority(2) man page for specific details.
46095 * @param int $pid If not specified, the pid of the current process is
46096 *   used.
46097 * @param int $process_identifier One of PRIO_PGRP, PRIO_USER or
46098 *   PRIO_PROCESS.
46099 * @return bool
46100 * @since PHP 5
46101 **/
46102function pcntl_setpriority($priority, $pid, $process_identifier){}
46103
46104/**
46105 * The {@link pcntl_signal} function installs a new signal handler for
46106 * the signal indicated by {@link signo}.
46107 *
46108 * @param int $signo The signal number.
46109 * @param callback $handler The signal handler which may be the name of
46110 *   a user created function, or method, or either of the two global
46111 *   constants SIG_IGN or SIG_DFL.
46112 * @param bool $restart_syscalls Specifies whether system call
46113 *   restarting should be used when this signal arrives.
46114 * @return bool
46115 * @since PHP 4 >= 4.1.0, PHP 5
46116 **/
46117function pcntl_signal($signo, $handler, $restart_syscalls){}
46118
46119/**
46120 * The {@link pcntl_signal_dispatch} function calls the signal handlers
46121 * installed by {@link pcntl_signal} for each pending signal.
46122 *
46123 * @return bool
46124 * @since PHP 5 >= 5.3.0
46125 **/
46126function pcntl_signal_dispatch(){}
46127
46128/**
46129 * The {@link pcntl_sigprocmask} function adds, removes or sets blocked
46130 * signals, depending on the {@link how} parameter.
46131 *
46132 * @param int $how Sets the behavior of {@link pcntl_sigprocmask}.
46133 *   Possible values: SIG_BLOCK: Add the signals to the currently blocked
46134 *   signals. SIG_UNBLOCK: Remove the signals from the currently blocked
46135 *   signals. SIG_SETMASK: Replace the currently blocked signals by the
46136 *   given list of signals.
46137 * @param array $set List of signals.
46138 * @param array $oldset The {@link oldset} parameter is set to an array
46139 *   containing the list of the previously blocked signals.
46140 * @return bool
46141 * @since PHP 5 >= 5.3.0
46142 **/
46143function pcntl_sigprocmask($how, $set, &$oldset){}
46144
46145/**
46146 * The {@link pcntl_sigtimedwait} function operates in exactly the same
46147 * way as {@link pcntl_sigwaitinfo} except that it takes two additional
46148 * parameters, {@link seconds} and {@link nanoseconds}, which enable an
46149 * upper bound to be placed on the time for which the script is
46150 * suspended.
46151 *
46152 * @param array $set Array of signals to wait for.
46153 * @param array $siginfo The {@link siginfo} is set to an array
46154 *   containing informations about the signal. See {@link
46155 *   pcntl_sigwaitinfo}.
46156 * @param int $seconds Timeout in seconds.
46157 * @param int $nanoseconds Timeout in nanoseconds.
46158 * @return int
46159 * @since PHP 5 >= 5.3.0
46160 **/
46161function pcntl_sigtimedwait($set, &$siginfo, $seconds, $nanoseconds){}
46162
46163/**
46164 * The {@link pcntl_sigwaitinfo} function suspends execution of the
46165 * calling script until one of the signals given in {@link set} are
46166 * delivered. If one of the signal is already pending (e.g. blocked by
46167 * {@link pcntl_sigprocmask}), {@link pcntl_sigwaitinfo} will return
46168 * immediately.
46169 *
46170 * @param array $set Array of signals to wait for.
46171 * @param array $siginfo The {@link siginfo} parameter is set to an
46172 *   array containing informations about the signal. The following
46173 *   elements are set for all signals: signo: Signal number errno: An
46174 *   error number code: Signal code The following elements may be set for
46175 *   the SIGCHLD signal: status: Exit value or signal utime: User time
46176 *   consumed stime: System time consumed pid: Sending process ID uid:
46177 *   Real user ID of sending process The following elements may be set
46178 *   for the SIGILL, SIGFPE, SIGSEGV and SIGBUS signals: addr: Memory
46179 *   location which caused fault The following element may be set for the
46180 *   SIGPOLL signal: band: Band event fd: File descriptor number
46181 * @return int
46182 * @since PHP 5 >= 5.3.0
46183 **/
46184function pcntl_sigwaitinfo($set, &$siginfo){}
46185
46186/**
46187 * The wait function suspends execution of the current process until a
46188 * child has exited, or until a signal is delivered whose action is to
46189 * terminate the current process or to call a signal handling function.
46190 * If a child has already exited by the time of the call (a so-called
46191 * "zombie" process), the function returns immediately. Any system
46192 * resources used by the child are freed. Please see your system's
46193 * wait(2) man page for specific details as to how wait works on your
46194 * system.
46195 *
46196 * @param int $status {@link pcntl_wait} will store status information
46197 *   in the {@link status} parameter which can be evaluated using the
46198 *   following functions: {@link pcntl_wifexited}, {@link
46199 *   pcntl_wifstopped}, {@link pcntl_wifsignaled}, {@link
46200 *   pcntl_wexitstatus}, {@link pcntl_wtermsig} and {@link
46201 *   pcntl_wstopsig}.
46202 * @param int $options If wait3 is available on your system (mostly
46203 *   BSD-style systems), you can provide the optional {@link options}
46204 *   parameter. If this parameter is not provided, wait will be used for
46205 *   the system call. If wait3 is not available, providing a value for
46206 *   options will have no effect. The value of options is the value of
46207 *   zero or more of the following two constants OR'ed together: Possible
46208 *   values for {@link options} WNOHANG Return immediately if no child
46209 *   has exited. WUNTRACED Return for children which are stopped, and
46210 *   whose status has not been reported.
46211 * @return int
46212 * @since PHP 5
46213 **/
46214function pcntl_wait(&$status, $options){}
46215
46216/**
46217 * Suspends execution of the current process until a child as specified
46218 * by the {@link pid} argument has exited, or until a signal is delivered
46219 * whose action is to terminate the current process or to call a signal
46220 * handling function.
46221 *
46222 * If a child as requested by {@link pid} has already exited by the time
46223 * of the call (a so-called "zombie" process), the function returns
46224 * immediately. Any system resources used by the child are freed. Please
46225 * see your system's waitpid(2) man page for specific details as to how
46226 * waitpid works on your system.
46227 *
46228 * @param int $pid The value of {@link pid} can be one of the
46229 *   following: possible values for {@link pid} < -1 wait for any child
46230 *   process whose process group ID is equal to the absolute value of
46231 *   {@link pid}. -1 wait for any child process; this is the same
46232 *   behaviour that the wait function exhibits. 0 wait for any child
46233 *   process whose process group ID is equal to that of the calling
46234 *   process. > 0 wait for the child whose process ID is equal to the
46235 *   value of {@link pid}.
46236 * @param int $status {@link pcntl_waitpid} will store status
46237 *   information in the {@link status} parameter which can be evaluated
46238 *   using the following functions: {@link pcntl_wifexited}, {@link
46239 *   pcntl_wifstopped}, {@link pcntl_wifsignaled}, {@link
46240 *   pcntl_wexitstatus}, {@link pcntl_wtermsig} and {@link
46241 *   pcntl_wstopsig}.
46242 * @param int $options The value of {@link options} is the value of
46243 *   zero or more of the following two global constants OR'ed together:
46244 *   possible values for {@link options} WNOHANG return immediately if no
46245 *   child has exited. WUNTRACED return for children which are stopped,
46246 *   and whose status has not been reported.
46247 * @return int
46248 * @since PHP 4 >= 4.1.0, PHP 5
46249 **/
46250function pcntl_waitpid($pid, &$status, $options){}
46251
46252/**
46253 * Returns the return code of a terminated child. This function is only
46254 * useful if {@link pcntl_wifexited} returned .
46255 *
46256 * @param int $status
46257 * @return int
46258 * @since PHP 4 >= 4.1.0, PHP 5
46259 **/
46260function pcntl_wexitstatus($status){}
46261
46262/**
46263 * Checks whether the child status code represents a normal exit.
46264 *
46265 * @param int $status
46266 * @return bool
46267 * @since PHP 4 >= 4.1.0, PHP 5
46268 **/
46269function pcntl_wifexited($status){}
46270
46271/**
46272 * Checks whether the child process exited because of a signal which was
46273 * not caught.
46274 *
46275 * @param int $status
46276 * @return bool
46277 * @since PHP 4 >= 4.1.0, PHP 5
46278 **/
46279function pcntl_wifsignaled($status){}
46280
46281/**
46282 * Checks whether the child process which caused the return is currently
46283 * stopped; this is only possible if the call to {@link pcntl_waitpid}
46284 * was done using the option WUNTRACED.
46285 *
46286 * @param int $status
46287 * @return bool
46288 * @since PHP 4 >= 4.1.0, PHP 5
46289 **/
46290function pcntl_wifstopped($status){}
46291
46292/**
46293 * Returns the number of the signal which caused the child to stop. This
46294 * function is only useful if {@link pcntl_wifstopped} returned .
46295 *
46296 * @param int $status
46297 * @return int
46298 * @since PHP 4 >= 4.1.0, PHP 5
46299 **/
46300function pcntl_wstopsig($status){}
46301
46302/**
46303 * Returns the number of the signal that caused the child process to
46304 * terminate. This function is only useful if {@link pcntl_wifsignaled}
46305 * returned .
46306 *
46307 * @param int $status
46308 * @return int
46309 * @since PHP 4 >= 4.1.0, PHP 5
46310 **/
46311function pcntl_wtermsig($status){}
46312
46313/**
46314 * Activates a previously created structure element or other content
46315 * item.
46316 *
46317 * @param resource $pdfdoc
46318 * @param int $id
46319 * @return bool
46320 * @since PECL pdflib >= 2.0.0
46321 **/
46322function PDF_activate_item($pdfdoc, $id){}
46323
46324/**
46325 * Adds a link to a web resource.
46326 *
46327 * This function is deprecated since PDFlib version 6, use {@link
46328 * PDF_create_action} with {@link type=Launch} and {@link
46329 * PDF_create_annotation} with {@link type=Link} instead.
46330 *
46331 * @param resource $pdfdoc
46332 * @param float $llx
46333 * @param float $lly
46334 * @param float $urx
46335 * @param float $ury
46336 * @param string $filename
46337 * @return bool
46338 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
46339 **/
46340function PDF_add_launchlink($pdfdoc, $llx, $lly, $urx, $ury, $filename){}
46341
46342/**
46343 * Add a link annotation to a target within the current PDF file.
46344 *
46345 * This function is deprecated since PDFlib version 6, use {@link
46346 * PDF_create_action} with {@link type=GoTo} and {@link
46347 * PDF_create_annotation} with {@link type=Link} instead.
46348 *
46349 * @param resource $pdfdoc
46350 * @param float $lowerleftx
46351 * @param float $lowerlefty
46352 * @param float $upperrightx
46353 * @param float $upperrighty
46354 * @param int $page
46355 * @param string $dest
46356 * @return bool
46357 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
46358 **/
46359function PDF_add_locallink($pdfdoc, $lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $page, $dest){}
46360
46361/**
46362 * Creates a named destination on an arbitrary page in the current
46363 * document.
46364 *
46365 * @param resource $pdfdoc
46366 * @param string $name
46367 * @param string $optlist
46368 * @return bool
46369 * @since PECL pdflib >= 2.0.0
46370 **/
46371function PDF_add_nameddest($pdfdoc, $name, $optlist){}
46372
46373/**
46374 * Sets an annotation for the current page.
46375 *
46376 * This function is deprecated since PDFlib version 6, use {@link
46377 * PDF_create_annotation} with {@link type=Text} instead.
46378 *
46379 * @param resource $pdfdoc
46380 * @param float $llx
46381 * @param float $lly
46382 * @param float $urx
46383 * @param float $ury
46384 * @param string $contents
46385 * @param string $title
46386 * @param string $icon
46387 * @param int $open
46388 * @return bool
46389 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
46390 **/
46391function PDF_add_note($pdfdoc, $llx, $lly, $urx, $ury, $contents, $title, $icon, $open){}
46392
46393/**
46394 * Add a file link annotation to a PDF target.
46395 *
46396 * This function is deprecated since PDFlib version 6, use {@link
46397 * PDF_create_action} with {@link type=GoToR} and {@link
46398 * PDF_create_annotation} with {@link type=Link} instead.
46399 *
46400 * @param resource $pdfdoc
46401 * @param float $bottom_left_x
46402 * @param float $bottom_left_y
46403 * @param float $up_right_x
46404 * @param float $up_right_y
46405 * @param string $filename
46406 * @param int $page
46407 * @param string $dest
46408 * @return bool
46409 * @since PHP 4, PECL pdflib >= 1.0.0
46410 **/
46411function PDF_add_pdflink($pdfdoc, $bottom_left_x, $bottom_left_y, $up_right_x, $up_right_y, $filename, $page, $dest){}
46412
46413/**
46414 * Adds a cell to a new or existing table.
46415 *
46416 * @param resource $pdfdoc
46417 * @param int $table
46418 * @param int $column
46419 * @param int $row
46420 * @param string $text
46421 * @param string $optlist
46422 * @return int
46423 * @since PECL pdflib >= 2.1.0
46424 **/
46425function PDF_add_table_cell($pdfdoc, $table, $column, $row, $text, $optlist){}
46426
46427/**
46428 * Creates a Textflow object, or adds text and explicit options to an
46429 * existing Textflow.
46430 *
46431 * @param resource $pdfdoc
46432 * @param int $textflow
46433 * @param string $text
46434 * @param string $optlist
46435 * @return int
46436 * @since PECL pdflib >= 2.1.0
46437 **/
46438function PDF_add_textflow($pdfdoc, $textflow, $text, $optlist){}
46439
46440/**
46441 * Adds an existing image as thumbnail for the current page.
46442 *
46443 * @param resource $pdfdoc
46444 * @param int $image
46445 * @return bool
46446 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
46447 **/
46448function PDF_add_thumbnail($pdfdoc, $image){}
46449
46450/**
46451 * Adds a weblink annotation to a target {@link url} on the Web.
46452 *
46453 * This function is deprecated since PDFlib version 6, use {@link
46454 * PDF_create_action} with {@link type=URI} and {@link
46455 * PDF_create_annotation} with {@link type=Link} instead.
46456 *
46457 * @param resource $pdfdoc
46458 * @param float $lowerleftx
46459 * @param float $lowerlefty
46460 * @param float $upperrightx
46461 * @param float $upperrighty
46462 * @param string $url
46463 * @return bool
46464 * @since PHP 4, PECL pdflib >= 1.0.0
46465 **/
46466function PDF_add_weblink($pdfdoc, $lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $url){}
46467
46468/**
46469 * Adds a counterclockwise circular arc.
46470 *
46471 * @param resource $p
46472 * @param float $x
46473 * @param float $y
46474 * @param float $r
46475 * @param float $alpha
46476 * @param float $beta
46477 * @return bool
46478 * @since PHP 4, PECL pdflib >= 1.0.0
46479 **/
46480function PDF_arc($p, $x, $y, $r, $alpha, $beta){}
46481
46482/**
46483 * Except for the drawing direction, this function behaves exactly like
46484 * {@link PDF_arc}.
46485 *
46486 * @param resource $p
46487 * @param float $x
46488 * @param float $y
46489 * @param float $r
46490 * @param float $alpha
46491 * @param float $beta
46492 * @return bool
46493 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
46494 **/
46495function PDF_arcn($p, $x, $y, $r, $alpha, $beta){}
46496
46497/**
46498 * Adds a file attachment annotation.
46499 *
46500 * This function is deprecated since PDFlib version 6, use {@link
46501 * PDF_create_annotation} with {@link type=FileAttachment} instead.
46502 *
46503 * @param resource $pdfdoc
46504 * @param float $llx
46505 * @param float $lly
46506 * @param float $urx
46507 * @param float $ury
46508 * @param string $filename
46509 * @param string $description
46510 * @param string $author
46511 * @param string $mimetype
46512 * @param string $icon
46513 * @return bool
46514 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
46515 **/
46516function PDF_attach_file($pdfdoc, $llx, $lly, $urx, $ury, $filename, $description, $author, $mimetype, $icon){}
46517
46518/**
46519 * Creates a new PDF file subject to various options.
46520 *
46521 * @param resource $pdfdoc
46522 * @param string $filename
46523 * @param string $optlist
46524 * @return int
46525 * @since PECL pdflib >= 2.0.0
46526 **/
46527function PDF_begin_document($pdfdoc, $filename, $optlist){}
46528
46529/**
46530 * Starts a Type 3 font definition.
46531 *
46532 * @param resource $pdfdoc
46533 * @param string $filename
46534 * @param float $a
46535 * @param float $b
46536 * @param float $c
46537 * @param float $d
46538 * @param float $e
46539 * @param float $f
46540 * @param string $optlist
46541 * @return bool
46542 * @since PECL pdflib >= 2.0.0
46543 **/
46544function PDF_begin_font($pdfdoc, $filename, $a, $b, $c, $d, $e, $f, $optlist){}
46545
46546/**
46547 * Starts a glyph definition for a Type 3 font.
46548 *
46549 * @param resource $pdfdoc
46550 * @param string $glyphname
46551 * @param float $wx
46552 * @param float $llx
46553 * @param float $lly
46554 * @param float $urx
46555 * @param float $ury
46556 * @return bool
46557 * @since PECL pdflib >= 2.0.0
46558 **/
46559function PDF_begin_glyph($pdfdoc, $glyphname, $wx, $llx, $lly, $urx, $ury){}
46560
46561/**
46562 * Opens a structure element or other content item with attributes
46563 * supplied as options.
46564 *
46565 * @param resource $pdfdoc
46566 * @param string $tag
46567 * @param string $optlist
46568 * @return int
46569 * @since PECL pdflib >= 2.0.0
46570 **/
46571function PDF_begin_item($pdfdoc, $tag, $optlist){}
46572
46573/**
46574 * Starts a layer for subsequent output on the page.
46575 *
46576 * This function requires PDF 1.5.
46577 *
46578 * @param resource $pdfdoc
46579 * @param int $layer
46580 * @return bool
46581 * @since PECL pdflib >= 2.0.0
46582 **/
46583function PDF_begin_layer($pdfdoc, $layer){}
46584
46585/**
46586 * Adds a new page to the document.
46587 *
46588 * This function is deprecated since PDFlib version 6, use {@link
46589 * PDF_begin_page_ext} instead.
46590 *
46591 * @param resource $pdfdoc
46592 * @param float $width
46593 * @param float $height
46594 * @return bool
46595 * @since PHP 4, PECL pdflib >= 1.0.0
46596 **/
46597function PDF_begin_page($pdfdoc, $width, $height){}
46598
46599/**
46600 * Adds a new page to the document, and specifies various options. The
46601 * parameters {@link width} and {@link height} are the dimensions of the
46602 * new page in points.
46603 *
46604 * Common Page Sizes in Points name size A0 2380 x 3368 A1 1684 x 2380 A2
46605 * 1190 x 1684 A3 842 x 1190 A4 595 x 842 A5 421 x 595 A6 297 x 421 B5
46606 * 501 x 709 letter (8.5" x 11") 612 x 792 legal (8.5" x 14") 612 x 1008
46607 * ledger (17" x 11") 1224 x 792 11" x 17" 792 x 1224
46608 *
46609 * @param resource $pdfdoc
46610 * @param float $width
46611 * @param float $height
46612 * @param string $optlist
46613 * @return bool
46614 * @since PECL pdflib >= 2.0.0
46615 **/
46616function PDF_begin_page_ext($pdfdoc, $width, $height, $optlist){}
46617
46618/**
46619 * Starts a new pattern definition.
46620 *
46621 * @param resource $pdfdoc
46622 * @param float $width
46623 * @param float $height
46624 * @param float $xstep
46625 * @param float $ystep
46626 * @param int $painttype
46627 * @return int
46628 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
46629 **/
46630function PDF_begin_pattern($pdfdoc, $width, $height, $xstep, $ystep, $painttype){}
46631
46632/**
46633 * Starts a new template definition.
46634 *
46635 * This function is deprecated since PDFlib version 7, use {@link
46636 * PDF_begin_template_ext} instead.
46637 *
46638 * @param resource $pdfdoc
46639 * @param float $width
46640 * @param float $height
46641 * @return int
46642 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
46643 **/
46644function PDF_begin_template($pdfdoc, $width, $height){}
46645
46646/**
46647 * Starts a new template definition.
46648 *
46649 * @param resource $pdfdoc
46650 * @param float $width
46651 * @param float $height
46652 * @param string $optlist
46653 * @return int
46654 * @since PECL pdflib >= 2.1.0
46655 **/
46656function PDF_begin_template_ext($pdfdoc, $width, $height, $optlist){}
46657
46658/**
46659 * Adds a circle.
46660 *
46661 * @param resource $pdfdoc
46662 * @param float $x
46663 * @param float $y
46664 * @param float $r
46665 * @return bool
46666 * @since PHP 4, PECL pdflib >= 1.0.0
46667 **/
46668function PDF_circle($pdfdoc, $x, $y, $r){}
46669
46670/**
46671 * Uses the current path as clipping path, and terminate the path.
46672 *
46673 * @param resource $p
46674 * @return bool
46675 * @since PHP 4, PECL pdflib >= 1.0.0
46676 **/
46677function PDF_clip($p){}
46678
46679/**
46680 * Closes the generated PDF file, and frees all document-related
46681 * resources.
46682 *
46683 * This function is deprecated since PDFlib version 6, use {@link
46684 * PDF_end_document} instead.
46685 *
46686 * @param resource $p
46687 * @return bool
46688 * @since PHP 4, PECL pdflib >= 1.0.0
46689 **/
46690function PDF_close($p){}
46691
46692/**
46693 * Closes the current path.
46694 *
46695 * @param resource $p
46696 * @return bool
46697 * @since PHP 4, PECL pdflib >= 1.0.0
46698 **/
46699function PDF_closepath($p){}
46700
46701/**
46702 * Closes the path, fills, and strokes it.
46703 *
46704 * @param resource $p
46705 * @return bool
46706 * @since PHP 4, PECL pdflib >= 1.0.0
46707 **/
46708function PDF_closepath_fill_stroke($p){}
46709
46710/**
46711 * Closes the path, and strokes it.
46712 *
46713 * @param resource $p
46714 * @return bool
46715 * @since PHP 4, PECL pdflib >= 1.0.0
46716 **/
46717function PDF_closepath_stroke($p){}
46718
46719/**
46720 * Closes an {@link image} retrieved with the {@link PDF_open_image}
46721 * function.
46722 *
46723 * @param resource $p
46724 * @param int $image
46725 * @return bool
46726 * @since PHP 4, PECL pdflib >= 1.0.0
46727 **/
46728function PDF_close_image($p, $image){}
46729
46730/**
46731 * Closes all open page handles, and closes the input PDF document.
46732 *
46733 * This function is deprecated since PDFlib version 7, use {@link
46734 * PDF_close_pdi_document} instead.
46735 *
46736 * @param resource $p
46737 * @param int $doc
46738 * @return bool
46739 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
46740 **/
46741function PDF_close_pdi($p, $doc){}
46742
46743/**
46744 * Closes the page handle, and frees all page-related resources.
46745 *
46746 * @param resource $p
46747 * @param int $page
46748 * @return bool
46749 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
46750 **/
46751function PDF_close_pdi_page($p, $page){}
46752
46753/**
46754 * Concatenates a matrix to the current transformation matrix (CTM).
46755 *
46756 * @param resource $p
46757 * @param float $a
46758 * @param float $b
46759 * @param float $c
46760 * @param float $d
46761 * @param float $e
46762 * @param float $f
46763 * @return bool
46764 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
46765 **/
46766function PDF_concat($p, $a, $b, $c, $d, $e, $f){}
46767
46768/**
46769 * Prints {@link text} at the next line.
46770 *
46771 * @param resource $p
46772 * @param string $text
46773 * @return bool
46774 * @since PHP 4, PECL pdflib >= 1.0.0
46775 **/
46776function PDF_continue_text($p, $text){}
46777
46778/**
46779 * Creates a 3D view.
46780 *
46781 * This function requires PDF 1.6.
46782 *
46783 * @param resource $pdfdoc
46784 * @param string $username
46785 * @param string $optlist
46786 * @return int
46787 * @since PECL pdflib >= 2.1.0
46788 **/
46789function PDF_create_3dview($pdfdoc, $username, $optlist){}
46790
46791/**
46792 * Creates an action which can be applied to various objects and events.
46793 *
46794 * @param resource $pdfdoc
46795 * @param string $type
46796 * @param string $optlist
46797 * @return int
46798 * @since PECL pdflib >= 2.0.0
46799 **/
46800function PDF_create_action($pdfdoc, $type, $optlist){}
46801
46802/**
46803 * Creates a rectangular annotation on the current page.
46804 *
46805 * @param resource $pdfdoc
46806 * @param float $llx
46807 * @param float $lly
46808 * @param float $urx
46809 * @param float $ury
46810 * @param string $type
46811 * @param string $optlist
46812 * @return bool
46813 * @since PECL pdflib >= 2.0.0
46814 **/
46815function PDF_create_annotation($pdfdoc, $llx, $lly, $urx, $ury, $type, $optlist){}
46816
46817/**
46818 * Creates a bookmark subject to various options.
46819 *
46820 * @param resource $pdfdoc
46821 * @param string $text
46822 * @param string $optlist
46823 * @return int
46824 * @since PECL pdflib >= 2.0.0
46825 **/
46826function PDF_create_bookmark($pdfdoc, $text, $optlist){}
46827
46828/**
46829 * Creates a form field on the current page subject to various options.
46830 *
46831 * @param resource $pdfdoc
46832 * @param float $llx
46833 * @param float $lly
46834 * @param float $urx
46835 * @param float $ury
46836 * @param string $name
46837 * @param string $type
46838 * @param string $optlist
46839 * @return bool
46840 * @since PECL pdflib >= 2.0.0
46841 **/
46842function PDF_create_field($pdfdoc, $llx, $lly, $urx, $ury, $name, $type, $optlist){}
46843
46844/**
46845 * Creates a form field group subject to various options.
46846 *
46847 * @param resource $pdfdoc
46848 * @param string $name
46849 * @param string $optlist
46850 * @return bool
46851 * @since PECL pdflib >= 2.0.0
46852 **/
46853function PDF_create_fieldgroup($pdfdoc, $name, $optlist){}
46854
46855/**
46856 * Creates a graphics state object subject to various options.
46857 *
46858 * @param resource $pdfdoc
46859 * @param string $optlist
46860 * @return int
46861 * @since PECL pdflib >= 2.0.0
46862 **/
46863function PDF_create_gstate($pdfdoc, $optlist){}
46864
46865/**
46866 * Creates a named virtual read-only file from data provided in memory.
46867 *
46868 * @param resource $pdfdoc
46869 * @param string $filename
46870 * @param string $data
46871 * @param string $optlist
46872 * @return bool
46873 * @since PECL pdflib >= 2.0.0
46874 **/
46875function PDF_create_pvf($pdfdoc, $filename, $data, $optlist){}
46876
46877/**
46878 * Preprocesses text for later formatting and creates a textflow object.
46879 *
46880 * @param resource $pdfdoc
46881 * @param string $text
46882 * @param string $optlist
46883 * @return int
46884 * @since PECL pdflib >= 2.0.0
46885 **/
46886function PDF_create_textflow($pdfdoc, $text, $optlist){}
46887
46888/**
46889 * Draws a Bezier curve from the current point, using 3 more control
46890 * points.
46891 *
46892 * @param resource $p
46893 * @param float $x1
46894 * @param float $y1
46895 * @param float $x2
46896 * @param float $y2
46897 * @param float $x3
46898 * @param float $y3
46899 * @return bool
46900 * @since PHP 4, PECL pdflib >= 1.0.0
46901 **/
46902function PDF_curveto($p, $x1, $y1, $x2, $y2, $x3, $y3){}
46903
46904/**
46905 * Creates a new layer definition.
46906 *
46907 * This function requires PDF 1.5.
46908 *
46909 * @param resource $pdfdoc
46910 * @param string $name
46911 * @param string $optlist
46912 * @return int
46913 * @since PECL pdflib >= 2.0.0
46914 **/
46915function PDF_define_layer($pdfdoc, $name, $optlist){}
46916
46917/**
46918 * Deletes a PDFlib object, and frees all internal resources.
46919 *
46920 * @param resource $pdfdoc
46921 * @return bool
46922 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
46923 **/
46924function PDF_delete($pdfdoc){}
46925
46926/**
46927 * Deletes a named virtual file and frees its data structures (but not
46928 * the contents).
46929 *
46930 * @param resource $pdfdoc
46931 * @param string $filename
46932 * @return int
46933 * @since PECL pdflib >= 2.0.0
46934 **/
46935function PDF_delete_pvf($pdfdoc, $filename){}
46936
46937/**
46938 * Deletes a table and all associated data structures.
46939 *
46940 * @param resource $pdfdoc
46941 * @param int $table
46942 * @param string $optlist
46943 * @return bool
46944 * @since PECL pdflib >= 2.1.0
46945 **/
46946function PDF_delete_table($pdfdoc, $table, $optlist){}
46947
46948/**
46949 * Deletes a textflow and the associated data structures.
46950 *
46951 * @param resource $pdfdoc
46952 * @param int $textflow
46953 * @return bool
46954 * @since PECL pdflib >= 2.0.0
46955 **/
46956function PDF_delete_textflow($pdfdoc, $textflow){}
46957
46958/**
46959 * Adds a glyph name and/or Unicode value to a custom encoding.
46960 *
46961 * @param resource $pdfdoc
46962 * @param string $encoding
46963 * @param int $slot
46964 * @param string $glyphname
46965 * @param int $uv
46966 * @return bool
46967 * @since PECL pdflib >= 2.0.0
46968 **/
46969function PDF_encoding_set_char($pdfdoc, $encoding, $slot, $glyphname, $uv){}
46970
46971/**
46972 * Ends the current path without filling or stroking it.
46973 *
46974 * @param resource $p
46975 * @return bool
46976 * @since PHP 4, PECL pdflib >= 1.0.0
46977 **/
46978function PDF_endpath($p){}
46979
46980/**
46981 * Closes the generated PDF file and applies various options.
46982 *
46983 * @param resource $pdfdoc
46984 * @param string $optlist
46985 * @return bool
46986 * @since PECL pdflib >= 2.0.0
46987 **/
46988function PDF_end_document($pdfdoc, $optlist){}
46989
46990/**
46991 * Terminates a Type 3 font definition.
46992 *
46993 * @param resource $pdfdoc
46994 * @return bool
46995 * @since PECL pdflib >= 2.0.0
46996 **/
46997function PDF_end_font($pdfdoc){}
46998
46999/**
47000 * Terminates a glyph definition for a Type 3 font.
47001 *
47002 * @param resource $pdfdoc
47003 * @return bool
47004 * @since PECL pdflib >= 2.0.0
47005 **/
47006function PDF_end_glyph($pdfdoc){}
47007
47008/**
47009 * Closes a structure element or other content item.
47010 *
47011 * @param resource $pdfdoc
47012 * @param int $id
47013 * @return bool
47014 * @since PECL pdflib >= 2.0.0
47015 **/
47016function PDF_end_item($pdfdoc, $id){}
47017
47018/**
47019 * Deactivates all active layers.
47020 *
47021 * This function requires PDF 1.5.
47022 *
47023 * @param resource $pdfdoc
47024 * @return bool
47025 * @since PECL pdflib >= 2.0.0
47026 **/
47027function PDF_end_layer($pdfdoc){}
47028
47029/**
47030 * Finishes the page.
47031 *
47032 * @param resource $p
47033 * @return bool
47034 * @since PHP 4, PECL pdflib >= 1.0.0
47035 **/
47036function PDF_end_page($p){}
47037
47038/**
47039 * Finishes a page, and applies various options.
47040 *
47041 * @param resource $pdfdoc
47042 * @param string $optlist
47043 * @return bool
47044 * @since PECL pdflib >= 2.0.0
47045 **/
47046function PDF_end_page_ext($pdfdoc, $optlist){}
47047
47048/**
47049 * Finishes the pattern definition.
47050 *
47051 * @param resource $p
47052 * @return bool
47053 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47054 **/
47055function PDF_end_pattern($p){}
47056
47057/**
47058 * Finishes a template definition.
47059 *
47060 * @param resource $p
47061 * @return bool
47062 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47063 **/
47064function PDF_end_template($p){}
47065
47066/**
47067 * Fills the interior of the current path with the current fill color.
47068 *
47069 * @param resource $p
47070 * @return bool
47071 * @since PHP 4, PECL pdflib >= 1.0.0
47072 **/
47073function PDF_fill($p){}
47074
47075/**
47076 * Fills an image block with variable data according to its properties.
47077 *
47078 * This function is only available in the PDFlib Personalization Server
47079 * (PPS).
47080 *
47081 * @param resource $pdfdoc
47082 * @param int $page
47083 * @param string $blockname
47084 * @param int $image
47085 * @param string $optlist
47086 * @return int
47087 * @since PECL pdflib >= 2.0.0
47088 **/
47089function PDF_fill_imageblock($pdfdoc, $page, $blockname, $image, $optlist){}
47090
47091/**
47092 * Fills a PDF block with variable data according to its properties.
47093 *
47094 * This function is only available in the PDFlib Personalization Server
47095 * (PPS).
47096 *
47097 * @param resource $pdfdoc
47098 * @param int $page
47099 * @param string $blockname
47100 * @param int $contents
47101 * @param string $optlist
47102 * @return int
47103 * @since PECL pdflib >= 2.0.0
47104 **/
47105function PDF_fill_pdfblock($pdfdoc, $page, $blockname, $contents, $optlist){}
47106
47107/**
47108 * Fills and strokes the current path with the current fill and stroke
47109 * color.
47110 *
47111 * @param resource $p
47112 * @return bool
47113 * @since PHP 4, PECL pdflib >= 1.0.0
47114 **/
47115function PDF_fill_stroke($p){}
47116
47117/**
47118 * Fills a text block with variable data according to its properties.
47119 *
47120 * This function is only available in the PDFlib Personalization Server
47121 * (PPS).
47122 *
47123 * @param resource $pdfdoc
47124 * @param int $page
47125 * @param string $blockname
47126 * @param string $text
47127 * @param string $optlist
47128 * @return int
47129 * @since PECL pdflib >= 2.0.0
47130 **/
47131function PDF_fill_textblock($pdfdoc, $page, $blockname, $text, $optlist){}
47132
47133/**
47134 * Search for a font and prepare it for later use with {@link
47135 * PDF_setfont}. The metrics will be loaded, and if {@link embed} is
47136 * nonzero, the font file will be checked, but not yet used. {@link
47137 * encoding} is one of builtin, macroman, winansi, host, a user-defined
47138 * encoding name or the name of a CMap. Parameter {@link embed} is
47139 * optional before PHP 4.3.5 or with PDFlib less than 5.
47140 *
47141 * This function is deprecated since PDFlib version 5, use {@link
47142 * PDF_load_font} instead.
47143 *
47144 * @param resource $p
47145 * @param string $fontname
47146 * @param string $encoding
47147 * @param int $embed
47148 * @return int
47149 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47150 **/
47151function PDF_findfont($p, $fontname, $encoding, $embed){}
47152
47153/**
47154 * Places an image or template on the page, subject to various options.
47155 *
47156 * @param resource $pdfdoc
47157 * @param int $image
47158 * @param float $x
47159 * @param float $y
47160 * @param string $optlist
47161 * @return bool
47162 * @since PECL pdflib >= 2.0.0
47163 **/
47164function PDF_fit_image($pdfdoc, $image, $x, $y, $optlist){}
47165
47166/**
47167 * Places an imported PDF page on the page, subject to various options.
47168 *
47169 * @param resource $pdfdoc
47170 * @param int $page
47171 * @param float $x
47172 * @param float $y
47173 * @param string $optlist
47174 * @return bool
47175 * @since PECL pdflib >= 2.0.0
47176 **/
47177function PDF_fit_pdi_page($pdfdoc, $page, $x, $y, $optlist){}
47178
47179/**
47180 * Places a table on the page fully or partially.
47181 *
47182 * @param resource $pdfdoc
47183 * @param int $table
47184 * @param float $llx
47185 * @param float $lly
47186 * @param float $urx
47187 * @param float $ury
47188 * @param string $optlist
47189 * @return string
47190 * @since PECL pdflib >= 2.1.0
47191 **/
47192function PDF_fit_table($pdfdoc, $table, $llx, $lly, $urx, $ury, $optlist){}
47193
47194/**
47195 * Formats the next portion of a textflow into a rectangular area.
47196 *
47197 * @param resource $pdfdoc
47198 * @param int $textflow
47199 * @param float $llx
47200 * @param float $lly
47201 * @param float $urx
47202 * @param float $ury
47203 * @param string $optlist
47204 * @return string
47205 * @since PECL pdflib >= 2.0.0
47206 **/
47207function PDF_fit_textflow($pdfdoc, $textflow, $llx, $lly, $urx, $ury, $optlist){}
47208
47209/**
47210 * Places a single line of text on the page, subject to various options.
47211 *
47212 * @param resource $pdfdoc
47213 * @param string $text
47214 * @param float $x
47215 * @param float $y
47216 * @param string $optlist
47217 * @return bool
47218 * @since PECL pdflib >= 2.0.0
47219 **/
47220function PDF_fit_textline($pdfdoc, $text, $x, $y, $optlist){}
47221
47222/**
47223 * Gets the name of the API function which threw the last exception or
47224 * failed.
47225 *
47226 * @param resource $pdfdoc
47227 * @return string
47228 * @since PECL pdflib >= 2.0.0
47229 **/
47230function PDF_get_apiname($pdfdoc){}
47231
47232/**
47233 * Fetches the buffer containing the generated PDF data.
47234 *
47235 * @param resource $p
47236 * @return string
47237 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47238 **/
47239function PDF_get_buffer($p){}
47240
47241/**
47242 * Gets the text of the last thrown exception or the reason for a failed
47243 * function call.
47244 *
47245 * @param resource $pdfdoc
47246 * @return string
47247 * @since PECL pdflib >= 2.0.0
47248 **/
47249function PDF_get_errmsg($pdfdoc){}
47250
47251/**
47252 * Gets the number of the last thrown exception or the reason for a
47253 * failed function call.
47254 *
47255 * @param resource $pdfdoc
47256 * @return int
47257 * @since PECL pdflib >= 2.0.0
47258 **/
47259function PDF_get_errnum($pdfdoc){}
47260
47261/**
47262 * This function is deprecated since PDFlib version 5, use {@link
47263 * PDF_get_value} with the parameter {@link major} instead.
47264 *
47265 * @return int
47266 * @since PHP 4 >= 4.2.0, PECL pdflib >= 1.0.0
47267 **/
47268function PDF_get_majorversion(){}
47269
47270/**
47271 * Returns the minor version number of the PDFlib version.
47272 *
47273 * This function is deprecated since PDFlib version 5, use {@link
47274 * PDF_get_value} with the parameter {@link minor} instead.
47275 *
47276 * @return int
47277 * @since PHP 4 >= 4.2.0, PECL pdflib >= 1.0.0
47278 **/
47279function PDF_get_minorversion(){}
47280
47281/**
47282 * Gets the contents of some PDFlib parameter with string type.
47283 *
47284 * @param resource $p
47285 * @param string $key
47286 * @param float $modifier
47287 * @return string
47288 * @since PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0
47289 **/
47290function PDF_get_parameter($p, $key, $modifier){}
47291
47292/**
47293 * Gets the contents of a PDI document parameter with string type.
47294 *
47295 * This function is deprecated since PDFlib version 7, use {@link
47296 * PDF_pcos_get_string} instead.
47297 *
47298 * @param resource $p
47299 * @param string $key
47300 * @param int $doc
47301 * @param int $page
47302 * @param int $reserved
47303 * @return string
47304 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47305 **/
47306function PDF_get_pdi_parameter($p, $key, $doc, $page, $reserved){}
47307
47308/**
47309 * Gets the contents of a PDI document parameter with numerical type.
47310 *
47311 * This function is deprecated since PDFlib version 7, use {@link
47312 * PDF_pcos_get_number} instead.
47313 *
47314 * @param resource $p
47315 * @param string $key
47316 * @param int $doc
47317 * @param int $page
47318 * @param int $reserved
47319 * @return float
47320 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47321 **/
47322function PDF_get_pdi_value($p, $key, $doc, $page, $reserved){}
47323
47324/**
47325 * Gets the value of some PDFlib parameter with numerical type.
47326 *
47327 * @param resource $p
47328 * @param string $key
47329 * @param float $modifier
47330 * @return float
47331 * @since PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0
47332 **/
47333function PDF_get_value($p, $key, $modifier){}
47334
47335/**
47336 * Queries detailed information about a loaded font.
47337 *
47338 * @param resource $pdfdoc
47339 * @param int $font
47340 * @param string $keyword
47341 * @param string $optlist
47342 * @return float
47343 * @since PECL pdflib >= 2.1.0
47344 **/
47345function PDF_info_font($pdfdoc, $font, $keyword, $optlist){}
47346
47347/**
47348 * Queries information about a matchbox on the current page.
47349 *
47350 * @param resource $pdfdoc
47351 * @param string $boxname
47352 * @param int $num
47353 * @param string $keyword
47354 * @return float
47355 * @since PECL pdflib >= 2.1.0
47356 **/
47357function PDF_info_matchbox($pdfdoc, $boxname, $num, $keyword){}
47358
47359/**
47360 * Retrieves table information related to the most recently placed table
47361 * instance.
47362 *
47363 * @param resource $pdfdoc
47364 * @param int $table
47365 * @param string $keyword
47366 * @return float
47367 * @since PECL pdflib >= 2.1.0
47368 **/
47369function PDF_info_table($pdfdoc, $table, $keyword){}
47370
47371/**
47372 * Queries the current state of a textflow.
47373 *
47374 * @param resource $pdfdoc
47375 * @param int $textflow
47376 * @param string $keyword
47377 * @return float
47378 * @since PECL pdflib >= 2.0.0
47379 **/
47380function PDF_info_textflow($pdfdoc, $textflow, $keyword){}
47381
47382/**
47383 * Performs textline formatting and queries the resulting metrics.
47384 *
47385 * @param resource $pdfdoc
47386 * @param string $text
47387 * @param string $keyword
47388 * @param string $optlist
47389 * @return float
47390 * @since PECL pdflib >= 2.1.0
47391 **/
47392function PDF_info_textline($pdfdoc, $text, $keyword, $optlist){}
47393
47394/**
47395 * Reset all color and graphics state parameters to their defaults.
47396 *
47397 * @param resource $p
47398 * @return bool
47399 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47400 **/
47401function PDF_initgraphics($p){}
47402
47403/**
47404 * Draws a line from the current point to another point.
47405 *
47406 * @param resource $p
47407 * @param float $x
47408 * @param float $y
47409 * @return bool
47410 * @since PHP 4, PECL pdflib >= 1.0.0
47411 **/
47412function PDF_lineto($p, $x, $y){}
47413
47414/**
47415 * Loads a 3D model from a disk-based or virtual file.
47416 *
47417 * This function requires PDF 1.6.
47418 *
47419 * @param resource $pdfdoc
47420 * @param string $filename
47421 * @param string $optlist
47422 * @return int
47423 * @since PECL pdflib >= 2.1.0
47424 **/
47425function PDF_load_3ddata($pdfdoc, $filename, $optlist){}
47426
47427/**
47428 * Searches for a font and prepares it for later use.
47429 *
47430 * @param resource $pdfdoc
47431 * @param string $fontname
47432 * @param string $encoding
47433 * @param string $optlist
47434 * @return int
47435 * @since PECL pdflib >= 2.0.0
47436 **/
47437function PDF_load_font($pdfdoc, $fontname, $encoding, $optlist){}
47438
47439/**
47440 * Searches for an ICC profile, and prepares it for later use.
47441 *
47442 * @param resource $pdfdoc
47443 * @param string $profilename
47444 * @param string $optlist
47445 * @return int
47446 * @since PECL pdflib >= 2.0.0
47447 **/
47448function PDF_load_iccprofile($pdfdoc, $profilename, $optlist){}
47449
47450/**
47451 * Opens a disk-based or virtual image file subject to various options.
47452 *
47453 * @param resource $pdfdoc
47454 * @param string $imagetype
47455 * @param string $filename
47456 * @param string $optlist
47457 * @return int
47458 * @since PECL pdflib >= 2.0.0
47459 **/
47460function PDF_load_image($pdfdoc, $imagetype, $filename, $optlist){}
47461
47462/**
47463 * Finds a built-in spot color name, or makes a named spot color from the
47464 * current fill color.
47465 *
47466 * @param resource $p
47467 * @param string $spotname
47468 * @return int
47469 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47470 **/
47471function PDF_makespotcolor($p, $spotname){}
47472
47473/**
47474 * Sets the current point for graphics output.
47475 *
47476 * @param resource $p
47477 * @param float $x
47478 * @param float $y
47479 * @return bool
47480 * @since PHP 4, PECL pdflib >= 1.0.0
47481 **/
47482function PDF_moveto($p, $x, $y){}
47483
47484/**
47485 * Creates a new PDFlib object with default settings.
47486 *
47487 * @return resource
47488 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47489 **/
47490function PDF_new(){}
47491
47492/**
47493 * Opens a raw CCITT image.
47494 *
47495 * This function is deprecated since PDFlib version 5, use {@link
47496 * PDF_load_image} instead.
47497 *
47498 * @param resource $pdfdoc
47499 * @param string $filename
47500 * @param int $width
47501 * @param int $height
47502 * @param int $BitReverse
47503 * @param int $k
47504 * @param int $Blackls1
47505 * @return int
47506 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47507 **/
47508function PDF_open_ccitt($pdfdoc, $filename, $width, $height, $BitReverse, $k, $Blackls1){}
47509
47510/**
47511 * Creates a new PDF file using the supplied file name.
47512 *
47513 * This function is deprecated since PDFlib version 6, use {@link
47514 * PDF_begin_document} instead.
47515 *
47516 * @param resource $p
47517 * @param string $filename
47518 * @return bool
47519 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47520 **/
47521function PDF_open_file($p, $filename){}
47522
47523/**
47524 * Uses image data from a variety of data sources.
47525 *
47526 * This function is deprecated since PDFlib version 5, use virtual files
47527 * and {@link PDF_load_image} instead.
47528 *
47529 * @param resource $p
47530 * @param string $imagetype
47531 * @param string $source
47532 * @param string $data
47533 * @param int $length
47534 * @param int $width
47535 * @param int $height
47536 * @param int $components
47537 * @param int $bpc
47538 * @param string $params
47539 * @return int
47540 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47541 **/
47542function PDF_open_image($p, $imagetype, $source, $data, $length, $width, $height, $components, $bpc, $params){}
47543
47544/**
47545 * Opens an image file.
47546 *
47547 * This function is deprecated since PDFlib version 5, use {@link
47548 * PDF_load_image} with the colorize, ignoremask, invert, mask, masked,
47549 * and page options instead.
47550 *
47551 * @param resource $p
47552 * @param string $imagetype
47553 * @param string $filename
47554 * @param string $stringparam
47555 * @param int $intparam
47556 * @return int
47557 * @since PHP 4, PECL pdflib >= 1.0.0
47558 **/
47559function PDF_open_image_file($p, $imagetype, $filename, $stringparam, $intparam){}
47560
47561/**
47562 * This function is not supported by PDFlib GmbH.
47563 *
47564 * @param resource $p
47565 * @param resource $image
47566 * @return int
47567 * @since PHP 4, PECL pdflib >= 1.0.0
47568 **/
47569function PDF_open_memory_image($p, $image){}
47570
47571/**
47572 * Opens a disk-based or virtual PDF document and prepares it for later
47573 * use.
47574 *
47575 * This function is deprecated since PDFlib version 7, use {@link
47576 * PDF_open_pdi_document} instead.
47577 *
47578 * @param resource $pdfdoc
47579 * @param string $filename
47580 * @param string $optlist
47581 * @param int $len
47582 * @return int
47583 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47584 **/
47585function PDF_open_pdi($pdfdoc, $filename, $optlist, $len){}
47586
47587/**
47588 * Prepares a page for later use with {@link PDF_fit_pdi_page}.
47589 *
47590 * @param resource $p
47591 * @param int $doc
47592 * @param int $pagenumber
47593 * @param string $optlist
47594 * @return int
47595 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47596 **/
47597function PDF_open_pdi_page($p, $doc, $pagenumber, $optlist){}
47598
47599/**
47600 * Gets the value of a pCOS path with type number or boolean.
47601 *
47602 * @param resource $p
47603 * @param int $doc
47604 * @param string $path
47605 * @return float
47606 * @since PECL pdflib >= 2.1.0
47607 **/
47608function PDF_pcos_get_number($p, $doc, $path){}
47609
47610/**
47611 * Gets the contents of a pCOS path with type stream, fstream, or string.
47612 *
47613 * @param resource $p
47614 * @param int $doc
47615 * @param string $optlist
47616 * @param string $path
47617 * @return string
47618 * @since PECL pdflib >= 2.1.0
47619 **/
47620function PDF_pcos_get_stream($p, $doc, $optlist, $path){}
47621
47622/**
47623 * Gets the value of a pCOS path with type name, string, or boolean.
47624 *
47625 * @param resource $p
47626 * @param int $doc
47627 * @param string $path
47628 * @return string
47629 * @since PECL pdflib >= 2.1.0
47630 **/
47631function PDF_pcos_get_string($p, $doc, $path){}
47632
47633/**
47634 * Places an image and scales it.
47635 *
47636 * This function is deprecated since PDFlib version 5, use {@link
47637 * PDF_fit_image} instead.
47638 *
47639 * @param resource $pdfdoc
47640 * @param int $image
47641 * @param float $x
47642 * @param float $y
47643 * @param float $scale
47644 * @return bool
47645 * @since PHP 4, PECL pdflib >= 1.0.0
47646 **/
47647function PDF_place_image($pdfdoc, $image, $x, $y, $scale){}
47648
47649/**
47650 * Places a PDF page and scales it.
47651 *
47652 * This function is deprecated since PDFlib version 5, use {@link
47653 * PDF_fit_pdi_page} instead.
47654 *
47655 * @param resource $pdfdoc
47656 * @param int $page
47657 * @param float $x
47658 * @param float $y
47659 * @param float $sx
47660 * @param float $sy
47661 * @return bool
47662 * @since PHP 4 >= 4.0.6, PECL pdflib >= 1.0.0
47663 **/
47664function PDF_place_pdi_page($pdfdoc, $page, $x, $y, $sx, $sy){}
47665
47666/**
47667 * Processes certain elements of an imported PDF document.
47668 *
47669 * @param resource $pdfdoc
47670 * @param int $doc
47671 * @param int $page
47672 * @param string $optlist
47673 * @return int
47674 * @since PECL pdflib >= 2.0.0
47675 **/
47676function PDF_process_pdi($pdfdoc, $doc, $page, $optlist){}
47677
47678/**
47679 * Draws a rectangle.
47680 *
47681 * @param resource $p
47682 * @param float $x
47683 * @param float $y
47684 * @param float $width
47685 * @param float $height
47686 * @return bool
47687 * @since PHP 4, PECL pdflib >= 1.0.0
47688 **/
47689function PDF_rect($p, $x, $y, $width, $height){}
47690
47691/**
47692 * Restores the most recently saved graphics state.
47693 *
47694 * @param resource $p
47695 * @return bool
47696 * @since PHP 4, PECL pdflib >= 1.0.0
47697 **/
47698function PDF_restore($p){}
47699
47700/**
47701 * Resumes a page to add more content to it.
47702 *
47703 * @param resource $pdfdoc
47704 * @param string $optlist
47705 * @return bool
47706 * @since PECL pdflib >= 2.0.0
47707 **/
47708function PDF_resume_page($pdfdoc, $optlist){}
47709
47710/**
47711 * Rotates the coordinate system.
47712 *
47713 * @param resource $p
47714 * @param float $phi
47715 * @return bool
47716 * @since PHP 4, PECL pdflib >= 1.0.0
47717 **/
47718function PDF_rotate($p, $phi){}
47719
47720/**
47721 * Saves the current graphics state.
47722 *
47723 * @param resource $p
47724 * @return bool
47725 * @since PHP 4, PECL pdflib >= 1.0.0
47726 **/
47727function PDF_save($p){}
47728
47729/**
47730 * Scales the coordinate system.
47731 *
47732 * @param resource $p
47733 * @param float $sx
47734 * @param float $sy
47735 * @return bool
47736 * @since PHP 4, PECL pdflib >= 1.0.0
47737 **/
47738function PDF_scale($p, $sx, $sy){}
47739
47740/**
47741 * Sets the current color space and color.
47742 *
47743 * @param resource $p
47744 * @param string $fstype
47745 * @param string $colorspace
47746 * @param float $c1
47747 * @param float $c2
47748 * @param float $c3
47749 * @param float $c4
47750 * @return bool
47751 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47752 **/
47753function PDF_setcolor($p, $fstype, $colorspace, $c1, $c2, $c3, $c4){}
47754
47755/**
47756 * Sets the current dash pattern to {@link b} black and {@link w} white
47757 * units.
47758 *
47759 * @param resource $pdfdoc
47760 * @param float $b
47761 * @param float $w
47762 * @return bool
47763 * @since PHP 4, PECL pdflib >= 1.0.0
47764 **/
47765function PDF_setdash($pdfdoc, $b, $w){}
47766
47767/**
47768 * Sets a dash pattern defined by an option list.
47769 *
47770 * @param resource $pdfdoc
47771 * @param string $optlist
47772 * @return bool
47773 * @since PECL pdflib >= 2.0.0
47774 **/
47775function PDF_setdashpattern($pdfdoc, $optlist){}
47776
47777/**
47778 * Sets the flatness parameter.
47779 *
47780 * @param resource $pdfdoc
47781 * @param float $flatness
47782 * @return bool
47783 * @since PHP 4, PECL pdflib >= 1.0.0
47784 **/
47785function PDF_setflat($pdfdoc, $flatness){}
47786
47787/**
47788 * Sets the current font in the specified {@link size}, using a {@link
47789 * font} handle returned by {@link PDF_load_font}.
47790 *
47791 * @param resource $pdfdoc
47792 * @param int $font
47793 * @param float $fontsize
47794 * @return bool
47795 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47796 **/
47797function PDF_setfont($pdfdoc, $font, $fontsize){}
47798
47799/**
47800 * Sets the current fill and stroke color to a gray value between 0 and 1
47801 * inclusive.
47802 *
47803 * This function is deprecated since PDFlib version 4, use {@link
47804 * PDF_setcolor} instead.
47805 *
47806 * @param resource $p
47807 * @param float $g
47808 * @return bool
47809 * @since PHP 4, PECL pdflib >= 1.0.0
47810 **/
47811function PDF_setgray($p, $g){}
47812
47813/**
47814 * Sets the current fill color to a gray value between 0 and 1 inclusive.
47815 *
47816 * This function is deprecated since PDFlib version 4, use {@link
47817 * PDF_setcolor} instead.
47818 *
47819 * @param resource $p
47820 * @param float $g
47821 * @return bool
47822 * @since PHP 4, PECL pdflib >= 1.0.0
47823 **/
47824function PDF_setgray_fill($p, $g){}
47825
47826/**
47827 * Sets the current stroke color to a gray value between 0 and 1
47828 * inclusive.
47829 *
47830 * This function is deprecated since PDFlib version 4, use {@link
47831 * PDF_setcolor} instead.
47832 *
47833 * @param resource $p
47834 * @param float $g
47835 * @return bool
47836 * @since PHP 4, PECL pdflib >= 1.0.0
47837 **/
47838function PDF_setgray_stroke($p, $g){}
47839
47840/**
47841 * Sets the {@link linecap} parameter to control the shape at the end of
47842 * a path with respect to stroking.
47843 *
47844 * @param resource $p
47845 * @param int $linecap
47846 * @return bool
47847 * @since PHP 4, PECL pdflib >= 1.0.0
47848 **/
47849function PDF_setlinecap($p, $linecap){}
47850
47851/**
47852 * Sets the {@link linejoin} parameter to specify the shape at the
47853 * corners of paths that are stroked.
47854 *
47855 * @param resource $p
47856 * @param int $value
47857 * @return bool
47858 * @since PHP 4, PECL pdflib >= 1.0.0
47859 **/
47860function PDF_setlinejoin($p, $value){}
47861
47862/**
47863 * Sets the current line width.
47864 *
47865 * @param resource $p
47866 * @param float $width
47867 * @return bool
47868 * @since PHP 4, PECL pdflib >= 1.0.0
47869 **/
47870function PDF_setlinewidth($p, $width){}
47871
47872/**
47873 * Explicitly sets the current transformation matrix.
47874 *
47875 * @param resource $p
47876 * @param float $a
47877 * @param float $b
47878 * @param float $c
47879 * @param float $d
47880 * @param float $e
47881 * @param float $f
47882 * @return bool
47883 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
47884 **/
47885function PDF_setmatrix($p, $a, $b, $c, $d, $e, $f){}
47886
47887/**
47888 * Sets the miter limit.
47889 *
47890 * @param resource $pdfdoc
47891 * @param float $miter
47892 * @return bool
47893 * @since PHP 4, PECL pdflib >= 1.0.0
47894 **/
47895function PDF_setmiterlimit($pdfdoc, $miter){}
47896
47897/**
47898 * Sets the current fill and stroke color to the supplied RGB values.
47899 *
47900 * This function is deprecated since PDFlib version 4, use {@link
47901 * PDF_setcolor} instead.
47902 *
47903 * @param resource $p
47904 * @param float $red
47905 * @param float $green
47906 * @param float $blue
47907 * @return bool
47908 * @since PHP 4, PECL pdflib >= 1.0.0
47909 **/
47910function PDF_setrgbcolor($p, $red, $green, $blue){}
47911
47912/**
47913 * Sets the current fill color to the supplied RGB values.
47914 *
47915 * This function is deprecated since PDFlib version 4, use {@link
47916 * PDF_setcolor} instead.
47917 *
47918 * @param resource $p
47919 * @param float $red
47920 * @param float $green
47921 * @param float $blue
47922 * @return bool
47923 * @since PHP 4, PECL pdflib >= 1.0.0
47924 **/
47925function PDF_setrgbcolor_fill($p, $red, $green, $blue){}
47926
47927/**
47928 * Sets the current stroke color to the supplied RGB values.
47929 *
47930 * This function is deprecated since PDFlib version 4, use {@link
47931 * PDF_setcolor} instead.
47932 *
47933 * @param resource $p
47934 * @param float $red
47935 * @param float $green
47936 * @param float $blue
47937 * @return bool
47938 * @since PHP 4, PECL pdflib >= 1.0.0
47939 **/
47940function PDF_setrgbcolor_stroke($p, $red, $green, $blue){}
47941
47942/**
47943 * Sets the border color for all kinds of annotations.
47944 *
47945 * This function is deprecated since PDFlib version 6, use the option
47946 * {@link annotcolor} in {@link PDF_create_annotation} instead.
47947 *
47948 * @param resource $p
47949 * @param float $red
47950 * @param float $green
47951 * @param float $blue
47952 * @return bool
47953 * @since PHP 4, PECL pdflib >= 1.0.0
47954 **/
47955function PDF_set_border_color($p, $red, $green, $blue){}
47956
47957/**
47958 * Sets the border dash style for all kinds of annotations.
47959 *
47960 * This function is deprecated since PDFlib version 6, use the option
47961 * {@link dasharray} in {@link PDF_create_annotation} instead.
47962 *
47963 * @param resource $pdfdoc
47964 * @param float $black
47965 * @param float $white
47966 * @return bool
47967 * @since PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0
47968 **/
47969function PDF_set_border_dash($pdfdoc, $black, $white){}
47970
47971/**
47972 * Sets the border style for all kinds of annotations.
47973 *
47974 * This function is deprecated since PDFlib version 6, use the options
47975 * {@link borderstyle} and {@link linewidth} in {@link
47976 * PDF_create_annotation} instead.
47977 *
47978 * @param resource $pdfdoc
47979 * @param string $style
47980 * @param float $width
47981 * @return bool
47982 * @since PHP 4, PECL pdflib >= 1.0.0
47983 **/
47984function PDF_set_border_style($pdfdoc, $style, $width){}
47985
47986/**
47987 * Activates a graphics state object.
47988 *
47989 * @param resource $pdfdoc
47990 * @param int $gstate
47991 * @return bool
47992 * @since PECL pdflib >= 2.0.0
47993 **/
47994function PDF_set_gstate($pdfdoc, $gstate){}
47995
47996/**
47997 * Fill document information field {@link key} with {@link value}.
47998 *
47999 * @param resource $p
48000 * @param string $key
48001 * @param string $value
48002 * @return bool
48003 * @since PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0
48004 **/
48005function PDF_set_info($p, $key, $value){}
48006
48007/**
48008 * Defines hierarchical and group relationships among layers.
48009 *
48010 * This function requires PDF 1.5.
48011 *
48012 * @param resource $pdfdoc
48013 * @param string $type
48014 * @param string $optlist
48015 * @return bool
48016 * @since PECL pdflib >= 2.0.0
48017 **/
48018function PDF_set_layer_dependency($pdfdoc, $type, $optlist){}
48019
48020/**
48021 * Sets some PDFlib parameter with string type.
48022 *
48023 * @param resource $p
48024 * @param string $key
48025 * @param string $value
48026 * @return bool
48027 * @since PHP 4, PECL pdflib >= 1.0.0
48028 **/
48029function PDF_set_parameter($p, $key, $value){}
48030
48031/**
48032 * Sets the position for text output on the page.
48033 *
48034 * @param resource $p
48035 * @param float $x
48036 * @param float $y
48037 * @return bool
48038 * @since PHP 4, PECL pdflib >= 1.0.0
48039 **/
48040function PDF_set_text_pos($p, $x, $y){}
48041
48042/**
48043 * Sets the value of some PDFlib parameter with numerical type.
48044 *
48045 * @param resource $p
48046 * @param string $key
48047 * @param float $value
48048 * @return bool
48049 * @since PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0
48050 **/
48051function PDF_set_value($p, $key, $value){}
48052
48053/**
48054 * Defines a blend from the current fill color to another color.
48055 *
48056 * This function requires PDF 1.4 or above.
48057 *
48058 * @param resource $pdfdoc
48059 * @param string $shtype
48060 * @param float $x0
48061 * @param float $y0
48062 * @param float $x1
48063 * @param float $y1
48064 * @param float $c1
48065 * @param float $c2
48066 * @param float $c3
48067 * @param float $c4
48068 * @param string $optlist
48069 * @return int
48070 * @since PECL pdflib >= 2.0.0
48071 **/
48072function PDF_shading($pdfdoc, $shtype, $x0, $y0, $x1, $y1, $c1, $c2, $c3, $c4, $optlist){}
48073
48074/**
48075 * Defines a shading pattern using a shading object.
48076 *
48077 * This function requires PDF 1.4 or above.
48078 *
48079 * @param resource $pdfdoc
48080 * @param int $shading
48081 * @param string $optlist
48082 * @return int
48083 * @since PECL pdflib >= 2.0.0
48084 **/
48085function PDF_shading_pattern($pdfdoc, $shading, $optlist){}
48086
48087/**
48088 * Fills an area with a shading, based on a shading object.
48089 *
48090 * This function requires PDF 1.4 or above.
48091 *
48092 * @param resource $pdfdoc
48093 * @param int $shading
48094 * @return bool
48095 * @since PECL pdflib >= 2.0.0
48096 **/
48097function PDF_shfill($pdfdoc, $shading){}
48098
48099/**
48100 * Prints {@link text} in the current font and size at the current
48101 * position.
48102 *
48103 * @param resource $pdfdoc
48104 * @param string $text
48105 * @return bool
48106 * @since PHP 4, PECL pdflib >= 1.0.0
48107 **/
48108function PDF_show($pdfdoc, $text){}
48109
48110/**
48111 * This function is deprecated since PDFlib version 6, use {@link
48112 * PDF_fit_textline} for single lines, or the {@link PDF_*_textflow}
48113 * functions for multi-line formatting instead.
48114 *
48115 * @param resource $p
48116 * @param string $text
48117 * @param float $left
48118 * @param float $top
48119 * @param float $width
48120 * @param float $height
48121 * @param string $mode
48122 * @param string $feature
48123 * @return int
48124 * @since PHP 4, PECL pdflib >= 1.0.0
48125 **/
48126function PDF_show_boxed($p, $text, $left, $top, $width, $height, $mode, $feature){}
48127
48128/**
48129 * Prints {@link text} in the current font.
48130 *
48131 * @param resource $p
48132 * @param string $text
48133 * @param float $x
48134 * @param float $y
48135 * @return bool
48136 * @since PHP 4, PECL pdflib >= 1.0.0
48137 **/
48138function PDF_show_xy($p, $text, $x, $y){}
48139
48140/**
48141 * Skews the coordinate system in x and y direction by {@link alpha} and
48142 * {@link beta} degrees.
48143 *
48144 * @param resource $p
48145 * @param float $alpha
48146 * @param float $beta
48147 * @return bool
48148 * @since PHP 4, PECL pdflib >= 1.0.0
48149 **/
48150function PDF_skew($p, $alpha, $beta){}
48151
48152/**
48153 * Returns the width of {@link text} in an arbitrary font.
48154 *
48155 * @param resource $p
48156 * @param string $text
48157 * @param int $font
48158 * @param float $fontsize
48159 * @return float
48160 * @since PHP 4, PECL pdflib >= 1.0.0
48161 **/
48162function PDF_stringwidth($p, $text, $font, $fontsize){}
48163
48164/**
48165 * Strokes the path with the current color and line width, and clear it.
48166 *
48167 * @param resource $p
48168 * @return bool
48169 * @since PHP 4, PECL pdflib >= 1.0.0
48170 **/
48171function PDF_stroke($p){}
48172
48173/**
48174 * Suspends the current page so that it can later be resumed with {@link
48175 * PDF_resume_page}.
48176 *
48177 * @param resource $pdfdoc
48178 * @param string $optlist
48179 * @return bool
48180 * @since PECL pdflib >= 2.0.0
48181 **/
48182function PDF_suspend_page($pdfdoc, $optlist){}
48183
48184/**
48185 * Translates the origin of the coordinate system.
48186 *
48187 * @param resource $p
48188 * @param float $tx
48189 * @param float $ty
48190 * @return bool
48191 * @since PHP 4, PECL pdflib >= 1.0.0
48192 **/
48193function PDF_translate($p, $tx, $ty){}
48194
48195/**
48196 * Converts a string from UTF-8 format to UTF-16.
48197 *
48198 * @param resource $pdfdoc
48199 * @param string $utf8string
48200 * @param string $ordering
48201 * @return string
48202 * @since PECL pdflib >= 2.0.3
48203 **/
48204function PDF_utf8_to_utf16($pdfdoc, $utf8string, $ordering){}
48205
48206/**
48207 * Converts a string from UTF-16 format to UTF-8.
48208 *
48209 * @param resource $pdfdoc
48210 * @param string $utf16string
48211 * @return string
48212 * @since PECL pdflib >= 2.0.3
48213 **/
48214function PDF_utf16_to_utf8($pdfdoc, $utf16string){}
48215
48216/**
48217 * Converts a string from UTF-32 format to UTF-16.
48218 *
48219 * @param resource $pdfdoc
48220 * @param string $utf32string
48221 * @param string $ordering
48222 * @return string
48223 * @since PECL pdflib >= Unknown future
48224 **/
48225function PDF_utf32_to_utf16($pdfdoc, $utf32string, $ordering){}
48226
48227/**
48228 * This function returns all currently available PDO drivers which can be
48229 * used in {@link DSN} parameter of {@link PDO::__construct}. This is a
48230 * static method.
48231 *
48232 * @return array
48233 * @since PHP 5.1.0 - 5.1.3, PECL pdo >= 0.9.0
48234 **/
48235function pdo_drivers(){}
48236
48237/**
48238 * This function behaves exactly as {@link fsockopen} with the difference
48239 * that the connection is not closed after the script finishes. It is the
48240 * persistent version of {@link fsockopen}.
48241 *
48242 * @param string $hostname
48243 * @param int $port
48244 * @param int $errno
48245 * @param string $errstr
48246 * @param float $timeout
48247 * @return resource
48248 * @since PHP 4, PHP 5
48249 **/
48250function pfsockopen($hostname, $port, &$errno, &$errstr, $timeout){}
48251
48252/**
48253 * {@link pg_affected_rows} returns the number of tuples
48254 * (instances/records/rows) affected by INSERT, UPDATE, and DELETE
48255 * queries.
48256 *
48257 * @param resource $result PostgreSQL query result resource, returned
48258 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48259 *   (among others).
48260 * @return int
48261 * @since PHP 4 >= 4.2.0, PHP 5
48262 **/
48263function pg_affected_rows($result){}
48264
48265/**
48266 * {@link pg_cancel_query} cancels an asynchronous query sent with {@link
48267 * pg_send_query}, {@link pg_send_query_params} or {@link
48268 * pg_send_execute}. You cannot cancel a query executed using {@link
48269 * pg_query}.
48270 *
48271 * @param resource $connection PostgreSQL database connection resource.
48272 * @return bool
48273 * @since PHP 4 >= 4.2.0, PHP 5
48274 **/
48275function pg_cancel_query($connection){}
48276
48277/**
48278 * PostgreSQL supports automatic character set conversion between server
48279 * and client for certain character sets. {@link pg_client_encoding}
48280 * returns the client encoding as a string. The returned string will be
48281 * one of the standard PostgreSQL encoding identifiers.
48282 *
48283 * @param resource $connection PostgreSQL database connection resource.
48284 *   When {@link connection} is not present, the default connection is
48285 *   used. The default connection is the last connection made by {@link
48286 *   pg_connect} or {@link pg_pconnect}.
48287 * @return string
48288 * @since PHP 4 >= 4.0.3, PHP 5
48289 **/
48290function pg_client_encoding($connection){}
48291
48292/**
48293 * {@link pg_close} closes the non-persistent connection to a PostgreSQL
48294 * database associated with the given {@link connection} resource.
48295 *
48296 * If there is open large object resource on the connection, do not close
48297 * the connection before closing all large object resources.
48298 *
48299 * @param resource $connection PostgreSQL database connection resource.
48300 *   When {@link connection} is not present, the default connection is
48301 *   used. The default connection is the last connection made by {@link
48302 *   pg_connect} or {@link pg_pconnect}.
48303 * @return bool
48304 * @since PHP 4, PHP 5
48305 **/
48306function pg_close($connection){}
48307
48308/**
48309 * {@link pg_connect} opens a connection to a PostgreSQL database
48310 * specified by the {@link connection_string}.
48311 *
48312 * If a second call is made to {@link pg_connect} with the same {@link
48313 * connection_string} as an existing connection, the existing connection
48314 * will be returned unless you pass PGSQL_CONNECT_FORCE_NEW as {@link
48315 * connect_type}.
48316 *
48317 * The old syntax with multiple parameters $conn = pg_connect("host",
48318 * "port", "options", "tty", "dbname") has been deprecated.
48319 *
48320 * @param string $connection_string The {@link connection_string} can
48321 *   be empty to use all default parameters, or it can contain one or
48322 *   more parameter settings separated by whitespace. Each parameter
48323 *   setting is in the form keyword = value. Spaces around the equal sign
48324 *   are optional. To write an empty value or a value containing spaces,
48325 *   surround it with single quotes, e.g., keyword = 'a value'. Single
48326 *   quotes and backslashes within the value must be escaped with a
48327 *   backslash, i.e., \' and \\. The currently recognized parameter
48328 *   keywords are: {@link host}, {@link hostaddr}, {@link port}, {@link
48329 *   dbname}, {@link user}, {@link password}, {@link connect_timeout},
48330 *   {@link options}, {@link tty} (ignored), {@link sslmode}, {@link
48331 *   requiressl} (deprecated in favor of {@link sslmode}), and {@link
48332 *   service}. Which of these arguments exist depends on your PostgreSQL
48333 *   version.
48334 * @param int $connect_type If PGSQL_CONNECT_FORCE_NEW is passed, then
48335 *   a new connection is created, even if the {@link connection_string}
48336 *   is identical to an existing connection.
48337 * @return resource
48338 * @since PHP 4, PHP 5
48339 **/
48340function pg_connect($connection_string, $connect_type){}
48341
48342/**
48343 * {@link pg_connection_busy} determines whether or not a connection is
48344 * busy. If it is busy, a previous query is still executing. If {@link
48345 * pg_get_result} is used on the connection, it will be blocked.
48346 *
48347 * @param resource $connection PostgreSQL database connection resource.
48348 * @return bool
48349 * @since PHP 4 >= 4.2.0, PHP 5
48350 **/
48351function pg_connection_busy($connection){}
48352
48353/**
48354 * {@link pg_connection_reset} resets the connection. It is useful for
48355 * error recovery.
48356 *
48357 * @param resource $connection PostgreSQL database connection resource.
48358 * @return bool
48359 * @since PHP 4 >= 4.2.0, PHP 5
48360 **/
48361function pg_connection_reset($connection){}
48362
48363/**
48364 * {@link pg_connection_status} returns the status of the specified
48365 * {@link connection}.
48366 *
48367 * @param resource $connection PostgreSQL database connection resource.
48368 * @return int
48369 * @since PHP 4 >= 4.2.0, PHP 5
48370 **/
48371function pg_connection_status($connection){}
48372
48373/**
48374 * {@link pg_convert} checks and converts the values in {@link
48375 * assoc_array} into suitable values for use in an SQL statement.
48376 * Precondition for {@link pg_convert} is the existence of a table {@link
48377 * table_name} which has at least as many columns as {@link assoc_array}
48378 * has elements. The fieldnames in {@link table_name} must match the
48379 * indices in {@link assoc_array} and the corresponding datatypes must be
48380 * compatible. Returns an array with the converted values on success,
48381 * otherwise.
48382 *
48383 * @param resource $connection PostgreSQL database connection resource.
48384 * @param string $table_name Name of the table against which to convert
48385 *   types.
48386 * @param array $assoc_array Data to be converted.
48387 * @param int $options Any number of PGSQL_CONV_IGNORE_DEFAULT,
48388 *   PGSQL_CONV_FORCE_NULL or PGSQL_CONV_IGNORE_NOT_NULL, combined.
48389 * @return array
48390 * @since PHP 4 >= 4.3.0, PHP 5
48391 **/
48392function pg_convert($connection, $table_name, $assoc_array, $options){}
48393
48394/**
48395 * {@link pg_copy_from} inserts records into a table from {@link rows}.
48396 * It issues a COPY FROM SQL command internally to insert records.
48397 *
48398 * @param resource $connection PostgreSQL database connection resource.
48399 * @param string $table_name Name of the table into which to copy the
48400 *   {@link rows}.
48401 * @param array $rows An array of data to be copied into {@link
48402 *   table_name}. Each value in {@link rows} becomes a row in {@link
48403 *   table_name}. Each value in {@link rows} should be a delimited string
48404 *   of the values to insert into each field. Values should be linefeed
48405 *   terminated.
48406 * @param string $delimiter The token that separates values for each
48407 *   field in each element of {@link rows}. Default is TAB.
48408 * @param string $null_as How SQL NULL values are represented in the
48409 *   {@link rows}. Default is \N ("\\N").
48410 * @return bool
48411 * @since PHP 4 >= 4.2.0, PHP 5
48412 **/
48413function pg_copy_from($connection, $table_name, $rows, $delimiter, $null_as){}
48414
48415/**
48416 * {@link pg_copy_to} copies a table to an array. It issues COPY TO SQL
48417 * command internally to retrieve records.
48418 *
48419 * @param resource $connection PostgreSQL database connection resource.
48420 * @param string $table_name Name of the table from which to copy the
48421 *   data into {@link rows}.
48422 * @param string $delimiter The token that separates values for each
48423 *   field in each element of {@link rows}. Default is TAB.
48424 * @param string $null_as How SQL NULL values are represented in the
48425 *   {@link rows}. Default is \N ("\\N").
48426 * @return array
48427 * @since PHP 4 >= 4.2.0, PHP 5
48428 **/
48429function pg_copy_to($connection, $table_name, $delimiter, $null_as){}
48430
48431/**
48432 * {@link pg_dbname} returns the name of the database that the given
48433 * PostgreSQL {@link connection} resource.
48434 *
48435 * @param resource $connection PostgreSQL database connection resource.
48436 *   When {@link connection} is not present, the default connection is
48437 *   used. The default connection is the last connection made by {@link
48438 *   pg_connect} or {@link pg_pconnect}.
48439 * @return string
48440 * @since PHP 4, PHP 5
48441 **/
48442function pg_dbname($connection){}
48443
48444/**
48445 * {@link pg_delete} deletes records from a table specified by the keys
48446 * and values in {@link assoc_array}. If {@link options} is specified,
48447 * {@link pg_convert} is applied to {@link assoc_array} with the
48448 * specified options.
48449 *
48450 * @param resource $connection PostgreSQL database connection resource.
48451 * @param string $table_name Name of the table from which to delete
48452 *   rows.
48453 * @param array $assoc_array An array whose keys are field names in the
48454 *   table {@link table_name}, and whose values are the values of those
48455 *   fields that are to be deleted.
48456 * @param int $options Any number of PGSQL_CONV_FORCE_NULL,
48457 *   PGSQL_DML_NO_CONV, PGSQL_DML_EXEC or PGSQL_DML_STRING combined. If
48458 *   PGSQL_DML_STRING is part of the {@link options} then query string is
48459 *   returned.
48460 * @return mixed
48461 * @since PHP 4 >= 4.3.0, PHP 5
48462 **/
48463function pg_delete($connection, $table_name, $assoc_array, $options){}
48464
48465/**
48466 * {@link pg_end_copy} syncs the PostgreSQL frontend (usually a web
48467 * server process) with the PostgreSQL server after doing a copy
48468 * operation performed by {@link pg_put_line}. {@link pg_end_copy} must
48469 * be issued, otherwise the PostgreSQL server may get out of sync with
48470 * the frontend and will report an error.
48471 *
48472 * @param resource $connection PostgreSQL database connection resource.
48473 *   When {@link connection} is not present, the default connection is
48474 *   used. The default connection is the last connection made by {@link
48475 *   pg_connect} or {@link pg_pconnect}.
48476 * @return bool
48477 * @since PHP 4 >= 4.0.3, PHP 5
48478 **/
48479function pg_end_copy($connection){}
48480
48481/**
48482 * {@link pg_escape_bytea} escapes string for bytea datatype. It returns
48483 * escaped string.
48484 *
48485 * @param resource $connection PostgreSQL database connection resource.
48486 *   When {@link connection} is not present, the default connection is
48487 *   used. The default connection is the last connection made by {@link
48488 *   pg_connect} or {@link pg_pconnect}.
48489 * @param string $data A string containing text or binary data to be
48490 *   inserted into a bytea column.
48491 * @return string
48492 * @since PHP 4 >= 4.2.0, PHP 5
48493 **/
48494function pg_escape_bytea($connection, $data){}
48495
48496/**
48497 * {@link pg_escape_string} escapes a string for insertion into the
48498 * database. It returns an escaped string in the PostgreSQL format. Use
48499 * of this function is recommended instead of {@link addslashes}. If the
48500 * type of the column is bytea, {@link pg_escape_bytea} must be used
48501 * instead.
48502 *
48503 * @param resource $connection PostgreSQL database connection resource.
48504 *   When {@link connection} is not present, the default connection is
48505 *   used. The default connection is the last connection made by {@link
48506 *   pg_connect} or {@link pg_pconnect}.
48507 * @param string $data A string containing text to be escaped.
48508 * @return string
48509 * @since PHP 4 >= 4.2.0, PHP 5
48510 **/
48511function pg_escape_string($connection, $data){}
48512
48513/**
48514 * Sends a request to execute a prepared statement with given parameters,
48515 * and waits for the result.
48516 *
48517 * {@link pg_execute} is like {@link pg_query_params}, but the command to
48518 * be executed is specified by naming a previously-prepared statement,
48519 * instead of giving a query string. This feature allows commands that
48520 * will be used repeatedly to be parsed and planned just once, rather
48521 * than each time they are executed. The statement must have been
48522 * prepared previously in the current session. {@link pg_execute} is
48523 * supported only against PostgreSQL 7.4 or higher connections; it will
48524 * fail when using earlier versions.
48525 *
48526 * The parameters are identical to {@link pg_query_params}, except that
48527 * the name of a prepared statement is given instead of a query string.
48528 *
48529 * @param resource $connection PostgreSQL database connection resource.
48530 *   When {@link connection} is not present, the default connection is
48531 *   used. The default connection is the last connection made by {@link
48532 *   pg_connect} or {@link pg_pconnect}.
48533 * @param string $stmtname The name of the prepared statement to
48534 *   execute. if "" is specified, then the unnamed statement is executed.
48535 *   The name must have been previously prepared using {@link
48536 *   pg_prepare}, {@link pg_send_prepare} or a PREPARE SQL command.
48537 * @param array $params An array of parameter values to substitute for
48538 *   the $1, $2, etc. placeholders in the original prepared query string.
48539 *   The number of elements in the array must match the number of
48540 *   placeholders.
48541 * @return resource
48542 * @since PHP 5 >= 5.1.0
48543 **/
48544function pg_execute($connection, $stmtname, $params){}
48545
48546/**
48547 * {@link pg_fetch_all} returns an array that contains all rows (records)
48548 * in the result resource.
48549 *
48550 * @param resource $result PostgreSQL query result resource, returned
48551 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48552 *   (among others).
48553 * @return array
48554 * @since PHP 4 >= 4.3.0, PHP 5
48555 **/
48556function pg_fetch_all($result){}
48557
48558/**
48559 * {@link pg_fetch_all_columns} returns an array that contains all rows
48560 * (records) in a particular column of the result resource.
48561 *
48562 * @param resource $result PostgreSQL query result resource, returned
48563 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48564 *   (among others).
48565 * @param int $column Column number, zero-based, to be retrieved from
48566 *   the result resource. Defaults to the first column if not specified.
48567 * @return array
48568 * @since PHP 5 >= 5.1.0
48569 **/
48570function pg_fetch_all_columns($result, $column){}
48571
48572/**
48573 * {@link pg_fetch_array} returns an array that corresponds to the
48574 * fetched row (record).
48575 *
48576 * {@link pg_fetch_array} is an extended version of {@link pg_fetch_row}.
48577 * In addition to storing the data in the numeric indices (field number)
48578 * to the result array, it can also store the data using associative
48579 * indices (field name). It stores both indicies by default.
48580 *
48581 * {@link pg_fetch_array} is NOT significantly slower than using {@link
48582 * pg_fetch_row}, and is significantly easier to use.
48583 *
48584 * @param resource $result PostgreSQL query result resource, returned
48585 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48586 *   (among others).
48587 * @param int $row Row number in result to fetch. Rows are numbered
48588 *   from 0 upwards. If omitted, next row is fetched.
48589 * @param int $result_type An optional parameter that controls how the
48590 *   returned array is indexed. {@link result_type} is a constant and can
48591 *   take the following values: PGSQL_ASSOC, PGSQL_NUM and PGSQL_BOTH.
48592 *   Using PGSQL_NUM, {@link pg_fetch_array} will return an array with
48593 *   numerical indices, using PGSQL_ASSOC it will return only associative
48594 *   indices while PGSQL_BOTH, the default, will return both numerical
48595 *   and associative indices.
48596 * @return array
48597 * @since PHP 4, PHP 5
48598 **/
48599function pg_fetch_array($result, $row, $result_type){}
48600
48601/**
48602 * {@link pg_fetch_assoc} returns an associative array that corresponds
48603 * to the fetched row (records).
48604 *
48605 * {@link pg_fetch_assoc} is equivalent to calling {@link pg_fetch_array}
48606 * with PGSQL_ASSOC as the optional third parameter. It only returns an
48607 * associative array. If you need the numeric indices, use {@link
48608 * pg_fetch_row}.
48609 *
48610 * {@link pg_fetch_assoc} is NOT significantly slower than using {@link
48611 * pg_fetch_row}, and is significantly easier to use.
48612 *
48613 * @param resource $result PostgreSQL query result resource, returned
48614 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48615 *   (among others).
48616 * @param int $row Row number in result to fetch. Rows are numbered
48617 *   from 0 upwards. If omitted, next row is fetched.
48618 * @return array
48619 * @since PHP 4 >= 4.3.0, PHP 5
48620 **/
48621function pg_fetch_assoc($result, $row){}
48622
48623/**
48624 * {@link pg_fetch_object} returns an object with properties that
48625 * correspond to the fetched row's field names. It can optionally
48626 * instantiate an object of a specific class, and pass parameters to that
48627 * class's constructor.
48628 *
48629 * Speed-wise, the function is identical to {@link pg_fetch_array}, and
48630 * almost as fast as {@link pg_fetch_row} (the difference is
48631 * insignificant).
48632 *
48633 * @param resource $result PostgreSQL query result resource, returned
48634 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48635 *   (among others).
48636 * @param int $row Row number in result to fetch. Rows are numbered
48637 *   from 0 upwards. If omitted, next row is fetched.
48638 * @param int $result_type Ignored and deprecated.
48639 * @return object
48640 * @since PHP 4, PHP 5
48641 **/
48642function pg_fetch_object($result, $row, $result_type){}
48643
48644/**
48645 * {@link pg_fetch_result} returns the value of a particular row and
48646 * field (column) in a PostgreSQL result resource.
48647 *
48648 * @param resource $result PostgreSQL query result resource, returned
48649 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48650 *   (among others).
48651 * @param int $row Row number in result to fetch. Rows are numbered
48652 *   from 0 upwards. If omitted, next row is fetched.
48653 * @param mixed $field A string representing the name of the field
48654 *   (column) to fetch, otherwise an int representing the field number to
48655 *   fetch. Fields are numbered from 0 upwards.
48656 * @return string
48657 * @since PHP 4 >= 4.2.0, PHP 5
48658 **/
48659function pg_fetch_result($result, $row, $field){}
48660
48661/**
48662 * {@link pg_fetch_row} fetches one row of data from the result
48663 * associated with the specified {@link result} resource.
48664 *
48665 * @param resource $result PostgreSQL query result resource, returned
48666 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48667 *   (among others).
48668 * @param int $row Row number in result to fetch. Rows are numbered
48669 *   from 0 upwards. If omitted, next row is fetched.
48670 * @return array
48671 * @since PHP 4, PHP 5
48672 **/
48673function pg_fetch_row($result, $row){}
48674
48675/**
48676 * {@link pg_field_is_null} tests if a field in a PostgreSQL result
48677 * resource is SQL NULL or not.
48678 *
48679 * @param resource $result PostgreSQL query result resource, returned
48680 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48681 *   (among others).
48682 * @param int $row Row number in result to fetch. Rows are numbered
48683 *   from 0 upwards. If omitted, current row is fetched.
48684 * @param mixed $field Field number (starting from 0) as an integer or
48685 *   the field name as a string.
48686 * @return int
48687 * @since PHP 4 >= 4.2.0, PHP 5
48688 **/
48689function pg_field_is_null($result, $row, $field){}
48690
48691/**
48692 * {@link pg_field_name} returns the name of the field occupying the
48693 * given {@link field_number} in the given PostgreSQL {@link result}
48694 * resource. Field numbering starts from 0.
48695 *
48696 * @param resource $result PostgreSQL query result resource, returned
48697 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48698 *   (among others).
48699 * @param int $field_number Field number, starting from 0.
48700 * @return string
48701 * @since PHP 4 >= 4.2.0, PHP 5
48702 **/
48703function pg_field_name($result, $field_number){}
48704
48705/**
48706 * {@link pg_field_num} will return the number of the field number that
48707 * corresponds to the {@link field_name} in the given PostgreSQL {@link
48708 * result} resource.
48709 *
48710 * @param resource $result PostgreSQL query result resource, returned
48711 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48712 *   (among others).
48713 * @param string $field_name The name of the field.
48714 * @return int
48715 * @since PHP 4 >= 4.2.0, PHP 5
48716 **/
48717function pg_field_num($result, $field_name){}
48718
48719/**
48720 * {@link pg_field_prtlen} returns the actual printed length (number of
48721 * characters) of a specific value in a PostgreSQL {@link result}. Row
48722 * numbering starts at 0. This function will return -1 on an error.
48723 *
48724 * {@link field_name_or_number} can be passed either as an integer or as
48725 * a string. If it is passed as an integer, PHP recognises it as the
48726 * field number, otherwise as field name.
48727 *
48728 * See the example given at the {@link pg_field_name} page.
48729 *
48730 * @param resource $result PostgreSQL query result resource, returned
48731 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48732 *   (among others).
48733 * @param int $row_number Row number in result. Rows are numbered from
48734 *   0 upwards. If omitted, current row is fetched.
48735 * @param mixed $field_name_or_number
48736 * @return int
48737 * @since PHP 4 >= 4.2.0, PHP 5
48738 **/
48739function pg_field_prtlen($result, $row_number, $field_name_or_number){}
48740
48741/**
48742 * {@link pg_field_size} returns the internal storage size (in bytes) of
48743 * the field number in the given PostgreSQL {@link result}.
48744 *
48745 * @param resource $result PostgreSQL query result resource, returned
48746 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48747 *   (among others).
48748 * @param int $field_number Field number, starting from 0.
48749 * @return int
48750 * @since PHP 4 >= 4.2.0, PHP 5
48751 **/
48752function pg_field_size($result, $field_number){}
48753
48754/**
48755 * {@link pg_field_table} returns the name of the table that field
48756 * belongs to, or the table's oid if {@link oid_only} is .
48757 *
48758 * @param resource $result PostgreSQL query result resource, returned
48759 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48760 *   (among others).
48761 * @param int $field_number Field number, starting from 0.
48762 * @param bool $oid_only By default the tables name that field belongs
48763 *   to is returned but if {@link oid_only} is set to , then the oid will
48764 *   instead be returned.
48765 * @return mixed
48766 * @since PHP 5 >= 5.2.0
48767 **/
48768function pg_field_table($result, $field_number, $oid_only){}
48769
48770/**
48771 * {@link pg_field_type} returns a string containing the base type name
48772 * of the given {@link field_number} in the given PostgreSQL {@link
48773 * result} resource.
48774 *
48775 * @param resource $result PostgreSQL query result resource, returned
48776 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48777 *   (among others).
48778 * @param int $field_number Field number, starting from 0.
48779 * @return string
48780 * @since PHP 4 >= 4.2.0, PHP 5
48781 **/
48782function pg_field_type($result, $field_number){}
48783
48784/**
48785 * {@link pg_field_type_oid} returns an integer containing the OID of the
48786 * base type of the given {@link field_number} in the given PostgreSQL
48787 * {@link result} resource.
48788 *
48789 * You can get more information about the field type by querying
48790 * PostgreSQL's pg_type system table using the OID obtained with this
48791 * function. The PostgreSQL {@link format_type} function will convert a
48792 * type OID into an SQL standard type name.
48793 *
48794 * @param resource $result PostgreSQL query result resource, returned
48795 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48796 *   (among others).
48797 * @param int $field_number Field number, starting from 0.
48798 * @return int
48799 * @since PHP 5 >= 5.1.0
48800 **/
48801function pg_field_type_oid($result, $field_number){}
48802
48803/**
48804 * {@link pg_free_result} frees the memory and data associated with the
48805 * specified PostgreSQL query result resource.
48806 *
48807 * This function need only be called if memory consumption during script
48808 * execution is a problem. Otherwise, all result memory will be
48809 * automatically freed when the script ends.
48810 *
48811 * @param resource $result PostgreSQL query result resource, returned
48812 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48813 *   (among others).
48814 * @return bool
48815 * @since PHP 4 >= 4.2.0, PHP 5
48816 **/
48817function pg_free_result($result){}
48818
48819/**
48820 * {@link pg_get_notify} gets notifications generated by a NOTIFY SQL
48821 * command. To receive notifications, the LISTEN SQL command must be
48822 * issued.
48823 *
48824 * @param resource $connection PostgreSQL database connection resource.
48825 * @param int $result_type An optional parameter that controls how the
48826 *   returned array is indexed. {@link result_type} is a constant and can
48827 *   take the following values: PGSQL_ASSOC, PGSQL_NUM and PGSQL_BOTH.
48828 *   Using PGSQL_NUM, {@link pg_get_notify} will return an array with
48829 *   numerical indices, using PGSQL_ASSOC it will return only associative
48830 *   indices while PGSQL_BOTH, the default, will return both numerical
48831 *   and associative indices.
48832 * @return array
48833 * @since PHP 4 >= 4.3.0, PHP 5
48834 **/
48835function pg_get_notify($connection, $result_type){}
48836
48837/**
48838 * {@link pg_get_pid} gets the backend's (database server process) PID.
48839 * The PID is useful to determine whether or not a NOTIFY message
48840 * received via {@link pg_get_notify} is sent from another process or
48841 * not.
48842 *
48843 * @param resource $connection PostgreSQL database connection resource.
48844 * @return int
48845 * @since PHP 4 >= 4.3.0, PHP 5
48846 **/
48847function pg_get_pid($connection){}
48848
48849/**
48850 * {@link pg_get_result} gets the result resource from an asynchronous
48851 * query executed by {@link pg_send_query}, {@link pg_send_query_params}
48852 * or {@link pg_send_execute}.
48853 *
48854 * {@link pg_send_query} and the other asynchronous query functions can
48855 * send multiple queries to a PostgreSQL server and {@link pg_get_result}
48856 * is used to get each query's results, one by one.
48857 *
48858 * @param resource $connection PostgreSQL database connection resource.
48859 * @return resource
48860 * @since PHP 4 >= 4.2.0, PHP 5
48861 **/
48862function pg_get_result($connection){}
48863
48864/**
48865 * {@link pg_host} returns the host name of the given PostgreSQL {@link
48866 * connection} resource is connected to.
48867 *
48868 * @param resource $connection PostgreSQL database connection resource.
48869 *   When {@link connection} is not present, the default connection is
48870 *   used. The default connection is the last connection made by {@link
48871 *   pg_connect} or {@link pg_pconnect}.
48872 * @return string
48873 * @since PHP 4, PHP 5
48874 **/
48875function pg_host($connection){}
48876
48877/**
48878 * {@link pg_insert} inserts the values of {@link assoc_array} into the
48879 * table specified by {@link table_name}. If {@link options} is
48880 * specified, {@link pg_convert} is applied to {@link assoc_array} with
48881 * the specified options.
48882 *
48883 * @param resource $connection PostgreSQL database connection resource.
48884 * @param string $table_name Name of the table into which to insert
48885 *   rows. The table {@link table_name} must at least have as many
48886 *   columns as {@link assoc_array} has elements.
48887 * @param array $assoc_array An array whose keys are field names in the
48888 *   table {@link table_name}, and whose values are the values of those
48889 *   fields that are to be inserted.
48890 * @param int $options Any number of PGSQL_CONV_OPTS,
48891 *   PGSQL_DML_NO_CONV, PGSQL_DML_EXEC, PGSQL_DML_ASYNC or
48892 *   PGSQL_DML_STRING combined. If PGSQL_DML_STRING is part of the {@link
48893 *   options} then query string is returned.
48894 * @return mixed
48895 * @since PHP 4 >= 4.3.0, PHP 5
48896 **/
48897function pg_insert($connection, $table_name, $assoc_array, $options){}
48898
48899/**
48900 * {@link pg_last_error} returns the last error message for a given
48901 * {@link connection}.
48902 *
48903 * Error messages may be overwritten by internal PostgreSQL (libpq)
48904 * function calls. It may not return an appropriate error message if
48905 * multiple errors occur inside a PostgreSQL module function.
48906 *
48907 * Use {@link pg_result_error}, {@link pg_result_error_field}, {@link
48908 * pg_result_status} and {@link pg_connection_status} for better error
48909 * handling.
48910 *
48911 * @param resource $connection PostgreSQL database connection resource.
48912 *   When {@link connection} is not present, the default connection is
48913 *   used. The default connection is the last connection made by {@link
48914 *   pg_connect} or {@link pg_pconnect}.
48915 * @return string
48916 * @since PHP 4 >= 4.2.0, PHP 5
48917 **/
48918function pg_last_error($connection){}
48919
48920/**
48921 * {@link pg_last_notice} returns the last notice message from the
48922 * PostgreSQL server on the specified {@link connection}. The PostgreSQL
48923 * server sends notice messages in several cases, for instance when
48924 * creating a SERIAL column in a table.
48925 *
48926 * With {@link pg_last_notice}, you can avoid issuing useless queries by
48927 * checking whether or not the notice is related to your transaction.
48928 *
48929 * Notice message tracking can be set to optional by setting 1 for
48930 * pgsql.ignore_notice in .
48931 *
48932 * Notice message logging can be set to optional by setting 0 for
48933 * pgsql.log_notice in . Unless pgsql.ignore_notice is set to 0, notice
48934 * message cannot be logged.
48935 *
48936 * @param resource $connection PostgreSQL database connection resource.
48937 * @return string
48938 * @since PHP 4 >= 4.0.6, PHP 5
48939 **/
48940function pg_last_notice($connection){}
48941
48942/**
48943 * {@link pg_last_oid} is used to retrieve the OID assigned to an
48944 * inserted row.
48945 *
48946 * OID field became an optional field from PostgreSQL 7.2 and will not be
48947 * present by default in PostgreSQL 8.1. When the OID field is not
48948 * present in a table, the programmer must use {@link pg_result_status}
48949 * to check for successful insertion.
48950 *
48951 * To get the value of a SERIAL field in an inserted row, it is necessary
48952 * to use the PostgreSQL CURRVAL function, naming the sequence whose last
48953 * value is required. If the name of the sequence is unknown, the
48954 * pg_get_serial_sequence PostgreSQL 8.0 function is necessary.
48955 *
48956 * PostgreSQL 8.1 has a function LASTVAL that returns the value of the
48957 * most recently used sequence in the session. This avoids the need for
48958 * naming the sequence, table or column altogether.
48959 *
48960 * @param resource $result PostgreSQL query result resource, returned
48961 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
48962 *   (among others).
48963 * @return string
48964 * @since PHP 4 >= 4.2.0, PHP 5
48965 **/
48966function pg_last_oid($result){}
48967
48968/**
48969 * {@link pg_lo_close} closes a large object. {@link large_object} is a
48970 * resource for the large object from {@link pg_lo_open}.
48971 *
48972 * To use the large object interface, it is necessary to enclose it
48973 * within a transaction block.
48974 *
48975 * @param resource $large_object PostgreSQL large object (LOB)
48976 *   resource, returned by {@link pg_lo_open}.
48977 * @return bool
48978 * @since PHP 4 >= 4.2.0, PHP 5
48979 **/
48980function pg_lo_close($large_object){}
48981
48982/**
48983 * {@link pg_lo_create} creates a large object and returns the OID of the
48984 * large object. PostgreSQL access modes INV_READ, INV_WRITE, and
48985 * INV_ARCHIVE are not supported, the object is created always with both
48986 * read and write access. INV_ARCHIVE has been removed from PostgreSQL
48987 * itself (version 6.3 and above).
48988 *
48989 * To use the large object interface, it is necessary to enclose it
48990 * within a transaction block.
48991 *
48992 * Instead of using the large object interface (which has no access
48993 * controls and is cumbersome to use), try PostgreSQL's bytea column type
48994 * and {@link pg_escape_bytea}.
48995 *
48996 * @param resource $connection PostgreSQL database connection resource.
48997 *   When {@link connection} is not present, the default connection is
48998 *   used. The default connection is the last connection made by {@link
48999 *   pg_connect} or {@link pg_pconnect}.
49000 * @param mixed $object_id If an {@link object_id} is given the
49001 *   function will try to create a large object with this id, else a free
49002 *   object id is assigned by the server. The parameter was added in PHP
49003 *   5.3 and relies on functionality that first appeared in PostgreSQL
49004 *   8.1.
49005 * @return int
49006 * @since PHP 4 >= 4.2.0, PHP 5
49007 **/
49008function pg_lo_create($connection, $object_id){}
49009
49010/**
49011 * {@link pg_lo_export} takes a large object in a PostgreSQL database and
49012 * saves its contents to a file on the local filesystem.
49013 *
49014 * To use the large object interface, it is necessary to enclose it
49015 * within a transaction block.
49016 *
49017 * @param resource $connection PostgreSQL database connection resource.
49018 *   When {@link connection} is not present, the default connection is
49019 *   used. The default connection is the last connection made by {@link
49020 *   pg_connect} or {@link pg_pconnect}.
49021 * @param int $oid The OID of the large object in the database.
49022 * @param string $pathname The full path and file name of the file in
49023 *   which to write the large object on the client filesystem.
49024 * @return bool
49025 * @since PHP 4 >= 4.2.0, PHP 5
49026 **/
49027function pg_lo_export($connection, $oid, $pathname){}
49028
49029/**
49030 * {@link pg_lo_import} creates a new large object in the database using
49031 * a file on the filesystem as its data source.
49032 *
49033 * To use the large object interface, it is necessary to enclose it
49034 * within a transaction block.
49035 *
49036 * @param resource $connection PostgreSQL database connection resource.
49037 *   When {@link connection} is not present, the default connection is
49038 *   used. The default connection is the last connection made by {@link
49039 *   pg_connect} or {@link pg_pconnect}.
49040 * @param string $pathname The full path and file name of the file on
49041 *   the client filesystem from which to read the large object data.
49042 * @param mixed $object_id If an {@link object_id} is given the
49043 *   function will try to create a large object with this id, else a free
49044 *   object id is assigned by the server. The parameter was added in PHP
49045 *   5.3 and relies on functionality that first appeared in PostgreSQL
49046 *   8.1.
49047 * @return int
49048 * @since PHP 4 >= 4.2.0, PHP 5
49049 **/
49050function pg_lo_import($connection, $pathname, $object_id){}
49051
49052/**
49053 * {@link pg_lo_open} opens a large object in the database and returns
49054 * large object resource so that it can be manipulated.
49055 *
49056 * To use the large object interface, it is necessary to enclose it
49057 * within a transaction block.
49058 *
49059 * @param resource $connection PostgreSQL database connection resource.
49060 *   When {@link connection} is not present, the default connection is
49061 *   used. The default connection is the last connection made by {@link
49062 *   pg_connect} or {@link pg_pconnect}.
49063 * @param int $oid The OID of the large object in the database.
49064 * @param string $mode Can be either "r" for read-only, "w" for write
49065 *   only or "rw" for read and write.
49066 * @return resource
49067 * @since PHP 4 >= 4.2.0, PHP 5
49068 **/
49069function pg_lo_open($connection, $oid, $mode){}
49070
49071/**
49072 * {@link pg_lo_read} reads at most {@link len} bytes from a large object
49073 * and returns it as a string.
49074 *
49075 * To use the large object interface, it is necessary to enclose it
49076 * within a transaction block.
49077 *
49078 * @param resource $large_object PostgreSQL large object (LOB)
49079 *   resource, returned by {@link pg_lo_open}.
49080 * @param int $len An optional maximum number of bytes to return.
49081 * @return string
49082 * @since PHP 4 >= 4.2.0, PHP 5
49083 **/
49084function pg_lo_read($large_object, $len){}
49085
49086/**
49087 * {@link pg_lo_read_all} reads a large object and passes it straight
49088 * through to the browser after sending all pending headers. Mainly
49089 * intended for sending binary data like images or sound.
49090 *
49091 * To use the large object interface, it is necessary to enclose it
49092 * within a transaction block.
49093 *
49094 * @param resource $large_object PostgreSQL large object (LOB)
49095 *   resource, returned by {@link pg_lo_open}.
49096 * @return int
49097 * @since PHP 4 >= 4.2.0, PHP 5
49098 **/
49099function pg_lo_read_all($large_object){}
49100
49101/**
49102 * {@link pg_lo_seek} seeks a position within a large object resource.
49103 *
49104 * To use the large object interface, it is necessary to enclose it
49105 * within a transaction block.
49106 *
49107 * @param resource $large_object PostgreSQL large object (LOB)
49108 *   resource, returned by {@link pg_lo_open}.
49109 * @param int $offset The number of bytes to seek.
49110 * @param int $whence One of the constants PGSQL_SEEK_SET (seek from
49111 *   object start), PGSQL_SEEK_CUR (seek from current position) or
49112 *   PGSQL_SEEK_END (seek from object end) .
49113 * @return bool
49114 * @since PHP 4 >= 4.2.0, PHP 5
49115 **/
49116function pg_lo_seek($large_object, $offset, $whence){}
49117
49118/**
49119 * {@link pg_lo_tell} returns the current position (offset from the
49120 * beginning) of a large object.
49121 *
49122 * To use the large object interface, it is necessary to enclose it
49123 * within a transaction block.
49124 *
49125 * @param resource $large_object PostgreSQL large object (LOB)
49126 *   resource, returned by {@link pg_lo_open}.
49127 * @return int
49128 * @since PHP 4 >= 4.2.0, PHP 5
49129 **/
49130function pg_lo_tell($large_object){}
49131
49132/**
49133 * {@link pg_lo_unlink} deletes a large object with the {@link oid}.
49134 *
49135 * To use the large object interface, it is necessary to enclose it
49136 * within a transaction block.
49137 *
49138 * @param resource $connection PostgreSQL database connection resource.
49139 *   When {@link connection} is not present, the default connection is
49140 *   used. The default connection is the last connection made by {@link
49141 *   pg_connect} or {@link pg_pconnect}.
49142 * @param int $oid The OID of the large object in the database.
49143 * @return bool
49144 * @since PHP 4 >= 4.2.0, PHP 5
49145 **/
49146function pg_lo_unlink($connection, $oid){}
49147
49148/**
49149 * {@link pg_lo_write} writes data into a large object at the current
49150 * seek position.
49151 *
49152 * To use the large object interface, it is necessary to enclose it
49153 * within a transaction block.
49154 *
49155 * @param resource $large_object PostgreSQL large object (LOB)
49156 *   resource, returned by {@link pg_lo_open}.
49157 * @param string $data The data to be written to the large object. If
49158 *   {@link len} is specified and is less than the length of {@link
49159 *   data}, only {@link len} bytes will be written.
49160 * @param int $len An optional maximum number of bytes to write. Must
49161 *   be greater than zero and no greater than the length of {@link data}.
49162 *   Defaults to the length of {@link data}.
49163 * @return int
49164 * @since PHP 4 >= 4.2.0, PHP 5
49165 **/
49166function pg_lo_write($large_object, $data, $len){}
49167
49168/**
49169 * {@link pg_meta_data} returns table definition for table_name as an
49170 * array.
49171 *
49172 * @param resource $connection PostgreSQL database connection resource.
49173 * @param string $table_name The name of the table.
49174 * @return array
49175 * @since PHP 4 >= 4.3.0, PHP 5
49176 **/
49177function pg_meta_data($connection, $table_name){}
49178
49179/**
49180 * {@link pg_num_fields} returns the number of fields (columns) in a
49181 * PostgreSQL result resource.
49182 *
49183 * @param resource $result PostgreSQL query result resource, returned
49184 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
49185 *   (among others).
49186 * @return int
49187 * @since PHP 4 >= 4.2.0, PHP 5
49188 **/
49189function pg_num_fields($result){}
49190
49191/**
49192 * {@link pg_num_rows} will return the number of rows in a PostgreSQL
49193 * result resource.
49194 *
49195 * @param resource $result PostgreSQL query result resource, returned
49196 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
49197 *   (among others).
49198 * @return int
49199 * @since PHP 4 >= 4.2.0, PHP 5
49200 **/
49201function pg_num_rows($result){}
49202
49203/**
49204 * {@link pg_options} will return a string containing the options
49205 * specified on the given PostgreSQL {@link connection} resource.
49206 *
49207 * @param resource $connection PostgreSQL database connection resource.
49208 *   When {@link connection} is not present, the default connection is
49209 *   used. The default connection is the last connection made by {@link
49210 *   pg_connect} or {@link pg_pconnect}.
49211 * @return string
49212 * @since PHP 4, PHP 5
49213 **/
49214function pg_options($connection){}
49215
49216/**
49217 * Looks up a current parameter setting of the server.
49218 *
49219 * Certain parameter values are reported by the server automatically at
49220 * connection startup or whenever their values change. {@link
49221 * pg_parameter_status} can be used to interrogate these settings. It
49222 * returns the current value of a parameter if known, or if the parameter
49223 * is not known.
49224 *
49225 * Parameters reported as of PostgreSQL 8.0 include server_version,
49226 * server_encoding, client_encoding, is_superuser, session_authorization,
49227 * DateStyle, TimeZone, and integer_datetimes. (server_encoding,
49228 * TimeZone, and integer_datetimes were not reported by releases before
49229 * 8.0.) Note that server_version, server_encoding and integer_datetimes
49230 * cannot change after PostgreSQL startup.
49231 *
49232 * PostgreSQL 7.3 or lower servers do not report parameter settings,
49233 * {@link pg_parameter_status} includes logic to obtain values for
49234 * server_version and client_encoding anyway. Applications are encouraged
49235 * to use {@link pg_parameter_status} rather than ad hoc code to
49236 * determine these values.
49237 *
49238 * @param resource $connection PostgreSQL database connection resource.
49239 *   When {@link connection} is not present, the default connection is
49240 *   used. The default connection is the last connection made by {@link
49241 *   pg_connect} or {@link pg_pconnect}.
49242 * @param string $param_name Possible {@link param_name} values include
49243 *   server_version, server_encoding, client_encoding, is_superuser,
49244 *   session_authorization, DateStyle, TimeZone, and integer_datetimes.
49245 * @return string
49246 * @since PHP 5
49247 **/
49248function pg_parameter_status($connection, $param_name){}
49249
49250/**
49251 * {@link pg_pconnect} opens a connection to a PostgreSQL database. It
49252 * returns a connection resource that is needed by other PostgreSQL
49253 * functions.
49254 *
49255 * If a second call is made to {@link pg_pconnect} with the same {@link
49256 * connection_string} as an existing connection, the existing connection
49257 * will be returned unless you pass PGSQL_CONNECT_FORCE_NEW as {@link
49258 * connect_type}.
49259 *
49260 * To enable persistent connection, the pgsql.allow_persistent directive
49261 * must be set to On (which is the default). The maximum number of
49262 * persistent connection can be defined with the pgsql.max_persistent
49263 * directive (defaults to -1 for no limit). The total number of
49264 * connections can be set with the pgsql.max_links directive.
49265 *
49266 * {@link pg_close} will not close persistent links generated by {@link
49267 * pg_pconnect}.
49268 *
49269 * @param string $connection_string The {@link connection_string} can
49270 *   be empty to use all default parameters, or it can contain one or
49271 *   more parameter settings separated by whitespace. Each parameter
49272 *   setting is in the form keyword = value. Spaces around the equal sign
49273 *   are optional. To write an empty value or a value containing spaces,
49274 *   surround it with single quotes, e.g., keyword = 'a value'. Single
49275 *   quotes and backslashes within the value must be escaped with a
49276 *   backslash, i.e., \' and \\. The currently recognized parameter
49277 *   keywords are: {@link host}, {@link hostaddr}, {@link port}, {@link
49278 *   dbname}, {@link user}, {@link password}, {@link connect_timeout},
49279 *   {@link options}, {@link tty} (ignored), {@link sslmode}, {@link
49280 *   requiressl} (deprecated in favor of {@link sslmode}), and {@link
49281 *   service}. Which of these arguments exist depends on your PostgreSQL
49282 *   version.
49283 * @param int $connect_type If PGSQL_CONNECT_FORCE_NEW is passed, then
49284 *   a new connection is created, even if the {@link connection_string}
49285 *   is identical to an existing connection.
49286 * @return resource
49287 * @since PHP 4, PHP 5
49288 **/
49289function pg_pconnect($connection_string, $connect_type){}
49290
49291/**
49292 * {@link pg_ping} pings a database connection and tries to reconnect it
49293 * if it is broken.
49294 *
49295 * @param resource $connection PostgreSQL database connection resource.
49296 *   When {@link connection} is not present, the default connection is
49297 *   used. The default connection is the last connection made by {@link
49298 *   pg_connect} or {@link pg_pconnect}.
49299 * @return bool
49300 * @since PHP 4 >= 4.3.0, PHP 5
49301 **/
49302function pg_ping($connection){}
49303
49304/**
49305 * {@link pg_port} returns the port number that the given PostgreSQL
49306 * {@link connection} resource is connected to.
49307 *
49308 * @param resource $connection PostgreSQL database connection resource.
49309 *   When {@link connection} is not present, the default connection is
49310 *   used. The default connection is the last connection made by {@link
49311 *   pg_connect} or {@link pg_pconnect}.
49312 * @return int
49313 * @since PHP 4, PHP 5
49314 **/
49315function pg_port($connection){}
49316
49317/**
49318 * {@link pg_prepare} creates a prepared statement for later execution
49319 * with {@link pg_execute} or {@link pg_send_execute}. This feature
49320 * allows commands that will be used repeatedly to be parsed and planned
49321 * just once, rather than each time they are executed. {@link pg_prepare}
49322 * is supported only against PostgreSQL 7.4 or higher connections; it
49323 * will fail when using earlier versions.
49324 *
49325 * The function creates a prepared statement named {@link stmtname} from
49326 * the {@link query} string, which must contain a single SQL command.
49327 * {@link stmtname} may be "" to create an unnamed statement, in which
49328 * case any pre-existing unnamed statement is automatically replaced;
49329 * otherwise it is an error if the statement name is already defined in
49330 * the current session. If any parameters are used, they are referred to
49331 * in the {@link query} as $1, $2, etc.
49332 *
49333 * Prepared statements for use with {@link pg_prepare} can also be
49334 * created by executing SQL PREPARE statements. (But {@link pg_prepare}
49335 * is more flexible since it does not require parameter types to be
49336 * pre-specified.) Also, although there is no PHP function for deleting a
49337 * prepared statement, the SQL DEALLOCATE statement can be used for that
49338 * purpose.
49339 *
49340 * @param resource $connection PostgreSQL database connection resource.
49341 *   When {@link connection} is not present, the default connection is
49342 *   used. The default connection is the last connection made by {@link
49343 *   pg_connect} or {@link pg_pconnect}.
49344 * @param string $stmtname The name to give the prepared statement.
49345 *   Must be unique per-connection. If "" is specified, then an unnamed
49346 *   statement is created, overwriting any previously defined unnamed
49347 *   statement.
49348 * @param string $query The parameterized SQL statement. Must contain
49349 *   only a single statement. (multiple statements separated by
49350 *   semi-colons are not allowed.) If any parameters are used, they are
49351 *   referred to as $1, $2, etc.
49352 * @return resource
49353 * @since PHP 5 >= 5.1.0
49354 **/
49355function pg_prepare($connection, $stmtname, $query){}
49356
49357/**
49358 * {@link pg_put_line} sends a NULL-terminated string to the PostgreSQL
49359 * backend server. This is needed in conjunction with PostgreSQL's COPY
49360 * FROM command.
49361 *
49362 * COPY is a high-speed data loading interface supported by PostgreSQL.
49363 * Data is passed in without being parsed, and in a single transaction.
49364 *
49365 * An alternative to using raw {@link pg_put_line} commands is to use
49366 * {@link pg_copy_from}. This is a far simpler interface.
49367 *
49368 * @param resource $connection PostgreSQL database connection resource.
49369 *   When {@link connection} is not present, the default connection is
49370 *   used. The default connection is the last connection made by {@link
49371 *   pg_connect} or {@link pg_pconnect}.
49372 * @param string $data A line of text to be sent directly to the
49373 *   PostgreSQL backend. A NULL terminator is added automatically.
49374 * @return bool
49375 * @since PHP 4 >= 4.0.3, PHP 5
49376 **/
49377function pg_put_line($connection, $data){}
49378
49379/**
49380 * {@link pg_query} executes the {@link query} on the specified database
49381 * {@link connection}.
49382 *
49383 * If an error occurs, and is returned, details of the error can be
49384 * retrieved using the {@link pg_last_error} function if the connection
49385 * is valid.
49386 *
49387 * Although {@link connection} can be omitted, it is not recommended,
49388 * since it can be the cause of hard to find bugs in scripts.
49389 *
49390 * @param resource $connection PostgreSQL database connection resource.
49391 *   When {@link connection} is not present, the default connection is
49392 *   used. The default connection is the last connection made by {@link
49393 *   pg_connect} or {@link pg_pconnect}.
49394 * @param string $query The SQL statement or statements to be executed.
49395 *   When multiple statements are passed to the function, they are
49396 *   automatically executed as one transaction, unless there are explicit
49397 *   BEGIN/COMMIT commands included in the query string. However, using
49398 *   multiple transactions in one function call is not recommended. Data
49399 *   inside the query should be properly escaped.
49400 * @return resource
49401 * @since PHP 4 >= 4.2.0, PHP 5
49402 **/
49403function pg_query($connection, $query){}
49404
49405/**
49406 * Submits a command to the server and waits for the result, with the
49407 * ability to pass parameters separately from the SQL command text.
49408 *
49409 * {@link pg_query_params} is like {@link pg_query}, but offers
49410 * additional functionality: parameter values can be specified separately
49411 * from the command string proper. {@link pg_query_params} is supported
49412 * only against PostgreSQL 7.4 or higher connections; it will fail when
49413 * using earlier versions.
49414 *
49415 * If parameters are used, they are referred to in the {@link query}
49416 * string as $1, $2, etc. {@link params} specifies the actual values of
49417 * the parameters. A value in this array means the corresponding
49418 * parameter is SQL NULL.
49419 *
49420 * The primary advantage of {@link pg_query_params} over {@link pg_query}
49421 * is that parameter values may be separated from the {@link query}
49422 * string, thus avoiding the need for tedious and error-prone quoting and
49423 * escaping. Unlike {@link pg_query}, {@link pg_query_params} allows at
49424 * most one SQL command in the given string. (There can be semicolons in
49425 * it, but not more than one nonempty command.)
49426 *
49427 * @param resource $connection PostgreSQL database connection resource.
49428 *   When {@link connection} is not present, the default connection is
49429 *   used. The default connection is the last connection made by {@link
49430 *   pg_connect} or {@link pg_pconnect}.
49431 * @param string $query The parameterized SQL statement. Must contain
49432 *   only a single statement. (multiple statements separated by
49433 *   semi-colons are not allowed.) If any parameters are used, they are
49434 *   referred to as $1, $2, etc.
49435 * @param array $params An array of parameter values to substitute for
49436 *   the $1, $2, etc. placeholders in the original prepared query string.
49437 *   The number of elements in the array must match the number of
49438 *   placeholders.
49439 * @return resource
49440 * @since PHP 5 >= 5.1.0
49441 **/
49442function pg_query_params($connection, $query, $params){}
49443
49444/**
49445 * {@link pg_result_error} returns any error message associated with the
49446 * {@link result} resource. Therefore, the user has a better chance of
49447 * getting the correct error message than with {@link pg_last_error}.
49448 *
49449 * The function {@link pg_result_error_field} can give much greater
49450 * detail on result errors than {@link pg_result_error}.
49451 *
49452 * Because {@link pg_query} returns if the query fails, you must use
49453 * {@link pg_send_query} and {@link pg_get_result} to get the result
49454 * handle.
49455 *
49456 * @param resource $result PostgreSQL query result resource, returned
49457 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
49458 *   (among others).
49459 * @return string
49460 * @since PHP 4 >= 4.2.0, PHP 5
49461 **/
49462function pg_result_error($result){}
49463
49464/**
49465 * {@link pg_result_error_field} returns one of the detailed error
49466 * message fields associated with {@link result} resource. It is only
49467 * available against a PostgreSQL 7.4 or above server. The error field is
49468 * specified by the {@link fieldcode}.
49469 *
49470 * Because {@link pg_query} and {@link pg_query_params} return if the
49471 * query fails, you must use {@link pg_send_query} and {@link
49472 * pg_get_result} to get the result handle.
49473 *
49474 * If you need to get additional error information from failed {@link
49475 * pg_query} queries, use {@link pg_set_error_verbosity} and {@link
49476 * pg_last_error} and then parse the result.
49477 *
49478 * @param resource $result A PostgreSQL query result resource from a
49479 *   previously executed statement.
49480 * @param int $fieldcode Possible {@link fieldcode} values are:
49481 *   PGSQL_DIAG_SEVERITY, PGSQL_DIAG_SQLSTATE,
49482 *   PGSQL_DIAG_MESSAGE_PRIMARY, PGSQL_DIAG_MESSAGE_DETAIL,
49483 *   PGSQL_DIAG_MESSAGE_HINT, PGSQL_DIAG_STATEMENT_POSITION,
49484 *   PGSQL_DIAG_INTERNAL_POSITION (PostgreSQL 8.0+ only),
49485 *   PGSQL_DIAG_INTERNAL_QUERY (PostgreSQL 8.0+ only),
49486 *   PGSQL_DIAG_CONTEXT, PGSQL_DIAG_SOURCE_FILE, PGSQL_DIAG_SOURCE_LINE
49487 *   or PGSQL_DIAG_SOURCE_FUNCTION.
49488 * @return string
49489 * @since PHP 5 >= 5.1.0
49490 **/
49491function pg_result_error_field($result, $fieldcode){}
49492
49493/**
49494 * {@link pg_result_seek} sets the internal row offset in a result
49495 * resource.
49496 *
49497 * @param resource $result PostgreSQL query result resource, returned
49498 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
49499 *   (among others).
49500 * @param int $offset Row to move the internal offset to in the {@link
49501 *   result} resource. Rows are numbered starting from zero.
49502 * @return bool
49503 * @since PHP 4 >= 4.3.0, PHP 5
49504 **/
49505function pg_result_seek($result, $offset){}
49506
49507/**
49508 * {@link pg_result_status} returns the status of a result resource, or
49509 * the PostgreSQL command completion tag associated with the result
49510 *
49511 * @param resource $result PostgreSQL query result resource, returned
49512 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
49513 *   (among others).
49514 * @param int $type Either PGSQL_STATUS_LONG to return the numeric
49515 *   status of the {@link result}, or PGSQL_STATUS_STRING to return the
49516 *   command tag of the {@link result}. If not specified,
49517 *   PGSQL_STATUS_LONG is the default.
49518 * @return mixed
49519 * @since PHP 4 >= 4.2.0, PHP 5
49520 **/
49521function pg_result_status($result, $type){}
49522
49523/**
49524 * {@link pg_select} selects records specified by assoc_array which has
49525 * field=>value. For a successful query, it returns an array containing
49526 * all records and fields that match the condition specified by
49527 * assoc_array.
49528 *
49529 * If options is specified, {@link pg_convert} is applied to assoc_array
49530 * with the specified flags.
49531 *
49532 * @param resource $connection PostgreSQL database connection resource.
49533 * @param string $table_name Name of the table from which to select
49534 *   rows.
49535 * @param array $assoc_array An array whose keys are field names in the
49536 *   table {@link table_name}, and whose values are the conditions that a
49537 *   row must meet to be retrieved.
49538 * @param int $options Any number of PGSQL_CONV_FORCE_NULL,
49539 *   PGSQL_DML_NO_CONV, PGSQL_DML_EXEC, PGSQL_DML_ASYNC or
49540 *   PGSQL_DML_STRING combined. If PGSQL_DML_STRING is part of the {@link
49541 *   options} then query string is returned.
49542 * @return mixed
49543 * @since PHP 4 >= 4.3.0, PHP 5
49544 **/
49545function pg_select($connection, $table_name, $assoc_array, $options){}
49546
49547/**
49548 * Sends a request to execute a prepared statement with given parameters,
49549 * without waiting for the result(s).
49550 *
49551 * This is similar to {@link pg_send_query_params}, but the command to be
49552 * executed is specified by naming a previously-prepared statement,
49553 * instead of giving a query string. The function's parameters are
49554 * handled identically to {@link pg_execute}. Like {@link pg_execute}, it
49555 * will not work on pre-7.4 versions of PostgreSQL.
49556 *
49557 * @param resource $connection PostgreSQL database connection resource.
49558 *   When {@link connection} is not present, the default connection is
49559 *   used. The default connection is the last connection made by {@link
49560 *   pg_connect} or {@link pg_pconnect}.
49561 * @param string $stmtname The name of the prepared statement to
49562 *   execute. if "" is specified, then the unnamed statement is executed.
49563 *   The name must have been previously prepared using {@link
49564 *   pg_prepare}, {@link pg_send_prepare} or a PREPARE SQL command.
49565 * @param array $params An array of parameter values to substitute for
49566 *   the $1, $2, etc. placeholders in the original prepared query string.
49567 *   The number of elements in the array must match the number of
49568 *   placeholders.
49569 * @return bool
49570 * @since PHP 5 >= 5.1.0
49571 **/
49572function pg_send_execute($connection, $stmtname, $params){}
49573
49574/**
49575 * Sends a request to create a prepared statement with the given
49576 * parameters, without waiting for completion.
49577 *
49578 * This is an asynchronous version of {@link pg_prepare}: it returns if
49579 * it was able to dispatch the request, and if not. After a successful
49580 * call, call {@link pg_get_result} to determine whether the server
49581 * successfully created the prepared statement. The function's parameters
49582 * are handled identically to {@link pg_prepare}. Like {@link
49583 * pg_prepare}, it will not work on pre-7.4 versions of PostgreSQL.
49584 *
49585 * @param resource $connection PostgreSQL database connection resource.
49586 *   When {@link connection} is not present, the default connection is
49587 *   used. The default connection is the last connection made by {@link
49588 *   pg_connect} or {@link pg_pconnect}.
49589 * @param string $stmtname The name to give the prepared statement.
49590 *   Must be unique per-connection. If "" is specified, then an unnamed
49591 *   statement is created, overwriting any previously defined unnamed
49592 *   statement.
49593 * @param string $query The parameterized SQL statement. Must contain
49594 *   only a single statement. (multiple statements separated by
49595 *   semi-colons are not allowed.) If any parameters are used, they are
49596 *   referred to as $1, $2, etc.
49597 * @return bool
49598 * @since PHP 5 >= 5.1.0
49599 **/
49600function pg_send_prepare($connection, $stmtname, $query){}
49601
49602/**
49603 * {@link pg_send_query} sends a query or queries asynchronously to the
49604 * {@link connection}. Unlike {@link pg_query}, it can send multiple
49605 * queries at once to PostgreSQL and get the results one by one using
49606 * {@link pg_get_result}.
49607 *
49608 * Script execution is not blocked while the queries are executing. Use
49609 * {@link pg_connection_busy} to check if the connection is busy (i.e.
49610 * the query is executing). Queries may be cancelled using {@link
49611 * pg_cancel_query}.
49612 *
49613 * Although the user can send multiple queries at once, multiple queries
49614 * cannot be sent over a busy connection. If a query is sent while the
49615 * connection is busy, it waits until the last query is finished and
49616 * discards all its results.
49617 *
49618 * @param resource $connection PostgreSQL database connection resource.
49619 * @param string $query The SQL statement or statements to be executed.
49620 *   Data inside the query should be properly escaped.
49621 * @return bool
49622 * @since PHP 4 >= 4.2.0, PHP 5
49623 **/
49624function pg_send_query($connection, $query){}
49625
49626/**
49627 * Submits a command and separate parameters to the server without
49628 * waiting for the result(s).
49629 *
49630 * This is equivalent to {@link pg_send_query} except that query
49631 * parameters can be specified separately from the {@link query} string.
49632 * The function's parameters are handled identically to {@link
49633 * pg_query_params}. Like {@link pg_query_params}, it will not work on
49634 * pre-7.4 PostgreSQL connections, and it allows only one command in the
49635 * query string.
49636 *
49637 * @param resource $connection PostgreSQL database connection resource.
49638 * @param string $query The parameterized SQL statement. Must contain
49639 *   only a single statement. (multiple statements separated by
49640 *   semi-colons are not allowed.) If any parameters are used, they are
49641 *   referred to as $1, $2, etc.
49642 * @param array $params An array of parameter values to substitute for
49643 *   the $1, $2, etc. placeholders in the original prepared query string.
49644 *   The number of elements in the array must match the number of
49645 *   placeholders.
49646 * @return bool
49647 * @since PHP 5 >= 5.1.0
49648 **/
49649function pg_send_query_params($connection, $query, $params){}
49650
49651/**
49652 * {@link pg_set_client_encoding} sets the client encoding and returns 0
49653 * if success or -1 if error.
49654 *
49655 * PostgreSQL will automatically convert data in the backend database
49656 * encoding into the frontend encoding.
49657 *
49658 * @param resource $connection PostgreSQL database connection resource.
49659 *   When {@link connection} is not present, the default connection is
49660 *   used. The default connection is the last connection made by {@link
49661 *   pg_connect} or {@link pg_pconnect}.
49662 * @param string $encoding The required client encoding. One of
49663 *   SQL_ASCII, EUC_JP, EUC_CN, EUC_KR, EUC_TW, UNICODE, MULE_INTERNAL,
49664 *   LATINX (X=1...9), KOI8, WIN, ALT, SJIS, BIG5 or WIN1250. The exact
49665 *   list of available encodings depends on your PostgreSQL version, so
49666 *   check your PostgreSQL manual for a more specific list.
49667 * @return int
49668 * @since PHP 4 >= 4.0.3, PHP 5
49669 **/
49670function pg_set_client_encoding($connection, $encoding){}
49671
49672/**
49673 * Determines the verbosity of messages returned by {@link pg_last_error}
49674 * and {@link pg_result_error}.
49675 *
49676 * {@link pg_set_error_verbosity} sets the verbosity mode, returning the
49677 * connection's previous setting. In PGSQL_ERRORS_TERSE mode, returned
49678 * messages include severity, primary text, and position only; this will
49679 * normally fit on a single line. The default mode (PGSQL_ERRORS_DEFAULT)
49680 * produces messages that include the above plus any detail, hint, or
49681 * context fields (these may span multiple lines). The
49682 * PGSQL_ERRORS_VERBOSE mode includes all available fields. Changing the
49683 * verbosity does not affect the messages available from already-existing
49684 * result objects, only subsequently-created ones.
49685 *
49686 * @param resource $connection PostgreSQL database connection resource.
49687 *   When {@link connection} is not present, the default connection is
49688 *   used. The default connection is the last connection made by {@link
49689 *   pg_connect} or {@link pg_pconnect}.
49690 * @param int $verbosity The required verbosity: PGSQL_ERRORS_TERSE,
49691 *   PGSQL_ERRORS_DEFAULT or PGSQL_ERRORS_VERBOSE.
49692 * @return int
49693 * @since PHP 5 >= 5.1.0
49694 **/
49695function pg_set_error_verbosity($connection, $verbosity){}
49696
49697/**
49698 * {@link pg_trace} enables tracing of the PostgreSQL frontend/backend
49699 * communication to a file. To fully understand the results, one needs to
49700 * be familiar with the internals of PostgreSQL communication protocol.
49701 *
49702 * For those who are not, it can still be useful for tracing errors in
49703 * queries sent to the server, you could do for example grep '^To
49704 * backend' trace.log and see what queries actually were sent to the
49705 * PostgreSQL server. For more information, refer to the PostgreSQL
49706 * Documentation.
49707 *
49708 * @param string $pathname The full path and file name of the file in
49709 *   which to write the trace log. Same as in {@link fopen}.
49710 * @param string $mode An optional file access mode, same as for {@link
49711 *   fopen}.
49712 * @param resource $connection PostgreSQL database connection resource.
49713 *   When {@link connection} is not present, the default connection is
49714 *   used. The default connection is the last connection made by {@link
49715 *   pg_connect} or {@link pg_pconnect}.
49716 * @return bool
49717 * @since PHP 4 >= 4.0.1, PHP 5
49718 **/
49719function pg_trace($pathname, $mode, $connection){}
49720
49721/**
49722 * Returns the current in-transaction status of the server.
49723 *
49724 * @param resource $connection PostgreSQL database connection resource.
49725 * @return int
49726 * @since PHP 5 >= 5.1.0
49727 **/
49728function pg_transaction_status($connection){}
49729
49730/**
49731 * {@link pg_tty} returns the TTY name that server side debugging output
49732 * is sent to on the given PostgreSQL {@link connection} resource.
49733 *
49734 * @param resource $connection PostgreSQL database connection resource.
49735 *   When {@link connection} is not present, the default connection is
49736 *   used. The default connection is the last connection made by {@link
49737 *   pg_connect} or {@link pg_pconnect}.
49738 * @return string
49739 * @since PHP 4, PHP 5
49740 **/
49741function pg_tty($connection){}
49742
49743/**
49744 * {@link pg_unescape_bytea} unescapes PostgreSQL bytea data values. It
49745 * returns the unescaped string, possibly containing binary data.
49746 *
49747 * @param string $data A string containing PostgreSQL bytea data to be
49748 *   converted into a PHP binary string.
49749 * @return string
49750 * @since PHP 4 >= 4.3.0, PHP 5
49751 **/
49752function pg_unescape_bytea($data){}
49753
49754/**
49755 * Stop tracing started by {@link pg_trace}.
49756 *
49757 * @param resource $connection PostgreSQL database connection resource.
49758 *   When {@link connection} is not present, the default connection is
49759 *   used. The default connection is the last connection made by {@link
49760 *   pg_connect} or {@link pg_pconnect}.
49761 * @return bool
49762 * @since PHP 4 >= 4.0.1, PHP 5
49763 **/
49764function pg_untrace($connection){}
49765
49766/**
49767 * {@link pg_update} updates records that matches condition with data. If
49768 * options is specified, {@link pg_convert} is applied to data with
49769 * specified options.
49770 *
49771 * @param resource $connection PostgreSQL database connection resource.
49772 * @param string $table_name Name of the table into which to update
49773 *   rows.
49774 * @param array $data An array whose keys are field names in the table
49775 *   {@link table_name}, and whose values are what matched rows are to be
49776 *   updated to.
49777 * @param array $condition An array whose keys are field names in the
49778 *   table {@link table_name}, and whose values are the conditions that a
49779 *   row must meet to be updated.
49780 * @param int $options Any number of PGSQL_CONV_OPTS,
49781 *   PGSQL_DML_NO_CONV, PGSQL_DML_EXEC or PGSQL_DML_STRING combined. If
49782 *   PGSQL_DML_STRING is part of the {@link options} then query string is
49783 *   returned.
49784 * @return mixed
49785 * @since PHP 4 >= 4.3.0, PHP 5
49786 **/
49787function pg_update($connection, $table_name, $data, $condition, $options){}
49788
49789/**
49790 * {@link pg_version} returns an array with the client, protocol and
49791 * server version. Protocol and server versions are only available if PHP
49792 * was compiled with PostgreSQL 7.4 or later.
49793 *
49794 * For more detailed server information, use {@link pg_parameter_status}.
49795 *
49796 * @param resource $connection PostgreSQL database connection resource.
49797 *   When {@link connection} is not present, the default connection is
49798 *   used. The default connection is the last connection made by {@link
49799 *   pg_connect} or {@link pg_pconnect}.
49800 * @return array
49801 * @since PHP 5
49802 **/
49803function pg_version($connection){}
49804
49805/**
49806 * This function prints out the credits listing the PHP developers,
49807 * modules, etc. It generates the appropriate HTML codes to insert the
49808 * information in a page.
49809 *
49810 * @param int $flag To generate a custom credits page, you may want to
49811 *   use the {@link flag} parameter.
49812 *
49813 *   Pre-defined {@link phpcredits} flags name description CREDITS_ALL
49814 *   All the credits, equivalent to using: CREDITS_DOCS + CREDITS_GENERAL
49815 *   + CREDITS_GROUP + CREDITS_MODULES + CREDITS_FULLPAGE. It generates a
49816 *   complete stand-alone HTML page with the appropriate tags.
49817 *   CREDITS_DOCS The credits for the documentation team CREDITS_FULLPAGE
49818 *   Usually used in combination with the other flags. Indicates that a
49819 *   complete stand-alone HTML page needs to be printed including the
49820 *   information indicated by the other flags. CREDITS_GENERAL General
49821 *   credits: Language design and concept, PHP authors and SAPI module.
49822 *   CREDITS_GROUP A list of the core developers CREDITS_MODULES A list
49823 *   of the extension modules for PHP, and their authors CREDITS_SAPI A
49824 *   list of the server API modules for PHP, and their authors
49825 * @return bool
49826 * @since PHP 4, PHP 5
49827 **/
49828function phpcredits($flag){}
49829
49830/**
49831 * Outputs a large amount of information about the current state of PHP.
49832 * This includes information about PHP compilation options and
49833 * extensions, the PHP version, server information and environment (if
49834 * compiled as a module), the PHP environment, OS version information,
49835 * paths, master and local values of configuration options, HTTP headers,
49836 * and the PHP License.
49837 *
49838 * Because every system is setup differently, {@link phpinfo} is commonly
49839 * used to check configuration settings and for available predefined
49840 * variables on a given system.
49841 *
49842 * {@link phpinfo} is also a valuable debugging tool as it contains all
49843 * EGPCS (Environment, GET, POST, Cookie, Server) data.
49844 *
49845 * @param int $what The output may be customized by passing one or more
49846 *   of the following constants bitwise values summed together in the
49847 *   optional {@link what} parameter. One can also combine the respective
49848 *   constants or bitwise values together with the or operator.
49849 *
49850 *   {@link phpinfo} options Name (constant) Value Description
49851 *   INFO_GENERAL 1 The configuration line, location, build date, Web
49852 *   Server, System and more. INFO_CREDITS 2 PHP Credits. See also {@link
49853 *   phpcredits}. INFO_CONFIGURATION 4 Current Local and Master values
49854 *   for PHP directives. See also {@link ini_get}. INFO_MODULES 8 Loaded
49855 *   modules and their respective settings. See also {@link
49856 *   get_loaded_extensions}. INFO_ENVIRONMENT 16 Environment Variable
49857 *   information that's also available in $_ENV. INFO_VARIABLES 32 Shows
49858 *   all predefined variables from EGPCS (Environment, GET, POST, Cookie,
49859 *   Server). INFO_LICENSE 64 PHP License information. See also the
49860 *   license FAQ. INFO_ALL -1 Shows all of the above.
49861 * @return bool
49862 * @since PHP 4, PHP 5
49863 **/
49864function phpinfo($what){}
49865
49866/**
49867 * Returns a string containing the version of the currently running PHP
49868 * parser or extension.
49869 *
49870 * @param string $extension An optional extension name.
49871 * @return string
49872 * @since PHP 4, PHP 5
49873 **/
49874function phpversion($extension){}
49875
49876/**
49877 * Performs a syntax (lint) check on the specified {@link filename}
49878 * testing for scripting errors.
49879 *
49880 * This is similar to using php -l from the commandline except that this
49881 * function will execute (but not output) the checked {@link filename}.
49882 *
49883 * For example, if a function is defined in {@link filename}, this
49884 * defined function will be available to the file that executed {@link
49885 * php_check_syntax}, but output from {@link filename} will be
49886 * suppressed.
49887 *
49888 * @param string $filename The name of the file being checked.
49889 * @param string $error_message If the {@link error_message} parameter
49890 *   is used, it will contain the error message generated by the syntax
49891 *   check. {@link error_message} is passed by reference.
49892 * @return bool
49893 * @since PHP 5
49894 **/
49895function php_check_syntax($filename, &$error_message){}
49896
49897/**
49898 * Check if a file is loaded, and retrieve its path.
49899 *
49900 * @return string
49901 * @since PHP 5 >= 5.2.4
49902 **/
49903function php_ini_loaded_file(){}
49904
49905/**
49906 * {@link php_ini_scanned_files} returns a comma-separated list of
49907 * configuration files parsed after . These files are found in a
49908 * directory defined by the --with-config-file-scan-dir option which is
49909 * set during compilation.
49910 *
49911 * The returned configuration files also include the path as declared in
49912 * the --with-config-file-scan-dir option.
49913 *
49914 * @return string
49915 * @since PHP 4 >= 4.3.0, PHP 5
49916 **/
49917function php_ini_scanned_files(){}
49918
49919/**
49920 * This function returns the ID which can be used to display the PHP logo
49921 * using the built-in image. Logo is displayed only if expose_php is On.
49922 *
49923 * @return string
49924 * @since PHP 4, PHP 5
49925 **/
49926function php_logo_guid(){}
49927
49928/**
49929 * @return string
49930 * @since PHP 4 >= 4.0.1, PHP 5
49931 **/
49932function php_sapi_name(){}
49933
49934/**
49935 * Returns the PHP source code in {@link filename} with PHP comments and
49936 * whitespace removed. This may be useful for determining the amount of
49937 * actual code in your scripts compared with the amount of comments. This
49938 * is similar to using php -w from the commandline.
49939 *
49940 * @param string $filename Path to the PHP file.
49941 * @return string
49942 * @since PHP 5
49943 **/
49944function php_strip_whitespace($filename){}
49945
49946/**
49947 * {@link php_uname} returns a description of the operating system PHP is
49948 * running on. This is the same string you see at the very top of the
49949 * {@link phpinfo} output. For the name of just the operating system,
49950 * consider using the PHP_OS constant, but keep in mind this constant
49951 * will contain the operating system PHP was built on.
49952 *
49953 * On some older UNIX platforms, it may not be able to determine the
49954 * current OS information in which case it will revert to displaying the
49955 * OS PHP was built on. This will only happen if your uname() library
49956 * call either doesn't exist or doesn't work.
49957 *
49958 * @param string $mode {@link mode} is a single character that defines
49959 *   what information is returned: 'a': This is the default. Contains all
49960 *   modes in the sequence "s n r v m". 's': Operating system name. eg.
49961 *   FreeBSD. 'n': Host name. eg. localhost.example.com. 'r': Release
49962 *   name. eg. 5.1.2-RELEASE. 'v': Version information. Varies a lot
49963 *   between operating systems. 'm': Machine type. eg. i386.
49964 * @return string
49965 * @since PHP 4 >= 4.0.2, PHP 5
49966 **/
49967function php_uname($mode){}
49968
49969/**
49970 * @return float
49971 * @since PHP 4, PHP 5
49972 **/
49973function pi(){}
49974
49975/**
49976 * Converts a PNG file into a WBMP file.
49977 *
49978 * @param string $pngname Path to PNG file.
49979 * @param string $wbmpname Path to destination WBMP file.
49980 * @param int $dest_height Destination image height.
49981 * @param int $dest_width Destination image width.
49982 * @param int $threshold Threshold value, between 0 and 8 (inclusive).
49983 * @return bool
49984 * @since PHP 4 >= 4.0.5, PHP 5
49985 **/
49986function png2wbmp($pngname, $wbmpname, $dest_height, $dest_width, $threshold){}
49987
49988/**
49989 * Opens a pipe to a process executed by forking the command given by
49990 * command.
49991 *
49992 * @param string $command The command
49993 * @param string $mode The mode
49994 * @return resource
49995 * @since PHP 4, PHP 5
49996 **/
49997function popen($command, $mode){}
49998
49999/**
50000 * Every array has an internal pointer to its "pos" element, which is
50001 * initialized to the first element inserted into the array.
50002 *
50003 * @param array $array The array.
50004 * @return mixed
50005 * @since PHP 4, PHP 5
50006 **/
50007function pos(&$array){}
50008
50009/**
50010 * {@link posix_access} checks the user's permission of a file.
50011 *
50012 * @param string $file The name of the file to be tested.
50013 * @param int $mode A mask consisting of one or more of POSIX_F_OK,
50014 *   POSIX_R_OK, POSIX_W_OK and POSIX_X_OK. POSIX_R_OK, POSIX_W_OK and
50015 *   POSIX_X_OK request checking whether the file exists and has read,
50016 *   write and execute permissions, respectively. POSIX_F_OK just
50017 *   requests checking for the existence of the file.
50018 * @return bool
50019 * @since PHP 5 >= 5.1.0
50020 **/
50021function posix_access($file, $mode){}
50022
50023/**
50024 * Generates a string which is the pathname for the current controlling
50025 * terminal for the process. On error this will set errno, which can be
50026 * checked using {@link posix_get_last_error}
50027 *
50028 * @return string
50029 * @since PHP 4, PHP 5
50030 **/
50031function posix_ctermid(){}
50032
50033/**
50034 * Retrieve the error number set by the last posix function that failed.
50035 * The system error message associated with the errno may be checked with
50036 * {@link posix_strerror}.
50037 *
50038 * @return int
50039 * @since PHP 4 >= 4.2.0, PHP 5
50040 **/
50041function posix_errno(){}
50042
50043/**
50044 * Gets the absolute pathname of the script's current working directory.
50045 * On error, it sets errno which can be checked using {@link
50046 * posix_get_last_error}
50047 *
50048 * @return string
50049 * @since PHP 4, PHP 5
50050 **/
50051function posix_getcwd(){}
50052
50053/**
50054 * Return the numeric effective group ID of the current process.
50055 *
50056 * @return int
50057 * @since PHP 4, PHP 5
50058 **/
50059function posix_getegid(){}
50060
50061/**
50062 * Return the numeric effective user ID of the current process. See also
50063 * {@link posix_getpwuid} for information on how to convert this into a
50064 * useable username.
50065 *
50066 * @return int
50067 * @since PHP 4, PHP 5
50068 **/
50069function posix_geteuid(){}
50070
50071/**
50072 * Return the numeric real group ID of the current process.
50073 *
50074 * @return int
50075 * @since PHP 4, PHP 5
50076 **/
50077function posix_getgid(){}
50078
50079/**
50080 * Gets information about a group provided its id.
50081 *
50082 * @param int $gid The group id.
50083 * @return array
50084 * @since PHP 4, PHP 5
50085 **/
50086function posix_getgrgid($gid){}
50087
50088/**
50089 * Gets information about a group provided its name.
50090 *
50091 * @param string $name The name of the group
50092 * @return array
50093 * @since PHP 4, PHP 5
50094 **/
50095function posix_getgrnam($name){}
50096
50097/**
50098 * Gets the group set of the current process.
50099 *
50100 * @return array
50101 * @since PHP 4, PHP 5
50102 **/
50103function posix_getgroups(){}
50104
50105/**
50106 * Returns the login name of the user owning the current process.
50107 *
50108 * @return string
50109 * @since PHP 4, PHP 5
50110 **/
50111function posix_getlogin(){}
50112
50113/**
50114 * Returns the process group identifier of the process {@link pid}.
50115 *
50116 * @param int $pid The process id.
50117 * @return int
50118 * @since PHP 4, PHP 5
50119 **/
50120function posix_getpgid($pid){}
50121
50122/**
50123 * Return the process group identifier of the current process.
50124 *
50125 * @return int
50126 * @since PHP 4, PHP 5
50127 **/
50128function posix_getpgrp(){}
50129
50130/**
50131 * Return the process identifier of the current process.
50132 *
50133 * @return int
50134 * @since PHP 4, PHP 5
50135 **/
50136function posix_getpid(){}
50137
50138/**
50139 * Return the process identifier of the parent process of the current
50140 * process.
50141 *
50142 * @return int
50143 * @since PHP 4, PHP 5
50144 **/
50145function posix_getppid(){}
50146
50147/**
50148 * Returns an array of information about the given user.
50149 *
50150 * @param string $username An alphanumeric username.
50151 * @return array
50152 * @since PHP 4, PHP 5
50153 **/
50154function posix_getpwnam($username){}
50155
50156/**
50157 * Returns an array of information about the user referenced by the given
50158 * user ID.
50159 *
50160 * @param int $uid The user identifier.
50161 * @return array
50162 * @since PHP 4, PHP 5
50163 **/
50164function posix_getpwuid($uid){}
50165
50166/**
50167 * {@link posix_getrlimit} returns an array of information about the
50168 * current resource's soft and hard limits.
50169 *
50170 * Each resource has an associated soft and hard limit. The soft limit is
50171 * the value that the kernel enforces for the corresponding resource. The
50172 * hard limit acts as a ceiling for the soft limit. An unprivileged
50173 * process may only set its soft limit to a value from 0 to the hard
50174 * limit, and irreversibly lower its hard limit.
50175 *
50176 * @return array
50177 * @since PHP 4, PHP 5
50178 **/
50179function posix_getrlimit(){}
50180
50181/**
50182 * Return the session id of the process {@link pid}. The session id of a
50183 * process is the process group id of the session leader.
50184 *
50185 * @param int $pid The process identifier. If set to 0, the current
50186 *   process is assumed. If an invalid {@link pid} is specified, then is
50187 *   returned and an error is set which can be checked with {@link
50188 *   posix_get_last_error}.
50189 * @return int
50190 * @since PHP 4, PHP 5
50191 **/
50192function posix_getsid($pid){}
50193
50194/**
50195 * Return the numeric real user ID of the current process.
50196 *
50197 * @return int
50198 * @since PHP 4, PHP 5
50199 **/
50200function posix_getuid(){}
50201
50202/**
50203 * Retrieve the error number set by the last posix function that failed.
50204 * The system error message associated with the errno may be checked with
50205 * {@link posix_strerror}.
50206 *
50207 * @return int
50208 * @since PHP 4 >= 4.2.0, PHP 5
50209 **/
50210function posix_get_last_error(){}
50211
50212/**
50213 * Calculates the group access list for the user specified in name.
50214 *
50215 * @param string $name The user to calculate the list for.
50216 * @param int $base_group_id Typically the group number from the
50217 *   password file.
50218 * @return bool
50219 * @since PHP 5 >= 5.2.0
50220 **/
50221function posix_initgroups($name, $base_group_id){}
50222
50223/**
50224 * Determines if the file descriptor {@link fd} refers to a valid
50225 * terminal type device.
50226 *
50227 * @param int $fd The file descriptor.
50228 * @return bool
50229 * @since PHP 4, PHP 5
50230 **/
50231function posix_isatty($fd){}
50232
50233/**
50234 * Send the signal {@link sig} to the process with the process identifier
50235 * {@link pid}.
50236 *
50237 * @param int $pid The process identifier.
50238 * @param int $sig One of the PCNTL signals constants.
50239 * @return bool
50240 * @since PHP 4, PHP 5
50241 **/
50242function posix_kill($pid, $sig){}
50243
50244/**
50245 * {@link posix_mkfifo} creates a special FIFO file which exists in the
50246 * file system and acts as a bidirectional communication endpoint for
50247 * processes.
50248 *
50249 * @param string $pathname Path to the FIFO file.
50250 * @param int $mode The second parameter {@link mode} has to be given
50251 *   in octal notation (e.g. 0644). The permission of the newly created
50252 *   FIFO also depends on the setting of the current {@link umask}. The
50253 *   permissions of the created file are (mode & ~umask).
50254 * @return bool
50255 * @since PHP 4, PHP 5
50256 **/
50257function posix_mkfifo($pathname, $mode){}
50258
50259/**
50260 * Creates a special or ordinary file.
50261 *
50262 * @param string $pathname The file to create
50263 * @param int $mode This parameter is constructed by a bitwise OR
50264 *   between file type (one of the following constants: POSIX_S_IFREG,
50265 *   POSIX_S_IFCHR, POSIX_S_IFBLK, POSIX_S_IFIFO or POSIX_S_IFSOCK) and
50266 *   permissions.
50267 * @param int $major The major device kernel identifier (required to
50268 *   pass when using S_IFCHR or S_IFBLK).
50269 * @param int $minor The minor device kernel identifier.
50270 * @return bool
50271 * @since PHP 5 >= 5.1.0
50272 **/
50273function posix_mknod($pathname, $mode, $major, $minor){}
50274
50275/**
50276 * Set the effective group ID of the current process. This is a
50277 * privileged function and needs appropriate privileges (usually root) on
50278 * the system to be able to perform this function.
50279 *
50280 * @param int $gid The group id.
50281 * @return bool
50282 * @since PHP 4 >= 4.0.2, PHP 5
50283 **/
50284function posix_setegid($gid){}
50285
50286/**
50287 * Set the real user ID of the current process. This is a privileged
50288 * function and needs appropriate privileges (usually root) on the system
50289 * to be able to perform this function.
50290 *
50291 * @param int $uid The user id.
50292 * @return bool
50293 * @since PHP 4 >= 4.0.2, PHP 5
50294 **/
50295function posix_seteuid($uid){}
50296
50297/**
50298 * Set the real group ID of the current process. This is a privileged
50299 * function and needs appropriate privileges (usually root) on the system
50300 * to be able to perform this function. The appropriate order of function
50301 * calls is {@link posix_setgid} first, {@link posix_setuid} last.
50302 *
50303 * @param int $gid The group id.
50304 * @return bool
50305 * @since PHP 4, PHP 5
50306 **/
50307function posix_setgid($gid){}
50308
50309/**
50310 * Let the process {@link pid} join the process group {@link pgid}.
50311 *
50312 * @param int $pid The process id.
50313 * @param int $pgid The process group id.
50314 * @return bool
50315 * @since PHP 4, PHP 5
50316 **/
50317function posix_setpgid($pid, $pgid){}
50318
50319/**
50320 * Make the current process a session leader.
50321 *
50322 * @return int
50323 * @since PHP 4, PHP 5
50324 **/
50325function posix_setsid(){}
50326
50327/**
50328 * Set the real user ID of the current process. This is a privileged
50329 * function that needs appropriate privileges (usually root) on the
50330 * system to be able to perform this function.
50331 *
50332 * @param int $uid The user id.
50333 * @return bool
50334 * @since PHP 4, PHP 5
50335 **/
50336function posix_setuid($uid){}
50337
50338/**
50339 * Returns the POSIX system error message associated with the given
50340 * {@link errno}. You may get the {@link errno} parameter by calling
50341 * {@link posix_get_last_error}.
50342 *
50343 * @param int $errno A POSIX error number, returned by {@link
50344 *   posix_get_last_error}. If set to 0, then the string "Success" is
50345 *   returned.
50346 * @return string
50347 * @since PHP 4 >= 4.2.0, PHP 5
50348 **/
50349function posix_strerror($errno){}
50350
50351/**
50352 * Gets information about the current CPU usage.
50353 *
50354 * @return array
50355 * @since PHP 4, PHP 5
50356 **/
50357function posix_times(){}
50358
50359/**
50360 * Returns a string for the absolute path to the current terminal device
50361 * that is open on the file descriptor {@link fd}.
50362 *
50363 * @param int $fd The file descriptor.
50364 * @return string
50365 * @since PHP 4, PHP 5
50366 **/
50367function posix_ttyname($fd){}
50368
50369/**
50370 * Gets information about the system.
50371 *
50372 * Posix requires that assumptions must not be made about the format of
50373 * the values, e.g. the assumption that a release may contain three
50374 * digits or anything else returned by this function.
50375 *
50376 * @return array
50377 * @since PHP 4, PHP 5
50378 **/
50379function posix_uname(){}
50380
50381/**
50382 * Returns {@link base} raised to the power of {@link exp}.
50383 *
50384 * @param number $base The base to use
50385 * @param number $exp The exponent
50386 * @return number
50387 * @since PHP 4, PHP 5
50388 **/
50389function pow($base, $exp){}
50390
50391/**
50392 * {@link preg_filter} is identical to {@link preg_replace} except it
50393 * only returns the matches. For details about how this function works,
50394 * read the {@link preg_replace} documentation.
50395 *
50396 * @param mixed $pattern
50397 * @param mixed $replacement
50398 * @param mixed $subject
50399 * @param int $limit
50400 * @param int $count
50401 * @return mixed
50402 * @since PHP 5 >= 5.3.0
50403 **/
50404function preg_filter($pattern, $replacement, $subject, $limit, &$count){}
50405
50406/**
50407 * Returns the array consisting of the elements of the {@link input}
50408 * array that match the given {@link pattern}.
50409 *
50410 * @param string $pattern The pattern to search for, as a string.
50411 * @param array $input The input array.
50412 * @param int $flags If set to PREG_GREP_INVERT, this function returns
50413 *   the elements of the input array that do not match the given {@link
50414 *   pattern}.
50415 * @return array
50416 * @since PHP 4, PHP 5
50417 **/
50418function preg_grep($pattern, $input, $flags){}
50419
50420/**
50421 * Returns the error code of the last PCRE regex execution.
50422 *
50423 * {@link preg_last_error} example
50424 *
50425 * <?php
50426 *
50427 * preg_match('/(?:\D+|<\d+>)*[!?]/', 'foobar foobar foobar');
50428 *
50429 * if (preg_last_error() == PREG_BACKTRACK_LIMIT_ERROR) { print
50430 * 'Backtrack limit was exhausted!'; }
50431 *
50432 * ?>
50433 *
50434 * Backtrack limit was exhausted!
50435 *
50436 * @return int
50437 * @since PHP 5 >= 5.2.0
50438 **/
50439function preg_last_error(){}
50440
50441/**
50442 * Searches {@link subject} for a match to the regular expression given
50443 * in {@link pattern}.
50444 *
50445 * @param string $pattern The pattern to search for, as a string.
50446 * @param string $subject The input string.
50447 * @param array $matches If {@link matches} is provided, then it is
50448 *   filled with the results of search. $matches[0] will contain the text
50449 *   that matched the full pattern, $matches[1] will have the text that
50450 *   matched the first captured parenthesized subpattern, and so on.
50451 * @param int $flags {@link flags} can be the following flag:
50452 *   PREG_OFFSET_CAPTURE If this flag is passed, for every occurring
50453 *   match the appendant string offset will also be returned. Note that
50454 *   this changes the value of {@link matches} into an array where every
50455 *   element is an array consisting of the matched string at offset 0 and
50456 *   its string offset into {@link subject} at offset 1.
50457 * @param int $offset
50458 * @return int
50459 * @since PHP 4, PHP 5
50460 **/
50461function preg_match($pattern, $subject, &$matches, $flags, $offset){}
50462
50463/**
50464 * Searches {@link subject} for all matches to the regular expression
50465 * given in {@link pattern} and puts them in {@link matches} in the order
50466 * specified by {@link flags}.
50467 *
50468 * After the first match is found, the subsequent searches are continued
50469 * on from end of the last match.
50470 *
50471 * @param string $pattern The pattern to search for, as a string.
50472 * @param string $subject The input string.
50473 * @param array $matches Array of all matches in multi-dimensional
50474 *   array ordered according to {@link flags}.
50475 * @param int $flags Can be a combination of the following flags (note
50476 *   that it doesn't make sense to use PREG_PATTERN_ORDER together with
50477 *   PREG_SET_ORDER): PREG_PATTERN_ORDER Orders results so that
50478 *   $matches[0] is an array of full pattern matches, $matches[1] is an
50479 *   array of strings matched by the first parenthesized subpattern, and
50480 *   so on.
50481 *
50482 *   <?php preg_match_all("|<[^>]+>(.*)</[^>]+>|U", "<b>example: </b><div
50483 *   align=left>this is a test</div>", $out, PREG_PATTERN_ORDER); echo
50484 *   $out[0][0] . ", " . $out[0][1] . "\n"; echo $out[1][0] . ", " .
50485 *   $out[1][1] . "\n"; ?>
50486 *
50487 *   <b>example: </b>, <div align=left>this is a test</div> example: ,
50488 *   this is a test
50489 *
50490 *   So, $out[0] contains array of strings that matched full pattern, and
50491 *   $out[1] contains array of strings enclosed by tags. PREG_SET_ORDER
50492 *   Orders results so that $matches[0] is an array of first set of
50493 *   matches, $matches[1] is an array of second set of matches, and so
50494 *   on.
50495 *
50496 *   <?php preg_match_all("|<[^>]+>(.*)</[^>]+>|U", "<b>example: </b><div
50497 *   align=\"left\">this is a test</div>", $out, PREG_SET_ORDER); echo
50498 *   $out[0][0] . ", " . $out[0][1] . "\n"; echo $out[1][0] . ", " .
50499 *   $out[1][1] . "\n"; ?>
50500 *
50501 *   <b>example: </b>, example: <div align="left">this is a test</div>,
50502 *   this is a test
50503 *
50504 *   PREG_OFFSET_CAPTURE If this flag is passed, for every occurring
50505 *   match the appendant string offset will also be returned. Note that
50506 *   this changes the value of {@link matches} into an array where every
50507 *   element is an array consisting of the matched string at offset 0 and
50508 *   its string offset into {@link subject} at offset 1. If no order flag
50509 *   is given, PREG_PATTERN_ORDER is assumed.
50510 * @param int $offset Orders results so that $matches[0] is an array of
50511 *   full pattern matches, $matches[1] is an array of strings matched by
50512 *   the first parenthesized subpattern, and so on.
50513 *
50514 *   <?php preg_match_all("|<[^>]+>(.*)</[^>]+>|U", "<b>example: </b><div
50515 *   align=left>this is a test</div>", $out, PREG_PATTERN_ORDER); echo
50516 *   $out[0][0] . ", " . $out[0][1] . "\n"; echo $out[1][0] . ", " .
50517 *   $out[1][1] . "\n"; ?>
50518 *
50519 *   <b>example: </b>, <div align=left>this is a test</div> example: ,
50520 *   this is a test
50521 *
50522 *   So, $out[0] contains array of strings that matched full pattern, and
50523 *   $out[1] contains array of strings enclosed by tags.
50524 * @return int
50525 * @since PHP 4, PHP 5
50526 **/
50527function preg_match_all($pattern, $subject, &$matches, $flags, $offset){}
50528
50529/**
50530 * {@link preg_quote} takes {@link str} and puts a backslash in front of
50531 * every character that is part of the regular expression syntax. This is
50532 * useful if you have a run-time string that you need to match in some
50533 * text and the string may contain special regex characters.
50534 *
50535 * The special regular expression characters are: . \ + * ? [ ^ ] $ ( ) {
50536 * } = ! < > | : -
50537 *
50538 * @param string $str The input string.
50539 * @param string $delimiter If the optional {@link delimiter} is
50540 *   specified, it will also be escaped. This is useful for escaping the
50541 *   delimiter that is required by the PCRE functions. The / is the most
50542 *   commonly used delimiter.
50543 * @return string
50544 * @since PHP 4, PHP 5
50545 **/
50546function preg_quote($str, $delimiter){}
50547
50548/**
50549 * Searches {@link subject} for matches to {@link pattern} and replaces
50550 * them with {@link replacement}.
50551 *
50552 * @param mixed $pattern The pattern to search for. It can be either a
50553 *   string or an array with strings. The e modifier makes {@link
50554 *   preg_replace} treat the {@link replacement} parameter as PHP code
50555 *   after the appropriate references substitution is done. Tip: make
50556 *   sure that {@link replacement} constitutes a valid PHP code string,
50557 *   otherwise PHP will complain about a parse error at the line
50558 *   containing {@link preg_replace}.
50559 * @param mixed $replacement The string or an array with strings to
50560 *   replace. If this parameter is a string and the {@link pattern}
50561 *   parameter is an array, all patterns will be replaced by that string.
50562 *   If both {@link pattern} and {@link replacement} parameters are
50563 *   arrays, each {@link pattern} will be replaced by the {@link
50564 *   replacement} counterpart. If there are fewer elements in the {@link
50565 *   replacement} array than in the {@link pattern} array, any extra
50566 *   {@link pattern}s will be replaced by an empty string. {@link
50567 *   replacement} may contain references of the form \\n or (since PHP
50568 *   4.0.4) $n, with the latter form being the preferred one. Every such
50569 *   reference will be replaced by the text captured by the n'th
50570 *   parenthesized pattern. n can be from 0 to 99, and \\0 or $0 refers
50571 *   to the text matched by the whole pattern. Opening parentheses are
50572 *   counted from left to right (starting from 1) to obtain the number of
50573 *   the capturing subpattern. To use backslash in replacement, it must
50574 *   be doubled ("\\\\" PHP string). When working with a replacement
50575 *   pattern where a backreference is immediately followed by another
50576 *   number (i.e.: placing a literal number immediately after a matched
50577 *   pattern), you cannot use the familiar \\1 notation for your
50578 *   backreference. \\11, for example, would confuse {@link preg_replace}
50579 *   since it does not know whether you want the \\1 backreference
50580 *   followed by a literal 1, or the \\11 backreference followed by
50581 *   nothing. In this case the solution is to use \${1}1. This creates an
50582 *   isolated $1 backreference, leaving the 1 as a literal. When using
50583 *   the e modifier, this function escapes some characters (namely ', ",
50584 *   \ and NULL) in the strings that replace the backreferences. This is
50585 *   done to ensure that no syntax errors arise from backreference usage
50586 *   with either single or double quotes (e.g.
50587 *   'strlen(\'$1\')+strlen("$2")'). Make sure you are aware of PHP's
50588 *   string syntax to know exactly how the interpreted string will look
50589 *   like.
50590 * @param mixed $subject The string or an array with strings to search
50591 *   and replace. If {@link subject} is an array, then the search and
50592 *   replace is performed on every entry of {@link subject}, and the
50593 *   return value is an array as well.
50594 * @param int $limit The maximum possible replacements for each pattern
50595 *   in each {@link subject} string. Defaults to -1 (no limit).
50596 * @param int $count If specified, this variable will be filled with
50597 *   the number of replacements done.
50598 * @return mixed
50599 * @since PHP 4, PHP 5
50600 **/
50601function preg_replace($pattern, $replacement, $subject, $limit, &$count){}
50602
50603/**
50604 * The behavior of this function is almost identical to {@link
50605 * preg_replace}, except for the fact that instead of {@link replacement}
50606 * parameter, one should specify a {@link callback}.
50607 *
50608 * @param mixed $pattern The pattern to search for. It can be either a
50609 *   string or an array with strings.
50610 * @param callback $callback A callback that will be called and passed
50611 *   an array of matched elements in the {@link subject} string. The
50612 *   callback should return the replacement string. You'll often need the
50613 *   {@link callback} function for a {@link preg_replace_callback} in
50614 *   just one place. In this case you can use an anonymous function
50615 *   (since PHP 5.3.0) or {@link create_function} to declare an anonymous
50616 *   function as callback within the call to {@link
50617 *   preg_replace_callback}. By doing it this way you have all
50618 *   information for the call in one place and do not clutter the
50619 *   function namespace with a callback function's name not used anywhere
50620 *   else.
50621 *
50622 *   {@link preg_replace_callback} and {@link create_function}
50623 *
50624 *   <?php /* a unix-style command line filter to convert uppercase *
50625 *   letters at the beginning of paragraphs to lowercase * / $fp =
50626 *   fopen("php://stdin", "r") or die("can't read stdin"); while
50627 *   (!feof($fp)) { $line = fgets($fp); $line = preg_replace_callback(
50628 *   '|<p>\s*\w|', create_function( // single quotes are essential here,
50629 *   // or alternative escape all $ as \$ '$matches', 'return
50630 *   strtolower($matches[0]);' ), $line ); echo $line; } fclose($fp); ?>
50631 * @param mixed $subject The string or an array with strings to search
50632 *   and replace.
50633 * @param int $limit The maximum possible replacements for each pattern
50634 *   in each {@link subject} string. Defaults to -1 (no limit).
50635 * @param int $count If specified, this variable will be filled with
50636 *   the number of replacements done.
50637 * @return mixed
50638 * @since PHP 4 >= 4.0.5, PHP 5
50639 **/
50640function preg_replace_callback($pattern, $callback, $subject, $limit, &$count){}
50641
50642/**
50643 * Split the given string by a regular expression.
50644 *
50645 * @param string $pattern The pattern to search for, as a string.
50646 * @param string $subject The input string.
50647 * @param int $limit If specified, then only substrings up to {@link
50648 *   limit} are returned with the rest of the string being placed in the
50649 *   last substring. A {@link limit} of -1, 0 or null means "no limit"
50650 *   and, as is standard across PHP, you can use null to skip to the
50651 *   {@link flags} parameter.
50652 * @param int $flags {@link flags} can be any combination of the
50653 *   following flags (combined with the | bitwise operator):
50654 *   PREG_SPLIT_NO_EMPTY If this flag is set, only non-empty pieces will
50655 *   be returned by {@link preg_split}. PREG_SPLIT_DELIM_CAPTURE If this
50656 *   flag is set, parenthesized expression in the delimiter pattern will
50657 *   be captured and returned as well. PREG_SPLIT_OFFSET_CAPTURE If this
50658 *   flag is set, for every occurring match the appendant string offset
50659 *   will also be returned. Note that this changes the return value in an
50660 *   array where every element is an array consisting of the matched
50661 *   string at offset 0 and its string offset into {@link subject} at
50662 *   offset 1.
50663 * @return array
50664 * @since PHP 4, PHP 5
50665 **/
50666function preg_split($pattern, $subject, $limit, $flags){}
50667
50668/**
50669 * Rewind the internal array pointer.
50670 *
50671 * {@link prev} behaves just like {@link next}, except it rewinds the
50672 * internal array pointer one place instead of advancing it.
50673 *
50674 * @param array $array The input array.
50675 * @return mixed
50676 * @since PHP 4, PHP 5
50677 **/
50678function prev(&$array){}
50679
50680/**
50681 * This function deletes the printers spool file.
50682 *
50683 * @param resource $printer_handle {@link printer_handle} must be a
50684 *   valid handle to a printer.
50685 * @return void
50686 **/
50687function printer_abort($printer_handle){}
50688
50689/**
50690 * This function closes the printer connection. {@link printer_close}
50691 * also closes the active device context.
50692 *
50693 * @param resource $printer_handle {@link printer_handle} must be a
50694 *   valid handle to a printer.
50695 * @return void
50696 **/
50697function printer_close($printer_handle){}
50698
50699/**
50700 * The function creates a new brush and returns a handle to it. A brush
50701 * is used to fill shapes. For an example see {@link
50702 * printer_select_brush}.
50703 *
50704 * @param int $style {@link style} must be one of the following
50705 *   constants: PRINTER_BRUSH_SOLID: creates a brush with a solid color.
50706 *   PRINTER_BRUSH_DIAGONAL: creates a brush with a 45-degree upward
50707 *   left-to-right hatch ( / ). PRINTER_BRUSH_CROSS: creates a brush with
50708 *   a cross hatch ( + ). PRINTER_BRUSH_DIAGCROSS: creates a brush with a
50709 *   45 cross hatch ( x ). PRINTER_BRUSH_FDIAGONAL: creates a brush with
50710 *   a 45-degree downward left-to-right hatch ( \ ).
50711 *   PRINTER_BRUSH_HORIZONTAL: creates a brush with a horizontal hatch (
50712 *   - ). PRINTER_BRUSH_VERTICAL: creates a brush with a vertical hatch (
50713 *   | ). PRINTER_BRUSH_CUSTOM: creates a custom brush from an BMP file.
50714 *   The second parameter is used to specify the BMP instead of the RGB
50715 *   color code.
50716 * @param string $color {@link color} must be a color in RGB hex
50717 *   format, i.e. "000000" for black.
50718 * @return resource
50719 **/
50720function printer_create_brush($style, $color){}
50721
50722/**
50723 * The function creates a new device context. A device context is used to
50724 * customize the graphic objects of the document.
50725 *
50726 * @param resource $printer_handle {@link printer_handle} must be a
50727 *   valid printer handle.
50728 * @return void
50729 **/
50730function printer_create_dc($printer_handle){}
50731
50732/**
50733 * The function creates a new font and returns a handle to it. A font is
50734 * used to draw text. For an example see {@link printer_select_font}.
50735 *
50736 * @param string $face {@link face} must be a string specifying the
50737 *   font face.
50738 * @param int $height {@link height} specifies the font height.
50739 * @param int $width {@link width} specifies the font width.
50740 * @param int $font_weight The {@link font_weight} specifies the font
50741 *   weight (400 is normal), and can be one of the following predefined
50742 *   constants. PRINTER_FW_THIN: sets the font weight to thin (100).
50743 *   PRINTER_FW_ULTRALIGHT: sets the font weight to ultra light (200).
50744 *   PRINTER_FW_LIGHT: sets the font weight to light (300).
50745 *   PRINTER_FW_NORMAL: sets the font weight to normal (400).
50746 *   PRINTER_FW_MEDIUM: sets the font weight to medium (500).
50747 *   PRINTER_FW_BOLD: sets the font weight to bold (700).
50748 *   PRINTER_FW_ULTRABOLD: sets the font weight to ultra bold (800).
50749 *   PRINTER_FW_HEAVY: sets the font weight to heavy (900).
50750 * @param bool $italic {@link italic} can be or , and sets whether the
50751 *   font should be italic.
50752 * @param bool $underline {@link underline} can be or , and sets
50753 *   whether the font should be underlined.
50754 * @param bool $strikeout {@link strikeout} can be or , and sets
50755 *   whether the font should be stroked out.
50756 * @param int $orientation {@link orientation} specifies a rotation.
50757 * @return resource
50758 **/
50759function printer_create_font($face, $height, $width, $font_weight, $italic, $underline, $strikeout, $orientation){}
50760
50761/**
50762 * The function creates a new pen and returns a handle to it. A pen is
50763 * used to draw lines and curves. For an example see {@link
50764 * printer_select_pen}.
50765 *
50766 * @param int $style {@link style} must be one of the following
50767 *   constants: PRINTER_PEN_SOLID: creates a solid pen. PRINTER_PEN_DASH:
50768 *   creates a dashed pen. PRINTER_PEN_DOT: creates a dotted pen.
50769 *   PRINTER_PEN_DASHDOT: creates a pen with dashes and dots.
50770 *   PRINTER_PEN_DASHDOTDOT: creates a pen with dashes and double dots.
50771 *   PRINTER_PEN_INVISIBLE: creates an invisible pen.
50772 * @param int $width {@link width} specifies the width of the pen.
50773 * @param string $color {@link color} must be a color in RGB hex
50774 *   format, i.e. "000000" for black.
50775 * @return resource
50776 **/
50777function printer_create_pen($style, $width, $color){}
50778
50779/**
50780 * The function deletes the selected brush. For an example see {@link
50781 * printer_select_brush}.
50782 *
50783 * @param resource $brush_handle {@link brush_handle} must be a valid
50784 *   handle to a brush.
50785 * @return void
50786 **/
50787function printer_delete_brush($brush_handle){}
50788
50789/**
50790 * The function deletes the device context. For an example see {@link
50791 * printer_create_dc}.
50792 *
50793 * @param resource $printer_handle {@link printer_handle} must be a
50794 *   valid printer handle.
50795 * @return bool
50796 **/
50797function printer_delete_dc($printer_handle){}
50798
50799/**
50800 * The function deletes the selected font. For an example see {@link
50801 * printer_select_font}.
50802 *
50803 * @param resource $font_handle {@link font_handle} must be a valid
50804 *   handle to a font.
50805 * @return void
50806 **/
50807function printer_delete_font($font_handle){}
50808
50809/**
50810 * The function deletes the selected pen. For an example see {@link
50811 * printer_select_pen}.
50812 *
50813 * @param resource $pen_handle {@link pen_handle} must be a valid pen
50814 *   handle.
50815 * @return void
50816 **/
50817function printer_delete_pen($pen_handle){}
50818
50819/**
50820 * The function draws an bmp.
50821 *
50822 * @param resource $printer_handle {@link printer_handle} must be a
50823 *   valid printer handle.
50824 * @param string $filename Path to the bitmap.
50825 * @param int $x {@link x} is the upper left x coordinate of the
50826 *   bitmap.
50827 * @param int $y {@link y} is the upper left y coordinate of the
50828 *   bitmap.
50829 * @param int $width The bitmap width.
50830 * @param int $height The bitmap height.
50831 * @return bool
50832 **/
50833function printer_draw_bmp($printer_handle, $filename, $x, $y, $width, $height){}
50834
50835/**
50836 * The function simply draws an chord.
50837 *
50838 * @param resource $printer_handle {@link printer_handle} must be a
50839 *   valid printer handle.
50840 * @param int $rec_x {@link rec_x} is the upper left x coordinate of
50841 *   the bounding rectangle.
50842 * @param int $rec_y {@link rec_y} is the upper left y coordinate of
50843 *   the bounding rectangle.
50844 * @param int $rec_x1 {@link rec_x1} is the lower right x coordinate of
50845 *   the bounding rectangle.
50846 * @param int $rec_y1 {@link rec_y1} is the lower right y coordinate of
50847 *   the bounding rectangle.
50848 * @param int $rad_x {@link rad_x} is x coordinate of the radial
50849 *   defining the beginning of the chord.
50850 * @param int $rad_y {@link rad_y} is y coordinate of the radial
50851 *   defining the beginning of the chord.
50852 * @param int $rad_x1 {@link rad_x1} is x coordinate of the radial
50853 *   defining the end of the chord.
50854 * @param int $rad_y1 {@link rad_y1} is y coordinate of the radial
50855 *   defining the end of the chord.
50856 * @return void
50857 **/
50858function printer_draw_chord($printer_handle, $rec_x, $rec_y, $rec_x1, $rec_y1, $rad_x, $rad_y, $rad_x1, $rad_y1){}
50859
50860/**
50861 * The function draws an ellipse.
50862 *
50863 * @param resource $printer_handle {@link printer_handle} must be a
50864 *   valid printer handle.
50865 * @param int $ul_x {@link ul_x} is the upper left x coordinate of the
50866 *   ellipse.
50867 * @param int $ul_y {@link ul_y} is the upper left y coordinate of the
50868 *   ellipse.
50869 * @param int $lr_x {@link lr_x} is the lower right x coordinate of the
50870 *   ellipse.
50871 * @param int $lr_y {@link lr_y} is the lower right y coordinate of the
50872 *   ellipse.
50873 * @return void
50874 **/
50875function printer_draw_elipse($printer_handle, $ul_x, $ul_y, $lr_x, $lr_y){}
50876
50877/**
50878 * The function draws a line using the selected pen.
50879 *
50880 * @param resource $printer_handle {@link printer_handle} must be a
50881 *   valid printer handle.
50882 * @param int $from_x {@link from_x} is the x coordinate of the origin
50883 *   point.
50884 * @param int $from_y {@link from_y} is the y coordinate of the origin
50885 *   point.
50886 * @param int $to_x {@link to_x} is the x coordinate of the destination
50887 *   point.
50888 * @param int $to_y {@link to_y} is the y coordinate of the destination
50889 *   point.
50890 * @return void
50891 **/
50892function printer_draw_line($printer_handle, $from_x, $from_y, $to_x, $to_y){}
50893
50894/**
50895 * The function draws an pie.
50896 *
50897 * @param resource $printer_handle {@link printer_handle} must be a
50898 *   valid printer handle.
50899 * @param int $rec_x {@link rec_x} is the upper left x coordinate of
50900 *   the bounding rectangle.
50901 * @param int $rec_y {@link rec_y} is the upper left y coordinate of
50902 *   the bounding rectangle.
50903 * @param int $rec_x1 {@link rec_x1} is the lower right x coordinate of
50904 *   the bounding rectangle.
50905 * @param int $rec_y1 {@link rec_y1} is the lower right y coordinate of
50906 *   the bounding rectangle.
50907 * @param int $rad1_x {@link rad1_x} is x coordinate of the first
50908 *   radial's ending.
50909 * @param int $rad1_y {@link rad1_y} is y coordinate of the first
50910 *   radial's ending.
50911 * @param int $rad2_x {@link rad2_x} is x coordinate of the second
50912 *   radial's ending.
50913 * @param int $rad2_y {@link rad2_y} is y coordinate of the second
50914 *   radial's ending.
50915 * @return void
50916 **/
50917function printer_draw_pie($printer_handle, $rec_x, $rec_y, $rec_x1, $rec_y1, $rad1_x, $rad1_y, $rad2_x, $rad2_y){}
50918
50919/**
50920 * The function draws a rectangle.
50921 *
50922 * @param resource $printer_handle {@link printer_handle} must be a
50923 *   valid printer handle.
50924 * @param int $ul_x {@link ul_x} is the upper left x coordinate of the
50925 *   rectangle.
50926 * @param int $ul_y {@link ul_y} is the upper left y coordinate of the
50927 *   rectangle.
50928 * @param int $lr_x {@link lr_x} is the lower right x coordinate of the
50929 *   rectangle.
50930 * @param int $lr_y {@link lr_y} is the lower right y coordinate of the
50931 *   rectangle.
50932 * @return void
50933 **/
50934function printer_draw_rectangle($printer_handle, $ul_x, $ul_y, $lr_x, $lr_y){}
50935
50936/**
50937 * The function draws a rectangle with rounded corners.
50938 *
50939 * @param resource $printer_handle {@link printer_handle} must be a
50940 *   valid printer handle.
50941 * @param int $ul_x {@link ul_x} is the upper left x coordinate of the
50942 *   rectangle.
50943 * @param int $ul_y {@link ul_y} is the upper left y coordinate of the
50944 *   rectangle.
50945 * @param int $lr_x {@link lr_x} is the lower right x coordinate of the
50946 *   rectangle.
50947 * @param int $lr_y {@link lr_y} is the lower right y coordinate of the
50948 *   rectangle.
50949 * @param int $width {@link width} is the width of the ellipse.
50950 * @param int $height {@link height} is the height of the ellipse.
50951 * @return void
50952 **/
50953function printer_draw_roundrect($printer_handle, $ul_x, $ul_y, $lr_x, $lr_y, $width, $height){}
50954
50955/**
50956 * The function draws {@link text} at position {@link x}, {@link y} using
50957 * the selected font.
50958 *
50959 * @param resource $printer_handle {@link printer_handle} must be a
50960 *   valid handle to a printer.
50961 * @param string $text The text to be written.
50962 * @param int $x {@link x} is the x coordinate of the position.
50963 * @param int $y {@link y} is the y coordinate of the position.
50964 * @return void
50965 **/
50966function printer_draw_text($printer_handle, $text, $x, $y){}
50967
50968/**
50969 * Closes a new document in the printer spooler. The document is now
50970 * ready for printing. For an example see {@link printer_start_doc}.
50971 *
50972 * @param resource $printer_handle {@link printer_handle} must be a
50973 *   valid handle to a printer.
50974 * @return bool
50975 **/
50976function printer_end_doc($printer_handle){}
50977
50978/**
50979 * The function closes the active page in the active document. For an
50980 * example see {@link printer_start_doc}.
50981 *
50982 * @param resource $printer_handle {@link printer_handle} must be a
50983 *   valid handle to a printer.
50984 * @return bool
50985 **/
50986function printer_end_page($printer_handle){}
50987
50988/**
50989 * The function retrieves the configuration setting of {@link option}.
50990 *
50991 * @param resource $printer_handle {@link printer_handle} must be a
50992 *   valid handle to a printer.
50993 * @param string $option Take a look at {@link printer_set_option} for
50994 *   the settings that can be retrieved, additionally the following
50995 *   settings can be retrieved: PRINTER_DEVICENAME returns the devicename
50996 *   of the printer. PRINTER_DRIVERVERSION returns the printer driver
50997 *   version.
50998 * @return mixed
50999 **/
51000function printer_get_option($printer_handle, $option){}
51001
51002/**
51003 * The function enumerates available printers and their capabilities.
51004 *
51005 * @param int $enumtype {@link enumtype} must be one of the following
51006 *   predefined constants: PRINTER_ENUM_LOCAL: enumerates the locally
51007 *   installed printers. PRINTER_ENUM_NAME: enumerates the printer of
51008 *   {@link name}, can be a server, domain or print provider.
51009 *   PRINTER_ENUM_SHARED: this parameter can't be used alone, it has to
51010 *   be OR'ed with other parameters, i.e. PRINTER_ENUM_LOCAL to detect
51011 *   the locally shared printers. PRINTER_ENUM_DEFAULT: (Win9.x only)
51012 *   enumerates the default printer. PRINTER_ENUM_CONNECTIONS:
51013 *   (WinNT/2000 only) enumerates the printers to which the user has made
51014 *   connections. PRINTER_ENUM_NETWORK: (WinNT/2000 only) enumerates
51015 *   network printers in the computer's domain. Only valid if {@link
51016 *   level} is 1. PRINTER_ENUM_REMOTE: (WinNT/2000 only) enumerates
51017 *   network printers and print servers in the computer's domain. Only
51018 *   valid if {@link level} is 1.
51019 * @param string $name Used with PRINTER_ENUM_NAME.
51020 * @param int $level {@link level} sets the level of information
51021 *   request. Can be 1,2,4 or 5.
51022 * @return array
51023 **/
51024function printer_list($enumtype, $name, $level){}
51025
51026/**
51027 * The function calculates the logical font height of {@link height}.
51028 *
51029 * @param resource $printer_handle {@link printer_handle} must be a
51030 *   valid printer handle.
51031 * @param int $height The font height.
51032 * @return int
51033 **/
51034function printer_logical_fontheight($printer_handle, $height){}
51035
51036/**
51037 * This function tries to open a connection to the given printer.
51038 *
51039 * {@link printer_open} also starts a device context.
51040 *
51041 * @param string $printername The printer name. If no parameter was
51042 *   given it tries to open a connection to the default printer (if not
51043 *   specified in as printer.default_printer, PHP tries to detect it).
51044 * @return resource
51045 **/
51046function printer_open($printername){}
51047
51048/**
51049 * The function selects a brush as the active drawing object of the
51050 * actual device context. A brush is used to fill shapes. If you draw an
51051 * rectangle the brush is used to draw the shapes, while the pen is used
51052 * to draw the border.
51053 *
51054 * If you haven't selected a brush before drawing shapes, the shape won't
51055 * be filled.
51056 *
51057 * @param resource $printer_handle {@link printer_handle} must be a
51058 *   valid printer handle.
51059 * @param resource $brush_handle {@link brush_handle} must be a valid
51060 *   brush handle.
51061 * @return void
51062 **/
51063function printer_select_brush($printer_handle, $brush_handle){}
51064
51065/**
51066 * The function selects a font to draw text.
51067 *
51068 * @param resource $printer_handle {@link printer_handle} must be a
51069 *   valid printer handle.
51070 * @param resource $font_handle {@link font_handle} must be a valid
51071 *   font handle.
51072 * @return void
51073 **/
51074function printer_select_font($printer_handle, $font_handle){}
51075
51076/**
51077 * The function selects a pen as the active drawing object of the actual
51078 * device context. A pen is used to draw lines and curves. I.e. if you
51079 * draw a single line the pen is used. If you draw an rectangle the pen
51080 * is used to draw the borders, while the brush is used to fill the
51081 * shape. If you haven't selected a pen before drawing shapes, the shape
51082 * won't be outlined.
51083 *
51084 * @param resource $printer_handle {@link printer_handle} must be a
51085 *   valid printer handle.
51086 * @param resource $pen_handle {@link pen_handle} must be a valid pen
51087 *   handle.
51088 * @return void
51089 **/
51090function printer_select_pen($printer_handle, $pen_handle){}
51091
51092/**
51093 * The function sets options for the current connection.
51094 *
51095 * @param resource $printer_handle {@link printer_handle} must be a
51096 *   valid printer handle.
51097 * @param int $option Option can be one of the following constants:
51098 *   PRINTER_COPIES: sets how many copies should be printed, {@link
51099 *   value} must be an integer. PRINTER_MODE: specifies the type of data
51100 *   (text, raw or emf), {@link value} must be a string. PRINTER_TITLE:
51101 *   specifies the name of the document, {@link value} must be a string.
51102 *   PRINTER_ORIENTATION: specifies the orientation of the paper, {@link
51103 *   value} can be either PRINTER_ORIENTATION_PORTRAIT or
51104 *   PRINTER_ORIENTATION_LANDSCAPE PRINTER_RESOLUTION_Y: specifies the
51105 *   y-resolution in DPI, {@link value} must be an integer.
51106 *   PRINTER_RESOLUTION_X: specifies the x-resolution in DPI, {@link
51107 *   value} must be an integer. PRINTER_PAPER_FORMAT: specifies a
51108 *   predefined paper format, set {@link value} to PRINTER_FORMAT_CUSTOM
51109 *   if you want to specify a custom format with PRINTER_PAPER_WIDTH and
51110 *   PRINTER_PAPER_LENGTH. {@link value} can be one of the following
51111 *   constants. PRINTER_FORMAT_CUSTOM: let's you specify a custom paper
51112 *   format. PRINTER_FORMAT_LETTER: specifies standard letter format (8
51113 *   1/2- by 11-inches). PRINTER_FORMAT_LEGAL: specifies standard legal
51114 *   format (8 1/2- by 14-inches). PRINTER_FORMAT_A3: specifies standard
51115 *   A3 format (297- by 420-millimeters). PRINTER_FORMAT_A4: specifies
51116 *   standard A4 format (210- by 297-millimeters). PRINTER_FORMAT_A5:
51117 *   specifies standard A5 format (148- by 210-millimeters).
51118 *   PRINTER_FORMAT_B4: specifies standard B4 format (250- by
51119 *   354-millimeters). PRINTER_FORMAT_B5: specifies standard B5 format
51120 *   (182- by 257-millimeter). PRINTER_FORMAT_FOLIO: specifies standard
51121 *   FOLIO format (8 1/2- by 13-inch). PRINTER_PAPER_LENGTH: if
51122 *   PRINTER_PAPER_FORMAT is set to PRINTER_FORMAT_CUSTOM,
51123 *   PRINTER_PAPER_LENGTH specifies a custom paper length in mm, {@link
51124 *   value} must be an integer. PRINTER_PAPER_WIDTH: if
51125 *   PRINTER_PAPER_FORMAT is set to PRINTER_FORMAT_CUSTOM,
51126 *   PRINTER_PAPER_WIDTH specifies a custom paper width in mm, {@link
51127 *   value} must be an integer. PRINTER_SCALE: specifies the factor by
51128 *   which the printed output is to be scaled. the page size is scaled
51129 *   from the physical page size by a factor of scale/100. for example if
51130 *   you set the scale to 50, the output would be half of its original
51131 *   size. {@link value} must be an integer. PRINTER_BACKGROUND_COLOR:
51132 *   specifies the background color for the actual device context, {@link
51133 *   value} must be a string containing the rgb information in hex format
51134 *   i.e. "005533". PRINTER_TEXT_COLOR: specifies the text color for the
51135 *   actual device context, {@link value} must be a string containing the
51136 *   rgb information in hex format i.e. "005533". PRINTER_TEXT_ALIGN:
51137 *   specifies the text alignment for the actual device context, {@link
51138 *   value} can be combined through OR'ing the following constants:
51139 *   PRINTER_TA_BASELINE: text will be aligned at the base line.
51140 *   PRINTER_TA_BOTTOM: text will be aligned at the bottom.
51141 *   PRINTER_TA_TOP: text will be aligned at the top. PRINTER_TA_CENTER:
51142 *   text will be aligned at the center. PRINTER_TA_LEFT: text will be
51143 *   aligned at the left. PRINTER_TA_RIGHT: text will be aligned at the
51144 *   right.
51145 * @param mixed $value The {@link option} value.
51146 * @return bool
51147 **/
51148function printer_set_option($printer_handle, $option, $value){}
51149
51150/**
51151 * The function creates a new document in the printer spooler. A document
51152 * can contain multiple pages, it's used to schedule the print job in the
51153 * spooler.
51154 *
51155 * @param resource $printer_handle {@link printer_handle} must be a
51156 *   valid printer handle.
51157 * @param string $document The optional parameter {@link document} can
51158 *   be used to set an alternative document name.
51159 * @return bool
51160 **/
51161function printer_start_doc($printer_handle, $document){}
51162
51163/**
51164 * The function creates a new page in the active document. For an example
51165 * see {@link printer_start_doc}.
51166 *
51167 * @param resource $printer_handle {@link printer_handle} must be a
51168 *   valid printer handle.
51169 * @return bool
51170 **/
51171function printer_start_page($printer_handle){}
51172
51173/**
51174 * Writes {@link content} directly to the printer.
51175 *
51176 * @param resource $printer_handle {@link printer_handle} must be a
51177 *   valid printer handle.
51178 * @param string $content The data to be written.
51179 * @return bool
51180 **/
51181function printer_write($printer_handle, $content){}
51182
51183/**
51184 * @param string $format See {@link sprintf} for a description of
51185 *   {@link format}.
51186 * @param mixed $args
51187 * @return int
51188 * @since PHP 4, PHP 5
51189 **/
51190function printf($format, $args){}
51191
51192/**
51193 * {@link print_r} displays information about a variable in a way that's
51194 * readable by humans.
51195 *
51196 * {@link print_r}, {@link var_dump} and {@link var_export} will also
51197 * show protected and private properties of objects with PHP 5. Static
51198 * class members will not be shown.
51199 *
51200 * Remember that {@link print_r} will move the array pointer to the end.
51201 * Use {@link reset} to bring it back to beginning.
51202 *
51203 * @param mixed $expression The expression to be printed.
51204 * @param bool $return If you would like to capture the output of
51205 *   {@link print_r}, use the {@link return} parameter. When this
51206 *   parameter is set to , {@link print_r} will return the information
51207 *   rather than print it.
51208 * @return mixed
51209 * @since PHP 4, PHP 5
51210 **/
51211function print_r($expression, $return){}
51212
51213/**
51214 * {@link proc_close} is similar to {@link pclose} except that it only
51215 * works on processes opened by {@link proc_open}. {@link proc_close}
51216 * waits for the process to terminate, and returns its exit code. If you
51217 * have open pipes to that process, you should {@link fclose} them prior
51218 * to calling this function in order to avoid a deadlock - the child
51219 * process may not be able to exit while the pipes are open.
51220 *
51221 * @param resource $process The {@link proc_open} resource that will be
51222 *   closed.
51223 * @return int
51224 * @since PHP 4 >= 4.3.0, PHP 5
51225 **/
51226function proc_close($process){}
51227
51228/**
51229 * {@link proc_get_status} fetches data about a process opened using
51230 * {@link proc_open}.
51231 *
51232 * @param resource $process The {@link proc_open} resource that will be
51233 *   evaluated.
51234 * @return array
51235 * @since PHP 5
51236 **/
51237function proc_get_status($process){}
51238
51239/**
51240 * {@link proc_nice} changes the priority of the current process by the
51241 * amount specified in {@link increment}. A positive {@link increment}
51242 * will lower the priority of the current process, whereas a negative
51243 * {@link increment} will raise the priority.
51244 *
51245 * {@link proc_nice} is not related to {@link proc_open} and its
51246 * associated functions in any way.
51247 *
51248 * @param int $increment The increment value of the priority change.
51249 * @return bool
51250 * @since PHP 5
51251 **/
51252function proc_nice($increment){}
51253
51254/**
51255 * {@link proc_open} is similar to {@link popen} but provides a much
51256 * greater degree of control over the program execution.
51257 *
51258 * @param string $cmd The command to execute
51259 * @param array $descriptorspec An indexed array where the key
51260 *   represents the descriptor number and the value represents how PHP
51261 *   will pass that descriptor to the child process. 0 is stdin, 1 is
51262 *   stdout, while 2 is stderr. Each element can be: An array describing
51263 *   the pipe to pass to the process. The first element is the descriptor
51264 *   type and the second element is an option for the given type. Valid
51265 *   types are pipe (the second element is either r to pass the read end
51266 *   of the pipe to the process, or w to pass the write end) and file
51267 *   (the second element is a filename). A stream resource representing a
51268 *   real file descriptor (e.g. opened file, a socket, STDIN). The file
51269 *   descriptor numbers are not limited to 0, 1 and 2 - you may specify
51270 *   any valid file descriptor number and it will be passed to the child
51271 *   process. This allows your script to interoperate with other scripts
51272 *   that run as "co-processes". In particular, this is useful for
51273 *   passing passphrases to programs like PGP, GPG and openssl in a more
51274 *   secure manner. It is also useful for reading status information
51275 *   provided by those programs on auxiliary file descriptors.
51276 * @param array $pipes Will be set to an indexed array of file pointers
51277 *   that correspond to PHP's end of any pipes that are created.
51278 * @param string $cwd The initial working dir for the command. This
51279 *   must be an absolute directory path, or if you want to use the
51280 *   default value (the working dir of the current PHP process)
51281 * @param array $env An array with the environment variables for the
51282 *   command that will be run, or to use the same environment as the
51283 *   current PHP process
51284 * @param array $other_options Allows you to specify additional
51285 *   options. Currently supported options include: suppress_errors
51286 *   (windows only): suppresses errors generated by this function when
51287 *   it's set to bypass_shell (windows only): bypass cmd.exe shell when
51288 *   set to context: stream context used when opening files (created with
51289 *   {@link stream_context_create}) binary_pipes: open pipes in binary
51290 *   mode, instead of using the usual stream_encoding
51291 * @return resource
51292 * @since PHP 4 >= 4.3.0, PHP 5
51293 **/
51294function proc_open($cmd, $descriptorspec, &$pipes, $cwd, $env, $other_options){}
51295
51296/**
51297 * Signals a {@link process} (created using {@link proc_open}) that it
51298 * should terminate. {@link proc_terminate} returns immediately and does
51299 * not wait for the process to terminate.
51300 *
51301 * {@link proc_terminate} allows you terminate the process and continue
51302 * with other tasks. You may poll the process (to see if it has stopped
51303 * yet) by using the {@link proc_get_status} function.
51304 *
51305 * @param resource $process The {@link proc_open} resource that will be
51306 *   closed.
51307 * @param int $signal This optional parameter is only useful on POSIX
51308 *   operating systems; you may specify a signal to send to the process
51309 *   using the kill(2) system call. The default is SIGTERM.
51310 * @return bool
51311 * @since PHP 5
51312 **/
51313function proc_terminate($process, $signal){}
51314
51315/**
51316 * This function checks if the given {@link property} exists in the
51317 * specified class.
51318 *
51319 * @param mixed $class The class name or an object of the class to test
51320 *   for
51321 * @param string $property The name of the property
51322 * @return bool
51323 * @since PHP 5 >= 5.1.0
51324 **/
51325function property_exists($class, $property){}
51326
51327/**
51328 * @param int $dictionary_link
51329 * @param string $word The added word.
51330 * @return bool
51331 * @since PHP 4 >= 4.0.2, PHP 5
51332 **/
51333function pspell_add_to_personal($dictionary_link, $word){}
51334
51335/**
51336 * @param int $dictionary_link
51337 * @param string $word The added word.
51338 * @return bool
51339 * @since PHP 4 >= 4.0.2, PHP 5
51340 **/
51341function pspell_add_to_session($dictionary_link, $word){}
51342
51343/**
51344 * @param int $dictionary_link
51345 * @param string $word The tested word.
51346 * @return bool
51347 * @since PHP 4 >= 4.0.2, PHP 5
51348 **/
51349function pspell_check($dictionary_link, $word){}
51350
51351/**
51352 * @param int $dictionary_link
51353 * @return bool
51354 * @since PHP 4 >= 4.0.2, PHP 5
51355 **/
51356function pspell_clear_session($dictionary_link){}
51357
51358/**
51359 * Create a config used to open a dictionary.
51360 *
51361 * {@link pspell_config_create} has a very similar syntax to {@link
51362 * pspell_new}. In fact, using {@link pspell_config_create} immediately
51363 * followed by {@link pspell_new_config} will produce the exact same
51364 * result. However, after creating a new config, you can also use {@link
51365 * pspell_config_*} functions before calling {@link pspell_new_config} to
51366 * take advantage of some advanced functionality.
51367 *
51368 * For more information and examples, check out inline manual pspell
51369 * website:.
51370 *
51371 * @param string $language The language parameter is the language code
51372 *   which consists of the two letter ISO 639 language code and an
51373 *   optional two letter ISO 3166 country code after a dash or
51374 *   underscore.
51375 * @param string $spelling The spelling parameter is the requested
51376 *   spelling for languages with more than one spelling such as English.
51377 *   Known values are 'american', 'british', and 'canadian'.
51378 * @param string $jargon The jargon parameter contains extra
51379 *   information to distinguish two different words lists that have the
51380 *   same language and spelling parameters.
51381 * @param string $encoding The encoding parameter is the encoding that
51382 *   words are expected to be in. Valid values are 'utf-8', 'iso8859-*',
51383 *   'koi8-r', 'viscii', 'cp1252', 'machine unsigned 16', 'machine
51384 *   unsigned 32'. This parameter is largely untested, so be careful when
51385 *   using.
51386 * @return int
51387 * @since PHP 4 >= 4.0.2, PHP 5
51388 **/
51389function pspell_config_create($language, $spelling, $jargon, $encoding){}
51390
51391/**
51392 * @param int $conf
51393 * @param string $directory
51394 * @return bool
51395 * @since PHP 5
51396 **/
51397function pspell_config_data_dir($conf, $directory){}
51398
51399/**
51400 * @param int $conf
51401 * @param string $directory
51402 * @return bool
51403 * @since PHP 5
51404 **/
51405function pspell_config_dict_dir($conf, $directory){}
51406
51407/**
51408 * @param int $dictionary_link
51409 * @param int $n Words less than {@link n} characters will be skipped.
51410 * @return bool
51411 * @since PHP 4 >= 4.0.2, PHP 5
51412 **/
51413function pspell_config_ignore($dictionary_link, $n){}
51414
51415/**
51416 * @param int $dictionary_link
51417 * @param int $mode The mode parameter is the mode in which
51418 *   spellchecker will work. There are several modes available:
51419 *   PSPELL_FAST - Fast mode (least number of suggestions) PSPELL_NORMAL
51420 *   - Normal mode (more suggestions) PSPELL_BAD_SPELLERS - Slow mode (a
51421 *   lot of suggestions)
51422 * @return bool
51423 * @since PHP 4 >= 4.0.2, PHP 5
51424 **/
51425function pspell_config_mode($dictionary_link, $mode){}
51426
51427/**
51428 * Set a file that contains personal wordlist. The personal wordlist will
51429 * be loaded and used in addition to the standard one after you call
51430 * {@link pspell_new_config}. The file is also the file where {@link
51431 * pspell_save_wordlist} will save personal wordlist to.
51432 *
51433 * {@link pspell_config_personal} should be used on a config before
51434 * calling {@link pspell_new_config}.
51435 *
51436 * @param int $dictionary_link
51437 * @param string $file The personal wordlist. If the file does not
51438 *   exist, it will be created. The file should be writable by whoever
51439 *   PHP runs as (e.g. nobody).
51440 * @return bool
51441 * @since PHP 4 >= 4.0.2, PHP 5
51442 **/
51443function pspell_config_personal($dictionary_link, $file){}
51444
51445/**
51446 * Set a file that contains replacement pairs.
51447 *
51448 * The replacement pairs improve the quality of the spellchecker. When a
51449 * word is misspelled, and a proper suggestion was not found in the list,
51450 * {@link pspell_store_replacement} can be used to store a replacement
51451 * pair and then {@link pspell_save_wordlist} to save the wordlist along
51452 * with the replacement pairs.
51453 *
51454 * {@link pspell_config_repl} should be used on a config before calling
51455 * {@link pspell_new_config}.
51456 *
51457 * @param int $dictionary_link
51458 * @param string $file The file should be writable by whoever PHP runs
51459 *   as (e.g. nobody).
51460 * @return bool
51461 * @since PHP 4 >= 4.0.2, PHP 5
51462 **/
51463function pspell_config_repl($dictionary_link, $file){}
51464
51465/**
51466 * This function determines whether run-together words will be treated as
51467 * legal compounds. That is, "thecat" will be a legal compound, although
51468 * there should be a space between the two words. Changing this setting
51469 * only affects the results returned by {@link pspell_check}; {@link
51470 * pspell_suggest} will still return suggestions.
51471 *
51472 * {@link pspell_config_runtogether} should be used on a config before
51473 * calling {@link pspell_new_config}.
51474 *
51475 * @param int $dictionary_link
51476 * @param bool $flag if run-together words should be treated as legal
51477 *   compounds, otherwise.
51478 * @return bool
51479 * @since PHP 4 >= 4.0.2, PHP 5
51480 **/
51481function pspell_config_runtogether($dictionary_link, $flag){}
51482
51483/**
51484 * {@link pspell_config_save_repl} determines whether {@link
51485 * pspell_save_wordlist} will save the replacement pairs along with the
51486 * wordlist. Usually there is no need to use this function because if
51487 * {@link pspell_config_repl} is used, the replacement pairs will be
51488 * saved by {@link pspell_save_wordlist} anyway, and if it is not, the
51489 * replacement pairs will not be saved.
51490 *
51491 * {@link pspell_config_save_repl} should be used on a config before
51492 * calling {@link pspell_new_config}.
51493 *
51494 * @param int $dictionary_link
51495 * @param bool $flag if replacement pairs should be saved, otherwise.
51496 * @return bool
51497 * @since PHP 4 >= 4.0.2, PHP 5
51498 **/
51499function pspell_config_save_repl($dictionary_link, $flag){}
51500
51501/**
51502 * {@link pspell_new} opens up a new dictionary and returns the
51503 * dictionary link identifier for use in other pspell functions.
51504 *
51505 * For more information and examples, check out inline manual pspell
51506 * website:.
51507 *
51508 * @param string $language The language parameter is the language code
51509 *   which consists of the two letter ISO 639 language code and an
51510 *   optional two letter ISO 3166 country code after a dash or
51511 *   underscore.
51512 * @param string $spelling The spelling parameter is the requested
51513 *   spelling for languages with more than one spelling such as English.
51514 *   Known values are 'american', 'british', and 'canadian'.
51515 * @param string $jargon The jargon parameter contains extra
51516 *   information to distinguish two different words lists that have the
51517 *   same language and spelling parameters.
51518 * @param string $encoding The encoding parameter is the encoding that
51519 *   words are expected to be in. Valid values are 'utf-8', 'iso8859-*',
51520 *   'koi8-r', 'viscii', 'cp1252', 'machine unsigned 16', 'machine
51521 *   unsigned 32'. This parameter is largely untested, so be careful when
51522 *   using.
51523 * @param int $mode The mode parameter is the mode in which
51524 *   spellchecker will work. There are several modes available:
51525 *   PSPELL_FAST - Fast mode (least number of suggestions) PSPELL_NORMAL
51526 *   - Normal mode (more suggestions) PSPELL_BAD_SPELLERS - Slow mode (a
51527 *   lot of suggestions) PSPELL_RUN_TOGETHER - Consider run-together
51528 *   words as legal compounds. That is, "thecat" will be a legal
51529 *   compound, although there should be a space between the two words.
51530 *   Changing this setting only affects the results returned by {@link
51531 *   pspell_check}; {@link pspell_suggest} will still return suggestions.
51532 *   Mode is a bitmask constructed from different constants listed above.
51533 *   However, PSPELL_FAST, PSPELL_NORMAL and PSPELL_BAD_SPELLERS are
51534 *   mutually exclusive, so you should select only one of them.
51535 * @return int
51536 * @since PHP 4 >= 4.0.2, PHP 5
51537 **/
51538function pspell_new($language, $spelling, $jargon, $encoding, $mode){}
51539
51540/**
51541 * @param int $config The {@link config} parameter is the one returned
51542 *   by {@link pspell_config_create} when the config was created.
51543 * @return int
51544 * @since PHP 4 >= 4.0.2, PHP 5
51545 **/
51546function pspell_new_config($config){}
51547
51548/**
51549 * For more information and examples, check out inline manual pspell
51550 * website:.
51551 *
51552 * @param string $personal The file where words added to the personal
51553 *   list will be stored. It should be an absolute filename beginning
51554 *   with '/' because otherwise it will be relative to $HOME, which is
51555 *   "/root" for most systems, and is probably not what you want.
51556 * @param string $language The language code which consists of the two
51557 *   letter ISO 639 language code and an optional two letter ISO 3166
51558 *   country code after a dash or underscore.
51559 * @param string $spelling The requested spelling for languages with
51560 *   more than one spelling such as English. Known values are 'american',
51561 *   'british', and 'canadian'.
51562 * @param string $jargon Extra information to distinguish two different
51563 *   words lists that have the same language and spelling parameters.
51564 * @param string $encoding The encoding that words are expected to be
51565 *   in. Valid values are utf-8, iso8859-*, koi8-r, viscii, cp1252,
51566 *   machine unsigned 16, machine unsigned 32.
51567 * @param int $mode The mode in which spellchecker will work. There are
51568 *   several modes available: PSPELL_FAST - Fast mode (least number of
51569 *   suggestions) PSPELL_NORMAL - Normal mode (more suggestions)
51570 *   PSPELL_BAD_SPELLERS - Slow mode (a lot of suggestions)
51571 *   PSPELL_RUN_TOGETHER - Consider run-together words as legal
51572 *   compounds. That is, "thecat" will be a legal compound, although
51573 *   there should be a space between the two words. Changing this setting
51574 *   only affects the results returned by {@link pspell_check}; {@link
51575 *   pspell_suggest} will still return suggestions. Mode is a bitmask
51576 *   constructed from different constants listed above. However,
51577 *   PSPELL_FAST, PSPELL_NORMAL and PSPELL_BAD_SPELLERS are mutually
51578 *   exclusive, so you should select only one of them.
51579 * @return int
51580 * @since PHP 4 >= 4.0.2, PHP 5
51581 **/
51582function pspell_new_personal($personal, $language, $spelling, $jargon, $encoding, $mode){}
51583
51584/**
51585 * @param int $dictionary_link A dictionary link identifier opened with
51586 *   {@link pspell_new_personal}.
51587 * @return bool
51588 * @since PHP 4 >= 4.0.2, PHP 5
51589 **/
51590function pspell_save_wordlist($dictionary_link){}
51591
51592/**
51593 * @param int $dictionary_link A dictionary link identifier, opened
51594 *   with {@link pspell_new_personal}
51595 * @param string $misspelled The misspelled word.
51596 * @param string $correct The fixed spelling for the {@link misspelled}
51597 *   word.
51598 * @return bool
51599 * @since PHP 4 >= 4.0.2, PHP 5
51600 **/
51601function pspell_store_replacement($dictionary_link, $misspelled, $correct){}
51602
51603/**
51604 * @param int $dictionary_link
51605 * @param string $word The tested word.
51606 * @return array
51607 * @since PHP 4 >= 4.0.2, PHP 5
51608 **/
51609function pspell_suggest($dictionary_link, $word){}
51610
51611/**
51612 * Adds a bookmark for the current page. Bookmarks usually appear in
51613 * PDF-Viewers left of the page in a hierarchical tree. Clicking on a
51614 * bookmark will jump to the given page.
51615 *
51616 * @param resource $psdoc Resource identifier of the postscript file as
51617 *   returned by {@link ps_new}.
51618 * @param string $text The text used for displaying the bookmark.
51619 * @param int $parent A bookmark previously created by this function
51620 *   which is used as the parent of the new bookmark.
51621 * @param int $open If {@link open} is unequal to zero the bookmark
51622 *   will be shown open by the pdf viewer.
51623 * @return int
51624 * @since PECL ps >= 1.1.0
51625 **/
51626function ps_add_bookmark($psdoc, $text, $parent, $open){}
51627
51628/**
51629 * Places a hyperlink at the given position pointing to a file program
51630 * which is being started when clicked on. The hyperlink's source
51631 * position is a rectangle with its lower left corner at (llx, lly) and
51632 * its upper right corner at (urx, ury). The rectangle has by default a
51633 * thin blue border.
51634 *
51635 * @param resource $psdoc Resource identifier of the postscript file as
51636 *   returned by {@link ps_new}.
51637 * @param float $llx The x-coordinate of the lower left corner.
51638 * @param float $lly The y-coordinate of the lower left corner.
51639 * @param float $urx The x-coordinate of the upper right corner.
51640 * @param float $ury The y-coordinate of the upper right corner.
51641 * @param string $filename The path of the program to be started, when
51642 *   the link is clicked on.
51643 * @return bool
51644 * @since PECL ps >= 1.1.0
51645 **/
51646function ps_add_launchlink($psdoc, $llx, $lly, $urx, $ury, $filename){}
51647
51648/**
51649 * Places a hyperlink at the given position pointing to a page in the
51650 * same document. Clicking on the link will jump to the given page. The
51651 * first page in a document has number 1.
51652 *
51653 * The hyperlink's source position is a rectangle with its lower left
51654 * corner at ({@link llx}, {@link lly}) and its upper right corner at
51655 * ({@link urx}, {@link ury}). The rectangle has by default a thin blue
51656 * border.
51657 *
51658 * @param resource $psdoc Resource identifier of the postscript file as
51659 *   returned by {@link ps_new}.
51660 * @param float $llx The x-coordinate of the lower left corner.
51661 * @param float $lly The y-coordinate of the lower left corner.
51662 * @param float $urx The x-coordinate of the upper right corner.
51663 * @param float $ury The y-coordinate of the upper right corner.
51664 * @param int $page The number of the page displayed when clicking on
51665 *   the link.
51666 * @param string $dest The parameter {@link dest} determines how the
51667 *   document is being viewed. It can be fitpage, fitwidth, fitheight, or
51668 *   fitbbox.
51669 * @return bool
51670 * @since PECL ps >= 1.1.0
51671 **/
51672function ps_add_locallink($psdoc, $llx, $lly, $urx, $ury, $page, $dest){}
51673
51674/**
51675 * Adds a note at a certain position on the page. Notes are like little
51676 * rectangular sheets with text on it, which can be placed anywhere on a
51677 * page. They are shown either folded or unfolded. If unfolded, the
51678 * specified icon is used as a placeholder.
51679 *
51680 * @param resource $psdoc Resource identifier of the postscript file as
51681 *   returned by {@link ps_new}.
51682 * @param float $llx The x-coordinate of the lower left corner.
51683 * @param float $lly The y-coordinate of the lower left corner.
51684 * @param float $urx The x-coordinate of the upper right corner.
51685 * @param float $ury The y-coordinate of the upper right corner.
51686 * @param string $contents The text of the note.
51687 * @param string $title The title of the note as displayed in the
51688 *   header of the note.
51689 * @param string $icon The icon shown if the note is folded. This
51690 *   parameter can be set to comment, insert, note, paragraph,
51691 *   newparagraph, key, or help.
51692 * @param int $open If {@link open} is unequal to zero the note will be
51693 *   shown unfolded after opening the document with a pdf viewer.
51694 * @return bool
51695 * @since PECL ps >= 1.1.0
51696 **/
51697function ps_add_note($psdoc, $llx, $lly, $urx, $ury, $contents, $title, $icon, $open){}
51698
51699/**
51700 * Places a hyperlink at the given position pointing to a second pdf
51701 * document. Clicking on the link will branch to the document at the
51702 * given page. The first page in a document has number 1.
51703 *
51704 * The hyperlink's source position is a rectangle with its lower left
51705 * corner at ({@link llx}, {@link lly}) and its upper right corner at
51706 * ({@link urx}, {@link ury}). The rectangle has by default a thin blue
51707 * border.
51708 *
51709 * @param resource $psdoc Resource identifier of the postscript file as
51710 *   returned by {@link ps_new}.
51711 * @param float $llx The x-coordinate of the lower left corner.
51712 * @param float $lly The y-coordinate of the lower left corner.
51713 * @param float $urx The x-coordinate of the upper right corner.
51714 * @param float $ury The y-coordinate of the upper right corner.
51715 * @param string $filename The name of the pdf document to be opened
51716 *   when clicking on this link.
51717 * @param int $page The page number of the destination pdf document
51718 * @param string $dest The parameter {@link dest} determines how the
51719 *   document is being viewed. It can be fitpage, fitwidth, fitheight, or
51720 *   fitbbox.
51721 * @return bool
51722 * @since PECL ps >= 1.1.0
51723 **/
51724function ps_add_pdflink($psdoc, $llx, $lly, $urx, $ury, $filename, $page, $dest){}
51725
51726/**
51727 * Places a hyperlink at the given position pointing to a web page. The
51728 * hyperlink's source position is a rectangle with its lower left corner
51729 * at ({@link llx}, {@link lly}) and its upper right corner at ({@link
51730 * urx}, {@link ury}). The rectangle has by default a thin blue border.
51731 *
51732 * @param resource $psdoc Resource identifier of the postscript file as
51733 *   returned by {@link ps_new}.
51734 * @param float $llx The x-coordinate of the lower left corner.
51735 * @param float $lly The y-coordinate of the lower left corner.
51736 * @param float $urx The x-coordinate of the upper right corner.
51737 * @param float $ury The y-coordinate of the upper right corner.
51738 * @param string $url The url of the hyperlink to be opened when
51739 *   clicking on this link, e.g. http://www.php.net.
51740 * @return bool
51741 * @since PECL ps >= 1.1.0
51742 **/
51743function ps_add_weblink($psdoc, $llx, $lly, $urx, $ury, $url){}
51744
51745/**
51746 * Draws a portion of a circle with at middle point at ({@link x}, {@link
51747 * y}). The arc starts at an angle of {@link alpha} and ends at an angle
51748 * of {@link beta}. It is drawn counterclockwise (use {@link ps_arcn} to
51749 * draw clockwise). The subpath added to the current path starts on the
51750 * arc at angle {@link alpha} and ends on the arc at angle {@link beta}.
51751 *
51752 * @param resource $psdoc Resource identifier of the postscript file as
51753 *   returned by {@link ps_new}.
51754 * @param float $x The x-coordinate of the circle's middle point.
51755 * @param float $y The y-coordinate of the circle's middle point.
51756 * @param float $radius The radius of the circle
51757 * @param float $alpha The start angle given in degrees.
51758 * @param float $beta The end angle given in degrees.
51759 * @return bool
51760 * @since PECL ps >= 1.1.0
51761 **/
51762function ps_arc($psdoc, $x, $y, $radius, $alpha, $beta){}
51763
51764/**
51765 * Draws a portion of a circle with at middle point at ({@link x}, {@link
51766 * y}). The arc starts at an angle of {@link alpha} and ends at an angle
51767 * of {@link beta}. It is drawn clockwise (use {@link ps_arc} to draw
51768 * counterclockwise). The subpath added to the current path starts on the
51769 * arc at angle {@link beta} and ends on the arc at angle {@link alpha}.
51770 *
51771 * @param resource $psdoc Resource identifier of the postscript file as
51772 *   returned by {@link ps_new}.
51773 * @param float $x The x-coordinate of the circle's middle point.
51774 * @param float $y The y-coordinate of the circle's middle point.
51775 * @param float $radius The radius of the circle
51776 * @param float $alpha The starting angle given in degrees.
51777 * @param float $beta The end angle given in degrees.
51778 * @return bool
51779 * @since PECL ps >= 1.1.0
51780 **/
51781function ps_arcn($psdoc, $x, $y, $radius, $alpha, $beta){}
51782
51783/**
51784 * Starts a new page. Although the parameters {@link width} and {@link
51785 * height} imply a different page size for each page, this is not
51786 * possible in PostScript. The first call of {@link ps_begin_page} will
51787 * set the page size for the whole document. Consecutive calls will have
51788 * no effect, except for creating a new page. The situation is different
51789 * if you intent to convert the PostScript document into PDF. This
51790 * function places pdfmarks into the document which can set the size for
51791 * each page indiviually. The resulting PDF document will have different
51792 * page sizes.
51793 *
51794 * Though PostScript does not know different page sizes, pslib places a
51795 * bounding box for each page into the document. This size is evaluated
51796 * by some PostScript viewers and will have precedence over the
51797 * BoundingBox in the Header of the document. This can lead to unexpected
51798 * results when you set a BoundingBox whose lower left corner is not (0,
51799 * 0), because the bounding box of the page will always have a lower left
51800 * corner (0, 0) and overwrites the global setting.
51801 *
51802 * Each page is encapsulated into save/restore. This means, that most of
51803 * the settings made on one page will not be retained on the next page.
51804 *
51805 * If there is up to the first call of {@link ps_begin_page} no call of
51806 * {@link ps_findfont}, then the header of the PostScript document will
51807 * be output and the bounding box will be set to the size of the first
51808 * page. The lower left corner of the bounding box is set to (0, 0). If
51809 * {@link ps_findfont} was called before, then the header has been output
51810 * already, and the document will not have a valid bounding box. In order
51811 * to prevent this, one should call {@link ps_set_info} to set the info
51812 * field BoundingBox and possibly Orientation before any {@link
51813 * ps_findfont} or {@link ps_begin_page} calls.
51814 *
51815 * @param resource $psdoc Resource identifier of the postscript file as
51816 *   returned by {@link ps_new}.
51817 * @param float $width The width of the page in pixel, e.g. 596 for A4
51818 *   format.
51819 * @param float $height The height of the page in pixel, e.g. 842 for
51820 *   A4 format.
51821 * @return bool
51822 * @since PECL ps >= 1.1.0
51823 **/
51824function ps_begin_page($psdoc, $width, $height){}
51825
51826/**
51827 * Starts a new pattern. A pattern is like a page containing e.g. a
51828 * drawing which can be used for filling areas. It is used like a color
51829 * by calling {@link ps_setcolor} and setting the color space to pattern.
51830 *
51831 * @param resource $psdoc Resource identifier of the postscript file as
51832 *   returned by {@link ps_new}.
51833 * @param float $width The width of the pattern in pixel.
51834 * @param float $height The height of the pattern in pixel.
51835 * @param float $xstep The distance in pixel of placements of the
51836 *   pattern in horizontal direction.
51837 * @param float $ystep The distance in pixel of placements of the
51838 *   pattern in vertical direction.
51839 * @param int $painttype Must be 1 or 2.
51840 * @return int
51841 * @since PECL ps >= 1.2.0
51842 **/
51843function ps_begin_pattern($psdoc, $width, $height, $xstep, $ystep, $painttype){}
51844
51845/**
51846 * Starts a new template. A template is called a form in the postscript
51847 * language. It is created similar to a pattern but used like an image.
51848 * Templates are often used for drawings which are placed several times
51849 * through out the document, e.g. like a company logo. All drawing
51850 * functions may be used within a template. The template will not be
51851 * drawn until it is placed by {@link ps_place_image}.
51852 *
51853 * @param resource $psdoc Resource identifier of the postscript file as
51854 *   returned by {@link ps_new}.
51855 * @param float $width The width of the template in pixel.
51856 * @param float $height The height of the template in pixel.
51857 * @return int
51858 * @since PECL ps >= 1.2.0
51859 **/
51860function ps_begin_template($psdoc, $width, $height){}
51861
51862/**
51863 * Draws a circle with its middle point at ({@link x}, {@link y}). The
51864 * circle starts and ends at position ({@link x}+{@link radius}, {@link
51865 * y}). If this function is called outside a path it will start a new
51866 * path. If it is called within a path it will add the circle as a
51867 * subpath. If the last drawing operation does not end in point ({@link
51868 * x}+{@link radius}, {@link y}) then there will be a gap in the path.
51869 *
51870 * @param resource $psdoc Resource identifier of the postscript file as
51871 *   returned by {@link ps_new}.
51872 * @param float $x The x-coordinate of the circle's middle point.
51873 * @param float $y The y-coordinate of the circle's middle point.
51874 * @param float $radius The radius of the circle
51875 * @return bool
51876 * @since PECL ps >= 1.1.0
51877 **/
51878function ps_circle($psdoc, $x, $y, $radius){}
51879
51880/**
51881 * Takes the current path and uses it to define the border of a clipping
51882 * area. Everything drawn outside of that area will not be visible.
51883 *
51884 * @param resource $psdoc Resource identifier of the postscript file as
51885 *   returned by {@link ps_new}.
51886 * @return bool
51887 * @since PECL ps >= 1.1.0
51888 **/
51889function ps_clip($psdoc){}
51890
51891/**
51892 * Closes the PostScript document.
51893 *
51894 * This function writes the trailer of the PostScript document. It also
51895 * writes the bookmark tree. {@link ps_close} does not free any
51896 * resources, which is done by {@link ps_delete}.
51897 *
51898 * This function is also called by {@link ps_delete} if it has not been
51899 * called before.
51900 *
51901 * @param resource $psdoc Resource identifier of the postscript file as
51902 *   returned by {@link ps_new}.
51903 * @return bool
51904 * @since PECL ps >= 1.1.0
51905 **/
51906function ps_close($psdoc){}
51907
51908/**
51909 * Connects the last point with the first point of a path. The resulting
51910 * path can be used for stroking, filling, clipping, etc..
51911 *
51912 * @param resource $psdoc Resource identifier of the postscript file as
51913 *   returned by {@link ps_new}.
51914 * @return bool
51915 * @since PECL ps >= 1.1.0
51916 **/
51917function ps_closepath($psdoc){}
51918
51919/**
51920 * Connects the last point with first point of a path and draws the
51921 * resulting closed line.
51922 *
51923 * @param resource $psdoc Resource identifier of the postscript file as
51924 *   returned by {@link ps_new}.
51925 * @return bool
51926 * @since PECL ps >= 1.1.0
51927 **/
51928function ps_closepath_stroke($psdoc){}
51929
51930/**
51931 * Closes an image and frees its resources. Once an image is closed it
51932 * cannot be used anymore.
51933 *
51934 * @param resource $psdoc Resource identifier of the postscript file as
51935 *   returned by {@link ps_new}.
51936 * @param int $imageid Resource identifier of the image as returned by
51937 *   {@link ps_open_image} or {@link ps_open_image_file}.
51938 * @return void
51939 * @since PECL ps >= 1.1.0
51940 **/
51941function ps_close_image($psdoc, $imageid){}
51942
51943/**
51944 * Output a text one line below the last line. The line spacing is taken
51945 * from the value "leading" which must be set with {@link ps_set_value}.
51946 * The actual position of the text is determined by the values "textx"
51947 * and "texty" which can be requested with {@link ps_get_value}
51948 *
51949 * @param resource $psdoc Resource identifier of the postscript file as
51950 *   returned by {@link ps_new}.
51951 * @param string $text The text to output.
51952 * @return bool
51953 * @since PECL ps >= 1.1.0
51954 **/
51955function ps_continue_text($psdoc, $text){}
51956
51957/**
51958 * Add a section of a cubic Bézier curve described by the three given
51959 * control points to the current path.
51960 *
51961 * @param resource $psdoc Resource identifier of the postscript file as
51962 *   returned by {@link ps_new}.
51963 * @param float $x1 x-coordinate of first control point.
51964 * @param float $y1 y-coordinate of first control point.
51965 * @param float $x2 x-coordinate of second control point.
51966 * @param float $y2 y-coordinate of second control point.
51967 * @param float $x3 x-coordinate of third control point.
51968 * @param float $y3 y-coordinate of third control point.
51969 * @return bool
51970 * @since PECL ps >= 1.1.0
51971 **/
51972function ps_curveto($psdoc, $x1, $y1, $x2, $y2, $x3, $y3){}
51973
51974/**
51975 * Mainly frees memory used by the document. Also closes a file, if it
51976 * was not closed before with {@link ps_close}. You should in any case
51977 * close the file with {@link ps_close} before, because {@link ps_close}
51978 * not just closes the file but also outputs a trailor containing
51979 * PostScript comments like the number of pages in the document and
51980 * adding the bookmark hierarchy.
51981 *
51982 * @param resource $psdoc Resource identifier of the postscript file as
51983 *   returned by {@link ps_new}.
51984 * @return bool
51985 * @since PECL ps >= 1.1.0
51986 **/
51987function ps_delete($psdoc){}
51988
51989/**
51990 * Ends a page which was started with {@link ps_begin_page}. Ending a
51991 * page will leave the current drawing context, which e.g. requires to
51992 * reload fonts if they were loading within the page, and to set many
51993 * other drawing parameters like the line width, or color..
51994 *
51995 * @param resource $psdoc Resource identifier of the postscript file as
51996 *   returned by {@link ps_new}.
51997 * @return bool
51998 * @since PECL ps >= 1.1.0
51999 **/
52000function ps_end_page($psdoc){}
52001
52002/**
52003 * Ends a pattern which was started with {@link ps_begin_pattern}. Once a
52004 * pattern has been ended, it can be used like a color to fill areas.
52005 *
52006 * @param resource $psdoc Resource identifier of the postscript file as
52007 *   returned by {@link ps_new}.
52008 * @return bool
52009 * @since PECL ps >= 1.2.0
52010 **/
52011function ps_end_pattern($psdoc){}
52012
52013/**
52014 * Ends a template which was started with {@link ps_begin_template}. Once
52015 * a template has been ended, it can be used like an image.
52016 *
52017 * @param resource $psdoc Resource identifier of the postscript file as
52018 *   returned by {@link ps_new}.
52019 * @return bool
52020 * @since PECL ps >= 1.2.0
52021 **/
52022function ps_end_template($psdoc){}
52023
52024/**
52025 * Fills the path constructed with previously called drawing functions
52026 * like {@link ps_lineto}.
52027 *
52028 * @param resource $psdoc Resource identifier of the postscript file as
52029 *   returned by {@link ps_new}.
52030 * @return bool
52031 * @since PECL ps >= 1.1.0
52032 **/
52033function ps_fill($psdoc){}
52034
52035/**
52036 * Fills and draws the path constructed with previously called drawing
52037 * functions like {@link ps_lineto}.
52038 *
52039 * @param resource $psdoc Resource identifier of the postscript file as
52040 *   returned by {@link ps_new}.
52041 * @return bool
52042 * @since PECL ps >= 1.1.0
52043 **/
52044function ps_fill_stroke($psdoc){}
52045
52046/**
52047 * Loads a font for later use. Before text is output with a loaded font
52048 * it must be set with {@link ps_setfont}. This function needs the adobe
52049 * font metric file in order to calculate the space used up by the
52050 * characters. A font which is loaded within a page will only be
52051 * available on that page. Fonts which are to be used in the complete
52052 * document have to be loaded before the first call of {@link
52053 * ps_begin_page}. Calling {@link ps_findfont} between pages will make
52054 * that font available for all following pages.
52055 *
52056 * The name of the afm file must be {@link fontname}.afm. If the font
52057 * shall be embedded the file {@link fontname}.pfb containing the font
52058 * outline must be present as well.
52059 *
52060 * Calling {@link ps_findfont} before the first page requires to output
52061 * the postscript header which includes the BoundingBox for the whole
52062 * document. Usually the BoundingBox is set with the first call of {@link
52063 * ps_begin_page} which now comes after {@link ps_findfont}. Consequently
52064 * the BoundingBox has not been set and a warning will be issued when
52065 * {@link ps_findfont} is called. In order to prevent this situation, one
52066 * should call {@link ps_set_parameter} to set the BoundingBox before
52067 * {@link ps_findfont} is called.
52068 *
52069 * @param resource $psdoc Resource identifier of the postscript file as
52070 *   returned by {@link ps_new}.
52071 * @param string $fontname The name of the font.
52072 * @param string $encoding {@link ps_findfont} will try to load the
52073 *   file passed in the parameter {@link encoding}. Encoding files are of
52074 *   the same syntax as those used by dvips(1). They contain a font
52075 *   encoding vector (which is currently not used but must be present)
52076 *   and a list of extra ligatures to extend the list of ligatures
52077 *   derived from the afm file. {@link encoding} can be or the empty
52078 *   string if the default encoding (TeXBase1) shall be used. If the
52079 *   encoding is set to builtin then there will be no reencoding and the
52080 *   font specific encoding will be used. This is very useful with symbol
52081 *   fonts.
52082 * @param bool $embed If set to a value >0 the font will be embedded
52083 *   into the document. This requires the font outline (.pfb file) to be
52084 *   present.
52085 * @return int
52086 * @since PECL ps >= 1.1.0
52087 **/
52088function ps_findfont($psdoc, $fontname, $encoding, $embed){}
52089
52090/**
52091 * This function is not implemented yet. It will always return an empty
52092 * string. The idea for a later implementation is to write the contents
52093 * of the postscript file into an internal buffer if in memory creation
52094 * is requested, and retrieve the buffer content with this function.
52095 * Currently, documents created in memory are send to the browser without
52096 * buffering.
52097 *
52098 * @param resource $psdoc Resource identifier of the postscript file as
52099 *   returned by {@link ps_new}.
52100 * @return string
52101 * @since PECL ps >= 1.1.0
52102 **/
52103function ps_get_buffer($psdoc){}
52104
52105/**
52106 * Gets several parameters which were directly set by {@link
52107 * ps_set_parameter} or indirectly by one of the other functions.
52108 * Parameters are by definition string values. This function cannot be
52109 * used to retrieve resources which were also set by {@link
52110 * ps_set_parameter}.
52111 *
52112 * The parameter {@link name} can have the following values.
52113 *
52114 * fontname The name of the currently active font or the font whose
52115 * identifier is passed in parameter {@link modifier}. fontencoding The
52116 * encoding of the currently active font. dottedversion The version of
52117 * the underlying pslib library in the format <major>.<minor>.<subminor>
52118 * scope The current drawing scope. Can be object, document, null, page,
52119 * pattern, path, template, prolog, font, glyph. ligaturedisolvechar The
52120 * character which dissolves a ligature. If your are using a font which
52121 * contains the ligature `ff' and `|' is the char to dissolve the
52122 * ligature, then `f|f' will result in two `f' instead of the ligature
52123 * `ff'. imageencoding The encoding used for encoding images. Can be
52124 * either hex or 85. hex encoding uses two bytes in the postscript file
52125 * each byte in the image. 85 stand for Ascii85 encoding. linenumbermode
52126 * Set to paragraph if lines are numbered within a paragraph or box if
52127 * they are numbered within the surrounding box. linebreak Only used if
52128 * text is output with {@link ps_show_boxed}. If set to true a carriage
52129 * return will add a line break. parbreak Only used if text is output
52130 * with {@link ps_show_boxed}. If set to true a carriage return will
52131 * start a new paragraph. hyphenation Only used if text is output with
52132 * {@link ps_show_boxed}. If set to true the paragraph will be hyphenated
52133 * if a hypen dictionary is set and exists. hyphendict Filename of the
52134 * dictionary used for hyphenation pattern.
52135 *
52136 * @param resource $psdoc Resource identifier of the postscript file as
52137 *   returned by {@link ps_new}.
52138 * @param string $name Name of the parameter.
52139 * @param float $modifier An identifier needed if a parameter of a
52140 *   resource is requested, e.g. the size of an image. In such a case the
52141 *   resource id is passed.
52142 * @return string
52143 * @since PECL ps >= 1.1.0
52144 **/
52145function ps_get_parameter($psdoc, $name, $modifier){}
52146
52147/**
52148 * Gets several values which were set by {@link ps_set_value}. Values are
52149 * by definition float values.
52150 *
52151 * The parameter {@link name} can have the following values.
52152 *
52153 * fontsize The size of the currently active font or the font whose
52154 * identifier is passed in parameter {@link modifier}. font The currently
52155 * active font itself. imagewidth The width of the image whose id is
52156 * passed in the parameter {@link modifier}. imageheight The height of
52157 * the image whose id is passed in the parameter {@link modifier}.
52158 * capheight The height of a capital M in the currently active font or
52159 * the font whose identifier is passed in parameter {@link modifier}.
52160 * ascender The ascender of the currently active font or the font whose
52161 * identifier is passed in parameter {@link modifier}. descender The
52162 * descender of the currently active font or the font whose identifier is
52163 * passed in parameter {@link modifier}. italicangle The italicangle of
52164 * the currently active font or the font whose identifier is passed in
52165 * parameter {@link modifier}. underlineposition The underlineposition of
52166 * the currently active font or the font whose identifier is passed in
52167 * parameter {@link modifier}. underlinethickness The underlinethickness
52168 * of the currently active font or the font whose identifier is passed in
52169 * parameter {@link modifier}. textx The current x-position for text
52170 * output. texty The current y-position for text output. textrendering
52171 * The current mode for text rendering. textrise The space by which text
52172 * is risen above the base line. leading The distance between text lines
52173 * in points. wordspacing The space between words as a multiple of the
52174 * width of a space char. charspacing The space between chars. If
52175 * charspacing is != 0.0 ligatures will always be dissolved.
52176 * hyphenminchars Minimum number of chars hyphenated at the end of a
52177 * word. parindent Indention of the first n line in a paragraph.
52178 * numindentlines Number of line in a paragraph to indent if parindent !=
52179 * 0.0. parskip Distance between paragraphs. linenumberspace Overall
52180 * space in front of each line for the line number. linenumbersep Space
52181 * between the line and the line number. major The major version number
52182 * of pslib. minor The minor version number of pslib. subminor, revision
52183 * The subminor version number of pslib.
52184 *
52185 * @param resource $psdoc Resource identifier of the postscript file as
52186 *   returned by {@link ps_new}.
52187 * @param string $name Name of the value.
52188 * @param float $modifier The parameter {@link modifier} specifies the
52189 *   resource for which the value is to be retrieved. This can be the id
52190 *   of a font or an image.
52191 * @return float
52192 * @since PECL ps >= 1.1.0
52193 **/
52194function ps_get_value($psdoc, $name, $modifier){}
52195
52196/**
52197 * Hyphenates the passed word. {@link ps_hyphenate} evaluates the value
52198 * hyphenminchars (set by {@link ps_set_value}) and the parameter
52199 * hyphendict (set by {@link ps_set_parameter}). hyphendict must be set
52200 * before calling this function.
52201 *
52202 * This function requires the locale category LC_CTYPE to be set
52203 * properly. This is done when the extension is initialized by using the
52204 * environment variables. On Unix systems read the man page of locale for
52205 * more information.
52206 *
52207 * @param resource $psdoc Resource identifier of the postscript file as
52208 *   returned by {@link ps_new}.
52209 * @param string $text {@link text} should not contain any non alpha
52210 *   characters. Possible positions for breaks are returned in an array
52211 *   of interger numbers. Each number is the position of the char in
52212 *   {@link text} after which a hyphenation can take place.
52213 * @return array
52214 * @since PECL ps >= 1.1.1
52215 **/
52216function ps_hyphenate($psdoc, $text){}
52217
52218/**
52219 * @param resource $psdoc Resource identifier of the postscript file as
52220 *   returned by {@link ps_new}.
52221 * @param string $file
52222 * @return bool
52223 * @since PECL ps >= 1.3.4
52224 **/
52225function ps_include_file($psdoc, $file){}
52226
52227/**
52228 * Adds a straight line from the current point to the given coordinates
52229 * to the current path. Use {@link ps_moveto} to set the starting point
52230 * of the line.
52231 *
52232 * @param resource $psdoc Resource identifier of the postscript file as
52233 *   returned by {@link ps_new}.
52234 * @param float $x x-coordinate of the end point of the line.
52235 * @param float $y y-coordinate of the end point of the line.
52236 * @return bool
52237 * @since PECL ps >= 1.1.0
52238 **/
52239function ps_lineto($psdoc, $x, $y){}
52240
52241/**
52242 * Creates a spot color from the current fill color. The fill color must
52243 * be defined in rgb, cmyk or gray colorspace. The spot color name can be
52244 * an arbitrary name. A spot color can be set as any color with {@link
52245 * ps_setcolor}. When the document is not printed but displayed by an
52246 * postscript viewer the given color in the specified color space is use.
52247 *
52248 * @param resource $psdoc Resource identifier of the postscript file as
52249 *   returned by {@link ps_new}.
52250 * @param string $name Name of the spot color, e.g. Pantone 5565.
52251 * @param int $reserved
52252 * @return int
52253 * @since PECL ps >= 1.1.0
52254 **/
52255function ps_makespotcolor($psdoc, $name, $reserved){}
52256
52257/**
52258 * Sets the current point to new coordinates. If this is the first call
52259 * of {@link ps_moveto} after a previous path has been ended then it will
52260 * start a new path. If this function is called in the middle of a path
52261 * it will just set the current point and start a subpath.
52262 *
52263 * @param resource $psdoc Resource identifier of the postscript file as
52264 *   returned by {@link ps_new}.
52265 * @param float $x x-coordinate of the point to move to.
52266 * @param float $y y-coordinate of the point to move to.
52267 * @return bool
52268 * @since PECL ps >= 1.1.0
52269 **/
52270function ps_moveto($psdoc, $x, $y){}
52271
52272/**
52273 * Creates a new document instance. It does not create the file on disk
52274 * or in memory, it just sets up everything. {@link ps_new} is usually
52275 * followed by a call of {@link ps_open_file} to actually create the
52276 * postscript document.
52277 *
52278 * @return resource
52279 * @since PECL ps >= 1.1.0
52280 **/
52281function ps_new(){}
52282
52283/**
52284 * Creates a new file on disk and writes the PostScript document into it.
52285 * The file will be closed when {@link ps_close} is called.
52286 *
52287 * @param resource $psdoc Resource identifier of the postscript file as
52288 *   returned by {@link ps_new}.
52289 * @param string $filename The name of the postscript file. If {@link
52290 *   filename} is not passed the document will be created in memory and
52291 *   all output will go straight to the browser.
52292 * @return bool
52293 * @since PECL ps >= 1.1.0
52294 **/
52295function ps_open_file($psdoc, $filename){}
52296
52297/**
52298 * Reads an image which is already available in memory. The parameter
52299 * {@link source} is currently not evaluated and assumed to be memory.
52300 * The image data is a sequence of pixels starting in th upper left
52301 * corner and ending in the lower right corner. Each pixel consists of
52302 * {@link components} color components, and each component has {@link
52303 * bpc} bits.
52304 *
52305 * @param resource $psdoc Resource identifier of the postscript file as
52306 *   returned by {@link ps_new}.
52307 * @param string $type The type of the image. Possible values are png,
52308 *   jpeg, or eps.
52309 * @param string $source Not used.
52310 * @param string $data The image data.
52311 * @param int $lenght The length of the image data.
52312 * @param int $width The width of the image.
52313 * @param int $height The height of the image.
52314 * @param int $components The number of components for each pixel. This
52315 *   can be 1 (gray scale images), 3 (rgb images), or 4 (cmyk, rgba
52316 *   images).
52317 * @param int $bpc Number of bits per component (quite often 8).
52318 * @param string $params
52319 * @return int
52320 * @since PECL ps >= 1.1.0
52321 **/
52322function ps_open_image($psdoc, $type, $source, $data, $lenght, $width, $height, $components, $bpc, $params){}
52323
52324/**
52325 * Loads an image for later use.
52326 *
52327 * @param resource $psdoc Resource identifier of the postscript file as
52328 *   returned by {@link ps_new}.
52329 * @param string $type The type of the image. Possible values are png,
52330 *   jpeg, or eps.
52331 * @param string $filename The name of the file containing the image
52332 *   data.
52333 * @param string $stringparam Not used.
52334 * @param int $intparam Not used.
52335 * @return int
52336 * @since PECL ps >= 1.1.0
52337 **/
52338function ps_open_image_file($psdoc, $type, $filename, $stringparam, $intparam){}
52339
52340/**
52341 * @param resource $psdoc Resource identifier of the postscript file as
52342 *   returned by {@link ps_new}.
52343 * @param int $gd
52344 * @return int
52345 * @since PECL ps >= 1.1.0
52346 **/
52347function ps_open_memory_image($psdoc, $gd){}
52348
52349/**
52350 * Places a formerly loaded image on the page. The image can be scaled.
52351 * If the image shall be rotated as well, you will have to rotate the
52352 * coordinate system before with {@link ps_rotate}.
52353 *
52354 * @param resource $psdoc Resource identifier of the postscript file as
52355 *   returned by {@link ps_new}.
52356 * @param int $imageid The resource identifier of the image as returned
52357 *   by {@link ps_open_image} or {@link ps_open_image_file}.
52358 * @param float $x x-coordinate of the lower left corner of the image.
52359 * @param float $y y-coordinate of the lower left corner of the image.
52360 * @param float $scale The scaling factor for the image. A scale of 1.0
52361 *   will result in a resolution of 72 dpi, because each pixel is
52362 *   equivalent to 1 point.
52363 * @return bool
52364 * @since PECL ps >= 1.1.0
52365 **/
52366function ps_place_image($psdoc, $imageid, $x, $y, $scale){}
52367
52368/**
52369 * Draws a rectangle with its lower left corner at ({@link x}, {@link
52370 * y}). The rectangle starts and ends in its lower left corner. If this
52371 * function is called outside a path it will start a new path. If it is
52372 * called within a path it will add the rectangle as a subpath. If the
52373 * last drawing operation does not end in the lower left corner then
52374 * there will be a gap in the path.
52375 *
52376 * @param resource $psdoc Resource identifier of the postscript file as
52377 *   returned by {@link ps_new}.
52378 * @param float $x x-coordinate of the lower left corner of the
52379 *   rectangle.
52380 * @param float $y y-coordinate of the lower left corner of the
52381 *   rectangle.
52382 * @param float $width The width of the image.
52383 * @param float $height The height of the image.
52384 * @return bool
52385 * @since PECL ps >= 1.1.0
52386 **/
52387function ps_rect($psdoc, $x, $y, $width, $height){}
52388
52389/**
52390 * Restores a previously saved graphics context. Any call of {@link
52391 * ps_save} must be accompanied by a call to {@link ps_restore}. All
52392 * coordinate transformations, line style settings, color settings, etc.
52393 * are being restored to the state before the call of {@link ps_save}.
52394 *
52395 * @param resource $psdoc Resource identifier of the postscript file as
52396 *   returned by {@link ps_new}.
52397 * @return bool
52398 * @since PECL ps >= 1.1.0
52399 **/
52400function ps_restore($psdoc){}
52401
52402/**
52403 * Sets the rotation of the coordinate system.
52404 *
52405 * @param resource $psdoc Resource identifier of the postscript file as
52406 *   returned by {@link ps_new}.
52407 * @param float $rot Angle of rotation in degree.
52408 * @return bool
52409 * @since PECL ps >= 1.1.0
52410 **/
52411function ps_rotate($psdoc, $rot){}
52412
52413/**
52414 * Saves the current graphics context, containing colors, translation and
52415 * rotation settings and some more. A saved context can be restored with
52416 * {@link ps_restore}.
52417 *
52418 * @param resource $psdoc Resource identifier of the postscript file as
52419 *   returned by {@link ps_new}.
52420 * @return bool
52421 * @since PECL ps >= 1.1.0
52422 **/
52423function ps_save($psdoc){}
52424
52425/**
52426 * Sets horizontal and vertical scaling of the coordinate system.
52427 *
52428 * @param resource $psdoc Resource identifier of the postscript file as
52429 *   returned by {@link ps_new}.
52430 * @param float $x Scaling factor in horizontal direction.
52431 * @param float $y Scaling factor in vertical direction.
52432 * @return bool
52433 * @since PECL ps >= 1.1.0
52434 **/
52435function ps_scale($psdoc, $x, $y){}
52436
52437/**
52438 * Sets the color for drawing, filling, or both.
52439 *
52440 * @param resource $psdoc Resource identifier of the postscript file as
52441 *   returned by {@link ps_new}.
52442 * @param string $type The parameter {@link type} can be both, fill, or
52443 *   fillstroke.
52444 * @param string $colorspace The colorspace should be one of gray, rgb,
52445 *   cmyk, spot, pattern. Depending on the colorspace either only the
52446 *   first, the first three or all parameters will be used.
52447 * @param float $c1 Depending on the colorspace this is either the red
52448 *   component (rgb), the cyan component (cmyk), the gray value (gray),
52449 *   the identifier of the spot color or the identifier of the pattern.
52450 * @param float $c2 Depending on the colorspace this is either the
52451 *   green component (rgb), the magenta component (cmyk).
52452 * @param float $c3 Depending on the colorspace this is either the blue
52453 *   component (rgb), the yellow component (cmyk).
52454 * @param float $c4 This must only be set in cmyk colorspace and
52455 *   specifies the black component.
52456 * @return bool
52457 * @since PECL ps >= 1.1.0
52458 **/
52459function ps_setcolor($psdoc, $type, $colorspace, $c1, $c2, $c3, $c4){}
52460
52461/**
52462 * Sets the length of the black and white portions of a dashed line.
52463 *
52464 * @param resource $psdoc Resource identifier of the postscript file as
52465 *   returned by {@link ps_new}.
52466 * @param float $on The length of the dash.
52467 * @param float $off The length of the gap between dashes.
52468 * @return bool
52469 * @since PECL ps >= 1.1.0
52470 **/
52471function ps_setdash($psdoc, $on, $off){}
52472
52473/**
52474 * @param resource $psdoc Resource identifier of the postscript file as
52475 *   returned by {@link ps_new}.
52476 * @param float $value The {@link value} must be between 0.2 and 1.
52477 * @return bool
52478 * @since PECL ps >= 1.1.0
52479 **/
52480function ps_setflat($psdoc, $value){}
52481
52482/**
52483 * Sets a font, which has to be loaded before with {@link ps_findfont}.
52484 * Outputting text without setting a font results in an error.
52485 *
52486 * @param resource $psdoc Resource identifier of the postscript file as
52487 *   returned by {@link ps_new}.
52488 * @param int $fontid The font identifier as returned by {@link
52489 *   ps_findfont}.
52490 * @param float $size The size of the font.
52491 * @return bool
52492 * @since PECL ps >= 1.1.0
52493 **/
52494function ps_setfont($psdoc, $fontid, $size){}
52495
52496/**
52497 * Sets the gray value for all following drawing operations.
52498 *
52499 * @param resource $psdoc Resource identifier of the postscript file as
52500 *   returned by {@link ps_new}.
52501 * @param float $gray The value must be between 0 (white) and 1
52502 *   (black).
52503 * @return bool
52504 * @since PECL ps >= 1.1.0
52505 **/
52506function ps_setgray($psdoc, $gray){}
52507
52508/**
52509 * Sets how line ends look like.
52510 *
52511 * @param resource $psdoc Resource identifier of the postscript file as
52512 *   returned by {@link ps_new}.
52513 * @param int $type The type of line ends. Possible values are
52514 *   PS_LINECAP_BUTT, PS_LINECAP_ROUND, or PS_LINECAP_SQUARED.
52515 * @return bool
52516 * @since PECL ps >= 1.1.0
52517 **/
52518function ps_setlinecap($psdoc, $type){}
52519
52520/**
52521 * Sets how lines are joined.
52522 *
52523 * @param resource $psdoc Resource identifier of the postscript file as
52524 *   returned by {@link ps_new}.
52525 * @param int $type The way lines are joined. Possible values are
52526 *   PS_LINEJOIN_MITER, PS_LINEJOIN_ROUND, or PS_LINEJOIN_BEVEL.
52527 * @return bool
52528 * @since PECL ps >= 1.1.0
52529 **/
52530function ps_setlinejoin($psdoc, $type){}
52531
52532/**
52533 * Sets the line width for all following drawing operations.
52534 *
52535 * @param resource $psdoc Resource identifier of the postscript file as
52536 *   returned by {@link ps_new}.
52537 * @param float $width The width of lines in points.
52538 * @return bool
52539 * @since PECL ps >= 1.1.0
52540 **/
52541function ps_setlinewidth($psdoc, $width){}
52542
52543/**
52544 * If two lines join in a small angle and the line join is set to
52545 * PS_LINEJOIN_MITER, then the resulting spike will be very long. The
52546 * miter limit is the maximum ratio of the miter length (the length of
52547 * the spike) and the line width.
52548 *
52549 * @param resource $psdoc Resource identifier of the postscript file as
52550 *   returned by {@link ps_new}.
52551 * @param float $value The maximum ratio between the miter length and
52552 *   the line width. Larger values (> 10) will result in very long spikes
52553 *   when two lines meet in a small angle. Keep the default unless you
52554 *   know what you are doing.
52555 * @return bool
52556 * @since PECL ps >= 1.1.0
52557 **/
52558function ps_setmiterlimit($psdoc, $value){}
52559
52560/**
52561 * @param resource $psdoc Resource identifier of the postscript file as
52562 *   returned by {@link ps_new}.
52563 * @param int $mode
52564 * @return bool
52565 * @since PECL ps >= 1.3.0
52566 **/
52567function ps_setoverprintmode($psdoc, $mode){}
52568
52569/**
52570 * Sets the length of the black and white portions of a dashed line.
52571 * {@link ps_setpolydash} is used to set more complicated dash patterns.
52572 *
52573 * @param resource $psdoc Resource identifier of the postscript file as
52574 *   returned by {@link ps_new}.
52575 * @param float $arr {@link arr} is a list of length elements
52576 *   alternately for the black and white portion.
52577 * @return bool
52578 * @since PECL ps >= 1.1.0
52579 **/
52580function ps_setpolydash($psdoc, $arr){}
52581
52582/**
52583 * Links added with one of the functions {@link ps_add_weblink}, {@link
52584 * ps_add_pdflink}, etc. will be displayed with a surounded rectangle
52585 * when the postscript document is converted to pdf and viewed in a pdf
52586 * viewer. This rectangle is not visible in the postscript document. This
52587 * function sets the color of the rectangle's border line.
52588 *
52589 * @param resource $psdoc Resource identifier of the postscript file as
52590 *   returned by {@link ps_new}.
52591 * @param float $red The red component of the border color.
52592 * @param float $green The green component of the border color.
52593 * @param float $blue The blue component of the border color.
52594 * @return bool
52595 * @since PECL ps >= 1.1.0
52596 **/
52597function ps_set_border_color($psdoc, $red, $green, $blue){}
52598
52599/**
52600 * Links added with one of the functions {@link ps_add_weblink}, {@link
52601 * ps_add_pdflink}, etc. will be displayed with a surounded rectangle
52602 * when the postscript document is converted to pdf and viewed in a pdf
52603 * viewer. This rectangle is not visible in the postscript document. This
52604 * function sets the length of the black and white portion of a dashed
52605 * border line.
52606 *
52607 * @param resource $psdoc Resource identifier of the postscript file as
52608 *   returned by {@link ps_new}.
52609 * @param float $black The length of the dash.
52610 * @param float $white The length of the gap between dashes.
52611 * @return bool
52612 * @since PECL ps >= 1.1.0
52613 **/
52614function ps_set_border_dash($psdoc, $black, $white){}
52615
52616/**
52617 * Links added with one of the functions {@link ps_add_weblink}, {@link
52618 * ps_add_pdflink}, etc. will be displayed with a surounded rectangle
52619 * when the postscript document is converted to pdf and viewed in a pdf
52620 * viewer. This rectangle is not visible in the postscript document. This
52621 * function sets the appearance and width of the border line.
52622 *
52623 * @param resource $psdoc Resource identifier of the postscript file as
52624 *   returned by {@link ps_new}.
52625 * @param string $style {@link style} can be solid or dashed.
52626 * @param float $width The line width of the border.
52627 * @return bool
52628 * @since PECL ps >= 1.1.0
52629 **/
52630function ps_set_border_style($psdoc, $style, $width){}
52631
52632/**
52633 * Sets certain information fields of the document. This fields will be
52634 * shown as a comment in the header of the PostScript file. If the
52635 * document is converted to pdf this fields will also be used for the
52636 * document information.
52637 *
52638 * The BoundingBox is usually set to the value given to the first page.
52639 * This only works if {@link ps_findfont} has not been called before. In
52640 * such cases the BoundingBox would be left unset unless you set it
52641 * explicitly with this function.
52642 *
52643 * This function will have no effect anymore when the header of the
52644 * postscript file has been already written. It must be called before the
52645 * first page or the first call of {@link ps_findfont}.
52646 *
52647 * @param resource $p Resource identifier of the postscript file as
52648 *   returned by {@link ps_new}.
52649 * @param string $key The name of the information field to set. The
52650 *   values which can be set are Keywords, Subject, Title, Creator,
52651 *   Author, BoundingBox, and Orientation. Be aware that some of them has
52652 *   a meaning to PostScript viewers.
52653 * @param string $val The value of the information field. The field
52654 *   Orientation can be set to either Portrait or Landscape. The
52655 *   BoundingBox is a string consisting of four numbers. The first two
52656 *   numbers are the coordinates of the lower left corner of the page.
52657 *   The last two numbers are the coordinates of the upper right corner.
52658 * @return bool
52659 * @since PECL ps >= 1.1.0
52660 **/
52661function ps_set_info($p, $key, $val){}
52662
52663/**
52664 * Sets several parameters which are used by many functions. Parameters
52665 * are by definition string values.
52666 *
52667 * @param resource $psdoc Resource identifier of the postscript file as
52668 *   returned by {@link ps_new}.
52669 * @param string $name For a list of possible names see {@link
52670 *   ps_get_parameter}.
52671 * @param string $value The value of the parameter.
52672 * @return bool
52673 * @since PECL ps >= 1.1.0
52674 **/
52675function ps_set_parameter($psdoc, $name, $value){}
52676
52677/**
52678 * Set the position for the next text output. You may alternatively set
52679 * the x and y value separately by calling {@link ps_set_value} and
52680 * choosing textx respectively texty as the value name.
52681 *
52682 * If you want to output text at a certain position it is more convenient
52683 * to use {@link ps_show_xy} instead of setting the text position and
52684 * calling {@link ps_show}.
52685 *
52686 * @param resource $psdoc Resource identifier of the postscript file as
52687 *   returned by {@link ps_new}.
52688 * @param float $x x-coordinate of the new text position.
52689 * @param float $y y-coordinate of the new text position.
52690 * @return bool
52691 * @since PECL ps >= 1.1.0
52692 **/
52693function ps_set_text_pos($psdoc, $x, $y){}
52694
52695/**
52696 * Sets several values which are used by many functions. Parameters are
52697 * by definition float values.
52698 *
52699 * @param resource $psdoc Resource identifier of the postscript file as
52700 *   returned by {@link ps_new}.
52701 * @param string $name The {@link name} can be one of the following:
52702 *   textrendering The way how text is shown. textx The x coordinate for
52703 *   text output. texty The y coordinate for text output. wordspacing The
52704 *   distance between words relative to the width of a space. leading The
52705 *   distance between lines in pixels.
52706 * @param float $value The way how text is shown.
52707 * @return bool
52708 * @since PECL ps >= 1.1.0
52709 **/
52710function ps_set_value($psdoc, $name, $value){}
52711
52712/**
52713 * Creates a shading, which can be used by {@link ps_shfill} or {@link
52714 * ps_shading_pattern}.
52715 *
52716 * The color of the shading can be in any color space except for pattern.
52717 *
52718 * @param resource $psdoc Resource identifier of the postscript file as
52719 *   returned by {@link ps_new}.
52720 * @param string $type The type of shading can be either radial or
52721 *   axial. Each shading starts with the current fill color and ends with
52722 *   the given color values passed in the parameters {@link c1} to {@link
52723 *   c4} (see {@link ps_setcolor} for their meaning).
52724 * @param float $x0 The coordinates {@link x0}, {@link y0}, {@link x1},
52725 *   {@link y1} are the start and end point of the shading. If the type
52726 *   of shading is radial the two points are the middle points of a
52727 *   starting and ending circle.
52728 * @param float $y0 See {@link ps_setcolor} for their meaning.
52729 * @param float $x1 If the shading is of type radial the {@link
52730 *   optlist} must also contain the parameters r0 and r1 with the radius
52731 *   of the start and end circle.
52732 * @param float $y1
52733 * @param float $c1
52734 * @param float $c2
52735 * @param float $c3
52736 * @param float $c4
52737 * @param string $optlist
52738 * @return int
52739 * @since PECL ps >= 1.3.0
52740 **/
52741function ps_shading($psdoc, $type, $x0, $y0, $x1, $y1, $c1, $c2, $c3, $c4, $optlist){}
52742
52743/**
52744 * Creates a pattern based on a shading, which has to be created before
52745 * with {@link ps_shading}. Shading patterns can be used like regular
52746 * patterns.
52747 *
52748 * @param resource $psdoc Resource identifier of the postscript file as
52749 *   returned by {@link ps_new}.
52750 * @param int $shadingid The identifier of a shading previously created
52751 *   with {@link ps_shading}.
52752 * @param string $optlist This argument is not currently used.
52753 * @return int
52754 * @since PECL ps >= 1.3.0
52755 **/
52756function ps_shading_pattern($psdoc, $shadingid, $optlist){}
52757
52758/**
52759 * Fills an area with a shading, which has to be created before with
52760 * {@link ps_shading}. This is an alternative way to creating a pattern
52761 * from a shading {@link ps_shading_pattern} and using the pattern as the
52762 * filling color.
52763 *
52764 * @param resource $psdoc Resource identifier of the postscript file as
52765 *   returned by {@link ps_new}.
52766 * @param int $shadingid The identifier of a shading previously created
52767 *   with {@link ps_shading}.
52768 * @return bool
52769 * @since PECL ps >= 1.3.0
52770 **/
52771function ps_shfill($psdoc, $shadingid){}
52772
52773/**
52774 * Output a text at the current text position. The text position can be
52775 * set by storing the x and y coordinates into the values textx and texty
52776 * with the function {@link ps_set_value}. The function will issue an
52777 * error if a font was not set before with {@link ps_setfont}.
52778 *
52779 * {@link ps_show} evaluates the following parameters and values as set
52780 * by {@link ps_set_parameter} and {@link ps_set_value}.
52781 *
52782 * @param resource $psdoc Resource identifier of the postscript file as
52783 *   returned by {@link ps_new}.
52784 * @param string $text The text to be output.
52785 * @return bool
52786 * @since PECL ps >= 1.1.0
52787 **/
52788function ps_show($psdoc, $text){}
52789
52790/**
52791 * @param resource $psdoc Resource identifier of the postscript file as
52792 *   returned by {@link ps_new}.
52793 * @param string $text
52794 * @param int $len
52795 * @return bool
52796 * @since PECL ps >= 1.1.0
52797 **/
52798function ps_show2($psdoc, $text, $len){}
52799
52800/**
52801 * Outputs a text in a given box. The lower left corner of the box is at
52802 * ({@link left}, {@link bottom}). Line breaks will be inserted where
52803 * needed. Multiple spaces are treated as one. Tabulators are treated as
52804 * spaces.
52805 *
52806 * The text will be hyphenated if the parameter {@link hyphenation} is
52807 * set to true and the parameter {@link hyphendict} contains a valid
52808 * filename for a hyphenation file. The line spacing is taken from the
52809 * value leading. Paragraphs can be separated by an empty line just like
52810 * in TeX. If the value parindent is set to value > 0.0 then the first n
52811 * lines will be indented. The number n of lines is set by the parameter
52812 * numindentlines. In order to prevent indenting of the first m
52813 * paragraphs set the value parindentskip to a positive number.
52814 *
52815 * @param resource $psdoc Resource identifier of the postscript file as
52816 *   returned by {@link ps_new}.
52817 * @param string $text The text to be output into the given box.
52818 * @param float $left x-coordinate of the lower left corner of the box.
52819 * @param float $bottom y-coordinate of the lower left corner of the
52820 *   box.
52821 * @param float $width Width of the box.
52822 * @param float $height Height of the box.
52823 * @param string $hmode The parameter {@link hmode} can be "justify",
52824 *   "fulljustify", "right", "left", or "center". The difference of
52825 *   "justify" and "fulljustify" just affects the last line of the box.
52826 *   In fulljustify mode the last line will be left and right justified
52827 *   unless this is also the last line of paragraph. In justify mode it
52828 *   will always be left justified.
52829 * @param string $feature
52830 * @return int
52831 * @since PECL ps >= 1.1.0
52832 **/
52833function ps_show_boxed($psdoc, $text, $left, $bottom, $width, $height, $hmode, $feature){}
52834
52835/**
52836 * Output a text at the given text position.
52837 *
52838 * @param resource $psdoc Resource identifier of the postscript file as
52839 *   returned by {@link ps_new}.
52840 * @param string $text The text to be output.
52841 * @param float $x x-coordinate of the lower left corner of the box
52842 *   surrounding the text.
52843 * @param float $y y-coordinate of the lower left corner of the box
52844 *   surrounding the text.
52845 * @return bool
52846 * @since PECL ps >= 1.1.0
52847 **/
52848function ps_show_xy($psdoc, $text, $x, $y){}
52849
52850/**
52851 * @param resource $psdoc
52852 * @param string $text
52853 * @param int $len
52854 * @param float $xcoor
52855 * @param float $ycoor
52856 * @return bool
52857 * @since PECL ps >= 1.1.0
52858 **/
52859function ps_show_xy2($psdoc, $text, $len, $xcoor, $ycoor){}
52860
52861/**
52862 * Calculates the width of a string in points if it was output in the
52863 * given font and font size. This function needs an Adobe font metrics
52864 * file to calculate the precise width. If kerning is turned on, it will
52865 * be taken into account.
52866 *
52867 * @param resource $psdoc Resource identifier of the postscript file as
52868 *   returned by {@link ps_new}.
52869 * @param string $text The text for which the width is to be
52870 *   calculated.
52871 * @param int $fontid The identifier of the font to be used. If not
52872 *   font is specified the current font will be used.
52873 * @param float $size The size of the font. If no size is specified the
52874 *   current size is used.
52875 * @return float
52876 * @since PECL ps >= 1.1.0
52877 **/
52878function ps_stringwidth($psdoc, $text, $fontid, $size){}
52879
52880/**
52881 * This function is similar to {@link ps_stringwidth} but returns an
52882 * array of dimensions containing the width, ascender, and descender of
52883 * the text.
52884 *
52885 * @param resource $psdoc Resource identifier of the postscript file as
52886 *   returned by {@link ps_new}.
52887 * @param string $text The text for which the geometry is to be
52888 *   calculated.
52889 * @param int $fontid The identifier of the font to be used. If not
52890 *   font is specified the current font will be used.
52891 * @param float $size The size of the font. If no size is specified the
52892 *   current size is used.
52893 * @return array
52894 * @since PECL ps >= 1.2.0
52895 **/
52896function ps_string_geometry($psdoc, $text, $fontid, $size){}
52897
52898/**
52899 * Draws the path constructed with previously called drawing functions
52900 * like {@link ps_lineto}.
52901 *
52902 * @param resource $psdoc Resource identifier of the postscript file as
52903 *   returned by {@link ps_new}.
52904 * @return bool
52905 * @since PECL ps >= 1.1.0
52906 **/
52907function ps_stroke($psdoc){}
52908
52909/**
52910 * Output the glyph at position {@link ord} in the font encoding vector
52911 * of the current font. The font encoding for a font can be set when
52912 * loading the font with {@link ps_findfont}.
52913 *
52914 * @param resource $psdoc Resource identifier of the postscript file as
52915 *   returned by {@link ps_new}.
52916 * @param int $ord The position of the glyph in the font encoding
52917 *   vector.
52918 * @return bool
52919 * @since PECL ps >= 1.2.0
52920 **/
52921function ps_symbol($psdoc, $ord){}
52922
52923/**
52924 * This function needs an Adobe font metrics file to know which glyphs
52925 * are available.
52926 *
52927 * @param resource $psdoc Resource identifier of the postscript file as
52928 *   returned by {@link ps_new}.
52929 * @param int $ord The parameter {@link ord} is the position of the
52930 *   glyph in the font encoding vector.
52931 * @param int $fontid The identifier of the font to be used. If not
52932 *   font is specified the current font will be used.
52933 * @return string
52934 * @since PECL ps >= 1.2.0
52935 **/
52936function ps_symbol_name($psdoc, $ord, $fontid){}
52937
52938/**
52939 * Calculates the width of a glyph in points if it was output in the
52940 * given font and font size. This function needs an Adobe font metrics
52941 * file to calculate the precise width.
52942 *
52943 * @param resource $psdoc Resource identifier of the postscript file as
52944 *   returned by {@link ps_new}.
52945 * @param int $ord The position of the glyph in the font encoding
52946 *   vector.
52947 * @param int $fontid The identifier of the font to be used. If not
52948 *   font is specified the current font will be used.
52949 * @param float $size The size of the font. If no size is specified the
52950 *   current size is used.
52951 * @return float
52952 * @since PECL ps >= 1.2.0
52953 **/
52954function ps_symbol_width($psdoc, $ord, $fontid, $size){}
52955
52956/**
52957 * Sets a new initial point of the coordinate system.
52958 *
52959 * @param resource $psdoc Resource identifier of the postscript file as
52960 *   returned by {@link ps_new}.
52961 * @param float $x x-coordinate of the origin of the translated
52962 *   coordinate system.
52963 * @param float $y y-coordinate of the origin of the translated
52964 *   coordinate system.
52965 * @return bool
52966 * @since PECL ps >= 1.1.0
52967 **/
52968function ps_translate($psdoc, $x, $y){}
52969
52970/**
52971 * Adds {@link setting} to the server environment. The environment
52972 * variable will only exist for the duration of the current request. At
52973 * the end of the request the environment is restored to its original
52974 * state.
52975 *
52976 * Setting certain environment variables may be a potential security
52977 * breach. The safe_mode_allowed_env_vars directive contains a
52978 * comma-delimited list of prefixes. In Safe Mode, the user may only
52979 * alter environment variables whose names begin with the prefixes
52980 * supplied by this directive. By default, users will only be able to set
52981 * environment variables that begin with PHP_ (e.g. PHP_FOO=BAR). Note:
52982 * if this directive is empty, PHP will let the user modify ANY
52983 * environment variable!
52984 *
52985 * The safe_mode_protected_env_vars directive contains a comma-delimited
52986 * list of environment variables, that the end user won't be able to
52987 * change using {@link putenv}. These variables will be protected even if
52988 * safe_mode_allowed_env_vars is set to allow to change them.
52989 *
52990 * @param string $setting The setting, like "FOO=BAR"
52991 * @return bool
52992 * @since PHP 4, PHP 5
52993 **/
52994function putenv($setting){}
52995
52996/**
52997 * Closes the paradox database. This function will not close the file.
52998 * You will have to call {@link fclose} afterwards.
52999 *
53000 * @param resource $pxdoc Resource identifier of the paradox database
53001 *   as returned by {@link px_new}.
53002 * @return bool
53003 * @since PECL paradox >= 1.0.0
53004 **/
53005function px_close($pxdoc){}
53006
53007/**
53008 * Create a new paradox database file. The actual file has to be opened
53009 * before with {@link fopen}. Make sure the file is writable.
53010 *
53011 * @param resource $pxdoc Resource identifier of the paradox database
53012 *   as returned by {@link px_new}.
53013 * @param resource $file File handle as returned by {@link fopen}.
53014 * @param array $fielddesc fielddesc is an array containing one element
53015 *   for each field specification. A field specification is an array
53016 *   itself with either two or three elements.The first element is always
53017 *   a string value used as the name of the field. It may not be larger
53018 *   than ten characters. The second element contains the field type
53019 *   which is one of the constants listed in the table Constants for
53020 *   field types. In the case of a character field or bcd field, you will
53021 *   have to provide a third element specifying the length respectively
53022 *   the precesion of the field. If your field specification contains
53023 *   blob fields, you will have to make sure to either make the field
53024 *   large enough for all field values to fit or specify a blob file with
53025 *   {@link px_set_blob_file} for storing the blobs. If this is not done
53026 *   the field data is truncated.
53027 * @return bool
53028 * @since PECL paradox >= 1.0.0
53029 **/
53030function px_create_fp($pxdoc, $file, $fielddesc){}
53031
53032/**
53033 * Turns a date as it stored in the paradox file into human readable
53034 * format. Paradox dates are the number of days since 1.1.0000. This
53035 * function is just for convenience. It can be easily replaced by some
53036 * math and the calendar functions as demonstrated in the example below.
53037 *
53038 * @param resource $pxdoc Resource identifier of the paradox database
53039 *   as returned by {@link px_new}.
53040 * @param int $value Value as stored in paradox database field of type
53041 *   PX_FIELD_DATE.
53042 * @param string $format String format similar to the format used by
53043 *   {@link date}. The placeholders support by this function is a subset
53044 *   of those supported by {@link date} (Y, y, m, n, d, j, L).
53045 * @return string
53046 * @since PECL paradox >= 1.4.0
53047 **/
53048function px_date2string($pxdoc, $value, $format){}
53049
53050/**
53051 * Deletes the resource of the paradox file and frees all memory.
53052 *
53053 * @param resource $pxdoc Resource identifier of the paradox database
53054 *   as returned by {@link px_new}.
53055 * @return bool
53056 * @since PECL paradox >= 1.0.0
53057 **/
53058function px_delete($pxdoc){}
53059
53060/**
53061 * This function deletes a record from the database. It does not free the
53062 * space in the database file but just marks it as deleted. Inserting a
53063 * new record afterwards will reuse the space.
53064 *
53065 * @param resource $pxdoc Resource identifier of the paradox database
53066 *   as returned by {@link px_new}.
53067 * @param int $num The record number is an artificial number counting
53068 *   records in the order as they are stored in the database. The first
53069 *   record has number 0.
53070 * @return bool
53071 * @since PECL paradox >= 1.4.0
53072 **/
53073function px_delete_record($pxdoc, $num){}
53074
53075/**
53076 * @param resource $pxdoc Resource identifier of the paradox database
53077 *   as returned by {@link px_new}.
53078 * @param int $fieldno Number of the field. The first field has number
53079 *   0. Specifying a field number less than 0 and greater or equal the
53080 *   number of fields will trigger an error.
53081 * @return array
53082 * @since PECL paradox >= 1.0.0
53083 **/
53084function px_get_field($pxdoc, $fieldno){}
53085
53086/**
53087 * @param resource $pxdoc Resource identifier of the paradox database
53088 *   as returned by {@link px_new}.
53089 * @return array
53090 * @since PECL paradox >= 1.0.0
53091 **/
53092function px_get_info($pxdoc){}
53093
53094/**
53095 * Gets various parameters.
53096 *
53097 * @param resource $pxdoc Resource identifier of the paradox database
53098 *   as returned by {@link px_new}.
53099 * @param string $name The {@link name} can be one of the following:
53100 * @return string
53101 * @since PECL paradox >= 1.1.0
53102 **/
53103function px_get_parameter($pxdoc, $name){}
53104
53105/**
53106 * @param resource $pxdoc Resource identifier of the paradox database
53107 *   as returned by {@link px_new}.
53108 * @param int $num The record number is an artificial number counting
53109 *   records in the order as they are stored in the database. The first
53110 *   record has number 0.
53111 * @param int $mode The optional {@link mode} can be PX_KEYTOLOWER or
53112 *   PX_KEYTOUPPER in order to convert the keys of the returned array
53113 *   into lower or upper case. If {@link mode} is not passed or is 0,
53114 *   then the key will be exactly like the field name. The element values
53115 *   will contain the field values. NULL values will be retained and are
53116 *   different from 0.0, 0 or the empty string. Fields of type
53117 *   PX_FIELD_TIME will be returned as an integer counting the number of
53118 *   milliseconds starting at midnight. A timestamp (PX_FIELD_TIMESTAMP)
53119 *   and date (PX_FIELD_DATE) are floating point respectively int values
53120 *   counting milliseconds respectively days starting at the beginning of
53121 *   julian calendar. Use the functions {@link px-timestamp2string} and
53122 *   {@link px-date2string} to convert them into a character
53123 *   representation.
53124 * @return array
53125 * @since PECL paradox >= 1.0.0
53126 **/
53127function px_get_record($pxdoc, $num, $mode){}
53128
53129/**
53130 * {@link px_get_schema} returns the database schema.
53131 *
53132 * @param resource $pxdoc Resource identifier of the paradox database
53133 *   as returned by {@link px_new}.
53134 * @param int $mode If the optional {@link mode} is PX_KEYTOLOWER or
53135 *   PX_KEYTOUPPER the keys of the returned array will be converted to
53136 *   lower or upper case. If {@link mode} is 0 or not passed at all, then
53137 *   the key name will be identical to the field name.
53138 * @return array
53139 * @since PECL paradox >= 1.0.0
53140 **/
53141function px_get_schema($pxdoc, $mode){}
53142
53143/**
53144 * Gets various values.
53145 *
53146 * @param resource $pxdoc Resource identifier of the paradox database
53147 *   as returned by {@link px_new}.
53148 * @param string $name {@link name} can be one of the following.
53149 *   numprimkeys The number of primary keys. Paradox databases always use
53150 *   the first numprimkeys fields for the primary index.
53151 * @return float
53152 * @since PECL paradox >= 1.1.0
53153 **/
53154function px_get_value($pxdoc, $name){}
53155
53156/**
53157 * Inserts a new record into the database. The record is not necessarily
53158 * inserted at the end of the database, but may be inserted at any
53159 * position depending on where the first free slot is found.
53160 *
53161 * The record data is passed as an array of field values. The elements in
53162 * the array must correspond to the fields in the database. If the array
53163 * has less elements than fields in the database, the remaining fields
53164 * will be set to null.
53165 *
53166 * Most field values can be passed as its equivalent php type e.g. a long
53167 * value is used for fields of type PX_FIELD_LONG, PX_FIELD_SHORT and
53168 * PX_FIELD_AUTOINC, a double values is used for fields of type
53169 * PX_FIELD_CURRENCY and PX_FIELD_NUMBER. Field values for blob and alpha
53170 * fields are passed as strings.
53171 *
53172 * Fields of type PX_FIELD_TIME and PX_FIELD_DATE both require a long
53173 * value. In the first case this is the number of milliseconds since
53174 * midnight. In the second case this is the number of days since
53175 * 1.1.0000. Below there are two examples to convert the current date or
53176 * timestamp into a value suitable for one of paradox's date/time fields.
53177 *
53178 * @param resource $pxdoc Resource identifier of the paradox database
53179 *   as returned by {@link px_new}.
53180 * @param array $data Associated or indexed array containing the field
53181 *   values as e.g. returned by {@link px_retrieve_record}.
53182 * @return int
53183 * @since PECL paradox >= 1.4.0
53184 **/
53185function px_insert_record($pxdoc, $data){}
53186
53187/**
53188 * Create a new paradox object. You will have to call this function
53189 * before any further functions. {@link px_new} does not create any file
53190 * on the disk, it just creates an instance of a paradox object. This
53191 * function must not be called if the object oriented interface is used.
53192 * Use new paradox_db() instead.
53193 *
53194 * @return resource
53195 * @since PECL paradox >= 1.0.0
53196 **/
53197function px_new(){}
53198
53199/**
53200 * Get the number of fields in a database file.
53201 *
53202 * @param resource $pxdoc Resource identifier of the paradox database
53203 *   as returned by {@link px_new}.
53204 * @return int
53205 * @since PECL paradox >= 1.0.0
53206 **/
53207function px_numfields($pxdoc){}
53208
53209/**
53210 * Get the number of records in a database file.
53211 *
53212 * @param resource $pxdoc Resource identifier of the paradox database
53213 *   as returned by {@link px_new}.
53214 * @return int
53215 * @since PECL paradox >= 1.0.0
53216 **/
53217function px_numrecords($pxdoc){}
53218
53219/**
53220 * Open an existing paradox database file. The actual file has to be
53221 * opened before with {@link fopen}. This function can also be used to
53222 * open primary index files and tread them like a paradox database. This
53223 * is supported for those who would like to investigate a primary index.
53224 * It cannot be used to accelerate access to a database file.
53225 *
53226 * @param resource $pxdoc Resource identifier of the paradox database
53227 *   as returned by {@link px_new}.
53228 * @param resource $file {@link file} is the return value from {@link
53229 *   fopen} with the actual database file as parameter. Make sure the
53230 *   database is writable if you plan to update or insert records.
53231 * @return bool
53232 * @since PECL paradox >= 1.0.0
53233 **/
53234function px_open_fp($pxdoc, $file){}
53235
53236/**
53237 * Stores a record into a paradox database. The record is always added at
53238 * the end of the database, regardless of any free slots. Use {@link
53239 * px_insert_record} to add a new record into the first free slot found
53240 * in the database.
53241 *
53242 * @param resource $pxdoc Resource identifier of the paradox database
53243 *   as returned by {@link px_new}.
53244 * @param array $record Associated or indexed array containing the
53245 *   field values as e.g. returned by {@link px_retrieve_record}.
53246 * @param int $recpos This optional parameter may be used to specify a
53247 *   record number greater than the current number of records in the
53248 *   database. The function will add as many empty records as needed.
53249 *   There is hardly any need for this parameter.
53250 * @return bool
53251 * @since PECL paradox >= 1.0.0
53252 **/
53253function px_put_record($pxdoc, $record, $recpos){}
53254
53255/**
53256 * This function is very similar to {@link px_get_record} but uses
53257 * internally a different approach to retrieve the data. It relies on
53258 * pxlib for reading each single field value, which usually results in
53259 * support for more field types.
53260 *
53261 * @param resource $pxdoc Resource identifier of the paradox database
53262 *   as returned by {@link px_new}.
53263 * @param int $num The record number is an artificial number counting
53264 *   records in the order as they are stored in the database. The first
53265 *   record has number 0.
53266 * @param int $mode The optional {@link mode} can be PX_KEYTOLOWER or
53267 *   PX_KEYTOUPPER in order to convert the keys into lower or upper case.
53268 *   If {@link mode} is not passed or is 0, then the key will be exactly
53269 *   like the field name. The element values will contain the field
53270 *   values. NULL values will be retained and are different from 0.0, 0
53271 *   or the empty string. Fields of type PX_FIELD_TIME will be returned
53272 *   as an integer counting the number of milliseconds starting at
53273 *   midnight. A timestamp is a floating point value also counting
53274 *   milliseconds starting at the beginning of julian calendar.
53275 * @return array
53276 * @since PECL paradox >= 1.4.0
53277 **/
53278function px_retrieve_record($pxdoc, $num, $mode){}
53279
53280/**
53281 * Sets the name of the file where blobs are going to be read from or
53282 * written into. Without calling this function, {@link px_get_record} or
53283 * {@link px_retrieve_record} will only return data in blob fields if the
53284 * data is part of the record and not stored in the blob file. Blob data
53285 * is stored in the record if it is small enough to fit in the size of
53286 * the blob field.
53287 *
53288 * Calling {@link px_put_record}, {@link px_insert_record}, or {@link
53289 * px_update_record} without calling {@link px_set_blob_file} will result
53290 * in truncated blob fields unless the data fits into the database file.
53291 *
53292 * Calling this function twice will close the first blob file and open
53293 * the new one.
53294 *
53295 * @param resource $pxdoc Resource identifier of the paradox database
53296 *   as returned by {@link px_new}.
53297 * @param string $filename The name of the file. Its extension should
53298 *   be .MB.
53299 * @return bool
53300 * @since PECL paradox >= 1.3.0
53301 **/
53302function px_set_blob_file($pxdoc, $filename){}
53303
53304/**
53305 * Sets various parameters.
53306 *
53307 * @param resource $pxdoc Resource identifier of the paradox database
53308 *   as returned by {@link px_new}.
53309 * @param string $name Depending on the parameter you want to set,
53310 *   {@link name} can be one of the following.
53311 * @param string $value The name of the table as it will be stored in
53312 *   the database header.
53313 * @return bool
53314 * @since PECL paradox >= 1.1.0
53315 **/
53316function px_set_parameter($pxdoc, $name, $value){}
53317
53318/**
53319 * Sets the table name of a paradox database, which was created with
53320 * {@link px_create_fp}. This function is deprecated use {@link
53321 * px_set_parameter} instead.
53322 *
53323 * @param resource $pxdoc Resource identifier of the paradox database
53324 *   as returned by {@link px_new}.
53325 * @param string $name The name of the table. If it is not set
53326 *   explicitly it will be set to the name of the database file.
53327 * @return void
53328 * @since PECL paradox >= 1.0.0
53329 **/
53330function px_set_tablename($pxdoc, $name){}
53331
53332/**
53333 * Set the encoding for data retrieved from a character field. All
53334 * character fields will be recoded to the encoding set by this function.
53335 * If the encoding is not set, the character data will be returned in the
53336 * DOS code page encoding as specified in the database file. The {@link
53337 * encoding} can be any string identifier known to iconv or recode. On
53338 * Unix systems run iconv -l for a list of available encodings.
53339 *
53340 * This function is deprecated and should be replaced by calling {@link
53341 * px_set_parameter}.
53342 *
53343 * See also {@link px_get_info} to determine the DOS code page as stored
53344 * in the database file.
53345 *
53346 * @param resource $pxdoc Resource identifier of the paradox database
53347 *   as returned by {@link px_new}.
53348 * @param string $encoding The encoding for the output. Data which is
53349 *   being read from character fields is recoded into the targetencoding.
53350 * @return bool
53351 * @since PECL paradox >= 1.0.0
53352 **/
53353function px_set_targetencoding($pxdoc, $encoding){}
53354
53355/**
53356 * Sets various values.
53357 *
53358 * @param resource $pxdoc Resource identifier of the paradox database
53359 *   as returned by {@link px_new}.
53360 * @param string $name {@link name} can be one of the following.
53361 * @param float $value The number of primary keys. Paradox databases
53362 *   always use the first numprimkeys fields for the primary index.
53363 * @return bool
53364 * @since PECL paradox >= 1.1.0
53365 **/
53366function px_set_value($pxdoc, $name, $value){}
53367
53368/**
53369 * Turns a timestamp as it stored in the paradox file into human readable
53370 * format. Paradox timestamps are the number of miliseconds since
53371 * 0001-01-02. This function is just for convenience. It can be easily
53372 * replaced by some math and the calendar functions as demonstrated in
53373 * the following example.
53374 *
53375 * @param resource $pxdoc Resource identifier of the paradox database.
53376 * @param float $value Value as stored in paradox database field of
53377 *   type PX_FIELD_TIME, or PX_FIELD_TIMESTAMP.
53378 * @param string $format String format similar to the format used by
53379 *   {@link date}. The placeholders support by this function is a subset
53380 *   of those supported by {@link date} (Y, y, m, n, d, j, H, h, G, g, i,
53381 *   s, A, a, L).
53382 * @return string
53383 * @since PECL paradox >= 1.4.0
53384 **/
53385function px_timestamp2string($pxdoc, $value, $format){}
53386
53387/**
53388 * Updates an exiting record in the database. The record starts at 0.
53389 *
53390 * The record data is passed as an array of field values. The elements in
53391 * the array must correspond to the fields in the database. If the array
53392 * has less elements than fields in the database, the remaining fields
53393 * will be set to null.
53394 *
53395 * @param resource $pxdoc Resource identifier of the paradox database
53396 *   as returned by {@link px_new}.
53397 * @param array $data Associated array containing the field values as
53398 *   returned by {@link px_retrieve_record}.
53399 * @param int $num The record number is an artificial number counting
53400 *   records in the order as they are stored in the database. The first
53401 *   record has number 0.
53402 * @return bool
53403 * @since PECL paradox >= 1.4.0
53404 **/
53405function px_update_record($pxdoc, $data, $num){}
53406
53407/**
53408 * @return string
53409 * @since PHP 4 >= 4.0.5
53410 **/
53411function qdom_error(){}
53412
53413/**
53414 * @param string $doc
53415 * @return QDomDocument
53416 * @since PHP 4 >= 4.0.4
53417 **/
53418function qdom_tree($doc){}
53419
53420/**
53421 * This function returns an 8-bit binary string corresponding to the
53422 * decoded quoted printable string (according to RFC2045, section 6.7,
53423 * not RFC2821, section 4.5.2, so additional periods are not stripped
53424 * from the beginning of line).
53425 *
53426 * This function is similar to {@link imap_qprint}, except this one does
53427 * not require the IMAP module to work.
53428 *
53429 * @param string $str The input string.
53430 * @return string
53431 * @since PHP 4, PHP 5
53432 **/
53433function quoted_printable_decode($str){}
53434
53435/**
53436 * Returns a quoted printable string created according to RFC2045,
53437 * section 6.7.
53438 *
53439 * This function is similar to {@link imap_8bit}, except this one does
53440 * not require the IMAP module to work.
53441 *
53442 * @param string $str The input string.
53443 * @return string
53444 * @since PHP 5 >= 5.3.0
53445 **/
53446function quoted_printable_encode($str){}
53447
53448/**
53449 * Returns a version of str with a backslash character (\) before every
53450 * character that is among these: . \ + * ? [ ^ ] ( $ )
53451 *
53452 * @param string $str The input string.
53453 * @return string
53454 * @since PHP 4, PHP 5
53455 **/
53456function quotemeta($str){}
53457
53458/**
53459 * This function converts {@link number} from radian to degrees.
53460 *
53461 * @param float $number A radian value
53462 * @return float
53463 * @since PHP 4, PHP 5
53464 **/
53465function rad2deg($number){}
53466
53467/**
53468 * @return resource
53469 * @since PECL radius >= 1.1.0
53470 **/
53471function radius_acct_open(){}
53472
53473/**
53474 * {@link radius_add_server} may be called multiple times, and it may be
53475 * used together with {@link radius_config}. At most 10 servers may be
53476 * specified. When multiple servers are given, they are tried in
53477 * round-robin fashion until a valid response is received, or until each
53478 * server's {@link max_tries} limit has been reached.
53479 *
53480 * @param resource $radius_handle
53481 * @param string $hostname The {@link hostname} parameter specifies the
53482 *   server host, either as a fully qualified domain name or as a
53483 *   dotted-quad IP address in text form.
53484 * @param int $port The {@link port} specifies the UDP port to contact
53485 *   on the server. If port is given as 0, the library looks up the
53486 *   radius/udp or radacct/udp service in the network services database,
53487 *   and uses the port found there. If no entry is found, the library
53488 *   uses the standard Radius ports, 1812 for authentication and 1813 for
53489 *   accounting.
53490 * @param string $secret The shared secret for the server host is
53491 *   passed to the {@link secret} parameter. The Radius protocol ignores
53492 *   all but the leading 128 bytes of the shared secret.
53493 * @param int $timeout The timeout for receiving replies from the
53494 *   server is passed to the {@link timeout} parameter, in units of
53495 *   seconds.
53496 * @param int $max_tries The maximum number of repeated requests to
53497 *   make before giving up is passed into the {@link max_tries}.
53498 * @return bool
53499 * @since PECL radius >= 1.1.0
53500 **/
53501function radius_add_server($radius_handle, $hostname, $port, $secret, $timeout, $max_tries){}
53502
53503/**
53504 * @return resource
53505 * @since PECL radius >= 1.1.0
53506 **/
53507function radius_auth_open(){}
53508
53509/**
53510 * It is not needed to call this function because php frees all resources
53511 * at the end of each request.
53512 *
53513 * @param resource $radius_handle
53514 * @return bool
53515 * @since PECL radius >= 1.1.0
53516 **/
53517function radius_close($radius_handle){}
53518
53519/**
53520 * Before issuing any Radius requests, the library must be made aware of
53521 * the servers it can contact. The easiest way to configure the library
53522 * is to call {@link radius_config}. {@link radius_config} causes the
53523 * library to read a configuration file whose format is described in
53524 * radius.conf.
53525 *
53526 * @param resource $radius_handle
53527 * @param string $file The pathname of the configuration file is passed
53528 *   as the file argument to {@link radius_config}. The library can also
53529 *   be configured programmatically by calls to {@link
53530 *   radius_add_server}.
53531 * @return bool
53532 * @since PECL radius >= 1.1.0
53533 **/
53534function radius_config($radius_handle, $file){}
53535
53536/**
53537 * A Radius request consists of a code specifying the kind of request,
53538 * and zero or more attributes which provide additional information. To
53539 * begin constructing a new request, call {@link radius_create_request}.
53540 *
53541 * @param resource $radius_handle
53542 * @param int $type Type is RADIUS_ACCESS_REQUEST or
53543 *   RADIUS_ACCOUNTING_REQUEST.
53544 * @return bool
53545 * @since PECL radius >= 1.1.0
53546 **/
53547function radius_create_request($radius_handle, $type){}
53548
53549/**
53550 * @param string $data
53551 * @return string
53552 * @since PECL radius >= 1.1.0
53553 **/
53554function radius_cvt_addr($data){}
53555
53556/**
53557 * @param string $data
53558 * @return int
53559 * @since PECL radius >= 1.1.0
53560 **/
53561function radius_cvt_int($data){}
53562
53563/**
53564 * @param string $data
53565 * @return string
53566 * @since PECL radius >= 1.1.0
53567 **/
53568function radius_cvt_string($data){}
53569
53570/**
53571 * Some data (Passwords, MS-CHAPv1 MPPE-Keys) is mangled for security
53572 * reasons, and must be demangled before you can use them.
53573 *
53574 * @param resource $radius_handle
53575 * @param string $mangled
53576 * @return string
53577 * @since PECL radius >= 1.2.0
53578 **/
53579function radius_demangle($radius_handle, $mangled){}
53580
53581/**
53582 * When using MPPE with MS-CHAPv2, the send- and recv-keys are mangled
53583 * (see RFC 2548), however this function is useless, because I don't
53584 * think that there is or will be a PPTP-MPPE implementation in PHP.
53585 *
53586 * @param resource $radius_handle
53587 * @param string $mangled
53588 * @return string
53589 * @since PECL radius >= 1.2.0
53590 **/
53591function radius_demangle_mppe_key($radius_handle, $mangled){}
53592
53593/**
53594 * Like Radius requests, each response may contain zero or more
53595 * attributes. After a response has been received successfully by {@link
53596 * radius_send_request}, its attributes can be extracted one by one using
53597 * {@link radius_get_attr}. Each time {@link radius_get_attr} is called,
53598 * it gets the next attribute from the current response.
53599 *
53600 * @param resource $radius_handle
53601 * @return mixed
53602 * @since PECL radius >= 1.1.0
53603 **/
53604function radius_get_attr($radius_handle){}
53605
53606/**
53607 * If {@link radius_get_attr} returns RADIUS_VENDOR_SPECIFIC, {@link
53608 * radius_get_vendor_attr} may be called to determine the vendor.
53609 *
53610 * @param string $data
53611 * @return array
53612 * @since PECL radius >= 1.1.0
53613 **/
53614function radius_get_vendor_attr($data){}
53615
53616/**
53617 * @param resource $radius_handle
53618 * @param int $type
53619 * @param string $addr
53620 * @return bool
53621 * @since PECL radius >= 1.1.0
53622 **/
53623function radius_put_addr($radius_handle, $type, $addr){}
53624
53625/**
53626 * @param resource $radius_handle
53627 * @param int $type
53628 * @param string $value
53629 * @return bool
53630 * @since PECL radius >= 1.1.0
53631 **/
53632function radius_put_attr($radius_handle, $type, $value){}
53633
53634/**
53635 * @param resource $radius_handle
53636 * @param int $type
53637 * @param int $value
53638 * @return bool
53639 * @since PECL radius >= 1.1.0
53640 **/
53641function radius_put_int($radius_handle, $type, $value){}
53642
53643/**
53644 * @param resource $radius_handle
53645 * @param int $type
53646 * @param string $value
53647 * @return bool
53648 * @since PECL radius >= 1.1.0
53649 **/
53650function radius_put_string($radius_handle, $type, $value){}
53651
53652/**
53653 * @param resource $radius_handle
53654 * @param int $vendor
53655 * @param int $type
53656 * @param string $addr
53657 * @return bool
53658 * @since PECL radius >= 1.1.0
53659 **/
53660function radius_put_vendor_addr($radius_handle, $vendor, $type, $addr){}
53661
53662/**
53663 * @param resource $radius_handle
53664 * @param int $vendor
53665 * @param int $type
53666 * @param string $value
53667 * @return bool
53668 * @since PECL radius >= 1.1.0
53669 **/
53670function radius_put_vendor_attr($radius_handle, $vendor, $type, $value){}
53671
53672/**
53673 * @param resource $radius_handle
53674 * @param int $vendor
53675 * @param int $type
53676 * @param int $value
53677 * @return bool
53678 * @since PECL radius >= 1.1.0
53679 **/
53680function radius_put_vendor_int($radius_handle, $vendor, $type, $value){}
53681
53682/**
53683 * @param resource $radius_handle
53684 * @param int $vendor
53685 * @param int $type
53686 * @param string $value
53687 * @return bool
53688 * @since PECL radius >= 1.1.0
53689 **/
53690function radius_put_vendor_string($radius_handle, $vendor, $type, $value){}
53691
53692/**
53693 * The request authenticator is needed for demangling mangled data like
53694 * passwords and encryption-keys.
53695 *
53696 * @param resource $radius_handle
53697 * @return string
53698 * @since PECL radius >= 1.1.0
53699 **/
53700function radius_request_authenticator($radius_handle){}
53701
53702/**
53703 * After the Radius request has been constructed, it is sent by {@link
53704 * radius_send_request}.
53705 *
53706 * The {@link radius_send_request} function sends the request and waits
53707 * for a valid reply, retrying the defined servers in round-robin fashion
53708 * as necessary.
53709 *
53710 * @param resource $radius_handle
53711 * @return int
53712 * @since PECL radius >= 1.1.0
53713 **/
53714function radius_send_request($radius_handle){}
53715
53716/**
53717 * The shared secret is needed as salt for demangling mangled data like
53718 * passwords and encryption-keys.
53719 *
53720 * @param resource $radius_handle
53721 * @return string
53722 * @since PECL radius >= 1.1.0
53723 **/
53724function radius_server_secret($radius_handle){}
53725
53726/**
53727 * If Radius-functions fail then they record an error message. This error
53728 * message can be retrieved with this function.
53729 *
53730 * @param resource $radius_handle
53731 * @return string
53732 * @since PECL radius >= 1.1.0
53733 **/
53734function radius_strerror($radius_handle){}
53735
53736/**
53737 * @return int
53738 * @since PHP 4, PHP 5
53739 **/
53740function rand(){}
53741
53742/**
53743 * Create an array containing a range of elements.
53744 *
53745 * @param mixed $low Low value.
53746 * @param mixed $high High value.
53747 * @param number $step If a {@link step} value is given, it will be
53748 *   used as the increment between elements in the sequence. {@link step}
53749 *   should be given as a positive number. If not specified, {@link step}
53750 *   will default to 1.
53751 * @return array
53752 * @since PHP 4, PHP 5
53753 **/
53754function range($low, $high, $step){}
53755
53756/**
53757 * This method defines whether broken archives can be read or all the
53758 * operations that attempt to extract the archive entries will fail.
53759 * Broken archives are archives for which no error is detected when the
53760 * file is opened but an error occurs when reading the entries.
53761 *
53762 * @param RarArchive $rarfile A RarArchive object, opened with {@link
53763 *   rar_open}.
53764 * @param bool $allow_broken Whether to allow reading broken files ()
53765 *   or not ().
53766 * @return bool
53767 * @since PECL rar >= 3.0.0
53768 **/
53769function rar_allow_broken_set($rarfile, $allow_broken){}
53770
53771/**
53772 * This function determines whether an archive is incomplete, i.e., if a
53773 * volume is missing or a volume is truncated.
53774 *
53775 * @param RarArchive $rarfile A RarArchive object, opened with {@link
53776 *   rar_open}.
53777 * @return bool
53778 * @since PECL rar >= 3.0.0
53779 **/
53780function rar_broken_is($rarfile){}
53781
53782/**
53783 * Close RAR archive and free all allocated resources.
53784 *
53785 * @param RarArchive $rarfile A RarArchive object, opened with {@link
53786 *   rar_open}.
53787 * @return bool
53788 * @since PECL rar >= 0.1
53789 **/
53790function rar_close($rarfile){}
53791
53792/**
53793 * Get the (global) comment stored in the RAR archive. It may be up to 64
53794 * KiB long.
53795 *
53796 * @param RarArchive $rarfile A RarArchive object, opened with {@link
53797 *   rar_open}.
53798 * @return string
53799 * @since PECL rar >= 2.0.0
53800 **/
53801function rar_comment_get($rarfile){}
53802
53803/**
53804 * Get entry object (file or directory) from the RAR archive.
53805 *
53806 * @param RarArchive $rarfile A RarArchive object, opened with {@link
53807 *   rar_open}.
53808 * @param string $entryname Path to the entry within the RAR archive.
53809 * @return RarEntry
53810 * @since PECL rar >= 0.1
53811 **/
53812function rar_entry_get($rarfile, $entryname){}
53813
53814/**
53815 * Get entries list (files and directories) from the RAR archive.
53816 *
53817 * @param RarArchive $rarfile A RarArchive object, opened with {@link
53818 *   rar_open}.
53819 * @return array
53820 * @since PECL rar >= 0.1
53821 **/
53822function rar_list($rarfile){}
53823
53824/**
53825 * Open specified RAR archive and return RarArchive instance representing
53826 * it.
53827 *
53828 * @param string $filename Path to the Rar archive.
53829 * @param string $password A plain password, if needed to decrypt the
53830 *   headers. It will also be used by default if encrypted files are
53831 *   found. Note that the files may have different passwords in respect
53832 *   to the headers and among them.
53833 * @param callback $volume_callback A function that receives one
53834 *   parameter – the path of the volume that was not found – and
53835 *   returns a string with the correct path for such volume or NULL if
53836 *   such volume does not exist or is not known. The programmer should
53837 *   ensure the passed function doesn't cause loops as this function is
53838 *   called repetedly if the path returned in a previous call did not
53839 *   correspond to the needed volume. Specifying this parameter omits the
53840 *   notice that would otherwise be emitted whenever a volume is not
53841 *   found; an implementation that only returns can therefore be used to
53842 *   merely omit such notices.
53843 * @return RarArchive
53844 * @since PECL rar >= 0.1
53845 **/
53846function rar_open($filename, $password, $volume_callback){}
53847
53848/**
53849 * Check whether the RAR archive is solid. Individual file extraction is
53850 * slower on solid archives.
53851 *
53852 * @param RarArchive $rarfile A RarArchive object, opened with {@link
53853 *   rar_open}.
53854 * @return bool
53855 * @since PECL rar >= 2.0.0
53856 **/
53857function rar_solid_is($rarfile){}
53858
53859/**
53860 * @return string
53861 * @since PECL rar >= 3.0.0
53862 **/
53863function rar_wrapper_cache_stats(){}
53864
53865/**
53866 * Returns a string in which the sequences with percent (%) signs
53867 * followed by two hex digits have been replaced with literal characters.
53868 *
53869 * @param string $str The URL to be decoded.
53870 * @return string
53871 * @since PHP 4, PHP 5
53872 **/
53873function rawurldecode($str){}
53874
53875/**
53876 * Encodes the given string according to RFC 1738.
53877 *
53878 * @param string $str The URL to be encoded.
53879 * @return string
53880 * @since PHP 4, PHP 5
53881 **/
53882function rawurlencode($str){}
53883
53884/**
53885 * Returns the filename of the next file from the directory. The
53886 * filenames are returned in the order in which they are stored by the
53887 * filesystem.
53888 *
53889 * @param resource $dir_handle The directory handle resource previously
53890 *   opened with {@link opendir}. If the directory handle is not
53891 *   specified, the last link opened by {@link opendir} is assumed.
53892 * @return string
53893 * @since PHP 4, PHP 5
53894 **/
53895function readdir($dir_handle){}
53896
53897/**
53898 * Reads a file and writes it to the output buffer.
53899 *
53900 * @param string $filename The filename being read.
53901 * @param bool $use_include_path You can use the optional second
53902 *   parameter and set it to , if you want to search for the file in the
53903 *   include_path, too.
53904 * @param resource $context A context stream resource.
53905 * @return int
53906 * @since PHP 4, PHP 5
53907 **/
53908function readfile($filename, $use_include_path, $context){}
53909
53910/**
53911 * Reads a file, decompresses it and writes it to standard output.
53912 *
53913 * {@link readgzfile} can be used to read a file which is not in gzip
53914 * format; in this case {@link readgzfile} will directly read from the
53915 * file without decompression.
53916 *
53917 * @param string $filename The file name. This file will be opened from
53918 *   the filesystem and its contents written to standard output.
53919 * @param int $use_include_path You can set this optional parameter to
53920 *   1, if you want to search for the file in the include_path too.
53921 * @return int
53922 * @since PHP 4, PHP 5
53923 **/
53924function readgzfile($filename, $use_include_path){}
53925
53926/**
53927 * Reads a single line from the user. You must add this line to the
53928 * history yourself using {@link readline_add_history}.
53929 *
53930 * @param string $prompt You may specify a string with which to prompt
53931 *   the user.
53932 * @return string
53933 * @since PHP 4, PHP 5
53934 **/
53935function readline($prompt){}
53936
53937/**
53938 * This function adds a line to the command line history.
53939 *
53940 * @param string $line The line to be added in the history.
53941 * @return bool
53942 * @since PHP 4, PHP 5
53943 **/
53944function readline_add_history($line){}
53945
53946/**
53947 * Sets up a readline callback interface then prints {@link prompt} and
53948 * immediately returns. Calling this function twice without removing the
53949 * previous callback interface will automatically and conveniently
53950 * overwrite the old interface.
53951 *
53952 * The callback feature is useful when combined with {@link
53953 * stream_select} as it allows interleaving of IO and user input, unlike
53954 * {@link readline}.
53955 *
53956 * @param string $prompt The prompt message.
53957 * @param callback $callback The {@link callback} function takes one
53958 *   parameter; the user input returned.
53959 * @return bool
53960 * @since PHP 5 >= 5.1.0
53961 **/
53962function readline_callback_handler_install($prompt, $callback){}
53963
53964/**
53965 * Removes a previously installed callback handler and restores terminal
53966 * settings.
53967 *
53968 * @return bool
53969 * @since PHP 5 >= 5.1.0
53970 **/
53971function readline_callback_handler_remove(){}
53972
53973/**
53974 * Reads a character of user input. When a line is received, this
53975 * function informs the readline callback interface installed using
53976 * {@link readline_callback_handler_install} that a line is ready for
53977 * input.
53978 *
53979 * @return void
53980 * @since PHP 5 >= 5.1.0
53981 **/
53982function readline_callback_read_char(){}
53983
53984/**
53985 * This function clears the entire command line history.
53986 *
53987 * @return bool
53988 * @since PHP 4, PHP 5
53989 **/
53990function readline_clear_history(){}
53991
53992/**
53993 * This function registers a completion function. This is the same kind
53994 * of functionality you'd get if you hit your tab key while using Bash.
53995 *
53996 * @param callback $function You must supply the name of an existing
53997 *   function which accepts a partial command line and returns an array
53998 *   of possible matches.
53999 * @return bool
54000 * @since PHP 4, PHP 5
54001 **/
54002function readline_completion_function($function){}
54003
54004/**
54005 * Gets or sets various internal readline variables.
54006 *
54007 * @param string $varname A variable name.
54008 * @param string $newvalue If provided, this will be the new value of
54009 *   the setting.
54010 * @return mixed
54011 * @since PHP 4, PHP 5
54012 **/
54013function readline_info($varname, $newvalue){}
54014
54015/**
54016 * Gets the entire command line history.
54017 *
54018 * @return array
54019 * @since PHP 4, PHP 5
54020 **/
54021function readline_list_history(){}
54022
54023/**
54024 * Tells readline that the cursor has moved to a new line.
54025 *
54026 * @return void
54027 * @since PHP 5 >= 5.1.0
54028 **/
54029function readline_on_new_line(){}
54030
54031/**
54032 * This function reads a command history from a file.
54033 *
54034 * @param string $filename Path to the filename containing the command
54035 *   history.
54036 * @return bool
54037 * @since PHP 4, PHP 5
54038 **/
54039function readline_read_history($filename){}
54040
54041/**
54042 * Redraws readline to redraw the display.
54043 *
54044 * @return void
54045 * @since PHP 5 >= 5.1.0
54046 **/
54047function readline_redisplay(){}
54048
54049/**
54050 * This function writes the command history to a file.
54051 *
54052 * @param string $filename Path to the saved file.
54053 * @return bool
54054 * @since PHP 4, PHP 5
54055 **/
54056function readline_write_history($filename){}
54057
54058/**
54059 * {@link readlink} does the same as the readlink C function.
54060 *
54061 * @param string $path The symbolic link path.
54062 * @return string
54063 * @since PHP 4, PHP 5
54064 **/
54065function readlink($path){}
54066
54067/**
54068 * {@link read_exif_data} reads the EXIF headers from a JPEG or TIFF
54069 * image file. This way you can read meta data generated by digital
54070 * cameras.
54071 *
54072 * EXIF headers tend to be present in JPEG/TIFF images generated by
54073 * digital cameras, but unfortunately each digital camera maker has a
54074 * different idea of how to actually tag their images, so you can't
54075 * always rely on a specific Exif header being present.
54076 *
54077 * Height and Width are computed the same way {@link getimagesize} does
54078 * so their values must not be part of any header returned. Also, html is
54079 * a height/width text string to be used inside normal HTML.
54080 *
54081 * When an Exif header contains a Copyright note, this itself can contain
54082 * two values. As the solution is inconsistent in the Exif 2.10 standard,
54083 * the COMPUTED section will return both entries Copyright.Photographer
54084 * and Copyright.Editor while the IFD0 sections contains the byte array
54085 * with the NULL character that splits both entries. Or just the first
54086 * entry if the datatype was wrong (normal behaviour of Exif). The
54087 * COMPUTED will also contain the entry Copyright which is either the
54088 * original copyright string, or a comma separated list of the photo and
54089 * editor copyright.
54090 *
54091 * The tag UserComment has the same problem as the Copyright tag. It can
54092 * store two values. First the encoding used, and second the value
54093 * itself. If so the IFD section only contains the encoding or a byte
54094 * array. The COMPUTED section will store both in the entries
54095 * UserCommentEncoding and UserComment. The entry UserComment is
54096 * available in both cases so it should be used in preference to the
54097 * value in IFD0 section.
54098 *
54099 * {@link read_exif_data} also validates EXIF data tags according to the
54100 * EXIF specification (, page 20).
54101 *
54102 * @param string $filename The name of the image file being read. This
54103 *   cannot be an URL.
54104 * @param string $sections Is a comma separated list of sections that
54105 *   need to be present in file to produce a result array. If none of the
54106 *   requested sections could be found the return value is . FILE
54107 *   FileName, FileSize, FileDateTime, SectionsFound COMPUTED html,
54108 *   Width, Height, IsColor, and more if available. Height and Width are
54109 *   computed the same way {@link getimagesize} does so their values must
54110 *   not be part of any header returned. Also, html is a height/width
54111 *   text string to be used inside normal HTML. ANY_TAG Any information
54112 *   that has a Tag e.g. IFD0, EXIF, ... IFD0 All tagged data of IFD0. In
54113 *   normal imagefiles this contains image size and so forth. THUMBNAIL A
54114 *   file is supposed to contain a thumbnail if it has a second IFD. All
54115 *   tagged information about the embedded thumbnail is stored in this
54116 *   section. COMMENT Comment headers of JPEG images. EXIF The EXIF
54117 *   section is a sub section of IFD0. It contains more detailed
54118 *   information about an image. Most of these entries are digital camera
54119 *   related.
54120 * @param bool $arrays Specifies whether or not each section becomes an
54121 *   array. The {@link sections} COMPUTED, THUMBNAIL, and COMMENT always
54122 *   become arrays as they may contain values whose names conflict with
54123 *   other sections.
54124 * @param bool $thumbnail When set to the thumbnail itself is read.
54125 *   Otherwise, only the tagged data is read.
54126 * @return array
54127 * @since PHP 4 >= 4.0.1, PHP 5
54128 **/
54129function read_exif_data($filename, $sections, $arrays, $thumbnail){}
54130
54131/**
54132 * {@link realpath} expands all symbolic links and resolves references to
54133 * '/./', '/../' and extra '/' characters in the input {@link path} and
54134 * return the canonicalized absolute pathname.
54135 *
54136 * @param string $path The path being checked.
54137 * @return string
54138 * @since PHP 4, PHP 5
54139 **/
54140function realpath($path){}
54141
54142/**
54143 * Get the contents of the realpath cache.
54144 *
54145 * @return array
54146 * @since PHP 5 >= 5.3.2
54147 **/
54148function realpath_cache_get(){}
54149
54150/**
54151 * Get the amount of memory used by the realpath cache.
54152 *
54153 * @return int
54154 * @since PHP 5 >= 5.3.2
54155 **/
54156function realpath_cache_size(){}
54157
54158/**
54159 * Recode the string {@link string} according to the recode request
54160 * {@link request}.
54161 *
54162 * @param string $request The desired recode request type
54163 * @param string $string The string to be recoded
54164 * @return string
54165 * @since PHP 4, PHP 5
54166 **/
54167function recode($request, $string){}
54168
54169/**
54170 * Recode the file referenced by file handle {@link input} into the file
54171 * referenced by file handle {@link output} according to the recode
54172 * {@link request}.
54173 *
54174 * @param string $request The desired recode request type
54175 * @param resource $input A local file handle resource for the {@link
54176 *   input}
54177 * @param resource $output A local file handle resource for the {@link
54178 *   output}
54179 * @return bool
54180 * @since PHP 4, PHP 5
54181 **/
54182function recode_file($request, $input, $output){}
54183
54184/**
54185 * Recode the string {@link string} according to the recode request
54186 * {@link request}.
54187 *
54188 * @param string $request The desired recode request type
54189 * @param string $string The string to be recoded
54190 * @return string
54191 * @since PHP 4, PHP 5
54192 **/
54193function recode_string($request, $string){}
54194
54195/**
54196 * Registers the function named by {@link function} to be executed when
54197 * script processing is complete or when {@link exit} is called.
54198 *
54199 * Multiple calls to {@link register_shutdown_function} can be made, and
54200 * each will be called in the same order as they were registered. If you
54201 * call {@link exit} within one registered shutdown function, processing
54202 * will stop completely and no other registered shutdown functions will
54203 * be called.
54204 *
54205 * @param callback $function The shutdown function to register. The
54206 *   shutdown functions are called as the part of the request so that
54207 *   it's possible to send the output from them. There is currently no
54208 *   way to process the data with output buffering functions in the
54209 *   shutdown function. Shutdown functions are called after closing all
54210 *   opened output buffers thus, for example, its output will not be
54211 *   compressed if zlib.output_compression is enabled.
54212 * @param mixed $parameter It is possible to pass parameters to the
54213 *   shutdown function by passing additional parameters.
54214 * @return void
54215 * @since PHP 4, PHP 5
54216 **/
54217function register_shutdown_function($function, $parameter){}
54218
54219/**
54220 * @param callback $function The function name as a string, or an array
54221 *   consisting of an object and a method.
54222 * @param mixed $arg
54223 * @return bool
54224 * @since PHP 4 >= 4.0.3, PHP 5
54225 **/
54226function register_tick_function($function, $arg){}
54227
54228/**
54229 * Attempts to rename {@link oldname} to {@link newname}.
54230 *
54231 * @param string $oldname
54232 * @param string $newname The new name.
54233 * @param resource $context
54234 * @return bool
54235 * @since PHP 4, PHP 5
54236 **/
54237function rename($oldname, $newname, $context){}
54238
54239/**
54240 * Renames a orig_name to new_name in the global function table. Useful
54241 * for temporarily overriding built-in functions.
54242 *
54243 * @param string $original_name The original function name.
54244 * @param string $new_name The new name for the {@link original_name}
54245 *   function.
54246 * @return bool
54247 * @since PECL apd >= 0.2
54248 **/
54249function rename_function($original_name, $new_name){}
54250
54251/**
54252 * {@link reset} rewinds {@link array}'s internal pointer to the first
54253 * element and returns the value of the first array element.
54254 *
54255 * @param array $array The input array.
54256 * @return mixed
54257 * @since PHP 4, PHP 5
54258 **/
54259function reset(&$array){}
54260
54261/**
54262 * Get the number of elements in the bundle.
54263 *
54264 * @param ResourceBundle $r ResourceBundle object.
54265 * @return int
54266 **/
54267function resourcebundle_count($r){}
54268
54269/**
54270 * Creates a resource bundle.
54271 *
54272 * @param string $locale Locale for which the resources should be
54273 *   loaded (locale name, e.g. en_CA).
54274 * @param string $bundlename The directory where the data is stored or
54275 *   the name of the .dat file.
54276 * @param bool $fallback Whether locale should match exactly or
54277 *   fallback to parent locale is allowed.
54278 * @return ResourceBundle
54279 **/
54280function resourcebundle_create($locale, $bundlename, $fallback){}
54281
54282/**
54283 * Get the data from the bundle by index or string key.
54284 *
54285 * @param ResourceBundle $r ResourceBundle object.
54286 * @param string|int $index Data index, must be string or integer.
54287 * @return mixed
54288 **/
54289function resourcebundle_get($r, $index){}
54290
54291/**
54292 * Get error code from the last function performed by the bundle object.
54293 *
54294 * @param ResourceBundle $r ResourceBundle object.
54295 * @return int
54296 **/
54297function resourcebundle_get_error_code($r){}
54298
54299/**
54300 * Get error message from the last function performed by the bundle
54301 * object.
54302 *
54303 * @param ResourceBundle $r ResourceBundle object.
54304 * @return string
54305 **/
54306function resourcebundle_get_error_message($r){}
54307
54308/**
54309 * Get the list of locales supported by the bundle. The list is taken
54310 * from the bundle table named res_index which should contain a table
54311 * named InstalledLocales, which contains locales as keys. This bundle
54312 * should be either in data directory as .res file or part of the .dat
54313 * file for this function to work.
54314 *
54315 * @param ResourceBundle $r ResourceBundle object.
54316 * @return array
54317 **/
54318function resourcebundle_locales($r){}
54319
54320/**
54321 * Used after changing the error handler function using {@link
54322 * set_error_handler}, to revert to the previous error handler (which
54323 * could be the built-in or a user defined function).
54324 *
54325 * @return bool
54326 * @since PHP 4 >= 4.0.1, PHP 5
54327 **/
54328function restore_error_handler(){}
54329
54330/**
54331 * Used after changing the exception handler function using {@link
54332 * set_exception_handler}, to revert to the previous exception handler
54333 * (which could be the built-in or a user defined function).
54334 *
54335 * @return bool
54336 * @since PHP 5
54337 **/
54338function restore_exception_handler(){}
54339
54340/**
54341 * @return void
54342 * @since PHP 4 >= 4.3.0, PHP 5
54343 **/
54344function restore_include_path(){}
54345
54346/**
54347 * Sets the file position indicator for {@link handle} to the beginning
54348 * of the file stream.
54349 *
54350 * @param resource $handle The file pointer must be valid, and must
54351 *   point to a file successfully opened by {@link fopen}.
54352 * @return bool
54353 * @since PHP 4, PHP 5
54354 **/
54355function rewind($handle){}
54356
54357/**
54358 * Resets the directory stream indicated by {@link dir_handle} to the
54359 * beginning of the directory.
54360 *
54361 * @param resource $dir_handle The directory handle resource previously
54362 *   opened with {@link opendir}. If the directory handle is not
54363 *   specified, the last link opened by {@link opendir} is assumed.
54364 * @return void
54365 * @since PHP 4, PHP 5
54366 **/
54367function rewinddir($dir_handle){}
54368
54369/**
54370 * Attempts to remove the directory named by {@link dirname}. The
54371 * directory must be empty, and the relevant permissions must permit
54372 * this. A E_WARNING level error will be generated on failure.
54373 *
54374 * @param string $dirname Path to the directory.
54375 * @param resource $context
54376 * @return bool
54377 * @since PHP 4, PHP 5
54378 **/
54379function rmdir($dirname, $context){}
54380
54381/**
54382 * Returns the rounded value of {@link val} to specified {@link
54383 * precision} (number of digits after the decimal point). {@link
54384 * precision} can also be negative or zero (default).
54385 *
54386 * PHP doesn't handle strings like "12,300.2" correctly by default. See
54387 * converting from strings.
54388 *
54389 * @param float $val The value to round
54390 * @param int $precision The optional number of decimal digits to round
54391 *   to.
54392 * @param int $mode One of PHP_ROUND_HALF_UP, PHP_ROUND_HALF_DOWN,
54393 *   PHP_ROUND_HALF_EVEN, or PHP_ROUND_HALF_ODD.
54394 * @return float
54395 * @since PHP 4, PHP 5
54396 **/
54397function round($val, $precision, $mode){}
54398
54399/**
54400 * {@link rpm_close} will close an RPM file pointer.
54401 *
54402 * @param resource $rpmr A file pointer resource successfully opened by
54403 *   {@link rpm_open}.
54404 * @return bool
54405 * @since PECL rpmreader >= 0.1.0
54406 **/
54407function rpm_close($rpmr){}
54408
54409/**
54410 * {@link rpm_get_tag} will retrieve a given tag from the RPM file's
54411 * header and return it.
54412 *
54413 * @param resource $rpmr A file pointer resource successfully opened by
54414 *   {@link rpm_open}.
54415 * @param int $tagnum The tag number to retrieve from the RPM header.
54416 *   This value can be specified using the list of constants defined by
54417 *   this module.
54418 * @return mixed
54419 * @since PECL rpmreader >= 0.1.0
54420 **/
54421function rpm_get_tag($rpmr, $tagnum){}
54422
54423/**
54424 * {@link rpm_is_valid} will test an RPM file for validity as an RPM
54425 * file. This is not the same as {@link rpm_open} as it only checks the
54426 * file for validity but does not return a file pointer to be used by
54427 * further functions.
54428 *
54429 * @param string $filename The filename of the RPM file you wish to
54430 *   check for validity.
54431 * @return bool
54432 * @since PECL rpmreader >= 0.1.0
54433 **/
54434function rpm_is_valid($filename){}
54435
54436/**
54437 * {@link rpm_open} will open an RPM file and will determine if the file
54438 * is a valid RPM file.
54439 *
54440 * @param string $filename The filename of the RPM file you wish to
54441 *   open.
54442 * @return resource
54443 * @since PECL rpmreader >= 0.1.0
54444 **/
54445function rpm_open($filename){}
54446
54447/**
54448 * {@link rpm_version} will return the current version of the rpmreader
54449 * extension.
54450 *
54451 * @return string
54452 * @since PECL rpmreader >= 0.3.0
54453 **/
54454function rpm_version(){}
54455
54456/**
54457 * This function sorts an array in reverse order (highest to lowest).
54458 *
54459 * @param array $array The input array.
54460 * @param int $sort_flags You may modify the behavior of the sort using
54461 *   the optional parameter {@link sort_flags}, for details see {@link
54462 *   sort}.
54463 * @return bool
54464 * @since PHP 4, PHP 5
54465 **/
54466function rsort(&$array, $sort_flags){}
54467
54468/**
54469 * This function returns a string with whitespace stripped from the end
54470 * of {@link str}.
54471 *
54472 * Without the second parameter, {@link rtrim} will strip these
54473 * characters: " " (ASCII 32 (0x20)), an ordinary space. "\t" (ASCII 9
54474 * (0x09)), a tab. "\n" (ASCII 10 (0x0A)), a new line (line feed). "\r"
54475 * (ASCII 13 (0x0D)), a carriage return. "\0" (ASCII 0 (0x00)), the
54476 * NUL-byte. "\x0B" (ASCII 11 (0x0B)), a vertical tab.
54477 *
54478 * @param string $str The input string.
54479 * @param string $charlist You can also specify the characters you want
54480 *   to strip, by means of the {@link charlist} parameter. Simply list
54481 *   all characters that you want to be stripped. With .. you can specify
54482 *   a range of characters.
54483 * @return string
54484 * @since PHP 4, PHP 5
54485 **/
54486function rtrim($str, $charlist){}
54487
54488/**
54489 * @param string $classname Name of class to be adopted
54490 * @param string $parentname Parent class which child class is
54491 *   extending
54492 * @return bool
54493 * @since PECL runkit >= 0.7.0
54494 **/
54495function runkit_class_adopt($classname, $parentname){}
54496
54497/**
54498 * @param string $classname Name of class to emancipate
54499 * @return bool
54500 * @since PECL runkit >= 0.7.0
54501 **/
54502function runkit_class_emancipate($classname){}
54503
54504/**
54505 * @param string $constname Name of constant to declare. Either a
54506 *   string to indicate a global constant, or classname::constname to
54507 *   indicate a class constant.
54508 * @param mixed $value NULL, Bool, Long, Double, String, or Resource
54509 *   value to store in the new constant.
54510 * @return bool
54511 * @since PECL runkit >= 0.7.0
54512 **/
54513function runkit_constant_add($constname, $value){}
54514
54515/**
54516 * @param string $constname Constant to redefine. Either string
54517 *   indicating global constant, or classname::constname indicating class
54518 *   constant.
54519 * @param mixed $newvalue New value to assign to constant.
54520 * @return bool
54521 * @since PECL runkit >= 0.7.0
54522 **/
54523function runkit_constant_redefine($constname, $newvalue){}
54524
54525/**
54526 * @param string $constname Name of constant to remove. Either a string
54527 *   indicating a global constant, or classname::constname indicating a
54528 *   class constant.
54529 * @return bool
54530 * @since PECL runkit >= 0.7.0
54531 **/
54532function runkit_constant_remove($constname){}
54533
54534/**
54535 * @param string $funcname Name of function to be created
54536 * @param string $arglist Comma separated argument list
54537 * @param string $code Code making up the function
54538 * @return bool
54539 * @since PECL runkit >= 0.7.0
54540 **/
54541function runkit_function_add($funcname, $arglist, $code){}
54542
54543/**
54544 * @param string $funcname Name of existing function
54545 * @param string $targetname Name of new function to copy definition to
54546 * @return bool
54547 * @since PECL runkit >= 0.7.0
54548 **/
54549function runkit_function_copy($funcname, $targetname){}
54550
54551/**
54552 * @param string $funcname Name of function to redefine
54553 * @param string $arglist New list of arguments to be accepted by
54554 *   function
54555 * @param string $code New code implementation
54556 * @return bool
54557 * @since PECL runkit >= 0.7.0
54558 **/
54559function runkit_function_redefine($funcname, $arglist, $code){}
54560
54561/**
54562 * @param string $funcname Name of function to be deleted
54563 * @return bool
54564 * @since PECL runkit >= 0.7.0
54565 **/
54566function runkit_function_remove($funcname){}
54567
54568/**
54569 * @param string $funcname Current function name
54570 * @param string $newname New function name
54571 * @return bool
54572 * @since PECL runkit >= 0.7.0
54573 **/
54574function runkit_function_rename($funcname, $newname){}
54575
54576/**
54577 * Similar to {@link include} however any code residing outside of a
54578 * function or class is simply ignored. Additionally, depending on the
54579 * value of {@link flags}, any functions or classes which already exist
54580 * in the currently running environment will be automatically overwritten
54581 * by their new definitions.
54582 *
54583 * @param string $filename Filename to import function and class
54584 *   definitions from
54585 * @param int $flags Bitwise OR of the RUNKIT_IMPORT_* family of
54586 *   constants.
54587 * @return bool
54588 * @since PECL runkit >= 0.7.0
54589 **/
54590function runkit_import($filename, $flags){}
54591
54592/**
54593 * The {@link runkit_lint} function performs a syntax (lint) check on the
54594 * specified php code testing for scripting errors. This is similar to
54595 * using php -l from the command line except {@link runkit_lint} accepts
54596 * actual code rather than a filename.
54597 *
54598 * @param string $code PHP Code to be lint checked
54599 * @return bool
54600 * @since PECL runkit >= 0.7.0
54601 **/
54602function runkit_lint($code){}
54603
54604/**
54605 * The {@link runkit_lint_file} function performs a syntax (lint) check
54606 * on the specified filename testing for scripting errors. This is
54607 * similar to using php -l from the commandline.
54608 *
54609 * @param string $filename File containing PHP Code to be lint checked
54610 * @return bool
54611 * @since PECL runkit >= 0.7.0
54612 **/
54613function runkit_lint_file($filename){}
54614
54615/**
54616 * @param string $classname The class to which this method will be
54617 *   added
54618 * @param string $methodname The name of the method to add
54619 * @param string $args Comma-delimited list of arguments for the
54620 *   newly-created method
54621 * @param string $code The code to be evaluated when {@link methodname}
54622 *   is called
54623 * @param int $flags The type of method to create, can be
54624 *   RUNKIT_ACC_PUBLIC, RUNKIT_ACC_PROTECTED or RUNKIT_ACC_PRIVATE
54625 * @return bool
54626 * @since PECL runkit >= 0.7.0
54627 **/
54628function runkit_method_add($classname, $methodname, $args, $code, $flags){}
54629
54630/**
54631 * @param string $dClass Destination class for copied method
54632 * @param string $dMethod Destination method name
54633 * @param string $sClass Source class of the method to copy
54634 * @param string $sMethod Name of the method to copy from the source
54635 *   class. If this parameter is omitted, the value of {@link dMethod} is
54636 *   assumed.
54637 * @return bool
54638 * @since PECL runkit >= 0.7.0
54639 **/
54640function runkit_method_copy($dClass, $dMethod, $sClass, $sMethod){}
54641
54642/**
54643 * @param string $classname The class in which to redefine the method
54644 * @param string $methodname The name of the method to redefine
54645 * @param string $args Comma-delimited list of arguments for the
54646 *   redefined method
54647 * @param string $code The new code to be evaluated when {@link
54648 *   methodname} is called
54649 * @param int $flags The redefined method can be RUNKIT_ACC_PUBLIC,
54650 *   RUNKIT_ACC_PROTECTED or RUNKIT_ACC_PRIVATE
54651 * @return bool
54652 * @since PECL runkit >= 0.7.0
54653 **/
54654function runkit_method_redefine($classname, $methodname, $args, $code, $flags){}
54655
54656/**
54657 * @param string $classname The class in which to remove the method
54658 * @param string $methodname The name of the method to remove
54659 * @return bool
54660 * @since PECL runkit >= 0.7.0
54661 **/
54662function runkit_method_remove($classname, $methodname){}
54663
54664/**
54665 * @param string $classname The class in which to rename the method
54666 * @param string $methodname The name of the method to rename
54667 * @param string $newname The new name to give to the renamed method
54668 * @return bool
54669 * @since PECL runkit >= 0.7.0
54670 **/
54671function runkit_method_rename($classname, $methodname, $newname){}
54672
54673/**
54674 * @return bool
54675 * @since PECL runkit >= 0.8.0
54676 **/
54677function runkit_return_value_used(){}
54678
54679/**
54680 * Ordinarily, anything output (such as with {@link echo} or {@link
54681 * print}) will be output as though it were printed from the parent's
54682 * scope. Using {@link runkit_sandbox_output_handler} however, output
54683 * generated by the sandbox (including errors), can be captured by a
54684 * function outside of the sandbox.
54685 *
54686 * @param object $sandbox Object instance of Runkit_Sandbox class on
54687 *   which to set output handling.
54688 * @param mixed $callback Name of a function which expects one
54689 *   parameter. Output generated by {@link sandbox} will be passed to
54690 *   this callback. Anything returned by the callback will be displayed
54691 *   normally. If this parameter is not passed then output handling will
54692 *   not be changed. If a non-truth value is passed, output handling will
54693 *   be disabled and will revert to direct display.
54694 * @return mixed
54695 * @since PECL runkit >= 0.7.0
54696 **/
54697function runkit_sandbox_output_handler($sandbox, $callback){}
54698
54699/**
54700 * @return array
54701 * @since PECL runkit >= 0.7.0
54702 **/
54703function runkit_superglobals(){}
54704
54705/**
54706 * Returns an array of files and directories from the {@link directory}.
54707 *
54708 * @param string $directory The directory that will be scanned.
54709 * @param int $sorting_order By default, the sorted order is
54710 *   alphabetical in ascending order. If the optional {@link
54711 *   sorting_order} is set to non-zero, then the sort order is
54712 *   alphabetical in descending order.
54713 * @param resource $context For a description of the {@link context}
54714 *   parameter, refer to the streams section of the manual.
54715 * @return array
54716 * @since PHP 5
54717 **/
54718function scandir($directory, $sorting_order, $context){}
54719
54720/**
54721 * {@link sem_acquire} blocks (if necessary) until the semaphore can be
54722 * acquired. A process attempting to acquire a semaphore which it has
54723 * already acquired will block forever if acquiring the semaphore would
54724 * cause its maximum number of semaphore to be exceeded.
54725 *
54726 * After processing a request, any semaphores acquired by the process but
54727 * not explicitly released will be released automatically and a warning
54728 * will be generated.
54729 *
54730 * @param resource $sem_identifier {@link sem_identifier} is a
54731 *   semaphore resource, obtained from {@link sem_get}.
54732 * @return bool
54733 * @since PHP 4, PHP 5
54734 **/
54735function sem_acquire($sem_identifier){}
54736
54737/**
54738 * {@link sem_get} returns an id that can be used to access the System V
54739 * semaphore with the given {@link key}.
54740 *
54741 * A second call to {@link sem_get} for the same key will return a
54742 * different semaphore identifier, but both identifiers access the same
54743 * underlying semaphore.
54744 *
54745 * @param int $key
54746 * @param int $max_acquire The number of processes that can acquire the
54747 *   semaphore simultaneously is set to {@link max_acquire}.
54748 * @param int $perm The semaphore permissions. Actually this value is
54749 *   set only if the process finds it is the only process currently
54750 *   attached to the semaphore.
54751 * @param int $auto_release Specifies if the semaphore should be
54752 *   automatically released on request shutdown.
54753 * @return resource
54754 * @since PHP 4, PHP 5
54755 **/
54756function sem_get($key, $max_acquire, $perm, $auto_release){}
54757
54758/**
54759 * {@link sem_release} releases the semaphore if it is currently acquired
54760 * by the calling process, otherwise a warning is generated.
54761 *
54762 * After releasing the semaphore, {@link sem_acquire} may be called to
54763 * re-acquire it.
54764 *
54765 * @param resource $sem_identifier A Semaphore resource handle as
54766 *   returned by {@link sem_get}.
54767 * @return bool
54768 * @since PHP 4, PHP 5
54769 **/
54770function sem_release($sem_identifier){}
54771
54772/**
54773 * {@link sem_remove} removes the given semaphore.
54774 *
54775 * After removing the semaphore, it is no more accessible.
54776 *
54777 * @param resource $sem_identifier A semaphore resource identifier as
54778 *   returned by {@link sem_get}.
54779 * @return bool
54780 * @since PHP 4 >= 4.1.0, PHP 5
54781 **/
54782function sem_remove($sem_identifier){}
54783
54784/**
54785 * Generates a storable representation of a value
54786 *
54787 * This is useful for storing or passing PHP values around without losing
54788 * their type and structure.
54789 *
54790 * To make the serialized string into a PHP value again, use {@link
54791 * unserialize}.
54792 *
54793 * @param mixed $value The value to be serialized. {@link serialize}
54794 *   handles all types, except the resource-type. You can even {@link
54795 *   serialize} arrays that contain references to itself. Circular
54796 *   references inside the array/object you are serializing will also be
54797 *   stored. Any other reference will be lost. When serializing objects,
54798 *   PHP will attempt to call the member function __sleep prior to
54799 *   serialization. This is to allow the object to do any last minute
54800 *   clean-up, etc. prior to being serialized. Likewise, when the object
54801 *   is restored using {@link unserialize} the __wakeup member function
54802 *   is called.
54803 * @return string
54804 * @since PHP 4, PHP 5
54805 **/
54806function serialize($value){}
54807
54808/**
54809 * {@link session_cache_expire} returns the current setting of
54810 * session.cache_expire.
54811 *
54812 * The cache expire is reset to the default value of 180 stored in
54813 * session.cache_limiter at request startup time. Thus, you need to call
54814 * {@link session_cache_expire} for every request (and before {@link
54815 * session_start} is called).
54816 *
54817 * @param string $new_cache_expire If {@link new_cache_expire} is
54818 *   given, the current cache expire is replaced with {@link
54819 *   new_cache_expire}.
54820 *
54821 *   Setting {@link new_cache_expire} is of value only, if
54822 *   session.cache_limiter is set to a value different from nocache.
54823 * @return int
54824 * @since PHP 4 >= 4.2.0, PHP 5
54825 **/
54826function session_cache_expire($new_cache_expire){}
54827
54828/**
54829 * {@link session_cache_limiter} returns the name of the current cache
54830 * limiter.
54831 *
54832 * The cache limiter defines which cache control HTTP headers are sent to
54833 * the client. These headers determine the rules by which the page
54834 * content may be cached by the client and intermediate proxies. Setting
54835 * the cache limiter to nocache disallows any client/proxy caching. A
54836 * value of public permits caching by proxies and the client, whereas
54837 * private disallows caching by proxies and permits the client to cache
54838 * the contents.
54839 *
54840 * In private mode, the Expire header sent to the client may cause
54841 * confusion for some browsers, including Mozilla. You can avoid this
54842 * problem by using private_no_expire mode. The Expire header is never
54843 * sent to the client in this mode.
54844 *
54845 * The cache limiter is reset to the default value stored in
54846 * session.cache_limiter at request startup time. Thus, you need to call
54847 * {@link session_cache_limiter} for every request (and before {@link
54848 * session_start} is called).
54849 *
54850 * @param string $cache_limiter If {@link cache_limiter} is specified,
54851 *   the name of the current cache limiter is changed to the new value.
54852 * @return string
54853 * @since PHP 4 >= 4.0.3, PHP 5
54854 **/
54855function session_cache_limiter($cache_limiter){}
54856
54857/**
54858 * End the current session and store session data.
54859 *
54860 * Session data is usually stored after your script terminated without
54861 * the need to call {@link session_commit}, but as session data is locked
54862 * to prevent concurrent writes only one script may operate on a session
54863 * at any time. When using framesets together with sessions you will
54864 * experience the frames loading one by one due to this locking. You can
54865 * reduce the time needed to load all the frames by ending the session as
54866 * soon as all changes to session variables are done.
54867 *
54868 * @return void
54869 * @since PHP 4 >= 4.4.0, PHP 5
54870 **/
54871function session_commit(){}
54872
54873/**
54874 * {@link session_decode} decodes the session data in {@link data},
54875 * setting variables stored in the session.
54876 *
54877 * @param string $data The encoded data to be stored.
54878 * @return bool
54879 * @since PHP 4, PHP 5
54880 **/
54881function session_decode($data){}
54882
54883/**
54884 * In order to kill the session altogether, like to log the user out, the
54885 * session id must also be unset. If a cookie is used to propagate the
54886 * session id (default behavior), then the session cookie must be
54887 * deleted. {@link setcookie} may be used for that.
54888 *
54889 * @return bool
54890 * @since PHP 4, PHP 5
54891 **/
54892function session_destroy(){}
54893
54894/**
54895 * {@link session_encode} returns a string with the contents of the
54896 * current session encoded within.
54897 *
54898 * @return string
54899 * @since PHP 4, PHP 5
54900 **/
54901function session_encode(){}
54902
54903/**
54904 * Gets the session cookie parameters.
54905 *
54906 * @return array
54907 * @since PHP 4, PHP 5
54908 **/
54909function session_get_cookie_params(){}
54910
54911/**
54912 * {@link session_id} is used to get or set the session id for the
54913 * current session.
54914 *
54915 * The constant SID can also be used to retrieve the current name and
54916 * session id as a string suitable for adding to URLs. See also Session
54917 * handling.
54918 *
54919 * @param string $id If {@link id} is specified, it will replace the
54920 *   current session id. {@link session_id} needs to be called before
54921 *   {@link session_start} for that purpose. Depending on the session
54922 *   handler, not all characters are allowed within the session id. For
54923 *   example, the file session handler only allows characters in the
54924 *   range a-z A-Z 0-9 , (comma) and - (minus)!
54925 * @return string
54926 * @since PHP 4, PHP 5
54927 **/
54928function session_id($id){}
54929
54930/**
54931 * Finds out whether a global variable is registered in a session.
54932 *
54933 * @param string $name The variable name.
54934 * @return bool
54935 * @since PHP 4, PHP 5
54936 **/
54937function session_is_registered($name){}
54938
54939/**
54940 * {@link session_module_name} gets the name of the current session
54941 * module.
54942 *
54943 * @param string $module If {@link module} is specified, that module
54944 *   will be used instead.
54945 * @return string
54946 * @since PHP 4, PHP 5
54947 **/
54948function session_module_name($module){}
54949
54950/**
54951 * {@link session_name} returns the name of the current session. If
54952 * {@link name} is given, {@link session_name} will update the session
54953 * name and return the old session name.
54954 *
54955 * The session name is reset to the default value stored in session.name
54956 * at request startup time. Thus, you need to call {@link session_name}
54957 * for every request (and before {@link session_start} or {@link
54958 * session_register} are called).
54959 *
54960 * @param string $name The session name references the session id in
54961 *   cookies and URLs. It should contain only alphanumeric characters; it
54962 *   should be short and descriptive (i.e. for users with enabled cookie
54963 *   warnings). If {@link name} is specified, the name of the current
54964 *   session is changed to its value.
54965 *
54966 *   The session name can't consist of digits only, at least one letter
54967 *   must be present. Otherwise a new session id is generated every time.
54968 * @return string
54969 * @since PHP 4, PHP 5
54970 **/
54971function session_name($name){}
54972
54973/**
54974 * @param int $error_level
54975 * @param string $error_message
54976 * @return bool
54977 * @since PECL session_pgsql SVN
54978 **/
54979function session_pgsql_add_error($error_level, $error_message){}
54980
54981/**
54982 * Get the number of errors and optional the error messages.
54983 *
54984 * @param bool $with_error_message Set to the literal error message for
54985 *   each error is also returned.
54986 * @return array
54987 * @since PECL session_pgsql SVN
54988 **/
54989function session_pgsql_get_error($with_error_message){}
54990
54991/**
54992 * @return string
54993 * @since PECL session_pgsql SVN
54994 **/
54995function session_pgsql_get_field(){}
54996
54997/**
54998 * Reset the connection to the session database servers.
54999 *
55000 * @return bool
55001 * @since PECL session_pgsql SVN
55002 **/
55003function session_pgsql_reset(){}
55004
55005/**
55006 * @param string $value
55007 * @return bool
55008 * @since PECL session_pgsql SVN
55009 **/
55010function session_pgsql_set_field($value){}
55011
55012/**
55013 * @return array
55014 * @since PECL session_pgsql SVN
55015 **/
55016function session_pgsql_status(){}
55017
55018/**
55019 * {@link session_regenerate_id} will replace the current session id with
55020 * a new one, and keep the current session information.
55021 *
55022 * @param bool $delete_old_session Whether to delete the old associated
55023 *   session file or not.
55024 * @return bool
55025 * @since PHP 4 >= 4.3.2, PHP 5
55026 **/
55027function session_regenerate_id($delete_old_session){}
55028
55029/**
55030 * {@link session_register} accepts a variable number of arguments, any
55031 * of which can be either a string holding the name of a variable or an
55032 * array consisting of variable names or other arrays. For each name,
55033 * {@link session_register} registers the global variable with that name
55034 * in the current session.
55035 *
55036 * You can also create a session variable by simply setting the
55037 * appropriate member of the $_SESSION or $HTTP_SESSION_VARS (PHP <
55038 * 4.1.0) array.
55039 *
55040 * <?php // Use of session_register() is deprecated $barney = "A big
55041 * purple dinosaur."; session_register("barney");
55042 *
55043 * // Use of $_SESSION is preferred, as of PHP 4.1.0 $_SESSION["zim"] =
55044 * "An invader from another planet.";
55045 *
55046 * // The old way was to use $HTTP_SESSION_VARS
55047 * $HTTP_SESSION_VARS["spongebob"] = "He's got square pants."; ?>
55048 *
55049 * If {@link session_start} was not called before this function is
55050 * called, an implicit call to {@link session_start} with no parameters
55051 * will be made. $_SESSION does not mimic this behavior and requires
55052 * {@link session_start} before use.
55053 *
55054 * @param mixed $name A string holding the name of a variable or an
55055 *   array consisting of variable names or other arrays.
55056 * @return bool
55057 * @since PHP 4, PHP 5
55058 **/
55059function session_register($name){}
55060
55061/**
55062 * {@link session_save_path} returns the path of the current directory
55063 * used to save session data.
55064 *
55065 * @param string $path Session data path. If specified, the path to
55066 *   which data is saved will be changed. {@link session_save_path} needs
55067 *   to be called before {@link session_start} for that purpose.
55068 *
55069 *   On some operating systems, you may want to specify a path on a
55070 *   filesystem that handles lots of small files efficiently. For
55071 *   example, on Linux, reiserfs may provide better performance than
55072 *   ext2fs.
55073 * @return string
55074 * @since PHP 4, PHP 5
55075 **/
55076function session_save_path($path){}
55077
55078/**
55079 * Set cookie parameters defined in the file. The effect of this function
55080 * only lasts for the duration of the script. Thus, you need to call
55081 * {@link session_set_cookie_params} for every request and before {@link
55082 * session_start} is called.
55083 *
55084 * @param int $lifetime Lifetime of the session cookie, defined in
55085 *   seconds.
55086 * @param string $path Path on the domain where the cookie will work.
55087 *   Use a single slash ('/') for all paths on the domain.
55088 * @param string $domain Cookie domain, for example 'www.php.net'. To
55089 *   make cookies visible on all subdomains then the domain must be
55090 *   prefixed with a dot like '.php.net'.
55091 * @param bool $secure If cookie will only be sent over secure
55092 *   connections.
55093 * @param bool $httponly If set to then PHP will attempt to send the
55094 *   httponly flag when setting the session cookie.
55095 * @return void
55096 * @since PHP 4, PHP 5
55097 **/
55098function session_set_cookie_params($lifetime, $path, $domain, $secure, $httponly){}
55099
55100/**
55101 * {@link session_set_save_handler} sets the user-level session storage
55102 * functions which are used for storing and retrieving data associated
55103 * with a session. This is most useful when a storage method other than
55104 * those supplied by PHP sessions is preferred. i.e. Storing the session
55105 * data in a local database.
55106 *
55107 * @param callback $open Open function, this works like a constructor
55108 *   in classes and is executed when the session is being opened. The
55109 *   open function expects two parameters, where the first is the save
55110 *   path and the second is the session name.
55111 * @param callback $close Close function, this works like a destructor
55112 *   in classes and is executed when the session operation is done.
55113 * @param callback $read Read function must return string value always
55114 *   to make save handler work as expected. Return empty string if there
55115 *   is no data to read. Return values from other handlers are converted
55116 *   to boolean expression. for success, for failure.
55117 * @param callback $write Write function that is called when session
55118 *   data is to be saved. This function expects two parameters: an
55119 *   identifier and the data associated with it. The "write" handler is
55120 *   not executed until after the output stream is closed. Thus, output
55121 *   from debugging statements in the "write" handler will never be seen
55122 *   in the browser. If debugging output is necessary, it is suggested
55123 *   that the debug output be written to a file instead.
55124 * @param callback $destroy The destroy handler, this is executed when
55125 *   a session is destroyed with {@link session_destroy} and takes the
55126 *   session id as its only parameter.
55127 * @param callback $gc The garbage collector, this is executed when the
55128 *   session garbage collector is executed and takes the max session
55129 *   lifetime as its only parameter.
55130 * @return bool
55131 * @since PHP 4, PHP 5
55132 **/
55133function session_set_save_handler($open, $close, $read, $write, $destroy, $gc){}
55134
55135/**
55136 * {@link session_start} creates a session or resumes the current one
55137 * based on a session identifier passed via a GET or POST request, or
55138 * passed via a cookie.
55139 *
55140 * To use a named session, call {@link session_name} before calling
55141 * {@link session_start}.
55142 *
55143 * When session.use_trans_sid is enabled, the {@link session_start}
55144 * function will register an internal output handler for URL rewriting.
55145 *
55146 * If a user uses ob_gzhandler or similar with {@link ob_start}, the
55147 * function order is important for proper output. For example,
55148 * ob_gzhandler must be registered before starting the session.
55149 *
55150 * @return bool
55151 * @since PHP 4, PHP 5
55152 **/
55153function session_start(){}
55154
55155/**
55156 * {@link session_unregister} unregisters the global variable named
55157 * {@link name} from the current session.
55158 *
55159 * @param string $name The variable name.
55160 * @return bool
55161 * @since PHP 4, PHP 5
55162 **/
55163function session_unregister($name){}
55164
55165/**
55166 * The {@link session_unset} function frees all session variables
55167 * currently registered.
55168 *
55169 * @return void
55170 * @since PHP 4, PHP 5
55171 **/
55172function session_unset(){}
55173
55174/**
55175 * End the current session and store session data.
55176 *
55177 * Session data is usually stored after your script terminated without
55178 * the need to call {@link session_write_close}, but as session data is
55179 * locked to prevent concurrent writes only one script may operate on a
55180 * session at any time. When using framesets together with sessions you
55181 * will experience the frames loading one by one due to this locking. You
55182 * can reduce the time needed to load all the frames by ending the
55183 * session as soon as all changes to session variables are done.
55184 *
55185 * @return void
55186 * @since PHP 4 >= 4.0.4, PHP 5
55187 **/
55188function session_write_close(){}
55189
55190/**
55191 * {@link setcookie} defines a cookie to be sent along with the rest of
55192 * the HTTP headers. Like other headers, cookies must be sent before any
55193 * output from your script (this is a protocol restriction). This
55194 * requires that you place calls to this function prior to any output,
55195 * including <html> and <head> tags as well as any whitespace.
55196 *
55197 * Once the cookies have been set, they can be accessed on the next page
55198 * load with the $_COOKIE or $HTTP_COOKIE_VARS arrays. Note, superglobals
55199 * such as $_COOKIE became available in PHP 4.1.0. Cookie values also
55200 * exist in $_REQUEST.
55201 *
55202 * @param string $name The name of the cookie.
55203 * @param string $value The value of the cookie. This value is stored
55204 *   on the clients computer; do not store sensitive information.
55205 *   Assuming the {@link name} is 'cookiename', this value is retrieved
55206 *   through $_COOKIE['cookiename']
55207 * @param int $expire The time the cookie expires. This is a Unix
55208 *   timestamp so is in number of seconds since the epoch. In other
55209 *   words, you'll most likely set this with the {@link time} function
55210 *   plus the number of seconds before you want it to expire. Or you
55211 *   might use {@link mktime}. time()+60*60*24*30 will set the cookie to
55212 *   expire in 30 days. If set to 0, or omitted, the cookie will expire
55213 *   at the end of the session (when the browser closes).
55214 *
55215 *   You may notice the {@link expire} parameter takes on a Unix
55216 *   timestamp, as opposed to the date format Wdy, DD-Mon-YYYY HH:MM:SS
55217 *   GMT, this is because PHP does this conversion internally. {@link
55218 *   expire} is compared to the client's time which can differ from
55219 *   server's time.
55220 * @param string $path The path on the server in which the cookie will
55221 *   be available on. If set to '/', the cookie will be available within
55222 *   the entire {@link domain}. If set to '/foo/', the cookie will only
55223 *   be available within the /foo/ directory and all sub-directories such
55224 *   as /foo/bar/ of {@link domain}. The default value is the current
55225 *   directory that the cookie is being set in.
55226 * @param string $domain The domain that the cookie is available. To
55227 *   make the cookie available on all subdomains of example.com then
55228 *   you'd set it to '.example.com'. The . is not required but makes it
55229 *   compatible with more browsers. Setting it to www.example.com will
55230 *   make the cookie only available in the www subdomain. Refer to tail
55231 *   matching in the spec for details.
55232 * @param bool $secure Indicates that the cookie should only be
55233 *   transmitted over a secure HTTPS connection from the client. When set
55234 *   to , the cookie will only be set if a secure connection exists. On
55235 *   the server-side, it's on the programmer to send this kind of cookie
55236 *   only on secure connection (e.g. with respect to $_SERVER["HTTPS"]).
55237 * @param bool $httponly When the cookie will be made accessible only
55238 *   through the HTTP protocol. This means that the cookie won't be
55239 *   accessible by scripting languages, such as JavaScript. This setting
55240 *   can effectively help to reduce identity theft through XSS attacks
55241 *   (although it is not supported by all browsers). Added in PHP 5.2.0.
55242 *   or
55243 * @return bool
55244 * @since PHP 4, PHP 5
55245 **/
55246function setcookie($name, $value, $expire, $path, $domain, $secure, $httponly){}
55247
55248/**
55249 * Sets locale information.
55250 *
55251 * @param int $category {@link category} is a named constant specifying
55252 *   the category of the functions affected by the locale setting: LC_ALL
55253 *   for all of the below LC_COLLATE for string comparison, see {@link
55254 *   strcoll} LC_CTYPE for character classification and conversion, for
55255 *   example {@link strtoupper} LC_MONETARY for {@link localeconv}
55256 *   LC_NUMERIC for decimal separator (See also {@link localeconv})
55257 *   LC_TIME for date and time formatting with {@link strftime}
55258 *   LC_MESSAGES for system responses (available if PHP was compiled with
55259 *   libintl)
55260 * @param string $locale If {@link locale} is or the empty string "",
55261 *   the locale names will be set from the values of environment
55262 *   variables with the same names as the above categories, or from
55263 *   "LANG". If {@link locale} is "0", the locale setting is not
55264 *   affected, only the current setting is returned. If {@link locale} is
55265 *   an array or followed by additional parameters then each array
55266 *   element or parameter is tried to be set as new locale until success.
55267 *   This is useful if a locale is known under different names on
55268 *   different systems or for providing a fallback for a possibly not
55269 *   available locale.
55270 * @return string
55271 * @since PHP 4, PHP 5
55272 **/
55273function setlocale($category, $locale){}
55274
55275/**
55276 * {@link setrawcookie} is exactly the same as {@link setcookie} except
55277 * that the cookie value will not be automatically urlencoded when sent
55278 * to the browser.
55279 *
55280 * @param string $name
55281 * @param string $value
55282 * @param int $expire
55283 * @param string $path
55284 * @param string $domain
55285 * @param bool $secure
55286 * @param bool $httponly
55287 * @return bool
55288 * @since PHP 5
55289 **/
55290function setrawcookie($name, $value, $expire, $path, $domain, $secure, $httponly){}
55291
55292/**
55293 * Set the type of variable {@link var} to {@link type}.
55294 *
55295 * @param mixed $var The variable being converted.
55296 * @param string $type Possibles values of {@link type} are: "boolean"
55297 *   (or, since PHP 4.2.0, "bool") "integer" (or, since PHP 4.2.0, "int")
55298 *   "float" (only possible since PHP 4.2.0, for older versions use the
55299 *   deprecated variant "double") "string" "array" "object" "null" (since
55300 *   PHP 4.2.0)
55301 * @return bool
55302 * @since PHP 4, PHP 5
55303 **/
55304function settype(&$var, $type){}
55305
55306/**
55307 * Sets a user function ({@link error_handler}) to handle errors in a
55308 * script.
55309 *
55310 * This function can be used for defining your own way of handling errors
55311 * during runtime, for example in applications in which you need to do
55312 * cleanup of data/files when a critical error happens, or when you need
55313 * to trigger an error under certain conditions (using {@link
55314 * trigger_error}).
55315 *
55316 * It is important to remember that the standard PHP error handler is
55317 * completely bypassed for the error types specified by {@link
55318 * error_types} unless the callback function returns . {@link
55319 * error_reporting} settings will have no effect and your error handler
55320 * will be called regardless - however you are still able to read the
55321 * current value of error_reporting and act appropriately. Of particular
55322 * note is that this value will be 0 if the statement that caused the
55323 * error was prepended by the @ error-control operator.
55324 *
55325 * Also note that it is your responsibility to {@link die} if necessary.
55326 * If the error-handler function returns, script execution will continue
55327 * with the next statement after the one that caused an error.
55328 *
55329 * The following error types cannot be handled with a user defined
55330 * function: E_ERROR, E_PARSE, E_CORE_ERROR, E_CORE_WARNING,
55331 * E_COMPILE_ERROR, E_COMPILE_WARNING, and most of E_STRICT raised in the
55332 * file where {@link set_error_handler} is called.
55333 *
55334 * If errors occur before the script is executed (e.g. on file uploads)
55335 * the custom error handler cannot be called since it is not registered
55336 * at that time.
55337 *
55338 * @param callback $error_handler The user function needs to accept two
55339 *   parameters: the error code, and a string describing the error. Then
55340 *   there are three optional parameters that may be supplied: the
55341 *   filename in which the error occurred, the line number in which the
55342 *   error occurred, and the context in which the error occurred (an
55343 *   array that points to the active symbol table at the point the error
55344 *   occurred). The function can be shown as:
55345 *
55346 *   handler int{@link errno} string{@link errstr} string{@link errfile}
55347 *   int{@link errline} array{@link errcontext} {@link errno} The first
55348 *   parameter, {@link errno}, contains the level of the error raised, as
55349 *   an integer. {@link errstr} The second parameter, {@link errstr},
55350 *   contains the error message, as a string. {@link errfile} The third
55351 *   parameter is optional, {@link errfile}, which contains the filename
55352 *   that the error was raised in, as a string. {@link errline} The
55353 *   fourth parameter is optional, {@link errline}, which contains the
55354 *   line number the error was raised at, as an integer. {@link
55355 *   errcontext} The fifth parameter is optional, {@link errcontext},
55356 *   which is an array that points to the active symbol table at the
55357 *   point the error occurred. In other words, {@link errcontext} will
55358 *   contain an array of every variable that existed in the scope the
55359 *   error was triggered in. User error handler must not modify error
55360 *   context. If the function returns then the normal error handler
55361 *   continues.
55362 * @param int $error_types
55363 * @return mixed
55364 * @since PHP 4 >= 4.0.1, PHP 5
55365 **/
55366function set_error_handler($error_handler, $error_types){}
55367
55368/**
55369 * Sets the default exception handler if an exception is not caught
55370 * within a try/catch block. Execution will stop after the {@link
55371 * exception_handler} is called.
55372 *
55373 * @param callback $exception_handler Name of the function to be called
55374 *   when an uncaught exception occurs. This function must be defined
55375 *   before calling {@link set_exception_handler}. This handler function
55376 *   needs to accept one parameter, which will be the exception object
55377 *   that was thrown.
55378 * @return callback
55379 * @since PHP 5
55380 **/
55381function set_exception_handler($exception_handler){}
55382
55383/**
55384 * Sets the include_path configuration option for the duration of the
55385 * script.
55386 *
55387 * @param string $new_include_path The new value for the include_path
55388 * @return string
55389 * @since PHP 4 >= 4.3.0, PHP 5
55390 **/
55391function set_include_path($new_include_path){}
55392
55393/**
55394 * Set the current active configuration setting of magic_quotes_runtime.
55395 *
55396 * @param bool $new_setting for off, for on.
55397 * @return bool
55398 * @since PHP 4, PHP 5
55399 **/
55400function set_magic_quotes_runtime($new_setting){}
55401
55402/**
55403 * Sets blocking or non-blocking mode on a {@link stream}.
55404 *
55405 * This function works for any stream that supports non-blocking mode
55406 * (currently, regular files and socket streams).
55407 *
55408 * @param resource $stream The stream.
55409 * @param int $mode If {@link mode} is 0, the given stream will be
55410 *   switched to non-blocking mode, and if 1, it will be switched to
55411 *   blocking mode. This affects calls like {@link fgets} and {@link
55412 *   fread} that read from the stream. In non-blocking mode an {@link
55413 *   fgets} call will always return right away while in blocking mode it
55414 *   will wait for data to become available on the stream.
55415 * @return bool
55416 * @since PHP 4, PHP 5
55417 **/
55418function set_socket_blocking($stream, $mode){}
55419
55420/**
55421 * Set the number of seconds a script is allowed to run. If this is
55422 * reached, the script returns a fatal error. The default limit is 30
55423 * seconds or, if it exists, the max_execution_time value defined in the
55424 * .
55425 *
55426 * When called, {@link set_time_limit} restarts the timeout counter from
55427 * zero. In other words, if the timeout is the default 30 seconds, and 25
55428 * seconds into script execution a call such as set_time_limit(20) is
55429 * made, the script will run for a total of 45 seconds before timing out.
55430 *
55431 * @param int $seconds The maximum execution time, in seconds. If set
55432 *   to zero, no time limit is imposed.
55433 * @return void
55434 * @since PHP 4, PHP 5
55435 **/
55436function set_time_limit($seconds){}
55437
55438/**
55439 * @param string $str The input string.
55440 * @param bool $raw_output If the optional {@link raw_output} is set to
55441 *   , then the sha1 digest is instead returned in raw binary format with
55442 *   a length of 20, otherwise the returned value is a 40-character
55443 *   hexadecimal number.
55444 * @return string
55445 * @since PHP 4 >= 4.3.0, PHP 5
55446 **/
55447function sha1($str, $raw_output){}
55448
55449/**
55450 * @param string $filename The filename of the file to hash.
55451 * @param bool $raw_output When , returns the digest in raw binary
55452 *   format with a length of 20.
55453 * @return string
55454 * @since PHP 4 >= 4.3.0, PHP 5
55455 **/
55456function sha1_file($filename, $raw_output){}
55457
55458/**
55459 * This function is identical to the backtick operator.
55460 *
55461 * @param string $cmd The command that will be executed.
55462 * @return string
55463 * @since PHP 4, PHP 5
55464 **/
55465function shell_exec($cmd){}
55466
55467/**
55468 * {@link shmop_close} is used to close a shared memory block.
55469 *
55470 * @param int $shmid The shared memory block identifier created by
55471 *   {@link shmop_open}
55472 * @return void
55473 * @since PHP 4 >= 4.0.4, PHP 5
55474 **/
55475function shmop_close($shmid){}
55476
55477/**
55478 * {@link shmop_delete} is used to delete a shared memory block.
55479 *
55480 * @param int $shmid The shared memory block identifier created by
55481 *   {@link shmop_open}
55482 * @return bool
55483 * @since PHP 4 >= 4.0.4, PHP 5
55484 **/
55485function shmop_delete($shmid){}
55486
55487/**
55488 * {@link shmop_open} can create or open a shared memory block.
55489 *
55490 * @param int $key System's id for the shared memory block. Can be
55491 *   passed as a decimal or hex.
55492 * @param string $flags The flags that you can use: "a" for access
55493 *   (sets SHM_RDONLY for shmat) use this flag when you need to open an
55494 *   existing shared memory segment for read only "c" for create (sets
55495 *   IPC_CREATE) use this flag when you need to create a new shared
55496 *   memory segment or if a segment with the same key exists, try to open
55497 *   it for read and write "w" for read & write access use this flag when
55498 *   you need to read and write to a shared memory segment, use this flag
55499 *   in most cases. "n" create a new memory segment (sets
55500 *   IPC_CREATE|IPC_EXCL) use this flag when you want to create a new
55501 *   shared memory segment but if one already exists with the same flag,
55502 *   fail. This is useful for security purposes, using this you can
55503 *   prevent race condition exploits.
55504 * @param int $mode The permissions that you wish to assign to your
55505 *   memory segment, those are the same as permission for a file.
55506 *   Permissions need to be passed in octal form, like for example 0644
55507 * @param int $size The size of the shared memory block you wish to
55508 *   create in bytes
55509 * @return int
55510 * @since PHP 4 >= 4.0.4, PHP 5
55511 **/
55512function shmop_open($key, $flags, $mode, $size){}
55513
55514/**
55515 * {@link shmop_read} will read a string from shared memory block.
55516 *
55517 * @param int $shmid The shared memory block identifier created by
55518 *   {@link shmop_open}
55519 * @param int $start Offset from which to start reading
55520 * @param int $count The number of bytes to read
55521 * @return string
55522 * @since PHP 4 >= 4.0.4, PHP 5
55523 **/
55524function shmop_read($shmid, $start, $count){}
55525
55526/**
55527 * {@link shmop_size} is used to get the size, in bytes of the shared
55528 * memory block.
55529 *
55530 * @param int $shmid The shared memory block identifier created by
55531 *   {@link shmop_open}
55532 * @return int
55533 * @since PHP 4 >= 4.0.4, PHP 5
55534 **/
55535function shmop_size($shmid){}
55536
55537/**
55538 * {@link shmop_write} will write a string into shared memory block.
55539 *
55540 * @param int $shmid The shared memory block identifier created by
55541 *   {@link shmop_open}
55542 * @param string $data A string to write into shared memory block
55543 * @param int $offset Specifies where to start writing data inside the
55544 *   shared memory segment.
55545 * @return int
55546 * @since PHP 4 >= 4.0.4, PHP 5
55547 **/
55548function shmop_write($shmid, $data, $offset){}
55549
55550/**
55551 * {@link shm_attach} returns an id that can be used to access the System
55552 * V shared memory with the given {@link key}, the first call creates the
55553 * shared memory segment with {@link memsize} and the optional perm-bits
55554 * {@link perm}.
55555 *
55556 * A second call to {@link shm_attach} for the same {@link key} will
55557 * return a different shared memory identifier, but both identifiers
55558 * access the same underlying shared memory. {@link memsize} and {@link
55559 * perm} will be ignored.
55560 *
55561 * @param int $key A numeric shared memory segment ID
55562 * @param int $memsize The memory size. If not provided, default to the
55563 *   sysvshm.init_mem in the , otherwise 10000 bytes.
55564 * @param int $perm The optional permission bits. Default to 0666.
55565 * @return resource
55566 * @since PHP 4, PHP 5
55567 **/
55568function shm_attach($key, $memsize, $perm){}
55569
55570/**
55571 * {@link shm_detach} disconnects from the shared memory given by the
55572 * {@link shm_identifier} created by {@link shm_attach}. Remember, that
55573 * shared memory still exist in the Unix system and the data is still
55574 * present.
55575 *
55576 * @param resource $shm_identifier A shared memory resource handle as
55577 *   returned by {@link shm_attach}
55578 * @return bool
55579 * @since PHP 4, PHP 5
55580 **/
55581function shm_detach($shm_identifier){}
55582
55583/**
55584 * {@link shm_get_var} returns the variable with a given {@link
55585 * variable_key}, in the given shared memory segment. The variable is
55586 * still present in the shared memory.
55587 *
55588 * @param resource $shm_identifier Shared memory segment, obtained from
55589 *   {@link shm_attach}.
55590 * @param int $variable_key The variable key.
55591 * @return mixed
55592 * @since PHP 4, PHP 5
55593 **/
55594function shm_get_var($shm_identifier, $variable_key){}
55595
55596/**
55597 * Checks whether a specific key exists inside a shared memory segment.
55598 *
55599 * @param resource $shm_identifier Shared memory segment, obtained from
55600 *   {@link shm_attach}.
55601 * @param int $variable_key The variable key.
55602 * @return bool
55603 * @since PHP 5 >= 5.3.0
55604 **/
55605function shm_has_var($shm_identifier, $variable_key){}
55606
55607/**
55608 * {@link shm_put_var} inserts or updates the {@link variable} with the
55609 * given {@link variable_key}.
55610 *
55611 * Warnings (E_WARNING level) will be issued if {@link shm_identifier} is
55612 * not a valid SysV shared memory index or if there was not enough shared
55613 * memory remaining to complete your request.
55614 *
55615 * @param resource $shm_identifier A shared memory resource handle as
55616 *   returned by {@link shm_attach}
55617 * @param int $variable_key The variable key.
55618 * @param mixed $variable The variable. All variable-types are
55619 *   supported.
55620 * @return bool
55621 * @since PHP 4, PHP 5
55622 **/
55623function shm_put_var($shm_identifier, $variable_key, $variable){}
55624
55625/**
55626 * {@link shm_remove} removes the shared memory {@link shm_identifier}.
55627 * All data will be destroyed.
55628 *
55629 * @param resource $shm_identifier The shared memory identifier as
55630 *   returned by {@link shm_attach}
55631 * @return bool
55632 * @since PHP 4, PHP 5
55633 **/
55634function shm_remove($shm_identifier){}
55635
55636/**
55637 * Removes a variable with a given {@link variable_key} and frees the
55638 * occupied memory.
55639 *
55640 * @param resource $shm_identifier The shared memory identifier as
55641 *   returned by {@link shm_attach}
55642 * @param int $variable_key The variable key.
55643 * @return bool
55644 * @since PHP 4, PHP 5
55645 **/
55646function shm_remove_var($shm_identifier, $variable_key){}
55647
55648/**
55649 * Prints out or returns a syntax highlighted version of the code
55650 * contained in {@link filename} using the colors defined in the built-in
55651 * syntax highlighter for PHP.
55652 *
55653 * Many servers are configured to automatically highlight files with a
55654 * phps extension. For example, example.phps when viewed will show the
55655 * syntax highlighted source of the file. To enable this, add this line
55656 * to the :
55657 *
55658 * @param string $filename Path to the PHP file to be highlighted.
55659 * @param bool $return Set this parameter to to make this function
55660 *   return the highlighted code.
55661 * @return mixed
55662 * @since PHP 4, PHP 5
55663 **/
55664function show_source($filename, $return){}
55665
55666/**
55667 * This function shuffles (randomizes the order of the elements in) an
55668 * array.
55669 *
55670 * @param array $array The array.
55671 * @return bool
55672 * @since PHP 4, PHP 5
55673 **/
55674function shuffle(&$array){}
55675
55676/**
55677 * This calculates the similarity between two strings as described in
55678 * Oliver [1993]. Note that this implementation does not use a stack as
55679 * in Oliver's pseudo code, but recursive calls which may or may not
55680 * speed up the whole process. Note also that the complexity of this
55681 * algorithm is O(N**3) where N is the length of the longest string.
55682 *
55683 * @param string $first The first string.
55684 * @param string $second The second string.
55685 * @param float $percent By passing a reference as third argument,
55686 *   {@link similar_text} will calculate the similarity in percent for
55687 *   you.
55688 * @return int
55689 * @since PHP 4, PHP 5
55690 **/
55691function similar_text($first, $second, &$percent){}
55692
55693/**
55694 * This function takes a node of a DOM document and makes it into a
55695 * SimpleXML node. This new object can then be used as a native SimpleXML
55696 * element.
55697 *
55698 * @param DOMNode $node A DOM Element node
55699 * @param string $class_name You may use this optional parameter so
55700 *   that {@link simplexml_import_dom} will return an object of the
55701 *   specified class. That class should extend the SimpleXMLElement
55702 *   class.
55703 * @return SimpleXMLElement
55704 * @since PHP 5
55705 **/
55706function simplexml_import_dom($node, $class_name){}
55707
55708/**
55709 * Convert the well-formed XML document in the given file to an object.
55710 *
55711 * @param string $filename Path to the XML file
55712 * @param string $class_name You may use this optional parameter so
55713 *   that {@link simplexml_load_file} will return an object of the
55714 *   specified class. That class should extend the SimpleXMLElement
55715 *   class.
55716 * @param int $options Since PHP 5.1.0 and Libxml 2.6.0, you may also
55717 *   use the {@link options} parameter to specify additional Libxml
55718 *   parameters.
55719 * @param string $ns
55720 * @param bool $is_prefix
55721 * @return object
55722 * @since PHP 5
55723 **/
55724function simplexml_load_file($filename, $class_name, $options, $ns, $is_prefix){}
55725
55726/**
55727 * Takes a well-formed XML string and returns it as an object.
55728 *
55729 * @param string $data A well-formed XML string
55730 * @param string $class_name You may use this optional parameter so
55731 *   that {@link simplexml_load_string} will return an object of the
55732 *   specified class. That class should extend the SimpleXMLElement
55733 *   class.
55734 * @param int $options Since PHP 5.1.0 and Libxml 2.6.0, you may also
55735 *   use the {@link options} parameter to specify additional Libxml
55736 *   parameters.
55737 * @param string $ns
55738 * @param bool $is_prefix
55739 * @return object
55740 * @since PHP 5
55741 **/
55742function simplexml_load_string($data, $class_name, $options, $ns, $is_prefix){}
55743
55744/**
55745 * {@link sin} returns the sine of the {@link arg} parameter. The {@link
55746 * arg} parameter is in radians.
55747 *
55748 * @param float $arg A value in radians
55749 * @return float
55750 * @since PHP 4, PHP 5
55751 **/
55752function sin($arg){}
55753
55754/**
55755 * Returns the hyperbolic sine of {@link arg}, defined as (exp(arg) -
55756 * exp(-arg))/2.
55757 *
55758 * @param float $arg The argument to process
55759 * @return float
55760 * @since PHP 4 >= 4.1.0, PHP 5
55761 **/
55762function sinh($arg){}
55763
55764/**
55765 * Counts all elements in an array, or properties in an object.
55766 *
55767 * For objects, if you have SPL installed, you can hook into {@link
55768 * sizeof} by implementing interface Countable. The interface has exactly
55769 * one method, {@link sizeof}, which returns the return value for the
55770 * {@link sizeof} function.
55771 *
55772 * Please see the Array section of the manual for a detailed explanation
55773 * of how arrays are implemented and used in PHP.
55774 *
55775 * @param mixed $var The array.
55776 * @param int $mode If the optional {@link mode} parameter is set to
55777 *   COUNT_RECURSIVE (or 1), {@link count} will recursively count the
55778 *   array. This is particularly useful for counting all the elements of
55779 *   a multidimensional array. {@link count} does not detect infinite
55780 *   recursion.
55781 * @return int
55782 * @since PHP 4, PHP 5
55783 **/
55784function sizeof($var, $mode){}
55785
55786/**
55787 * @param int $seconds Halt time in seconds.
55788 * @return int
55789 * @since PHP 4, PHP 5
55790 **/
55791function sleep($seconds){}
55792
55793/**
55794 * The {@link snmpget} function is used to read the value of an SNMP
55795 * object specified by the {@link object_id}.
55796 *
55797 * @param string $hostname The SNMP agent.
55798 * @param string $community The read community.
55799 * @param string $object_id The SNMP object.
55800 * @param int $timeout The number of microseconds until the first
55801 *   timeout.
55802 * @param int $retries
55803 * @return string
55804 * @since PHP 4, PHP 5
55805 **/
55806function snmpget($hostname, $community, $object_id, $timeout, $retries){}
55807
55808/**
55809 * @param string $host
55810 * @param string $community
55811 * @param string $object_id
55812 * @param int $timeout
55813 * @param int $retries
55814 * @return string
55815 * @since PHP 5
55816 **/
55817function snmpgetnext($host, $community, $object_id, $timeout, $retries){}
55818
55819/**
55820 * @param string $host
55821 * @param string $community
55822 * @param string $object_id
55823 * @param int $timeout
55824 * @param int $retries
55825 * @return array
55826 * @since PHP 4, PHP 5
55827 **/
55828function snmprealwalk($host, $community, $object_id, $timeout, $retries){}
55829
55830/**
55831 * {@link snmpset} is used to set the value of an SNMP object specified
55832 * by the {@link object_id}.
55833 *
55834 * @param string $hostname The SNMP agent.
55835 * @param string $community The write community.
55836 * @param string $object_id The SNMP object.
55837 * @param string $type
55838 * @param mixed $value
55839 * @param int $timeout The number of microseconds until the first
55840 *   timeout.
55841 * @param int $retries
55842 * @return bool
55843 * @since PHP 4, PHP 5
55844 **/
55845function snmpset($hostname, $community, $object_id, $type, $value, $timeout, $retries){}
55846
55847/**
55848 * {@link snmpwalk} function is used to read all the values from an SNMP
55849 * agent specified by the {@link hostname}.
55850 *
55851 * @param string $hostname The SNMP agent.
55852 * @param string $community The read community.
55853 * @param string $object_id If , {@link object_id} is taken as the root
55854 *   of the SNMP objects tree and all objects under that tree are
55855 *   returned as an array. If {@link object_id} is specified, all the
55856 *   SNMP objects below that {@link object_id} are returned.
55857 * @param int $timeout The number of microseconds until the first
55858 *   timeout.
55859 * @param int $retries
55860 * @return array
55861 * @since PHP 4, PHP 5
55862 **/
55863function snmpwalk($hostname, $community, $object_id, $timeout, $retries){}
55864
55865/**
55866 * {@link snmpwalkoid} function is used to read all object ids and their
55867 * respective values from an SNMP agent specified by {@link hostname}.
55868 *
55869 * The existence of {@link snmpwalkoid} and {@link snmpwalk} has
55870 * historical reasons. Both functions are provided for backward
55871 * compatibility. Use {@link snmprealwalk} instead.
55872 *
55873 * @param string $hostname The SNMP agent.
55874 * @param string $community The read community.
55875 * @param string $object_id If , {@link object_id} is taken as the root
55876 *   of the SNMP objects tree and all objects under that tree are
55877 *   returned as an array. If {@link object_id} is specified, all the
55878 *   SNMP objects below that {@link object_id} are returned.
55879 * @param int $timeout The number of microseconds until the first
55880 *   timeout.
55881 * @param int $retries
55882 * @return array
55883 * @since PHP 4, PHP 5
55884 **/
55885function snmpwalkoid($hostname, $community, $object_id, $timeout, $retries){}
55886
55887/**
55888 * Returns the current value stored in the UCD Library for quick_print.
55889 * quick_print is off by default.
55890 *
55891 * @return bool
55892 * @since PHP 4, PHP 5
55893 **/
55894function snmp_get_quick_print(){}
55895
55896/**
55897 * @return int
55898 * @since PHP 4 >= 4.3.3, PHP 5
55899 **/
55900function snmp_get_valueretrieval(){}
55901
55902/**
55903 * @param string $filename
55904 * @return bool
55905 * @since PHP 5
55906 **/
55907function snmp_read_mib($filename){}
55908
55909/**
55910 * @param int $enum_print
55911 * @return void
55912 * @since PHP 4 >= 4.3.0, PHP 5
55913 **/
55914function snmp_set_enum_print($enum_print){}
55915
55916/**
55917 * @param int $oid_numeric_print
55918 * @return void
55919 * @since PHP 4 >= 4.3.0, PHP 5
55920 **/
55921function snmp_set_oid_numeric_print($oid_numeric_print){}
55922
55923/**
55924 * {@link snmp_set_oid_output_format} sets the output format to be full
55925 * or numeric.
55926 *
55927 * @param int $oid_format Set it to SNMP_OID_OUTPUT_FULL if you want a
55928 *   full output, SNMP_OID_OUTPUT_NUMERIC otherwise.
55929 * @return void
55930 * @since PHP 5 >= 5.2.0
55931 **/
55932function snmp_set_oid_output_format($oid_format){}
55933
55934/**
55935 * Sets the value of {@link quick_print} within the UCD SNMP library.
55936 * When this is set (1), the SNMP library will return 'quick printed'
55937 * values. This means that just the value will be printed. When {@link
55938 * quick_print} is not enabled (default) the UCD SNMP library prints
55939 * extra information including the type of the value (i.e. IpAddress or
55940 * OID). Additionally, if quick_print is not enabled, the library prints
55941 * additional hex values for all strings of three characters or less.
55942 *
55943 * By default the UCD SNMP library returns verbose values, quick_print is
55944 * used to return only the value.
55945 *
55946 * Currently strings are still returned with extra quotes, this will be
55947 * corrected in a later release.
55948 *
55949 * @param bool $quick_print
55950 * @return void
55951 * @since PHP 4, PHP 5
55952 **/
55953function snmp_set_quick_print($quick_print){}
55954
55955/**
55956 * @param int $method
55957 * @return void
55958 * @since PHP 4 >= 4.3.3, PHP 5
55959 **/
55960function snmp_set_valueretrieval($method){}
55961
55962/**
55963 * After the socket {@link socket} has been created using {@link
55964 * socket_create}, bound to a name with {@link socket_bind}, and told to
55965 * listen for connections with {@link socket_listen}, this function will
55966 * accept incoming connections on that socket. Once a successful
55967 * connection is made, a new socket resource is returned, which may be
55968 * used for communication. If there are multiple connections queued on
55969 * the socket, the first will be used. If there are no pending
55970 * connections, {@link socket_accept} will block until a connection
55971 * becomes present. If {@link socket} has been made non-blocking using
55972 * {@link socket_set_blocking} or {@link socket_set_nonblock}, will be
55973 * returned.
55974 *
55975 * The socket resource returned by {@link socket_accept} may not be used
55976 * to accept new connections. The original listening socket {@link
55977 * socket}, however, remains open and may be reused.
55978 *
55979 * @param resource $socket A valid socket resource created with {@link
55980 *   socket_create}.
55981 * @return resource
55982 * @since PHP 4 >= 4.1.0, PHP 5
55983 **/
55984function socket_accept($socket){}
55985
55986/**
55987 * Binds the name given in {@link address} to the socket described by
55988 * {@link socket}. This has to be done before a connection is be
55989 * established using {@link socket_connect} or {@link socket_listen}.
55990 *
55991 * @param resource $socket A valid socket resource created with {@link
55992 *   socket_create}.
55993 * @param string $address If the socket is of the AF_INET family, the
55994 *   {@link address} is an IP in dotted-quad notation (e.g. 127.0.0.1).
55995 *   If the socket is of the AF_UNIX family, the {@link address} is the
55996 *   path of a Unix-domain socket (e.g. /tmp/my.sock).
55997 * @param int $port The {@link port} parameter is only used when
55998 *   connecting to an AF_INET socket, and designates the port on the
55999 *   remote host to which a connection should be made.
56000 * @return bool
56001 * @since PHP 4 >= 4.1.0, PHP 5
56002 **/
56003function socket_bind($socket, $address, $port){}
56004
56005/**
56006 * This function clears the error code on the given socket or the global
56007 * last socket error if no socket is specified.
56008 *
56009 * This function allows explicitly resetting the error code value either
56010 * of a socket or of the extension global last error code. This may be
56011 * useful to detect within a part of the application if an error occurred
56012 * or not.
56013 *
56014 * @param resource $socket A valid socket resource created with {@link
56015 *   socket_create}.
56016 * @return void
56017 * @since PHP 4 >= 4.2.0, PHP 5
56018 **/
56019function socket_clear_error($socket){}
56020
56021/**
56022 * {@link socket_close} closes the socket resource given by {@link
56023 * socket}. This function is specific to sockets and cannot be used on
56024 * any other type of resources.
56025 *
56026 * @param resource $socket A valid socket resource created with {@link
56027 *   socket_create} or {@link socket_accept}.
56028 * @return void
56029 * @since PHP 4 >= 4.1.0, PHP 5
56030 **/
56031function socket_close($socket){}
56032
56033/**
56034 * Initiate a connection to {@link address} using the socket resource
56035 * {@link socket}, which must be a valid socket resource created with
56036 * {@link socket_create}.
56037 *
56038 * @param resource $socket
56039 * @param string $address The {@link address} parameter is either an
56040 *   IPv4 address in dotted-quad notation (e.g. 127.0.0.1) if {@link
56041 *   socket} is AF_INET, a valid IPv6 address (e.g. ::1) if IPv6 support
56042 *   is enabled and {@link socket} is AF_INET6 or the pathname of a Unix
56043 *   domain socket, if the socket family is AF_UNIX.
56044 * @param int $port The {@link port} parameter is only used and is
56045 *   mandatory when connecting to an AF_INET or an AF_INET6 socket, and
56046 *   designates the port on the remote host to which a connection should
56047 *   be made.
56048 * @return bool
56049 * @since PHP 4 >= 4.1.0, PHP 5
56050 **/
56051function socket_connect($socket, $address, $port){}
56052
56053/**
56054 * Creates and returns a socket resource, also referred to as an endpoint
56055 * of communication. A typical network connection is made up of 2
56056 * sockets, one performing the role of the client, and another performing
56057 * the role of the server.
56058 *
56059 * @param int $domain The {@link domain} parameter specifies the
56060 *   protocol family to be used by the socket.
56061 * @param int $type The {@link type} parameter selects the type of
56062 *   communication to be used by the socket.
56063 * @param int $protocol The {@link protocol} parameter sets the
56064 *   specific protocol within the specified {@link domain} to be used
56065 *   when communicating on the returned socket. The proper value can be
56066 *   retrieved by name by using {@link getprotobyname}. If the desired
56067 *   protocol is TCP, or UDP the corresponding constants SOL_TCP, and
56068 *   SOL_UDP can also be used.
56069 * @return resource
56070 * @since PHP 4 >= 4.1.0, PHP 5
56071 **/
56072function socket_create($domain, $type, $protocol){}
56073
56074/**
56075 * {@link socket_create_listen} creates a new socket resource of type
56076 * AF_INET listening on all local interfaces on the given port waiting
56077 * for new connections.
56078 *
56079 * This function is meant to ease the task of creating a new socket which
56080 * only listens to accept new connections.
56081 *
56082 * @param int $port The port on which to listen on all interfaces.
56083 * @param int $backlog The {@link backlog} parameter defines the
56084 *   maximum length the queue of pending connections may grow to.
56085 *   SOMAXCONN may be passed as {@link backlog} parameter, see {@link
56086 *   socket_listen} for more information.
56087 * @return resource
56088 * @since PHP 4 >= 4.1.0, PHP 5
56089 **/
56090function socket_create_listen($port, $backlog){}
56091
56092/**
56093 * {@link socket_create_pair} creates two connected and indistinguishable
56094 * sockets, and stores them in {@link fd}. This function is commonly used
56095 * in IPC (InterProcess Communication).
56096 *
56097 * @param int $domain The {@link domain} parameter specifies the
56098 *   protocol family to be used by the socket. See {@link socket_create}
56099 *   for the full list.
56100 * @param int $type The {@link type} parameter selects the type of
56101 *   communication to be used by the socket. See {@link socket_create}
56102 *   for the full list.
56103 * @param int $protocol The {@link protocol} parameter sets the
56104 *   specific protocol within the specified {@link domain} to be used
56105 *   when communicating on the returned socket. The proper value can be
56106 *   retrieved by name by using {@link getprotobyname}. If the desired
56107 *   protocol is TCP, or UDP the corresponding constants SOL_TCP, and
56108 *   SOL_UDP can also be used. See {@link socket_create} for the full
56109 *   list of supported protocols.
56110 * @param array $fd Reference to an array in which the two socket
56111 *   resources will be inserted.
56112 * @return bool
56113 * @since PHP 4 >= 4.1.0, PHP 5
56114 **/
56115function socket_create_pair($domain, $type, $protocol, &$fd){}
56116
56117/**
56118 * Queries the remote side of the given socket which may either result in
56119 * host/port or in a Unix filesystem path, dependent on its type.
56120 *
56121 * @param resource $socket A valid socket resource created with {@link
56122 *   socket_create} or {@link socket_accept}.
56123 * @param string $address If the given socket is of type AF_INET or
56124 *   AF_INET6, {@link socket_getpeername} will return the peers (remote)
56125 *   IP address in appropriate notation (e.g. 127.0.0.1 or fe80::1) in
56126 *   the {@link address} parameter and, if the optional {@link port}
56127 *   parameter is present, also the associated port. If the given socket
56128 *   is of type AF_UNIX, {@link socket_getpeername} will return the Unix
56129 *   filesystem path (e.g. /var/run/daemon.sock) in the {@link address}
56130 *   parameter.
56131 * @param int $port If given, this will hold the port associated to
56132 *   {@link address}.
56133 * @return bool
56134 * @since PHP 4 >= 4.1.0, PHP 5
56135 **/
56136function socket_getpeername($socket, &$address, &$port){}
56137
56138/**
56139 * @param resource $socket A valid socket resource created with {@link
56140 *   socket_create} or {@link socket_accept}.
56141 * @param string $addr If the given socket is of type AF_INET or
56142 *   AF_INET6, {@link socket_getsockname} will return the local IP
56143 *   address in appropriate notation (e.g. 127.0.0.1 or fe80::1) in the
56144 *   {@link address} parameter and, if the optional {@link port}
56145 *   parameter is present, also the associated port. If the given socket
56146 *   is of type AF_UNIX, {@link socket_getsockname} will return the Unix
56147 *   filesystem path (e.g. /var/run/daemon.sock) in the {@link address}
56148 *   parameter.
56149 * @param int $port If provided, this will hold the associated port.
56150 * @return bool
56151 * @since PHP 4 >= 4.1.0, PHP 5
56152 **/
56153function socket_getsockname($socket, &$addr, &$port){}
56154
56155/**
56156 * The {@link socket_get_option} function retrieves the value for the
56157 * option specified by the {@link optname} parameter for the specified
56158 * {@link socket}.
56159 *
56160 * @param resource $socket A valid socket resource created with {@link
56161 *   socket_create} or {@link socket_accept}.
56162 * @param int $level The {@link level} parameter specifies the protocol
56163 *   level at which the option resides. For example, to retrieve options
56164 *   at the socket level, a {@link level} parameter of SOL_SOCKET would
56165 *   be used. Other levels, such as TCP, can be used by specifying the
56166 *   protocol number of that level. Protocol numbers can be found by
56167 *   using the {@link getprotobyname} function.
56168 * @param int $optname
56169 * @return mixed
56170 * @since PHP 4 >= 4.3.0, PHP 5
56171 **/
56172function socket_get_option($socket, $level, $optname){}
56173
56174/**
56175 * If a socket resource is passed to this function, the last error which
56176 * occurred on this particular socket is returned. If the socket resource
56177 * is omitted, the error code of the last failed socket function is
56178 * returned. The latter is particularly helpful for functions like {@link
56179 * socket_create} which don't return a socket on failure and {@link
56180 * socket_select} which can fail for reasons not directly tied to a
56181 * particular socket. The error code is suitable to be fed to {@link
56182 * socket_strerror} which returns a string describing the given error
56183 * code.
56184 *
56185 * @param resource $socket A valid socket resource created with {@link
56186 *   socket_create}.
56187 * @return int
56188 * @since PHP 4 >= 4.1.0, PHP 5
56189 **/
56190function socket_last_error($socket){}
56191
56192/**
56193 * After the socket {@link socket} has been created using {@link
56194 * socket_create} and bound to a name with {@link socket_bind}, it may be
56195 * told to listen for incoming connections on {@link socket}.
56196 *
56197 * {@link socket_listen} is applicable only to sockets of type
56198 * SOCK_STREAM or SOCK_SEQPACKET.
56199 *
56200 * @param resource $socket A valid socket resource created with {@link
56201 *   socket_create}.
56202 * @param int $backlog A maximum of {@link backlog} incoming
56203 *   connections will be queued for processing. If a connection request
56204 *   arrives with the queue full the client may receive an error with an
56205 *   indication of ECONNREFUSED, or, if the underlying protocol supports
56206 *   retransmission, the request may be ignored so that retries may
56207 *   succeed.
56208 * @return bool
56209 * @since PHP 4 >= 4.1.0, PHP 5
56210 **/
56211function socket_listen($socket, $backlog){}
56212
56213/**
56214 * The function {@link socket_read} reads from the socket resource {@link
56215 * socket} created by the {@link socket_create} or {@link socket_accept}
56216 * functions.
56217 *
56218 * @param resource $socket A valid socket resource created with {@link
56219 *   socket_create} or {@link socket_accept}.
56220 * @param int $length The maximum number of bytes read is specified by
56221 *   the {@link length} parameter. Otherwise you can use \r, \n, or \0 to
56222 *   end reading (depending on the {@link type} parameter, see below).
56223 * @param int $type Optional {@link type} parameter is a named
56224 *   constant: PHP_BINARY_READ (Default) - use the system recv()
56225 *   function. Safe for reading binary data. PHP_NORMAL_READ - reading
56226 *   stops at \n or \r.
56227 * @return string
56228 * @since PHP 4 >= 4.1.0, PHP 5
56229 **/
56230function socket_read($socket, $length, $type){}
56231
56232/**
56233 * The {@link socket_recv} function receives {@link len} bytes of data in
56234 * {@link buf} from {@link socket}. {@link socket_recv} can be used to
56235 * gather data from connected sockets. Additionally, one or more flags
56236 * can be specified to modify the behaviour of the function.
56237 *
56238 * {@link buf} is passed by reference, so it must be specified as a
56239 * variable in the argument list. Data read from {@link socket} by {@link
56240 * socket_recv} will be returned in {@link buf}.
56241 *
56242 * @param resource $socket The {@link socket} must be a socket resource
56243 *   previously created by socket_create().
56244 * @param string $buf The data received will be fetched to the variable
56245 *   specified with {@link buf}. If an error occurs, if the connection is
56246 *   reset, or if no data is available, {@link buf} will be set to .
56247 * @param int $len Up to {@link len} bytes will be fetched from remote
56248 *   host.
56249 * @param int $flags The value of {@link flags} can be any combination
56250 *   of the following flags, joined with the binary OR (|) operator.
56251 * @return int
56252 * @since PHP 4 >= 4.1.0, PHP 5
56253 **/
56254function socket_recv($socket, &$buf, $len, $flags){}
56255
56256/**
56257 * The {@link socket_recvfrom} function receives {@link len} bytes of
56258 * data in {@link buf} from {@link name} on port {@link port} (if the
56259 * socket is not of type AF_UNIX) using {@link socket}. {@link
56260 * socket_recvfrom} can be used to gather data from both connected and
56261 * unconnected sockets. Additionally, one or more flags can be specified
56262 * to modify the behaviour of the function.
56263 *
56264 * The {@link name} and {@link port} must be passed by reference. If the
56265 * socket is not connection-oriented, {@link name} will be set to the
56266 * internet protocol address of the remote host or the path to the UNIX
56267 * socket. If the socket is connection-oriented, {@link name} is .
56268 * Additionally, the {@link port} will contain the port of the remote
56269 * host in the case of an unconnected AF_INET or AF_INET6 socket.
56270 *
56271 * @param resource $socket The {@link socket} must be a socket resource
56272 *   previously created by socket_create().
56273 * @param string $buf The data received will be fetched to the variable
56274 *   specified with {@link buf}.
56275 * @param int $len Up to {@link len} bytes will be fetched from remote
56276 *   host.
56277 * @param int $flags The value of {@link flags} can be any combination
56278 *   of the following flags, joined with the binary OR (|) operator.
56279 * @param string $name If the socket is of the type AF_UNIX type,
56280 *   {@link name} is the path to the file. Else, for unconnected sockets,
56281 *   {@link name} is the IP address of, the remote host, or if the socket
56282 *   is connection-oriented.
56283 * @param int $port This argument only applies to AF_INET and AF_INET6
56284 *   sockets, and specifies the remote port from which the data is
56285 *   received. If the socket is connection-oriented, {@link port} will be
56286 *   .
56287 * @return int
56288 * @since PHP 4 >= 4.1.0, PHP 5
56289 **/
56290function socket_recvfrom($socket, &$buf, $len, $flags, &$name, &$port){}
56291
56292/**
56293 * {@link socket_select} accepts arrays of sockets and waits for them to
56294 * change status. Those coming with BSD sockets background will recognize
56295 * that those socket resource arrays are in fact the so-called file
56296 * descriptor sets. Three independent arrays of socket resources are
56297 * watched.
56298 *
56299 * @param array $read The sockets listed in the {@link read} array will
56300 *   be watched to see if characters become available for reading (more
56301 *   precisely, to see if a read will not block - in particular, a socket
56302 *   resource is also ready on end-of-file, in which case a {@link
56303 *   socket_read} will return a zero length string).
56304 * @param array $write The sockets listed in the {@link write} array
56305 *   will be watched to see if a write will not block.
56306 * @param array $except The sockets listed in the {@link except} array
56307 *   will be watched for exceptions.
56308 * @param int $tv_sec The {@link tv_sec} and {@link tv_usec} together
56309 *   form the timeout parameter. The timeout is an upper bound on the
56310 *   amount of time elapsed before {@link socket_select} return. {@link
56311 *   tv_sec} may be zero , causing {@link socket_select} to return
56312 *   immediately. This is useful for polling. If {@link tv_sec} is (no
56313 *   timeout), {@link socket_select} can block indefinitely.
56314 * @param int $tv_usec
56315 * @return int
56316 * @since PHP 4 >= 4.1.0, PHP 5
56317 **/
56318function socket_select(&$read, &$write, &$except, $tv_sec, $tv_usec){}
56319
56320/**
56321 * The function {@link socket_send} sends {@link len} bytes to the socket
56322 * {@link socket} from {@link buf}.
56323 *
56324 * @param resource $socket A valid socket resource created with {@link
56325 *   socket_create} or {@link socket_accept}.
56326 * @param string $buf A buffer containing the data that will be sent to
56327 *   the remote host.
56328 * @param int $len The number of bytes that will be sent to the remote
56329 *   host from {@link buf}.
56330 * @param int $flags The value of {@link flags} can be any combination
56331 *   of the following flags, joined with the binary OR (|) operator.
56332 *   Possible values for {@link flags} MSG_OOB Send OOB (out-of-band)
56333 *   data. MSG_EOR Indicate a record mark. The sent data completes the
56334 *   record. MSG_EOF Close the sender side of the socket and include an
56335 *   appropriate notification of this at the end of the sent data. The
56336 *   sent data completes the transaction. MSG_DONTROUTE Bypass routing,
56337 *   use direct interface.
56338 * @return int
56339 * @since PHP 4 >= 4.1.0, PHP 5
56340 **/
56341function socket_send($socket, $buf, $len, $flags){}
56342
56343/**
56344 * The function {@link socket_sendto} sends {@link len} bytes from {@link
56345 * buf} through the socket {@link socket} to the {@link port} at the
56346 * address {@link addr}.
56347 *
56348 * @param resource $socket A valid socket resource created using {@link
56349 *   socket_create}.
56350 * @param string $buf The sent data will be taken from buffer {@link
56351 *   buf}.
56352 * @param int $len {@link len} bytes from {@link buf} will be sent.
56353 * @param int $flags The value of {@link flags} can be any combination
56354 *   of the following flags, joined with the binary OR (|) operator.
56355 *   Possible values for {@link flags} MSG_OOB Send OOB (out-of-band)
56356 *   data. MSG_EOR Indicate a record mark. The sent data completes the
56357 *   record. MSG_EOF Close the sender side of the socket and include an
56358 *   appropriate notification of this at the end of the sent data. The
56359 *   sent data completes the transaction. MSG_DONTROUTE Bypass routing,
56360 *   use direct interface.
56361 * @param string $addr IP address of the remote host.
56362 * @param int $port {@link port} is the remote port number at which the
56363 *   data will be sent.
56364 * @return int
56365 * @since PHP 4 >= 4.1.0, PHP 5
56366 **/
56367function socket_sendto($socket, $buf, $len, $flags, $addr, $port){}
56368
56369/**
56370 * The {@link socket_set_block} function removes the O_NONBLOCK flag on
56371 * the socket specified by the {@link socket} parameter.
56372 *
56373 * When an operation (e.g. receive, send, connect, accept, ...) is
56374 * performed on a blocking socket, the script will pause its execution
56375 * until it receives a signal or it can perform the operation.
56376 *
56377 * @param resource $socket A valid socket resource created with {@link
56378 *   socket_create} or {@link socket_accept}.
56379 * @return bool
56380 * @since PHP 4 >= 4.2.0, PHP 5
56381 **/
56382function socket_set_block($socket){}
56383
56384/**
56385 * The {@link socket_set_nonblock} function sets the O_NONBLOCK flag on
56386 * the socket specified by the {@link socket} parameter.
56387 *
56388 * When an operation (e.g. receive, send, connect, accept, ...) is
56389 * performed on a non-blocking socket, the script not pause its execution
56390 * until it receives a signal or it can perform the operation. Rather, if
56391 * the operation would result in a block, the called function will fail.
56392 *
56393 * @param resource $socket A valid socket resource created with {@link
56394 *   socket_create} or {@link socket_accept}.
56395 * @return bool
56396 * @since PHP 4 >= 4.1.0, PHP 5
56397 **/
56398function socket_set_nonblock($socket){}
56399
56400/**
56401 * The {@link socket_set_option} function sets the option specified by
56402 * the {@link optname} parameter, at the specified protocol {@link
56403 * level}, to the value pointed to by the {@link optval} parameter for
56404 * the {@link socket}.
56405 *
56406 * @param resource $socket A valid socket resource created with {@link
56407 *   socket_create} or {@link socket_accept}.
56408 * @param int $level The {@link level} parameter specifies the protocol
56409 *   level at which the option resides. For example, to retrieve options
56410 *   at the socket level, a {@link level} parameter of SOL_SOCKET would
56411 *   be used. Other levels, such as TCP, can be used by specifying the
56412 *   protocol number of that level. Protocol numbers can be found by
56413 *   using the {@link getprotobyname} function.
56414 * @param int $optname The available socket options are the same as
56415 *   those for the {@link socket_get_option} function.
56416 * @param mixed $optval The option value.
56417 * @return bool
56418 * @since PHP 4 >= 4.3.0, PHP 5
56419 **/
56420function socket_set_option($socket, $level, $optname, $optval){}
56421
56422/**
56423 * The {@link socket_shutdown} function allows you to stop incoming,
56424 * outgoing or all data (the default) from being sent through the {@link
56425 * socket}
56426 *
56427 * @param resource $socket A valid socket resource created with {@link
56428 *   socket_create}.
56429 * @param int $how The value of {@link how} can be one of the
56430 *   following: possible values for {@link how} 0 Shutdown socket reading
56431 *   1 Shutdown socket writing 2 Shutdown socket reading and writing
56432 * @return bool
56433 * @since PHP 4 >= 4.1.0, PHP 5
56434 **/
56435function socket_shutdown($socket, $how){}
56436
56437/**
56438 * {@link socket_strerror} takes as its {@link errno} parameter a socket
56439 * error code as returned by {@link socket_last_error} and returns the
56440 * corresponding explanatory text.
56441 *
56442 * @param int $errno A valid socket error number, likely produced by
56443 *   {@link socket_last_error}.
56444 * @return string
56445 * @since PHP 4 >= 4.1.0, PHP 5
56446 **/
56447function socket_strerror($errno){}
56448
56449/**
56450 * The function {@link socket_write} writes to the {@link socket} from
56451 * the given {@link buffer}.
56452 *
56453 * @param resource $socket
56454 * @param string $buffer The buffer to be written.
56455 * @param int $length The optional parameter {@link length} can specify
56456 *   an alternate length of bytes written to the socket. If this length
56457 *   is greater then the buffer length, it is silently truncated to the
56458 *   length of the buffer.
56459 * @return int
56460 * @since PHP 4 >= 4.1.0, PHP 5
56461 **/
56462function socket_write($socket, $buffer, $length){}
56463
56464/**
56465 * This function returns the current version of the extension as a
56466 * string.
56467 *
56468 * @return string
56469 * @since PECL solr >= 0.9.1
56470 **/
56471function solr_get_version(){}
56472
56473/**
56474 * This function sorts an array. Elements will be arranged from lowest to
56475 * highest when this function has completed.
56476 *
56477 * @param array $array The input array.
56478 * @param int $sort_flags The optional second parameter {@link
56479 *   sort_flags} may be used to modify the sorting behavior using these
56480 *   values: Sorting type flags: SORT_REGULAR - compare items normally
56481 *   (don't change types) SORT_NUMERIC - compare items numerically
56482 *   SORT_STRING - compare items as strings SORT_LOCALE_STRING - compare
56483 *   items as strings, based on the current locale. Added in PHP 4.4.0
56484 *   and 5.0.2, it uses the system locale, which can be changed using
56485 *   {@link setlocale}.
56486 * @return bool
56487 * @since PHP 4, PHP 5
56488 **/
56489function sort(&$array, $sort_flags){}
56490
56491/**
56492 * Calculates the soundex key of {@link str}.
56493 *
56494 * Soundex keys have the property that words pronounced similarly produce
56495 * the same soundex key, and can thus be used to simplify searches in
56496 * databases where you know the pronunciation but not the spelling. This
56497 * soundex function returns a string 4 characters long, starting with a
56498 * letter.
56499 *
56500 * This particular soundex function is one described by Donald Knuth in
56501 * "The Art Of Computer Programming, vol. 3: Sorting And Searching",
56502 * Addison-Wesley (1973), pp. 391-392.
56503 *
56504 * @param string $str The input string.
56505 * @return string
56506 * @since PHP 4, PHP 5
56507 **/
56508function soundex($str){}
56509
56510/**
56511 * Splits a {@link string} into array by regular expression.
56512 *
56513 * @param string $pattern Case sensitive regular expression. If you
56514 *   want to split on any of the characters which are considered special
56515 *   by regular expressions, you'll need to escape them first. If you
56516 *   think {@link split} (or any other regex function, for that matter)
56517 *   is doing something weird, please read the file regex.7, included in
56518 *   the regex/ subdirectory of the PHP distribution. It's in manpage
56519 *   format, so you'll want to do something along the lines of man
56520 *   /usr/local/src/regex/regex.7 in order to read it.
56521 * @param string $string The input string.
56522 * @param int $limit If {@link limit} is set, the returned array will
56523 *   contain a maximum of {@link limit} elements with the last element
56524 *   containing the whole rest of {@link string}.
56525 * @return array
56526 * @since PHP 4, PHP 5
56527 **/
56528function split($pattern, $string, $limit){}
56529
56530/**
56531 * Splits a {@link string} into array by regular expression.
56532 *
56533 * This function is identical to {@link split} except that this ignores
56534 * case distinction when matching alphabetic characters.
56535 *
56536 * @param string $pattern Case insensitive regular expression. If you
56537 *   want to split on any of the characters which are considered special
56538 *   by regular expressions, you'll need to escape them first. If you
56539 *   think {@link spliti} (or any other regex function, for that matter)
56540 *   is doing something weird, please read the file regex.7, included in
56541 *   the regex/ subdirectory of the PHP distribution. It's in manpage
56542 *   format, so you'll want to do something along the lines of man
56543 *   /usr/local/src/regex/regex.7 in order to read it.
56544 * @param string $string The input string.
56545 * @param int $limit If {@link limit} is set, the returned array will
56546 *   contain a maximum of {@link limit} elements with the last element
56547 *   containing the whole rest of {@link string}.
56548 * @return array
56549 * @since PHP 4 >= 4.0.1, PHP 5
56550 **/
56551function spliti($pattern, $string, $limit){}
56552
56553/**
56554 * This function is intended to be used as a default implementation for
56555 * {@link __autoload}. If nothing else is specified and {@link
56556 * spl_autoload_register} is called without any parameters then this
56557 * functions will be used for any later call to {@link __autoload}.
56558 *
56559 * @param string $class_name
56560 * @param string $file_extensions By default it checks all include
56561 *   paths to contain filenames built up by the lowercase class name
56562 *   appended by the filename extensions .inc and .php.
56563 * @return void
56564 * @since PHP 5 >= 5.1.2
56565 **/
56566function spl_autoload($class_name, $file_extensions){}
56567
56568/**
56569 * This function can be used to manually search for a class or interface
56570 * using the registered __autoload functions.
56571 *
56572 * @param string $class_name The class name being searched.
56573 * @return void
56574 * @since PHP 5 >= 5.1.2
56575 **/
56576function spl_autoload_call($class_name){}
56577
56578/**
56579 * This function can modify and check the file extensions that the built
56580 * in {@link __autoload} fallback function {@link spl_autoload} will be
56581 * using.
56582 *
56583 * @param string $file_extensions When calling without an argument, it
56584 *   simply returns the current list of extensions each separated by
56585 *   comma. To modify the list of file extensions, simply invoke the
56586 *   functions with the new list of file extensions to use in a single
56587 *   string with each extensions separated by comma.
56588 * @return string
56589 * @since PHP 5 >= 5.1.2
56590 **/
56591function spl_autoload_extensions($file_extensions){}
56592
56593/**
56594 * Get all registered __autoload() functions.
56595 *
56596 * @return array
56597 * @since PHP 5 >= 5.1.2
56598 **/
56599function spl_autoload_functions(){}
56600
56601/**
56602 * Register a function with the spl provided __autoload stack. If the
56603 * stack is not yet activated it will be activated.
56604 *
56605 * If your code has an existing __autoload function then this function
56606 * must be explicitly registered on the __autoload stack. This is because
56607 * spl_autoload_register() will effectively replace the engine cache for
56608 * the __autoload function by either spl_autoload() or
56609 * spl_autoload_call().
56610 *
56611 * If there must be multiple autoload functions, {@link
56612 * spl_autoload_register} allows for this. It effectively creates a queue
56613 * of autoload functions, and runs through each of them in the order they
56614 * are defined. By contrast, {@link __autoload} may only be defined once.
56615 *
56616 * @param callback $autoload_function The autoload function being
56617 *   registered. If no parameter is provided, then the default
56618 *   implementation of {@link spl_autoload} will be registered.
56619 * @param bool $throw This parameter specifies whether {@link
56620 *   spl_autoload_register} should throw exceptions on error.
56621 * @param bool $prepend If true, {@link spl_autoload_register} will
56622 *   prepend the autoloader on the autoload stack instead of appending
56623 *   it.
56624 * @return bool
56625 * @since PHP 5 >= 5.1.2
56626 **/
56627function spl_autoload_register($autoload_function, $throw, $prepend){}
56628
56629/**
56630 * Unregister a function from the spl provided __autoload stack. If the
56631 * stack is activated and empty after unregistering the given function
56632 * then it will be deactivated.
56633 *
56634 * When this function results in the autoload stack being deactivated,
56635 * any __autoload function that previously existed will not be
56636 * reactivated.
56637 *
56638 * @param mixed $autoload_function The autoload function being
56639 *   unregistered.
56640 * @return bool
56641 * @since PHP 5 >= 5.1.2
56642 **/
56643function spl_autoload_unregister($autoload_function){}
56644
56645/**
56646 * This function returns an array with the current available SPL classes.
56647 *
56648 * @return array
56649 * @since PHP 5
56650 **/
56651function spl_classes(){}
56652
56653/**
56654 * This function returns a unique identifier for the object. This id can
56655 * be used as a hash key for storing objects or for identifying an
56656 * object.
56657 *
56658 * @param object $obj Any object.
56659 * @return string
56660 * @since PHP 5 >= 5.2.0
56661 **/
56662function spl_object_hash($obj){}
56663
56664/**
56665 * Returns a string produced according to the formatting string {@link
56666 * format}.
56667 *
56668 * @param string $format The format string is composed of zero or more
56669 *   directives: ordinary characters (excluding %) that are copied
56670 *   directly to the result, and conversion specifications, each of which
56671 *   results in fetching its own parameter. This applies to both {@link
56672 *   sprintf} and {@link printf}. Each conversion specification consists
56673 *   of a percent sign (%), followed by one or more of these elements, in
56674 *   order: An optional sign specifier that forces a sign (- or +) to be
56675 *   used on a number. By default, only the - sign is used on a number if
56676 *   it's negative. This specifier forces positive numbers to have the +
56677 *   sign attached as well, and was added in PHP 4.3.0. An optional
56678 *   padding specifier that says what character will be used for padding
56679 *   the results to the right string size. This may be a space character
56680 *   or a 0 (zero character). The default is to pad with spaces. An
56681 *   alternate padding character can be specified by prefixing it with a
56682 *   single quote ('). See the examples below. An optional alignment
56683 *   specifier that says if the result should be left-justified or
56684 *   right-justified. The default is right-justified; a - character here
56685 *   will make it left-justified. An optional number, a width specifier
56686 *   that says how many characters (minimum) this conversion should
56687 *   result in. An optional precision specifier in the form of a period
56688 *   (`.') followed by an optional decimal digit string that says how
56689 *   many decimal digits should be displayed for floating-point numbers.
56690 *   When using this specifier on a string, it acts as a cutoff point,
56691 *   setting a maximum character limit to the string. A type specifier
56692 *   that says what type the argument data should be treated as. Possible
56693 *   types: % - a literal percent character. No argument is required. b -
56694 *   the argument is treated as an integer, and presented as a binary
56695 *   number. c - the argument is treated as an integer, and presented as
56696 *   the character with that ASCII value. d - the argument is treated as
56697 *   an integer, and presented as a (signed) decimal number. e - the
56698 *   argument is treated as scientific notation (e.g. 1.2e+2). The
56699 *   precision specifier stands for the number of digits after the
56700 *   decimal point since PHP 5.2.1. In earlier versions, it was taken as
56701 *   number of significant digits (one less). E - like %e but uses
56702 *   uppercase letter (e.g. 1.2E+2). u - the argument is treated as an
56703 *   integer, and presented as an unsigned decimal number. f - the
56704 *   argument is treated as a float, and presented as a floating-point
56705 *   number (locale aware). F - the argument is treated as a float, and
56706 *   presented as a floating-point number (non-locale aware). Available
56707 *   since PHP 4.3.10 and PHP 5.0.3. g - shorter of %e and %f. G -
56708 *   shorter of %E and %f. o - the argument is treated as an integer, and
56709 *   presented as an octal number. s - the argument is treated as and
56710 *   presented as a string. x - the argument is treated as an integer and
56711 *   presented as a hexadecimal number (with lowercase letters). X - the
56712 *   argument is treated as an integer and presented as a hexadecimal
56713 *   number (with uppercase letters). The format string supports argument
56714 *   numbering/swapping. Here is an example: Argument swapping
56715 *
56716 *   <?php $format = 'There are %d monkeys in the %s'; printf($format,
56717 *   $num, $location); ?>
56718 *
56719 *   This might output, "There are 5 monkeys in the tree". But imagine we
56720 *   are creating a format string in a separate file, commonly because we
56721 *   would like to internationalize it and we rewrite it as: Argument
56722 *   swapping
56723 *
56724 *   <?php $format = 'The %s contains %d monkeys'; printf($format, $num,
56725 *   $location); ?>
56726 *
56727 *   We now have a problem. The order of the placeholders in the format
56728 *   string does not match the order of the arguments in the code. We
56729 *   would like to leave the code as is and simply indicate in the format
56730 *   string which arguments the placeholders refer to. We would write the
56731 *   format string like this instead: Argument swapping
56732 *
56733 *   <?php $format = 'The %2$s contains %1$d monkeys'; printf($format,
56734 *   $num, $location); ?>
56735 *
56736 *   An added benefit here is that you can repeat the placeholders
56737 *   without adding more arguments in the code. For example: Argument
56738 *   swapping
56739 *
56740 *   <?php $format = 'The %2$s contains %1$d monkeys. That\'s a nice %2$s
56741 *   full of %1$d monkeys.'; printf($format, $num, $location); ?>
56742 * @param mixed $args
56743 * @return string
56744 * @since PHP 4, PHP 5
56745 **/
56746function sprintf($format, $args){}
56747
56748/**
56749 * {@link sqlite_array_query} executes the given query and returns an
56750 * array of the entire result set. It is similar to calling {@link
56751 * sqlite_query} and then {@link sqlite_fetch_array} for each row in the
56752 * result set. {@link sqlite_array_query} is significantly faster than
56753 * the aforementioned.
56754 *
56755 * @param resource $dbhandle The query to be executed. Data inside the
56756 *   query should be properly escaped.
56757 * @param string $query The SQLite Database resource; returned from
56758 *   {@link sqlite_open} when used procedurally. This parameter is not
56759 *   required when using the object-oriented method.
56760 * @param int $result_type
56761 * @param bool $decode_binary
56762 * @return array
56763 * @since PHP 5, PECL sqlite >= 1.0.0
56764 **/
56765function sqlite_array_query($dbhandle, $query, $result_type, $decode_binary){}
56766
56767/**
56768 * Set the maximum time, in milliseconds, that SQLite will wait for a
56769 * {@link dbhandle} to become ready for use.
56770 *
56771 * @param resource $dbhandle The SQLite Database resource; returned
56772 *   from {@link sqlite_open} when used procedurally. This parameter is
56773 *   not required when using the object-oriented method.
56774 * @param int $milliseconds The number of milliseconds. When set to 0,
56775 *   busy handlers will be disabled and SQLite will return immediately
56776 *   with a SQLITE_BUSY status code if another process/thread has the
56777 *   database locked for an update. PHP sets the default busy timeout to
56778 *   be 60 seconds when the database is opened.
56779 * @return void
56780 * @since PHP 5, PECL sqlite >= 1.0.0
56781 **/
56782function sqlite_busy_timeout($dbhandle, $milliseconds){}
56783
56784/**
56785 * Returns the numbers of rows that were changed by the most recent SQL
56786 * statement executed against the {@link dbhandle} database handle.
56787 *
56788 * @param resource $dbhandle The SQLite Database resource; returned
56789 *   from {@link sqlite_open} when used procedurally. This parameter is
56790 *   not required when using the object-oriented method.
56791 * @return int
56792 * @since PHP 5, PECL sqlite >= 1.0.0
56793 **/
56794function sqlite_changes($dbhandle){}
56795
56796/**
56797 * Closes the given {@link database} handle. If the database was
56798 * persistent, it will be closed and removed from the persistent list.
56799 *
56800 * @param resource $dbhandle The SQLite Database resource; returned
56801 *   from {@link sqlite_open} when used procedurally.
56802 * @return void
56803 * @since PHP 5, PECL sqlite >= 1.0.0
56804 **/
56805function sqlite_close($dbhandle){}
56806
56807/**
56808 * Fetches the value of a column named {@link index_or_name} (if it is a
56809 * string), or of the ordinal column numbered {@link index_or_name} (if
56810 * it is an integer) from the current row of the query result handle
56811 * {@link result}.
56812 *
56813 * @param resource $result The SQLite result resource. This parameter
56814 *   is not required when using the object-oriented method.
56815 * @param mixed $index_or_name The column index or name to fetch.
56816 * @param bool $decode_binary
56817 * @return mixed
56818 * @since PHP 5, PECL sqlite >= 1.0.0
56819 **/
56820function sqlite_column($result, $index_or_name, $decode_binary){}
56821
56822/**
56823 * {@link sqlite_create_aggregate} is similar to {@link
56824 * sqlite_create_function} except that it registers functions that can be
56825 * used to calculate a result aggregated across all the rows of a query.
56826 *
56827 * The key difference between this function and {@link
56828 * sqlite_create_function} is that two functions are required to manage
56829 * the aggregate; {@link step_func} is called for each row of the result
56830 * set. Your PHP function should accumulate the result and store it into
56831 * the aggregation context. Once all the rows have been processed, {@link
56832 * finalize_func} will be called and it should then take the data from
56833 * the aggregation context and return the result. Callback functions
56834 * should return a type understood by SQLite (i.e. scalar type).
56835 *
56836 * @param resource $dbhandle The SQLite Database resource; returned
56837 *   from {@link sqlite_open} when used procedurally. This parameter is
56838 *   not required when using the object-oriented method.
56839 * @param string $function_name The name of the function used in SQL
56840 *   statements.
56841 * @param callback $step_func Callback function called for each row of
56842 *   the result set.
56843 * @param callback $finalize_func Callback function to aggregate the
56844 *   "stepped" data from each row.
56845 * @param int $num_args Hint to the SQLite parser if the callback
56846 *   function accepts a predetermined number of arguments.
56847 * @return void
56848 * @since PHP 5, PECL sqlite >= 1.0.0
56849 **/
56850function sqlite_create_aggregate($dbhandle, $function_name, $step_func, $finalize_func, $num_args){}
56851
56852/**
56853 * {@link sqlite_create_function} allows you to register a PHP function
56854 * with SQLite as an UDF (User Defined Function), so that it can be
56855 * called from within your SQL statements.
56856 *
56857 * The UDF can be used in any SQL statement that can call functions, such
56858 * as SELECT and UPDATE statements and also in triggers.
56859 *
56860 * @param resource $dbhandle The SQLite Database resource; returned
56861 *   from {@link sqlite_open} when used procedurally. This parameter is
56862 *   not required when using the object-oriented method.
56863 * @param string $function_name The name of the function used in SQL
56864 *   statements.
56865 * @param callback $callback Callback function to handle the defined
56866 *   SQL function.
56867 * @param int $num_args Hint to the SQLite parser if the callback
56868 *   function accepts a predetermined number of arguments.
56869 * @return void
56870 * @since PHP 5, sqlite >= 1.0.0
56871 **/
56872function sqlite_create_function($dbhandle, $function_name, $callback, $num_args){}
56873
56874/**
56875 * {@link sqlite_current} is identical to {@link sqlite_fetch_array}
56876 * except that it does not advance to the next row prior to returning the
56877 * data; it returns the data from the current position only.
56878 *
56879 * @param resource $result The SQLite result resource. This parameter
56880 *   is not required when using the object-oriented method.
56881 * @param int $result_type
56882 * @param bool $decode_binary
56883 * @return array
56884 * @since PHP 5, PECL sqlite >= 1.0.0
56885 **/
56886function sqlite_current($result, $result_type, $decode_binary){}
56887
56888/**
56889 * Returns a human readable description of the {@link error_code}
56890 * returned from {@link sqlite_last_error}.
56891 *
56892 * @param int $error_code The error code being used, which might be
56893 *   passed in from {@link sqlite_last_error}.
56894 * @return string
56895 * @since PHP 5, PECL sqlite >= 1.0.0
56896 **/
56897function sqlite_error_string($error_code){}
56898
56899/**
56900 * {@link sqlite_escape_string} will correctly quote the string specified
56901 * by {@link item} for use in an SQLite SQL statement. This includes
56902 * doubling up single-quote characters (') and checking for binary-unsafe
56903 * characters in the query string.
56904 *
56905 * Although the encoding makes it safe to insert the data, it will render
56906 * simple text comparisons and LIKE clauses in your queries unusable for
56907 * the columns that contain the binary data. In practice, this shouldn't
56908 * be a problem, as your schema should be such that you don't use such
56909 * things on binary columns (in fact, it might be better to store binary
56910 * data using other means, such as in files).
56911 *
56912 * @param string $item The string being quoted. If the {@link item}
56913 *   contains a NUL character, or if it begins with a character whose
56914 *   ordinal value is 0x01, PHP will apply a binary encoding scheme so
56915 *   that you can safely store and retrieve binary data.
56916 * @return string
56917 * @since PHP 5, PECL sqlite >= 1.0.0
56918 **/
56919function sqlite_escape_string($item){}
56920
56921/**
56922 * Executes an SQL statement given by the {@link query} against a given
56923 * database handle (specified by the {@link dbhandle} parameter).
56924 *
56925 * @param resource $dbhandle The SQLite Database resource; returned
56926 *   from {@link sqlite_open} when used procedurally. This parameter is
56927 *   not required when using the object-oriented method.
56928 * @param string $query The query to be executed. Data inside the query
56929 *   should be properly escaped.
56930 * @param string $error_msg The specified variable will be filled if an
56931 *   error occurs. This is specially important because SQL syntax errors
56932 *   can't be fetched using the {@link sqlite_last_error} function.
56933 * @return bool
56934 * @since PHP 5, PECL sqlite >= 1.0.3
56935 **/
56936function sqlite_exec($dbhandle, $query, &$error_msg){}
56937
56938/**
56939 * {@link sqlite_factory} behaves similarly to {@link sqlite_open} in
56940 * that it opens an SQLite database or attempts to create it if it does
56941 * not exist. However, a SQLiteDatabase object is returned rather than a
56942 * resource. Please see the {@link sqlite_open} reference page for
56943 * further usage and caveats.
56944 *
56945 * @param string $filename The filename of the SQLite database.
56946 * @param int $mode The mode of the file. Intended to be used to open
56947 *   the database in read-only mode. Presently, this parameter is ignored
56948 *   by the sqlite library. The default value for mode is the octal value
56949 *   0666 and this is the recommended value.
56950 * @param string $error_message Passed by reference and is set to hold
56951 *   a descriptive error message explaining why the database could not be
56952 *   opened if there was an error.
56953 * @return SQLiteDatabase
56954 * @since PHP 5
56955 **/
56956function sqlite_factory($filename, $mode, &$error_message){}
56957
56958/**
56959 * {@link sqlite_fetch_all} returns an array of the entire result set
56960 * from the {@link result} resource. It is similar to calling {@link
56961 * sqlite_query} (or {@link sqlite_unbuffered_query}) and then {@link
56962 * sqlite_fetch_array} for each row in the result set.
56963 *
56964 * @param resource $result The SQLite result resource. This parameter
56965 *   is not required when using the object-oriented method.
56966 * @param int $result_type
56967 * @param bool $decode_binary
56968 * @return array
56969 * @since PHP 5, PECL sqlite >= 1.0.0
56970 **/
56971function sqlite_fetch_all($result, $result_type, $decode_binary){}
56972
56973/**
56974 * Fetches the next row from the given {@link result} handle. If there
56975 * are no more rows, returns , otherwise returns an associative array
56976 * representing the row data.
56977 *
56978 * @param resource $result The SQLite result resource. This parameter
56979 *   is not required when using the object-oriented method.
56980 * @param int $result_type
56981 * @param bool $decode_binary
56982 * @return array
56983 * @since PHP 5, PECL sqlite >= 1.0.0
56984 **/
56985function sqlite_fetch_array($result, $result_type, $decode_binary){}
56986
56987/**
56988 * {@link sqlite_fetch_column_types} returns an array of column data
56989 * types from the specified {@link table_name} table.
56990 *
56991 * @param string $table_name The table name to query.
56992 * @param resource $dbhandle The SQLite Database resource; returned
56993 *   from {@link sqlite_open} when used procedurally. This parameter is
56994 *   not required when using the object-oriented method.
56995 * @param int $result_type The optional {@link result_type} parameter
56996 *   accepts a constant and determines how the returned array will be
56997 *   indexed. Using SQLITE_ASSOC will return only associative indices
56998 *   (named fields) while SQLITE_NUM will return only numerical indices
56999 *   (ordinal field numbers). SQLITE_BOTH will return both associative
57000 *   and numerical indices. SQLITE_ASSOC is the default for this
57001 *   function.
57002 * @return array
57003 * @since PHP 5
57004 **/
57005function sqlite_fetch_column_types($table_name, $dbhandle, $result_type){}
57006
57007/**
57008 * @param resource $result
57009 * @param string $class_name
57010 * @param array $ctor_params
57011 * @param bool $decode_binary
57012 * @return object
57013 * @since PHP 5
57014 **/
57015function sqlite_fetch_object($result, $class_name, $ctor_params, $decode_binary){}
57016
57017/**
57018 * {@link sqlite_fetch_single} is identical to {@link sqlite_fetch_array}
57019 * except that it returns the value of the first column of the rowset.
57020 *
57021 * This is the most optimal way to retrieve data when you are only
57022 * interested in the values from a single column of data.
57023 *
57024 * @param resource $result The SQLite result resource. This parameter
57025 *   is not required when using the object-oriented method.
57026 * @param bool $decode_binary
57027 * @return string
57028 * @since PHP 5, PECL sqlite >= 1.0.1
57029 **/
57030function sqlite_fetch_single($result, $decode_binary){}
57031
57032/**
57033 * {@link sqlite_fetch_string} is identical to {@link sqlite_fetch_array}
57034 * except that it returns the value of the first column of the rowset.
57035 *
57036 * This is the most optimal way to retrieve data when you are only
57037 * interested in the values from a single column of data.
57038 *
57039 * @param resource $result The SQLite result resource. This parameter
57040 *   is not required when using the object-oriented method.
57041 * @param bool $decode_binary
57042 * @return string
57043 * @since PHP 5, PECL sqlite >= 1.0.0
57044 **/
57045function sqlite_fetch_string($result, $decode_binary){}
57046
57047/**
57048 * Given the ordinal column number, {@link field_index}, {@link
57049 * sqlite_field_name} returns the name of that field in the result set
57050 * {@link result}.
57051 *
57052 * @param resource $result The SQLite result resource. This parameter
57053 *   is not required when using the object-oriented method.
57054 * @param int $field_index The ordinal column number in the result set.
57055 * @return string
57056 * @since PHP 5, PECL sqlite >= 1.0.0
57057 **/
57058function sqlite_field_name($result, $field_index){}
57059
57060/**
57061 * Finds whether more rows are available from the given result set.
57062 *
57063 * @param resource $result The SQLite result resource.
57064 * @return bool
57065 * @since PHP 5, PECL sqlite >= 1.0.0
57066 **/
57067function sqlite_has_more($result){}
57068
57069/**
57070 * Find whether there are more previous rows from the given result
57071 * handle.
57072 *
57073 * @param resource $result The SQLite result resource. This parameter
57074 *   is not required when using the object-oriented method.
57075 * @return bool
57076 * @since PHP 5
57077 **/
57078function sqlite_has_prev($result){}
57079
57080/**
57081 * {@link sqlite_key} returns the current row index of the buffered
57082 * result set {@link result}.
57083 *
57084 * @param resource $result The SQLite result resource. This parameter
57085 *   is not required when using the object-oriented method.
57086 * @return int
57087 * @since PHP 5 >= 5.1.0
57088 **/
57089function sqlite_key($result){}
57090
57091/**
57092 * Returns the error code from the last operation performed on {@link
57093 * dbhandle} (the database handle), or 0 when no error occurred. A human
57094 * readable description of the error code can be retrieved using {@link
57095 * sqlite_error_string}.
57096 *
57097 * @param resource $dbhandle The SQLite Database resource; returned
57098 *   from {@link sqlite_open} when used procedurally. This parameter is
57099 *   not required when using the object-oriented method.
57100 * @return int
57101 * @since PHP 5, PECL sqlite >= 1.0.0
57102 **/
57103function sqlite_last_error($dbhandle){}
57104
57105/**
57106 * Returns the rowid of the row that was most recently inserted into the
57107 * database {@link dbhandle}, if it was created as an auto-increment
57108 * field.
57109 *
57110 * @param resource $dbhandle The SQLite Database resource; returned
57111 *   from {@link sqlite_open} when used procedurally. This parameter is
57112 *   not required when using the object-oriented method.
57113 * @return int
57114 * @since PHP 5, PECL sqlite >= 1.0.0
57115 **/
57116function sqlite_last_insert_rowid($dbhandle){}
57117
57118/**
57119 * The SQLite library may be compiled in either ISO-8859-1 or UTF-8
57120 * compatible modes. This function allows you to determine which encoding
57121 * scheme is used by your version of the library.
57122 *
57123 * When compiled with UTF-8 support, sqlite handles encoding and decoding
57124 * of UTF-8 multi-byte character sequences, but does not yet do a
57125 * complete job when working with the data (no normalization is performed
57126 * for example), and some comparison operations may still not be carried
57127 * out correctly.
57128 *
57129 * @return string
57130 * @since PHP 5, PECL sqlite >= 1.0.0
57131 **/
57132function sqlite_libencoding(){}
57133
57134/**
57135 * Returns the version of the linked SQLite library.
57136 *
57137 * @return string
57138 * @since PHP 5, PECL sqlite >= 1.0.0
57139 **/
57140function sqlite_libversion(){}
57141
57142/**
57143 * {@link sqlite_next} advances the result handle {@link result} to the
57144 * next row.
57145 *
57146 * @param resource $result The SQLite result resource. This parameter
57147 *   is not required when using the object-oriented method.
57148 * @return bool
57149 * @since PHP 5, PECL sqlite >= 1.0.0
57150 **/
57151function sqlite_next($result){}
57152
57153/**
57154 * Returns the number of fields in the {@link result} set.
57155 *
57156 * @param resource $result The SQLite result resource. This parameter
57157 *   is not required when using the object-oriented method.
57158 * @return int
57159 * @since PHP 5, PECL sqlite >= 1.0.0
57160 **/
57161function sqlite_num_fields($result){}
57162
57163/**
57164 * Returns the number of rows in the buffered {@link result} set.
57165 *
57166 * @param resource $result The SQLite result resource. This parameter
57167 *   is not required when using the object-oriented method.
57168 * @return int
57169 * @since PHP 5, PECL sqlite >= 1.0.0
57170 **/
57171function sqlite_num_rows($result){}
57172
57173/**
57174 * Opens an SQLite database or creates the database if it does not exist.
57175 *
57176 * @param string $filename The filename of the SQLite database. If the
57177 *   file does not exist, SQLite will attempt to create it. PHP must have
57178 *   write permissions to the file if data is inserted, the database
57179 *   schema is modified or to create the database if it does not exist.
57180 * @param int $mode The mode of the file. Intended to be used to open
57181 *   the database in read-only mode. Presently, this parameter is ignored
57182 *   by the sqlite library. The default value for mode is the octal value
57183 *   0666 and this is the recommended value.
57184 * @param string $error_message Passed by reference and is set to hold
57185 *   a descriptive error message explaining why the database could not be
57186 *   opened if there was an error.
57187 * @return resource
57188 * @since PHP 5, PECL sqlite >= 1.0.0
57189 **/
57190function sqlite_open($filename, $mode, &$error_message){}
57191
57192/**
57193 * {@link sqlite_popen} will first check to see if a persistent handle
57194 * has already been opened for the given {@link filename}. If it finds
57195 * one, it returns that handle to your script, otherwise it opens a fresh
57196 * handle to the database.
57197 *
57198 * The benefit of this approach is that you don't incur the performance
57199 * cost of re-reading the database and index schema on each page hit
57200 * served by persistent web server SAPI's (any SAPI except for regular
57201 * CGI or CLI).
57202 *
57203 * @param string $filename The filename of the SQLite database. If the
57204 *   file does not exist, SQLite will attempt to create it. PHP must have
57205 *   write permissions to the file if data is inserted, the database
57206 *   schema is modified or to create the database if it does not exist.
57207 * @param int $mode The mode of the file. Intended to be used to open
57208 *   the database in read-only mode. Presently, this parameter is ignored
57209 *   by the sqlite library. The default value for mode is the octal value
57210 *   0666 and this is the recommended value.
57211 * @param string $error_message Passed by reference and is set to hold
57212 *   a descriptive error message explaining why the database could not be
57213 *   opened if there was an error.
57214 * @return resource
57215 * @since PHP 5, PECL sqlite >= 1.0.0
57216 **/
57217function sqlite_popen($filename, $mode, &$error_message){}
57218
57219/**
57220 * {@link sqlite_prev} seeks back the {@link result} handle to the
57221 * previous row.
57222 *
57223 * @param resource $result The SQLite result resource. This parameter
57224 *   is not required when using the object-oriented method.
57225 * @return bool
57226 * @since PHP 5
57227 **/
57228function sqlite_prev($result){}
57229
57230/**
57231 * Executes an SQL statement given by the {@link query} against a given
57232 * database handle.
57233 *
57234 * @param resource $dbhandle The SQLite Database resource; returned
57235 *   from {@link sqlite_open} when used procedurally. This parameter is
57236 *   not required when using the object-oriented method.
57237 * @param string $query The query to be executed. Data inside the query
57238 *   should be properly escaped.
57239 * @param int $result_type
57240 * @param string $error_msg The specified variable will be filled if an
57241 *   error occurs. This is specially important because SQL syntax errors
57242 *   can't be fetched using the {@link sqlite_last_error} function.
57243 * @return resource
57244 * @since PHP 5, PECL sqlite >= 1.0.0
57245 **/
57246function sqlite_query($dbhandle, $query, $result_type, &$error_msg){}
57247
57248/**
57249 * {@link sqlite_rewind} seeks back to the first row in the given result
57250 * set.
57251 *
57252 * @param resource $result The SQLite result resource. This parameter
57253 *   is not required when using the object-oriented method.
57254 * @return bool
57255 * @since PHP 5, PECL sqlite >= 1.0.0
57256 **/
57257function sqlite_rewind($result){}
57258
57259/**
57260 * {@link sqlite_seek} seeks to the row given by the parameter {@link
57261 * rownum}.
57262 *
57263 * @param resource $result The SQLite result resource. This parameter
57264 *   is not required when using the object-oriented method.
57265 * @param int $rownum The ordinal row number to seek to. The row number
57266 *   is zero-based (0 is the first row).
57267 * @return bool
57268 * @since PHP 5, PECL sqlite >= 1.0.0
57269 **/
57270function sqlite_seek($result, $rownum){}
57271
57272/**
57273 * @param resource $db
57274 * @param string $query
57275 * @param bool $first_row_only
57276 * @param bool $decode_binary
57277 * @return array
57278 * @since PHP 5, PECL sqlite >= 1.0.1
57279 **/
57280function sqlite_single_query($db, $query, $first_row_only, $decode_binary){}
57281
57282/**
57283 * Decodes binary data passed as parameters to a UDF.
57284 *
57285 * You must call this function on parameters passed to your UDF if you
57286 * need them to handle binary data, as the binary encoding employed by
57287 * PHP will obscure the content and of the parameter in its natural,
57288 * non-coded form.
57289 *
57290 * PHP does not perform this encode/decode operation automatically as it
57291 * would severely impact performance if it did.
57292 *
57293 * @param string $data The encoded data that will be decoded, data that
57294 *   was applied by either {@link sqlite_udf_encode_binary} or {@link
57295 *   sqlite_escape_string}.
57296 * @return string
57297 * @since PHP 5, PECL sqlite >= 1.0.0
57298 **/
57299function sqlite_udf_decode_binary($data){}
57300
57301/**
57302 * {@link sqlite_udf_encode_binary} applies a binary encoding to the
57303 * {@link data} so that it can be safely returned from queries (since the
57304 * underlying libsqlite API is not binary safe).
57305 *
57306 * If there is a chance that your data might be binary unsafe (e.g.: it
57307 * contains a NUL byte in the middle rather than at the end, or if it has
57308 * and 0x01 byte as the first character) then you must call this function
57309 * to encode the return value from your UDF.
57310 *
57311 * PHP does not perform this encode/decode operation automatically as it
57312 * would severely impact performance if it did.
57313 *
57314 * @param string $data The string being encoded.
57315 * @return string
57316 * @since PHP 5, PECL sqlite >= 1.0.0
57317 **/
57318function sqlite_udf_encode_binary($data){}
57319
57320/**
57321 * {@link sqlite_unbuffered_query} is identical to {@link sqlite_query}
57322 * except that the result that is returned is a sequential forward-only
57323 * result set that can only be used to read each row, one after the
57324 * other.
57325 *
57326 * This function is ideal for generating things such as HTML tables where
57327 * you only need to process one row at a time and don't need to randomly
57328 * access the row data.
57329 *
57330 * @param resource $dbhandle The SQLite Database resource; returned
57331 *   from {@link sqlite_open} when used procedurally. This parameter is
57332 *   not required when using the object-oriented method.
57333 * @param string $query The query to be executed. Data inside the query
57334 *   should be properly escaped.
57335 * @param int $result_type
57336 * @param string $error_msg The specified variable will be filled if an
57337 *   error occurs. This is specially important because SQL syntax errors
57338 *   can't be fetched using the {@link sqlite_last_error} function.
57339 * @return resource
57340 * @since PHP 5, PECL sqlite >= 1.0.0
57341 **/
57342function sqlite_unbuffered_query($dbhandle, $query, $result_type, &$error_msg){}
57343
57344/**
57345 * Finds whether more rows are available from the given result handle.
57346 *
57347 * @param resource $result The SQLite result resource. This parameter
57348 *   is not required when using the object-oriented method.
57349 * @return bool
57350 * @since PHP 5
57351 **/
57352function sqlite_valid($result){}
57353
57354/**
57355 * Creates a regular expression for a case insensitive match.
57356 *
57357 * @param string $string The input string.
57358 * @return string
57359 * @since PHP 4, PHP 5
57360 **/
57361function sql_regcase($string){}
57362
57363/**
57364 * Returns the square root of {@link arg}.
57365 *
57366 * @param float $arg The argument to process
57367 * @return float
57368 * @since PHP 4, PHP 5
57369 **/
57370function sqrt($arg){}
57371
57372/**
57373 * Seeds the random number generator with {@link seed} or with a random
57374 * value if no {@link seed} is given.
57375 *
57376 * @param int $seed Optional seed value
57377 * @return void
57378 * @since PHP 4, PHP 5
57379 **/
57380function srand($seed){}
57381
57382/**
57383 * The function {@link sscanf} is the input analog of {@link printf}.
57384 * {@link sscanf} reads from the string {@link str} and interprets it
57385 * according to the specified {@link format}, which is described in the
57386 * documentation for {@link sprintf}.
57387 *
57388 * Any whitespace in the format string matches any whitespace in the
57389 * input string. This means that even a tab \t in the format string can
57390 * match a single space character in the input string.
57391 *
57392 * @param string $str The input string being parsed.
57393 * @param string $format The interpreted format for {@link str}, which
57394 *   is described in the documentation for {@link sprintf} with following
57395 *   differences: Function is not locale-aware. F, g, G and b are not
57396 *   supported. D stands for decimal number. i stands for integer with
57397 *   base detection. n stands for number of characters processed so far.
57398 * @return mixed
57399 * @since PHP 4 >= 4.0.1, PHP 5
57400 **/
57401function sscanf($str, $format){}
57402
57403/**
57404 * Authenticate using a public hostkey read from a file.
57405 *
57406 * @param resource $session An SSH connection link identifier, obtained
57407 *   from a call to {@link ssh2_connect}.
57408 * @param string $username
57409 * @param string $hostname
57410 * @param string $pubkeyfile
57411 * @param string $privkeyfile
57412 * @param string $passphrase If {@link privkeyfile} is encrypted (which
57413 *   it should be), the passphrase must be provided.
57414 * @param string $local_username If {@link local_username} is omitted,
57415 *   then the value for {@link username} will be used for it.
57416 * @return bool
57417 * @since PECL ssh2 >= 0.9.0
57418 **/
57419function ssh2_auth_hostbased_file($session, $username, $hostname, $pubkeyfile, $privkeyfile, $passphrase, $local_username){}
57420
57421/**
57422 * Attempt "none" authentication which usually will (and should) fail. As
57423 * part of the failure, this function will return an array of accepted
57424 * authentication methods.
57425 *
57426 * @param resource $session An SSH connection link identifier, obtained
57427 *   from a call to {@link ssh2_connect}.
57428 * @param string $username Remote user name.
57429 * @return mixed
57430 * @since PECL ssh2 >= 0.9.0
57431 **/
57432function ssh2_auth_none($session, $username){}
57433
57434/**
57435 * Authenticate over SSH using a plain password
57436 *
57437 * @param resource $session An SSH connection link identifier, obtained
57438 *   from a call to {@link ssh2_connect}.
57439 * @param string $username Remote user name.
57440 * @param string $password Password for {@link username}
57441 * @return bool
57442 * @since PECL ssh2 >= 0.9.0
57443 **/
57444function ssh2_auth_password($session, $username, $password){}
57445
57446/**
57447 * Authenticate using a public key read from a file.
57448 *
57449 * @param resource $session An SSH connection link identifier, obtained
57450 *   from a call to {@link ssh2_connect}.
57451 * @param string $username
57452 * @param string $pubkeyfile
57453 * @param string $privkeyfile
57454 * @param string $passphrase If {@link privkeyfile} is encrypted (which
57455 *   it should be), the {@link passphrase} must be provided.
57456 * @return bool
57457 * @since PECL ssh2 >= 0.9.0
57458 **/
57459function ssh2_auth_pubkey_file($session, $username, $pubkeyfile, $privkeyfile, $passphrase){}
57460
57461/**
57462 * Establish a connection to a remote SSH server.
57463 *
57464 * Once connected, the client should verify the server's hostkey using
57465 * {@link ssh2_fingerprint}, then authenticate using either password or
57466 * public key.
57467 *
57468 * @param string $host
57469 * @param int $port
57470 * @param array $methods {@link methods} may be an associative array
57471 *   with up to four parameters as described below.
57472 *
57473 *   {@link methods} may be an associative array with any or all of the
57474 *   following parameters. Index Meaning Supported Values* kex List of
57475 *   key exchange methods to advertise, comma separated in order of
57476 *   preference. diffie-hellman-group1-sha1, diffie-hellman-group14-sha1,
57477 *   and diffie-hellman-group-exchange-sha1 hostkey List of hostkey
57478 *   methods to advertise, come separated in order of preference. ssh-rsa
57479 *   and ssh-dss client_to_server Associative array containing crypt,
57480 *   compression, and message authentication code (MAC) method
57481 *   preferences for messages sent from client to server.
57482 *   server_to_client Associative array containing crypt, compression,
57483 *   and message authentication code (MAC) method preferences for
57484 *   messages sent from server to client. * - Supported Values are
57485 *   dependent on methods supported by underlying library. See libssh2
57486 *   documentation for additional information.
57487 *
57488 *   {@link client_to_server} and {@link server_to_client} may be an
57489 *   associative array with any or all of the following parameters. Index
57490 *   Meaning Supported Values* crypt List of crypto methods to advertise,
57491 *   comma separated in order of preference. rijndael-cbc@lysator.liu.se,
57492 *   aes256-cbc, aes192-cbc, aes128-cbc, 3des-cbc, blowfish-cbc,
57493 *   cast128-cbc, arcfour, and none** comp List of compression methods to
57494 *   advertise, comma separated in order of preference. zlib and none mac
57495 *   List of MAC methods to advertise, come separated in order of
57496 *   preference. hmac-sha1, hmac-sha1-96, hmac-ripemd160,
57497 *   hmac-ripemd160@openssh.com, and none**
57498 *
57499 *   Crypt and MAC method "none" For security reasons, none is disabled
57500 *   by the underlying libssh2 library unless explicitly enabled during
57501 *   build time by using the appropriate ./configure options. See
57502 *   documentation for the underlying library for more information.
57503 * @param array $callbacks {@link callbacks} may be an associative
57504 *   array with any or all of the following parameters. Callbacks
57505 *   parameters Index Meaning Prototype ignore Name of function to call
57506 *   when an SSH2_MSG_IGNORE packet is received void ignore_cb($message)
57507 *   debug Name of function to call when an SSH2_MSG_DEBUG packet is
57508 *   received void debug_cb($message, $language, $always_display)
57509 *   macerror Name of function to call when a packet is received but the
57510 *   message authentication code failed. If the callback returns , the
57511 *   mismatch will be ignored, otherwise the connection will be
57512 *   terminated. bool macerror_cb($packet) disconnect Name of function to
57513 *   call when an SSH2_MSG_DISCONNECT packet is received void
57514 *   disconnect_cb($reason, $message, $language)
57515 * @return resource
57516 * @since PECL ssh2 >= 0.9.0
57517 **/
57518function ssh2_connect($host, $port, $methods, $callbacks){}
57519
57520/**
57521 * Execute a command at the remote end and allocate a channel for it.
57522 *
57523 * @param resource $session An SSH connection link identifier, obtained
57524 *   from a call to {@link ssh2_connect}.
57525 * @param string $command
57526 * @param string $pty
57527 * @param array $env {@link env} may be passed as an associative array
57528 *   of name/value pairs to set in the target environment.
57529 * @param int $width Width of the virtual terminal.
57530 * @param int $height Height of the virtual terminal.
57531 * @param int $width_height_type {@link width_height_type} should be
57532 *   one of SSH2_TERM_UNIT_CHARS or SSH2_TERM_UNIT_PIXELS.
57533 * @return resource
57534 * @since PECL ssh2 >= 0.9.0
57535 **/
57536function ssh2_exec($session, $command, $pty, $env, $width, $height, $width_height_type){}
57537
57538/**
57539 * Fetches an alternate substream associated with an SSH2 channel stream.
57540 * The SSH2 protocol currently defines only one substream, STDERR, which
57541 * has a substream ID of SSH2_STREAM_STDERR (defined as 1).
57542 *
57543 * @param resource $channel
57544 * @param int $streamid An SSH2 channel stream.
57545 * @return resource
57546 * @since PECL ssh2 >= 0.9.0
57547 **/
57548function ssh2_fetch_stream($channel, $streamid){}
57549
57550/**
57551 * Returns a server hostkey hash from an active session.
57552 *
57553 * @param resource $session An SSH connection link identifier, obtained
57554 *   from a call to {@link ssh2_connect}.
57555 * @param int $flags {@link flags} may be either of
57556 *   SSH2_FINGERPRINT_MD5 or SSH2_FINGERPRINT_SHA1 logically ORed with
57557 *   SSH2_FINGERPRINT_HEX or SSH2_FINGERPRINT_RAW.
57558 * @return string
57559 * @since PECL ssh2 >= 0.9.0
57560 **/
57561function ssh2_fingerprint($session, $flags){}
57562
57563/**
57564 * Returns list of negotiated methods.
57565 *
57566 * @param resource $session An SSH connection link identifier, obtained
57567 *   from a call to {@link ssh2_connect}.
57568 * @return array
57569 * @since PECL ssh2 >= 0.9.0
57570 **/
57571function ssh2_methods_negotiated($session){}
57572
57573/**
57574 * @param resource $pkey Publickey Subsystem resource created by {@link
57575 *   ssh2_publickey_init}.
57576 * @param string $algoname Publickey algorithm (e.g.): ssh-dss, ssh-rsa
57577 * @param string $blob Publickey blob as raw binary data
57578 * @param bool $overwrite If the specified key already exists, should
57579 *   it be overwritten?
57580 * @param array $attributes Associative array of attributes to assign
57581 *   to this public key. Refer to ietf-secsh-publickey-subsystem for a
57582 *   list of supported attributes. To mark an attribute as mandatory,
57583 *   precede its name with an asterisk. If the server is unable to
57584 *   support an attribute marked mandatory, it will abort the add
57585 *   process.
57586 * @return bool
57587 * @since PECL ssh2 >= 0.10
57588 **/
57589function ssh2_publickey_add($pkey, $algoname, $blob, $overwrite, $attributes){}
57590
57591/**
57592 * Request the Publickey subsystem from an already connected SSH2 server.
57593 *
57594 * The publickey subsystem allows an already connected and authenticated
57595 * client to manage the list of authorized public keys stored on the
57596 * target server in an implementation agnostic manner. If the remote
57597 * server does not support the publickey subsystem, the {@link
57598 * ssh2_publickey_init} function will return .
57599 *
57600 * @param resource $session
57601 * @return resource
57602 * @since PECL ssh2 >= 0.10
57603 **/
57604function ssh2_publickey_init($session){}
57605
57606/**
57607 * List currently authorized publickeys.
57608 *
57609 * @param resource $pkey Publickey Subsystem resource
57610 * @return array
57611 * @since PECL ssh2 >= 0.10
57612 **/
57613function ssh2_publickey_list($pkey){}
57614
57615/**
57616 * Removes an authorized publickey.
57617 *
57618 * @param resource $pkey Publickey Subsystem Resource
57619 * @param string $algoname Publickey algorithm (e.g.): ssh-dss, ssh-rsa
57620 * @param string $blob Publickey blob as raw binary data
57621 * @return bool
57622 * @since PECL ssh2 >= 0.10
57623 **/
57624function ssh2_publickey_remove($pkey, $algoname, $blob){}
57625
57626/**
57627 * Copy a file from the remote server to the local filesystem using the
57628 * SCP protocol.
57629 *
57630 * @param resource $session An SSH connection link identifier, obtained
57631 *   from a call to {@link ssh2_connect}.
57632 * @param string $remote_file Path to the remote file.
57633 * @param string $local_file Path to the local file.
57634 * @return bool
57635 * @since PECL ssh2 >= 0.9.0
57636 **/
57637function ssh2_scp_recv($session, $remote_file, $local_file){}
57638
57639/**
57640 * Copy a file from the local filesystem to the remote server using the
57641 * SCP protocol.
57642 *
57643 * @param resource $session An SSH connection link identifier, obtained
57644 *   from a call to {@link ssh2_connect}.
57645 * @param string $local_file Path to the local file.
57646 * @param string $remote_file Path to the remote file.
57647 * @param int $create_mode The file will be created with the mode
57648 *   specified by {@link create_mode}.
57649 * @return bool
57650 * @since PECL ssh2 >= 0.9.0
57651 **/
57652function ssh2_scp_send($session, $local_file, $remote_file, $create_mode){}
57653
57654/**
57655 * Request the SFTP subsystem from an already connected SSH2 server.
57656 *
57657 * @param resource $session An SSH connection link identifier, obtained
57658 *   from a call to {@link ssh2_connect}.
57659 * @return resource
57660 * @since PECL ssh2 >= 0.9.0
57661 **/
57662function ssh2_sftp($session){}
57663
57664/**
57665 * Stats a symbolic link on the remote filesystem without following the
57666 * link.
57667 *
57668 * This function is similar to using the {@link lstat} function with the
57669 * ssh2.sftp:// wrapper in PHP5 and returns the same values.
57670 *
57671 * @param resource $sftp
57672 * @param string $path Path to the remote symbolic link.
57673 * @return array
57674 * @since PECL ssh2 >= 0.9.0
57675 **/
57676function ssh2_sftp_lstat($sftp, $path){}
57677
57678/**
57679 * Creates a directory on the remote file server with permissions set to
57680 * {@link mode}.
57681 *
57682 * This function is similar to using {@link mkdir} with the ssh2.sftp://
57683 * wrapper.
57684 *
57685 * @param resource $sftp An SSH2 SFTP resource opened by {@link
57686 *   ssh2_sftp}.
57687 * @param string $dirname Path of the new directory.
57688 * @param int $mode Permissions on the new directory.
57689 * @param bool $recursive If {@link recursive} is any parent
57690 *   directories required for {@link dirname} will be automatically
57691 *   created as well.
57692 * @return bool
57693 * @since PECL ssh2 >= 0.9.0
57694 **/
57695function ssh2_sftp_mkdir($sftp, $dirname, $mode, $recursive){}
57696
57697/**
57698 * Returns the target of a symbolic link.
57699 *
57700 * @param resource $sftp An SSH2 SFTP resource opened by {@link
57701 *   ssh2_sftp}.
57702 * @param string $link Path of the symbolic link.
57703 * @return string
57704 * @since PECL ssh2 >= 0.9.0
57705 **/
57706function ssh2_sftp_readlink($sftp, $link){}
57707
57708/**
57709 * Translates {@link filename} into the effective real path on the remote
57710 * filesystem.
57711 *
57712 * @param resource $sftp An SSH2 SFTP resource opened by {@link
57713 *   ssh2_sftp}.
57714 * @param string $filename
57715 * @return string
57716 * @since PECL ssh2 >= 0.9.0
57717 **/
57718function ssh2_sftp_realpath($sftp, $filename){}
57719
57720/**
57721 * Renames a file on the remote filesystem.
57722 *
57723 * @param resource $sftp An SSH2 SFTP resource opened by {@link
57724 *   ssh2_sftp}.
57725 * @param string $from The current file that is being renamed.
57726 * @param string $to The new file name that replaces {@link from}.
57727 * @return bool
57728 * @since PECL ssh2 >= 0.9.0
57729 **/
57730function ssh2_sftp_rename($sftp, $from, $to){}
57731
57732/**
57733 * Removes a directory from the remote file server.
57734 *
57735 * This function is similar to using {@link rmdir} with the ssh2.sftp://
57736 * wrapper.
57737 *
57738 * @param resource $sftp An SSH2 SFTP resource opened by {@link
57739 *   ssh2_sftp}.
57740 * @param string $dirname
57741 * @return bool
57742 * @since PECL ssh2 >= 0.9.0
57743 **/
57744function ssh2_sftp_rmdir($sftp, $dirname){}
57745
57746/**
57747 * Stats a file on the remote filesystem following any symbolic links.
57748 *
57749 * This function is similar to using the {@link stat} function with the
57750 * ssh2.sftp:// wrapper in PHP5 and returns the same values.
57751 *
57752 * @param resource $sftp An SSH2 SFTP resource opened by {@link
57753 *   ssh2_sftp}.
57754 * @param string $path
57755 * @return array
57756 * @since PECL ssh2 >= 0.9.0
57757 **/
57758function ssh2_sftp_stat($sftp, $path){}
57759
57760/**
57761 * Creates a symbolic link named {@link link} on the remote filesystem
57762 * pointing to {@link target}.
57763 *
57764 * @param resource $sftp An SSH2 SFTP resource opened by {@link
57765 *   ssh2_sftp}.
57766 * @param string $target Target of the symbolic link.
57767 * @param string $link
57768 * @return bool
57769 * @since PECL ssh2 >= 0.9.0
57770 **/
57771function ssh2_sftp_symlink($sftp, $target, $link){}
57772
57773/**
57774 * Deletes a file on the remote filesystem.
57775 *
57776 * @param resource $sftp An SSH2 SFTP resource opened by {@link
57777 *   ssh2_sftp}.
57778 * @param string $filename
57779 * @return bool
57780 * @since PECL ssh2 >= 0.9.0
57781 **/
57782function ssh2_sftp_unlink($sftp, $filename){}
57783
57784/**
57785 * Open a shell at the remote end and allocate a stream for it.
57786 *
57787 * @param resource $session An SSH connection link identifier, obtained
57788 *   from a call to {@link ssh2_connect}.
57789 * @param string $term_type {@link term_type} should correspond to one
57790 *   of the entries in the target system's /etc/termcap file.
57791 * @param array $env {@link env} may be passed as an associative array
57792 *   of name/value pairs to set in the target environment.
57793 * @param int $width Width of the virtual terminal.
57794 * @param int $height Height of the virtual terminal.
57795 * @param int $width_height_type {@link width_height_type} should be
57796 *   one of SSH2_TERM_UNIT_CHARS or SSH2_TERM_UNIT_PIXELS.
57797 * @return resource
57798 * @since PECL ssh2 >= 0.9.0
57799 **/
57800function ssh2_shell($session, $term_type, $env, $width, $height, $width_height_type){}
57801
57802/**
57803 * Open a socket stream to an arbitrary host/port by way of the currently
57804 * connected SSH server.
57805 *
57806 * @param resource $session An SSH connection link identifier, obtained
57807 *   from a call to {@link ssh2_connect}.
57808 * @param string $host
57809 * @param int $port
57810 * @return resource
57811 * @since PECL ssh2 >= 0.9.0
57812 **/
57813function ssh2_tunnel($session, $host, $port){}
57814
57815/**
57816 * Gathers the statistics of the file named by {@link filename}. If
57817 * {@link filename} is a symbolic link, statistics are from the file
57818 * itself, not the symlink.
57819 *
57820 * {@link lstat} is identical to {@link stat} except it would instead be
57821 * based off the symlinks status.
57822 *
57823 * @param string $filename Path to the file.
57824 * @return array
57825 * @since PHP 4, PHP 5
57826 **/
57827function stat($filename){}
57828
57829/**
57830 * @param array $a
57831 * @return float
57832 * @since PECL stats >= 1.0.0
57833 **/
57834function stats_absolute_deviation($a){}
57835
57836/**
57837 * Method
57838 *
57839 * Cumulative distribution function (P) is calculated directly by code
57840 * associated with the following reference.
57841 *
57842 * DiDinato, A. R. and Morris, A. H. Algorithm 708: Significant Digit
57843 * Computation of the Incomplete Beta Function Ratios. ACM Trans. Math.
57844 * Softw. 18 (1993), 360-373.
57845 *
57846 * Computation of other parameters involve a search for a value that
57847 * produces the desired value of P. The search relies on the monotonicity
57848 * of P with the other parameter.
57849 *
57850 * Note
57851 *
57852 * The beta density is proportional to t^(A-1) * (1-t)^(B-1)
57853 *
57854 * Arguments
57855 *
57856 * P -- The integral from 0 to X of the chi-square distribution. Input
57857 * range: [0, 1].
57858 *
57859 * Q -- 1-P. Input range: [0, 1]. P + Q = 1.0.
57860 *
57861 * X -- Upper limit of integration of beta density. Input range: [0,1].
57862 * Search range: [0,1]
57863 *
57864 * Y -- 1-X. Input range: [0,1]. Search range: [0,1] X + Y = 1.0.
57865 *
57866 * A -- The first parameter of the beta density. Input range: (0,
57867 * +infinity). Search range: [1D-100,1D100]
57868 *
57869 * B -- The second parameter of the beta density. Input range: (0,
57870 * +infinity). Search range: [1D-100,1D100]
57871 *
57872 * STATUS -- 0 if calculation completed correctly -I if input parameter
57873 * number I is out of range 1 if answer appears to be lower than lowest
57874 * search bound 2 if answer appears to be higher than greatest search
57875 * bound 3 if P + Q .ne. 1 4 if X + Y .ne. 1
57876 *
57877 * BOUND -- Undefined if STATUS is 0
57878 *
57879 * Bound exceeded by parameter number I if STATUS is negative.
57880 *
57881 * Lower search bound if STATUS is 1.
57882 *
57883 * Upper search bound if STATUS is 2.
57884 *
57885 * @param float $par1
57886 * @param float $par2
57887 * @param float $par3
57888 * @param int $which Integer indicating which of the next four argument
57889 *   values is to be calculated from the others. Legal range: 1..4 which
57890 *   = 1 : Calculate P and Q from X,Y,A and B which = 2 : Calculate X and
57891 *   Y from P,Q,A and B which = 3 : Calculate A from P,Q,X,Y and B which
57892 *   = 4 : Calculate B from P,Q,X,Y and A
57893 * @return float
57894 * @since PECL stats >= 1.0.0
57895 **/
57896function stats_cdf_beta($par1, $par2, $par3, $which){}
57897
57898/**
57899 * @param float $par1
57900 * @param float $par2
57901 * @param float $par3
57902 * @param int $which
57903 * @return float
57904 * @since PECL stats >= 1.0.0
57905 **/
57906function stats_cdf_binomial($par1, $par2, $par3, $which){}
57907
57908/**
57909 * @param float $par1
57910 * @param float $par2
57911 * @param float $par3
57912 * @param int $which
57913 * @return float
57914 * @since PECL stats >= 1.0.0
57915 **/
57916function stats_cdf_cauchy($par1, $par2, $par3, $which){}
57917
57918/**
57919 * @param float $par1
57920 * @param float $par2
57921 * @param int $which
57922 * @return float
57923 * @since PECL stats >= 1.0.0
57924 **/
57925function stats_cdf_chisquare($par1, $par2, $which){}
57926
57927/**
57928 * @param float $par1
57929 * @param float $par2
57930 * @param int $which
57931 * @return float
57932 * @since PECL stats >= 1.0.0
57933 **/
57934function stats_cdf_exponential($par1, $par2, $which){}
57935
57936/**
57937 * @param float $par1
57938 * @param float $par2
57939 * @param float $par3
57940 * @param int $which
57941 * @return float
57942 * @since PECL stats >= 1.0.0
57943 **/
57944function stats_cdf_f($par1, $par2, $par3, $which){}
57945
57946/**
57947 * @param float $par1
57948 * @param float $par2
57949 * @param float $par3
57950 * @param int $which
57951 * @return float
57952 * @since PECL stats >= 1.0.0
57953 **/
57954function stats_cdf_gamma($par1, $par2, $par3, $which){}
57955
57956/**
57957 * @param float $par1
57958 * @param float $par2
57959 * @param float $par3
57960 * @param int $which
57961 * @return float
57962 * @since PECL stats >= 1.0.0
57963 **/
57964function stats_cdf_laplace($par1, $par2, $par3, $which){}
57965
57966/**
57967 * @param float $par1
57968 * @param float $par2
57969 * @param float $par3
57970 * @param int $which
57971 * @return float
57972 * @since PECL stats >= 1.0.0
57973 **/
57974function stats_cdf_logistic($par1, $par2, $par3, $which){}
57975
57976/**
57977 * @param float $par1
57978 * @param float $par2
57979 * @param float $par3
57980 * @param int $which
57981 * @return float
57982 * @since PECL stats >= 1.0.0
57983 **/
57984function stats_cdf_negative_binomial($par1, $par2, $par3, $which){}
57985
57986/**
57987 * @param float $par1
57988 * @param float $par2
57989 * @param float $par3
57990 * @param int $which
57991 * @return float
57992 * @since PECL stats >= 1.0.0
57993 **/
57994function stats_cdf_noncentral_chisquare($par1, $par2, $par3, $which){}
57995
57996/**
57997 * @param float $par1
57998 * @param float $par2
57999 * @param float $par3
58000 * @param float $par4
58001 * @param int $which
58002 * @return float
58003 * @since PECL stats >= 1.0.0
58004 **/
58005function stats_cdf_noncentral_f($par1, $par2, $par3, $par4, $which){}
58006
58007/**
58008 * @param float $par1
58009 * @param float $par2
58010 * @param int $which
58011 * @return float
58012 * @since PECL stats >= 1.0.0
58013 **/
58014function stats_cdf_poisson($par1, $par2, $which){}
58015
58016/**
58017 * @param float $par1
58018 * @param float $par2
58019 * @param int $which
58020 * @return float
58021 * @since PECL stats >= 1.0.0
58022 **/
58023function stats_cdf_t($par1, $par2, $which){}
58024
58025/**
58026 * @param float $par1
58027 * @param float $par2
58028 * @param float $par3
58029 * @param int $which
58030 * @return float
58031 * @since PECL stats >= 1.0.0
58032 **/
58033function stats_cdf_uniform($par1, $par2, $par3, $which){}
58034
58035/**
58036 * @param float $par1
58037 * @param float $par2
58038 * @param float $par3
58039 * @param int $which
58040 * @return float
58041 * @since PECL stats >= 1.0.0
58042 **/
58043function stats_cdf_weibull($par1, $par2, $par3, $which){}
58044
58045/**
58046 * @param array $a
58047 * @param array $b
58048 * @return float
58049 * @since PECL stats >= 1.0.0
58050 **/
58051function stats_covariance($a, $b){}
58052
58053/**
58054 * @param float $x
58055 * @param float $a
58056 * @param float $b
58057 * @return float
58058 * @since PECL stats >= 1.0.0
58059 **/
58060function stats_dens_beta($x, $a, $b){}
58061
58062/**
58063 * @param float $x
58064 * @param float $ave
58065 * @param float $stdev
58066 * @return float
58067 * @since PECL stats >= 1.0.0
58068 **/
58069function stats_dens_cauchy($x, $ave, $stdev){}
58070
58071/**
58072 * @param float $x
58073 * @param float $dfr
58074 * @return float
58075 * @since PECL stats >= 1.0.0
58076 **/
58077function stats_dens_chisquare($x, $dfr){}
58078
58079/**
58080 * @param float $x
58081 * @param float $scale
58082 * @return float
58083 * @since PECL stats >= 1.0.0
58084 **/
58085function stats_dens_exponential($x, $scale){}
58086
58087/**
58088 * @param float $x
58089 * @param float $dfr1
58090 * @param float $dfr2
58091 * @return float
58092 * @since PECL stats >= 1.0.0
58093 **/
58094function stats_dens_f($x, $dfr1, $dfr2){}
58095
58096/**
58097 * @param float $x
58098 * @param float $shape
58099 * @param float $scale
58100 * @return float
58101 * @since PECL stats >= 1.0.0
58102 **/
58103function stats_dens_gamma($x, $shape, $scale){}
58104
58105/**
58106 * @param float $x
58107 * @param float $ave
58108 * @param float $stdev
58109 * @return float
58110 * @since PECL stats >= 1.0.0
58111 **/
58112function stats_dens_laplace($x, $ave, $stdev){}
58113
58114/**
58115 * @param float $x
58116 * @param float $ave
58117 * @param float $stdev
58118 * @return float
58119 * @since PECL stats >= 1.0.0
58120 **/
58121function stats_dens_logistic($x, $ave, $stdev){}
58122
58123/**
58124 * @param float $x
58125 * @param float $n
58126 * @param float $pi
58127 * @return float
58128 * @since PECL stats >= 1.0.0
58129 **/
58130function stats_dens_negative_binomial($x, $n, $pi){}
58131
58132/**
58133 * @param float $x
58134 * @param float $ave
58135 * @param float $stdev
58136 * @return float
58137 * @since PECL stats >= 1.0.0
58138 **/
58139function stats_dens_normal($x, $ave, $stdev){}
58140
58141/**
58142 * @param float $x
58143 * @param float $n
58144 * @param float $pi
58145 * @return float
58146 * @since PECL stats >= 1.0.0
58147 **/
58148function stats_dens_pmf_binomial($x, $n, $pi){}
58149
58150/**
58151 * @param float $n1
58152 * @param float $n2
58153 * @param float $N1
58154 * @param float $N2
58155 * @return float
58156 * @since PECL stats >= 1.0.0
58157 **/
58158function stats_dens_pmf_hypergeometric($n1, $n2, $N1, $N2){}
58159
58160/**
58161 * @param float $x
58162 * @param float $lb
58163 * @return float
58164 * @since PECL stats >= 1.0.0
58165 **/
58166function stats_dens_pmf_poisson($x, $lb){}
58167
58168/**
58169 * @param float $x
58170 * @param float $dfr
58171 * @return float
58172 * @since PECL stats >= 1.0.0
58173 **/
58174function stats_dens_t($x, $dfr){}
58175
58176/**
58177 * @param float $x
58178 * @param float $a
58179 * @param float $b
58180 * @return float
58181 * @since PECL stats >= 1.0.0
58182 **/
58183function stats_dens_weibull($x, $a, $b){}
58184
58185/**
58186 * @param float $x
58187 * @param float $a
58188 * @param float $b
58189 * @return float
58190 * @since PECL stats >= 1.0.0
58191 **/
58192function stats_den_uniform($x, $a, $b){}
58193
58194/**
58195 * @param array $a
58196 * @return number
58197 * @since PECL stats >= 1.0.0
58198 **/
58199function stats_harmonic_mean($a){}
58200
58201/**
58202 * @param array $a
58203 * @return float
58204 * @since PECL stats >= 1.0.0
58205 **/
58206function stats_kurtosis($a){}
58207
58208/**
58209 * Returns a random deviate from the beta distribution with parameters A
58210 * and B. The density of the beta is x^(a-1) * (1-x)^(b-1) / B(a,b) for 0
58211 * < x <. Method R. C. H. Cheng.
58212 *
58213 * @param float $a
58214 * @param float $b
58215 * @return float
58216 * @since PECL stats >= 1.0.0
58217 **/
58218function stats_rand_gen_beta($a, $b){}
58219
58220/**
58221 * @param float $df
58222 * @return float
58223 * @since PECL stats >= 1.0.0
58224 **/
58225function stats_rand_gen_chisquare($df){}
58226
58227/**
58228 * @param float $av
58229 * @return float
58230 * @since PECL stats >= 1.0.0
58231 **/
58232function stats_rand_gen_exponential($av){}
58233
58234/**
58235 * Generates a random deviate from the F (variance ratio) distribution
58236 * with "dfn" degrees of freedom in the numerator and "dfd" degrees of
58237 * freedom in the denominator. Method : directly generates ratio of
58238 * chisquare variates.
58239 *
58240 * @param float $dfn
58241 * @param float $dfd
58242 * @return float
58243 * @since PECL stats >= 1.0.0
58244 **/
58245function stats_rand_gen_f($dfn, $dfd){}
58246
58247/**
58248 * @param float $low
58249 * @param float $high
58250 * @return float
58251 * @since PECL stats >= 1.0.0
58252 **/
58253function stats_rand_gen_funiform($low, $high){}
58254
58255/**
58256 * Generates random deviates from the gamma distribution whose density is
58257 * (A**R)/Gamma(R) * X**(R-1) * Exp(-A*X).
58258 *
58259 * @param float $a location parameter of Gamma distribution ({@link a}
58260 *   > 0).
58261 * @param float $r shape parameter of Gamma distribution ({@link r} >
58262 *   0).
58263 * @return float
58264 * @since PECL stats >= 1.0.0
58265 **/
58266function stats_rand_gen_gamma($a, $r){}
58267
58268/**
58269 * @param int $n
58270 * @param float $pp
58271 * @return int
58272 * @since PECL stats >= 1.0.0
58273 **/
58274function stats_rand_gen_ibinomial($n, $pp){}
58275
58276/**
58277 * @param int $n
58278 * @param float $p
58279 * @return int
58280 * @since PECL stats >= 1.0.0
58281 **/
58282function stats_rand_gen_ibinomial_negative($n, $p){}
58283
58284/**
58285 * @return int
58286 * @since PECL stats >= 1.0.0
58287 **/
58288function stats_rand_gen_int(){}
58289
58290/**
58291 * @param float $mu
58292 * @return int
58293 * @since PECL stats >= 1.0.0
58294 **/
58295function stats_rand_gen_ipoisson($mu){}
58296
58297/**
58298 * @param int $low
58299 * @param int $high
58300 * @return int
58301 * @since PECL stats >= 1.0.0
58302 **/
58303function stats_rand_gen_iuniform($low, $high){}
58304
58305/**
58306 * @param float $df
58307 * @param float $xnonc
58308 * @return float
58309 * @since PECL stats >= 1.0.0
58310 **/
58311function stats_rand_gen_noncenral_chisquare($df, $xnonc){}
58312
58313/**
58314 * @param float $dfn
58315 * @param float $dfd
58316 * @param float $xnonc
58317 * @return float
58318 * @since PECL stats >= 1.0.0
58319 **/
58320function stats_rand_gen_noncentral_f($dfn, $dfd, $xnonc){}
58321
58322/**
58323 * @param float $df
58324 * @param float $xnonc
58325 * @return float
58326 * @since PECL stats >= 1.0.0
58327 **/
58328function stats_rand_gen_noncentral_t($df, $xnonc){}
58329
58330/**
58331 * @param float $av
58332 * @param float $sd
58333 * @return float
58334 * @since PECL stats >= 1.0.0
58335 **/
58336function stats_rand_gen_normal($av, $sd){}
58337
58338/**
58339 * @param float $df
58340 * @return float
58341 * @since PECL stats >= 1.0.0
58342 **/
58343function stats_rand_gen_t($df){}
58344
58345/**
58346 * @return array
58347 * @since PECL stats >= 1.0.0
58348 **/
58349function stats_rand_get_seeds(){}
58350
58351/**
58352 * @param string $phrase
58353 * @return array
58354 * @since PECL stats >= 1.0.0
58355 **/
58356function stats_rand_phrase_to_seeds($phrase){}
58357
58358/**
58359 * @return float
58360 * @since PECL stats >= 1.0.0
58361 **/
58362function stats_rand_ranf(){}
58363
58364/**
58365 * @param int $iseed1
58366 * @param int $iseed2
58367 * @return void
58368 * @since PECL stats >= 1.0.0
58369 **/
58370function stats_rand_setall($iseed1, $iseed2){}
58371
58372/**
58373 * @param array $a
58374 * @return float
58375 * @since PECL stats >= 1.0.0
58376 **/
58377function stats_skew($a){}
58378
58379/**
58380 * @param array $a
58381 * @param bool $sample
58382 * @return float
58383 * @since PECL stats >= 1.0.0
58384 **/
58385function stats_standard_deviation($a, $sample){}
58386
58387/**
58388 * @param int $x
58389 * @param int $n
58390 * @return float
58391 * @since PECL stats >= 1.0.0
58392 **/
58393function stats_stat_binomial_coef($x, $n){}
58394
58395/**
58396 * @param array $arr1
58397 * @param array $arr2
58398 * @return float
58399 * @since PECL stats >= 1.0.0
58400 **/
58401function stats_stat_correlation($arr1, $arr2){}
58402
58403/**
58404 * @param int $n
58405 * @return float
58406 * @since PECL stats >= 1.0.0
58407 **/
58408function stats_stat_gennch($n){}
58409
58410/**
58411 * @param array $arr1
58412 * @param array $arr2
58413 * @return float
58414 * @since PECL stats >= 1.0.0
58415 **/
58416function stats_stat_independent_t($arr1, $arr2){}
58417
58418/**
58419 * @param array $arr1
58420 * @param array $arr2
58421 * @return float
58422 * @since PECL stats >= 1.0.0
58423 **/
58424function stats_stat_innerproduct($arr1, $arr2){}
58425
58426/**
58427 * @param float $par1
58428 * @param float $par2
58429 * @param float $par3
58430 * @param int $which
58431 * @return float
58432 * @since PECL stats >= 1.0.0
58433 **/
58434function stats_stat_noncentral_t($par1, $par2, $par3, $which){}
58435
58436/**
58437 * @param array $arr1
58438 * @param array $arr2
58439 * @return float
58440 * @since PECL stats >= 1.0.0
58441 **/
58442function stats_stat_paired_t($arr1, $arr2){}
58443
58444/**
58445 * @param float $df
58446 * @param float $xnonc
58447 * @return float
58448 * @since PECL stats >= 1.0.0
58449 **/
58450function stats_stat_percentile($df, $xnonc){}
58451
58452/**
58453 * @param array $arr
58454 * @param float $power
58455 * @return float
58456 * @since PECL stats >= 1.0.0
58457 **/
58458function stats_stat_powersum($arr, $power){}
58459
58460/**
58461 * @param array $a
58462 * @param bool $sample
58463 * @return float
58464 * @since PECL stats >= 1.0.0
58465 **/
58466function stats_variance($a, $sample){}
58467
58468/**
58469 * Rolls back a transaction in progress.
58470 *
58471 * @param resource $link The transaction to abort.
58472 * @param string $transaction_id
58473 * @param array $headers
58474 * @return bool
58475 **/
58476function stomp_abort($link, $transaction_id, $headers){}
58477
58478/**
58479 * Acknowledges consumption of a message from a subscription using client
58480 * acknowledgment.
58481 *
58482 * @param resource $link The message/messageId to be acknowledged.
58483 * @param mixed $msg
58484 * @param array $headers
58485 * @return bool
58486 **/
58487function stomp_ack($link, $msg, $headers){}
58488
58489/**
58490 * Starts a transaction.
58491 *
58492 * @param resource $link The transaction id.
58493 * @param string $transaction_id
58494 * @param array $headers
58495 * @return bool
58496 **/
58497function stomp_begin($link, $transaction_id, $headers){}
58498
58499/**
58500 * Closes a previously opened connection.
58501 *
58502 * @param resource $link
58503 * @return bool
58504 **/
58505function stomp_close($link){}
58506
58507/**
58508 * Commits a transaction in progress.
58509 *
58510 * @param resource $link The transaction id.
58511 * @param string $transaction_id
58512 * @param array $headers
58513 * @return bool
58514 **/
58515function stomp_commit($link, $transaction_id, $headers){}
58516
58517/**
58518 * Opens a connection to a stomp compliant Message Broker.
58519 *
58520 * @param string $broker The broker URI
58521 * @param string $username The username.
58522 * @param string $password The password.
58523 * @return resource
58524 **/
58525function stomp_connect($broker, $username, $password){}
58526
58527/**
58528 * Returns a string description of the last connect error.
58529 *
58530 * @return string
58531 * @since PECL stomp >= 0.3.0
58532 **/
58533function stomp_connect_error(){}
58534
58535/**
58536 * Gets the last stomp error.
58537 *
58538 * @param resource $link
58539 * @return string
58540 **/
58541function stomp_error($link){}
58542
58543/**
58544 * Gets read timeout
58545 *
58546 * @param resource $link
58547 * @return array
58548 **/
58549function stomp_get_read_timeout($link){}
58550
58551/**
58552 * Gets the current stomp session ID.
58553 *
58554 * @param resource $link
58555 * @return string
58556 **/
58557function stomp_get_session_id($link){}
58558
58559/**
58560 * Indicates whether or not there is a frame ready to read.
58561 *
58562 * @param resource $link
58563 * @return bool
58564 **/
58565function stomp_has_frame($link){}
58566
58567/**
58568 * Reads the next frame. It is possible to instantiate an object of a
58569 * specific class, and pass parameters to that class's constructor.
58570 *
58571 * @param resource $link The name of the class to instantiate. If not
58572 *   specified, a stompFrame object is returned.
58573 * @return array
58574 **/
58575function stomp_read_frame($link){}
58576
58577/**
58578 * Sends a message to the Message Broker.
58579 *
58580 * @param resource $link Where to send the message
58581 * @param string $destination Message to send.
58582 * @param mixed $msg
58583 * @param array $headers
58584 * @return bool
58585 **/
58586function stomp_send($link, $destination, $msg, $headers){}
58587
58588/**
58589 * Sets read timeout.
58590 *
58591 * @param resource $link The seconds part of the timeout to be set.
58592 * @param integer $seconds The microseconds part of the timeout to be
58593 *   set.
58594 * @param integer $microseconds
58595 * @return void
58596 **/
58597function stomp_set_read_timeout($link, $seconds, $microseconds){}
58598
58599/**
58600 * Registers to listen to a given destination.
58601 *
58602 * @param resource $link Destination to subscribe to.
58603 * @param string $destination
58604 * @param array $headers
58605 * @return bool
58606 **/
58607function stomp_subscribe($link, $destination, $headers){}
58608
58609/**
58610 * Removes an existing subscription.
58611 *
58612 * @param resource $link Subscription to remove.
58613 * @param string $destination
58614 * @param array $headers
58615 * @return bool
58616 **/
58617function stomp_unsubscribe($link, $destination, $headers){}
58618
58619/**
58620 * Returns a string containing the version of the current stomp
58621 * extension.
58622 *
58623 * @return string
58624 * @since PECL stomp >= 0.1.0
58625 **/
58626function stomp_version(){}
58627
58628/**
58629 * Binary safe case-insensitive string comparison.
58630 *
58631 * @param string $str1 The first string
58632 * @param string $str2 The second string
58633 * @return int
58634 * @since PHP 4, PHP 5
58635 **/
58636function strcasecmp($str1, $str2){}
58637
58638/**
58639 * Returns part of {@link haystack} string from the first occurrence of
58640 * {@link needle} to the end of {@link haystack}.
58641 *
58642 * @param string $haystack The input string.
58643 * @param mixed $needle If {@link needle} is not a string, it is
58644 *   converted to an integer and applied as the ordinal value of a
58645 *   character.
58646 * @param bool $before_needle If , {@link strstr} returns the part of
58647 *   the {@link haystack} before the first occurrence of the {@link
58648 *   needle}.
58649 * @return string
58650 * @since PHP 4, PHP 5
58651 **/
58652function strchr($haystack, $needle, $before_needle){}
58653
58654/**
58655 * @param string $str1 The first string.
58656 * @param string $str2 The second string.
58657 * @return int
58658 * @since PHP 4, PHP 5
58659 **/
58660function strcmp($str1, $str2){}
58661
58662/**
58663 * Note that this comparison is case sensitive, and unlike {@link strcmp}
58664 * this function is not binary safe.
58665 *
58666 * {@link strcoll} uses the current locale for doing the comparisons. If
58667 * the current locale is C or POSIX, this function is equivalent to
58668 * {@link strcmp}.
58669 *
58670 * @param string $str1 The first string.
58671 * @param string $str2 The second string.
58672 * @return int
58673 * @since PHP 4 >= 4.0.5, PHP 5
58674 **/
58675function strcoll($str1, $str2){}
58676
58677/**
58678 * Returns the length of the initial segment of {@link str1} which does
58679 * not contain any of the characters in {@link str2}.
58680 *
58681 * @param string $str1 The first string.
58682 * @param string $str2 The second string.
58683 * @param int $start The start position of the string to examine.
58684 * @param int $length The length of the string to examine.
58685 * @return int
58686 * @since PHP 4, PHP 5
58687 **/
58688function strcspn($str1, $str2, $start, $length){}
58689
58690/**
58691 * @param resource $brigade
58692 * @param resource $bucket
58693 * @return void
58694 * @since PHP 5
58695 **/
58696function stream_bucket_append($brigade, $bucket){}
58697
58698/**
58699 * @param resource $brigade
58700 * @return object
58701 * @since PHP 5
58702 **/
58703function stream_bucket_make_writeable($brigade){}
58704
58705/**
58706 * @param resource $stream
58707 * @param string $buffer
58708 * @return object
58709 * @since PHP 5
58710 **/
58711function stream_bucket_new($stream, $buffer){}
58712
58713/**
58714 * @param resource $brigade
58715 * @param resource $bucket
58716 * @return void
58717 * @since PHP 5
58718 **/
58719function stream_bucket_prepend($brigade, $bucket){}
58720
58721/**
58722 * Creates and returns a stream context with any options supplied in
58723 * {@link options} preset.
58724 *
58725 * @param array $options Must be an associative array of associative
58726 *   arrays in the format $arr['wrapper']['option'] = $value. Default to
58727 *   an empty array.
58728 * @param array $params Must be an associative array in the format
58729 *   $arr['parameter'] = $value. Refer to context parameters for a
58730 *   listing of standard stream parameters.
58731 * @return resource
58732 * @since PHP 4 >= 4.3.0, PHP 5
58733 **/
58734function stream_context_create($options, $params){}
58735
58736/**
58737 * @param array $options
58738 * @return resource
58739 * @since PHP 5 >= 5.1.0
58740 **/
58741function stream_context_get_default($options){}
58742
58743/**
58744 * @param resource $stream_or_context The stream or context to get
58745 *   options from
58746 * @return array
58747 * @since PHP 4 >= 4.3.0, PHP 5
58748 **/
58749function stream_context_get_options($stream_or_context){}
58750
58751/**
58752 * Retrieves parameter and options information from the stream or
58753 * context.
58754 *
58755 * @param resource $stream_or_context A stream resource or a context
58756 *   resource
58757 * @return array
58758 * @since PHP 5 >= 5.3.0
58759 **/
58760function stream_context_get_params($stream_or_context){}
58761
58762/**
58763 * @param array $options The options to set for the default context.
58764 * @return resource
58765 * @since PHP 5 >= 5.3.0
58766 **/
58767function stream_context_set_default($options){}
58768
58769/**
58770 * @param resource $stream_or_context The stream or context resource to
58771 *   apply the options too.
58772 * @param string $wrapper The options to set for the default context.
58773 * @param string $option
58774 * @param mixed $value
58775 * @return bool
58776 * @since PHP 4 >= 4.3.0, PHP 5
58777 **/
58778function stream_context_set_option($stream_or_context, $wrapper, $option, $value){}
58779
58780/**
58781 * Sets parameters on the specified context.
58782 *
58783 * @param resource $stream_or_context The stream or context to apply
58784 *   the parameters too.
58785 * @param array $params An array of parameters to set.
58786 * @return bool
58787 * @since PHP 4 >= 4.3.0, PHP 5
58788 **/
58789function stream_context_set_params($stream_or_context, $params){}
58790
58791/**
58792 * Makes a copy of up to {@link maxlength} bytes of data from the current
58793 * position (or from the {@link offset} position, if specified) in {@link
58794 * source} to {@link dest}. If {@link maxlength} is not specified, all
58795 * remaining content in {@link source} will be copied.
58796 *
58797 * @param resource $source The source stream
58798 * @param resource $dest The destination stream
58799 * @param int $maxlength Maximum bytes to copy
58800 * @param int $offset The offset where to start to copy data
58801 * @return int
58802 * @since PHP 5
58803 **/
58804function stream_copy_to_stream($source, $dest, $maxlength, $offset){}
58805
58806/**
58807 * @param resource $stream
58808 * @param string $encoding
58809 * @return bool
58810 **/
58811function stream_encoding($stream, $encoding){}
58812
58813/**
58814 * Adds {@link filtername} to the list of filters attached to {@link
58815 * stream}.
58816 *
58817 * @param resource $stream The target stream.
58818 * @param string $filtername The filter name.
58819 * @param int $read_write By default, {@link stream_filter_append} will
58820 *   attach the filter to the read filter chain if the file was opened
58821 *   for reading (i.e. File Mode: r, and/or +). The filter will also be
58822 *   attached to the write filter chain if the file was opened for
58823 *   writing (i.e. File Mode: w, a, and/or +). STREAM_FILTER_READ,
58824 *   STREAM_FILTER_WRITE, and/or STREAM_FILTER_ALL can also be passed to
58825 *   the {@link read_write} parameter to override this behavior.
58826 * @param mixed $params This filter will be added with the specified
58827 *   {@link params} to the end of the list and will therefore be called
58828 *   last during stream operations. To add a filter to the beginning of
58829 *   the list, use {@link stream_filter_prepend}.
58830 * @return resource
58831 * @since PHP 4 >= 4.3.0, PHP 5
58832 **/
58833function stream_filter_append($stream, $filtername, $read_write, $params){}
58834
58835/**
58836 * Adds {@link filtername} to the list of filters attached to {@link
58837 * stream}.
58838 *
58839 * @param resource $stream The target stream.
58840 * @param string $filtername The filter name.
58841 * @param int $read_write By default, {@link stream_filter_prepend}
58842 *   will attach the filter to the read filter chain if the file was
58843 *   opened for reading (i.e. File Mode: r, and/or +). The filter will
58844 *   also be attached to the write filter chain if the file was opened
58845 *   for writing (i.e. File Mode: w, a, and/or +). STREAM_FILTER_READ,
58846 *   STREAM_FILTER_WRITE, and/or STREAM_FILTER_ALL can also be passed to
58847 *   the {@link read_write} parameter to override this behavior. See
58848 *   {@link stream_filter_append} for an example of using this parameter.
58849 * @param mixed $params This filter will be added with the specified
58850 *   {@link params} to the beginning of the list and will therefore be
58851 *   called first during stream operations. To add a filter to the end of
58852 *   the list, use {@link stream_filter_append}.
58853 * @return resource
58854 * @since PHP 4 >= 4.3.0, PHP 5
58855 **/
58856function stream_filter_prepend($stream, $filtername, $read_write, $params){}
58857
58858/**
58859 * {@link stream_filter_register} allows you to implement your own filter
58860 * on any registered stream used with all the other filesystem functions
58861 * (such as {@link fopen}, {@link fread} etc.).
58862 *
58863 * @param string $filtername The filter name to be registered.
58864 * @param string $classname To implement a filter, you need to define a
58865 *   class as an extension of php_user_filter with a number of member
58866 *   functions as defined below. When performing read/write operations on
58867 *   the stream to which your filter is attached, PHP will pass the data
58868 *   through your filter (and any other filters attached to that stream)
58869 *   so that the data may be modified as desired. You must implement the
58870 *   methods exactly as described below - doing otherwise will lead to
58871 *   undefined behaviour. This method is called whenever data is read
58872 *   from or written to the attached stream (such as with {@link fread}
58873 *   or {@link fwrite}). {@link in} is a resource pointing to a bucket
58874 *   brigade which contains one or more bucket objects containing data to
58875 *   be filtered. {@link out} is a resource pointing to a second bucket
58876 *   brigade into which your modified buckets should be placed. {@link
58877 *   consumed}, which must always be declared by reference, should be
58878 *   incremented by the length of the data which your filter reads in and
58879 *   alters. In most cases this means you will increment {@link consumed}
58880 *   by $bucket->datalen for each $bucket. If the stream is in the
58881 *   process of closing (and therefore this is the last pass through the
58882 *   filterchain), the {@link closing} parameter will be set to . The
58883 *   filter method must return one of three values upon completion.
58884 *   Return Value Meaning PSFS_PASS_ON Filter processed successfully with
58885 *   data available in the {@link out} bucket brigade. PSFS_FEED_ME
58886 *   Filter processed successfully, however no data was available to
58887 *   return. More data is required from the stream or prior filter.
58888 *   PSFS_ERR_FATAL (default) The filter experienced an unrecoverable
58889 *   error and cannot continue.
58890 *
58891 *   Property Contents FilterClass->filtername A string containing the
58892 *   name the filter was instantiated with. Filters may be registered
58893 *   under multiple names or under wildcards. Use this property to
58894 *   determine which name was used. FilterClass->params The contents of
58895 *   the {@link params} parameter passed to {@link stream_filter_append}
58896 *   or {@link stream_filter_prepend}. FilterClass->stream The stream
58897 *   resource being filtered. Maybe available only during filter calls
58898 *   when the closing parameter is set to . This method is called upon
58899 *   filter shutdown (typically, this is also during stream shutdown),
58900 *   and is executed after the flush method is called. If any resources
58901 *   were allocated or initialized during onCreate() this would be the
58902 *   time to destroy or dispose of them.
58903 * @return bool
58904 * @since PHP 5
58905 **/
58906function stream_filter_register($filtername, $classname){}
58907
58908/**
58909 * Removes a stream filter previously added to a stream with {@link
58910 * stream_filter_prepend} or {@link stream_filter_append}. Any data
58911 * remaining in the filter's internal buffer will be flushed through to
58912 * the next filter before removing it.
58913 *
58914 * @param resource $stream_filter The stream filter to be removed.
58915 * @return bool
58916 * @since PHP 5 >= 5.1.0
58917 **/
58918function stream_filter_remove($stream_filter){}
58919
58920/**
58921 * Identical to {@link file_get_contents}, except that {@link
58922 * stream_get_contents} operates on an already open stream resource and
58923 * returns the remaining contents in a string, up to {@link maxlength}
58924 * bytes and starting at the specified {@link offset}.
58925 *
58926 * @param resource $handle A stream resource (e.g. returned from {@link
58927 *   fopen})
58928 * @param int $maxlength The maximum bytes to read. Defaults to -1
58929 *   (read all the remaining buffer).
58930 * @param int $offset Seek to the specified offset before reading.
58931 * @return string
58932 * @since PHP 5
58933 **/
58934function stream_get_contents($handle, $maxlength, $offset){}
58935
58936/**
58937 * @return array
58938 * @since PHP 5
58939 **/
58940function stream_get_filters(){}
58941
58942/**
58943 * Gets a line from the given handle.
58944 *
58945 * Reading ends when {@link length} bytes have been read, when the string
58946 * specified by {@link ending} is found (which is not included in the
58947 * return value), or on EOF (whichever comes first).
58948 *
58949 * This function is nearly identical to {@link fgets} except in that it
58950 * allows end of line delimiters other than the standard \n, \r, and
58951 * \r\n, and does not return the delimiter itself.
58952 *
58953 * @param resource $handle A valid file handle.
58954 * @param int $length The number of bytes to read from the handle.
58955 * @param string $ending An optional string delimiter.
58956 * @return string
58957 * @since PHP 5
58958 **/
58959function stream_get_line($handle, $length, $ending){}
58960
58961/**
58962 * Returns information about an existing {@link stream}.
58963 *
58964 * @param resource $stream The stream can be any stream created by
58965 *   {@link fopen}, {@link fsockopen} and {@link pfsockopen}.
58966 * @return array
58967 * @since PHP 4 >= 4.3.0, PHP 5
58968 **/
58969function stream_get_meta_data($stream){}
58970
58971/**
58972 * @return array
58973 * @since PHP 5
58974 **/
58975function stream_get_transports(){}
58976
58977/**
58978 * Retrieve list of registered streams available on the running system.
58979 *
58980 * @return array
58981 * @since PHP 5
58982 **/
58983function stream_get_wrappers(){}
58984
58985/**
58986 * Checks if a stream, or a URL, is a local one or not.
58987 *
58988 * @param mixed $stream_or_url The stream resource or URL to check.
58989 * @return bool
58990 * @since PHP 5 >= 5.2.4
58991 **/
58992function stream_is_local($stream_or_url){}
58993
58994/**
58995 * A callback function, used by the notification context parameter,
58996 * called during an event.
58997 *
58998 * @param int $notification_code One of the STREAM_NOTIFY_*
58999 *   notification constants.
59000 * @param int $severity One of the STREAM_NOTIFY_SEVERITY_*
59001 *   notification constants.
59002 * @param string $message Passed if a descriptive message is available
59003 *   for the event.
59004 * @param int $message_code Passed if a descriptive message code is
59005 *   available for the event. The meaning of this value is dependent on
59006 *   the specific wrapper in use.
59007 * @param int $bytes_transferred If applicable, the {@link
59008 *   bytes_transferred} will be populated.
59009 * @param int $bytes_max If applicable, the {@link bytes_max} will be
59010 *   populated.
59011 * @return void
59012 * @since PHP 5 >= 5.2.0
59013 **/
59014function stream_notification_callback($notification_code, $severity, $message, $message_code, $bytes_transferred, $bytes_max){}
59015
59016/**
59017 * Allows you to implement your own protocol handlers and streams for use
59018 * with all the other filesystem functions (such as {@link fopen}, {@link
59019 * fread} etc.).
59020 *
59021 * @param string $protocol The wrapper name to be registered.
59022 * @param string $classname The classname which implements the {@link
59023 *   protocol}.
59024 * @param int $flags Should be set to STREAM_IS_URL if {@link protocol}
59025 *   is a URL protocol. Default is 0, local stream.
59026 * @return bool
59027 * @since PHP 4 >= 4.3.0, PHP 5
59028 **/
59029function stream_register_wrapper($protocol, $classname, $flags){}
59030
59031/**
59032 * Resolve filename against the include path according to the same rules
59033 * as {@link fopen}/{@link include} does.
59034 *
59035 * @param string $filename The filename to resolve.
59036 * @param resource $context A valid context resource created with
59037 *   {@link stream_context_create}.
59038 * @return string
59039 * @since PHP 5 >= 5.3.2
59040 **/
59041function stream_resolve_include_path($filename, $context){}
59042
59043/**
59044 * The {@link stream_select} function accepts arrays of streams and waits
59045 * for them to change status. Its operation is equivalent to that of the
59046 * {@link socket_select} function except in that it acts on streams.
59047 *
59048 * @param array $read The streams listed in the {@link read} array will
59049 *   be watched to see if characters become available for reading (more
59050 *   precisely, to see if a read will not block - in particular, a stream
59051 *   resource is also ready on end-of-file, in which case an {@link
59052 *   fread} will return a zero length string).
59053 * @param array $write The streams listed in the {@link write} array
59054 *   will be watched to see if a write will not block.
59055 * @param array $except The streams listed in the {@link except} array
59056 *   will be watched for high priority exceptional ("out-of-band") data
59057 *   arriving.
59058 * @param int $tv_sec The {@link tv_sec} and {@link tv_usec} together
59059 *   form the timeout parameter, {@link tv_sec} specifies the number of
59060 *   seconds while {@link tv_usec} the number of microseconds. The {@link
59061 *   timeout} is an upper bound on the amount of time that {@link
59062 *   stream_select} will wait before it returns. If {@link tv_sec} and
59063 *   {@link tv_usec} are both set to 0, {@link stream_select} will not
59064 *   wait for data - instead it will return immediately, indicating the
59065 *   current status of the streams. If {@link tv_sec} is {@link
59066 *   stream_select} can block indefinitely, returning only when an event
59067 *   on one of the watched streams occurs (or if a signal interrupts the
59068 *   system call).
59069 * @param int $tv_usec See {@link tv_sec} description.
59070 * @return int
59071 * @since PHP 4 >= 4.3.0, PHP 5
59072 **/
59073function stream_select(&$read, &$write, &$except, $tv_sec, $tv_usec){}
59074
59075/**
59076 * Sets blocking or non-blocking mode on a {@link stream}.
59077 *
59078 * This function works for any stream that supports non-blocking mode
59079 * (currently, regular files and socket streams).
59080 *
59081 * @param resource $stream The stream.
59082 * @param int $mode If {@link mode} is 0, the given stream will be
59083 *   switched to non-blocking mode, and if 1, it will be switched to
59084 *   blocking mode. This affects calls like {@link fgets} and {@link
59085 *   fread} that read from the stream. In non-blocking mode an {@link
59086 *   fgets} call will always return right away while in blocking mode it
59087 *   will wait for data to become available on the stream.
59088 * @return bool
59089 * @since PHP 4 >= 4.3.0, PHP 5
59090 **/
59091function stream_set_blocking($stream, $mode){}
59092
59093/**
59094 * Sets the read buffer. It's the equivalent of {@link
59095 * stream_set_write_buffer}, but for read operations.
59096 *
59097 * @param resource $stream The file pointer.
59098 * @param int $buffer The number of bytes to buffer. If {@link buffer}
59099 *   is 0 then read operations are unbuffered. This ensures that all
59100 *   reads with {@link fread} are completed before other processes are
59101 *   allowed to write to that output stream.
59102 * @return int
59103 * @since PHP 5 >= 5.3.3
59104 **/
59105function stream_set_read_buffer($stream, $buffer){}
59106
59107/**
59108 * Sets the timeout value on {@link stream}, expressed in the sum of
59109 * {@link seconds} and {@link microseconds}.
59110 *
59111 * When the stream times out, the 'timed_out' key of the array returned
59112 * by {@link stream_get_meta_data} is set to , although no error/warning
59113 * is generated.
59114 *
59115 * @param resource $stream The target stream.
59116 * @param int $seconds The seconds part of the timeout to be set.
59117 * @param int $microseconds The microseconds part of the timeout to be
59118 *   set.
59119 * @return bool
59120 * @since PHP 4 >= 4.3.0, PHP 5
59121 **/
59122function stream_set_timeout($stream, $seconds, $microseconds){}
59123
59124/**
59125 * Sets the buffering for write operations on the given {@link stream} to
59126 * {@link buffer} bytes.
59127 *
59128 * @param resource $stream The file pointer.
59129 * @param int $buffer The number of bytes to buffer. If {@link buffer}
59130 *   is 0 then write operations are unbuffered. This ensures that all
59131 *   writes with {@link fwrite} are completed before other processes are
59132 *   allowed to write to that output stream.
59133 * @return int
59134 * @since PHP 4 >= 4.3.0, PHP 5
59135 **/
59136function stream_set_write_buffer($stream, $buffer){}
59137
59138/**
59139 * Accept a connection on a socket previously created by {@link
59140 * stream_socket_server}.
59141 *
59142 * @param resource $server_socket The server socket to accept a
59143 *   connection from.
59144 * @param float $timeout Override the default socket accept timeout.
59145 *   Time should be given in seconds.
59146 * @param string $peername Will be set to the name (address) of the
59147 *   client which connected, if included and available from the selected
59148 *   transport.
59149 * @return resource
59150 * @since PHP 5
59151 **/
59152function stream_socket_accept($server_socket, $timeout, &$peername){}
59153
59154/**
59155 * Initiates a stream or datagram connection to the destination specified
59156 * by {@link remote_socket}. The type of socket created is determined by
59157 * the transport specified using standard URL formatting:
59158 * transport://target. For Internet Domain sockets (AF_INET) such as TCP
59159 * and UDP, the target portion of the {@link remote_socket} parameter
59160 * should consist of a hostname or IP address followed by a colon and a
59161 * port number. For Unix domain sockets, the {@link target} portion
59162 * should point to the socket file on the filesystem.
59163 *
59164 * @param string $remote_socket Address to the socket to connect to.
59165 * @param int $errno Will be set to the system level error number if
59166 *   connection fails.
59167 * @param string $errstr Will be set to the system level error message
59168 *   if the connection fails.
59169 * @param float $timeout Number of seconds until the connect() system
59170 *   call should timeout. This parameter only applies when not making
59171 *   asynchronous connection attempts. To set a timeout for
59172 *   reading/writing data over the socket, use the {@link
59173 *   stream_set_timeout}, as the {@link timeout} only applies while
59174 *   making connecting the socket.
59175 * @param int $flags Bitmask field which may be set to any combination
59176 *   of connection flags. Currently the select of connection flags is
59177 *   limited to STREAM_CLIENT_CONNECT (default),
59178 *   STREAM_CLIENT_ASYNC_CONNECT and STREAM_CLIENT_PERSISTENT.
59179 * @param resource $context A valid context resource created with
59180 *   {@link stream_context_create}.
59181 * @return resource
59182 * @since PHP 5
59183 **/
59184function stream_socket_client($remote_socket, &$errno, &$errstr, $timeout, $flags, $context){}
59185
59186/**
59187 * @param resource $stream The stream resource.
59188 * @param bool $enable Enable/disable cryptography on the stream.
59189 * @param int $crypto_type Setup encryption on the stream. Valid
59190 *   methods are STREAM_CRYPTO_METHOD_SSLv2_CLIENT
59191 *   STREAM_CRYPTO_METHOD_SSLv3_CLIENT STREAM_CRYPTO_METHOD_SSLv23_CLIENT
59192 *   STREAM_CRYPTO_METHOD_TLS_CLIENT STREAM_CRYPTO_METHOD_SSLv2_SERVER
59193 *   STREAM_CRYPTO_METHOD_SSLv3_SERVER STREAM_CRYPTO_METHOD_SSLv23_SERVER
59194 *   STREAM_CRYPTO_METHOD_TLS_SERVER
59195 * @param resource $session_stream Seed the stream with settings from
59196 *   {@link session_stream}.
59197 * @return mixed
59198 * @since PHP 5 >= 5.1.0
59199 **/
59200function stream_socket_enable_crypto($stream, $enable, $crypto_type, $session_stream){}
59201
59202/**
59203 * Returns the local or remote name of a given socket connection.
59204 *
59205 * @param resource $handle The socket to get the name of.
59206 * @param bool $want_peer If set to the remote socket name will be
59207 *   returned, if set to the local socket name will be returned.
59208 * @return string
59209 * @since PHP 5
59210 **/
59211function stream_socket_get_name($handle, $want_peer){}
59212
59213/**
59214 * {@link stream_socket_pair} creates a pair of connected,
59215 * indistinguishable socket streams. This function is commonly used in
59216 * IPC (Inter-Process Communication).
59217 *
59218 * @param int $domain The protocol family to be used: STREAM_PF_INET,
59219 *   STREAM_PF_INET6 or STREAM_PF_UNIX
59220 * @param int $type The type of communication to be used:
59221 *   STREAM_SOCK_DGRAM, STREAM_SOCK_RAW, STREAM_SOCK_RDM,
59222 *   STREAM_SOCK_SEQPACKET or STREAM_SOCK_STREAM
59223 * @param int $protocol The protocol to be used: STREAM_IPPROTO_ICMP,
59224 *   STREAM_IPPROTO_IP, STREAM_IPPROTO_RAW, STREAM_IPPROTO_TCP or
59225 *   STREAM_IPPROTO_UDP
59226 * @return array
59227 * @since PHP 5 >= 5.1.0
59228 **/
59229function stream_socket_pair($domain, $type, $protocol){}
59230
59231/**
59232 * {@link stream_socket_recvfrom} accepts data from a remote socket up to
59233 * {@link length} bytes.
59234 *
59235 * @param resource $socket The remote socket.
59236 * @param int $length The number of bytes to receive from the {@link
59237 *   socket}.
59238 * @param int $flags The value of {@link flags} can be any combination
59239 *   of the following: Possible values for {@link flags} STREAM_OOB
59240 *   Process OOB (out-of-band) data. STREAM_PEEK Retrieve data from the
59241 *   socket, but do not consume the buffer. Subsequent calls to {@link
59242 *   fread} or {@link stream_socket_recvfrom} will see the same data.
59243 * @param string $address If {@link address} is provided it will be
59244 *   populated with the address of the remote socket.
59245 * @return string
59246 * @since PHP 5
59247 **/
59248function stream_socket_recvfrom($socket, $length, $flags, &$address){}
59249
59250/**
59251 * Sends the specified {@link data} through the {@link socket}.
59252 *
59253 * @param resource $socket The socket to send {@link data} to.
59254 * @param string $data The data to be sent.
59255 * @param int $flags The value of {@link flags} can be any combination
59256 *   of the following: possible values for {@link flags} STREAM_OOB
59257 *   Process OOB (out-of-band) data.
59258 * @param string $address The address specified when the socket stream
59259 *   was created will be used unless an alternate address is specified in
59260 *   {@link address}. If specified, it must be in dotted quad (or [ipv6])
59261 *   format.
59262 * @return int
59263 * @since PHP 5
59264 **/
59265function stream_socket_sendto($socket, $data, $flags, $address){}
59266
59267/**
59268 * Creates a stream or datagram socket on the specified {@link
59269 * local_socket}.
59270 *
59271 * This function only creates a socket, to begin accepting connections
59272 * use {@link stream_socket_accept}.
59273 *
59274 * @param string $local_socket The type of socket created is determined
59275 *   by the transport specified using standard URL formatting:
59276 *   transport://target. For Internet Domain sockets (AF_INET) such as
59277 *   TCP and UDP, the target portion of the {@link remote_socket}
59278 *   parameter should consist of a hostname or IP address followed by a
59279 *   colon and a port number. For Unix domain sockets, the target portion
59280 *   should point to the socket file on the filesystem. Depending on the
59281 *   environment, Unix domain sockets may not be available. A list of
59282 *   available transports can be retrieved using {@link
59283 *   stream_get_transports}. See for a list of bulitin transports.
59284 * @param int $errno If the optional {@link errno} and {@link errstr}
59285 *   arguments are present they will be set to indicate the actual system
59286 *   level error that occurred in the system-level socket(), bind(), and
59287 *   listen() calls. If the value returned in {@link errno} is 0 and the
59288 *   function returned , it is an indication that the error occurred
59289 *   before the bind() call. This is most likely due to a problem
59290 *   initializing the socket. Note that the {@link errno} and {@link
59291 *   errstr} arguments will always be passed by reference.
59292 * @param string $errstr See {@link errno} description.
59293 * @param int $flags A bitmask field which may be set to any
59294 *   combination of socket creation flags.
59295 * @param resource $context
59296 * @return resource
59297 * @since PHP 5
59298 **/
59299function stream_socket_server($local_socket, &$errno, &$errstr, $flags, $context){}
59300
59301/**
59302 * Shutdowns (partially or not) a full-duplex connection.
59303 *
59304 * @param resource $stream An open stream (opened with {@link
59305 *   stream_socket_client}, for example)
59306 * @param int $how One of the following constants: STREAM_SHUT_RD
59307 *   (disable further receptions), STREAM_SHUT_WR (disable further
59308 *   transmissions) or STREAM_SHUT_RDWR (disable further receptions and
59309 *   transmissions).
59310 * @return bool
59311 * @since PHP 5 >= 5.2.1
59312 **/
59313function stream_socket_shutdown($stream, $how){}
59314
59315/**
59316 * Tells whether the stream supports locking through {@link flock}.
59317 *
59318 * @param resource $stream The stream to check.
59319 * @return bool
59320 * @since PHP 5 >= 5.3.0
59321 **/
59322function stream_supports_lock($stream){}
59323
59324/**
59325 * Allows you to implement your own protocol handlers and streams for use
59326 * with all the other filesystem functions (such as {@link fopen}, {@link
59327 * fread} etc.).
59328 *
59329 * @param string $protocol The wrapper name to be registered.
59330 * @param string $classname The classname which implements the {@link
59331 *   protocol}.
59332 * @param int $flags Should be set to STREAM_IS_URL if {@link protocol}
59333 *   is a URL protocol. Default is 0, local stream.
59334 * @return bool
59335 * @since PHP 4 >= 4.3.2, PHP 5
59336 **/
59337function stream_wrapper_register($protocol, $classname, $flags){}
59338
59339/**
59340 * Restores a built-in wrapper previously unregistered with {@link
59341 * stream_wrapper_unregister}.
59342 *
59343 * @param string $protocol
59344 * @return bool
59345 * @since PHP 5 >= 5.1.0
59346 **/
59347function stream_wrapper_restore($protocol){}
59348
59349/**
59350 * Allows you to disable an already defined stream wrapper. Once the
59351 * wrapper has been disabled you may override it with a user-defined
59352 * wrapper using {@link stream_wrapper_register} or reenable it later on
59353 * with {@link stream_wrapper_restore}.
59354 *
59355 * @param string $protocol
59356 * @return bool
59357 * @since PHP 5 >= 5.1.0
59358 **/
59359function stream_wrapper_unregister($protocol){}
59360
59361/**
59362 * Format the time and/or date according to locale settings. Month and
59363 * weekday names and other language-dependent strings respect the current
59364 * locale set with {@link setlocale}.
59365 *
59366 * Not all conversion specifiers may be supported by your C library, in
59367 * which case they will not be supported by PHP's {@link strftime}.
59368 * Additionally, not all platforms support negative timestamps, so your
59369 * date range may be limited to no earlier than the Unix epoch. This
59370 * means that %e, %T, %R and, %D (and possibly others) - as well as dates
59371 * prior to Jan 1, 1970 - will not work on Windows, some Linux
59372 * distributions, and a few other operating systems. For Windows systems,
59373 * a complete overview of supported conversion specifiers can be found at
59374 * MSDN.
59375 *
59376 * @param string $format The following characters are recognized in the
59377 *   {@link format} parameter string {@link format} Description Example
59378 *   returned values Day --- --- %a An abbreviated textual representation
59379 *   of the day Sun through Sat %A A full textual representation of the
59380 *   day Sunday through Saturday %d Two-digit day of the month (with
59381 *   leading zeros) 01 to 31 %e Day of the month, with a space preceding
59382 *   single digits 1 to 31 %j Day of the year, 3 digits with leading
59383 *   zeros 001 to 366 %u ISO-8601 numeric representation of the day of
59384 *   the week 1 (for Monday) though 7 (for Sunday) %w Numeric
59385 *   representation of the day of the week 0 (for Sunday) through 6 (for
59386 *   Saturday) Week --- --- %U Week number of the given year, starting
59387 *   with the first Sunday as the first week 13 (for the 13th full week
59388 *   of the year) %V ISO-8601:1988 week number of the given year,
59389 *   starting with the first week of the year with at least 4 weekdays,
59390 *   with Monday being the start of the week 01 through 53 (where 53
59391 *   accounts for an overlapping week) %W A numeric representation of the
59392 *   week of the year, starting with the first Monday as the first week
59393 *   46 (for the 46th week of the year beginning with a Monday) Month ---
59394 *   --- %b Abbreviated month name, based on the locale Jan through Dec
59395 *   %B Full month name, based on the locale January through December %h
59396 *   Abbreviated month name, based on the locale (an alias of %b) Jan
59397 *   through Dec %m Two digit representation of the month 01 (for
59398 *   January) through 12 (for December) Year --- --- %C Two digit
59399 *   representation of the century (year divided by 100, truncated to an
59400 *   integer) 19 for the 20th Century %g Two digit representation of the
59401 *   year going by ISO-8601:1988 standards (see %V) Example: 09 for the
59402 *   week of January 6, 2009 %G The full four-digit version of %g
59403 *   Example: 2008 for the week of January 3, 2009 %y Two digit
59404 *   representation of the year Example: 09 for 2009, 79 for 1979 %Y Four
59405 *   digit representation for the year Example: 2038 Time --- --- %H Two
59406 *   digit representation of the hour in 24-hour format 00 through 23 %I
59407 *   Two digit representation of the hour in 12-hour format 01 through 12
59408 *   %l (lower-case 'L') Hour in 12-hour format, with a space preceeding
59409 *   single digits 1 through 12 %M Two digit representation of the minute
59410 *   00 through 59 %p UPPER-CASE 'AM' or 'PM' based on the given time
59411 *   Example: AM for 00:31, PM for 22:23 %P lower-case 'am' or 'pm' based
59412 *   on the given time Example: am for 00:31, pm for 22:23 %r Same as
59413 *   "%I:%M:%S %p" Example: 09:34:17 PM for 21:34:17 %R Same as "%H:%M"
59414 *   Example: 00:35 for 12:35 AM, 16:44 for 4:44 PM %S Two digit
59415 *   representation of the second 00 through 59 %T Same as "%H:%M:%S"
59416 *   Example: 21:34:17 for 09:34:17 PM %X Preferred time representation
59417 *   based on locale, without the date Example: 03:59:16 or 15:59:16 %z
59418 *   Either the time zone offset from UTC or the abbreviation (depends on
59419 *   operating system) Example: -0500 or EST for Eastern Time %Z The time
59420 *   zone offset/abbreviation option NOT given by %z (depends on
59421 *   operating system) Example: -0500 or EST for Eastern Time Time and
59422 *   Date Stamps --- --- %c Preferred date and time stamp based on local
59423 *   Example: Tue Feb 5 00:45:10 2009 for February 4, 2009 at 12:45:10 AM
59424 *   %D Same as "%m/%d/%y" Example: 02/05/09 for February 5, 2009 %F Same
59425 *   as "%Y-%m-%d" (commonly used in database datestamps) Example:
59426 *   2009-02-05 for February 5, 2009 %s Unix Epoch Time timestamp (same
59427 *   as the {@link time} function) Example: 305815200 for September 10,
59428 *   1979 08:40:00 AM %x Preferred date representation based on locale,
59429 *   without the time Example: 02/05/09 for February 5, 2009
59430 *   Miscellaneous --- --- %n A newline character ("\n") --- %t A Tab
59431 *   character ("\t") --- %% A literal percentage character ("%") ---
59432 *   Maximum length of this parameter is 1023 characters.
59433 * @param int $timestamp
59434 * @return string
59435 * @since PHP 4, PHP 5
59436 **/
59437function strftime($format, $timestamp){}
59438
59439/**
59440 * Returns a string with backslashes stripped off. Recognizes C-like \n,
59441 * \r ..., octal and hexadecimal representation.
59442 *
59443 * @param string $str The string to be unescaped.
59444 * @return string
59445 * @since PHP 4, PHP 5
59446 **/
59447function stripcslashes($str){}
59448
59449/**
59450 * Returns the numeric position of the first occurrence of {@link needle}
59451 * in the {@link haystack} string.
59452 *
59453 * Unlike {@link strpos}, {@link stripos} is case-insensitive.
59454 *
59455 * @param string $haystack The string to search in
59456 * @param string $needle Note that the {@link needle} may be a string
59457 *   of one or more characters. If {@link needle} is not a string, it is
59458 *   converted to an integer and applied as the ordinal value of a
59459 *   character.
59460 * @param int $offset The optional {@link offset} parameter allows you
59461 *   to specify which character in {@link haystack} to start searching.
59462 *   The position returned is still relative to the beginning of {@link
59463 *   haystack}.
59464 * @return int
59465 * @since PHP 5
59466 **/
59467function stripos($haystack, $needle, $offset){}
59468
59469/**
59470 * Un-quotes a quoted string.
59471 *
59472 * An example use of {@link stripslashes} is when the PHP directive
59473 * magic_quotes_gpc is on (it's on by default), and you aren't inserting
59474 * this data into a place (such as a database) that requires escaping.
59475 * For example, if you're simply outputting data straight from an HTML
59476 * form.
59477 *
59478 * @param string $str The input string.
59479 * @return string
59480 * @since PHP 4, PHP 5
59481 **/
59482function stripslashes($str){}
59483
59484/**
59485 * This function tries to return a string with all NUL bytes, HTML and
59486 * PHP tags stripped from a given {@link str}. It uses the same tag
59487 * stripping state machine as the {@link fgetss} function.
59488 *
59489 * @param string $str The input string.
59490 * @param string $allowable_tags You can use the optional second
59491 *   parameter to specify tags which should not be stripped.
59492 * @return string
59493 * @since PHP 4, PHP 5
59494 **/
59495function strip_tags($str, $allowable_tags){}
59496
59497/**
59498 * Returns all of {@link haystack} from the first occurrence of {@link
59499 * needle} to the end.
59500 *
59501 * @param string $haystack The string to search in
59502 * @param mixed $needle If {@link needle} is not a string, it is
59503 *   converted to an integer and applied as the ordinal value of a
59504 *   character.
59505 * @param bool $before_needle If , {@link stristr} returns the part of
59506 *   the {@link haystack} before the first occurrence of the {@link
59507 *   needle}.
59508 * @return string
59509 * @since PHP 4, PHP 5
59510 **/
59511function stristr($haystack, $needle, $before_needle){}
59512
59513/**
59514 * Returns the length of the given {@link string}.
59515 *
59516 * @param string $string The string being measured for length.
59517 * @return int
59518 * @since PHP 4, PHP 5
59519 **/
59520function strlen($string){}
59521
59522/**
59523 * This function implements a comparison algorithm that orders
59524 * alphanumeric strings in the way a human being would. The behaviour of
59525 * this function is similar to {@link strnatcmp}, except that the
59526 * comparison is not case sensitive. For more information see: Martin
59527 * Pool's Natural Order String Comparison page.
59528 *
59529 * @param string $str1 The first string.
59530 * @param string $str2 The second string.
59531 * @return int
59532 * @since PHP 4, PHP 5
59533 **/
59534function strnatcasecmp($str1, $str2){}
59535
59536/**
59537 * This function implements a comparison algorithm that orders
59538 * alphanumeric strings in the way a human being would, this is described
59539 * as a "natural ordering". Note that this comparison is case sensitive.
59540 *
59541 * @param string $str1 The first string.
59542 * @param string $str2 The second string.
59543 * @return int
59544 * @since PHP 4, PHP 5
59545 **/
59546function strnatcmp($str1, $str2){}
59547
59548/**
59549 * This function is similar to {@link strcasecmp}, with the difference
59550 * that you can specify the (upper limit of the) number of characters
59551 * from each string to be used in the comparison.
59552 *
59553 * @param string $str1 The first string.
59554 * @param string $str2 The second string.
59555 * @param int $len The length of strings to be used in the comparison.
59556 * @return int
59557 * @since PHP 4 >= 4.0.2, PHP 5
59558 **/
59559function strncasecmp($str1, $str2, $len){}
59560
59561/**
59562 * This function is similar to {@link strcmp}, with the difference that
59563 * you can specify the (upper limit of the) number of characters from
59564 * each string to be used in the comparison.
59565 *
59566 * Note that this comparison is case sensitive.
59567 *
59568 * @param string $str1 The first string.
59569 * @param string $str2 The second string.
59570 * @param int $len Number of characters to use in the comparison.
59571 * @return int
59572 * @since PHP 4, PHP 5
59573 **/
59574function strncmp($str1, $str2, $len){}
59575
59576/**
59577 * {@link strpbrk} searches the {@link haystack} string for a {@link
59578 * char_list}.
59579 *
59580 * @param string $haystack The string where {@link char_list} is looked
59581 *   for.
59582 * @param string $char_list This parameter is case sensitive.
59583 * @return string
59584 * @since PHP 5
59585 **/
59586function strpbrk($haystack, $char_list){}
59587
59588/**
59589 * Returns the numeric position of the first occurrence of {@link needle}
59590 * in the {@link haystack} string. Unlike the {@link strrpos} before PHP
59591 * 5, this function can take a full string as the {@link needle}
59592 * parameter and the entire string will be used.
59593 *
59594 * @param string $haystack The string to search in
59595 * @param mixed $needle If {@link needle} is not a string, it is
59596 *   converted to an integer and applied as the ordinal value of a
59597 *   character.
59598 * @param int $offset The optional {@link offset} parameter allows you
59599 *   to specify which character in {@link haystack} to start searching.
59600 *   The position returned is still relative to the beginning of {@link
59601 *   haystack}.
59602 * @return int
59603 * @since PHP 4, PHP 5
59604 **/
59605function strpos($haystack, $needle, $offset){}
59606
59607/**
59608 * {@link strptime} returns an array with the {@link date} parsed, or on
59609 * error.
59610 *
59611 * Month and weekday names and other language dependent strings respect
59612 * the current locale set with {@link setlocale} (LC_TIME).
59613 *
59614 * @param string $date The string to parse (e.g. returned from {@link
59615 *   strftime})
59616 * @param string $format The format used in {@link date} (e.g. the same
59617 *   as used in {@link strftime}). For more information about the format
59618 *   options, read the {@link strftime} page.
59619 * @return array
59620 * @since PHP 5 >= 5.1.0
59621 **/
59622function strptime($date, $format){}
59623
59624/**
59625 * This function returns the portion of {@link haystack} which starts at
59626 * the last occurrence of {@link needle} and goes until the end of {@link
59627 * haystack}.
59628 *
59629 * @param string $haystack The string to search in
59630 * @param mixed $needle If {@link needle} contains more than one
59631 *   character, only the first is used. This behavior is different from
59632 *   that of {@link strstr}. If {@link needle} is not a string, it is
59633 *   converted to an integer and applied as the ordinal value of a
59634 *   character.
59635 * @return string
59636 * @since PHP 4, PHP 5
59637 **/
59638function strrchr($haystack, $needle){}
59639
59640/**
59641 * Returns {@link string}, reversed.
59642 *
59643 * @param string $string The string to be reversed.
59644 * @return string
59645 * @since PHP 4, PHP 5
59646 **/
59647function strrev($string){}
59648
59649/**
59650 * Find position of last occurrence of a case-insensitive string in a
59651 * string. Unlike {@link strrpos}, {@link strripos} is case-insensitive.
59652 *
59653 * @param string $haystack The string to search in
59654 * @param string $needle Note that the {@link needle} may be a string
59655 *   of one or more characters.
59656 * @param int $offset The {@link offset} parameter may be specified to
59657 *   begin searching an arbitrary number of characters into the string.
59658 *   Negative offset values will start the search at {@link offset}
59659 *   characters from the start of the string.
59660 * @return int
59661 * @since PHP 5
59662 **/
59663function strripos($haystack, $needle, $offset){}
59664
59665/**
59666 * Returns the numeric position of the last occurrence of {@link needle}
59667 * in the {@link haystack} string. Note that the needle in this case can
59668 * only be a single character in PHP 4. If a string is passed as the
59669 * needle, then only the first character of that string will be used.
59670 *
59671 * @param string $haystack The string to search in.
59672 * @param string $needle If {@link needle} is not a string, it is
59673 *   converted to an integer and applied as the ordinal value of a
59674 *   character.
59675 * @param int $offset May be specified to begin searching an arbitrary
59676 *   number of characters into the string. Negative values will stop
59677 *   searching at an arbitrary point prior to the end of the string.
59678 * @return int
59679 * @since PHP 4, PHP 5
59680 **/
59681function strrpos($haystack, $needle, $offset){}
59682
59683/**
59684 * Returns the length of the first group of consecutive characters from
59685 * {@link mask} found in {@link subject}.
59686 *
59687 * If {@link start} and {@link length} are omitted, then all of {@link
59688 * subject} will be examined. If they are included, then the effect will
59689 * be the same as calling strspn(substr($subject, $start, $length),
59690 * $mask) (see for more information).
59691 *
59692 * The line of code:
59693 *
59694 * <?php $var = strspn("42 is the answer to the 128th question.",
59695 * "1234567890"); ?>
59696 *
59697 * will assign 2 to $var, because the string "42" is the first segment
59698 * from {@link subject} to consist only of characters contained within
59699 * "1234567890".
59700 *
59701 * @param string $subject The string to examine.
59702 * @param string $mask The list of allowable characters to include in
59703 *   counted segments.
59704 * @param int $start The position in {@link subject} to start
59705 *   searching. If {@link start} is given and is non-negative, then
59706 *   {@link strspn} will begin examining {@link subject} at the {@link
59707 *   start}'th position. For instance, in the string 'abcdef', the
59708 *   character at position 0 is 'a', the character at position 2 is 'c',
59709 *   and so forth. If {@link start} is given and is negative, then {@link
59710 *   strspn} will begin examining {@link subject} at the {@link start}'th
59711 *   position from the end of {@link subject}.
59712 * @param int $length The length of the segment from {@link subject} to
59713 *   examine. If {@link length} is given and is non-negative, then {@link
59714 *   subject} will be examined for {@link length} characters after the
59715 *   starting position. If {@link length}is given and is negative, then
59716 *   {@link subject} will be examined from the starting position up to
59717 *   {@link length} characters from the end of {@link subject}.
59718 * @return int
59719 * @since PHP 4, PHP 5
59720 **/
59721function strspn($subject, $mask, $start, $length){}
59722
59723/**
59724 * Returns part of {@link haystack} string from the first occurrence of
59725 * {@link needle} to the end of {@link haystack}.
59726 *
59727 * @param string $haystack The input string.
59728 * @param mixed $needle If {@link needle} is not a string, it is
59729 *   converted to an integer and applied as the ordinal value of a
59730 *   character.
59731 * @param bool $before_needle If , {@link strstr} returns the part of
59732 *   the {@link haystack} before the first occurrence of the {@link
59733 *   needle}.
59734 * @return string
59735 * @since PHP 4, PHP 5
59736 **/
59737function strstr($haystack, $needle, $before_needle){}
59738
59739/**
59740 * {@link strtok} splits a string ({@link str}) into smaller strings
59741 * (tokens), with each token being delimited by any character from {@link
59742 * token}. That is, if you have a string like "This is an example string"
59743 * you could tokenize this string into its individual words by using the
59744 * space character as the token.
59745 *
59746 * Note that only the first call to strtok uses the string argument.
59747 * Every subsequent call to strtok only needs the token to use, as it
59748 * keeps track of where it is in the current string. To start over, or to
59749 * tokenize a new string you simply call strtok with the string argument
59750 * again to initialize it. Note that you may put multiple tokens in the
59751 * token parameter. The string will be tokenized when any one of the
59752 * characters in the argument are found.
59753 *
59754 * @param string $str The string being split up into smaller strings
59755 *   (tokens).
59756 * @param string $token The delimiter used when splitting up {@link
59757 *   str}.
59758 * @return string
59759 * @since PHP 4, PHP 5
59760 **/
59761function strtok($str, $token){}
59762
59763/**
59764 * Returns {@link string} with all alphabetic characters converted to
59765 * lowercase.
59766 *
59767 * Note that 'alphabetic' is determined by the current locale. This means
59768 * that in i.e. the default "C" locale, characters such as umlaut-A ()
59769 * will not be converted.
59770 *
59771 * @param string $str The input string.
59772 * @return string
59773 * @since PHP 4, PHP 5
59774 **/
59775function strtolower($str){}
59776
59777/**
59778 * This function will use the TZ environment variable (if available) to
59779 * calculate the timestamp. Since PHP 5.1.0 there are easier ways to
59780 * define the timezone that is used across all date/time functions. That
59781 * process is explained in the {@link date_default_timezone_get} function
59782 * page.
59783 *
59784 * @param string $time
59785 * @param int $now The timestamp which is used as a base for the
59786 *   calculation of relative dates.
59787 * @return int
59788 * @since PHP 4, PHP 5
59789 **/
59790function strtotime($time, $now){}
59791
59792/**
59793 * Returns {@link string} with all alphabetic characters converted to
59794 * uppercase.
59795 *
59796 * Note that 'alphabetic' is determined by the current locale. For
59797 * instance, in the default "C" locale characters such as umlaut-a (ä)
59798 * will not be converted.
59799 *
59800 * @param string $string The input string.
59801 * @return string
59802 * @since PHP 4, PHP 5
59803 **/
59804function strtoupper($string){}
59805
59806/**
59807 * This function returns a copy of {@link str}, translating all
59808 * occurrences of each character in {@link from} to the corresponding
59809 * character in {@link to}.
59810 *
59811 * If {@link from} and {@link to} are different lengths, the extra
59812 * characters in the longer of the two are ignored.
59813 *
59814 * @param string $str The string being translated.
59815 * @param string $from The string being translated to {@link to}.
59816 * @param string $to The string replacing {@link from}.
59817 * @return string
59818 * @since PHP 4, PHP 5
59819 **/
59820function strtr($str, $from, $to){}
59821
59822/**
59823 * @param mixed $var The variable that is being converted to a string.
59824 *   {@link var} may be any scalar type. You cannot use {@link strval} on
59825 *   arrays or objects.
59826 * @return string
59827 * @since PHP 4, PHP 5
59828 **/
59829function strval($var){}
59830
59831/**
59832 * Similar to {@link fgetcsv} this functions parses a string as its input
59833 * unlike {@link fgetcsv} which takes a file as its input.
59834 *
59835 * @param string $input The string to parse.
59836 * @param string $delimiter Set the field delimiter (one character
59837 *   only).
59838 * @param string $enclosure Set the field enclosure character (one
59839 *   character only).
59840 * @param string $escape Set the escape character (one character only).
59841 *   Defaults as a backslash (\)
59842 * @return array
59843 * @since PHP 5 >= 5.3.0
59844 **/
59845function str_getcsv($input, $delimiter, $enclosure, $escape){}
59846
59847/**
59848 * This function returns a string or an array with all occurrences of
59849 * {@link search} in {@link subject} (ignoring case) replaced with the
59850 * given {@link replace} value. If you don't need fancy replacing rules,
59851 * you should generally use this function instead of {@link preg_replace}
59852 * with the i modifier.
59853 *
59854 * @param mixed $search
59855 * @param mixed $replace
59856 * @param mixed $subject If {@link subject} is an array, then the
59857 *   search and replace is performed with every entry of {@link subject},
59858 *   and the return value is an array as well.
59859 * @param int $count The number of matched and replaced {@link needles}
59860 *   will be returned in {@link count} which is passed by reference.
59861 * @return mixed
59862 * @since PHP 5
59863 **/
59864function str_ireplace($search, $replace, $subject, &$count){}
59865
59866/**
59867 * This functions returns the {@link input} string padded on the left,
59868 * the right, or both sides to the specified padding length. If the
59869 * optional argument {@link pad_string} is not supplied, the {@link
59870 * input} is padded with spaces, otherwise it is padded with characters
59871 * from {@link pad_string} up to the limit.
59872 *
59873 * @param string $input The input string.
59874 * @param int $pad_length If the value of {@link pad_length} is
59875 *   negative, less than, or equal to the length of the input string, no
59876 *   padding takes place.
59877 * @param string $pad_string
59878 * @param int $pad_type Optional argument {@link pad_type} can be
59879 *   STR_PAD_RIGHT, STR_PAD_LEFT, or STR_PAD_BOTH. If {@link pad_type} is
59880 *   not specified it is assumed to be STR_PAD_RIGHT.
59881 * @return string
59882 * @since PHP 4 >= 4.0.1, PHP 5
59883 **/
59884function str_pad($input, $pad_length, $pad_string, $pad_type){}
59885
59886/**
59887 * Returns {@link input} repeated {@link multiplier} times.
59888 *
59889 * @param string $input The string to be repeated.
59890 * @param int $multiplier Number of time the {@link input} string
59891 *   should be repeated. {@link multiplier} has to be greater than or
59892 *   equal to 0. If the {@link multiplier} is set to 0, the function will
59893 *   return an empty string.
59894 * @return string
59895 * @since PHP 4, PHP 5
59896 **/
59897function str_repeat($input, $multiplier){}
59898
59899/**
59900 * This function returns a string or an array with all occurrences of
59901 * {@link search} in {@link subject} replaced with the given {@link
59902 * replace} value.
59903 *
59904 * If you don't need fancy replacing rules (like regular expressions),
59905 * you should always use this function instead of {@link ereg_replace} or
59906 * {@link preg_replace}.
59907 *
59908 * @param mixed $search The value being searched for, otherwise known
59909 *   as the needle. An array may be used to designate multiple needles.
59910 * @param mixed $replace The replacement value that replaces found
59911 *   {@link search} values. An array may be used to designate multiple
59912 *   replacements.
59913 * @param mixed $subject The string or array being searched and
59914 *   replaced on, otherwise known as the haystack. If {@link subject} is
59915 *   an array, then the search and replace is performed with every entry
59916 *   of {@link subject}, and the return value is an array as well.
59917 * @param int $count
59918 * @return mixed
59919 * @since PHP 4, PHP 5
59920 **/
59921function str_replace($search, $replace, $subject, &$count){}
59922
59923/**
59924 * Performs the ROT13 encoding on the {@link str} argument and returns
59925 * the resulting string.
59926 *
59927 * The ROT13 encoding simply shifts every letter by 13 places in the
59928 * alphabet while leaving non-alpha characters untouched. Encoding and
59929 * decoding are done by the same function, passing an encoded string as
59930 * argument will return the original version.
59931 *
59932 * @param string $str The input string.
59933 * @return string
59934 * @since PHP 4 >= 4.2.0, PHP 5
59935 **/
59936function str_rot13($str){}
59937
59938/**
59939 * @param string $str The input string.
59940 * @return string
59941 * @since PHP 4 >= 4.3.0, PHP 5
59942 **/
59943function str_shuffle($str){}
59944
59945/**
59946 * Converts a string to an array.
59947 *
59948 * @param string $string The input string.
59949 * @param int $split_length Maximum length of the chunk.
59950 * @return array
59951 * @since PHP 5
59952 **/
59953function str_split($string, $split_length){}
59954
59955/**
59956 * Counts the number of words inside {@link string}. If the optional
59957 * {@link format} is not specified, then the return value will be an
59958 * integer representing the number of words found. In the event the
59959 * {@link format} is specified, the return value will be an array,
59960 * content of which is dependent on the {@link format}. The possible
59961 * value for the {@link format} and the resultant outputs are listed
59962 * below.
59963 *
59964 * For the purpose of this function, 'word' is defined as a locale
59965 * dependent string containing alphabetic characters, which also may
59966 * contain, but not start with ' and - characters.
59967 *
59968 * @param string $string The string
59969 * @param int $format Specify the return value of this function. The
59970 *   current supported values are: 0 - returns the number of words found
59971 *   1 - returns an array containing all the words found inside the
59972 *   {@link string} 2 - returns an associative array, where the key is
59973 *   the numeric position of the word inside the {@link string} and the
59974 *   value is the actual word itself
59975 * @param string $charlist A list of additional characters which will
59976 *   be considered as 'word'
59977 * @return mixed
59978 * @since PHP 4 >= 4.3.0, PHP 5
59979 **/
59980function str_word_count($string, $format, $charlist){}
59981
59982/**
59983 * Returns the portion of {@link string} specified by the {@link start}
59984 * and {@link length} parameters.
59985 *
59986 * @param string $string The input string.
59987 * @param int $start If {@link start} is non-negative, the returned
59988 *   string will start at the {@link start}'th position in {@link
59989 *   string}, counting from zero. For instance, in the string 'abcdef',
59990 *   the character at position 0 is 'a', the character at position 2 is
59991 *   'c', and so forth. If {@link start} is negative, the returned string
59992 *   will start at the {@link start}'th character from the end of {@link
59993 *   string}. If {@link string} is less than or equal to {@link start}
59994 *   characters long, will be returned.
59995 *
59996 *   Using a negative {@link start}
59997 *
59998 *   <?php $rest = substr("abcdef", -1); // returns "f" $rest =
59999 *   substr("abcdef", -2); // returns "ef" $rest = substr("abcdef", -3,
60000 *   1); // returns "d" ?>
60001 * @param int $length If {@link length} is given and is positive, the
60002 *   string returned will contain at most {@link length} characters
60003 *   beginning from {@link start} (depending on the length of {@link
60004 *   string}). If {@link length} is given and is negative, then that many
60005 *   characters will be omitted from the end of {@link string} (after the
60006 *   start position has been calculated when a {@link start} is
60007 *   negative). If {@link start} denotes a position beyond this
60008 *   truncation, an empty string will be returned. If {@link length} is
60009 *   given and is 0, or an empty string will be returned.
60010 * @return string
60011 * @since PHP 4, PHP 5
60012 **/
60013function substr($string, $start, $length){}
60014
60015/**
60016 * {@link substr_compare} compares {@link main_str} from position {@link
60017 * offset} with {@link str} up to {@link length} characters.
60018 *
60019 * @param string $main_str The main string being compared.
60020 * @param string $str The secondary string being compared.
60021 * @param int $offset The start position for the comparison. If
60022 *   negative, it starts counting from the end of the string.
60023 * @param int $length The length of the comparison. The default value
60024 *   is the largest of the length of the {@link str} compared to the
60025 *   length of {@link main_str} less the {@link offset}.
60026 * @param bool $case_insensitivity If {@link case_insensitivity} is ,
60027 *   comparison is case insensitive.
60028 * @return int
60029 * @since PHP 5
60030 **/
60031function substr_compare($main_str, $str, $offset, $length, $case_insensitivity){}
60032
60033/**
60034 * {@link substr_count} returns the number of times the {@link needle}
60035 * substring occurs in the {@link haystack} string. Please note that
60036 * {@link needle} is case sensitive.
60037 *
60038 * @param string $haystack The string to search in
60039 * @param string $needle The substring to search for
60040 * @param int $offset The offset where to start counting
60041 * @param int $length The maximum length after the specified offset to
60042 *   search for the substring. It outputs a warning if the offset plus
60043 *   the length is greater than the {@link haystack} length.
60044 * @return int
60045 * @since PHP 4, PHP 5
60046 **/
60047function substr_count($haystack, $needle, $offset, $length){}
60048
60049/**
60050 * {@link substr_replace} replaces a copy of {@link string} delimited by
60051 * the {@link start} and (optionally) {@link length} parameters with the
60052 * string given in {@link replacement}.
60053 *
60054 * @param mixed $string The input string.
60055 * @param string $replacement The replacement string.
60056 * @param int $start If {@link start} is positive, the replacing will
60057 *   begin at the {@link start}'th offset into {@link string}. If {@link
60058 *   start} is negative, the replacing will begin at the {@link start}'th
60059 *   character from the end of {@link string}.
60060 * @param int $length If given and is positive, it represents the
60061 *   length of the portion of {@link string} which is to be replaced. If
60062 *   it is negative, it represents the number of characters from the end
60063 *   of {@link string} at which to stop replacing. If it is not given,
60064 *   then it will default to strlen( {@link string} ); i.e. end the
60065 *   replacing at the end of {@link string}. Of course, if {@link length}
60066 *   is zero then this function will have the effect of inserting {@link
60067 *   replacement} into {@link string} at the given {@link start} offset.
60068 * @return mixed
60069 * @since PHP 4, PHP 5
60070 **/
60071function substr_replace($string, $replacement, $start, $length){}
60072
60073/**
60074 * Adds the file, directory or symbolic link at {@link path} to the
60075 * working directory. The item will be added to the repository the next
60076 * time you call {@link svn_commit} on the working copy.
60077 *
60078 * @param string $path Path of item to add.
60079 * @param bool $recursive If item is directory, whether or not to
60080 *   recursively add all of its contents. Default is
60081 * @param bool $force If true, Subversion will recurse into already
60082 *   versioned directories in order to add unversioned files that may be
60083 *   hiding in those directories. Default is
60084 * @return bool
60085 * @since PECL svn >= 0.1.0
60086 **/
60087function svn_add($path, $recursive, $force){}
60088
60089/**
60090 * Retrieves authentication parameter at {@link key}. For a list of valid
60091 * keys and their meanings, consult the authentication constants list.
60092 *
60093 * @param string $key String key name. Use the authentication constants
60094 *   defined by this extension to specify a key.
60095 * @return string
60096 * @since PECL svn >= 0.1.0
60097 **/
60098function svn_auth_get_parameter($key){}
60099
60100/**
60101 * Sets authentication parameter at {@link key} to {@link value}. For a
60102 * list of valid keys and their meanings, consult the authentication
60103 * constants list.
60104 *
60105 * @param string $key String key name. Use the authentication constants
60106 *   defined by this extension to specify a key.
60107 * @param string $value String value to set to parameter at key. Format
60108 *   of value varies with the parameter.
60109 * @return void
60110 * @since PECL svn >= 0.1.0
60111 **/
60112function svn_auth_set_parameter($key, $value){}
60113
60114/**
60115 * Get the SVN blame of a file from a repository URL.
60116 *
60117 * @param string $repository_url The repository URL.
60118 * @param int $revision_no The revision number.
60119 * @return array
60120 * @since PECL svn >= 0.3.0
60121 **/
60122function svn_blame($repository_url, $revision_no){}
60123
60124/**
60125 * Returns the contents of the URL {@link repos_url} to a file in the
60126 * repository, optionally at revision number {@link revision_no}.
60127 *
60128 * @param string $repos_url String URL path to item in a repository.
60129 * @param int $revision_no Integer revision number of item to retrieve,
60130 *   default is the HEAD revision.
60131 * @return string
60132 * @since PECL svn >= 0.1.0
60133 **/
60134function svn_cat($repos_url, $revision_no){}
60135
60136/**
60137 * Checks out a working copy from the repository at {@link repos} to
60138 * {@link targetpath} at revision {@link revision}.
60139 *
60140 * @param string $repos String URL path to directory in repository to
60141 *   check out.
60142 * @param string $targetpath String local path to directory to check
60143 *   out in to
60144 * @param int $revision Integer revision number of repository to check
60145 *   out. Default is HEAD, the most recent revision.
60146 * @param int $flags Any combination of SVN_NON_RECURSIVE and
60147 *   SVN_IGNORE_EXTERNALS.
60148 * @return bool
60149 * @since PECL svn >= 0.1.0
60150 **/
60151function svn_checkout($repos, $targetpath, $revision, $flags){}
60152
60153/**
60154 * Recursively cleanup working copy directory {@link workingdir},
60155 * finishing any incomplete operations and removing working copy locks.
60156 * Use when a working copy is in limbo and needs to be usable again.
60157 *
60158 * @param string $workingdir String path to local working directory to
60159 *   cleanup
60160 * @return bool
60161 * @since PECL svn >= 0.1.0
60162 **/
60163function svn_cleanup($workingdir){}
60164
60165/**
60166 * Returns the version of the SVN client libraries
60167 *
60168 * @return string
60169 * @since PECL svn >= 0.1.0
60170 **/
60171function svn_client_version(){}
60172
60173/**
60174 * Commits changes made in the local working copy files enumerated in the
60175 * {@link targets} array to the repository, with the log message {@link
60176 * log}. Directories in the {@link targets} array will be recursively
60177 * committed unless {@link dontrecurse} is set to true.
60178 *
60179 * @param string $log String log text to commit
60180 * @param array $targets Array of local paths of files to be committed
60181 * @param bool $dontrecurse Boolean flag to disable recursive
60182 *   committing of directories in the {@link targets} array. Default is .
60183 * @return array
60184 * @since PECL svn >= 0.1.0
60185 **/
60186function svn_commit($log, $targets, $dontrecurse){}
60187
60188/**
60189 * Deletes the file, directory or symbolic link at {@link path} from the
60190 * working directory. The item will be deleted from the repository the
60191 * next time you call {@link svn_commit} on the working copy.
60192 *
60193 * @param string $path Path of item to delete.
60194 * @param bool $force If , the file will be deleted even if it has
60195 *   local modifications. Otherwise, local modifications will result in a
60196 *   failure. Default is
60197 * @return bool
60198 * @since PECL svn >= 0.4.0
60199 **/
60200function svn_delete($path, $force){}
60201
60202/**
60203 * Recursively diffs two paths, {@link path1} and {@link path2}.
60204 *
60205 * @param string $path1 First path to diff. This can be a URL to a
60206 *   file/directory in an SVN repository or a local file/directory path.
60207 * @param int $rev1 First path's revision number. Use SVN_REVISION_HEAD
60208 *   to specify the most recent revision.
60209 * @param string $path2 Second path to diff. See {@link path1} for
60210 *   description.
60211 * @param int $rev2 Second path's revision number. See {@link rev1} for
60212 *   description.
60213 * @return array
60214 * @since PECL svn >= 0.1.0
60215 **/
60216function svn_diff($path1, $rev1, $path2, $rev2){}
60217
60218/**
60219 * Export the contents of either a working copy or repository into a
60220 * 'clean' directory.
60221 *
60222 * @param string $frompath The path to the current repository.
60223 * @param string $topath The path to the new repository.
60224 * @param bool $working_copy If , it will export uncommitted files from
60225 *   the working copy.
60226 * @return bool
60227 * @since PECL svn >= 0.3.0
60228 **/
60229function svn_export($frompath, $topath, $working_copy){}
60230
60231/**
60232 * Abort a transaction, returns true if everything is okay, false
60233 * otherwise
60234 *
60235 * @param resource $txn
60236 * @return bool
60237 * @since PECL svn >= 0.2.0
60238 **/
60239function svn_fs_abort_txn($txn){}
60240
60241/**
60242 * Creates and returns a stream that will be used to replace
60243 *
60244 * @param resource $root
60245 * @param string $path
60246 * @return resource
60247 * @since PECL svn >= 0.2.0
60248 **/
60249function svn_fs_apply_text($root, $path){}
60250
60251/**
60252 * Create a new transaction
60253 *
60254 * @param resource $repos
60255 * @param int $rev
60256 * @return resource
60257 * @since PECL svn >= 0.2.0
60258 **/
60259function svn_fs_begin_txn2($repos, $rev){}
60260
60261/**
60262 * Return true if everything is ok, false otherwise
60263 *
60264 * @param resource $root
60265 * @param string $path
60266 * @param string $name
60267 * @param string $value
60268 * @return bool
60269 * @since PECL svn >= 0.2.0
60270 **/
60271function svn_fs_change_node_prop($root, $path, $name, $value){}
60272
60273/**
60274 * Determines what kind of item lives at path in a given repository
60275 * fsroot
60276 *
60277 * @param resource $fsroot
60278 * @param string $path
60279 * @return int
60280 * @since PECL svn >= 0.1.0
60281 **/
60282function svn_fs_check_path($fsroot, $path){}
60283
60284/**
60285 * Return true if content is different, false otherwise
60286 *
60287 * @param resource $root1
60288 * @param string $path1
60289 * @param resource $root2
60290 * @param string $path2
60291 * @return bool
60292 * @since PECL svn >= 0.2.0
60293 **/
60294function svn_fs_contents_changed($root1, $path1, $root2, $path2){}
60295
60296/**
60297 * Copies a file or a directory, returns true if all is ok, false
60298 * otherwise
60299 *
60300 * @param resource $from_root
60301 * @param string $from_path
60302 * @param resource $to_root
60303 * @param string $to_path
60304 * @return bool
60305 * @since PECL svn >= 0.2.0
60306 **/
60307function svn_fs_copy($from_root, $from_path, $to_root, $to_path){}
60308
60309/**
60310 * Deletes a file or a directory, return true if all is ok, false
60311 * otherwise
60312 *
60313 * @param resource $root
60314 * @param string $path
60315 * @return bool
60316 * @since PECL svn >= 0.2.0
60317 **/
60318function svn_fs_delete($root, $path){}
60319
60320/**
60321 * Enumerates the directory entries under path; returns a hash of dir
60322 * names to file type
60323 *
60324 * @param resource $fsroot
60325 * @param string $path
60326 * @return array
60327 * @since PECL svn >= 0.1.0
60328 **/
60329function svn_fs_dir_entries($fsroot, $path){}
60330
60331/**
60332 * Returns a stream to access the contents of a file from a given version
60333 * of the fs
60334 *
60335 * @param resource $fsroot
60336 * @param string $path
60337 * @return resource
60338 * @since PECL svn >= 0.1.0
60339 **/
60340function svn_fs_file_contents($fsroot, $path){}
60341
60342/**
60343 * Returns the length of a file from a given version of the fs
60344 *
60345 * @param resource $fsroot
60346 * @param string $path
60347 * @return int
60348 * @since PECL svn >= 0.1.0
60349 **/
60350function svn_fs_file_length($fsroot, $path){}
60351
60352/**
60353 * Return true if the path points to a directory, false otherwise
60354 *
60355 * @param resource $root
60356 * @param string $path
60357 * @return bool
60358 * @since PECL svn >= 0.2.0
60359 **/
60360function svn_fs_is_dir($root, $path){}
60361
60362/**
60363 * Return true if the path points to a file, false otherwise
60364 *
60365 * @param resource $root
60366 * @param string $path
60367 * @return bool
60368 * @since PECL svn >= 0.2.0
60369 **/
60370function svn_fs_is_file($root, $path){}
60371
60372/**
60373 * Creates a new empty directory, returns true if all is ok, false
60374 * otherwise
60375 *
60376 * @param resource $root
60377 * @param string $path
60378 * @return bool
60379 * @since PECL svn >= 0.2.0
60380 **/
60381function svn_fs_make_dir($root, $path){}
60382
60383/**
60384 * Creates a new empty file, returns true if all is ok, false otherwise
60385 *
60386 * @param resource $root
60387 * @param string $path
60388 * @return bool
60389 * @since PECL svn >= 0.2.0
60390 **/
60391function svn_fs_make_file($root, $path){}
60392
60393/**
60394 * Returns the revision in which path under fsroot was created
60395 *
60396 * @param resource $fsroot
60397 * @param string $path
60398 * @return int
60399 * @since PECL svn >= 0.1.0
60400 **/
60401function svn_fs_node_created_rev($fsroot, $path){}
60402
60403/**
60404 * Returns the value of a property for a node
60405 *
60406 * @param resource $fsroot
60407 * @param string $path
60408 * @param string $propname
60409 * @return string
60410 * @since PECL svn >= 0.1.0
60411 **/
60412function svn_fs_node_prop($fsroot, $path, $propname){}
60413
60414/**
60415 * Return true if props are different, false otherwise
60416 *
60417 * @param resource $root1
60418 * @param string $path1
60419 * @param resource $root2
60420 * @param string $path2
60421 * @return bool
60422 * @since PECL svn >= 0.2.0
60423 **/
60424function svn_fs_props_changed($root1, $path1, $root2, $path2){}
60425
60426/**
60427 * Fetches the value of a named property
60428 *
60429 * @param resource $fs
60430 * @param int $revnum
60431 * @param string $propname
60432 * @return string
60433 * @since PECL svn >= 0.1.0
60434 **/
60435function svn_fs_revision_prop($fs, $revnum, $propname){}
60436
60437/**
60438 * Get a handle on a specific version of the repository root
60439 *
60440 * @param resource $fs
60441 * @param int $revnum
60442 * @return resource
60443 * @since PECL svn >= 0.1.0
60444 **/
60445function svn_fs_revision_root($fs, $revnum){}
60446
60447/**
60448 * Creates and returns a transaction root
60449 *
60450 * @param resource $txn
60451 * @return resource
60452 * @since PECL svn >= 0.2.0
60453 **/
60454function svn_fs_txn_root($txn){}
60455
60456/**
60457 * Returns the number of the youngest revision in the filesystem
60458 *
60459 * @param resource $fs
60460 * @return int
60461 * @since PECL svn >= 0.1.0
60462 **/
60463function svn_fs_youngest_rev($fs){}
60464
60465/**
60466 * Commits unversioned {@link path} into repository at {@link url}. If
60467 * {@link path} is a directory and {@link nonrecursive} is , the
60468 * directory will be imported recursively.
60469 *
60470 * @param string $path Path of file or directory to import.
60471 * @param string $url Repository URL to import into.
60472 * @param bool $nonrecursive Whether or not to refrain from recursively
60473 *   processing directories.
60474 * @return bool
60475 * @since PECL svn >= 0.2.0
60476 **/
60477function svn_import($path, $url, $nonrecursive){}
60478
60479/**
60480 * {@link svn_log} returns the complete history of the item at the
60481 * repository URL {@link repos_url}, or the history of a specific
60482 * revision if {@link start_revision} is set. This function is equivalent
60483 * to svn log --verbose -r $start_revision $repos_url.
60484 *
60485 * @param string $repos_url Repository URL of the item to retrieve log
60486 *   history from.
60487 * @param int $start_revision Revision number of the first log to
60488 *   retrieve. Use SVN_REVISION_HEAD to retrieve the log from the most
60489 *   recent revision.
60490 * @param int $end_revision Revision number of the last log to
60491 *   retrieve. Defaults to {@link start_revision} if specified or to
60492 *   SVN_REVISION_INITIAL otherwise.
60493 * @param int $limit Number of logs to retrieve.
60494 * @param int $flags Any combination of SVN_OMIT_MESSAGES,
60495 *   SVN_DISCOVER_CHANGED_PATHS and SVN_STOP_ON_COPY.
60496 * @return array
60497 * @since PECL svn >= 0.1.0
60498 **/
60499function svn_log($repos_url, $start_revision, $end_revision, $limit, $flags){}
60500
60501/**
60502 * This function queries the repository URL and returns a list of files
60503 * and directories, optionally from a specific revision. This is
60504 * equivalent to svn list $repos_url[@$revision_no]
60505 *
60506 * @param string $repos_url URL of the repository, eg.
60507 *   http://www.example.com/svnroot. To access a local Subversion
60508 *   repository via filesystem, use the file URI scheme, eg.
60509 *   file:///home/user/svn-repos
60510 * @param int $revision_no Integer revision number to retrieve listing
60511 *   of. When omitted, the HEAD revision is used.
60512 * @param bool $recurse Enables recursion.
60513 * @return array
60514 * @since PECL svn >= 0.1.0
60515 **/
60516function svn_ls($repos_url, $revision_no, $recurse){}
60517
60518/**
60519 * Creates a directory in a working copy or repository.
60520 *
60521 * @param string $path The path to the working copy or repository.
60522 * @return bool
60523 * @since PECL svn >= 0.4.0
60524 **/
60525function svn_mkdir($path){}
60526
60527/**
60528 * Create a new subversion repository at path
60529 *
60530 * @param string $path
60531 * @param array $config
60532 * @param array $fsconfig
60533 * @return resource
60534 * @since PECL svn >= 0.1.0
60535 **/
60536function svn_repos_create($path, $config, $fsconfig){}
60537
60538/**
60539 * Gets a handle on the filesystem for a repository
60540 *
60541 * @param resource $repos
60542 * @return resource
60543 * @since PECL svn >= 0.1.0
60544 **/
60545function svn_repos_fs($repos){}
60546
60547/**
60548 * Create a new transaction
60549 *
60550 * @param resource $repos
60551 * @param int $rev
60552 * @param string $author
60553 * @param string $log_msg
60554 * @return resource
60555 * @since PECL svn >= 0.2.0
60556 **/
60557function svn_repos_fs_begin_txn_for_commit($repos, $rev, $author, $log_msg){}
60558
60559/**
60560 * Commits a transaction and returns the new revision
60561 *
60562 * @param resource $txn
60563 * @return int
60564 * @since PECL svn >= 0.2.0
60565 **/
60566function svn_repos_fs_commit_txn($txn){}
60567
60568/**
60569 * Make a hot-copy of the repos at repospath; copy it to destpath
60570 *
60571 * @param string $repospath
60572 * @param string $destpath
60573 * @param bool $cleanlogs
60574 * @return bool
60575 * @since PECL svn >= 0.1.0
60576 **/
60577function svn_repos_hotcopy($repospath, $destpath, $cleanlogs){}
60578
60579/**
60580 * Open a shared lock on a repository.
60581 *
60582 * @param string $path
60583 * @return resource
60584 * @since PECL svn >= 0.1.0
60585 **/
60586function svn_repos_open($path){}
60587
60588/**
60589 * Run recovery procedures on the repository located at path.
60590 *
60591 * @param string $path
60592 * @return bool
60593 * @since PECL svn >= 0.1.0
60594 **/
60595function svn_repos_recover($path){}
60596
60597/**
60598 * Revert any local changes to the path in a working copy.
60599 *
60600 * @param string $path The path to the working repository.
60601 * @param bool $recursive Optionally make recursive changes.
60602 * @return bool
60603 * @since PECL svn >= 0.3.0
60604 **/
60605function svn_revert($path, $recursive){}
60606
60607/**
60608 * Returns the status of working copy files and directories, giving
60609 * modifications, additions, deletions and other changes to items in the
60610 * working copy.
60611 *
60612 * @param string $path Local path to file or directory to retrieve
60613 *   status of.
60614 * @param int $flags Any combination of SVN_NON_RECURSIVE, SVN_ALL
60615 *   (regardless of modification status), SVN_SHOW_UPDATES (entries will
60616 *   be added for items that are out-of-date), SVN_NO_IGNORE (disregard
60617 *   svn:ignore properties when scanning for new files) and
60618 *   SVN_IGNORE_EXTERNALS.
60619 * @return array
60620 * @since PECL svn >= 0.1.0
60621 **/
60622function svn_status($path, $flags){}
60623
60624/**
60625 * Update working copy at {@link path} to revision {@link revno}. If
60626 * {@link recurse} is true, directories will be recursively updated.
60627 *
60628 * @param string $path Path to local working copy.
60629 * @param int $revno Revision number to update to, default is
60630 *   SVN_REVISION_HEAD.
60631 * @param bool $recurse Whether or not to recursively update
60632 *   directories.
60633 * @return int
60634 * @since PECL svn >= 0.1.0
60635 **/
60636function svn_update($path, $revno, $recurse){}
60637
60638/**
60639 * Gets the URL specified by the parameter {@link url} with the given
60640 * {@link target}.
60641 *
60642 * @param string $url The URL, as a string.
60643 * @param string $target The target, as a string.
60644 * @return void
60645 * @since PHP 4
60646 **/
60647function swf_actiongeturl($url, $target){}
60648
60649/**
60650 * The {@link swf_actiongotoframe} function will go to the frame
60651 * specified by {@link framenumber}, play it, and then stop.
60652 *
60653 * @param int $framenumber The frame number.
60654 * @return void
60655 * @since PHP 4
60656 **/
60657function swf_actiongotoframe($framenumber){}
60658
60659/**
60660 * The {@link swf_actiongotolabel} function displays the frame with the
60661 * label given by the {@link label} parameter and then stops.
60662 *
60663 * @param string $label The frame label.
60664 * @return void
60665 * @since PHP 4
60666 **/
60667function swf_actiongotolabel($label){}
60668
60669/**
60670 * Go forward one frame.
60671 *
60672 * @return void
60673 * @since PHP 4
60674 **/
60675function swf_actionnextframe(){}
60676
60677/**
60678 * Start playing the flash movie from the current frame.
60679 *
60680 * @return void
60681 * @since PHP 4
60682 **/
60683function swf_actionplay(){}
60684
60685/**
60686 * Go backwards one frame.
60687 *
60688 * @return void
60689 * @since PHP 4
60690 **/
60691function swf_actionprevframe(){}
60692
60693/**
60694 * Sets the context for all actions. You can use this to control other
60695 * flash movies that are currently playing.
60696 *
60697 * @param string $target The target, as a string.
60698 * @return void
60699 * @since PHP 4
60700 **/
60701function swf_actionsettarget($target){}
60702
60703/**
60704 * Stop playing the flash movie at the current frame.
60705 *
60706 * @return void
60707 * @since PHP 4
60708 **/
60709function swf_actionstop(){}
60710
60711/**
60712 * Toggle the flash movie between high and low quality.
60713 *
60714 * @return void
60715 * @since PHP 4
60716 **/
60717function swf_actiontogglequality(){}
60718
60719/**
60720 * The {@link swf_actionwaitforframe} function will check to see if the
60721 * frame, specified by the {@link framenumber} parameter has been loaded,
60722 * if not it will skip the number of actions specified by the {@link
60723 * skipcount} parameter. This can be useful for "Loading..." type
60724 * animations.
60725 *
60726 * @param int $framenumber The frame number.
60727 * @param int $skipcount The number of actions to skip.
60728 * @return void
60729 * @since PHP 4
60730 **/
60731function swf_actionwaitforframe($framenumber, $skipcount){}
60732
60733/**
60734 * Allow you to define the specifics of using a button.
60735 *
60736 * @param int $states Defines what states the button can have, these
60737 *   can be any or all of the following constants: BSHitTest, BSDown,
60738 *   BSOver or BSUp.
60739 * @param int $shapeid The second parameter, the {@link shapeid} is the
60740 *   look of the button, this is usually the object id of the shape of
60741 *   the button.
60742 * @param int $depth This parameter is the placement of the button in
60743 *   the current frame.
60744 * @return void
60745 * @since PHP 4
60746 **/
60747function swf_addbuttonrecord($states, $shapeid, $depth){}
60748
60749/**
60750 * Sets the global add color to the specified color. This color is then
60751 * implicitly used by the {@link swf_placeobject}, {@link
60752 * swf_modifyobject} and {@link swf_addbuttonrecord} functions.
60753 *
60754 * The color of the object will be add by the given values when the
60755 * object is written to the screen.
60756 *
60757 * @param float $r Red value
60758 * @param float $g Green value
60759 * @param float $b Blue value
60760 * @param float $a Alpha value
60761 * @return void
60762 * @since PHP 4
60763 **/
60764function swf_addcolor($r, $g, $b, $a){}
60765
60766/**
60767 * Close a file that was opened by the {@link swf_openfile} function.
60768 *
60769 * @param int $return_file If set then the contents of the SWF file are
60770 *   returned from the function.
60771 * @return void
60772 * @since PHP 4
60773 **/
60774function swf_closefile($return_file){}
60775
60776/**
60777 * The {@link swf_definebitmap} function defines a bitmap given an image.
60778 *
60779 * @param int $objid An SWF object id.
60780 * @param string $image_name A GIF, JPEG, RGB or FI image. The image
60781 *   will be converted into a Flash JPEG or Flash color map format.
60782 * @return void
60783 * @since PHP 4
60784 **/
60785function swf_definebitmap($objid, $image_name){}
60786
60787/**
60788 * The {@link swf_definefont} function defines a font parameter and gives
60789 * it the specified id. It then sets the font given by fontname to the
60790 * current font.
60791 *
60792 * @param int $fontid The id to be given to the font.
60793 * @param string $fontname The font so be set as current font.
60794 * @return void
60795 * @since PHP 4
60796 **/
60797function swf_definefont($fontid, $fontname){}
60798
60799/**
60800 * Defines a line.
60801 *
60802 * @param int $objid The object id.
60803 * @param float $x1 x-coordinate of start point.
60804 * @param float $y1 y-coordinate of start point.
60805 * @param float $x2 x-coordinate of end point.
60806 * @param float $y2 y-coordinate of end point.
60807 * @param float $width The line width.
60808 * @return void
60809 * @since PHP 4
60810 **/
60811function swf_defineline($objid, $x1, $y1, $x2, $y2, $width){}
60812
60813/**
60814 * Defines a polygon given an array of x, y coordinates.
60815 *
60816 * @param int $objid The object id.
60817 * @param array $coords An array of x, y coordinates.
60818 * @param int $npoints The number of overall points that are contained
60819 *   in the array given by {@link coords}
60820 * @param float $width The width of the polygon's border, if set to 0.0
60821 *   the polygon is filled.
60822 * @return void
60823 * @since PHP 4
60824 **/
60825function swf_definepoly($objid, $coords, $npoints, $width){}
60826
60827/**
60828 * Defines a rectangle with an upper left hand coordinate and a lower
60829 * right hand coordinate.
60830 *
60831 * @param int $objid The object id.
60832 * @param float $x1 x-coordinate of upper left point.
60833 * @param float $y1 y-coordinate of upper left point.
60834 * @param float $x2 x-coordinate of lower right point.
60835 * @param float $y2 y-coordinate of lower right point.
60836 * @param float $width Width of the rectangles border, if the width is
60837 *   0.0 then the rectangle is filled.
60838 * @return void
60839 * @since PHP 4
60840 **/
60841function swf_definerect($objid, $x1, $y1, $x2, $y2, $width){}
60842
60843/**
60844 * Defines a text string using the current font and font size.
60845 *
60846 * @param int $objid The object id.
60847 * @param string $str The text, as a string.
60848 * @param int $docenter The {@link docenter} is where the word is
60849 *   centered, if {@link docenter} is 1, then the word is centered in x.
60850 * @return void
60851 * @since PHP 4
60852 **/
60853function swf_definetext($objid, $str, $docenter){}
60854
60855/**
60856 * The {@link swf_endbutton} function ends the definition of the current
60857 * button.
60858 *
60859 * @return void
60860 * @since PHP 4
60861 **/
60862function swf_endbutton(){}
60863
60864/**
60865 * Ends the current action started by the {@link swf_startdoaction}
60866 * function.
60867 *
60868 * @return void
60869 * @since PHP 4
60870 **/
60871function swf_enddoaction(){}
60872
60873/**
60874 * The {@link swf_endshape} completes the definition of the current
60875 * shape.
60876 *
60877 * @return void
60878 * @since PHP 4
60879 **/
60880function swf_endshape(){}
60881
60882/**
60883 * Ends the definition of a symbol that was started by the {@link
60884 * swf_startsymbol} function.
60885 *
60886 * @return void
60887 * @since PHP 4
60888 **/
60889function swf_endsymbol(){}
60890
60891/**
60892 * Changes the font size to the value given by the {@link size}
60893 * parameter.
60894 *
60895 * @param float $size The font size, as an integer.
60896 * @return void
60897 * @since PHP 4
60898 **/
60899function swf_fontsize($size){}
60900
60901/**
60902 * Set the current font slant to the angle indicated by the {@link slant}
60903 * parameter.
60904 *
60905 * @param float $slant Positive values create a forward slant, negative
60906 *   values create a negative slant.
60907 * @return void
60908 * @since PHP 4
60909 **/
60910function swf_fontslant($slant){}
60911
60912/**
60913 * Set the font tracking to the value specified by the {@link tracking}
60914 * parameter. This function is used to increase the spacing between
60915 * letters and text, positive values increase the space and negative
60916 * values decrease the space between letters.
60917 *
60918 * @param float $tracking The font tracking.
60919 * @return void
60920 * @since PHP 4
60921 **/
60922function swf_fonttracking($tracking){}
60923
60924/**
60925 * Returns information about a bitmap.
60926 *
60927 * @param int $bitmapid The bitmap id.
60928 * @return array
60929 * @since PHP 4
60930 **/
60931function swf_getbitmapinfo($bitmapid){}
60932
60933/**
60934 * Gets information about the font by giving the height in pixels of a
60935 * capital A and a lowercase x.
60936 *
60937 * @return array
60938 * @since PHP 4
60939 **/
60940function swf_getfontinfo(){}
60941
60942/**
60943 * The {@link swf_getframe} function gets the number of the current
60944 * frame.
60945 *
60946 * @return int
60947 * @since PHP 4
60948 **/
60949function swf_getframe(){}
60950
60951/**
60952 * Labels the current frame with the given {@link name}.
60953 *
60954 * @param string $name The frame label.
60955 * @return void
60956 * @since PHP 4
60957 **/
60958function swf_labelframe($name){}
60959
60960/**
60961 * Defines a viewing transformation by giving the viewing position and
60962 * the coordinates of a reference point in the scene.
60963 *
60964 * @param float $view_x x-coordinate for the viewing position
60965 * @param float $view_y y-coordinate for the viewing position
60966 * @param float $view_z z-coordinate for the viewing position
60967 * @param float $reference_x x-coordinate for the reference point
60968 * @param float $reference_y y-coordinate for the reference point
60969 * @param float $reference_z z-coordinate for the reference point
60970 * @param float $twist Controls the rotation along with viewer's z
60971 *   axis.
60972 * @return void
60973 * @since PHP 4
60974 **/
60975function swf_lookat($view_x, $view_y, $view_z, $reference_x, $reference_y, $reference_z, $twist){}
60976
60977/**
60978 * Updates the position and/or color of the object at the specified
60979 * {@link depth}.
60980 *
60981 * @param int $depth The depth, as an integer.
60982 * @param int $how Determines what is updated. {@link how} can either
60983 *   be the constant MOD_MATRIX or MOD_COLOR or it can be a combination
60984 *   of both. MOD_COLOR uses the current mulcolor (specified by the
60985 *   function {@link swf_mulcolor}) and addcolor (specified by the
60986 *   function {@link swf_addcolor}) to color the object. MOD_MATRIX uses
60987 *   the current matrix to position the object.
60988 * @return void
60989 * @since PHP 4
60990 **/
60991function swf_modifyobject($depth, $how){}
60992
60993/**
60994 * Sets the global multiply color to the given one. This color is then
60995 * implicitly used by the {@link swf_placeobject}, {@link
60996 * swf_modifyobject} and {@link swf_addbuttonrecord} functions.
60997 *
60998 * The color of the object will be multiplied by the given color values
60999 * when the object is written to the screen.
61000 *
61001 * @param float $r Red value
61002 * @param float $g Green value
61003 * @param float $b Blue value
61004 * @param float $a Alpha value
61005 * @return void
61006 * @since PHP 4
61007 **/
61008function swf_mulcolor($r, $g, $b, $a){}
61009
61010/**
61011 * The {@link swf_nextid} function returns the next available object id.
61012 *
61013 * @return int
61014 * @since PHP 4
61015 **/
61016function swf_nextid(){}
61017
61018/**
61019 * The {@link swf_oncondition} function describes a transition that will
61020 * trigger an action list.
61021 *
61022 * @param int $transition There are several types of possible
61023 *   transitions, the following are for buttons defined as
61024 *   TYPE_MENUBUTTON: IdletoOverUp OverUptoIdle OverUptoOverDown
61025 *   OverDowntoOverUp IdletoOverDown OutDowntoIdle MenuEnter
61026 *   (IdletoOverUp|IdletoOverDown) MenuExit (OverUptoIdle|OverDowntoIdle)
61027 *   For TYPE_PUSHBUTTON there are the following options: IdletoOverUp
61028 *   OverUptoIdle OverUptoOverDown OverDowntoOverUp OverDowntoOutDown
61029 *   OutDowntoOverDown OutDowntoIdle ButtonEnter
61030 *   (IdletoOverUp|OutDowntoOverDown) ButtonExit
61031 *   (OverUptoIdle|OverDowntoOutDown)
61032 * @return void
61033 * @since PHP 4
61034 **/
61035function swf_oncondition($transition){}
61036
61037/**
61038 * Opens a new file. This must be the first function you call, otherwise
61039 * your script will not work.
61040 *
61041 * @param string $filename The path to the SWF file. If you want to
61042 *   send your output to the screen, set this to php://stdout.
61043 * @param float $width The movie width
61044 * @param float $height The movie height
61045 * @param float $framerate The frame rate.
61046 * @param float $r Red value for the background.
61047 * @param float $g Green value for the background.
61048 * @param float $b Blue value for the background.
61049 * @return void
61050 * @since PHP 4
61051 **/
61052function swf_openfile($filename, $width, $height, $framerate, $r, $g, $b){}
61053
61054/**
61055 * Defines an 3D orthographic mapping of user coordinates onto the
61056 * current viewport.
61057 *
61058 * @param float $xmin
61059 * @param float $xmax
61060 * @param float $ymin
61061 * @param float $ymax
61062 * @param float $zmin
61063 * @param float $zmax
61064 * @return void
61065 * @since PHP 4 >= 4.0.1
61066 **/
61067function swf_ortho($xmin, $xmax, $ymin, $ymax, $zmin, $zmax){}
61068
61069/**
61070 * Defines a two dimensional orthographic mapping of user coordinates
61071 * onto the current viewport, this defaults to one to one mapping of the
61072 * area of the Flash movie.
61073 *
61074 * If a perspective transformation is desired, {@link swf_perspective}
61075 * can be used.
61076 *
61077 * @param float $xmin
61078 * @param float $xmax
61079 * @param float $ymin
61080 * @param float $ymax
61081 * @return void
61082 * @since PHP 4
61083 **/
61084function swf_ortho2($xmin, $xmax, $ymin, $ymax){}
61085
61086/**
61087 * Defines a perspective projection transformation.
61088 *
61089 * @param float $fovy A field-of-view angle in the y direction.
61090 * @param float $aspect The aspect ratio of the viewport that is being
61091 *   drawn onto.
61092 * @param float $near The near clipping plane.
61093 * @param float $far The far clipping plane.
61094 * @return void
61095 * @since PHP 4
61096 **/
61097function swf_perspective($fovy, $aspect, $near, $far){}
61098
61099/**
61100 * Places the object in the current frame at a specified {@link depth}.
61101 *
61102 * This uses the current mulcolor (specified by {@link swf_mulcolor}) and
61103 * the current addcolor (specified by {@link swf_addcolor}) to color the
61104 * object and it uses the current matrix to position the object.
61105 *
61106 * @param int $objid The object id.
61107 * @param int $depth Must be between 1 and 65535.
61108 * @return void
61109 * @since PHP 4
61110 **/
61111function swf_placeobject($objid, $depth){}
61112
61113/**
61114 * The {@link swf_polarview} function defines the viewer's position in
61115 * polar coordinates.
61116 *
61117 * @param float $dist The distance between the viewpoint to the world
61118 *   space origin.
61119 * @param float $azimuth Defines the azimuthal angle in the x,y
61120 *   coordinate plane, measured in distance from the y axis.
61121 * @param float $incidence Defines the angle of incidence in the y,z
61122 *   plane, measured in distance from the z axis. The incidence angle is
61123 *   defined as the angle of the viewport relative to the z axis.
61124 * @param float $twist Specifies the amount that the viewpoint is to be
61125 *   rotated about the line of sight using the right hand rule.
61126 * @return void
61127 * @since PHP 4
61128 **/
61129function swf_polarview($dist, $azimuth, $incidence, $twist){}
61130
61131/**
61132 * Pushes the current transformation matrix back onto the stack.
61133 *
61134 * @return void
61135 * @since PHP 4
61136 **/
61137function swf_popmatrix(){}
61138
61139/**
61140 * Enables or disables the rounding of the translation when objects are
61141 * placed or moved, there are times when text becomes more readable
61142 * because rounding has been enabled.
61143 *
61144 * @param int $round Whether to enable rounding or not, if set to the
61145 *   value of 1, then rounding is enabled, if set to 0 then rounding is
61146 *   disabled.
61147 * @return void
61148 * @since PHP 4
61149 **/
61150function swf_posround($round){}
61151
61152/**
61153 * Pushes the current transformation matrix back onto the stack.
61154 *
61155 * @return void
61156 * @since PHP 4
61157 **/
61158function swf_pushmatrix(){}
61159
61160/**
61161 * Removes the last object drawn at the depth specified by {@link depth}.
61162 *
61163 * @param int $depth The depth, as an integer.
61164 * @return void
61165 * @since PHP 4
61166 **/
61167function swf_removeobject($depth){}
61168
61169/**
61170 * Rotates the current transformation by a given {@link angle} around the
61171 * given {@link axis}.
61172 *
61173 * @param float $angle The rotation angle.
61174 * @param string $axis The axis. Valid values axis are x (the x axis),
61175 *   y (the y axis) or z (the z axis).
61176 * @return void
61177 * @since PHP 4
61178 **/
61179function swf_rotate($angle, $axis){}
61180
61181/**
61182 * The {@link swf_scale} scales curve coordinates by the given value.
61183 *
61184 * @param float $x x scale factor.
61185 * @param float $y y scale factor.
61186 * @param float $z z scale factor.
61187 * @return void
61188 * @since PHP 4
61189 **/
61190function swf_scale($x, $y, $z){}
61191
61192/**
61193 * The {@link swf_setfont} sets the current font to the value given by
61194 * the {@link fontid} parameter.
61195 *
61196 * @param int $fontid The font identifier.
61197 * @return void
61198 * @since PHP 4
61199 **/
61200function swf_setfont($fontid){}
61201
61202/**
61203 * Changes the active frame to the specified on.
61204 *
61205 * @param int $framenumber The frame number to be set.
61206 * @return void
61207 * @since PHP 4
61208 **/
61209function swf_setframe($framenumber){}
61210
61211/**
61212 * Draws a circular arc.
61213 *
61214 * @param float $x x-coordinate of the center.
61215 * @param float $y y-coordinate of the center.
61216 * @param float $r The arc radius.
61217 * @param float $ang1 The start angle.
61218 * @param float $ang2 The end angle.
61219 * @return void
61220 * @since PHP 4
61221 **/
61222function swf_shapearc($x, $y, $r, $ang1, $ang2){}
61223
61224/**
61225 * Draws a quadratic bezier curve from the current location, though the
61226 * two given points.
61227 *
61228 * The current position is then set to the point defined by the {@link
61229 * x2} and {@link y2} parameters.
61230 *
61231 * @param float $x1 x-coordinate of the first point.
61232 * @param float $y1 y-coordinate of the first point.
61233 * @param float $x2 x-coordinate of the second point.
61234 * @param float $y2 y-coordinate of the second point.
61235 * @return void
61236 * @since PHP 4
61237 **/
61238function swf_shapecurveto($x1, $y1, $x2, $y2){}
61239
61240/**
61241 * Draw a cubic bezier curve using the given coordinates.
61242 *
61243 * The current position is then set to the {@link x3},{@link y3}
61244 * coordinate.
61245 *
61246 * @param float $x1 x-coordinate of the first off curve control point.
61247 * @param float $y1 y-coordinate of the first off curve control point.
61248 * @param float $x2 x-coordinate of the second off curve control point.
61249 * @param float $y2 y-coordinate of the second off curve control point.
61250 * @param float $x3 x-coordinate of the endpoint.
61251 * @param float $y3 y-coordinate of the endpoint.
61252 * @return void
61253 * @since PHP 4
61254 **/
61255function swf_shapecurveto3($x1, $y1, $x2, $y2, $x3, $y3){}
61256
61257/**
61258 * Sets the fill to bitmap clipped, empty spaces will be filled by the
61259 * bitmap.
61260 *
61261 * @param int $bitmapid The bitmap id.
61262 * @return void
61263 * @since PHP 4
61264 **/
61265function swf_shapefillbitmapclip($bitmapid){}
61266
61267/**
61268 * Sets the fill to bitmap tile, empty spaces will be filled by the
61269 * bitmap.
61270 *
61271 * @param int $bitmapid The bitmap id.
61272 * @return void
61273 * @since PHP 4
61274 **/
61275function swf_shapefillbitmaptile($bitmapid){}
61276
61277/**
61278 * Turns off filling for the current shape.
61279 *
61280 * @return void
61281 * @since PHP 4
61282 **/
61283function swf_shapefilloff(){}
61284
61285/**
61286 * Sets the current fill style to solid, and then sets the fill color to
61287 * the given color.
61288 *
61289 * @param float $r Red value
61290 * @param float $g Green value
61291 * @param float $b Blue value
61292 * @param float $a Alpha value
61293 * @return void
61294 * @since PHP 4
61295 **/
61296function swf_shapefillsolid($r, $g, $b, $a){}
61297
61298/**
61299 * Sets the current line style to the given color and width.
61300 *
61301 * @param float $r Red value
61302 * @param float $g Green value
61303 * @param float $b Blue value
61304 * @param float $a Alpha value
61305 * @param float $width The line width. If 0.0 is given then no lines
61306 *   are drawn.
61307 * @return void
61308 * @since PHP 4
61309 **/
61310function swf_shapelinesolid($r, $g, $b, $a, $width){}
61311
61312/**
61313 * Draws a line to the {@link x} and {@link y} coordinates. The current
61314 * position is then set to that point.
61315 *
61316 * @param float $x x-coordinate of the target.
61317 * @param float $y y-coordinate of the target.
61318 * @return void
61319 * @since PHP 4
61320 **/
61321function swf_shapelineto($x, $y){}
61322
61323/**
61324 * Moves the current position to the given point.
61325 *
61326 * @param float $x x-coordinate of the target.
61327 * @param float $y y-coordinate of the target.
61328 * @return void
61329 * @since PHP 4
61330 **/
61331function swf_shapemoveto($x, $y){}
61332
61333/**
61334 * Outputs the current frame.
61335 *
61336 * @return void
61337 * @since PHP 4
61338 **/
61339function swf_showframe(){}
61340
61341/**
61342 * Starts the definition of a button.
61343 *
61344 * @param int $objid The object id.
61345 * @param int $type Can either be TYPE_MENUBUTTON or TYPE_PUSHBUTTON.
61346 *   The TYPE_MENUBUTTON constant allows the focus to travel from the
61347 *   button when the mouse is down, TYPE_PUSHBUTTON does not allow the
61348 *   focus to travel when the mouse is down.
61349 * @return void
61350 * @since PHP 4
61351 **/
61352function swf_startbutton($objid, $type){}
61353
61354/**
61355 * Starts the description of an action list for the current frame. This
61356 * must be called before actions are defined for the current frame.
61357 *
61358 * @return void
61359 * @since PHP 4
61360 **/
61361function swf_startdoaction(){}
61362
61363/**
61364 * Starts a complex shape.
61365 *
61366 * @param int $objid The object id.
61367 * @return void
61368 * @since PHP 4
61369 **/
61370function swf_startshape($objid){}
61371
61372/**
61373 * Defines an object id as a symbol. Symbols are tiny flash movies that
61374 * can be played simultaneously.
61375 *
61376 * @param int $objid The object id you want to define as a symbol.
61377 * @return void
61378 * @since PHP 4
61379 **/
61380function swf_startsymbol($objid){}
61381
61382/**
61383 * Gives the width of the string in pixels, using the current font and
61384 * font size.
61385 *
61386 * @param string $str The string.
61387 * @return float
61388 * @since PHP 4
61389 **/
61390function swf_textwidth($str){}
61391
61392/**
61393 * Translates the current transformation by the given values.
61394 *
61395 * @param float $x x value.
61396 * @param float $y y value.
61397 * @param float $z z value.
61398 * @return void
61399 * @since PHP 4
61400 **/
61401function swf_translate($x, $y, $z){}
61402
61403/**
61404 * Selects an area for future drawing for {@link xmin} to {@link xmax}
61405 * and {@link ymin} to {@link ymax}, if this function is not called the
61406 * area defaults to the size of the screen.
61407 *
61408 * @param float $xmin
61409 * @param float $xmax
61410 * @param float $ymin
61411 * @param float $ymax
61412 * @return void
61413 * @since PHP 4
61414 **/
61415function swf_viewport($xmin, $xmax, $ymin, $ymax){}
61416
61417/**
61418 * {@link sybase_affected_rows} returns the number of rows affected by
61419 * the last INSERT, UPDATE or DELETE query on the server associated with
61420 * the specified link identifier.
61421 *
61422 * This command is not effective for SELECT statements, only on
61423 * statements which modify records. To retrieve the number of rows
61424 * returned from a SELECT, use {@link sybase_num_rows}.
61425 *
61426 * @param resource $link_identifier If the link identifier isn't
61427 *   specified, the last opened link is assumed.
61428 * @return int
61429 * @since PHP 4, PHP 5
61430 **/
61431function sybase_affected_rows($link_identifier){}
61432
61433/**
61434 * {@link sybase_close} closes the link to a Sybase database that's
61435 * associated with the specified link {@link link_identifier}.
61436 *
61437 * Note that this isn't usually necessary, as non-persistent open links
61438 * are automatically closed at the end of the script's execution.
61439 *
61440 * {@link sybase_close} will not close persistent links generated by
61441 * {@link sybase_pconnect}.
61442 *
61443 * @param resource $link_identifier If the link identifier isn't
61444 *   specified, the last opened link is assumed.
61445 * @return bool
61446 * @since PHP 4, PHP 5
61447 **/
61448function sybase_close($link_identifier){}
61449
61450/**
61451 * {@link sybase_connect} establishes a connection to a Sybase server.
61452 *
61453 * In case a second call is made to {@link sybase_connect} with the same
61454 * arguments, no new link will be established, but instead, the link
61455 * identifier of the already opened link will be returned.
61456 *
61457 * The link to the server will be closed as soon as the execution of the
61458 * script ends, unless it's closed earlier by explicitly calling {@link
61459 * sybase_close}.
61460 *
61461 * @param string $servername The servername argument has to be a valid
61462 *   servername that is defined in the 'interfaces' file.
61463 * @param string $username Sybase user name
61464 * @param string $password Password associated with {@link username}.
61465 * @param string $charset Specifies the charset for the connection
61466 * @param string $appname Specifies an appname for the Sybase
61467 *   connection. This allow you to make separate connections in the same
61468 *   script to the same database. This may come handy when you have
61469 *   started a transaction in your current connection, and you need to be
61470 *   able to do a separate query which cannot be performed inside this
61471 *   transaction.
61472 * @param bool $new Whether to open a new connection or use the
61473 *   existing one.
61474 * @return resource
61475 * @since PHP 4, PHP 5
61476 **/
61477function sybase_connect($servername, $username, $password, $charset, $appname, $new){}
61478
61479/**
61480 * {@link sybase_data_seek} moves the internal row pointer of the Sybase
61481 * result associated with the specified result identifier to pointer to
61482 * the specified row number. The next call to {@link sybase_fetch_row}
61483 * would return that row.
61484 *
61485 * @param resource $result_identifier
61486 * @param int $row_number
61487 * @return bool
61488 * @since PHP 4, PHP 5
61489 **/
61490function sybase_data_seek($result_identifier, $row_number){}
61491
61492/**
61493 * Using {@link sybase_deadlock_retry_count}, the number of retries can
61494 * be defined in cases of deadlocks. By default, every deadlock is
61495 * retried an infinite number of times or until the process is killed by
61496 * Sybase, the executing script is killed (for instance, by {@link
61497 * set_time_limit}) or the query succeeds.
61498 *
61499 * @param int $retry_count Values for retry_count -1 Retry forever
61500 *   (default) 0 Do not retry n Retry n times
61501 * @return void
61502 * @since PHP 4 >= 4.3.0, PHP 5
61503 **/
61504function sybase_deadlock_retry_count($retry_count){}
61505
61506/**
61507 * {@link sybase_fetch_array} is an extended version of {@link
61508 * sybase_fetch_row}. In addition to storing the data in the numeric
61509 * indices of the result array, it also stores the data in associative
61510 * indices, using the field names as keys.
61511 *
61512 * An important thing to note is that using {@link sybase_fetch_array} is
61513 * NOT significantly slower than using {@link sybase_fetch_row}, while it
61514 * provides a significant added value.
61515 *
61516 * @param resource $result
61517 * @return array
61518 * @since PHP 4, PHP 5
61519 **/
61520function sybase_fetch_array($result){}
61521
61522/**
61523 * {@link sybase_fetch_assoc} is a version of {@link sybase_fetch_row}
61524 * that uses column names instead of integers for indices in the result
61525 * array. Columns from different tables with the same names are returned
61526 * as name, name1, name2, ..., nameN.
61527 *
61528 * An important thing to note is that using {@link sybase_fetch_assoc} is
61529 * NOT significantly slower than using {@link sybase_fetch_row}, while it
61530 * provides a significant added value.
61531 *
61532 * @param resource $result
61533 * @return array
61534 * @since PHP 4 >= 4.3.0, PHP 5
61535 **/
61536function sybase_fetch_assoc($result){}
61537
61538/**
61539 * {@link sybase_fetch_field} can be used in order to obtain information
61540 * about fields in a certain query result.
61541 *
61542 * @param resource $result
61543 * @param int $field_offset If the field offset isn't specified, the
61544 *   next field that wasn't yet retrieved by {@link sybase_fetch_field}
61545 *   is retrieved.
61546 * @return object
61547 * @since PHP 4, PHP 5
61548 **/
61549function sybase_fetch_field($result, $field_offset){}
61550
61551/**
61552 * {@link sybase_fetch_object} is similar to {@link sybase_fetch_assoc},
61553 * with one difference - an object is returned, instead of an array.
61554 *
61555 * Speed-wise, the function is identical to {@link sybase_fetch_array},
61556 * and almost as quick as {@link sybase_fetch_row} (the difference is
61557 * insignificant).
61558 *
61559 * @param resource $result
61560 * @param mixed $object Use the second {@link object} to specify the
61561 *   type of object you want to return. If this parameter is omitted, the
61562 *   object will be of type stdClass.
61563 * @return object
61564 * @since PHP 4, PHP 5
61565 **/
61566function sybase_fetch_object($result, $object){}
61567
61568/**
61569 * {@link sybase_fetch_row} fetches one row of data from the result
61570 * associated with the specified result identifier.
61571 *
61572 * Subsequent call to {@link sybase_fetch_row} would return the next row
61573 * in the result set, or if there are no more rows.
61574 *
61575 * @param resource $result
61576 * @return array
61577 * @since PHP 4, PHP 5
61578 **/
61579function sybase_fetch_row($result){}
61580
61581/**
61582 * Seeks to the specified field offset. If the next call to {@link
61583 * sybase_fetch_field} won't include a field offset, this field would be
61584 * returned.
61585 *
61586 * @param resource $result
61587 * @param int $field_offset
61588 * @return bool
61589 * @since PHP 4, PHP 5
61590 **/
61591function sybase_field_seek($result, $field_offset){}
61592
61593/**
61594 * {@link sybase_free_result} only needs to be called if you are worried
61595 * about using too much memory while your script is running. All result
61596 * memory will automatically be freed when the script ends. You may call
61597 * {@link sybase_free_result} with the result identifier as an argument
61598 * and the associated result memory will be freed.
61599 *
61600 * @param resource $result
61601 * @return bool
61602 * @since PHP 4, PHP 5
61603 **/
61604function sybase_free_result($result){}
61605
61606/**
61607 * {@link sybase_get_last_message} returns the last message reported by
61608 * the server.
61609 *
61610 * @return string
61611 * @since PHP 4, PHP 5
61612 **/
61613function sybase_get_last_message(){}
61614
61615/**
61616 * {@link sybase_min_client_severity} sets the minimum client severity
61617 * level.
61618 *
61619 * @param int $severity
61620 * @return void
61621 * @since PHP 4, PHP 5
61622 **/
61623function sybase_min_client_severity($severity){}
61624
61625/**
61626 * {@link sybase_min_error_severity} sets the minimum error severity
61627 * level.
61628 *
61629 * @param int $severity
61630 * @return void
61631 * @since PHP 4, PHP 5
61632 **/
61633function sybase_min_error_severity($severity){}
61634
61635/**
61636 * {@link sybase_min_message_severity} sets the minimum message severity
61637 * level.
61638 *
61639 * @param int $severity
61640 * @return void
61641 * @since PHP 4, PHP 5
61642 **/
61643function sybase_min_message_severity($severity){}
61644
61645/**
61646 * {@link sybase_min_server_severity} sets the minimum server severity
61647 * level.
61648 *
61649 * @param int $severity
61650 * @return void
61651 * @since PHP 4, PHP 5
61652 **/
61653function sybase_min_server_severity($severity){}
61654
61655/**
61656 * {@link sybase_num_fields} returns the number of fields in a result
61657 * set.
61658 *
61659 * @param resource $result
61660 * @return int
61661 * @since PHP 4, PHP 5
61662 **/
61663function sybase_num_fields($result){}
61664
61665/**
61666 * {@link sybase_num_rows} returns the number of rows in a result set.
61667 *
61668 * @param resource $result
61669 * @return int
61670 * @since PHP 4, PHP 5
61671 **/
61672function sybase_num_rows($result){}
61673
61674/**
61675 * {@link sybase_pconnect} acts very much like {@link sybase_connect}
61676 * with two major differences.
61677 *
61678 * First, when connecting, the function would first try to find a
61679 * (persistent) link that's already open with the same host, username and
61680 * password. If one is found, an identifier for it will be returned
61681 * instead of opening a new connection.
61682 *
61683 * Second, the connection to the SQL server will not be closed when the
61684 * execution of the script ends. Instead, the link will remain open for
61685 * future use ({@link sybase_close} will not close links established by
61686 * {@link sybase_pconnect}).
61687 *
61688 * This type of links is therefore called 'persistent'.
61689 *
61690 * @param string $servername The servername argument has to be a valid
61691 *   servername that is defined in the 'interfaces' file.
61692 * @param string $username Sybase user name
61693 * @param string $password Password associated with {@link username}.
61694 * @param string $charset Specifies the charset for the connection
61695 * @param string $appname Specifies an appname for the Sybase
61696 *   connection. This allow you to make separate connections in the same
61697 *   script to the same database. This may come handy when you have
61698 *   started a transaction in your current connection, and you need to be
61699 *   able to do a separate query which cannot be performed inside this
61700 *   transaction.
61701 * @return resource
61702 * @since PHP 4, PHP 5
61703 **/
61704function sybase_pconnect($servername, $username, $password, $charset, $appname){}
61705
61706/**
61707 * {@link sybase_query} sends a query to the currently active database on
61708 * the server that's associated with the specified link identifier.
61709 *
61710 * @param string $query
61711 * @param resource $link_identifier If the link identifier isn't
61712 *   specified, the last opened link is assumed. If no link is open, the
61713 *   function tries to establish a link as if {@link sybase_connect} was
61714 *   called, and use it.
61715 * @return mixed
61716 * @since PHP 4, PHP 5
61717 **/
61718function sybase_query($query, $link_identifier){}
61719
61720/**
61721 * Returns the contents of the cell at the row and offset in the
61722 * specified Sybase result set.
61723 *
61724 * When working on large result sets, you should consider using one of
61725 * the functions that fetch an entire row (specified below). As these
61726 * functions return the contents of multiple cells in one function call,
61727 * they're MUCH quicker than sybase_result(). Also, note that specifying
61728 * a numeric offset for the field argument is much quicker than
61729 * specifying a fieldname or tablename.fieldname argument.
61730 *
61731 * Recommended high-performance alternatives: {@link sybase_fetch_row},
61732 * {@link sybase_fetch_array} and {@link sybase_fetch_object}.
61733 *
61734 * @param resource $result
61735 * @param int $row
61736 * @param mixed $field The field argument can be the field's offset, or
61737 *   the field's name, or the field's table dot field's name
61738 *   (tablename.fieldname). If the column name has been aliased ('select
61739 *   foo as bar from...'), use the alias instead of the column name.
61740 * @return string
61741 * @since PHP 4, PHP 5
61742 **/
61743function sybase_result($result, $row, $field){}
61744
61745/**
61746 * {@link sybase_select_db} sets the current active database on the
61747 * server that's associated with the specified link identifier.
61748 *
61749 * Every subsequent call to {@link sybase_query} will be made on the
61750 * active database.
61751 *
61752 * @param string $database_name
61753 * @param resource $link_identifier If no link identifier is specified,
61754 *   the last opened link is assumed. If no link is open, the function
61755 *   will try to establish a link as if {@link sybase_connect} was
61756 *   called, and use it.
61757 * @return bool
61758 * @since PHP 4, PHP 5
61759 **/
61760function sybase_select_db($database_name, $link_identifier){}
61761
61762/**
61763 * {@link sybase_set_message_handler} sets a user function to handle
61764 * messages generated by the server. You may specify the name of a global
61765 * function, or use an array to specify an object reference and a method
61766 * name.
61767 *
61768 * @param callback $handler The handler expects five arguments in the
61769 *   following order: message number, severity, state, line number and
61770 *   description. The first four are integers. The last is a string. If
61771 *   the function returns , PHP generates an ordinary error message.
61772 * @param resource $connection
61773 * @return bool
61774 * @since PHP 4 >= 4.3.0, PHP 5
61775 **/
61776function sybase_set_message_handler($handler, $connection){}
61777
61778/**
61779 * {@link sybase_unbuffered_query} sends a query to the currently active
61780 * database on the server that's associated with the specified link
61781 * identifier. If the link identifier isn't specified, the last opened
61782 * link is assumed. If no link is open, the function tries to establish a
61783 * link as if {@link sybase_connect} was called, and use it.
61784 *
61785 * Unlike {@link sybase_query}, {@link sybase_unbuffered_query} reads
61786 * only the first row of the result set. {@link sybase_fetch_array} and
61787 * similar function read more rows as needed. {@link sybase_data_seek}
61788 * reads up to the target row. The behavior may produce better
61789 * performance for large result sets.
61790 *
61791 * {@link sybase_num_rows} will only return the correct number of rows if
61792 * all result sets have been read. To Sybase, the number of rows is not
61793 * known and is therefore computed by the client implementation.
61794 *
61795 * @param string $query
61796 * @param resource $link_identifier
61797 * @param bool $store_result The optional {@link store_result} can be
61798 *   to indicate the resultsets shouldn't be fetched into memory, thus
61799 *   minimizing memory usage which is particularly interesting with very
61800 *   large resultsets.
61801 * @return resource
61802 * @since PHP 4 >= 4.3.0, PHP 5
61803 **/
61804function sybase_unbuffered_query($query, $link_identifier, $store_result){}
61805
61806/**
61807 * {@link symlink} creates a symbolic link to the existing {@link target}
61808 * with the specified name {@link link}.
61809 *
61810 * @param string $target Target of the link.
61811 * @param string $link The link name.
61812 * @return bool
61813 * @since PHP 4, PHP 5
61814 **/
61815function symlink($target, $link){}
61816
61817/**
61818 * {@link syslog} generates a log message that will be distributed by the
61819 * system logger.
61820 *
61821 * For information on setting up a user defined log handler, see the
61822 * syslog.conf 5 Unix manual page. More information on the syslog
61823 * facilities and option can be found in the man pages for syslog 3 on
61824 * Unix machines.
61825 *
61826 * @param int $priority {@link priority} is a combination of the
61827 *   facility and the level. Possible values are: {@link syslog}
61828 *   Priorities (in descending order) Constant Description LOG_EMERG
61829 *   system is unusable LOG_ALERT action must be taken immediately
61830 *   LOG_CRIT critical conditions LOG_ERR error conditions LOG_WARNING
61831 *   warning conditions LOG_NOTICE normal, but significant, condition
61832 *   LOG_INFO informational message LOG_DEBUG debug-level message
61833 * @param string $message The message to send, except that the two
61834 *   characters %m will be replaced by the error message string
61835 *   (strerror) corresponding to the present value of errno.
61836 * @return bool
61837 * @since PHP 4, PHP 5
61838 **/
61839function syslog($priority, $message){}
61840
61841/**
61842 * {@link system} is just like the C version of the function in that it
61843 * executes the given {@link command} and outputs the result.
61844 *
61845 * The {@link system} call also tries to automatically flush the web
61846 * server's output buffer after each line of output if PHP is running as
61847 * a server module.
61848 *
61849 * If you need to execute a command and have all the data from the
61850 * command passed directly back without any interference, use the {@link
61851 * passthru} function.
61852 *
61853 * @param string $command The command that will be executed.
61854 * @param int $return_var If the {@link return_var} argument is
61855 *   present, then the return status of the executed command will be
61856 *   written to this variable.
61857 * @return string
61858 * @since PHP 4, PHP 5
61859 **/
61860function system($command, &$return_var){}
61861
61862/**
61863 * Returns three samples representing the average system load (the number
61864 * of processes in the system run queue) over the last 1, 5 and 15
61865 * minutes, respectively.
61866 *
61867 * @return array
61868 * @since PHP 5 >= 5.1.3
61869 **/
61870function sys_getloadavg(){}
61871
61872/**
61873 * Returns the path of the directory PHP stores temporary files in by
61874 * default.
61875 *
61876 * @return string
61877 * @since PHP 5 >= 5.2.1
61878 **/
61879function sys_get_temp_dir(){}
61880
61881/**
61882 * {@link tan} returns the tangent of the {@link arg} parameter. The
61883 * {@link arg} parameter is in radians.
61884 *
61885 * @param float $arg The argument to process in radians
61886 * @return float
61887 * @since PHP 4, PHP 5
61888 **/
61889function tan($arg){}
61890
61891/**
61892 * Returns the hyperbolic tangent of {@link arg}, defined as
61893 * sinh(arg)/cosh(arg).
61894 *
61895 * @param float $arg The argument to process
61896 * @return float
61897 * @since PHP 4 >= 4.1.0, PHP 5
61898 **/
61899function tanh($arg){}
61900
61901/**
61902 * This function consults the /etc/hosts.allow and /etc/hosts.deny files
61903 * to check if access to service {@link daemon} should be granted or
61904 * denied for a client.
61905 *
61906 * @param string $daemon The service name.
61907 * @param string $address The client remote address. Can be either an
61908 *   IP address or a domain name.
61909 * @param string $user An optional user name.
61910 * @param bool $nodns If {@link address} looks like domain name then
61911 *   DNS is used to resolve it to IP address; set {@link nodns} to to
61912 *   avoid this.
61913 * @return bool
61914 * @since PECL tcpwrap >= 0.1.0
61915 **/
61916function tcpwrap_check($daemon, $address, $user, $nodns){}
61917
61918/**
61919 * Creates a file with a unique filename, with access permission set to
61920 * 0600, in the specified directory. If the directory does not exist,
61921 * {@link tempnam} may generate a file in the system's temporary
61922 * directory, and return the name of that.
61923 *
61924 * @param string $dir The directory where the temporary filename will
61925 *   be created.
61926 * @param string $prefix The prefix of the generated temporary
61927 *   filename.
61928 * @return string
61929 * @since PHP 4, PHP 5
61930 **/
61931function tempnam($dir, $prefix){}
61932
61933/**
61934 * This function sets the domain to search within when calls are made to
61935 * {@link gettext}, usually the named after an application.
61936 *
61937 * @param string $text_domain The new message domain, or to get the
61938 *   current setting without changing it
61939 * @return string
61940 * @since PHP 4, PHP 5
61941 **/
61942function textdomain($text_domain){}
61943
61944/**
61945 * {@link tidy_access_count} returns the number of accessibility warnings
61946 * found for the specified document.
61947 *
61948 * @param tidy $object
61949 * @return int
61950 * @since PHP 5, PECL tidy >= 0.5.2
61951 **/
61952function tidy_access_count($object){}
61953
61954/**
61955 * This function cleans and repairs the given tidy {@link object}.
61956 *
61957 * @param tidy $object
61958 * @return bool
61959 * @since PHP 5, PECL tidy >= 0.5.2
61960 **/
61961function tidy_clean_repair($object){}
61962
61963/**
61964 * Returns the number of errors encountered in the configuration of the
61965 * specified tidy {@link object}.
61966 *
61967 * @param tidy $object
61968 * @return int
61969 * @since PHP 5, PECL tidy >= 0.5.2
61970 **/
61971function tidy_config_count($object){}
61972
61973/**
61974 * Runs diagnostic tests on the given tidy {@link object}, adding some
61975 * more information about the document in the error buffer.
61976 *
61977 * @param tidy $object
61978 * @return bool
61979 * @since PHP 5, PECL tidy >= 0.5.2
61980 **/
61981function tidy_diagnose($object){}
61982
61983/**
61984 * Returns the number of Tidy errors encountered for the specified
61985 * document.
61986 *
61987 * @param tidy $object
61988 * @return int
61989 * @since PHP 5, PECL tidy >= 0.5.2
61990 **/
61991function tidy_error_count($object){}
61992
61993/**
61994 * Returns the value of the specified {@link option} for the specified
61995 * tidy {@link object}.
61996 *
61997 * @param tidy $object
61998 * @param string $option You will find a list with each configuration
61999 *   option and their types at: .
62000 * @return mixed
62001 * @since PHP 5, PECL tidy >= 0.5.2
62002 **/
62003function tidy_getopt($object, $option){}
62004
62005/**
62006 * Returns a tidyNode object starting from the <body> tag of the tidy
62007 * parse tree.
62008 *
62009 * @param tidy $object
62010 * @return tidyNode
62011 * @since PHP 5, PECL tidy 0.5.2-1.0
62012 **/
62013function tidy_get_body($object){}
62014
62015/**
62016 * Gets the list of the configuration options in use by the given tidy
62017 * {@link object}.
62018 *
62019 * @param tidy $object
62020 * @return array
62021 * @since PHP 5, PECL tidy >= 0.7.0
62022 **/
62023function tidy_get_config($object){}
62024
62025/**
62026 * Returns warnings and errors which occurred parsing the specified
62027 * document.
62028 *
62029 * @param tidy $object
62030 * @return string
62031 * @since PHP 5, PECL tidy >= 0.5.2
62032 **/
62033function tidy_get_error_buffer($object){}
62034
62035/**
62036 * Returns a tidyNode object starting from the <head> tag of the tidy
62037 * parse tree.
62038 *
62039 * @param tidy $object
62040 * @return tidyNode
62041 * @since PHP 5, PECL tidy 0.5.2-1.0.0
62042 **/
62043function tidy_get_head($object){}
62044
62045/**
62046 * Returns a tidyNode object starting from the <html> tag of the tidy
62047 * parse tree.
62048 *
62049 * @param tidy $object
62050 * @return tidyNode
62051 * @since PHP 5, PECL tidy 0.5.2-1.0.0
62052 **/
62053function tidy_get_html($object){}
62054
62055/**
62056 * Returns the detected HTML version for the specified tidy {@link
62057 * object}.
62058 *
62059 * @param tidy $object
62060 * @return int
62061 * @since PHP 5, PECL tidy >= 0.5.2
62062 **/
62063function tidy_get_html_ver($object){}
62064
62065/**
62066 * {@link tidy_get_opt_doc} returns the documentation for the given
62067 * option name.
62068 *
62069 * @param tidy $object
62070 * @param string $optname The option name
62071 * @return string
62072 * @since PHP 5 >= 5.1.0
62073 **/
62074function tidy_get_opt_doc($object, $optname){}
62075
62076/**
62077 * Gets a string with the repaired html.
62078 *
62079 * @param tidy $object
62080 * @return string
62081 * @since PHP 5, PECL tidy >= 0.5.2
62082 **/
62083function tidy_get_output($object){}
62084
62085/**
62086 * Gets the release date of the Tidy library.
62087 *
62088 * @return string
62089 * @since PHP 5, PECL tidy >= 0.5.2
62090 **/
62091function tidy_get_release(){}
62092
62093/**
62094 * Returns a tidyNode object representing the root of the tidy parse
62095 * tree.
62096 *
62097 * @param tidy $object
62098 * @return tidyNode
62099 * @since PHP 5, PECL tidy 0.5.2-1.0.0
62100 **/
62101function tidy_get_root($object){}
62102
62103/**
62104 * Returns the status for the specified tidy {@link object}.
62105 *
62106 * @param tidy $object
62107 * @return int
62108 * @since PHP 5, PECL tidy >= 0.5.2
62109 **/
62110function tidy_get_status($object){}
62111
62112/**
62113 * Tells if the document is a XHTML document.
62114 *
62115 * @param tidy $object
62116 * @return bool
62117 * @since PHP 5, PECL tidy >= 0.5.2
62118 **/
62119function tidy_is_xhtml($object){}
62120
62121/**
62122 * Tells if the document is a generic (non HTML/XHTML) XML document.
62123 *
62124 * @param tidy $object
62125 * @return bool
62126 * @since PHP 5, PECL tidy >= 0.5.2
62127 **/
62128function tidy_is_xml($object){}
62129
62130/**
62131 * Loads a Tidy configuration file, with the specified {@link encoding}.
62132 *
62133 * @param string $filename
62134 * @param string $encoding
62135 * @return void
62136 * @since PECL tidy >= 0.5.2
62137 **/
62138function tidy_load_config($filename, $encoding){}
62139
62140/**
62141 * Parses the given file.
62142 *
62143 * @param string $filename If the {@link filename} parameter is given,
62144 *   this function will also read that file and initialize the object
62145 *   with the file, acting like {@link tidy_parse_file}.
62146 * @param mixed $config The config {@link config} can be passed either
62147 *   as an array or as a string. If a string is passed, it is interpreted
62148 *   as the name of the configuration file, otherwise, it is interpreted
62149 *   as the options themselves. For an explanation about each option, see
62150 *   .
62151 * @param string $encoding The {@link encoding} parameter sets the
62152 *   encoding for input/output documents. The possible values for
62153 *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
62154 *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
62155 * @param bool $use_include_path Search for the file in the
62156 *   include_path.
62157 * @return tidy
62158 * @since PHP 5, PECL tidy >= 0.5.2
62159 **/
62160function tidy_parse_file($filename, $config, $encoding, $use_include_path){}
62161
62162/**
62163 * Parses a document stored in a string.
62164 *
62165 * @param string $input The data to be parsed.
62166 * @param mixed $config The config {@link config} can be passed either
62167 *   as an array or as a string. If a string is passed, it is interpreted
62168 *   as the name of the configuration file, otherwise, it is interpreted
62169 *   as the options themselves. For an explanation about each option,
62170 *   visit .
62171 * @param string $encoding The {@link encoding} parameter sets the
62172 *   encoding for input/output documents. The possible values for
62173 *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
62174 *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
62175 * @return tidy
62176 * @since PHP 5, PECL tidy >= 0.5.2
62177 **/
62178function tidy_parse_string($input, $config, $encoding){}
62179
62180/**
62181 * Repairs the given file and returns it as a string.
62182 *
62183 * @param string $filename The file to be repaired.
62184 * @param mixed $config The config {@link config} can be passed either
62185 *   as an array or as a string. If a string is passed, it is interpreted
62186 *   as the name of the configuration file, otherwise, it is interpreted
62187 *   as the options themselves. Check
62188 *   http://tidy.sourceforge.net/docs/quickref.html for an explanation
62189 *   about each option.
62190 * @param string $encoding The {@link encoding} parameter sets the
62191 *   encoding for input/output documents. The possible values for
62192 *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
62193 *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
62194 * @param bool $use_include_path Search for the file in the
62195 *   include_path.
62196 * @return string
62197 * @since PHP 5, PECL tidy >= 0.7.0
62198 **/
62199function tidy_repair_file($filename, $config, $encoding, $use_include_path){}
62200
62201/**
62202 * Repairs the given string.
62203 *
62204 * @param string $data The data to be repaired.
62205 * @param mixed $config The config {@link config} can be passed either
62206 *   as an array or as a string. If a string is passed, it is interpreted
62207 *   as the name of the configuration file, otherwise, it is interpreted
62208 *   as the options themselves. Check for an explanation about each
62209 *   option.
62210 * @param string $encoding The {@link encoding} parameter sets the
62211 *   encoding for input/output documents. The possible values for
62212 *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
62213 *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
62214 * @return string
62215 * @since PHP 5, PECL tidy >= 0.7.0
62216 **/
62217function tidy_repair_string($data, $config, $encoding){}
62218
62219/**
62220 * This function restores the Tidy configuration to the default values.
62221 *
62222 * @return bool
62223 * @since PECL tidy >= 0.7.0
62224 **/
62225function tidy_reset_config(){}
62226
62227/**
62228 * Saves current settings to the specified file. Only non-default values
62229 * are written.
62230 *
62231 * @param string $filename Path to the config file.
62232 * @return bool
62233 * @since PECL tidy >= 0.5.2
62234 **/
62235function tidy_save_config($filename){}
62236
62237/**
62238 * {@link tidy_setopt} updates the specified {@link option} with a new
62239 * {@link value}.
62240 *
62241 * @param string $option The tidy option name. A list of available
62242 *   configuration options may be found at: .
62243 * @param mixed $value The tidy option name.
62244 * @return bool
62245 * @since PECL tidy >= 0.5.2
62246 **/
62247function tidy_setopt($option, $value){}
62248
62249/**
62250 * Sets the encoding for input/output documents.
62251 *
62252 * @param string $encoding The {@link encoding} parameter sets the
62253 *   encoding for input/output documents. The possible values for
62254 *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
62255 *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
62256 * @return bool
62257 * @since PECL tidy >= 0.5.2
62258 **/
62259function tidy_set_encoding($encoding){}
62260
62261/**
62262 * Returns the number of Tidy warnings encountered for the specified
62263 * document.
62264 *
62265 * @param tidy $object
62266 * @return int
62267 * @since PHP 5, PECL tidy >= 0.5.2
62268 **/
62269function tidy_warning_count($object){}
62270
62271/**
62272 * Returns the current time measured in the number of seconds since the
62273 * Unix Epoch (January 1 1970 00:00:00 GMT).
62274 *
62275 * @return int
62276 * @since PHP 4, PHP 5
62277 **/
62278function time(){}
62279
62280/**
62281 * @return array
62282 * @since PHP 5 >= 5.1.0
62283 **/
62284function timezone_abbreviations_list(){}
62285
62286/**
62287 * @param int $what One of DateTimeZone class constants.
62288 * @param string $country A two-letter ISO 3166-1 compatible country
62289 *   code.
62290 * @return array
62291 * @since PHP 5 >= 5.1.0
62292 **/
62293function timezone_identifiers_list($what, $country){}
62294
62295/**
62296 * Returns location information for a timezone, including country code,
62297 * latitude/longitude and comments.
62298 *
62299 * @return array
62300 * @since PHP 5 >= 5.3.0
62301 **/
62302function timezone_location_get(){}
62303
62304/**
62305 * @param string $abbr Time zone abbreviation.
62306 * @param int $gmtOffset Offset from GMT in seconds. Defaults to -1
62307 *   which means that first found time zone corresponding to {@link abbr}
62308 *   is returned. Otherwise exact offset is searched and only if not
62309 *   found then the first time zone with any offset is returned.
62310 * @param int $isdst Daylight saving time indicator. If {@link abbr}
62311 *   doesn't exist then the time zone is searched solely by {@link
62312 *   offset} and {@link isdst}.
62313 * @return string
62314 * @since PHP 5 >= 5.1.3
62315 **/
62316function timezone_name_from_abbr($abbr, $gmtOffset, $isdst){}
62317
62318/**
62319 * Returns the name of the timezone.
62320 *
62321 * @return string
62322 * @since PHP 5 >= 5.1.0
62323 **/
62324function timezone_name_get(){}
62325
62326/**
62327 * This function returns the offset to GMT for the date/time specified in
62328 * the {@link datetime} parameter. The GMT offset is calculated with the
62329 * timezone information contained in the DateTimeZone object being used.
62330 *
62331 * @param DateTimeZone $object DateTime that contains the date/time to
62332 *   compute the offset from.
62333 * @param DateTime $datetime
62334 * @return int
62335 * @since PHP 5 >= 5.1.0
62336 **/
62337function timezone_offset_get($object, $datetime){}
62338
62339/**
62340 * Creates new DateTimeZone object.
62341 *
62342 * @param string $timezone One of timezones.
62343 * @return DateTimeZone
62344 * @since PHP 5 >= 5.1.0
62345 **/
62346function timezone_open($timezone){}
62347
62348/**
62349 * @param DateTimeZone $object Begin timestamp.
62350 * @param int $timestamp_begin End timestamp.
62351 * @param int $timestamp_end
62352 * @return array
62353 * @since PHP 5 >= 5.2.0
62354 **/
62355function timezone_transitions_get($object, $timestamp_begin, $timestamp_end){}
62356
62357/**
62358 * Returns the current version of the timezonedb.
62359 *
62360 * @return string
62361 * @since PHP 5 >= 5.3.0
62362 **/
62363function timezone_version_get(){}
62364
62365/**
62366 * Delays program execution for the given number of {@link seconds} and
62367 * {@link nanoseconds}.
62368 *
62369 * @param int $seconds Must be a positive integer.
62370 * @param int $nanoseconds Must be a positive integer less than 1
62371 *   billion.
62372 * @return mixed
62373 * @since PHP 5
62374 **/
62375function time_nanosleep($seconds, $nanoseconds){}
62376
62377/**
62378 * Makes the script sleep until the specified {@link timestamp}.
62379 *
62380 * @param float $timestamp The timestamp when the script should wake.
62381 * @return bool
62382 * @since PHP 5 >= 5.1.0
62383 **/
62384function time_sleep_until($timestamp){}
62385
62386/**
62387 * Creates a temporary file with a unique name in read-write (w+) mode
62388 * and returns a file handle .
62389 *
62390 * The file is automatically removed when closed (using {@link fclose}),
62391 * or when the script ends.
62392 *
62393 * For details, consult your system documentation on the tmpfile(3)
62394 * function, as well as the stdio.h header file.
62395 *
62396 * @return resource
62397 * @since PHP 4, PHP 5
62398 **/
62399function tmpfile(){}
62400
62401/**
62402 * {@link token_get_all} parses the given {@link source} string into PHP
62403 * language tokens using the Zend engines lexical scanner.
62404 *
62405 * For a list of parser tokens, see , or use {@link token_name} to
62406 * translate a token value into its string representation.
62407 *
62408 * @param string $source The PHP source to parse.
62409 * @return array
62410 * @since PHP 4 >= 4.2.0, PHP 5
62411 **/
62412function token_get_all($source){}
62413
62414/**
62415 * {@link token_name} gets the symbolic name for a PHP {@link token}
62416 * value.
62417 *
62418 * @param int $token The token value.
62419 * @return string
62420 * @since PHP 4 >= 4.2.0, PHP 5
62421 **/
62422function token_name($token){}
62423
62424/**
62425 * Attempts to set the access and modification times of the file named in
62426 * the {@link filename} parameter to the value given in {@link time}.
62427 * Note that the access time is always modified, regardless of the number
62428 * of parameters.
62429 *
62430 * If the file does not exist, it will be created.
62431 *
62432 * @param string $filename The name of the file being touched.
62433 * @param int $time The touch time. If {@link time} is not supplied,
62434 *   the current system time is used.
62435 * @param int $atime If present, the access time of the given filename
62436 *   is set to the value of {@link atime}. Otherwise, it is set to {@link
62437 *   time}.
62438 * @return bool
62439 * @since PHP 4, PHP 5
62440 **/
62441function touch($filename, $time, $atime){}
62442
62443/**
62444 * Used to trigger a user error condition, it can be used by in
62445 * conjunction with the built-in error handler, or with a user defined
62446 * function that has been set as the new error handler ({@link
62447 * set_error_handler}).
62448 *
62449 * This function is useful when you need to generate a particular
62450 * response to an exception at runtime.
62451 *
62452 * @param string $error_msg The designated error message for this
62453 *   error. It's limited to 1024 characters in length. Any additional
62454 *   characters beyond 1024 will be truncated.
62455 * @param int $error_type The designated error type for this error. It
62456 *   only works with the E_USER family of constants, and will default to
62457 *   E_USER_NOTICE.
62458 * @return bool
62459 * @since PHP 4 >= 4.0.1, PHP 5
62460 **/
62461function trigger_error($error_msg, $error_type){}
62462
62463/**
62464 * This function returns a string with whitespace stripped from the
62465 * beginning and end of {@link str}. Without the second parameter, {@link
62466 * trim} will strip these characters: " " (ASCII 32 (0x20)), an ordinary
62467 * space. "\t" (ASCII 9 (0x09)), a tab. "\n" (ASCII 10 (0x0A)), a new
62468 * line (line feed). "\r" (ASCII 13 (0x0D)), a carriage return. "\0"
62469 * (ASCII 0 (0x00)), the NUL-byte. "\x0B" (ASCII 11 (0x0B)), a vertical
62470 * tab.
62471 *
62472 * @param string $str The string that will be trimmed.
62473 * @param string $charlist Optionally, the stripped characters can also
62474 *   be specified using the {@link charlist} parameter. Simply list all
62475 *   characters that you want to be stripped. With .. you can specify a
62476 *   range of characters.
62477 * @return string
62478 * @since PHP 4, PHP 5
62479 **/
62480function trim($str, $charlist){}
62481
62482/**
62483 * This function sorts an array such that array indices maintain their
62484 * correlation with the array elements they are associated with, using a
62485 * user-defined comparison function.
62486 *
62487 * This is used mainly when sorting associative arrays where the actual
62488 * element order is significant.
62489 *
62490 * @param array $array The input array.
62491 * @param callback $cmp_function See {@link usort} and {@link uksort}
62492 *   for examples of user-defined comparison functions.
62493 * @return bool
62494 * @since PHP 4, PHP 5
62495 **/
62496function uasort(&$array, $cmp_function){}
62497
62498/**
62499 * Returns a string with the first character of {@link str} capitalized,
62500 * if that character is alphabetic.
62501 *
62502 * Note that 'alphabetic' is determined by the current locale. For
62503 * instance, in the default "C" locale characters such as umlaut-a ()
62504 * will not be converted.
62505 *
62506 * @param string $str The input string.
62507 * @return string
62508 * @since PHP 4, PHP 5
62509 **/
62510function ucfirst($str){}
62511
62512/**
62513 * Returns a string with the first character of each word in {@link str}
62514 * capitalized, if that character is alphabetic.
62515 *
62516 * The definition of a word is any string of characters that is
62517 * immediately after a whitespace (These are: space, form-feed, newline,
62518 * carriage return, horizontal tab, and vertical tab).
62519 *
62520 * @param string $str The input string.
62521 * @return string
62522 * @since PHP 4, PHP 5
62523 **/
62524function ucwords($str){}
62525
62526/**
62527 * {@link udm_add_search_limit} adds search restrictions.
62528 *
62529 * @param resource $agent A link to Agent, received after call to
62530 *   {@link udm_alloc_agent}.
62531 * @param int $var Defines the parameter, indicating limits. Possible
62532 *   {@link var} values: UDM_LIMIT_URL - defines document URL limitations
62533 *   to limit the search through subsection of the database. It supports
62534 *   SQL % and _ LIKE wildcards, where % matches any number of
62535 *   characters, even zero characters, and _ matches exactly one
62536 *   character. E.g. http://www.example.___/catalog may stand for
62537 *   http://www.example.com/catalog and http://www.example.net/catalog.
62538 *   UDM_LIMIT_TAG - defines site TAG limitations. In indexer-conf you
62539 *   can assign specific TAGs to various sites and parts of a site. Tags
62540 *   in mnoGoSearch 3.1.x are lines, that may contain metasymbols % and
62541 *   _. Metasymbols allow searching among groups of tags. E.g. there are
62542 *   links with tags ABCD and ABCE, and search restriction is by ABC_ -
62543 *   the search will be made among both of the tags. UDM_LIMIT_LANG -
62544 *   defines document language limitations. UDM_LIMIT_CAT - defines
62545 *   document category limitations. Categories are similar to tag
62546 *   feature, but nested. So you can have one category inside another and
62547 *   so on. You have to use two characters for each level. Use a hex
62548 *   number going from 0-F or a 36 base number going from 0-Z. Therefore
62549 *   a top-level category like 'Auto' would be 01. If it has a
62550 *   subcategory like 'Ford', then it would be 01 (the parent category)
62551 *   and then 'Ford' which we will give 01. Put those together and you
62552 *   get 0101. If 'Auto' had another subcategory named 'VW', then it's id
62553 *   would be 01 because it belongs to the 'Ford' category and then 02
62554 *   because it's the next category. So it's id would be 0102. If VW had
62555 *   a sub category called 'Engine' then it's id would start at 01 again
62556 *   and it would get the 'VW' id 02 and 'Auto' id of 01, making it
62557 *   010201. If you want to search for sites under that category then you
62558 *   pass it cat=010201 in the URL. UDM_LIMIT_DATE - defines limitation
62559 *   by date the document was modified. Format of parameter value: a
62560 *   string with first character < or >, then with no space - date in
62561 *   unixtime format, for example:
62562 *
62563 *   <?php udm_add_search_limit($udm, UDM_LIMIT_DATE, "&lt;908012006");
62564 *   ?>
62565 *
62566 *   If > character is used, then the search will be restricted to those
62567 *   documents having a modification date greater than entered, if <,
62568 *   then smaller.
62569 * @param string $val Defines the value of the current parameter.
62570 * @return bool
62571 * @since PHP 4 >= 4.0.5, PHP 5 = 1.0.0
62572 **/
62573function udm_add_search_limit($agent, $var, $val){}
62574
62575/**
62576 * Allocate a mnoGoSearch session.
62577 *
62578 * @param string $dbaddr {@link dbaddr} - URL-style database
62579 *   description, with options (type, host, database name, port, user and
62580 *   password) to connect to SQL database. Do not matter for built-in
62581 *   text files support. Format for {@link dbaddr}:
62582 *   DBType:[//[DBUser[:DBPass]@]DBHost[:DBPort]]/DBName/. Currently
62583 *   supported DBType values are: mysql, pgsql, msql, solid, mssql,
62584 *   oracle, and ibase. Actually, it does not matter for native libraries
62585 *   support, but ODBC users should specify one of the supported values.
62586 *   If your database type is not supported, you may use unknown instead.
62587 * @param string $dbmode {@link dbmode} - You may select the SQL
62588 *   database mode of words storage. Possible values of {@link dbmode}
62589 *   are: single, multi, crc, or crc-multi. When single is specified, all
62590 *   words are stored in the same table. If multi is selected, words will
62591 *   be located in different tables depending of their lengths. "multi"
62592 *   mode is usually faster, but requires more tables in the database. If
62593 *   "crc" mode is selected, mnoGoSearch will store 32 bit integer word
62594 *   IDs calculated by CRC32 algorithm instead of words. This mode
62595 *   requires less disk space and it is faster comparing with "single"
62596 *   and "multi" modes. crc-multi uses the same storage structure with
62597 *   the "crc" mode, but also stores words in different tables depending
62598 *   on words lengths like in "multi" mode.
62599 * @return resource
62600 * @since PHP 4 >= 4.0.5, PHP 5 = 1.0.0
62601 **/
62602function udm_alloc_agent($dbaddr, $dbmode){}
62603
62604/**
62605 * {@link udm_alloc_agent_array} will create an agent with multiple
62606 * database connections.
62607 *
62608 * @param array $databases The array {@link databases} must contain one
62609 *   database URL per element, analog to the first parameter of {@link
62610 *   udm_alloc_agent}.
62611 * @return resource
62612 * @since PHP 4 >= 4.3.3, PHP 5 = 1.0.0
62613 **/
62614function udm_alloc_agent_array($databases){}
62615
62616/**
62617 * Gets the mnoGoSearch API version.
62618 *
62619 * This function allows the user to identify which API functions are
62620 * available, e.g. {@link udm_get_doc_count} function is only available
62621 * in mnoGoSearch 3.1.11 or later.
62622 *
62623 * @return int
62624 * @since PHP 4 >= 4.0.5, PHP 5 = 1.0.0
62625 **/
62626function udm_api_version(){}
62627
62628/**
62629 * Gets all the categories on the same level with the current one.
62630 *
62631 * The function can be useful for developing categories tree browser.
62632 *
62633 * @param resource $agent A link to Agent, received after call to
62634 *   {@link udm_alloc_agent}.
62635 * @param string $category
62636 * @return array
62637 * @since PHP 4 >= 4.0.6, PHP 5 = 1.0.0
62638 **/
62639function udm_cat_list($agent, $category){}
62640
62641/**
62642 * Returns an array describing the path in the categories tree from the
62643 * tree root to the current one, specified by {@link category}.
62644 *
62645 * @param resource $agent A link to Agent, received after call to
62646 *   {@link udm_alloc_agent}.
62647 * @param string $category
62648 * @return array
62649 * @since PHP 4 >= 4.0.6, PHP 5 = 1.0.0
62650 **/
62651function udm_cat_path($agent, $category){}
62652
62653/**
62654 * @param resource $agent
62655 * @param string $charset
62656 * @return bool
62657 * @since PHP 4 >= 4.2.0, PHP 5 = 1.0.0
62658 **/
62659function udm_check_charset($agent, $charset){}
62660
62661/**
62662 * @param resource $agent
62663 * @param int $link
62664 * @param string $doc_id
62665 * @return int
62666 * @since PHP 4 >= 4.2.0
62667 **/
62668function udm_check_stored($agent, $link, $doc_id){}
62669
62670/**
62671 * {@link udm_clear_search_limits} resets defined search limitations.
62672 *
62673 * @param resource $agent A link to Agent, received after call to
62674 *   {@link udm_alloc_agent}.
62675 * @return bool
62676 * @since PHP 4 >= 4.0.5, PHP 5 = 1.0.0
62677 **/
62678function udm_clear_search_limits($agent){}
62679
62680/**
62681 * @param resource $agent
62682 * @param int $link
62683 * @return int
62684 * @since PHP 4 >= 4.2.0
62685 **/
62686function udm_close_stored($agent, $link){}
62687
62688/**
62689 * @param resource $agent
62690 * @param string $str
62691 * @return int
62692 * @since PHP 4 >= 4.2.0, PHP 5 = 1.0.0
62693 **/
62694function udm_crc32($agent, $str){}
62695
62696/**
62697 * Receiving numeric agent error code.
62698 *
62699 * @param resource $agent A link to Agent, received after call to
62700 *   {@link udm_alloc_agent}.
62701 * @return int
62702 * @since PHP 4 >= 4.0.5, PHP 5 = 1.0.0
62703 **/
62704function udm_errno($agent){}
62705
62706/**
62707 * Gets the agent error message.
62708 *
62709 * @param resource $agent A link to Agent, received after call to
62710 *   {@link udm_alloc_agent}.
62711 * @return string
62712 * @since PHP 4 >= 4.0.5, PHP 5 = 1.0.0
62713 **/
62714function udm_error($agent){}
62715
62716/**
62717 * Performs a search.
62718 *
62719 * The search itself. The first argument - session, the next one - query
62720 * itself. To find something just type words you want to find and press
62721 * SUBMIT button. For example, "mysql odbc". You should not use quotes "
62722 * in query, they are written here only to divide a query from other
62723 * text. mnoGoSearch will find all documents that contain word "mysql"
62724 * and/or word "odbc". Best documents having bigger weights will be
62725 * displayed first. If you use search mode ALL, search will return
62726 * documents that contain both (or more) words you entered. In case you
62727 * use mode ANY, the search will return list of documents that contain
62728 * any of the words you entered. If you want more advanced results you
62729 * may use query language. You should select "bool" match mode in the
62730 * search from.
62731 *
62732 * @param resource $agent A link to Agent, received after call to
62733 *   {@link udm_alloc_agent}.
62734 * @param string $query mnoGoSearch understands the following boolean
62735 *   operators: & - logical AND. For example, mysql & odbc. mnoGoSearch
62736 *   will find any URLs that contain both mysql and odbc. | - logical OR.
62737 *   For example mysql|odbc. mnoGoSearch will find any URLs, that contain
62738 *   word mysql or word odbc. ~ - logical NOT. For example mysql & ~odbc.
62739 *   mnoGoSearch will find URLs that contain word mysql and do not
62740 *   contain word odbc at the same time. Note that ~ just excludes given
62741 *   word from results. Query ~odbc will find nothing! () - group command
62742 *   to compose more complex queries. For example (mysql | msql) &
62743 *   ~postgres. Query language is simple and powerful at the same time.
62744 *   Just consider query as usual boolean expression.
62745 * @return resource
62746 * @since PHP 4 >= 4.0.5, PHP 5 = 1.0.0
62747 **/
62748function udm_find($agent, $query){}
62749
62750/**
62751 * Freeing up memory allocated for agent session.
62752 *
62753 * @param resource $agent A link to Agent, received after call to
62754 *   {@link udm_alloc_agent}.
62755 * @return int
62756 * @since PHP 4 >= 4.0.5, PHP 5 = 1.0.0
62757 **/
62758function udm_free_agent($agent){}
62759
62760/**
62761 * Frees the memory allocated for ispell data.
62762 *
62763 * @param int $agent A link to Agent, received after call to {@link
62764 *   udm_alloc_agent}.
62765 * @return bool
62766 * @since PHP 4 >= 4.0.5, PHP 5 = 1.0.0
62767 **/
62768function udm_free_ispell_data($agent){}
62769
62770/**
62771 * Freeing up memory allocated for results.
62772 *
62773 * @param resource $res A link to a result identifier, received after
62774 *   call to {@link udm_find}.
62775 * @return bool
62776 * @since PHP 4 >= 4.0.5, PHP 5 = 1.0.0
62777 **/
62778function udm_free_res($res){}
62779
62780/**
62781 * {@link udm_get_doc_count} returns the number of documents in the
62782 * database.
62783 *
62784 * @param resource $agent A link to Agent, received after call to
62785 *   {@link udm_alloc_agent}.
62786 * @return int
62787 * @since PHP 4 >= 4.0.5, PHP 5 = 1.0.0
62788 **/
62789function udm_get_doc_count($agent){}
62790
62791/**
62792 * Fetch a mnoGoSearch result field.
62793 *
62794 * @param resource $res {@link res} - a link to result identifier,
62795 *   received after call to {@link udm_find}.
62796 * @param int $row {@link row} - the number of the link on the current
62797 *   page. May have values from 0 to {@link UDM_PARAM_NUM_ROWS-1}.
62798 * @param int $field {@link field} - field identifier, may have the
62799 *   following values: UDM_FIELD_URL - document URL field
62800 *   UDM_FIELD_CONTENT - document Content-type field (for example,
62801 *   text/html). UDM_FIELD_CATEGORY - document category field. Use {@link
62802 *   udm_cat_path} to get full path to current category from the
62803 *   categories tree root. (This parameter is available only in PHP 4.0.6
62804 *   or later). UDM_FIELD_TITLE - document title field.
62805 *   UDM_FIELD_KEYWORDS - document keywords field (from META KEYWORDS
62806 *   tag). UDM_FIELD_DESC - document description field (from META
62807 *   DESCRIPTION tag). UDM_FIELD_TEXT - document body text (the first
62808 *   couple of lines to give an idea of what the document is about).
62809 *   UDM_FIELD_SIZE - document size. UDM_FIELD_URLID - unique URL ID of
62810 *   the link. UDM_FIELD_RATING - page rating (as calculated by
62811 *   mnoGoSearch). UDM_FIELD_MODIFIED - last-modified field in unixtime
62812 *   format. UDM_FIELD_ORDER - the number of the current document in set
62813 *   of found documents. UDM_FIELD_CRC - document CRC.
62814 * @return string
62815 * @since PHP 4 >= 4.0.5, PHP 5 = 1.0.0
62816 **/
62817function udm_get_res_field($res, $row, $field){}
62818
62819/**
62820 * Gets the mnoGoSearch result parameters.
62821 *
62822 * @param resource $res {@link res} - a link to result identifier,
62823 *   received after call to {@link udm_find}.
62824 * @param int $param {@link param} - parameter identifier, may have the
62825 *   following values: UDM_PARAM_NUM_ROWS - number of received found
62826 *   links on the current page. It is equal to UDM_PARAM_PAGE_SIZE for
62827 *   all search pages, on the last page - the rest of links.
62828 *   UDM_PARAM_FOUND - total number of results matching the query.
62829 *   UDM_PARAM_WORDINFO - information on the words found. E.g. search for
62830 *   "a good book" will return "a: stopword, good:5637, book: 120"
62831 *   UDM_PARAM_SEARCHTIME - search time in seconds. UDM_PARAM_FIRST_DOC -
62832 *   the number of the first document displayed on current page.
62833 *   UDM_PARAM_LAST_DOC - the number of the last document displayed on
62834 *   current page.
62835 * @return string
62836 * @since PHP 4 >= 4.0.5, PHP 5 = 1.0.0
62837 **/
62838function udm_get_res_param($res, $param){}
62839
62840/**
62841 * {@link udm_hash32} will take a string {@link str} and return a quite
62842 * unique 32-bit hash number from it.
62843 *
62844 * @param resource $agent A link to Agent, received after call to
62845 *   {@link udm_alloc_agent}.
62846 * @param string $str The input string.
62847 * @return int
62848 * @since PHP 4 >= 4.3.3, PHP 5 = 1.0.0
62849 **/
62850function udm_hash32($agent, $str){}
62851
62852/**
62853 * {@link udm_load_ispell_data} loads ispell data.
62854 *
62855 * After using this function to free memory allocated for ispell data,
62856 * please use {@link udm_free_ispell_data}, even if you use
62857 * UDM_ISPELL_TYPE_SERVER mode.
62858 *
62859 * @param resource $agent A link to Agent, received after call to
62860 *   {@link udm_alloc_agent}.
62861 * @param int $var Indicates the source for ispell data. May have the
62862 *   following values: UDM_ISPELL_TYPE_DB - indicates that ispell data
62863 *   should be loaded from SQL. In this case, parameters {@link val1} and
62864 *   {@link val2} are ignored and should be left blank. {@link flag}
62865 *   should be equal to 1. {@link flag} indicates that after loading
62866 *   ispell data from defined source it should be sorted (it is necessary
62867 *   for correct functioning of ispell). In case of loading ispell data
62868 *   from files there may be several calls to {@link
62869 *   udm_load_ispell_data}, and there is no sense to sort data after
62870 *   every call, but only after the last one. Since in db mode all the
62871 *   data is loaded by one call, this parameter should have the value 1.
62872 *   In this mode in case of error, e.g. if ispell tables are absent, the
62873 *   function will return and code and error message will be accessible
62874 *   through {@link udm_error} and {@link udm_errno}.
62875 *   UDM_ISPELL_TYPE_AFFIX - indicates that ispell data should be loaded
62876 *   from file and initiates loading affixes file. In this case {@link
62877 *   val1} defines double letter language code for which affixes are
62878 *   loaded, and {@link val2} - file path. Please note, that if a
62879 *   relative path entered, the module looks for the file not in
62880 *   UDM_CONF_DIR, but in relation to current path, i.e. to the path
62881 *   where the script is executed. In case of error in this mode, e.g. if
62882 *   file is absent, the function will return , and an error message will
62883 *   be displayed. Error message text cannot be accessed through {@link
62884 *   udm_error} and {@link udm_errno}, since those functions can only
62885 *   return messages associated with SQL. Please, see {@link flag}
62886 *   parameter description in UDM_ISPELL_TYPE_DB. {@link
62887 *   udm_load_ispell_data} example
62888 *
62889 *   <?php if ((! udm_load_ispell_data($udm, UDM_ISPELL_TYPE_AFFIX, 'en',
62890 *   '/opt/ispell/en.aff', 0)) || (! udm_load_ispell_data($udm,
62891 *   UDM_ISPELL_TYPE_AFFIX, 'ru', '/opt/ispell/ru.aff', 0)) || (!
62892 *   udm_load_ispell_data($udm, UDM_ISPELL_TYPE_SPELL, 'en',
62893 *   '/opt/ispell/en.dict', 0)) || (! udm_load_ispell_data($udm,
62894 *   UDM_ISPELL_TYPE_SPELL, 'ru', '/opt/ispell/ru.dict', 1))) { exit; }
62895 *   ?>
62896 *
62897 *   {@link flag} is equal to 1 only in the last call.
62898 *   UDM_ISPELL_TYPE_SPELL - indicates that ispell data should be loaded
62899 *   from file and initiates loading of ispell dictionary file. In this
62900 *   case {@link val1} defines double letter language code for which
62901 *   affixes are loaded, and {@link val2} - file path. Please note, that
62902 *   if a relative path entered, the module looks for the file not in
62903 *   UDM_CONF_DIR, but in relation to current path, i.e. to the path
62904 *   where the script is executed. In case of error in this mode, e.g. if
62905 *   file is absent, the function will return , and an error message will
62906 *   be displayed. Error message text cannot be accessed through {@link
62907 *   udm_error} and {@link udm_errno}, since those functions can only
62908 *   return messages associated with SQL. Please, see {@link flag}
62909 *   parameter description in UDM_ISPELL_TYPE_DB.
62910 *
62911 *   <?php if ((! udm_load_ispell_data($udm, UDM_ISPELL_TYPE_AFFIX, 'en',
62912 *   '/opt/ispell/en.aff', 0)) || (! udm_load_ispell_data($udm,
62913 *   UDM_ISPELL_TYPE_AFFIX, 'ru', '/opt/ispell/ru.aff', 0)) || (!
62914 *   udm_load_ispell_data($udm, UDM_ISPELL_TYPE_SPELL, 'en',
62915 *   '/opt/ispell/en.dict', 0)) || (! udm_load_ispell_data($udm,
62916 *   UDM_ISPELL_TYPE_SPELL, 'ru', '/opt/ispell/ru.dict', 1))) { exit; }
62917 *   ?>
62918 *
62919 *   {@link flag} is equal to 1 only in the last call.
62920 *   UDM_ISPELL_TYPE_SERVER - enables spell server support. {@link val1}
62921 *   parameter indicates address of the host running spell server. {@link
62922 *   val2} ` is not used yet, but in future releases it is going to
62923 *   indicate number of port used by spell server. {@link flag} parameter
62924 *   in this case is not needed since ispell data is stored on
62925 *   spellserver already sorted. Spelld server reads spell-data from a
62926 *   separate configuration file (/usr/local/mnogosearch/etc/spelld.conf
62927 *   by default), sorts it and stores in memory. With clients server
62928 *   communicates in two ways: to indexer all the data is transferred (so
62929 *   that indexer starts faster), from search.cgi server receives word to
62930 *   normalize and then passes over to client (search.cgi) list of
62931 *   normalized word forms. This allows fastest, compared to db and text
62932 *   modes processing of search queries (by omitting loading and sorting
62933 *   all the spell data). {@link udm_load_ispell_data} function in
62934 *   UDM_ISPELL_TYPE_SERVER mode does not actually load ispell data, but
62935 *   only defines server address. In fact, server is automatically used
62936 *   by {@link udm_find} function when performing search. In case of
62937 *   errors, e.g. if spellserver is not running or invalid host
62938 *   indicated, there are no messages returned and ispell conversion does
62939 *   not work. This function is available in mnoGoSearch 3.1.12 or later.
62940 *   Example:
62941 *
62942 *   <?php if (!udm_load_ispell_data($udm, UDM_ISPELL_TYPE_SERVER, '',
62943 *   '', 1)) { echo "Error loading ispell data from server<br />\n";
62944 *   exit; } ?>
62945 *
62946 *   The fastest mode is UDM_ISPELL_TYPE_SERVER. UDM_ISPELL_TYPE_TEXT is
62947 *   slower and UDM_ISPELL_TYPE_DB is the slowest. The above pattern is
62948 *   for mnoGoSearch 3.1.10 - 3.1.11. It is planned to speed up DB mode
62949 *   in future versions and it is going to be faster than TEXT mode.
62950 * @param string $val1
62951 * @param string $val2
62952 * @param int $flag
62953 * @return bool
62954 * @since PHP 4 >= 4.0.5, PHP 5 = 1.0.0
62955 **/
62956function udm_load_ispell_data($agent, $var, $val1, $val2, $flag){}
62957
62958/**
62959 * @param resource $agent
62960 * @param string $storedaddr
62961 * @return int
62962 * @since PHP 4 >= 4.2.0
62963 **/
62964function udm_open_stored($agent, $storedaddr){}
62965
62966/**
62967 * Defines mnoGoSearch session parameters.
62968 *
62969 * @param resource $agent A link to Agent, received after call to
62970 *   {@link udm_alloc_agent}.
62971 * @param int $var The following parameters and their values are
62972 *   available: UDM_PARAM_PAGE_NUM - used to choose search results page
62973 *   number (results are returned by pages beginning from 0, with
62974 *   UDM_PARAM_PAGE_SIZE results per page). UDM_PARAM_PAGE_SIZE - number
62975 *   of search results displayed on one page. UDM_PARAM_SEARCH_MODE -
62976 *   search mode. The following values available: UDM_MODE_ALL - search
62977 *   for all words; UDM_MODE_ANY - search for any word; UDM_MODE_PHRASE -
62978 *   phrase search; UDM_MODE_BOOL - boolean search. See {@link udm_find}
62979 *   for details on boolean search. UDM_PARAM_CACHE_MODE - turns on or
62980 *   off search result cache mode. When enabled, the search engine will
62981 *   store search results to disk. In case a similar search is performed
62982 *   later, the engine will take results from the cache for faster
62983 *   performance. Available values: UDM_CACHE_ENABLED,
62984 *   UDM_CACHE_DISABLED. UDM_PARAM_TRACK_MODE - turns on or off
62985 *   trackquery mode. Since version 3.1.2 mnoGoSearch has a query
62986 *   tracking support. Note that tracking is implemented in SQL version
62987 *   only and not available in built-in database. To use tracking, you
62988 *   have to create tables for tracking support. For MySQL, use
62989 *   create/mysql/track.txt. When doing a search, front-end uses those
62990 *   tables to store query words, a number of found documents and current
62991 *   Unix timestamp in seconds. Available values: UDM_TRACK_ENABLED,
62992 *   UDM_TRACK_DISABLED. UDM_PARAM_PHRASE_MODE - defines whether index
62993 *   database using phrases ("phrase" parameter in indexer.conf).
62994 *   Possible values: UDM_PHRASE_ENABLED and UDM_PHRASE_DISABLED. Please
62995 *   note, that if phrase search is enabled (UDM_PHRASE_ENABLED), it is
62996 *   still possible to do search in any mode (ANY, ALL, BOOL or PHRASE).
62997 *   In 3.1.10 version of mnoGoSearch phrase search is supported only in
62998 *   sql and built-in database modes, while beginning with 3.1.11 phrases
62999 *   are supported in cachemode as well. Examples of phrase search:
63000 *   "Arizona desert" - This query returns all indexed documents that
63001 *   contain "Arizona desert" as a phrase. Notice that you need to put
63002 *   double quotes around the phrase UDM_PARAM_CHARSET - defines local
63003 *   charset. Available values: set of charsets supported by mnoGoSearch,
63004 *   e.g. koi8-r, cp1251, ... UDM_PARAM_STOPFILE - Defines name and path
63005 *   to stopwords file. (There is a small difference with mnoGoSearch -
63006 *   while in mnoGoSearch if relative path or no path entered, it looks
63007 *   for this file in relation to UDM_CONF_DIR, the module looks for the
63008 *   file in relation to current path, i.e. to the path where the PHP
63009 *   script is executed.) UDM_PARAM_STOPTABLE - Load stop words from the
63010 *   given SQL table. You may use several StopwordTable commands. This
63011 *   command has no effect when compiled without SQL database support.
63012 *   UDM_PARAM_WEIGHT_FACTOR - represents weight factors for specific
63013 *   document parts. Currently body, title, keywords, description, url
63014 *   are supported. To activate this feature please use degrees of 2 in
63015 *   *Weight commands of the indexer.conf. Let's imagine that we have
63016 *   these weights: URLWeight 1 BodyWeight 2 TitleWeight 4 KeywordWeight
63017 *   8 DescWeight 16 As far as indexer uses bit OR operation for word
63018 *   weights when some word presents several time in the same document,
63019 *   it is possible at search time to detect word appearance in different
63020 *   document parts. Word which appears only in the body will have
63021 *   00000010 aggregate weight (in binary notation). Word used in all
63022 *   document parts will have 00011111 aggregate weight. This parameter's
63023 *   value is a string of hex digits ABCDE. Each digit is a factor for
63024 *   corresponding bit in word weight. For the given above weights
63025 *   configuration: E is a factor for weight 1 (URL Weight bit) D is a
63026 *   factor for weight 2 (BodyWeight bit) C is a factor for weight 4
63027 *   (TitleWeight bit) B is a factor for weight 8 (KeywordWeight bit) A
63028 *   is a factor for weight 16 (DescWeight bit) Examples:
63029 *   UDM_PARAM_WEIGHT_FACTOR=00001 will search through URLs only.
63030 *   UDM_PARAM_WEIGHT_FACTOR=00100 will search through Titles only.
63031 *   UDM_PARAM_WEIGHT_FACTOR=11100 will search through
63032 *   Title,Keywords,Description but not through URL and Body.
63033 *   UDM_PARAM_WEIGHT_FACTOR=F9421 will search through: Description with
63034 *   factor 15 (F hex) Keywords with factor 9 Title with factor 4 Body
63035 *   with factor 2 URL with factor 1 If UDM_PARAM_WEIGHT_FACTOR variable
63036 *   is omitted, original weight value is taken to sort results. For a
63037 *   given above weight configuration it means that document description
63038 *   has a most big weight 16. UDM_PARAM_WORD_MATCH - word match. You may
63039 *   use this parameter to choose word match type. This feature works
63040 *   only in "single" and "multi" modes using SQL based and built-in
63041 *   database. It does not work in cachemode and other modes since they
63042 *   use word CRC and do not support substring search. Available values:
63043 *   UDM_MATCH_BEGIN - word beginning match; UDM_MATCH_END - word ending
63044 *   match; UDM_MATCH_WORD - whole word match; UDM_MATCH_SUBSTR - word
63045 *   substring match. UDM_PARAM_MIN_WORD_LEN - defines minimal word
63046 *   length. Any word shorter this limit is considered to be a stopword.
63047 *   Please note that this parameter value is inclusive, i.e. if
63048 *   UDM_PARAM_MIN_WORD_LEN=3, a word 3 characters long will not be
63049 *   considered a stopword, while a word 2 characters long will be.
63050 *   Default value is 1. UDM_PARAM_ISPELL_PREFIXES - Possible values:
63051 *   UDM_PREFIXES_ENABLED and UDM_PREFIXES_DISABLED, that respectively
63052 *   enable or disable using prefixes. E.g. if a word "tested" is in
63053 *   search query, also words like "test", "testing", etc. Only suffixes
63054 *   are supported by default. Prefixes usually change word meanings, for
63055 *   example if somebody is searching for the word "tested" one hardly
63056 *   wants "untested" to be found. Prefixes support may also be found
63057 *   useful for site's spelling checking purposes. In order to enable
63058 *   ispell, you have to load ispell data with {@link
63059 *   udm_load_ispell_data}. UDM_PARAM_CROSS_WORDS - enables or disables
63060 *   crosswords support. Possible values: UDM_CROSS_WORDS_ENABLED and
63061 *   UDM_CROSS_WORDS_DISABLED. The crosswords feature allows to assign
63062 *   words between <a href="xxx"> and </a> also to a document this link
63063 *   leads to. It works in SQL database mode and is not supported in
63064 *   built-in database and Cachemode. UDM_PARAM_VARDIR - specifies a
63065 *   custom path to directory where indexer stores data when using
63066 *   built-in database and in cache mode. By default /var directory of
63067 *   mnoGoSearch installation is used. Can have only string values.
63068 * @param string $val
63069 * @return bool
63070 * @since PHP 4 >= 4.0.5, PHP 5 = 1.0.0
63071 **/
63072function udm_set_agent_param($agent, $var, $val){}
63073
63074/**
63075 * {@link uksort} will sort the keys of an array using a user-supplied
63076 * comparison function. If the array you wish to sort needs to be sorted
63077 * by some non-trivial criteria, you should use this function.
63078 *
63079 * @param array $array The input array.
63080 * @param callback $cmp_function The callback comparison function.
63081 *   Function {@link cmp_function} should accept two parameters which
63082 *   will be filled by pairs of {@link array} keys. The comparison
63083 *   function must return an integer less than, equal to, or greater than
63084 *   zero if the first argument is considered to be respectively less
63085 *   than, equal to, or greater than the second.
63086 * @return bool
63087 * @since PHP 4, PHP 5
63088 **/
63089function uksort(&$array, $cmp_function){}
63090
63091/**
63092 * {@link umask} sets PHP's umask to {@link mask} & 0777 and returns the
63093 * old umask. When PHP is being used as a server module, the umask is
63094 * restored when each request is finished.
63095 *
63096 * @param int $mask The new umask.
63097 * @return int
63098 * @since PHP 4, PHP 5
63099 **/
63100function umask($mask){}
63101
63102/**
63103 * Convert a binary string encoded in {@link encoding} to a unicode
63104 * string.
63105 *
63106 * @param string $input Try string that is converted.
63107 * @param string $encoding The encoding of {@link input}.
63108 * @param int $errmode Conversion error mode. This parameter determines
63109 *   the action to take when the converter cannot convert a character.
63110 *   For a list of available modes, refer to {@link
63111 *   unicode_set_error_mode}. If the parameter is not set, the global
63112 *   error mode is used.
63113 * @return unicode
63114 **/
63115function unicode_decode($input, $encoding, $errmode){}
63116
63117/**
63118 * Takes a unicode string and converts it to a string in the specified
63119 * {@link encoding}.
63120 *
63121 * @param unicode $input The unicode string that is converted.
63122 * @param string $encoding The new encoding for {@link input}.
63123 * @param int $errmode Conversion error mode. This parameter determines
63124 *   the action to take when the converter cannot convert a character.
63125 *   For a list of available modes, refer to {@link
63126 *   unicode_set_error_mode}. If the parameter is not set, the global
63127 *   error mode is used.
63128 * @return string
63129 **/
63130function unicode_encode($input, $encoding, $errmode){}
63131
63132/**
63133 * Return the current error mode for string conversions in {@link
63134 * direction}.
63135 *
63136 * @param int $direction Get the error mode for conversion {@link
63137 *   direction}. This can either be FROM_UNICODE or TO_UNICODE. See
63138 *   {@link unicode_set_error_mode} for more details.
63139 * @return int
63140 **/
63141function unicode_get_error_mode($direction){}
63142
63143/**
63144 * Return the substitution character for string conversion errors set by
63145 * {@link unicode_set_subst_char}.
63146 *
63147 * @return unicode
63148 **/
63149function unicode_get_subst_char(){}
63150
63151/**
63152 * This function sets the error mode for string conversions between
63153 * different encodings. An error can occur during conversion when an
63154 * illegal character is encountered or if a character cannot be
63155 * represented into the new encoding. By default, when an error is
63156 * encountered, the conversion stops.
63157 *
63158 * @param int $direction The {@link direction} sets the conversion
63159 *   direction to which the error mode will apply. This can either be
63160 *   FROM_UNICODE, which will set the error mode for conversions from a
63161 *   unicode string to a binary string or TO_UNICODE, which will set the
63162 *   error mode for conversions from a binary string to a unicode string.
63163 * @param int $mode {@link mode} determines how the conversion errors
63164 *   are handled. It should be one of the following constants:
63165 *
63166 *   Available modes Mode Description U_CONV_ERROR_STOP Stop the
63167 *   conversion. This is the default mode. U_CONV_ERROR_SKIP Skip the
63168 *   character. U_CONV_ERROR_SUBST Substitute the character. The
63169 *   substituting character can be set with {@link
63170 *   unicode_set_subst_char}. U_CONV_ERROR_ESCAPE_UNICODE Escape the
63171 *   faulty bytes and represent them in the Unicode character format.
63172 *   U_CONV_ERROR_ESCAPE_ICU Escape the faulty bytes and represent them
63173 *   in the ICU character format. U_CONV_ERROR_ESCAPE_JAVA Escape the
63174 *   faulty bytes and print them in the Java character format.
63175 *   U_CONV_ERROR_ESCAPE_XML_DEC Escape the faulty bytes and represent
63176 *   them in decimal format. U_CONV_ERROR_ESCAPE_XML_HEX Escape the
63177 *   faulty bytes and represent them in hexadecimal format.
63178 * @return bool
63179 **/
63180function unicode_set_error_mode($direction, $mode){}
63181
63182/**
63183 * When converting a string from or to unicode, an invalid or
63184 * unconvertible character may be encountered. When the conversion error
63185 * mode is set to U_CONV_ERROR_SUBST, the character that caused the error
63186 * is substituted by a character set by this function. The default
63187 * substitution character is ?.
63188 *
63189 * @param unicode $character The substitution character to use.
63190 * @return bool
63191 **/
63192function unicode_set_subst_char($character){}
63193
63194/**
63195 * Gets a prefixed unique identifier based on the current time in
63196 * microseconds.
63197 *
63198 * @param string $prefix Can be useful, for instance, if you generate
63199 *   identifiers simultaneously on several hosts that might happen to
63200 *   generate the identifier at the same microsecond. With an empty
63201 *   {@link prefix}, the returned string will be 13 characters long. If
63202 *   {@link more_entropy} is , it will be 23 characters.
63203 * @param bool $more_entropy If set to , {@link uniqid} will add
63204 *   additional entropy (using the combined linear congruential
63205 *   generator) at the end of the return value, which should make the
63206 *   results more unique.
63207 * @return string
63208 * @since PHP 4, PHP 5
63209 **/
63210function uniqid($prefix, $more_entropy){}
63211
63212/**
63213 * Return the Julian Day for a Unix {@link timestamp} (seconds since
63214 * 1.1.1970), or for the current day if no {@link timestamp} is given.
63215 *
63216 * @param int $timestamp A unix timestamp to convert.
63217 * @return int
63218 * @since PHP 4, PHP 5
63219 **/
63220function unixtojd($timestamp){}
63221
63222/**
63223 * Deletes {@link filename}. Similar to the Unix C unlink() function. A
63224 * E_WARNING level error will be generated on failure.
63225 *
63226 * @param string $filename Path to the file.
63227 * @param resource $context
63228 * @return bool
63229 * @since PHP 4, PHP 5
63230 **/
63231function unlink($filename, $context){}
63232
63233/**
63234 * Unpacks from a binary string into an array according to the given
63235 * {@link format}.
63236 *
63237 * {@link unpack} works slightly different from Perl as the unpacked data
63238 * is stored in an associative array. To accomplish this you have to name
63239 * the different format codes and separate them by a slash /.
63240 *
63241 * @param string $format See {@link pack} for an explanation of the
63242 *   format codes.
63243 * @param string $data The packed data.
63244 * @return array
63245 * @since PHP 4, PHP 5
63246 **/
63247function unpack($format, $data){}
63248
63249/**
63250 * @param string $function_name The function name, as a string.
63251 * @return void
63252 * @since PHP 4 >= 4.0.3, PHP 5
63253 **/
63254function unregister_tick_function($function_name){}
63255
63256/**
63257 * @param string $str The serialized string. If the variable being
63258 *   unserialized is an object, after successfully reconstructing the
63259 *   object PHP will automatically attempt to call the {@link __wakeup}
63260 *   member function (if it exists).
63261 *
63262 *   unserialize_callback_func directive It's possible to set a
63263 *   callback-function which will be called, if an undefined class should
63264 *   be instantiated during unserializing. (to prevent getting an
63265 *   incomplete object "__PHP_Incomplete_Class".) Use your , {@link
63266 *   ini_set} or to define 'unserialize_callback_func'. Everytime an
63267 *   undefined class should be instantiated, it'll be called. To disable
63268 *   this feature just empty this setting.
63269 * @return mixed
63270 * @since PHP 4, PHP 5
63271 **/
63272function unserialize($str){}
63273
63274/**
63275 * Decodes any %## encoding in the given string. Plus symbols ('+') are
63276 * decoded to a space character.
63277 *
63278 * @param string $str The string to be decoded.
63279 * @return string
63280 * @since PHP 4, PHP 5
63281 **/
63282function urldecode($str){}
63283
63284/**
63285 * This function is convenient when encoding a string to be used in a
63286 * query part of a URL, as a convenient way to pass variables to the next
63287 * page.
63288 *
63289 * @param string $str The string to be encoded.
63290 * @return string
63291 * @since PHP 4, PHP 5
63292 **/
63293function urlencode($str){}
63294
63295/**
63296 * Used to trigger a user error condition, it can be used by in
63297 * conjunction with the built-in error handler, or with a user defined
63298 * function that has been set as the new error handler ({@link
63299 * set_error_handler}).
63300 *
63301 * This function is useful when you need to generate a particular
63302 * response to an exception at runtime.
63303 *
63304 * @param string $error_msg The designated error message for this
63305 *   error. It's limited to 1024 characters in length. Any additional
63306 *   characters beyond 1024 will be truncated.
63307 * @param int $error_type The designated error type for this error. It
63308 *   only works with the E_USER family of constants, and will default to
63309 *   E_USER_NOTICE.
63310 * @return bool
63311 * @since PHP 4, PHP 5
63312 **/
63313function user_error($error_msg, $error_type){}
63314
63315/**
63316 * This function sets whether or not to use the SOAP error handler in the
63317 * SOAP server. It will return the previous value. If set to , details of
63318 * errors in a SoapServer application will be sent to the clients. If ,
63319 * no information will be sent.
63320 *
63321 * @param bool $handler Set to to send error details to clients.
63322 * @return bool
63323 * @since Unknown
63324 **/
63325function use_soap_error_handler($handler){}
63326
63327/**
63328 * Delays program execution for the given number of micro seconds.
63329 *
63330 * @param int $micro_seconds Halt time in micro seconds. A micro second
63331 *   is one millionth of a second.
63332 * @return void
63333 * @since PHP 4, PHP 5
63334 **/
63335function usleep($micro_seconds){}
63336
63337/**
63338 * This function will sort an array by its values using a user-supplied
63339 * comparison function. If the array you wish to sort needs to be sorted
63340 * by some non-trivial criteria, you should use this function.
63341 *
63342 * @param array $array The input array.
63343 * @param callback $cmp_function The comparison function must return an
63344 *   integer less than, equal to, or greater than zero if the first
63345 *   argument is considered to be respectively less than, equal to, or
63346 *   greater than the second.
63347 * @return bool
63348 * @since PHP 4, PHP 5
63349 **/
63350function usort(&$array, $cmp_function){}
63351
63352/**
63353 * This function decodes {@link data}, assumed to be UTF-8 encoded, to
63354 * ISO-8859-1.
63355 *
63356 * @param string $data An UTF-8 encoded string.
63357 * @return string
63358 * @since PHP 4, PHP 5
63359 **/
63360function utf8_decode($data){}
63361
63362/**
63363 * This function encodes the string {@link data} to UTF-8, and returns
63364 * the encoded version. UTF-8 is a standard mechanism used by Unicode for
63365 * encoding wide character values into a byte stream. UTF-8 is
63366 * transparent to plain ASCII characters, is self-synchronized (meaning
63367 * it is possible for a program to figure out where in the bytestream
63368 * characters start) and can be used with normal string comparison
63369 * functions for sorting and such. PHP encodes UTF-8 characters in up to
63370 * four bytes, like this: UTF-8 encoding bytes bits representation 1 7
63371 * 0bbbbbbb 2 11 110bbbbb 10bbbbbb 3 16 1110bbbb 10bbbbbb 10bbbbbb 4 21
63372 * 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb Each b represents a bit that can
63373 * be used to store character data.
63374 *
63375 * @param string $data An ISO-8859-1 string.
63376 * @return string
63377 * @since PHP 4, PHP 5
63378 **/
63379function utf8_encode($data){}
63380
63381/**
63382 * Returns the absolute value of a variant.
63383 *
63384 * @param mixed $val The variant.
63385 * @return mixed
63386 * @since PHP 5
63387 **/
63388function variant_abs($val){}
63389
63390/**
63391 * Adds {@link left} to {@link right} using the following rules (taken
63392 * from the MSDN library), which correspond to those of Visual Basic:
63393 * Variant Addition Rules If Then Both expressions are of the string type
63394 * Concatenation One expression is a string type and the other a
63395 * character Addition One expression is numeric and the other is a string
63396 * Addition Both expressions are numeric Addition Either expression is
63397 * NULL NULL is returned Both expressions are empty Integer subtype is
63398 * returned
63399 *
63400 * @param mixed $left The left operand.
63401 * @param mixed $right The right operand.
63402 * @return mixed
63403 * @since PHP 5
63404 **/
63405function variant_add($left, $right){}
63406
63407/**
63408 * Performs a bitwise AND operation. Note that this is slightly different
63409 * from a regular AND operation.
63410 *
63411 * @param mixed $left The left operand.
63412 * @param mixed $right The right operand.
63413 * @return mixed
63414 * @since PHP 5
63415 **/
63416function variant_and($left, $right){}
63417
63418/**
63419 * This function makes a copy of {@link variant} and then performs a
63420 * variant cast operation to force the copy to have the type given by
63421 * {@link type}.
63422 *
63423 * This function wraps VariantChangeType() in the COM library; consult
63424 * MSDN for more information.
63425 *
63426 * @param variant $variant The variant.
63427 * @param int $type {@link type} should be one of the VT_XXX constants.
63428 * @return variant
63429 * @since PHP 5
63430 **/
63431function variant_cast($variant, $type){}
63432
63433/**
63434 * Concatenates {@link left} with {@link right} and returns the result.
63435 *
63436 * This function is notionally equivalent to {@link $left} . {@link
63437 * $right}.
63438 *
63439 * @param mixed $left The left operand.
63440 * @param mixed $right The right operand.
63441 * @return mixed
63442 * @since PHP 5
63443 **/
63444function variant_cat($left, $right){}
63445
63446/**
63447 * Compares {@link left} with {@link right}.
63448 *
63449 * This function will only compare scalar values, not arrays or variant
63450 * records.
63451 *
63452 * @param mixed $left The left operand.
63453 * @param mixed $right The right operand.
63454 * @param int $lcid A valid Locale Identifier to use when comparing
63455 *   strings (this affects string collation).
63456 * @param int $flags {@link flags} can be one or more of the following
63457 *   values OR'd together, and affects string comparisons: Variant
63458 *   Comparision Flags value meaning NORM_IGNORECASE Compare case
63459 *   insensitively NORM_IGNORENONSPACE Ignore nonspacing characters
63460 *   NORM_IGNORESYMBOLS Ignore symbols NORM_IGNOREWIDTH Ignore string
63461 *   width NORM_IGNOREKANATYPE Ignore Kana type NORM_IGNOREKASHIDA Ignore
63462 *   Arabic kashida characters
63463 * @return int
63464 * @since PHP 5
63465 **/
63466function variant_cmp($left, $right, $lcid, $flags){}
63467
63468/**
63469 * Converts {@link timestamp} from a unix timestamp value into a variant
63470 * of type VT_DATE. This allows easier interopability between the
63471 * unix-ish parts of PHP and COM.
63472 *
63473 * @param int $timestamp A unix timestamp.
63474 * @return variant
63475 * @since PHP 5
63476 **/
63477function variant_date_from_timestamp($timestamp){}
63478
63479/**
63480 * Converts {@link variant} from a VT_DATE (or similar) value into a Unix
63481 * timestamp. This allows easier interopability between the Unix-ish
63482 * parts of PHP and COM.
63483 *
63484 * @param variant $variant The variant.
63485 * @return int
63486 * @since PHP 5
63487 **/
63488function variant_date_to_timestamp($variant){}
63489
63490/**
63491 * Divides {@link left} by {@link right} and returns the result.
63492 *
63493 * @param mixed $left The left operand.
63494 * @param mixed $right The right operand.
63495 * @return mixed
63496 * @since PHP 5
63497 **/
63498function variant_div($left, $right){}
63499
63500/**
63501 * Performs a bitwise equivalence on two variants.
63502 *
63503 * @param mixed $left The left operand.
63504 * @param mixed $right The right operand.
63505 * @return mixed
63506 * @since PHP 5
63507 **/
63508function variant_eqv($left, $right){}
63509
63510/**
63511 * Gets the integer portion of a variant.
63512 *
63513 * @param mixed $variant The variant.
63514 * @return mixed
63515 * @since PHP 5
63516 **/
63517function variant_fix($variant){}
63518
63519/**
63520 * Returns the type of a variant object.
63521 *
63522 * @param variant $variant The variant object.
63523 * @return int
63524 * @since PHP 5
63525 **/
63526function variant_get_type($variant){}
63527
63528/**
63529 * Converts {@link left} and {@link right} to integer values, and then
63530 * performs integer division.
63531 *
63532 * @param mixed $left The left operand.
63533 * @param mixed $right The right operand.
63534 * @return mixed
63535 * @since PHP 5
63536 **/
63537function variant_idiv($left, $right){}
63538
63539/**
63540 * Performs a bitwise implication operation.
63541 *
63542 * @param mixed $left The left operand.
63543 * @param mixed $right The right operand.
63544 * @return mixed
63545 * @since PHP 5
63546 **/
63547function variant_imp($left, $right){}
63548
63549/**
63550 * Gets the integer portion of a variant.
63551 *
63552 * @param mixed $variant The variant.
63553 * @return mixed
63554 * @since PHP 5
63555 **/
63556function variant_int($variant){}
63557
63558/**
63559 * Divides {@link left} by {@link right} and returns the remainder.
63560 *
63561 * @param mixed $left The left operand.
63562 * @param mixed $right The right operand.
63563 * @return mixed
63564 * @since PHP 5
63565 **/
63566function variant_mod($left, $right){}
63567
63568/**
63569 * Multiplies {@link left} by {@link right}.
63570 *
63571 * @param mixed $left The left operand.
63572 * @param mixed $right The right operand.
63573 * @return mixed
63574 * @since PHP 5
63575 **/
63576function variant_mul($left, $right){}
63577
63578/**
63579 * Performs logical negation of {@link variant}.
63580 *
63581 * @param mixed $variant The variant.
63582 * @return mixed
63583 * @since PHP 5
63584 **/
63585function variant_neg($variant){}
63586
63587/**
63588 * Performs bitwise not negation on {@link variant} and returns the
63589 * result.
63590 *
63591 * @param mixed $variant The variant.
63592 * @return mixed
63593 * @since PHP 5
63594 **/
63595function variant_not($variant){}
63596
63597/**
63598 * Performs a bitwise OR operation. Note that this is slightly different
63599 * from a regular OR operation.
63600 *
63601 * @param mixed $left The left operand.
63602 * @param mixed $right The right operand.
63603 * @return mixed
63604 * @since PHP 5
63605 **/
63606function variant_or($left, $right){}
63607
63608/**
63609 * Returns the result of {@link left} to the power of {@link right}.
63610 *
63611 * @param mixed $left The left operand.
63612 * @param mixed $right The right operand.
63613 * @return mixed
63614 * @since PHP 5
63615 **/
63616function variant_pow($left, $right){}
63617
63618/**
63619 * Returns the value of {@link variant} rounded to {@link decimals}
63620 * decimal places.
63621 *
63622 * @param mixed $variant The variant.
63623 * @param int $decimals Number of decimal places.
63624 * @return mixed
63625 * @since PHP 5
63626 **/
63627function variant_round($variant, $decimals){}
63628
63629/**
63630 * Converts {@link value} to a variant and assigns it to the {@link
63631 * variant} object; no new variant object is created, and the old value
63632 * of {@link variant} is freed/released.
63633 *
63634 * @param variant $variant The variant.
63635 * @param mixed $value
63636 * @return void
63637 * @since PHP 5
63638 **/
63639function variant_set($variant, $value){}
63640
63641/**
63642 * This function is similar to {@link variant_cast} except that the
63643 * variant is modified "in-place"; no new variant is created. The
63644 * parameters for this function have identical meaning to those of {@link
63645 * variant_cast}.
63646 *
63647 * @param variant $variant The variant.
63648 * @param int $type
63649 * @return void
63650 * @since PHP 5
63651 **/
63652function variant_set_type($variant, $type){}
63653
63654/**
63655 * Subtracts {@link right} from {@link left}.
63656 *
63657 * @param mixed $left The left operand.
63658 * @param mixed $right The right operand.
63659 * @return mixed
63660 * @since PHP 5
63661 **/
63662function variant_sub($left, $right){}
63663
63664/**
63665 * Performs a logical exclusion.
63666 *
63667 * @param mixed $left The left operand.
63668 * @param mixed $right The right operand.
63669 * @return mixed
63670 * @since PHP 5
63671 **/
63672function variant_xor($left, $right){}
63673
63674/**
63675 * @param mixed $expression The variable you want to export.
63676 * @param mixed $expression
63677 * @return void
63678 * @since PHP 4, PHP 5
63679 **/
63680function var_dump($expression, $expression){}
63681
63682/**
63683 * @param mixed $expression The variable you want to export.
63684 * @param bool $return If used and set to , {@link var_export} will
63685 *   return the variable representation instead of outputing it.
63686 * @return mixed
63687 * @since PHP 4 >= 4.2.0, PHP 5
63688 **/
63689function var_export($expression, $return){}
63690
63691/**
63692 * {@link version_compare} compares two "PHP-standardized" version number
63693 * strings. This is useful if you would like to write programs working
63694 * only on some versions of PHP.
63695 *
63696 * The function first replaces _, - and + with a dot . in the version
63697 * strings and also inserts dots . before and after any non number so
63698 * that for example '4.3.2RC1' becomes '4.3.2.RC.1'. Then it splits the
63699 * results like if you were using explode('.', $ver). Then it compares
63700 * the parts starting from left to right. If a part contains special
63701 * version strings these are handled in the following order: any string
63702 * not found in this list < dev < alpha = a < beta = b < RC = rc < # < pl
63703 * = p. This way not only versions with different levels like '4.1' and
63704 * '4.1.2' can be compared but also any PHP specific version containing
63705 * development state.
63706 *
63707 * @param string $version1 First version number.
63708 * @param string $version2 Second version number.
63709 * @param string $operator If you specify the third optional {@link
63710 *   operator} argument, you can test for a particular relationship. The
63711 *   possible operators are: <, lt, <=, le, >, gt, >=, ge, ==, =, eq, !=,
63712 *   <>, ne respectively. This parameter is case-sensitive, so values
63713 *   should be lowercase.
63714 * @return mixed
63715 * @since PHP 4 >= 4.1.0, PHP 5
63716 **/
63717function version_compare($version1, $version2, $operator){}
63718
63719/**
63720 * Write a string produced according to {@link format} to the stream
63721 * resource specified by {@link handle}.
63722 *
63723 * Operates as {@link fprintf} but accepts an array of arguments, rather
63724 * than a variable number of arguments.
63725 *
63726 * @param resource $handle
63727 * @param string $format See {@link sprintf} for a description of
63728 *   {@link format}.
63729 * @param array $args
63730 * @return int
63731 * @since PHP 5
63732 **/
63733function vfprintf($handle, $format, $args){}
63734
63735/**
63736 * {@link virtual} is an Apache-specific function which is similar to
63737 * <!--#include virtual...--> in mod_include. It performs an Apache
63738 * sub-request. It is useful for including CGI scripts or .shtml files,
63739 * or anything else that you would parse through Apache. Note that for a
63740 * CGI script, the script must generate valid CGI headers. At the minimum
63741 * that means it must generate a Content-Type header.
63742 *
63743 * To run the sub-request, all buffers are terminated and flushed to the
63744 * browser, pending headers are sent too.
63745 *
63746 * @param string $filename The file that the virtual command will be
63747 *   performed on.
63748 * @return bool
63749 * @since PHP 4, PHP 5
63750 **/
63751function virtual($filename){}
63752
63753/**
63754 * @param string $domain
63755 * @param string $aliasdomain
63756 * @return bool
63757 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
63758 **/
63759function vpopmail_add_alias_domain($domain, $aliasdomain){}
63760
63761/**
63762 * @param string $olddomain
63763 * @param string $newdomain
63764 * @return bool
63765 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
63766 **/
63767function vpopmail_add_alias_domain_ex($olddomain, $newdomain){}
63768
63769/**
63770 * @param string $domain
63771 * @param string $dir
63772 * @param int $uid
63773 * @param int $gid
63774 * @return bool
63775 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
63776 **/
63777function vpopmail_add_domain($domain, $dir, $uid, $gid){}
63778
63779/**
63780 * @param string $domain
63781 * @param string $passwd
63782 * @param string $quota
63783 * @param string $bounce
63784 * @param bool $apop
63785 * @return bool
63786 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
63787 **/
63788function vpopmail_add_domain_ex($domain, $passwd, $quota, $bounce, $apop){}
63789
63790/**
63791 * @param string $user
63792 * @param string $domain
63793 * @param string $password
63794 * @param string $gecos
63795 * @param bool $apop
63796 * @return bool
63797 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
63798 **/
63799function vpopmail_add_user($user, $domain, $password, $gecos, $apop){}
63800
63801/**
63802 * @param string $user
63803 * @param string $domain
63804 * @param string $alias
63805 * @return bool
63806 * @since PHP 4 >= 4.0.7, PECL vpopmail >= 0.2
63807 **/
63808function vpopmail_alias_add($user, $domain, $alias){}
63809
63810/**
63811 * @param string $user
63812 * @param string $domain
63813 * @return bool
63814 * @since PHP 4 >= 4.0.7, PECL vpopmail >= 0.2
63815 **/
63816function vpopmail_alias_del($user, $domain){}
63817
63818/**
63819 * @param string $domain
63820 * @return bool
63821 * @since PHP 4 >= 4.0.7, PECL vpopmail >= 0.2
63822 **/
63823function vpopmail_alias_del_domain($domain){}
63824
63825/**
63826 * @param string $alias
63827 * @param string $domain
63828 * @return array
63829 * @since PHP 4 >= 4.0.7, PECL vpopmail >= 0.2
63830 **/
63831function vpopmail_alias_get($alias, $domain){}
63832
63833/**
63834 * @param string $domain
63835 * @return array
63836 * @since PHP 4 >= 4.0.7, PECL vpopmail >= 0.2
63837 **/
63838function vpopmail_alias_get_all($domain){}
63839
63840/**
63841 * @param string $user
63842 * @param string $domain
63843 * @param string $password
63844 * @param string $apop
63845 * @return bool
63846 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
63847 **/
63848function vpopmail_auth_user($user, $domain, $password, $apop){}
63849
63850/**
63851 * @param string $domain
63852 * @return bool
63853 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
63854 **/
63855function vpopmail_del_domain($domain){}
63856
63857/**
63858 * @param string $domain
63859 * @return bool
63860 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
63861 **/
63862function vpopmail_del_domain_ex($domain){}
63863
63864/**
63865 * @param string $user
63866 * @param string $domain
63867 * @return bool
63868 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
63869 **/
63870function vpopmail_del_user($user, $domain){}
63871
63872/**
63873 * @return string
63874 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
63875 **/
63876function vpopmail_error(){}
63877
63878/**
63879 * @param string $user
63880 * @param string $domain
63881 * @param string $password
63882 * @param bool $apop
63883 * @return bool
63884 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
63885 **/
63886function vpopmail_passwd($user, $domain, $password, $apop){}
63887
63888/**
63889 * @param string $user
63890 * @param string $domain
63891 * @param string $quota
63892 * @return bool
63893 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
63894 **/
63895function vpopmail_set_user_quota($user, $domain, $quota){}
63896
63897/**
63898 * Display array values as a formatted string according to {@link format}
63899 * (which is described in the documentation for {@link sprintf}).
63900 *
63901 * Operates as {@link printf} but accepts an array of arguments, rather
63902 * than a variable number of arguments.
63903 *
63904 * @param string $format See {@link sprintf} for a description of
63905 *   {@link format}.
63906 * @param array $args
63907 * @return int
63908 * @since PHP 4 >= 4.1.0, PHP 5
63909 **/
63910function vprintf($format, $args){}
63911
63912/**
63913 * Operates as {@link sprintf} but accepts an array of arguments, rather
63914 * than a variable number of arguments.
63915 *
63916 * @param string $format See {@link sprintf} for a description of
63917 *   {@link format}.
63918 * @param array $args
63919 * @return string
63920 * @since PHP 4 >= 4.1.0, PHP 5
63921 **/
63922function vsprintf($format, $args){}
63923
63924/**
63925 * You need to call this function if you would like to define a type for
63926 * a w32api call.
63927 *
63928 * @param string $typename The name of the type.
63929 * @param string $member1_type A member type can be a user defined
63930 *   type. All the type names are case sensitive. Built in type names
63931 *   should be provided in lowercase.
63932 * @param string $member1_name The member name of {@link member1_type}.
63933 * @return bool
63934 * @since PHP 4 >= 4.2.0
63935 **/
63936function w32api_deftype($typename, $member1_type, $member1_name){}
63937
63938/**
63939 * This function creates an instance of the data type named {@link
63940 * typename}, filling in the values of the data type.
63941 *
63942 * @param string $typename The {@link typename} parameter is case
63943 *   sensitive.
63944 * @param mixed $value You should give the values in the same order as
63945 *   you defined the data type with {@link w32api_deftype}.
63946 * @return resource
63947 * @since PHP 4 >= 4.2.0
63948 **/
63949function w32api_init_dtype($typename, $value){}
63950
63951/**
63952 * {@link w32api_invoke_function} tries to find the previously registered
63953 * function, passing the parameters you provided.
63954 *
63955 * @param string $funcname The function name.
63956 * @param mixed $argument Any of the arguments can be of any PHP type
63957 *   or {@link w32api_deftype} defined type, as needed.
63958 * @return mixed
63959 * @since PHP 4 >= 4.2.0
63960 **/
63961function w32api_invoke_function($funcname, $argument){}
63962
63963/**
63964 * This function tries to find the {@link function_name} function in
63965 * {@link library}, and tries to import it into PHP.
63966 *
63967 * @param string $library The library name, as a string.
63968 * @param string $function_name The function name, as a string.
63969 * @param string $return_type The function will be registered with the
63970 *   given {@link return_type}. This type can be a generic PHP type, or a
63971 *   type defined with {@link w32api_deftype}. All type names are case
63972 *   sensitive. Built in type names should be provided in lowercase.
63973 * @return bool
63974 * @since PHP 4 >= 4.2.0
63975 **/
63976function w32api_register_function($library, $function_name, $return_type){}
63977
63978/**
63979 * This function sets the method call type.
63980 *
63981 * @param int $method Can be one of DC_CALL_CDECL or DC_CALL_STD (the
63982 *   extension default).
63983 * @return void
63984 * @since PHP 4 >= 4.2.0
63985 **/
63986function w32api_set_call_method($method){}
63987
63988/**
63989 * Serializes the passed variables and add the result to the given
63990 * packet.
63991 *
63992 * @param resource $packet_id A WDDX packet, returned by {@link
63993 *   wddx_packet_start}.
63994 * @param mixed $var_name Can be either a string naming a variable or
63995 *   an array containing strings naming the variables or another array,
63996 *   etc.
63997 * @return bool
63998 * @since PHP 4, PHP 5
63999 **/
64000function wddx_add_vars($packet_id, $var_name){}
64001
64002/**
64003 * Unserializes a WDDX {@link packet}.
64004 *
64005 * @param string $packet A WDDX packet, as a string or stream.
64006 * @return mixed
64007 * @since PHP 4, PHP 5
64008 **/
64009function wddx_deserialize($packet){}
64010
64011/**
64012 * Ends and returns the given WDDX packet.
64013 *
64014 * @param resource $packet_id A WDDX packet, returned by {@link
64015 *   wddx_packet_start}.
64016 * @return string
64017 * @since PHP 4, PHP 5
64018 **/
64019function wddx_packet_end($packet_id){}
64020
64021/**
64022 * Start a new WDDX packet for incremental addition of variables. It
64023 * automatically creates a structure definition inside the packet to
64024 * contain the variables.
64025 *
64026 * @param string $comment An optional comment string.
64027 * @return resource
64028 * @since PHP 4, PHP 5
64029 **/
64030function wddx_packet_start($comment){}
64031
64032/**
64033 * Creates a WDDX packet from a single given value.
64034 *
64035 * @param mixed $var The value to be serialized
64036 * @param string $comment An optional comment string that appears in
64037 *   the packet header.
64038 * @return string
64039 * @since PHP 4, PHP 5
64040 **/
64041function wddx_serialize_value($var, $comment){}
64042
64043/**
64044 * Creates a WDDX packet with a structure that contains the serialized
64045 * representation of the passed variables.
64046 *
64047 * @param mixed $var_name Can be either a string naming a variable or
64048 *   an array containing strings naming the variables or another array,
64049 *   etc.
64050 * @return string
64051 * @since PHP 4, PHP 5
64052 **/
64053function wddx_serialize_vars($var_name){}
64054
64055/**
64056 * Unserializes a WDDX {@link packet}.
64057 *
64058 * @param string $packet A WDDX packet, as a string or stream.
64059 * @return mixed
64060 * @since PHP 4, PHP 5
64061 **/
64062function wddx_unserialize($packet){}
64063
64064/**
64065 * @param array $details An array of service details: {@link service}
64066 *   The short name of the service. This is the name that you will use to
64067 *   control the service using the net command. The service must be
64068 *   unique (no two services can share the same name), and, ideally,
64069 *   should avoid having spaces in the name. {@link display} The display
64070 *   name of the service. This is the name that you will see in the
64071 *   Services Applet. {@link user} The name of the user account under
64072 *   which you want the service to run. If omitted, the service will run
64073 *   as the LocalSystem account. If the username is specified, you must
64074 *   also provide a password. {@link password} The password that
64075 *   corresponds to the {@link user}. {@link path} The full path to the
64076 *   executable module that will be launched when the service is started.
64077 *   If omitted, the path to the current PHP process will be used. {@link
64078 *   params} Command line parameters to pass to the service when it
64079 *   starts. If you want to run a PHP script as the service, then the
64080 *   first parameter should be the full path to the PHP script that you
64081 *   intend to run. If the script name or path contains spaces, then wrap
64082 *   the full path to the PHP script with ". {@link load_order} Controls
64083 *   the load_order. This is not yet fully supported. {@link svc_type}
64084 *   Sets the service type. If omitted, the default value is
64085 *   WIN32_SERVICE_WIN32_OWN_PROCESS. Don't change this unless you know
64086 *   what you're doing. {@link start_type} Specifies how the service
64087 *   should be started. The default is WIN32_SERVICE_AUTO_START which
64088 *   means the service will be launched when the machine starts up.
64089 *   {@link error_control} Informs the SCM what it should do when it
64090 *   detects a problem with the service. The default is
64091 *   WIN32_SERVER_ERROR_IGNORE. Changing this value is not yet fully
64092 *   supported.
64093 * @param string $machine The short name of the service. This is the
64094 *   name that you will use to control the service using the net command.
64095 *   The service must be unique (no two services can share the same
64096 *   name), and, ideally, should avoid having spaces in the name.
64097 * @return mixed
64098 **/
64099function win32_create_service($details, $machine){}
64100
64101/**
64102 * Attempts to delete a service from the SCM database. Administrative
64103 * privileges are required for this to succeed.
64104 *
64105 * This function really just marks the service for deletion. If other
64106 * processes (such as the Services Applet) are open, then the deletion
64107 * will be deferred until those applications are closed. If a service is
64108 * marked for deletion, further attempts to delete it will fail, and
64109 * attempts to create a new service with that name will also fail.
64110 *
64111 * @param string $servicename The short name of the service.
64112 * @param string $machine The optional machine name. If omitted, the
64113 *   local machine will be used.
64114 * @return int
64115 **/
64116function win32_delete_service($servicename, $machine){}
64117
64118/**
64119 * Returns the control code that was last sent to this service process.
64120 * When running as a service you should periodically check this to
64121 * determine if your service needs to stop running.
64122 *
64123 * @return int
64124 **/
64125function win32_get_last_control_message(){}
64126
64127/**
64128 * Retrieves statistics about all running processes.
64129 *
64130 * @return array
64131 * @since PECL win32ps >= 1.0.1
64132 **/
64133function win32_ps_list_procs(){}
64134
64135/**
64136 * Retrieves statistics about the global memory utilization.
64137 *
64138 * @return array
64139 * @since PECL win32ps >= 1.0.1
64140 **/
64141function win32_ps_stat_mem(){}
64142
64143/**
64144 * Retrieves statistics about the process with the process id {@link
64145 * pid}.
64146 *
64147 * @param int $pid The process id of the process to stat. If omitted,
64148 *   the id of the current process.
64149 * @return array
64150 * @since PECL win32ps >= 1.0.1
64151 **/
64152function win32_ps_stat_proc($pid){}
64153
64154/**
64155 * Queries the current status for a service, returning an array of
64156 * information.
64157 *
64158 * @param string $servicename The short name of the service.
64159 * @param string $machine The optional machine name. If omitted, the
64160 *   local machine will be used.
64161 * @return mixed
64162 **/
64163function win32_query_service_status($servicename, $machine){}
64164
64165/**
64166 * Informs the SCM of the current status of a running service. This call
64167 * is only valid for a running service process.
64168 *
64169 * @param int $status The service status code, one of
64170 *   WIN32_SERVICE_RUNNING, WIN32_SERVICE_STOPPED,
64171 *   WIN32_SERVICE_STOP_PENDING, WIN32_SERVICE_START_PENDING,
64172 *   WIN32_SERVICE_CONTINUE_PENDING, WIN32_SERVICE_PAUSE_PENDING,
64173 *   WIN32_SERVICE_PAUSED.
64174 * @return bool
64175 **/
64176function win32_set_service_status($status){}
64177
64178/**
64179 * Attempts to start the named service. Usually requires administrative
64180 * privileges.
64181 *
64182 * @param string $servicename The short name of the service.
64183 * @param string $machine Optional machine name. If omitted, the local
64184 *   machine is used.
64185 * @return int
64186 **/
64187function win32_start_service($servicename, $machine){}
64188
64189/**
64190 * When launched via the Service Control Manager, a service process is
64191 * required to "check-in" with it to establish service monitoring and
64192 * communication facilities. This function performs the check-in by
64193 * spawning a thread to handle the lower-level communication with the
64194 * service control manager.
64195 *
64196 * Once started, the service process should continue to check-in with the
64197 * service control manager so that it can determine if it should
64198 * terminate. This is achieved by periodically calling {@link
64199 * win32_get_last_control_message} and handling the return code
64200 * appropriately.
64201 *
64202 * @param string $name The short-name of the service, as registered by
64203 *   {@link win32_create_service}.
64204 * @return mixed
64205 **/
64206function win32_start_service_ctrl_dispatcher($name){}
64207
64208/**
64209 * Stops a named service. Requires administrative privileges.
64210 *
64211 * @param string $servicename The short name of the service.
64212 * @param string $machine Optional machine name. If omitted, the local
64213 *   machine is used.
64214 * @return int
64215 **/
64216function win32_stop_service($servicename, $machine){}
64217
64218/**
64219 * Retrieves information about file cache content and its usage.
64220 *
64221 * @param bool $summaryonly Controls whether the returned array will
64222 *   contain information about individual cache entries along with the
64223 *   file cache summary.
64224 * @return array
64225 * @since PECL wincache >= 1.0.0
64226 **/
64227function wincache_fcache_fileinfo($summaryonly){}
64228
64229/**
64230 * Retrieves information about memory usage by file cache.
64231 *
64232 * @return array
64233 * @since PECL wincache >= 1.0.0
64234 **/
64235function wincache_fcache_meminfo(){}
64236
64237/**
64238 * Obtains an exclusive lock on a given key. The execution of the current
64239 * script will be blocked until the lock can be obtained. Once the lock
64240 * is obtained, the other scripts that try to request the lock by using
64241 * the same key will be blocked, until the current script releases the
64242 * lock by using {@link wincache_unlock}.
64243 *
64244 * @param string $key Name of the key in the cache to get the lock on.
64245 * @param bool $isglobal Controls whether the scope of the lock is
64246 *   system-wide or local. Local locks are scoped to the application pool
64247 *   in IIS FastCGI case or to all php processes that have the same
64248 *   parent process identifier.
64249 * @return bool
64250 * @since PECL wincache >= 1.1.0
64251 **/
64252function wincache_lock($key, $isglobal){}
64253
64254/**
64255 * Retrieves information about opcode cache content and its usage.
64256 *
64257 * @param bool $summaryonly Controls whether the returned array will
64258 *   contain information about individual cache entries along with the
64259 *   opcode cache summary.
64260 * @return array
64261 * @since PECL wincache >= 1.0.0
64262 **/
64263function wincache_ocache_fileinfo($summaryonly){}
64264
64265/**
64266 * Retrieves information about memory usage by opcode cache.
64267 *
64268 * @return array
64269 * @since PECL wincache >= 1.0.0
64270 **/
64271function wincache_ocache_meminfo(){}
64272
64273/**
64274 * Refreshes the cache entries for the files, whose names were passed in
64275 * the input argument. If no argument is specified then refreshes all the
64276 * entries in the cache.
64277 *
64278 * @param array $files An array of file names for files that need to be
64279 *   refreshed. An absolute or relative file paths can be used.
64280 * @return bool
64281 * @since PECL wincache >= 1.0.0
64282 **/
64283function wincache_refresh_if_changed($files){}
64284
64285/**
64286 * Retrieves information about cached mappings between relative file
64287 * paths and corresponding absolute file paths.
64288 *
64289 * @return array
64290 * @since PECL wincache >= 1.0.0
64291 **/
64292function wincache_rplist_fileinfo(){}
64293
64294/**
64295 * Retrieves information about memory usage by resolve file path cache.
64296 *
64297 * @return array
64298 * @since PECL wincache >= 1.0.0
64299 **/
64300function wincache_rplist_meminfo(){}
64301
64302/**
64303 * Retrieves information about session cache content and its usage.
64304 *
64305 * @param bool $summaryonly Controls whether the returned array will
64306 *   contain information about individual cache entries along with the
64307 *   session cache summary.
64308 * @return array
64309 * @since PECL wincache >= 1.1.0
64310 **/
64311function wincache_scache_info($summaryonly){}
64312
64313/**
64314 * Retrieves information about memory usage by session cache.
64315 *
64316 * @return array
64317 * @since PECL wincache >= 1.1.0
64318 **/
64319function wincache_scache_meminfo(){}
64320
64321/**
64322 * Adds a variable in user cache, only if this variable doesn't already
64323 * exist in the cache. The added variable remains in the user cache
64324 * unless its time to live expires or it is deleted by using {@link
64325 * wincache_ucache_delete} or {@link wincache_ucache_clear} functions.
64326 *
64327 * @param mixed $key Store the variable using this {@link key} name. If
64328 *   a variable with same key is already present the function will fail
64329 *   and return FALSE. {@link key} is case sensitive. To override the
64330 *   value even if {@link key} is present use {@link wincache_ucache_set}
64331 *   function instad. {@link key} can also take array of name => value
64332 *   pairs where names will be used as keys. This can be used to add
64333 *   multiple values in the cache in one operation, thus avoiding race
64334 *   condition.
64335 * @param mixed $value Value of a variable to store. {@link Value}
64336 *   supports all data types except resources, such as file handles. This
64337 *   paramter is ignored if first argument is an array. A general
64338 *   guidance is to pass NULL as {@link value} while using array as
64339 *   {@link key}.
64340 * @param int $ttl Time for the variable to live in the cache in
64341 *   seconds. After the value specified in {@link ttl} has passed the
64342 *   stored variable will be deleted from the cache. This parameter takes
64343 *   a default value of 0 which means the variable will stay in the cache
64344 *   unless explicitly deleted by using {@link wincache_ucache_delete} or
64345 *   {@link wincache_ucache_clear} functions.
64346 * @return bool
64347 * @since PECL wincache >= 1.1.0
64348 **/
64349function wincache_ucache_add($key, $value, $ttl){}
64350
64351/**
64352 * Compares the variable associated with the {@link key} with {@link
64353 * old_value} and if it matches then assigns the {@link new_value} to it.
64354 *
64355 * @param string $key The {@link key} that is used to store the
64356 *   variable in the cache. {@link key} is case sensitive.
64357 * @param long $old_value Old value of the variable pointed by {@link
64358 *   key} in the user cache. The value should be of type long, otherwise
64359 *   the function returns FALSE.
64360 * @param long $new_value New value which will get assigned to variable
64361 *   pointer by {@link key} if a match is found. The value should be of
64362 *   type long, otherwise the function returns FALSE.
64363 * @return mixed
64364 * @since PECL wincache >= 1.1.0
64365 **/
64366function wincache_ucache_cas($key, $old_value, $new_value){}
64367
64368/**
64369 * Clears/deletes all the values stored in the user cache.
64370 *
64371 * @return bool
64372 * @since PECL wincache >= 1.1.0
64373 **/
64374function wincache_ucache_clear(){}
64375
64376/**
64377 * Decrements the value associated with the {@link key} by 1 or as
64378 * specified by {@link dec_by}.
64379 *
64380 * @param string $key The {@link key} that was used to store the
64381 *   variable in the cache. {@link key} is case sensitive.
64382 * @param long $dec_by The value by which the variable associated with
64383 *   the {@link key} will get decremented. If the argument is a floating
64384 *   point number it will be truncated to nearest integer. The variable
64385 *   associated with the {@link key} should be of type long, otherwise
64386 *   the function fails and returns FALSE.
64387 * @param bool $success Will be set to TRUE on success and FALSE on
64388 *   failure.
64389 * @return mixed
64390 * @since PECL wincache >= 1.1.0
64391 **/
64392function wincache_ucache_dec($key, $dec_by, &$success){}
64393
64394/**
64395 * Deletes the elements in the user cache pointed by {@link key}.
64396 *
64397 * @param mixed $key The {@link key} that was used to store the
64398 *   variable in the cache. {@link key} is case sensitive. {@link key}
64399 *   can be an array of keys.
64400 * @return bool
64401 * @since PECL wincache >= 1.1.0
64402 **/
64403function wincache_ucache_delete($key){}
64404
64405/**
64406 * Checks if a variable with the {@link key} exists in the user cache or
64407 * not.
64408 *
64409 * @param string $key The {@link key} that was used to store the
64410 *   variable in the cache. {@link key} is case sensitive.
64411 * @return bool
64412 * @since PECL wincache >= 1.1.0
64413 **/
64414function wincache_ucache_exists($key){}
64415
64416/**
64417 * Gets a variable stored in the user cache.
64418 *
64419 * @param mixed $key The {@link key} that was used to store the
64420 *   variable in the cache. {@link key} is case sensitive. {@link key}
64421 *   can be an array of keys. In this case the return value will be an
64422 *   array of values of each element in the {@link key} array.
64423 * @param bool $success Will be set to TRUE on success and FALSE on
64424 *   failure.
64425 * @return mixed
64426 * @since PECL wincache >= 1.1.0
64427 **/
64428function wincache_ucache_get($key, &$success){}
64429
64430/**
64431 * Increments the value associated with the {@link key} by 1 or as
64432 * specified by {@link inc_by}.
64433 *
64434 * @param string $key The {@link key} that was used to store the
64435 *   variable in the cache. {@link key} is case sensitive.
64436 * @param long $inc_by The value by which the variable associated with
64437 *   the {@link key} will get incremented. If the argument is a floating
64438 *   point number it will be truncated to nearest integer. The variable
64439 *   associated with the {@link key} should be of type long, otherwise
64440 *   the function fails and returns FALSE.
64441 * @param bool $success Will be set to TRUE on success and FALSE on
64442 *   failure.
64443 * @return mixed
64444 * @since PECL wincache >= 1.1.0
64445 **/
64446function wincache_ucache_inc($key, $inc_by, &$success){}
64447
64448/**
64449 * Retrieves information about data stored in the user cache.
64450 *
64451 * @param bool $summaryonly Controls whether the returned array will
64452 *   contain information about individual cache entries along with the
64453 *   user cache summary.
64454 * @param string $key The key of an entry in the user cache. If
64455 *   specified then the returned array will contain information only
64456 *   about that cache entry. If not specified and {@link summaryonly} is
64457 *   set to false then the returned array will contain information about
64458 *   all entries in the cache.
64459 * @return array
64460 * @since PECL wincache >= 1.1.0
64461 **/
64462function wincache_ucache_info($summaryonly, $key){}
64463
64464/**
64465 * Retrieves information about memory usage by user cache.
64466 *
64467 * @return array
64468 * @since PECL wincache >= 1.1.0
64469 **/
64470function wincache_ucache_meminfo(){}
64471
64472/**
64473 * Adds a variable in user cache. Overwrites a variable if it already
64474 * exists in the cache. The added or updated variable remains in the user
64475 * cache unless its time to live expires or it is deleted by using {@link
64476 * wincache_ucache_delete} or {@link wincache_ucache_clear} functions.
64477 *
64478 * @param mixed $key Store the variable using this {@link key} name. If
64479 *   a variable with same {@link key} is already present the function
64480 *   will overwrite the previous value with the new one. {@link key} is
64481 *   case sensitive. {@link key} can also take array of name => value
64482 *   pairs where names will be used as keys. This can be used to add
64483 *   multiple values in the cache in one operation, thus avoiding race
64484 *   condition.
64485 * @param mixed $value Value of a variable to store. {@link Value}
64486 *   supports all data types except resources, such as file handles. This
64487 *   paramter is ignored if first argument is an array. A general
64488 *   guidance is to pass NULL as {@link value} while using array as
64489 *   {@link key}.
64490 * @param int $ttl Time for the variable to live in the cache in
64491 *   seconds. After the value specified in {@link ttl} has passed the
64492 *   stored variable will be deleted from the cache. This parameter takes
64493 *   a default value of 0 which means the variable will stay in the cache
64494 *   unless explicitly deleted by using {@link wincache_ucache_delete} or
64495 *   {@link wincache_ucache_clear} functions.
64496 * @return bool
64497 * @since PECL wincache >= 1.1.0
64498 **/
64499function wincache_ucache_set($key, $value, $ttl){}
64500
64501/**
64502 * Releases an exclusive lock that was obtained on a given key by using
64503 * {@link wincache_lock}. If any other process was blocked waiting for
64504 * the lock on this key, that process will be able to obtain the lock.
64505 *
64506 * @param string $key Name of the key in the cache to release the lock
64507 *   on.
64508 * @return bool
64509 * @since PECL wincache >= 1.1.0
64510 **/
64511function wincache_unlock($key){}
64512
64513/**
64514 * Wraps a string to a given number of characters using a string break
64515 * character.
64516 *
64517 * @param string $str The input string.
64518 * @param int $width The column width.
64519 * @param string $break The line is broken using the optional {@link
64520 *   break} parameter.
64521 * @param bool $cut If the {@link cut} is set to , the string is always
64522 *   wrapped at or before the specified width. So if you have a word that
64523 *   is larger than the given width, it is broken apart. (See second
64524 *   example).
64525 * @return string
64526 * @since PHP 4 >= 4.0.2, PHP 5
64527 **/
64528function wordwrap($str, $width, $break, $cut){}
64529
64530/**
64531 * This function gets the value of an extended attribute of a file.
64532 *
64533 * @param string $filename The file from which we get the attribute.
64534 * @param string $name The name of the attribute.
64535 * @param int $flags Supported xattr flags XATTR_DONTFOLLOW Do not
64536 *   follow the symbolic link but operate on symbolic link itself.
64537 *   XATTR_ROOT Set attribute in root (trusted) namespace. Requires root
64538 *   privileges.
64539 * @return string
64540 * @since PECL xattr >= 0.9.0
64541 **/
64542function xattr_get($filename, $name, $flags){}
64543
64544/**
64545 * This functions gets a list of names of extended attributes of a file.
64546 *
64547 * @param string $filename The path of the file.
64548 * @param int $flags Supported xattr flags XATTR_DONTFOLLOW Do not
64549 *   follow the symbolic link but operate on symbolic link itself.
64550 *   XATTR_ROOT Set attribute in root (trusted) namespace. Requires root
64551 *   privileges.
64552 * @return array
64553 * @since PECL xattr >= 0.9.0
64554 **/
64555function xattr_list($filename, $flags){}
64556
64557/**
64558 * This function removes an extended attribute of a file.
64559 *
64560 * @param string $filename The file from which we remove the attribute.
64561 * @param string $name The name of the attribute to remove.
64562 * @param int $flags Supported xattr flags XATTR_DONTFOLLOW Do not
64563 *   follow the symbolic link but operate on symbolic link itself.
64564 *   XATTR_ROOT Set attribute in root (trusted) namespace. Requires root
64565 *   privileges.
64566 * @return bool
64567 * @since PECL xattr >= 0.9.0
64568 **/
64569function xattr_remove($filename, $name, $flags){}
64570
64571/**
64572 * This function sets the value of an extended attribute of a file.
64573 *
64574 * @param string $filename The file in which we set the attribute.
64575 * @param string $name The name of the extended attribute. This
64576 *   attribute will be created if it doesn't exist or replaced otherwise.
64577 *   You can change this behaviour by using the {@link flags} parameter.
64578 * @param string $value The value of the attribute.
64579 * @param int $flags Supported xattr flags XATTR_CREATE Function will
64580 *   fail if extended attribute already exists. XATTR_REPLACE Function
64581 *   will fail if extended attribute doesn't exist. XATTR_DONTFOLLOW Do
64582 *   not follow the symbolic link but operate on symbolic link itself.
64583 *   XATTR_ROOT Set attribute in root (trusted) namespace. Requires root
64584 *   privileges.
64585 * @return bool
64586 * @since PECL xattr >= 0.9.0
64587 **/
64588function xattr_set($filename, $name, $value, $flags){}
64589
64590/**
64591 * This functions checks if the filesystem holding the given file
64592 * supports extended attributes. Read access to the file is required.
64593 *
64594 * @param string $filename The path of the tested file.
64595 * @param int $flags Supported xattr flags XATTR_DONTFOLLOW Do not
64596 *   follow the symbolic link but operate on symbolic link itself.
64597 * @return bool
64598 * @since PECL xattr >= 1.0.0
64599 **/
64600function xattr_supported($filename, $flags){}
64601
64602/**
64603 * Makes a binary diff of two files and stores the result in a patch
64604 * file. This function works with both text and binary files. Resulting
64605 * patch file can be later applied using {@link xdiff_file_bpatch}/{@link
64606 * xdiff_string_bpatch}.
64607 *
64608 * @param string $old_file Path to the first file. This file acts as
64609 *   "old" file.
64610 * @param string $new_file Path to the second file. This file acts as
64611 *   "new" file.
64612 * @param string $dest Path of the resulting patch file. Resulting file
64613 *   contains differences between "old" and "new" files. It is in binary
64614 *   format and is human-unreadable.
64615 * @return bool
64616 * @since PECL xdiff >= 0.2.0
64617 **/
64618function xdiff_file_bdiff($old_file, $new_file, $dest){}
64619
64620/**
64621 * Returns a size of a result file that would be created after applying
64622 * binary patch from file {@link file} to the original file.
64623 *
64624 * @param string $file The path to the binary patch created by {@link
64625 *   xdiff_string_bdiff} or {@link xdiff_string_rabdiff} function.
64626 * @return int
64627 * @since PECL xdiff >= 0.2.0
64628 **/
64629function xdiff_file_bdiff_size($file){}
64630
64631/**
64632 * Patches a {@link file} with a binary {@link patch} and stores the
64633 * result in a file {@link dest}. This function accepts patches created
64634 * both via {@link xdiff_file_bdiff} and {@link xdiff_file_rabdiff}
64635 * functions or their string counterparts.
64636 *
64637 * @param string $file The original file.
64638 * @param string $patch The binary patch file.
64639 * @param string $dest Path of the resulting file.
64640 * @return bool
64641 * @since PECL xdiff >= 0.2.0
64642 **/
64643function xdiff_file_bpatch($file, $patch, $dest){}
64644
64645/**
64646 * Makes an unified diff containing differences between {@link old_file}
64647 * and {@link new_file} and stores it in {@link dest} file. The resulting
64648 * file is human-readable. An optional {@link context} parameter
64649 * specifies how many lines of context should be added around each
64650 * change. Setting {@link minimal} parameter to true will result in
64651 * outputting the shortest patch file possible (can take a long time).
64652 *
64653 * @param string $old_file Path to the first file. This file acts as
64654 *   "old" file.
64655 * @param string $new_file Path to the second file. This file acts as
64656 *   "new" file.
64657 * @param string $dest Path of the resulting patch file.
64658 * @param int $context Indicates how many lines of context you want to
64659 *   include in diff result.
64660 * @param bool $minimal Set this parameter to if you want to minimalize
64661 *   size of the result (can take a long time).
64662 * @return bool
64663 * @since PECL xdiff >= 0.2.0
64664 **/
64665function xdiff_file_diff($old_file, $new_file, $dest, $context, $minimal){}
64666
64667/**
64668 * Makes a binary diff of two files and stores the result in a patch
64669 * file. This function works with both text and binary files. Resulting
64670 * patch file can be later applied using {@link xdiff_file_bpatch}.
64671 *
64672 * Starting with version 1.5.0 this function is an alias of {@link
64673 * xdiff_file_bdiff}.
64674 *
64675 * @param string $old_file Path to the first file. This file acts as
64676 *   "old" file.
64677 * @param string $new_file Path to the second file. This file acts as
64678 *   "new" file.
64679 * @param string $dest Path of the resulting patch file. Resulting file
64680 *   contains differences between "old" and "new" files. It is in binary
64681 *   format and is human-unreadable.
64682 * @return bool
64683 * @since PECL xdiff >= 0.2.0
64684 **/
64685function xdiff_file_diff_binary($old_file, $new_file, $dest){}
64686
64687/**
64688 * Merges three files into one and stores the result in a file {@link
64689 * dest}. The {@link old_file} is an original version while {@link
64690 * new_file1} and {@link new_file2} are modified versions of an original.
64691 *
64692 * @param string $old_file Path to the first file. It acts as "old"
64693 *   file.
64694 * @param string $new_file1 Path to the second file. It acts as
64695 *   modified version of {@link old_file}.
64696 * @param string $new_file2 Path to the third file. It acts as modified
64697 *   version of {@link old_file}.
64698 * @param string $dest Path of the resulting file, containing merged
64699 *   changed from both {@link new_file1} and {@link new_file2}.
64700 * @return mixed
64701 * @since PECL xdiff >= 0.2.0
64702 **/
64703function xdiff_file_merge3($old_file, $new_file1, $new_file2, $dest){}
64704
64705/**
64706 * Patches a {@link file} with a {@link patch} and stores the result in a
64707 * file. {@link patch} has to be an unified diff created by {@link
64708 * xdiff_file_diff}/{@link xdiff_string_diff} function. An optional
64709 * {@link flags} parameter specifies mode of operation.
64710 *
64711 * @param string $file The original file.
64712 * @param string $patch The unified patch file. It has to be created
64713 *   using {@link xdiff_string_diff}, {@link xdiff_file_diff} functions
64714 *   or compatible tools.
64715 * @param string $dest Path of the resulting file.
64716 * @param int $flags Can be either XDIFF_PATCH_NORMAL (default mode,
64717 *   normal patch) or XDIFF_PATCH_REVERSE (reversed patch). Starting from
64718 *   version 1.5.0, you can also use binary OR to enable
64719 *   XDIFF_PATCH_IGNORESPACE flag.
64720 * @return mixed
64721 * @since PECL xdiff >= 0.2.0
64722 **/
64723function xdiff_file_patch($file, $patch, $dest, $flags){}
64724
64725/**
64726 * Patches a {@link file} with a binary {@link patch} and stores the
64727 * result in a file {@link dest}. This function accepts patches created
64728 * both via {@link xdiff_file_bdiff} or {@link xdiff_file_rabdiff}
64729 * functions or their string counterparts.
64730 *
64731 * Starting with version 1.5.0 this function is an alias of {@link
64732 * xdiff_file_bpatch}.
64733 *
64734 * @param string $file The original file.
64735 * @param string $patch The binary patch file.
64736 * @param string $dest Path of the resulting file.
64737 * @return bool
64738 * @since PECL xdiff >= 0.2.0
64739 **/
64740function xdiff_file_patch_binary($file, $patch, $dest){}
64741
64742/**
64743 * Makes a binary diff of two files and stores the result in a patch
64744 * file. The difference between this function and {@link
64745 * xdiff_file_bdiff} is different algorithm used which should result in
64746 * faster execution and smaller diff produced. This function works with
64747 * both text and binary files. Resulting patch file can be later applied
64748 * using {@link xdiff_file_bpatch}/{@link xdiff_string_bpatch}.
64749 *
64750 * For more details about differences between algorithm used please check
64751 * libxdiff website.
64752 *
64753 * @param string $old_file Path to the first file. This file acts as
64754 *   "old" file.
64755 * @param string $new_file Path to the second file. This file acts as
64756 *   "new" file.
64757 * @param string $dest Path of the resulting patch file. Resulting file
64758 *   contains differences between "old" and "new" files. It is in binary
64759 *   format and is human-unreadable.
64760 * @return bool
64761 * @since PECL xdiff >= 0.2.0
64762 **/
64763function xdiff_file_rabdiff($old_file, $new_file, $dest){}
64764
64765/**
64766 * Makes a binary diff of two strings and returns the result. This
64767 * function works with both text and binary data. Resulting patch can be
64768 * later applied using {@link xdiff_string_bpatch}/{@link
64769 * xdiff_file_bpatch}.
64770 *
64771 * @param string $old_data First string with binary data. It acts as
64772 *   "old" data.
64773 * @param string $new_data Second string with binary data. It acts as
64774 *   "new" data.
64775 * @return string
64776 * @since PECL xdiff >= 0.2.0
64777 **/
64778function xdiff_string_bdiff($old_data, $new_data){}
64779
64780/**
64781 * Returns a size of a result file that would be created after applying
64782 * binary {@link patch} to the original file.
64783 *
64784 * @param string $patch The binary patch created by {@link
64785 *   xdiff_string_bdiff} or {@link xdiff_string_rabdiff} function.
64786 * @return int
64787 * @since PECL xdiff >= 0.2.0
64788 **/
64789function xdiff_string_bdiff_size($patch){}
64790
64791/**
64792 * Patches a string {@link str} with a binary {@link patch}. This
64793 * function accepts patches created both via {@link xdiff_string_bdiff}
64794 * and {@link xdiff_string_rabdiff} functions or their file counterparts.
64795 *
64796 * @param string $str The original binary string.
64797 * @param string $patch The binary patch string.
64798 * @return string
64799 * @since PECL xdiff >= 0.2.0
64800 **/
64801function xdiff_string_bpatch($str, $patch){}
64802
64803/**
64804 * Makes an unified diff containing differences between {@link old_data}
64805 * string and {@link new_data} string and returns it. The resulting diff
64806 * is human-readable. An optional {@link context} parameter specifies how
64807 * many lines of context should be added around each change. Setting
64808 * {@link minimal} parameter to true will result in outputting the
64809 * shortest patch file possible (can take a long time).
64810 *
64811 * @param string $old_data First string with data. It acts as "old"
64812 *   data.
64813 * @param string $new_data Second string with data. It acts as "new"
64814 *   data.
64815 * @param int $context Indicates how many lines of context you want to
64816 *   include in the diff result.
64817 * @param bool $minimal Set this parameter to if you want to minimalize
64818 *   the size of the result (can take a long time).
64819 * @return string
64820 * @since PECL xdiff >= 0.2.0
64821 **/
64822function xdiff_string_diff($old_data, $new_data, $context, $minimal){}
64823
64824/**
64825 * Merges three strings into one and returns the result. The {@link
64826 * old_data} is an original version of data while {@link new_file1} and
64827 * {@link new_file2} are modified versions of an original. An optional
64828 * {@link error} is used to pass any rejected parts during merging
64829 * process.
64830 *
64831 * @param string $old_data First string with data. It acts as "old"
64832 *   data.
64833 * @param string $new_data1 Second string with data. It acts as
64834 *   modified version of {@link old_data}.
64835 * @param string $new_data2 Third string with data. It acts as modified
64836 *   version of {@link old_data}.
64837 * @param string $error If provided then rejected parts are stored
64838 *   inside this variable.
64839 * @return mixed
64840 * @since PECL xdiff >= 0.2.0
64841 **/
64842function xdiff_string_merge3($old_data, $new_data1, $new_data2, &$error){}
64843
64844/**
64845 * Patches a {@link str} string with an unified patch in {@link patch}
64846 * parameter and returns the result. {@link patch} has to be an unified
64847 * diff created by {@link xdiff_file_diff}/{@link xdiff_string_diff}
64848 * function. An optional {@link flags} parameter specifies mode of
64849 * operation. Any rejected parts of the patch will be stored inside
64850 * {@link error} variable if it is provided.
64851 *
64852 * @param string $str The original string.
64853 * @param string $patch The unified patch string. It has to be created
64854 *   using {@link xdiff_string_diff}, {@link xdiff_file_diff} functions
64855 *   or compatible tools.
64856 * @param int $flags {@link flags} can be either XDIFF_PATCH_NORMAL
64857 *   (default mode, normal patch) or XDIFF_PATCH_REVERSE (reversed
64858 *   patch). Starting from version 1.5.0, you can also use binary OR to
64859 *   enable XDIFF_PATCH_IGNORESPACE flag.
64860 * @param string $error If provided then rejected parts are stored
64861 *   inside this variable.
64862 * @return string
64863 * @since PECL xdiff >= 0.2.0
64864 **/
64865function xdiff_string_patch($str, $patch, $flags, &$error){}
64866
64867/**
64868 * Patches a string {@link str} with a binary {@link patch}. This
64869 * function accepts patches created both via {@link xdiff_string_bdiff}
64870 * and {@link xdiff_string_rabdiff} functions or their file counterparts.
64871 *
64872 * Starting with version 1.5.0 this function is an alias of {@link
64873 * xdiff_string_bpatch}.
64874 *
64875 * @param string $str The original binary string.
64876 * @param string $patch The binary patch string.
64877 * @return string
64878 * @since PECL xdiff >= 0.2.0
64879 **/
64880function xdiff_string_patch_binary($str, $patch){}
64881
64882/**
64883 * @param string $xml XML response returned by XMLRPC method.
64884 * @param string $encoding Input encoding supported by iconv.
64885 * @return mixed
64886 * @since PHP 4 >= 4.1.0, PHP 5
64887 **/
64888function xmlrpc_decode($xml, $encoding){}
64889
64890/**
64891 * @param string $xml
64892 * @param string $method
64893 * @param string $encoding
64894 * @return mixed
64895 * @since PHP 4 >= 4.1.0, PHP 5
64896 **/
64897function xmlrpc_decode_request($xml, &$method, $encoding){}
64898
64899/**
64900 * @param mixed $value
64901 * @return string
64902 * @since PHP 4 >= 4.1.0, PHP 5
64903 **/
64904function xmlrpc_encode($value){}
64905
64906/**
64907 * @param string $method Name of the method to call.
64908 * @param mixed $params Method parameters compatible with method
64909 *   signature.
64910 * @param array $output_options Array specifying output options may
64911 *   contain (default values are emphasised): output_type: php, xml
64912 *   verbosity: no_white_space, newlines_only, pretty escaping: cdata,
64913 *   non-ascii, non-print, markup (may be a string with one value or an
64914 *   array with multiple values) version: simple, xmlrpc, soap 1.1, auto
64915 *   encoding: iso-8859-1, other character set supported by iconv
64916 * @return string
64917 * @since PHP 4 >= 4.1.0, PHP 5
64918 **/
64919function xmlrpc_encode_request($method, $params, $output_options){}
64920
64921/**
64922 * This function is especially useful for base64 and datetime strings.
64923 *
64924 * @param mixed $value
64925 * @return string
64926 * @since PHP 4 >= 4.1.0, PHP 5
64927 **/
64928function xmlrpc_get_type($value){}
64929
64930/**
64931 * @param array $arg Array returned by {@link xmlrpc_decode}.
64932 * @return bool
64933 * @since PHP 4 >= 4.3.0, PHP 5
64934 **/
64935function xmlrpc_is_fault($arg){}
64936
64937/**
64938 * @param string $xml
64939 * @return array
64940 * @since PHP 4 >= 4.1.0, PHP 5
64941 **/
64942function xmlrpc_parse_method_descriptions($xml){}
64943
64944/**
64945 * @param resource $server
64946 * @param array $desc
64947 * @return int
64948 * @since PHP 4 >= 4.1.0, PHP 5
64949 **/
64950function xmlrpc_server_add_introspection_data($server, $desc){}
64951
64952/**
64953 * @param resource $server
64954 * @param string $xml
64955 * @param mixed $user_data
64956 * @param array $output_options
64957 * @return string
64958 * @since PHP 4 >= 4.1.0, PHP 5
64959 **/
64960function xmlrpc_server_call_method($server, $xml, $user_data, $output_options){}
64961
64962/**
64963 * @return resource
64964 * @since PHP 4 >= 4.1.0, PHP 5
64965 **/
64966function xmlrpc_server_create(){}
64967
64968/**
64969 * @param resource $server
64970 * @return int
64971 * @since PHP 4 >= 4.1.0, PHP 5
64972 **/
64973function xmlrpc_server_destroy($server){}
64974
64975/**
64976 * @param resource $server
64977 * @param string $function
64978 * @return bool
64979 * @since PHP 4 >= 4.1.0, PHP 5
64980 **/
64981function xmlrpc_server_register_introspection_callback($server, $function){}
64982
64983/**
64984 * @param resource $server
64985 * @param string $method_name
64986 * @param string $function
64987 * @return bool
64988 * @since PHP 4 >= 4.1.0, PHP 5
64989 **/
64990function xmlrpc_server_register_method($server, $method_name, $function){}
64991
64992/**
64993 * Sets xmlrpc type, base64 or datetime, for a PHP string value.
64994 *
64995 * @param string $value Value to set the type
64996 * @param string $type 'base64' or 'datetime'
64997 * @return bool
64998 * @since PHP 4 >= 4.1.0, PHP 5
64999 **/
65000function xmlrpc_set_type(&$value, $type){}
65001
65002/**
65003 * Ends the current attribute.
65004 *
65005 * @param resource $xmlwriter
65006 * @return bool
65007 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65008 **/
65009function xmlwriter_end_attribute($xmlwriter){}
65010
65011/**
65012 * Ends the current CDATA section.
65013 *
65014 * @param resource $xmlwriter
65015 * @return bool
65016 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65017 **/
65018function xmlwriter_end_cdata($xmlwriter){}
65019
65020/**
65021 * Ends the current comment.
65022 *
65023 * @param resource $xmlwriter
65024 * @return bool
65025 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 1.0.0
65026 **/
65027function xmlwriter_end_comment($xmlwriter){}
65028
65029/**
65030 * Ends the current document.
65031 *
65032 * @param resource $xmlwriter
65033 * @return bool
65034 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65035 **/
65036function xmlwriter_end_document($xmlwriter){}
65037
65038/**
65039 * Ends the DTD of the document.
65040 *
65041 * @param resource $xmlwriter
65042 * @return bool
65043 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65044 **/
65045function xmlwriter_end_dtd($xmlwriter){}
65046
65047/**
65048 * Ends the current DTD attribute list.
65049 *
65050 * @param resource $xmlwriter
65051 * @return bool
65052 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65053 **/
65054function xmlwriter_end_dtd_attlist($xmlwriter){}
65055
65056/**
65057 * Ends the current DTD element.
65058 *
65059 * @param resource $xmlwriter
65060 * @return bool
65061 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65062 **/
65063function xmlwriter_end_dtd_element($xmlwriter){}
65064
65065/**
65066 * Ends the current DTD entity.
65067 *
65068 * @param resource $xmlwriter
65069 * @return bool
65070 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65071 **/
65072function xmlwriter_end_dtd_entity($xmlwriter){}
65073
65074/**
65075 * Ends the current element.
65076 *
65077 * @param resource $xmlwriter
65078 * @return bool
65079 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65080 **/
65081function xmlwriter_end_element($xmlwriter){}
65082
65083/**
65084 * Ends the current processing instruction.
65085 *
65086 * @param resource $xmlwriter
65087 * @return bool
65088 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65089 **/
65090function xmlwriter_end_pi($xmlwriter){}
65091
65092/**
65093 * Flushes the current buffer.
65094 *
65095 * @param resource $xmlwriter Whether to empty the buffer or no.
65096 *   Default is .
65097 * @param bool $empty
65098 * @return mixed
65099 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 1.0.0
65100 **/
65101function xmlwriter_flush($xmlwriter, $empty){}
65102
65103/**
65104 * End the current xml element. Writes an end tag even if the element is
65105 * empty.
65106 *
65107 * @param resource $xmlwriter
65108 * @return bool
65109 * @since PHP 5 >= 5.2.0, PECL xmlwriter >= 2.0.4
65110 **/
65111function xmlwriter_full_end_element($xmlwriter){}
65112
65113/**
65114 * Creates a new XMLWriter using memory for string output.
65115 *
65116 * @return resource
65117 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65118 **/
65119function xmlwriter_open_memory(){}
65120
65121/**
65122 * Creates a new XMLWriter using {@link uri} for the output.
65123 *
65124 * @param string $uri The URI of the resource for the output.
65125 * @return resource
65126 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65127 **/
65128function xmlwriter_open_uri($uri){}
65129
65130/**
65131 * Returns the current buffer.
65132 *
65133 * @param resource $xmlwriter Whether to flush the output buffer or no.
65134 *   Default is .
65135 * @param bool $flush
65136 * @return string
65137 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65138 **/
65139function xmlwriter_output_memory($xmlwriter, $flush){}
65140
65141/**
65142 * Toggles indentation on or off.
65143 *
65144 * @param resource $xmlwriter Whether indentation is enabled.
65145 * @param bool $indent
65146 * @return bool
65147 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65148 **/
65149function xmlwriter_set_indent($xmlwriter, $indent){}
65150
65151/**
65152 * Sets the string which will be used to indent each element/attribute of
65153 * the resulting xml.
65154 *
65155 * @param resource $xmlwriter The indentation string.
65156 * @param string $indentString
65157 * @return bool
65158 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65159 **/
65160function xmlwriter_set_indent_string($xmlwriter, $indentString){}
65161
65162/**
65163 * Starts an attribute.
65164 *
65165 * @param resource $xmlwriter The attribute name.
65166 * @param string $name
65167 * @return bool
65168 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65169 **/
65170function xmlwriter_start_attribute($xmlwriter, $name){}
65171
65172/**
65173 * Starts a namespaced attribute.
65174 *
65175 * @param resource $xmlwriter The namespace prefix.
65176 * @param string $prefix The attribute name.
65177 * @param string $name The namespace URI.
65178 * @param string $uri
65179 * @return bool
65180 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65181 **/
65182function xmlwriter_start_attribute_ns($xmlwriter, $prefix, $name, $uri){}
65183
65184/**
65185 * Starts a CDATA.
65186 *
65187 * @param resource $xmlwriter
65188 * @return bool
65189 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65190 **/
65191function xmlwriter_start_cdata($xmlwriter){}
65192
65193/**
65194 * Starts a comment.
65195 *
65196 * @param resource $xmlwriter
65197 * @return bool
65198 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 1.0.0
65199 **/
65200function xmlwriter_start_comment($xmlwriter){}
65201
65202/**
65203 * Starts a document.
65204 *
65205 * @param resource $xmlwriter The version number of the document as
65206 *   part of the XML declaration. Defaults to 1.0.
65207 * @param string $version The encoding of the document as part of the
65208 *   XML declaration. by default.
65209 * @param string $encoding yes or no.
65210 * @param string $standalone
65211 * @return bool
65212 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65213 **/
65214function xmlwriter_start_document($xmlwriter, $version, $encoding, $standalone){}
65215
65216/**
65217 * Starts a DTD.
65218 *
65219 * @param resource $xmlwriter The qualified name of the document type
65220 *   to create.
65221 * @param string $qualifiedName The external subset public identifier.
65222 * @param string $publicId The external subset system identifier.
65223 * @param string $systemId
65224 * @return bool
65225 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65226 **/
65227function xmlwriter_start_dtd($xmlwriter, $qualifiedName, $publicId, $systemId){}
65228
65229/**
65230 * Starts a DTD attribute list.
65231 *
65232 * @param resource $xmlwriter The attribute list name.
65233 * @param string $name
65234 * @return bool
65235 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65236 **/
65237function xmlwriter_start_dtd_attlist($xmlwriter, $name){}
65238
65239/**
65240 * Starts a DTD element.
65241 *
65242 * @param resource $xmlwriter The qualified name of the document type
65243 *   to create.
65244 * @param string $qualifiedName
65245 * @return bool
65246 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65247 **/
65248function xmlwriter_start_dtd_element($xmlwriter, $qualifiedName){}
65249
65250/**
65251 * Starts a DTD entity.
65252 *
65253 * @param resource $xmlwriter The name of the entity.
65254 * @param string $name
65255 * @param bool $isparam
65256 * @return bool
65257 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65258 **/
65259function xmlwriter_start_dtd_entity($xmlwriter, $name, $isparam){}
65260
65261/**
65262 * Starts an element.
65263 *
65264 * @param resource $xmlwriter The element name.
65265 * @param string $name
65266 * @return bool
65267 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65268 **/
65269function xmlwriter_start_element($xmlwriter, $name){}
65270
65271/**
65272 * Starts a namespaced element.
65273 *
65274 * @param resource $xmlwriter The namespace prefix.
65275 * @param string $prefix The element name.
65276 * @param string $name The namespace URI.
65277 * @param string $uri
65278 * @return bool
65279 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65280 **/
65281function xmlwriter_start_element_ns($xmlwriter, $prefix, $name, $uri){}
65282
65283/**
65284 * Starts a processing instruction tag.
65285 *
65286 * @param resource $xmlwriter The target of the processing instruction.
65287 * @param string $target
65288 * @return bool
65289 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65290 **/
65291function xmlwriter_start_pi($xmlwriter, $target){}
65292
65293/**
65294 * Writes a text.
65295 *
65296 * @param resource $xmlwriter The contents of the text.
65297 * @param string $content
65298 * @return bool
65299 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65300 **/
65301function xmlwriter_text($xmlwriter, $content){}
65302
65303/**
65304 * Writes a full attribute.
65305 *
65306 * @param resource $xmlwriter The name of the attribute.
65307 * @param string $name The value of the attribute.
65308 * @param string $value
65309 * @return bool
65310 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65311 **/
65312function xmlwriter_write_attribute($xmlwriter, $name, $value){}
65313
65314/**
65315 * Writes a full namespaced attribute.
65316 *
65317 * @param resource $xmlwriter The namespace prefix.
65318 * @param string $prefix The attribute name.
65319 * @param string $name The namespace URI.
65320 * @param string $uri The attribute value.
65321 * @param string $content
65322 * @return bool
65323 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65324 **/
65325function xmlwriter_write_attribute_ns($xmlwriter, $prefix, $name, $uri, $content){}
65326
65327/**
65328 * Writes a full CDATA.
65329 *
65330 * @param resource $xmlwriter The contents of the CDATA.
65331 * @param string $content
65332 * @return bool
65333 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65334 **/
65335function xmlwriter_write_cdata($xmlwriter, $content){}
65336
65337/**
65338 * Writes a full comment.
65339 *
65340 * @param resource $xmlwriter The contents of the comment.
65341 * @param string $content
65342 * @return bool
65343 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65344 **/
65345function xmlwriter_write_comment($xmlwriter, $content){}
65346
65347/**
65348 * Writes a full DTD.
65349 *
65350 * @param resource $xmlwriter The DTD name.
65351 * @param string $name The external subset public identifier.
65352 * @param string $publicId The external subset system identifier.
65353 * @param string $systemId The content of the DTD.
65354 * @param string $subset
65355 * @return bool
65356 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65357 **/
65358function xmlwriter_write_dtd($xmlwriter, $name, $publicId, $systemId, $subset){}
65359
65360/**
65361 * Writes a DTD attribute list.
65362 *
65363 * @param resource $xmlwriter The name of the DTD attribute list.
65364 * @param string $name The content of the DTD attribute list.
65365 * @param string $content
65366 * @return bool
65367 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65368 **/
65369function xmlwriter_write_dtd_attlist($xmlwriter, $name, $content){}
65370
65371/**
65372 * Writes a full DTD element.
65373 *
65374 * @param resource $xmlwriter The name of the DTD element.
65375 * @param string $name The content of the element.
65376 * @param string $content
65377 * @return bool
65378 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65379 **/
65380function xmlwriter_write_dtd_element($xmlwriter, $name, $content){}
65381
65382/**
65383 * Writes a full DTD entity.
65384 *
65385 * @param resource $xmlwriter The name of the entity.
65386 * @param string $name The content of the entity.
65387 * @param string $content
65388 * @param bool $pe
65389 * @param string $pubid
65390 * @param string $sysid
65391 * @param string $ndataid
65392 * @return bool
65393 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65394 **/
65395function xmlwriter_write_dtd_entity($xmlwriter, $name, $content, $pe, $pubid, $sysid, $ndataid){}
65396
65397/**
65398 * Writes a full element tag.
65399 *
65400 * @param resource $xmlwriter The element name.
65401 * @param string $name The element contents.
65402 * @param string $content
65403 * @return bool
65404 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65405 **/
65406function xmlwriter_write_element($xmlwriter, $name, $content){}
65407
65408/**
65409 * Writes a full namespaced element tag.
65410 *
65411 * @param resource $xmlwriter The namespace prefix.
65412 * @param string $prefix The element name.
65413 * @param string $name The namespace URI.
65414 * @param string $uri The element contents.
65415 * @param string $content
65416 * @return bool
65417 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65418 **/
65419function xmlwriter_write_element_ns($xmlwriter, $prefix, $name, $uri, $content){}
65420
65421/**
65422 * Writes a processing instruction.
65423 *
65424 * @param resource $xmlwriter The target of the processing instruction.
65425 * @param string $target The content of the processing instruction.
65426 * @param string $content
65427 * @return bool
65428 * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
65429 **/
65430function xmlwriter_write_pi($xmlwriter, $target, $content){}
65431
65432/**
65433 * Writes a raw xml text.
65434 *
65435 * @param resource $xmlwriter The text string to write.
65436 * @param string $content
65437 * @return bool
65438 * @since PHP 5 >= 5.2.0, PECL xmlwriter >= 2.0.4
65439 **/
65440function xmlwriter_write_raw($xmlwriter, $content){}
65441
65442/**
65443 * Gets the XML parser error string associated with the given {@link
65444 * code}.
65445 *
65446 * @param int $code An error code from {@link xml_get_error_code}.
65447 * @return string
65448 * @since PHP 4, PHP 5
65449 **/
65450function xml_error_string($code){}
65451
65452/**
65453 * Gets the current byte index of the given XML parser.
65454 *
65455 * @param resource $parser A reference to the XML parser to get byte
65456 *   index from.
65457 * @return int
65458 * @since PHP 4, PHP 5
65459 **/
65460function xml_get_current_byte_index($parser){}
65461
65462/**
65463 * Gets the current column number of the given XML parser.
65464 *
65465 * @param resource $parser A reference to the XML parser to get column
65466 *   number from.
65467 * @return int
65468 * @since PHP 4, PHP 5
65469 **/
65470function xml_get_current_column_number($parser){}
65471
65472/**
65473 * Gets the current line number for the given XML parser.
65474 *
65475 * @param resource $parser A reference to the XML parser to get line
65476 *   number from.
65477 * @return int
65478 * @since PHP 4, PHP 5
65479 **/
65480function xml_get_current_line_number($parser){}
65481
65482/**
65483 * Gets the XML parser error code.
65484 *
65485 * @param resource $parser A reference to the XML parser to get error
65486 *   code from.
65487 * @return int
65488 * @since PHP 4, PHP 5
65489 **/
65490function xml_get_error_code($parser){}
65491
65492/**
65493 * {@link xml_parse} parses an XML document. The handlers for the
65494 * configured events are called as many times as necessary.
65495 *
65496 * @param resource $parser A reference to the XML parser to use.
65497 * @param string $data Chunk of data to parse. A document may be parsed
65498 *   piece-wise by calling {@link xml_parse} several times with new data,
65499 *   as long as the {@link is_final} parameter is set and when the last
65500 *   data is parsed.
65501 * @param bool $is_final If set and , {@link data} is the last piece of
65502 *   data sent in this parse.
65503 * @return int
65504 * @since PHP 4, PHP 5
65505 **/
65506function xml_parse($parser, $data, $is_final){}
65507
65508/**
65509 * {@link xml_parser_create} creates a new XML parser and returns a
65510 * resource handle referencing it to be used by the other XML functions.
65511 *
65512 * @param string $encoding The optional {@link encoding} specifies the
65513 *   character encoding for the input/output in PHP 4. Starting from PHP
65514 *   5, the input encoding is automatically detected, so that the {@link
65515 *   encoding} parameter specifies only the output encoding. In PHP 4,
65516 *   the default output encoding is the same as the input charset. If
65517 *   empty string is passed, the parser attempts to identify which
65518 *   encoding the document is encoded in by looking at the heading 3 or 4
65519 *   bytes. In PHP 5.0.0 and 5.0.1, the default output charset is
65520 *   ISO-8859-1, while in PHP 5.0.2 and upper is UTF-8. The supported
65521 *   encodings are ISO-8859-1, UTF-8 and US-ASCII.
65522 * @return resource
65523 * @since PHP 4, PHP 5
65524 **/
65525function xml_parser_create($encoding){}
65526
65527/**
65528 * {@link xml_parser_create_ns} creates a new XML parser with XML
65529 * namespace support and returns a resource handle referencing it to be
65530 * used by the other XML functions.
65531 *
65532 * @param string $encoding The optional {@link encoding} specifies the
65533 *   character encoding for the input/output in PHP 4. Starting from PHP
65534 *   5, the input encoding is automatically detected, so that the {@link
65535 *   encoding} parameter specifies only the output encoding. In PHP 4,
65536 *   the default output encoding is the same as the input charset. In PHP
65537 *   5.0.0 and 5.0.1, the default output charset is ISO-8859-1, while in
65538 *   PHP 5.0.2 and upper is UTF-8. The supported encodings are
65539 *   ISO-8859-1, UTF-8 and US-ASCII.
65540 * @param string $separator With a namespace aware parser tag
65541 *   parameters passed to the various handler functions will consist of
65542 *   namespace and tag name separated by the string specified in {@link
65543 *   seperator}.
65544 * @return resource
65545 * @since PHP 4 >= 4.0.5, PHP 5
65546 **/
65547function xml_parser_create_ns($encoding, $separator){}
65548
65549/**
65550 * Frees the given XML {@link parser}.
65551 *
65552 * @param resource $parser
65553 * @return bool
65554 * @since PHP 4, PHP 5
65555 **/
65556function xml_parser_free($parser){}
65557
65558/**
65559 * Gets an option value from an XML parser.
65560 *
65561 * @param resource $parser
65562 * @param int $option
65563 * @return mixed
65564 * @since PHP 4, PHP 5
65565 **/
65566function xml_parser_get_option($parser, $option){}
65567
65568/**
65569 * Sets an option in an XML parser.
65570 *
65571 * @param resource $parser A reference to the XML parser to set an
65572 *   option in.
65573 * @param int $option Which option to set. See below. The following
65574 *   options are available: XML parser options Option constant Data type
65575 *   Description XML_OPTION_CASE_FOLDING integer Controls whether
65576 *   case-folding is enabled for this XML parser. Enabled by default.
65577 *   XML_OPTION_SKIP_TAGSTART integer Specify how many characters should
65578 *   be skipped in the beginning of a tag name. XML_OPTION_SKIP_WHITE
65579 *   integer Whether to skip values consisting of whitespace characters.
65580 *   XML_OPTION_TARGET_ENCODING string Sets which target encoding to use
65581 *   in this XML parser.By default, it is set to the same as the source
65582 *   encoding used by {@link xml_parser_create}. Supported target
65583 *   encodings are ISO-8859-1, US-ASCII and UTF-8.
65584 * @param mixed $value The option's new value.
65585 * @return bool
65586 * @since PHP 4, PHP 5
65587 **/
65588function xml_parser_set_option($parser, $option, $value){}
65589
65590/**
65591 * This function parses an XML file into 2 parallel array structures, one
65592 * ({@link index}) containing pointers to the location of the appropriate
65593 * values in the {@link values} array. These last two parameters must be
65594 * passed by reference.
65595 *
65596 * @param resource $parser
65597 * @param string $data
65598 * @param array $values
65599 * @param array $index
65600 * @return int
65601 * @since PHP 4, PHP 5
65602 **/
65603function xml_parse_into_struct($parser, $data, &$values, &$index){}
65604
65605/**
65606 * Sets the character data handler function for the XML parser {@link
65607 * parser}.
65608 *
65609 * @param resource $parser
65610 * @param callback $handler {@link handler} is a string containing the
65611 *   name of a function that must exist when {@link xml_parse} is called
65612 *   for {@link parser}. The function named by {@link handler} must
65613 *   accept two parameters: handler resource{@link parser} string{@link
65614 *   data} {@link parser} The first parameter, parser, is a reference to
65615 *   the XML parser calling the handler. {@link data} The second
65616 *   parameter, {@link data}, contains the character data as a string.
65617 *   Character data handler is called for every piece of a text in the
65618 *   XML document. It can be called multiple times inside each fragment
65619 *   (e.g. for non-ASCII strings). If a handler function is set to an
65620 *   empty string, or , the handler in question is disabled.
65621 * @return bool
65622 * @since PHP 4, PHP 5
65623 **/
65624function xml_set_character_data_handler($parser, $handler){}
65625
65626/**
65627 * Sets the default handler function for the XML parser {@link parser}.
65628 *
65629 * @param resource $parser
65630 * @param callback $handler {@link handler} is a string containing the
65631 *   name of a function that must exist when {@link xml_parse} is called
65632 *   for {@link parser}. The function named by {@link handler} must
65633 *   accept two parameters: handler resource{@link parser} string{@link
65634 *   data} {@link parser} The first parameter, parser, is a reference to
65635 *   the XML parser calling the handler. {@link data} The second
65636 *   parameter, {@link data}, contains the character data.This may be the
65637 *   XML declaration, document type declaration, entities or other data
65638 *   for which no other handler exists. If a handler function is set to
65639 *   an empty string, or , the handler in question is disabled.
65640 * @return bool
65641 * @since PHP 4, PHP 5
65642 **/
65643function xml_set_default_handler($parser, $handler){}
65644
65645/**
65646 * Sets the element handler functions for the XML {@link parser}. {@link
65647 * start_element_handler} and {@link end_element_handler} are strings
65648 * containing the names of functions that must exist when {@link
65649 * xml_parse} is called for {@link parser}.
65650 *
65651 * @param resource $parser
65652 * @param callback $start_element_handler The function named by {@link
65653 *   start_element_handler} must accept three parameters:
65654 *   start_element_handler resource{@link parser} string{@link name}
65655 *   array{@link attribs} {@link parser} The first parameter, parser, is
65656 *   a reference to the XML parser calling the handler. {@link name} The
65657 *   second parameter, {@link name}, contains the name of the element for
65658 *   which this handler is called.If case-folding is in effect for this
65659 *   parser, the element name will be in uppercase letters. {@link
65660 *   attribs} The third parameter, {@link attribs}, contains an
65661 *   associative array with the element's attributes (if any).The keys of
65662 *   this array are the attribute names, the values are the attribute
65663 *   values.Attribute names are case-folded on the same criteria as
65664 *   element names.Attribute values are not case-folded. The original
65665 *   order of the attributes can be retrieved by walking through {@link
65666 *   attribs} the normal way, using {@link each}.The first key in the
65667 *   array was the first attribute, and so on.
65668 * @param callback $end_element_handler
65669 * @return bool
65670 * @since PHP 4, PHP 5
65671 **/
65672function xml_set_element_handler($parser, $start_element_handler, $end_element_handler){}
65673
65674/**
65675 * Set a handler to be called when leaving the scope of a namespace
65676 * declaration. This will be called, for each namespace declaration,
65677 * after the handler for the end tag of the element in which the
65678 * namespace was declared.
65679 *
65680 * @param resource $parser A reference to the XML parser.
65681 * @param callback $handler {@link handler} is a string containing the
65682 *   name of a function that must exist when {@link xml_parse} is called
65683 *   for {@link parser}. The function named by {@link handler} must
65684 *   accept three parameters, and should return an integer value. If the
65685 *   value returned from the handler is (which it will be if no value is
65686 *   returned), the XML parser will stop parsing and {@link
65687 *   xml_get_error_code} will return XML_ERROR_EXTERNAL_ENTITY_HANDLING.
65688 *   handler resource{@link parser} string{@link user_data} string{@link
65689 *   prefix} {@link parser} The first parameter, parser, is a reference
65690 *   to the XML parser calling the handler. {@link user_data} {@link
65691 *   prefix} If a handler function is set to an empty string, or , the
65692 *   handler in question is disabled.
65693 * @return bool
65694 * @since PHP 4 >= 4.0.5, PHP 5
65695 **/
65696function xml_set_end_namespace_decl_handler($parser, $handler){}
65697
65698/**
65699 * Sets the external entity reference handler function for the XML parser
65700 * {@link parser}.
65701 *
65702 * @param resource $parser
65703 * @param callback $handler {@link handler} is a string containing the
65704 *   name of a function that must exist when {@link xml_parse} is called
65705 *   for {@link parser}. The function named by {@link handler} must
65706 *   accept five parameters, and should return an integer value.If the
65707 *   value returned from the handler is (which it will be if no value is
65708 *   returned), the XML parser will stop parsing and {@link
65709 *   xml_get_error_code} will return XML_ERROR_EXTERNAL_ENTITY_HANDLING.
65710 *   handler resource{@link parser} string{@link open_entity_names}
65711 *   string{@link base} string{@link system_id} string{@link public_id}
65712 *   {@link parser} The first parameter, parser, is a reference to the
65713 *   XML parser calling the handler. {@link open_entity_names} The second
65714 *   parameter, {@link open_entity_names}, is a space-separated list of
65715 *   the names of the entities that are open for the parse of this entity
65716 *   (including the name of the referenced entity). {@link base} This is
65717 *   the base for resolving the system identifier ({@link system_id}) of
65718 *   the external entity.Currently this parameter will always be set to
65719 *   an empty string. {@link system_id} The fourth parameter, {@link
65720 *   system_id}, is the system identifier as specified in the entity
65721 *   declaration. {@link public_id} The fifth parameter, {@link
65722 *   public_id}, is the public identifier as specified in the entity
65723 *   declaration, or an empty string if none was specified; the
65724 *   whitespace in the public identifier will have been normalized as
65725 *   required by the XML spec. If a handler function is set to an empty
65726 *   string, or , the handler in question is disabled.
65727 * @return bool
65728 * @since PHP 4, PHP 5
65729 **/
65730function xml_set_external_entity_ref_handler($parser, $handler){}
65731
65732/**
65733 * Sets the notation declaration handler function for the XML parser
65734 * {@link parser}.
65735 *
65736 * A notation declaration is part of the document's DTD and has the
65737 * following format:
65738 *
65739 * <!NOTATION <parameter>name</parameter> {
65740 * <parameter>systemId</parameter> | <parameter>publicId</parameter>?>
65741 *
65742 * See section 4.7 of the XML 1.0 spec for the definition of notation
65743 * declarations.
65744 *
65745 * @param resource $parser
65746 * @param callback $handler {@link handler} is a string containing the
65747 *   name of a function that must exist when {@link xml_parse} is called
65748 *   for {@link parser}. The function named by {@link handler} must
65749 *   accept five parameters: handler resource{@link parser} string{@link
65750 *   notation_name} string{@link base} string{@link system_id}
65751 *   string{@link public_id} {@link parser} The first parameter, parser,
65752 *   is a reference to the XML parser calling the handler. {@link
65753 *   notation_name} This is the notation's {@link name}, as per the
65754 *   notation format described above. {@link base} This is the base for
65755 *   resolving the system identifier ({@link system_id}) of the notation
65756 *   declaration. Currently this parameter will always be set to an empty
65757 *   string. {@link system_id} System identifier of the external notation
65758 *   declaration. {@link public_id} Public identifier of the external
65759 *   notation declaration. If a handler function is set to an empty
65760 *   string, or , the handler in question is disabled.
65761 * @return bool
65762 * @since PHP 4, PHP 5
65763 **/
65764function xml_set_notation_decl_handler($parser, $handler){}
65765
65766/**
65767 * This function allows to use {@link parser} inside {@link object}. All
65768 * callback functions could be set with {@link xml_set_element_handler}
65769 * etc and assumed to be methods of {@link object}.
65770 *
65771 * @param resource $parser
65772 * @param object $object
65773 * @return bool
65774 * @since PHP 4, PHP 5
65775 **/
65776function xml_set_object($parser, &$object){}
65777
65778/**
65779 * Sets the processing instruction (PI) handler function for the XML
65780 * parser {@link parser}.
65781 *
65782 * A processing instruction has the following format: <?target data?> You
65783 * can put PHP code into such a tag, but be aware of one limitation: in
65784 * an XML PI, the PI end tag (?>) can not be quoted, so this character
65785 * sequence should not appear in the PHP code you embed with PIs in XML
65786 * documents.If it does, the rest of the PHP code, as well as the "real"
65787 * PI end tag, will be treated as character data.
65788 *
65789 * @param resource $parser
65790 * @param callback $handler {@link handler} is a string containing the
65791 *   name of a function that must exist when {@link xml_parse} is called
65792 *   for {@link parser}. The function named by {@link handler} must
65793 *   accept three parameters: handler resource{@link parser} string{@link
65794 *   target} string{@link data} {@link parser} The first parameter,
65795 *   parser, is a reference to the XML parser calling the handler. {@link
65796 *   target} The second parameter, {@link target}, contains the PI
65797 *   target. {@link data} The third parameter, {@link data}, contains the
65798 *   PI data. If a handler function is set to an empty string, or , the
65799 *   handler in question is disabled.
65800 * @return bool
65801 * @since PHP 4, PHP 5
65802 **/
65803function xml_set_processing_instruction_handler($parser, $handler){}
65804
65805/**
65806 * Set a handler to be called when a namespace is declared. Namespace
65807 * declarations occur inside start tags. But the namespace declaration
65808 * start handler is called before the start tag handler for each
65809 * namespace declared in that start tag.
65810 *
65811 * @param resource $parser A reference to the XML parser.
65812 * @param callback $handler {@link handler} is a string containing the
65813 *   name of a function that must exist when {@link xml_parse} is called
65814 *   for {@link parser}. The function named by {@link handler} must
65815 *   accept four parameters, and should return an integer value. If the
65816 *   value returned from the handler is (which it will be if no value is
65817 *   returned), the XML parser will stop parsing and {@link
65818 *   xml_get_error_code} will return XML_ERROR_EXTERNAL_ENTITY_HANDLING.
65819 *   handler resource{@link parser} string{@link user_data} string{@link
65820 *   prefix} string{@link uri} {@link parser} The first parameter,
65821 *   parser, is a reference to the XML parser calling the handler. {@link
65822 *   user_data} {@link prefix} {@link uri} If a handler function is set
65823 *   to an empty string, or , the handler in question is disabled.
65824 * @return bool
65825 * @since PHP 4 >= 4.0.5, PHP 5
65826 **/
65827function xml_set_start_namespace_decl_handler($parser, $handler){}
65828
65829/**
65830 * Sets the unparsed entity declaration handler function for the XML
65831 * parser {@link parser}.
65832 *
65833 * The {@link handler} will be called if the XML parser encounters an
65834 * external entity declaration with an NDATA declaration, like the
65835 * following:
65836 *
65837 * <!ENTITY <parameter>name</parameter> {<parameter>publicId</parameter>
65838 * | <parameter>systemId</parameter>} NDATA
65839 * <parameter>notationName</parameter>
65840 *
65841 * See section 4.2.2 of the XML 1.0 spec for the definition of notation
65842 * declared external entities.
65843 *
65844 * @param resource $parser
65845 * @param callback $handler {@link handler} is a string containing the
65846 *   name of a function that must exist when {@link xml_parse} is called
65847 *   for {@link parser}. The function named by {@link handler} must
65848 *   accept six parameters: handler resource{@link parser} string{@link
65849 *   entity_name} string{@link base} string{@link system_id} string{@link
65850 *   public_id} string{@link notation_name} {@link parser} The first
65851 *   parameter, parser, is a reference to the XML parser calling the
65852 *   handler. {@link entity_name} The name of the entity that is about to
65853 *   be defined. {@link base} This is the base for resolving the system
65854 *   identifier ({@link systemId}) of the external entity.Currently this
65855 *   parameter will always be set to an empty string. {@link system_id}
65856 *   System identifier for the external entity. {@link public_id} Public
65857 *   identifier for the external entity. {@link notation_name} Name of
65858 *   the notation of this entity (see {@link
65859 *   xml_set_notation_decl_handler}). If a handler function is set to an
65860 *   empty string, or , the handler in question is disabled.
65861 * @return bool
65862 * @since PHP 4, PHP 5
65863 **/
65864function xml_set_unparsed_entity_decl_handler($parser, $handler){}
65865
65866/**
65867 * The optional {@link contextnode} can be specified for doing relative
65868 * XPath queries.
65869 *
65870 * See also {@link xpath_new_context}.
65871 *
65872 * @param XPathContext $xpath_context
65873 * @param string $xpath_expression
65874 * @param domnode $contextnode
65875 * @return XPathObject
65876 * @since PHP 4
65877 **/
65878function xpath_eval($xpath_context, $xpath_expression, $contextnode){}
65879
65880/**
65881 * {@link xpath_eval_expression} Example
65882 *
65883 * <?php
65884 *
65885 * include("example.inc");
65886 *
65887 * if (!$dom = domxml_open_mem($xmlstr)) { echo "Error while parsing the
65888 * document\n"; exit; }
65889 *
65890 * $xpath = xpath_new_context($dom);
65891 * var_dump(xpath_eval_expression($xpath, '/chapter/@language'));
65892 *
65893 * ?>
65894 *
65895 * object(XPathObject)(2) { ["type"]=> int(1) ["nodeset"]=> array(1) {
65896 * [0]=> object(domattribute)(5) { ["type"]=> int(2) ["name"]=> string(8)
65897 * "language" ["value"]=> string(2) "en" [0]=> int(7) [1]=>
65898 * int(138004256) } } }
65899 *
65900 * See also {@link xpath_eval}.
65901 *
65902 * @param XPathContext $xpath_context
65903 * @param string $expression
65904 * @param domnode $contextnode
65905 * @return XPathObject
65906 * @since PHP 4
65907 **/
65908function xpath_eval_expression($xpath_context, $expression, $contextnode){}
65909
65910/**
65911 * Creates a new xpath context.
65912 *
65913 * @param domdocument $dom_document
65914 * @return XPathContext
65915 * @since PHP 4
65916 **/
65917function xpath_new_context($dom_document){}
65918
65919/**
65920 * @param XPathContext $xpath_context
65921 * @param string $prefix
65922 * @param string $uri
65923 * @return bool
65924 * @since PHP 4 >= 4.2.0
65925 **/
65926function xpath_register_ns($xpath_context, $prefix, $uri){}
65927
65928/**
65929 * @param XPathContext $xpath_context
65930 * @param object $context_node
65931 * @return bool
65932 * @since PHP 4 >= 4.3.0
65933 **/
65934function xpath_register_ns_auto($xpath_context, $context_node){}
65935
65936/**
65937 * @param XPathContext $xpath_context
65938 * @param string $eval_str
65939 * @param domnode $contextnode
65940 * @return int
65941 * @since PHP 4
65942 **/
65943function xptr_eval($xpath_context, $eval_str, $contextnode){}
65944
65945/**
65946 * @return XPathContext
65947 * @since PHP 4
65948 **/
65949function xptr_new_context(){}
65950
65951/**
65952 * {@link xslt_backend_info} gets information about the compilation
65953 * settings of the backend.
65954 *
65955 * @return string
65956 * @since PHP 4 >= 4.3.0
65957 **/
65958function xslt_backend_info(){}
65959
65960/**
65961 * {@link xslt_backend_name} gets the name of the backend.
65962 *
65963 * @return string
65964 * @since PHP 4 >= 4.3.0
65965 **/
65966function xslt_backend_name(){}
65967
65968/**
65969 * {@link xslt_backend_version} gets the version number of Sablotron.
65970 *
65971 * @return string
65972 * @since PHP 4 >= 4.3.0
65973 **/
65974function xslt_backend_version(){}
65975
65976/**
65977 * Create and return a new XSLT processor resource for manipulation by
65978 * the other XSLT functions.
65979 *
65980 * @return resource
65981 * @since PHP 4 >= 4.0.3
65982 **/
65983function xslt_create(){}
65984
65985/**
65986 * Returns an error code describing the last error that occurred on the
65987 * passed XSLT processor.
65988 *
65989 * @param resource $xh The XSLT processor link identifier, created with
65990 *   {@link xslt_create}.
65991 * @return int
65992 * @since PHP 4 >= 4.0.3
65993 **/
65994function xslt_errno($xh){}
65995
65996/**
65997 * Returns a string describing the last error that occurred on the passed
65998 * XSLT processor.
65999 *
66000 * @param resource $xh The XSLT processor link identifier, created with
66001 *   {@link xslt_create}.
66002 * @return string
66003 * @since PHP 4 >= 4.0.3
66004 **/
66005function xslt_error($xh){}
66006
66007/**
66008 * Free the XSLT processor identified by the given handle.
66009 *
66010 * @param resource $xh The XSLT processor link identifier, created with
66011 *   {@link xslt_create}.
66012 * @return void
66013 * @since PHP 4 >= 4.0.3
66014 **/
66015function xslt_free($xh){}
66016
66017/**
66018 * {@link xslt_getopt} returns the options on the given {@link
66019 * processor}.
66020 *
66021 * @param resource $processor The XSLT processor link identifier,
66022 *   created with {@link xslt_create}.
66023 * @return int
66024 * @since PHP 4 >= 4.3.0
66025 **/
66026function xslt_getopt($processor){}
66027
66028/**
66029 * The {@link xslt_process} function is the crux of the XSLT extension.
66030 * It allows you to perform an XSLT transformation using almost any type
66031 * of input source - the containers. This is accomplished through the use
66032 * of argument buffers -- a concept taken from the Sablotron XSLT
66033 * processor (currently the only XSLT processor this extension supports).
66034 * The input containers default to a filename 'containing' the document
66035 * to be processed.
66036 *
66037 * @param resource $xh The XSLT processor link identifier, created with
66038 *   {@link xslt_create}.
66039 * @param string $xmlcontainer Path to XML file or placeholder for the
66040 *   XML argument.
66041 * @param string $xslcontainer Path to XSL file or placeholder for the
66042 *   XML argument.
66043 * @param string $resultcontainer The result container defaults to a
66044 *   filename for the transformed document. If the result container is
66045 *   not specified - i.e. - than the result is returned.
66046 * @param array $arguments Instead of files as the XML and XSLT
66047 *   arguments to the {@link xslt_process} function, you can specify
66048 *   argument place holders which are then substituted by values given in
66049 *   the {@link arguments} array.
66050 * @param array $parameters An array for any top-level parameters that
66051 *   will be passed to the XSLT document. These parameters can then be
66052 *   accessed within your XSL files using the <xsl:param
66053 *   name=parameter_name> instruction. The parameters must be UTF-8
66054 *   encoded and their values will be interpreted as strings by the
66055 *   Sablotron processor. In other words - you cannot pass node-sets as
66056 *   parameters to the XSLT document.
66057 * @return mixed
66058 * @since PHP 4 >= 4.0.3
66059 **/
66060function xslt_process($xh, $xmlcontainer, $xslcontainer, $resultcontainer, $arguments, $parameters){}
66061
66062/**
66063 * {@link xslt_setopt} sets the options specified by {@link newmask} on
66064 * the given {@link processor}.
66065 *
66066 * @param resource $processor The XSLT processor link identifier,
66067 *   created with {@link xslt_create}.
66068 * @param int $newmask {@link newmask} is a bitmask constructed with
66069 *   the following constants: XSLT_SABOPT_PARSE_PUBLIC_ENTITIES - Tell
66070 *   the processor to parse public entities. By default this has been
66071 *   turned off. XSLT_SABOPT_DISABLE_ADDING_META - Do not add the meta
66072 *   tag "Content-Type" for HTML output. The default is set during the
66073 *   compilation of the processor. XSLT_SABOPT_DISABLE_STRIPPING -
66074 *   Suppress the whitespace stripping (on data files only).
66075 *   XSLT_SABOPT_IGNORE_DOC_NOT_FOUND - Consider unresolved documents
66076 *   (the document() function) non-lethal.
66077 * @return mixed
66078 * @since PHP 4 >= 4.3.0
66079 **/
66080function xslt_setopt($processor, $newmask){}
66081
66082/**
66083 * Sets the base URI for all XSLT transformations, the base URI is used
66084 * with Xpath instructions to resolve document() and other commands which
66085 * access external resources. It is also used to resolve URIs for the
66086 * <xsl:include> and <xsl:import> elements.
66087 *
66088 * @param resource $xh The XSLT processor link identifier, created with
66089 *   {@link xslt_create}.
66090 * @param string $uri The base URI to be used.
66091 * @return void
66092 * @since PHP 4 >= 4.0.5
66093 **/
66094function xslt_set_base($xh, $uri){}
66095
66096/**
66097 * Set the output encoding for the XSLT transformations. When using the
66098 * Sablotron backend, this option is only available when you compile
66099 * Sablotron with encoding support.
66100 *
66101 * @param resource $xh The XSLT processor link identifier, created with
66102 *   {@link xslt_create}.
66103 * @param string $encoding An output encoding, e.g iso-8859-1.
66104 * @return void
66105 * @since PHP 4 >= 4.0.5
66106 **/
66107function xslt_set_encoding($xh, $encoding){}
66108
66109/**
66110 * Set an error handler function for the XSLT processor given by {@link
66111 * xh}, this function will be called whenever an error occurs in the XSLT
66112 * transformation (this function is also called for notices).
66113 *
66114 * @param resource $xh The XSLT processor link identifier, created with
66115 *   {@link xslt_create}.
66116 * @param mixed $handler The user function needs to accept four
66117 *   parameters: the XSLT processor, the error level, the error code and
66118 *   an array of messages. The function can be shown as: error_handler
66119 *   resource{@link xh} int{@link error_level} int{@link error_code}
66120 *   array{@link messages}
66121 * @return void
66122 * @since PHP 4 >= 4.0.4
66123 **/
66124function xslt_set_error_handler($xh, $handler){}
66125
66126/**
66127 * This function allows you to set the file in which you want XSLT log
66128 * messages to, XSLT log messages are different than error messages, in
66129 * that log messages are not actually error messages but rather messages
66130 * related to the state of the XSLT processor. They are useful for
66131 * debugging XSLT, when something goes wrong.
66132 *
66133 * By default logging is disabled, in order to enable logging you must
66134 * first call {@link xslt_set_log} with a boolean parameter which enables
66135 * logging, then if you want to set the log file to debug to, you must
66136 * then pass it a string containing the filename.
66137 *
66138 * @param resource $xh The XSLT processor link identifier, created with
66139 *   {@link xslt_create}.
66140 * @param mixed $log This parameter is either a boolean value which
66141 *   toggles logging on and off, or a string containing the logfile in
66142 *   which log errors too.
66143 * @return void
66144 * @since PHP 4 >= 4.0.6
66145 **/
66146function xslt_set_log($xh, $log){}
66147
66148/**
66149 * This function allows to use the {@link processor} inside an {@link
66150 * object} and to resolve all callback functions in it.
66151 *
66152 * The callback functions can be declared with {@link
66153 * xslt_set_sax_handlers}, {@link xslt_set_scheme_handlers} or {@link
66154 * xslt_set_error_handler} and are assumed to be methods of {@link
66155 * object}.
66156 *
66157 * @param resource $processor The XSLT processor link identifier,
66158 *   created with {@link xslt_create}.
66159 * @param object $obj An object.
66160 * @return bool
66161 * @since PHP 4 >= 4.3.0
66162 **/
66163function xslt_set_object($processor, &$obj){}
66164
66165/**
66166 * Set SAX handlers on the resource handle given by {@link xh}.
66167 *
66168 * @param resource $xh The XSLT processor link identifier, created with
66169 *   {@link xslt_create}.
66170 * @param array $handlers SAX handlers should be a two dimensional
66171 *   array with the format (all top level elements are optional):
66172 *
66173 *   array( [document] => array( start document handler, end document
66174 *   handler ), [element] => array( start element handler, end element
66175 *   handler ), [namespace] => array( start namespace handler, end
66176 *   namespace handler ), [comment] => comment handler, [pi] =>
66177 *   processing instruction handler, [character] => character data
66178 *   handler )
66179 * @return void
66180 * @since PHP 4 >= 4.0.3
66181 **/
66182function xslt_set_sax_handler($xh, $handlers){}
66183
66184/**
66185 * {@link xslt_set_sax_handlers} registers the SAX {@link handlers} for
66186 * the document, given a XSLT {@link processor} resource.
66187 *
66188 * Using {@link xslt_set_sax_handlers} doesn't look very different than
66189 * running a SAX parser like {@link xml_parse} on the result of an {@link
66190 * xslt_process} transformation.
66191 *
66192 * @param resource $processor The XSLT processor link identifier,
66193 *   created with {@link xslt_create}.
66194 * @param array $handlers {@link handlers} should be an array in the
66195 *   following format:
66196 *
66197 *   <?php
66198 *
66199 *   $handlers = array(
66200 *
66201 *   "document" => array( "start_doc", "end_doc"),
66202 *
66203 *   "element" => array( "start_element", "end_element"),
66204 *
66205 *   "namespace" => array( "start_namespace", "end_namespace"),
66206 *
66207 *   "comment" => "comment",
66208 *
66209 *   "pi" => "pi",
66210 *
66211 *   "character" => "characters"
66212 *
66213 *   ); ?>
66214 *
66215 *   Where the functions follow the syntax described for the scheme
66216 *   handler functions. Each of the individual SAX handler functions are
66217 *   in the format below: start_doc resource{@link processor} end_doc
66218 *   resource{@link processor} start_element resource{@link processor}
66219 *   string{@link name} array{@link attributes} end_element
66220 *   resource{@link processor} string{@link name} start_namespace
66221 *   resource{@link processor} string{@link prefix} string{@link uri}
66222 *   end_namespace resource{@link processor} string{@link prefix} comment
66223 *   resource{@link processor} string{@link contents} pi resource{@link
66224 *   processor} string{@link target} string{@link contents} characters
66225 *   resource{@link processor} string{@link contents}
66226 * @return void
66227 * @since PHP 4 >= 4.0.6
66228 **/
66229function xslt_set_sax_handlers($processor, $handlers){}
66230
66231/**
66232 * Set Scheme handlers on the resource handle given by {@link xh}.
66233 *
66234 * @param resource $xh The XSLT processor link identifier, created with
66235 *   {@link xslt_create}.
66236 * @param array $handlers Scheme handlers should be an array with the
66237 *   format (all elements are optional):
66238 *
66239 *   array( [get_all] => get all handler, [open] => open handler, [get]
66240 *   => get handler, [put] => put handler, [close] => close handler )
66241 * @return void
66242 * @since PHP 4 >= 4.0.5
66243 **/
66244function xslt_set_scheme_handler($xh, $handlers){}
66245
66246/**
66247 * Registers the scheme handlers (XPath handlers) for the document.
66248 *
66249 * @param resource $xh The XSLT processor link identifier, created with
66250 *   {@link xslt_create}.
66251 * @param array $handlers An array with the following keys: "get_all",
66252 *   "open", "get", "put", and "close". Every entry must be a function
66253 *   name or an array in the following format: array($obj, "method").
66254 *   Note that the given array does not need to contain all of the
66255 *   different scheme handler elements (although it can), but it only
66256 *   needs to conform to the "handler" => "fonction" format described
66257 *   above. Each of the individual scheme handler functions called are in
66258 *   the formats below:
66259 *
66260 *   string get_all(resource processor, string scheme, string rest)
66261 *   resource open(resource processor, string scheme, string rest) int
66262 *   get(resource processor, resource fp, string &data) int put(resource
66263 *   processor, resource fp, string data) void close(resource processor,
66264 *   resource fp)
66265 * @return void
66266 * @since PHP 4 >= 4.0.6
66267 **/
66268function xslt_set_scheme_handlers($xh, $handlers){}
66269
66270/**
66271 * Generate a YAML representation of the provided {@link data}.
66272 *
66273 * @param mixed $data The {@link data} being encoded. Can be any type
66274 *   except a resource.
66275 * @param int $encoding Output character encoding chosen from
66276 *   YAML_ANY_ENCODING, YAML_UTF8_ENCODING, YAML_UTF16LE_ENCODING,
66277 *   YAML_UTF16BE_ENCODING. Defaults to YAML_ANY_ENCODING.
66278 * @param int $linebreak Output linebreak style chosen from
66279 *   YAML_ANY_BREAK, YAML_CR_BREAK, YAML_LN_BREAK, YAML_CRLN_BREAK.
66280 *   Defaults to YAML_ANY_BREAK.
66281 * @return string
66282 * @since PECL yaml >= 0.5.0
66283 **/
66284function yaml_emit($data, $encoding, $linebreak){}
66285
66286/**
66287 * Generate a YAML representation of the provided {@link data} in the
66288 * {@link filename}.
66289 *
66290 * @param string $filename Path to the file.
66291 * @param mixed $data The {@link data} being encoded. Can be any type
66292 *   except a resource.
66293 * @param int $encoding Output character encoding chosen from
66294 *   YAML_ANY_ENCODING, YAML_UTF8_ENCODING, YAML_UTF16LE_ENCODING,
66295 *   YAML_UTF16BE_ENCODING. Defaults to YAML_ANY_ENCODING.
66296 * @param int $linebreak Output linebreak style chosen from
66297 *   YAML_ANY_BREAK, YAML_CR_BREAK, YAML_LN_BREAK, YAML_CRLN_BREAK.
66298 *   Defaults to YAML_ANY_BREAK.
66299 * @return bool
66300 * @since PECL yaml >= 0.5.0
66301 **/
66302function yaml_emit_file($filename, $data, $encoding, $linebreak){}
66303
66304/**
66305 * Convert all or part of a YAML document stream to a PHP variable.
66306 *
66307 * @param string $input The string to parse as a YAML document stream.
66308 * @param int $pos Document to extract from stream (-1 for all
66309 *   documents, 0 for first document, ...).
66310 * @param int $ndocs If {@link ndocs} is provided, then it is filled
66311 *   with the number of documents found in stream.
66312 * @param array $callbacks Content handlers for YAML nodes. Associative
66313 *   array of YAML tag => callback mappings.
66314 * @return mixed
66315 * @since PECL yaml >= 0.4.0
66316 **/
66317function yaml_parse($input, $pos, &$ndocs, $callbacks){}
66318
66319/**
66320 * Convert all or part of a YAML document stream read from a file to a
66321 * PHP variable.
66322 *
66323 * @param string $filename Path to the file.
66324 * @param int $pos Document to extract from stream (-1 for all
66325 *   documents, 0 for first document, ...).
66326 * @param int $ndocs If {@link ndocs} is provided, then it is filled
66327 *   with the number of documents found in stream.
66328 * @param array $callbacks Content handlers for YAML nodes. Associative
66329 *   array of YAML tag => callback mappings.
66330 * @return mixed
66331 * @since PECL yaml >= 0.4.0
66332 **/
66333function yaml_parse_file($filename, $pos, &$ndocs, $callbacks){}
66334
66335/**
66336 * Convert all or part of a YAML document stream read from a URL to a PHP
66337 * variable.
66338 *
66339 * @param string $url {@link url} should be of the form "scheme://...".
66340 *   PHP will search for a protocol handler (also known as a wrapper) for
66341 *   that scheme. If no wrappers for that protocol are registered, PHP
66342 *   will emit a notice to help you track potential problems in your
66343 *   script and then continue as though filename specifies a regular
66344 *   file.
66345 * @param int $pos Document to extract from stream (-1 for all
66346 *   documents, 0 for first document, ...).
66347 * @param int $ndocs If {@link ndocs} is provided, then it is filled
66348 *   with the number of documents found in stream.
66349 * @param array $callbacks Content handlers for YAML nodes. Associative
66350 *   array of YAML tag => callback mappings.
66351 * @return mixed
66352 * @since PECL yaml >= 0.4.0
66353 **/
66354function yaml_parse_url($url, $pos, &$ndocs, $callbacks){}
66355
66356/**
66357 * Returns additional error information for the last request on the
66358 * server.
66359 *
66360 * With some servers, this function may return the same string as {@link
66361 * yaz_error}.
66362 *
66363 * @param resource $id The connection resource returned by {@link
66364 *   yaz_connect}.
66365 * @return string
66366 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
66367 **/
66368function yaz_addinfo($id){}
66369
66370/**
66371 * This function configures the CCL query parser for a server with
66372 * definitions of access points (CCL qualifiers) and their mapping to
66373 * RPN.
66374 *
66375 * To map a specific CCL query to RPN afterwards call the {@link
66376 * yaz_ccl_parse} function.
66377 *
66378 * @param resource $id The connection resource returned by {@link
66379 *   yaz_connect}.
66380 * @param array $config An array of configuration. Each key of the
66381 *   array is the name of a CCL field and the corresponding value holds a
66382 *   string that specifies a mapping to RPN. The mapping is a sequence of
66383 *   attribute-type, attribute-value pairs. Attribute-type and
66384 *   attribute-value is separated by an equal sign (=). Each pair is
66385 *   separated by white space. Additional information can be found on the
66386 *   CCL page.
66387 * @return void
66388 * @since PHP 4 >= 4.0.5, PECL yaz >= 0.9.0
66389 **/
66390function yaz_ccl_conf($id, $config){}
66391
66392/**
66393 * This function invokes a CCL parser. It converts a given CCL FIND query
66394 * to an RPN query which may be passed to the {@link yaz_search} function
66395 * to perform a search.
66396 *
66397 * To define a set of valid CCL fields call {@link yaz_ccl_conf} prior to
66398 * this function.
66399 *
66400 * @param resource $id The connection resource returned by {@link
66401 *   yaz_connect}.
66402 * @param string $query The CCL FIND query.
66403 * @param array $result If the function was executed successfully, this
66404 *   will be an array containing the valid RPN query under the key rpn.
66405 *   Upon failure, three indexes are set in this array to indicate the
66406 *   cause of failure: errorcode - the CCL error code (integer)
66407 *   errorstring - the CCL error string errorpos - approximate position
66408 *   in query of failure (integer is character position)
66409 * @return bool
66410 * @since PHP 4 >= 4.0.5, PECL yaz >= 0.9.0
66411 **/
66412function yaz_ccl_parse($id, $query, &$result){}
66413
66414/**
66415 * Closes the connection given by parameter {@link id}.
66416 *
66417 * @param resource $id The connection resource returned by {@link
66418 *   yaz_connect}.
66419 * @return bool
66420 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
66421 **/
66422function yaz_close($id){}
66423
66424/**
66425 * This function returns a connection resource on success, zero on
66426 * failure.
66427 *
66428 * {@link yaz_connect} prepares for a connection to a Z39.50 server. This
66429 * function is non-blocking and does not attempt to establish a
66430 * connection - it merely prepares a connect to be performed later when
66431 * {@link yaz_wait} is called.
66432 *
66433 * @param string $zurl A string that takes the form
66434 *   host[:port][/database]. If port is omitted, port 210 is used. If
66435 *   database is omitted Default is used.
66436 * @param mixed $options If given as a string, it is treated as the
66437 *   Z39.50 V2 authentication string (OpenAuth). If given as an array,
66438 *   the contents of the array serves as options. user Username for
66439 *   authentication. group Group for authentication. password Password
66440 *   for authentication. cookie Cookie for session (YAZ proxy). proxy
66441 *   Proxy for connection (YAZ proxy). persistent A boolean. If the
66442 *   connection is persistent; If the connection is not persistent. By
66443 *   default connections are persistent. If you open a persistent
66444 *   connection, you won't be able to close it later with {@link
66445 *   yaz_close}. piggyback A boolean. If piggyback is enabled for
66446 *   searches; If piggyback is disabled. By default piggyback is enabled.
66447 *   Enabling piggyback is more efficient and usually saves a
66448 *   network-round-trip for first time fetches of records. However, a few
66449 *   Z39.50 servers do not support piggyback or they ignore element set
66450 *   names. For those, piggyback should be disabled. charset A string
66451 *   that specifies character set to be used in Z39.50 language and
66452 *   character set negotiation. Use strings such as: ISO-8859-1, UTF-8,
66453 *   UTF-16. Most Z39.50 servers do not support this feature (and thus,
66454 *   this is ignored). Many servers use the ISO-8859-1 encoding for
66455 *   queries and messages. MARC21/USMARC records are not affected by this
66456 *   setting.
66457 *
66458 *   preferredMessageSize An integer that specifies the maximum byte size
66459 *   of all records to be returned by a target during retrieval. See the
66460 *   Z39.50 standard for more information. This option is supported in
66461 *   PECL YAZ 1.0.5 or later.
66462 *
66463 *   maximumRecordSize An integer that specifies the maximum byte size of
66464 *   a single record to be returned by a target during retrieval. This
66465 *   entity is referred to as Exceptional-record-size in the Z39.50
66466 *   standard. This option is supported in PECL YAZ 1.0.5 or later.
66467 * @return mixed
66468 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
66469 **/
66470function yaz_connect($zurl, $options){}
66471
66472/**
66473 * This function allows you to change databases within a session by
66474 * specifying one or more databases to be used in search, retrieval, etc.
66475 * - overriding databases specified in call to {@link yaz_connect}.
66476 *
66477 * @param resource $id The connection resource returned by {@link
66478 *   yaz_connect}.
66479 * @param string $databases A string containing one or more databases.
66480 *   Multiple databases are separated by a plus sign +.
66481 * @return bool
66482 * @since PHP 4 >= 4.0.6, PECL yaz >= 0.9.0
66483 **/
66484function yaz_database($id, $databases){}
66485
66486/**
66487 * This function sets the element set name for retrieval.
66488 *
66489 * Call this function before {@link yaz_search} or {@link yaz_present} to
66490 * specify the element set name for records to be retrieved.
66491 *
66492 * @param resource $id The connection resource returned by {@link
66493 *   yaz_connect}.
66494 * @param string $elementset Most servers support F (for full records)
66495 *   and B (for brief records).
66496 * @return bool
66497 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
66498 **/
66499function yaz_element($id, $elementset){}
66500
66501/**
66502 * Returns an error number for the server (last request) identified by
66503 * {@link id}.
66504 *
66505 * {@link yaz_errno} should be called after network activity for each
66506 * server - (after {@link yaz_wait} returns) to determine the success or
66507 * failure of the last operation (e.g. search).
66508 *
66509 * @param resource $id The connection resource returned by {@link
66510 *   yaz_connect}.
66511 * @return int
66512 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
66513 **/
66514function yaz_errno($id){}
66515
66516/**
66517 * {@link yaz_error} returns an English text message corresponding to the
66518 * last error number as returned by {@link yaz_errno}.
66519 *
66520 * @param resource $id The connection resource returned by {@link
66521 *   yaz_connect}.
66522 * @return string
66523 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
66524 **/
66525function yaz_error($id){}
66526
66527/**
66528 * This function prepares for an Extended Service Request. Extended
66529 * Services is family of various Z39.50 facilities, such as Record
66530 * Update, Item Order, Database administration etc.
66531 *
66532 * The {@link yaz_es} creates an Extended Service Request packages and
66533 * puts it into a queue of operations. Use {@link yaz_wait} to send the
66534 * request(s) to the server. After completion of {@link yaz_wait} the
66535 * result of the Extended Service operation should be expected with a
66536 * call to {@link yaz_es_result}.
66537 *
66538 * @param resource $id The connection resource returned by {@link
66539 *   yaz_connect}.
66540 * @param string $type A string which represents the type of the
66541 *   Extended Service: itemorder (Item Order), create (Create Database),
66542 *   drop (Drop Database), commit (Commit Operation), update (Update
66543 *   Record), xmlupdate (XML Update). Each type is specified in the
66544 *   following section.
66545 * @param array $args An array with extended service options plus
66546 *   package specific options. The options are identical to those offered
66547 *   in the C API of ZOOM C. Refer to the ZOOM Extended Services.
66548 * @return void
66549 * @since PECL yaz >= 0.9.0
66550 **/
66551function yaz_es($id, $type, $args){}
66552
66553/**
66554 * This function inspects the last returned Extended Service result from
66555 * a server. An Extended Service is initiated by either {@link
66556 * yaz_item_order} or {@link yaz_es}.
66557 *
66558 * @param resource $id The connection resource returned by {@link
66559 *   yaz_connect}.
66560 * @return array
66561 * @since PHP 4 >= 4.2.0, PECL yaz >= 0.9.0
66562 **/
66563function yaz_es_result($id){}
66564
66565/**
66566 * Returns the value of the option specified with {@link name}.
66567 *
66568 * @param resource $id The connection resource returned by {@link
66569 *   yaz_connect}.
66570 * @param string $name The option name.
66571 * @return string
66572 * @since PECL yaz >= 0.9.0
66573 **/
66574function yaz_get_option($id, $name){}
66575
66576/**
66577 * {@link yaz_hits} returns the number of hits for the last search.
66578 *
66579 * @param resource $id The connection resource returned by {@link
66580 *   yaz_connect}.
66581 * @param array $searchresult Result array for detailed search result
66582 *   information.
66583 * @return int
66584 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
66585 **/
66586function yaz_hits($id, &$searchresult){}
66587
66588/**
66589 * This function prepares for an Extended Services request using the
66590 * Profile for the Use of Z39.50 Item Order Extended Service to Transport
66591 * ILL (Profile/1). See this and the specification.
66592 *
66593 * @param resource $id The connection resource returned by {@link
66594 *   yaz_connect}.
66595 * @param array $args Must be an associative array with information
66596 *   about the Item Order request to be sent. The key of the hash is the
66597 *   name of the corresponding ASN.1 tag path. For example, the ISBN
66598 *   below the Item-ID has the key item-id,ISBN. The ILL-Request
66599 *   parameters are: There are also a few parameters that are part of the
66600 *   Extended Services Request package and the ItemOrder package:
66601 * @return void
66602 * @since PHP 4 >= 4.0.5, PECL yaz >= 0.9.0
66603 **/
66604function yaz_itemorder($id, $args){}
66605
66606/**
66607 * This function prepares for retrieval of records after a successful
66608 * search.
66609 *
66610 * The {@link yaz_range} function should be called prior to this function
66611 * to specify the range of records to be retrieved.
66612 *
66613 * @param resource $id The connection resource returned by {@link
66614 *   yaz_connect}.
66615 * @return bool
66616 * @since PHP 4 >= 4.0.5, PECL yaz >= 0.9.0
66617 **/
66618function yaz_present($id){}
66619
66620/**
66621 * Specifies a range of records to retrieve.
66622 *
66623 * This function should be called before {@link yaz_search} or {@link
66624 * yaz_present}.
66625 *
66626 * @param resource $id The connection resource returned by {@link
66627 *   yaz_connect}.
66628 * @param int $start Specifies the position of the first record to be
66629 *   retrieved. The records numbers goes from 1 to {@link yaz_hits}.
66630 * @param int $number Specifies the number of records to be retrieved.
66631 * @return void
66632 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
66633 **/
66634function yaz_range($id, $start, $number){}
66635
66636/**
66637 * The {@link yaz_record} function inspects a record in the current
66638 * result set at the position specified by parameter {@link pos}.
66639 *
66640 * @param resource $id The connection resource returned by {@link
66641 *   yaz_connect}.
66642 * @param int $pos The record position. Records positions in a result
66643 *   set are numbered 1, 2, ... $hits where $hits is the count returned
66644 *   by {@link yaz_hits}.
66645 * @param string $type The {@link type} specifies the form of the
66646 *   returned record. Besides conversion of the transfer record to a
66647 *   string/array, PHP/YAZ it is also possible to perform a character set
66648 *   conversion of the record. Especially for USMARC/MARC21 that is
66649 *   recommended since these are typically returned in the character set
66650 *   MARC-8 that is not supported by browsers, etc. To specify a
66651 *   conversion, add ; charset=from, to where from is the original
66652 *   character set of the record and to is the resulting character set
66653 *   (as seen by PHP).
66654 * @return string
66655 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
66656 **/
66657function yaz_record($id, $pos, $type){}
66658
66659/**
66660 * This function prepares for a Z39.50 Scan Request on the specified
66661 * connection.
66662 *
66663 * To actually transfer the Scan Request to the server and receive the
66664 * Scan Response, {@link yaz_wait} must be called. Upon completion of
66665 * {@link yaz_wait} call {@link yaz_error} and {@link yaz_scan_result} to
66666 * handle the response.
66667 *
66668 * @param resource $id The connection resource returned by {@link
66669 *   yaz_connect}.
66670 * @param string $type Currently only type rpn is supported.
66671 * @param string $startterm Starting term point for the scan. The form
66672 *   in which the starting term is specified is given by parameter {@link
66673 *   type}. The syntax this parameter is similar to the RPN query as
66674 *   described in {@link yaz_search}. It consists of zero or more
66675 *   @attr-operator specifications, then followed by exactly one token.
66676 * @param array $flags This optional parameter specifies additional
66677 *   information to control the behaviour of the scan request. Three
66678 *   indexes are currently read from the flags array: number (number of
66679 *   terms requested), position (preferred position of term) and stepSize
66680 *   (preferred step size).
66681 * @return void
66682 * @since PHP 4 >= 4.0.5, PECL yaz >= 0.9.0
66683 **/
66684function yaz_scan($id, $type, $startterm, $flags){}
66685
66686/**
66687 * {@link yaz_scan_result} returns terms and associated information as
66688 * received from the server in the last performed {@link yaz_scan}.
66689 *
66690 * @param resource $id The connection resource returned by {@link
66691 *   yaz_connect}.
66692 * @param array $result If given, this array will be modified to hold
66693 *   additional information taken from the Scan Response: number - Number
66694 *   of entries returned stepsize - Step size position - Position of term
66695 *   status - Scan status
66696 * @return array
66697 * @since PHP 4 >= 4.0.5, PECL yaz >= 0.9.0
66698 **/
66699function yaz_scan_result($id, &$result){}
66700
66701/**
66702 * {@link yaz_schema} specifies the schema for retrieval.
66703 *
66704 * This function should be called before {@link yaz_search} or {@link
66705 * yaz_present}.
66706 *
66707 * @param resource $id The connection resource returned by {@link
66708 *   yaz_connect}.
66709 * @param string $schema Must be specified as an OID (Object
66710 *   Identifier) in a raw dot-notation (like 1.2.840.10003.13.4) or as
66711 *   one of the known registered schemas: GILS-schema, Holdings, Zthes,
66712 *   ...
66713 * @return void
66714 * @since PHP 4 >= 4.2.0, PECL yaz >= 0.9.0
66715 **/
66716function yaz_schema($id, $schema){}
66717
66718/**
66719 * {@link yaz_search} prepares for a search on the given connection.
66720 *
66721 * Like {@link yaz_connect} this function is non-blocking and only
66722 * prepares for a search to be executed later when {@link yaz_wait} is
66723 * called.
66724 *
66725 * @param resource $id The connection resource returned by {@link
66726 *   yaz_connect}.
66727 * @param string $type This parameter represents the query type - only
66728 *   "rpn" is supported now in which case the third argument specifies a
66729 *   Type-1 query in prefix query notation.
66730 * @param string $query The RPN query is a textual representation of
66731 *   the Type-1 query as defined by the Z39.50 standard. However, in the
66732 *   text representation as used by YAZ a prefix notation is used, that
66733 *   is the operator precedes the operands. The query string is a
66734 *   sequence of tokens where white space is ignored unless surrounded by
66735 *   double quotes. Tokens beginning with an at-character (@) are
66736 *   considered operators, otherwise they are treated as search terms.
66737 *   You can find information about attributes at the Z39.50 Maintenance
66738 *   Agency site.
66739 * @return bool
66740 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
66741 **/
66742function yaz_search($id, $type, $query){}
66743
66744/**
66745 * Sets one or more options on the given connection.
66746 *
66747 * @param resource $id The connection resource returned by {@link
66748 *   yaz_connect}.
66749 * @param string $name May be either a string or an array. If given as
66750 *   a string, this will be the name of the option to set. You'll need to
66751 *   give it's {@link value}. If given as an array, this will be an
66752 *   associative array (option name => option value).
66753 * @param string $value The new value of the option. Use this only if
66754 *   the previous argument is a string.
66755 * @return void
66756 * @since PECL yaz >= 0.9.0
66757 **/
66758function yaz_set_option($id, $name, $value){}
66759
66760/**
66761 * This function sets sorting criteria and enables Z39.50 Sort.
66762 *
66763 * Call this function before {@link yaz_search}. Using this function
66764 * alone does not have any effect. When used in conjunction with {@link
66765 * yaz_search}, a Z39.50 Sort will be sent after a search response has
66766 * been received and before any records are retrieved with Z39.50 Present
66767 * ({@link yaz_present}.
66768 *
66769 * @param resource $id The connection resource returned by {@link
66770 *   yaz_connect}.
66771 * @param string $criteria A string that takes the form field1 flags1
66772 *   field2 flags2 where field1 specifies the primary attributes for
66773 *   sort, field2 seconds, etc.. The field specifies either a numerical
66774 *   attribute combinations consisting of type=value pairs separated by
66775 *   comma (e.g. 1=4,2=1) ; or the field may specify a plain string
66776 *   criteria (e.g. title. The flags is a sequence of the following
66777 *   characters which may not be separated by any white space.
66778 *
66779 *   Sort Flags a Sort ascending d Sort descending i Case insensitive
66780 *   sorting s Case sensitive sorting
66781 * @return void
66782 * @since PHP 4 >= 4.0.7, PECL yaz >= 0.9.0
66783 **/
66784function yaz_sort($id, $criteria){}
66785
66786/**
66787 * {@link yaz_syntax} specifies the preferred record syntax for retrieval
66788 *
66789 * This function should be called before {@link yaz_search} or {@link
66790 * yaz_present}.
66791 *
66792 * @param resource $id The connection resource returned by {@link
66793 *   yaz_connect}.
66794 * @param string $syntax The syntax must be specified as an OID (Object
66795 *   Identifier) in a raw dot-notation (like 1.2.840.10003.5.10) or as
66796 *   one of the known registered record syntaxes (sutrs, usmarc, grs1,
66797 *   xml, etc.).
66798 * @return void
66799 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
66800 **/
66801function yaz_syntax($id, $syntax){}
66802
66803/**
66804 * This function carries out networked (blocked) activity for outstanding
66805 * requests which have been prepared by the functions {@link
66806 * yaz_connect}, {@link yaz_search}, {@link yaz_present}, {@link
66807 * yaz_scan} and {@link yaz_itemorder}.
66808 *
66809 * {@link yaz_wait} returns when all servers have either completed all
66810 * requests or aborted (in case of errors).
66811 *
66812 * @param array $options An associative array of options: timeout Sets
66813 *   timeout in seconds. If a server has not responded within the timeout
66814 *   it is considered dead and {@link yaz_wait} returns. The default
66815 *   value for timeout is 15 seconds. event A boolean.
66816 * @return mixed
66817 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
66818 **/
66819function yaz_wait(&$options){}
66820
66821/**
66822 * @param string $domain The NIS domain name.
66823 * @param string $map The NIS map.
66824 * @param string $callback
66825 * @return void
66826 * @since PHP 4 >= 4.0.6, PHP 5
66827 **/
66828function yp_all($domain, $map, $callback){}
66829
66830/**
66831 * Returns all map entries.
66832 *
66833 * @param string $domain The NIS domain name.
66834 * @param string $map The NIS map.
66835 * @return array
66836 * @since PHP 4 >= 4.0.6, PHP 5
66837 **/
66838function yp_cat($domain, $map){}
66839
66840/**
66841 * Returns the error code of the previous operation.
66842 *
66843 * @return int
66844 * @since PHP 4 >= 4.0.6, PHP 5
66845 **/
66846function yp_errno(){}
66847
66848/**
66849 * Returns the error message associated with the given error code. Useful
66850 * to indicate what exactly went wrong.
66851 *
66852 * @param int $errorcode The error code.
66853 * @return string
66854 * @since PHP 4 >= 4.0.6, PHP 5
66855 **/
66856function yp_err_string($errorcode){}
66857
66858/**
66859 * Gets the first key-value pair from the named {@link map} in the named
66860 * {@link domain}.
66861 *
66862 * @param string $domain The NIS domain name.
66863 * @param string $map The NIS map.
66864 * @return array
66865 * @since PHP 4, PHP 5
66866 **/
66867function yp_first($domain, $map){}
66868
66869/**
66870 * Returns the default domain of the node. Can be used as the domain
66871 * parameter for successive NIS calls.
66872 *
66873 * A NIS domain can be described a group of NIS maps. Every host that
66874 * needs to look up information binds itself to a certain domain. Refer
66875 * to the documents mentioned at the beginning for more detailed
66876 * information.
66877 *
66878 * @return string
66879 * @since PHP 4, PHP 5
66880 **/
66881function yp_get_default_domain(){}
66882
66883/**
66884 * Returns the machine name of the master NIS server for a {@link map}.
66885 *
66886 * @param string $domain The NIS domain name.
66887 * @param string $map The NIS map.
66888 * @return string
66889 * @since PHP 4, PHP 5
66890 **/
66891function yp_master($domain, $map){}
66892
66893/**
66894 * Returns the value associated with the passed {@link key} out of the
66895 * specified {@link map}.
66896 *
66897 * @param string $domain The NIS domain name.
66898 * @param string $map The NIS map.
66899 * @param string $key This key must be exact.
66900 * @return string
66901 * @since PHP 4, PHP 5
66902 **/
66903function yp_match($domain, $map, $key){}
66904
66905/**
66906 * Returns the next key-value pair in the named {@link map} after the
66907 * specified {@link key}.
66908 *
66909 * @param string $domain
66910 * @param string $map
66911 * @param string $key
66912 * @return array
66913 * @since PHP 4, PHP 5
66914 **/
66915function yp_next($domain, $map, $key){}
66916
66917/**
66918 * Gets the order number for a map.
66919 *
66920 * @param string $domain
66921 * @param string $map
66922 * @return int
66923 * @since PHP 4, PHP 5
66924 **/
66925function yp_order($domain, $map){}
66926
66927/**
66928 * This function returns the ID which can be used to display the Zend
66929 * logo using the built-in image.
66930 *
66931 * @return string
66932 * @since PHP 4, PHP 5
66933 **/
66934function zend_logo_guid(){}
66935
66936/**
66937 * This function returns a unique identifier for the current thread.
66938 *
66939 * @return int
66940 * @since PHP 5
66941 **/
66942function zend_thread_id(){}
66943
66944/**
66945 * Returns a string containing the version of the currently running Zend
66946 * Engine.
66947 *
66948 * @return string
66949 * @since PHP 4, PHP 5
66950 **/
66951function zend_version(){}
66952
66953/**
66954 * Closes the given ZIP file archive.
66955 *
66956 * @param resource $zip A ZIP file previously opened with {@link
66957 *   zip_open}.
66958 * @return void
66959 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0
66960 **/
66961function zip_close($zip){}
66962
66963/**
66964 * Closes the specified directory entry.
66965 *
66966 * @param resource $zip_entry A directory entry previously opened
66967 *   {@link zip_entry_open}.
66968 * @return bool
66969 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0
66970 **/
66971function zip_entry_close($zip_entry){}
66972
66973/**
66974 * Returns the compressed size of the specified directory entry.
66975 *
66976 * @param resource $zip_entry A directory entry returned by {@link
66977 *   zip_read}.
66978 * @return int
66979 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0
66980 **/
66981function zip_entry_compressedsize($zip_entry){}
66982
66983/**
66984 * Returns the compression method of the directory entry specified by
66985 * {@link zip_entry}.
66986 *
66987 * @param resource $zip_entry A directory entry returned by {@link
66988 *   zip_read}.
66989 * @return string
66990 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0
66991 **/
66992function zip_entry_compressionmethod($zip_entry){}
66993
66994/**
66995 * Returns the actual size of the specified directory entry.
66996 *
66997 * @param resource $zip_entry A directory entry returned by {@link
66998 *   zip_read}.
66999 * @return int
67000 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0
67001 **/
67002function zip_entry_filesize($zip_entry){}
67003
67004/**
67005 * Returns the name of the specified directory entry.
67006 *
67007 * @param resource $zip_entry A directory entry returned by {@link
67008 *   zip_read}.
67009 * @return string
67010 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0
67011 **/
67012function zip_entry_name($zip_entry){}
67013
67014/**
67015 * Opens a directory entry in a zip file for reading.
67016 *
67017 * @param resource $zip A valid resource handle returned by {@link
67018 *   zip_open}.
67019 * @param resource $zip_entry A directory entry returned by {@link
67020 *   zip_read}.
67021 * @param string $mode Any of the modes specified in the documentation
67022 *   of {@link fopen}.
67023 * @return bool
67024 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0
67025 **/
67026function zip_entry_open($zip, $zip_entry, $mode){}
67027
67028/**
67029 * Reads from an open directory entry.
67030 *
67031 * @param resource $zip_entry A directory entry returned by {@link
67032 *   zip_read}.
67033 * @param int $length The number of bytes to return. If not specified,
67034 *   this function will attempt to read 1024 bytes.
67035 * @return string
67036 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0
67037 **/
67038function zip_entry_read($zip_entry, $length){}
67039
67040/**
67041 * Opens a new zip archive for reading.
67042 *
67043 * @param string $filename The file name of the ZIP archive to open.
67044 * @return mixed
67045 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0
67046 **/
67047function zip_open($filename){}
67048
67049/**
67050 * Reads the next entry in a zip file archive.
67051 *
67052 * @param resource $zip A ZIP file previously opened with {@link
67053 *   zip_open}.
67054 * @return mixed
67055 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0
67056 **/
67057function zip_read($zip){}
67058
67059/**
67060 * Returns the coding type used for output compression.
67061 *
67062 * @return string
67063 * @since PHP 4 >= 4.3.2, PHP 5
67064 **/
67065function zlib_get_coding_type(){}
67066
67067/**
67068 * Iterates through a file system in a similar fashion to .
67069 **/
67070class GlobIterator extends FilesystemIterator implements Iterator, Traversable, SeekableIterator, Countable {
67071    /**
67072     * Gets the number of directories and files found by the glob expression.
67073     *
67074     * @return integer
67075     * @since PHP 5 >= 5.3.0
67076     **/
67077    function count(){}
67078
67079    /**
67080     * Constructs a new directory iterator from a glob expression.
67081     *
67082     * @param string $path The path of the directory.
67083     * @param integer $flags Option flags, the flags may be a bitmask of
67084     *   the FilesystemIterator constants.
67085     * @since PHP 5 >= 5.3.0
67086     **/
67087    function __construct($path, $flags){}
67088
67089}
67090/**
67091 * Description of the class.
67092 **/
67093interface Gmagick {
67094    const COLOR_ALPHA = 0;
67095    const COLOR_BLACK = 0;
67096    const COLOR_BLUE = 0;
67097    const COLOR_CYAN = 0;
67098    const COLOR_FUZZ = 0;
67099    const COLOR_GREEN = 0;
67100    const COLOR_MAGENTA = 0;
67101    const COLOR_OPACITY = 0;
67102    const COLOR_RED = 0;
67103    const COLOR_YELLOW = 0;
67104    /**
67105     * Adds new image to Gmagick object from the current position of the
67106     * source object. After the operation iterator position is moved at the
67107     * end of the list.
67108     *
67109     * @param Gmagick $Gmagick The source Gmagick object
67110     * @return void
67111     * @since PECL gmagick >= Unknown
67112     **/
67113    function addimage($Gmagick);
67114
67115    /**
67116     * Adds random noise to the image.
67117     *
67118     * @param int $NOISE The type of the noise. Refer to this list of noise
67119     *   constants.
67120     * @return void
67121     * @since PECL gmagick >= Unknown
67122     **/
67123    function addnoiseimage($NOISE);
67124
67125    /**
67126     * Annotates an image with text.
67127     *
67128     * @param GmagickDraw $GmagickDraw The GmagickDraw object that contains
67129     *   settings for drawing the text
67130     * @param int $x Horizontal offset in pixels to the left of text
67131     * @param int $y Vertical offset in pixels to the baseline of text
67132     * @param float $angle The angle at which to write the text
67133     * @param string $text The string to draw
67134     * @return void
67135     * @since PECL gmagick >= Unknown
67136     **/
67137    function annotateimage($GmagickDraw, $x, $y, $angle, $text);
67138
67139    /**
67140     * Adds blur filter to image.
67141     *
67142     * @param float $radius Blur radius
67143     * @param float $sigma Standard deviation
67144     * @return void
67145     * @since PECL gmagick >= Unknown
67146     **/
67147    function blurimage($radius, $sigma);
67148
67149    /**
67150     * Surrounds the image with a border of the color defined by the
67151     * bordercolor GmagickPixel object or a color string.
67152     *
67153     * @param GmagickPixel $color GmagickPixel object or a string
67154     *   containing the border color
67155     * @param int $width Border width
67156     * @param int $height Border height
67157     * @return void
67158     * @since PECL gmagick >= Unknown
67159     **/
67160    function borderimage($color, $width, $height);
67161
67162    /**
67163     * Simulates a charcoal drawing.
67164     *
67165     * @param float $radius The radius of the Gaussian, in pixels, not
67166     *   counting the center pixel
67167     * @param float $sigma The standard deviation of the Gaussian, in
67168     *   pixels
67169     * @return void
67170     * @since PECL gmagick >= Unknown
67171     **/
67172    function charcoalimage($radius, $sigma);
67173
67174    /**
67175     * Removes a region of an image and collapses the image to occupy the
67176     * removed portion.
67177     *
67178     * @param int $width Width of the chopped area
67179     * @param int $height Height of the chopped area
67180     * @param int $x X origo of the chopped area
67181     * @param int $y Y origo of the chopped area
67182     * @return void
67183     * @since PECL gmagick >= Unknown
67184     **/
67185    function chopimage($width, $height, $x, $y);
67186
67187    /**
67188     * Clears all resources associated to Gmagick object
67189     *
67190     * @return void
67191     * @since PECL gmagick >= Unknown
67192     **/
67193    function clear();
67194
67195    /**
67196     * Adds a comment to your image.
67197     *
67198     * @param string $comment The comment to add
67199     * @return void
67200     * @since PECL gmagick >= Unknown
67201     **/
67202    function commentimage($comment);
67203
67204    /**
67205     * Composite one image onto another at the specified offset.
67206     *
67207     * @param Gmagick $source Gmagick object which holds the composite
67208     *   image
67209     * @param int $COMPOSE Composite operator.
67210     * @param int $x The column offset of the composited image
67211     * @param int $y The row offset of the composited image
67212     * @return void
67213     * @since PECL gmagick >= Unknown
67214     **/
67215    function compositeimage($source, $COMPOSE, $x, $y);
67216
67217    /**
67218     * Extracts a region of the image.
67219     *
67220     * @param int $width The width of the crop
67221     * @param int $height The height of the crop
67222     * @param int $x The X coordinate of the cropped region's top left
67223     *   corner
67224     * @param int $y The Y coordinate of the cropped region's top left
67225     *   corner
67226     * @return void
67227     * @since PECL gmagick >= Unknown
67228     **/
67229    function cropimage($width, $height, $x, $y);
67230
67231    /**
67232     * Creates a fixed size thumbnail by first scaling the image down and
67233     * cropping a specified area from the center.
67234     *
67235     * @param int $width The width of the thumbnail
67236     * @param int $height The Height of the thumbnail
67237     * @return void
67238     * @since PECL gmagick >= Unknown
67239     **/
67240    function cropthumbnailimage($width, $height);
67241
67242    /**
67243     * Returns reference to the current gmagick object with image pointer at
67244     * the correct sequence.
67245     *
67246     * @return void
67247     * @since PECL gmagick >= Unknown
67248     **/
67249    function current();
67250
67251    /**
67252     * Displaces an image's colormap by a given number of positions. If you
67253     * cycle the colormap a number of times you can produce a psychedelic
67254     * effect.
67255     *
67256     * @param float $displace The amount to displace the colormap.
67257     * @return void
67258     * @since PECL gmagick >= Unknown
67259     **/
67260    function cyclecolormapimage($displace);
67261
67262    /**
67263     * Compares each image with the next in a sequence and returns the
67264     * maximum bounding region of any pixel differences it discovers.
67265     *
67266     * @return void
67267     * @since PECL gmagick >= Unknown
67268     **/
67269    function deconstructimages();
67270
67271    /**
67272     * Reduces the speckle noise in an image while preserving the edges of
67273     * the original image.
67274     *
67275     * @return void
67276     * @since PECL gmagick >= Unknown
67277     **/
67278    function despeckleimage();
67279
67280    /**
67281     * Destroys the Gmagick object and frees all resources associated with it
67282     *
67283     * @return void
67284     * @since PECL gmagick >= Unknown
67285     **/
67286    function destroy();
67287
67288    /**
67289     * Renders the GmagickDraw object on the current image
67290     *
67291     * @param GmagickDraw $GmagickDraw The drawing operations to render on
67292     *   the image.
67293     * @return void
67294     * @since PECL gmagick >= Unknown
67295     **/
67296    function drawimage($GmagickDraw);
67297
67298    /**
67299     * Enhance edges within the image with a convolution filter of the given
67300     * radius. Use radius 0 and it will be auto-selected.
67301     *
67302     * @param float $radius The radius of the operation.
67303     * @return void
67304     * @since PECL gmagick >= Unknown
67305     **/
67306    function edgeimage($radius);
67307
67308    /**
67309     * Returns a grayscale image with a three-dimensional effect. We convolve
67310     * the image with a Gaussian operator of the given radius and standard
67311     * deviation (sigma). For reasonable results, radius should be larger
67312     * than sigma. Use a radius of 0 and it will choose a suitable radius for
67313     * you.
67314     *
67315     * @param float $radius The radius of the effect
67316     * @param float $sigma The sigma of the effect
67317     * @return void
67318     * @since PECL gmagick >= Unknown
67319     **/
67320    function embossimage($radius, $sigma);
67321
67322    /**
67323     * Applies a digital filter that improves the quality of a noisy image.
67324     *
67325     * @return void
67326     * @since PECL gmagick >= Unknown
67327     **/
67328    function enhanceimage();
67329
67330    /**
67331     * Equalizes the image histogram.
67332     *
67333     * @return void
67334     * @since PECL gmagick >= Unknown
67335     **/
67336    function equalizeimage();
67337
67338    /**
67339     * Creates a vertical mirror image by reflecting the pixels around the
67340     * central x-axis.
67341     *
67342     * @return void
67343     * @since PECL gmagick >= Unknown
67344     **/
67345    function flipimage();
67346
67347    /**
67348     * Creates a horizontal mirror image by reflecting the pixels around the
67349     * central y-axis.
67350     *
67351     * @return void
67352     * @since PECL gmagick >= Unknown
67353     **/
67354    function flopimage();
67355
67356    /**
67357     * Adds a simulated three-dimensional border around the image. The width
67358     * and height specify the border width of the vertical and horizontal
67359     * sides of the frame. The inner and outer bevels indicate the width of
67360     * the inner and outer shadows of the frame.
67361     *
67362     * @param GmagickPixel $color GmagickPixel object or a float
67363     *   representing the matte color
67364     * @param int $width The width of the border
67365     * @param int $height The height of the border
67366     * @param int $inner_bevel The inner bevel width
67367     * @param int $outer_bevel The outer bevel width
67368     * @return void
67369     * @since PECL gmagick >= Unknown
67370     **/
67371    function frameimage($color, $width, $height, $inner_bevel, $outer_bevel);
67372
67373    /**
67374     * Gamma-corrects an image. The same image viewed on different devices
67375     * will have perceptual differences in the way the image's intensities
67376     * are represented on the screen. Specify individual gamma levels for the
67377     * red, green, and blue channels, or adjust all three with the gamma
67378     * parameter. Values typically range from 0.8 to 2.3.
67379     *
67380     * @param float $gamma The amount of gamma-correction.
67381     * @return void
67382     * @since PECL gmagick >= Unknown
67383     **/
67384    function gammaimage($gamma);
67385
67386    /**
67387     * Returns the GraphicsMagick API copyright as a string.
67388     *
67389     * @return void
67390     * @since PECL gmagick >= Unknown
67391     **/
67392    function getcopyright();
67393
67394    /**
67395     * Returns the filename associated with an image sequence.
67396     *
67397     * @return void
67398     * @since PECL gmagick >= Unknown
67399     **/
67400    function getfilename();
67401
67402    /**
67403     * Returns the image background color.
67404     *
67405     * @return void
67406     * @since PECL gmagick >= Unknown
67407     **/
67408    function getimagebackgroundcolor();
67409
67410    /**
67411     * Returns the chromaticity blue primary point for the image.
67412     *
67413     * @return void
67414     * @since PECL gmagick >= Unknown
67415     **/
67416    function getimageblueprimary();
67417
67418    /**
67419     * Returns the image border color.
67420     *
67421     * @return void
67422     * @since PECL gmagick >= Unknown
67423     **/
67424    function getimagebordercolor();
67425
67426    /**
67427     * Gets the depth for a particular image channel.
67428     *
67429     * @return void
67430     * @since PECL gmagick >= Unknown
67431     **/
67432    function getimagechanneldepth();
67433
67434    /**
67435     * Returns the color of the specified colormap index.
67436     *
67437     * @return void
67438     * @since PECL gmagick >= Unknown
67439     **/
67440    function getimagecolors();
67441
67442    /**
67443     * Gets the image colorspace.
67444     *
67445     * @return void
67446     * @since PECL gmagick >= Unknown
67447     **/
67448    function getimagecolorspace();
67449
67450    /**
67451     * Returns the composite operator associated with the image.
67452     *
67453     * @return void
67454     * @since PECL gmagick >= Unknown
67455     **/
67456    function getimagecompose();
67457
67458    /**
67459     * Gets the image delay
67460     *
67461     * @return void
67462     * @since PECL gmagick >= Unknown
67463     **/
67464    function getimagedelay();
67465
67466    /**
67467     * Gets the depth of the image.
67468     *
67469     * @return void
67470     * @since PECL gmagick >= Unknown
67471     **/
67472    function getimagedepth();
67473
67474    /**
67475     * Gets the image disposal method
67476     *
67477     * @return void
67478     * @since PECL gmagick >= Unknown
67479     **/
67480    function getimagedispose();
67481
67482    /**
67483     * Returns an associative array with the keys "min" and "max".
67484     *
67485     * @return void
67486     * @since PECL gmagick >= Unknown
67487     **/
67488    function getimageextrema();
67489
67490    /**
67491     * Returns the filename of a particular image in a sequence
67492     *
67493     * @return void
67494     * @since PECL gmagick >= Unknown
67495     **/
67496    function getimagefilename();
67497
67498    /**
67499     * Returns the format of a particular image in a sequence.
67500     *
67501     * @return void
67502     * @since PECL gmagick >= Unknown
67503     **/
67504    function getimageformat();
67505
67506    /**
67507     * Gets the image gamma
67508     *
67509     * @return void
67510     * @since PECL gmagick >= Unknown
67511     **/
67512    function getimagegamma();
67513
67514    /**
67515     * Returns the chromaticity green primary point. Returns an array with
67516     * the keys "x" and "y".
67517     *
67518     * @return void
67519     * @since PECL gmagick >= Unknown
67520     **/
67521    function getimagegreenprimary();
67522
67523    /**
67524     * Returns the image height
67525     *
67526     * @return void
67527     * @since PECL gmagick >= Unknown
67528     **/
67529    function getimageheight();
67530
67531    /**
67532     * Returns the image histogram as an array of GmagickPixel objects. Throw
67533     * an GmagickException on error.
67534     *
67535     * @return void
67536     * @since PECL gmagick >= Unknown
67537     **/
67538    function getimagehistogram();
67539
67540    /**
67541     * Returns the index of the current active image within the Gmagick
67542     * object.
67543     *
67544     * @return void
67545     * @since PECL gmagick >= Unknown
67546     **/
67547    function getimageindex();
67548
67549    /**
67550     * Gets the image interlace scheme.
67551     *
67552     * @return void
67553     * @since PECL gmagick >= Unknown
67554     **/
67555    function getimageinterlacescheme();
67556
67557    /**
67558     * Gets the image iterations.
67559     *
67560     * @return void
67561     * @since PECL gmagick >= Unknown
67562     **/
67563    function getimageiterations();
67564
67565    /**
67566     * Returns TRUE if the image has a matte channel otherwise false.
67567     *
67568     * @return void
67569     * @since PECL gmagick >= Unknown
67570     **/
67571    function getimagematte();
67572
67573    /**
67574     * Returns GmagickPixel object on success. Throw an GmagickException on
67575     * error.
67576     *
67577     * @return void
67578     * @since PECL gmagick >= Unknown
67579     **/
67580    function getimagemattecolor();
67581
67582    /**
67583     * Returns the named image profile.
67584     *
67585     * @return void
67586     * @since PECL gmagick >= Unknown
67587     **/
67588    function getimageprofile();
67589
67590    /**
67591     * Returns the chromaticity red primary point as an array with the keys
67592     * "x" and "y".
67593     *
67594     * @return void
67595     * @since PECL gmagick >= Unknown
67596     **/
67597    function getimageredprimary();
67598
67599    /**
67600     * Gets the image rendering intent
67601     *
67602     * @return void
67603     * @since PECL gmagick >= Unknown
67604     **/
67605    function getimagerenderingintent();
67606
67607    /**
67608     * Returns the resolution as an array.
67609     *
67610     * @return void
67611     * @since PECL gmagick >= Unknown
67612     **/
67613    function getimageresolution();
67614
67615    /**
67616     * Gets the image scene.
67617     *
67618     * @return void
67619     * @since PECL gmagick >= Unknown
67620     **/
67621    function getimagescene();
67622
67623    /**
67624     * Generates an SHA-256 message digest for the image pixel stream.
67625     *
67626     * @return void
67627     * @since PECL gmagick >= Unknown
67628     **/
67629    function getimagesignature();
67630
67631    /**
67632     * Gets the potential image type.
67633     *
67634     * @return void
67635     * @since PECL gmagick >= Unknown
67636     **/
67637    function getimagetype();
67638
67639    /**
67640     * Gets the image units of resolution.
67641     *
67642     * @return void
67643     * @since PECL gmagick >= Unknown
67644     **/
67645    function getimageunits();
67646
67647    /**
67648     * Returns the chromaticity white point as an associative array with the
67649     * keys "x" and "y".
67650     *
67651     * @return void
67652     * @since PECL gmagick >= Unknown
67653     **/
67654    function getimagewhitepoint();
67655
67656    /**
67657     * Returns the width of the image.
67658     *
67659     * @return void
67660     * @since PECL gmagick >= Unknown
67661     **/
67662    function getimagewidth();
67663
67664    /**
67665     * Returns the GraphicsMagick package name.
67666     *
67667     * @return void
67668     * @since PECL gmagick >= Unknown
67669     **/
67670    function getpackagename();
67671
67672    /**
67673     * Returns the Gmagick quantum depth as a string.
67674     *
67675     * @return void
67676     * @since PECL gmagick >= Unknown
67677     **/
67678    function getquantumdepth();
67679
67680    /**
67681     * Returns the GraphicsMagick release date as a string.
67682     *
67683     * @return void
67684     * @since PECL gmagick >= Unknown
67685     **/
67686    function getreleasedate();
67687
67688    /**
67689     * Gets the horizontal and vertical sampling factor.
67690     *
67691     * @return void
67692     * @since PECL gmagick >= Unknown
67693     **/
67694    function getsamplingfactors();
67695
67696    /**
67697     * Returns the size associated with the Gmagick object as an array with
67698     * the keys "columns" and "rows".
67699     *
67700     * @return void
67701     * @since PECL gmagick >= Unknown
67702     **/
67703    function getsize();
67704
67705    /**
67706     * Returns the GraphicsMagick API version as a string and as a number.
67707     *
67708     * @return void
67709     * @since PECL gmagick >= Unknown
67710     **/
67711    function getversion();
67712
67713    /**
67714     * Returns TRUE if the object has more images when traversing the list in
67715     * the forward direction.
67716     *
67717     * @return void
67718     * @since PECL gmagick >= Unknown
67719     **/
67720    function hasnextimage();
67721
67722    /**
67723     * Returns TRUE if the object has more images when traversing the list in
67724     * the reverse direction
67725     *
67726     * @return void
67727     * @since PECL gmagick >= Unknown
67728     **/
67729    function haspreviousimage();
67730
67731    /**
67732     * Creates a new image that is a copy of an existing one with the image
67733     * pixels "imploded" by the specified percentage.
67734     *
67735     * @param float $radius The radius of the implode
67736     * @return void
67737     * @since PECL gmagick >= Unknown
67738     **/
67739    function implodeimage($radius);
67740
67741    /**
67742     * Adds a label to an image.
67743     *
67744     * @param string $label The label to add
67745     * @return void
67746     * @since PECL gmagick >= Unknown
67747     **/
67748    function labelimage($label);
67749
67750    /**
67751     * Adjusts the levels of an image by scaling the colors falling between
67752     * specified white and black points to the full available quantum range.
67753     * The parameters provided represent the black, mid, and white points.
67754     * The black point specifies the darkest color in the image. Colors
67755     * darker than the black point are set to zero. Mid point specifies a
67756     * gamma correction to apply to the image. White point specifies the
67757     * lightest color in the image. Colors brighter than the white point are
67758     * set to the maximum quantum value.
67759     *
67760     * @param float $blackPoint The image black point
67761     * @param float $gamma The gamma value
67762     * @param float $whitePoint The image white point
67763     * @param int $channel Provide any channel constant that is valid for
67764     *   your channel mode. To apply to more than one channel, combine
67765     *   channeltype constants using bitwise operators. Refer to this list of
67766     *   channel constants.
67767     * @return void
67768     * @since PECL gmagick >= Unknown
67769     **/
67770    function levelimage($blackPoint, $gamma, $whitePoint, $channel);
67771
67772    /**
67773     * Conveniently scales an image proportionally to twice its original
67774     * size.
67775     *
67776     * @return void
67777     * @since PECL gmagick >= Unknown
67778     **/
67779    function magnifyimage();
67780
67781    /**
67782     * Replaces the colors of an image with the closest color from a
67783     * reference image.
67784     *
67785     * @param gmagick $gmagick The reference image
67786     * @param int $dither Set this integer value to something other than
67787     *   zero to dither the mapped image
67788     * @return void
67789     * @since PECL gmagick >= Unknown
67790     **/
67791    function mapimage($gmagick, $dither);
67792
67793    /**
67794     * Applies a digital filter that improves the quality of a noisy image.
67795     * Each pixel is replaced by the median in a set of neighboring pixels as
67796     * defined by radius.
67797     *
67798     * @param float $radius The radius of the pixel neighborhood.
67799     * @return void
67800     * @since PECL gmagick >= Unknown
67801     **/
67802    function medianfilterimage($radius);
67803
67804    /**
67805     * A convenient method that scales an image proportionally to one-half
67806     * its original size
67807     *
67808     * @return void
67809     * @since PECL gmagick >= Unknown
67810     **/
67811    function minifyimage();
67812
67813    /**
67814     * Lets you control the brightness, saturation, and hue of an image. Hue
67815     * is the percentage of absolute rotation from the current position. For
67816     * example 50 results in a counter-clockwise rotation of 90 degrees, 150
67817     * results in a clockwise rotation of 90 degrees, with 0 and 200 both
67818     * resulting in a rotation of 180 degrees.
67819     *
67820     * @param float $brightness The percent change in brighness (-100 thru
67821     *   +100).
67822     * @param float $saturation The percent change in saturation (-100 thru
67823     *   +100)
67824     * @param float $hue The percent change in hue (-100 thru +100)
67825     * @return void
67826     * @since PECL gmagick >= Unknown
67827     **/
67828    function modulateimage($brightness, $saturation, $hue);
67829
67830    /**
67831     * Simulates motion blur. We convolve the image with a Gaussian operator
67832     * of the given radius and standard deviation (sigma). For reasonable
67833     * results, radius should be larger than sigma. Use a radius of 0 and
67834     * MotionBlurImage() selects a suitable radius for you. Angle gives the
67835     * angle of the blurring motion.
67836     *
67837     * @param float $radius The radius of the Gaussian, in pixels, not
67838     *   counting the center pixel.
67839     * @param float $sigma The standard deviation of the Gaussian, in
67840     *   pixels.
67841     * @param float $angle Apply the effect along this angle.
67842     * @return void
67843     * @since PECL gmagick >= Unknown
67844     **/
67845    function motionblurimage($radius, $sigma, $angle);
67846
67847    /**
67848     * Creates a new image with the specified background color
67849     *
67850     * @param int $width Width of the new image
67851     * @param int $height Height of the new image
67852     * @param mixed $background The background color used for this image
67853     *   (as float)
67854     * @param string $format Image format.
67855     * @return void
67856     * @since PECL gmagick >= Unknown
67857     **/
67858    function newimage($width, $height, $background, $format);
67859
67860    /**
67861     * Associates the next image in the image list with an Gmagick object.
67862     *
67863     * @return void
67864     * @since PECL gmagick >= Unknown
67865     **/
67866    function nextimage();
67867
67868    /**
67869     * Enhances the contrast of a color image by adjusting the pixels color
67870     * to span the entire range of colors available.
67871     *
67872     * @param int $channel Identify which channel to normalize
67873     * @return void
67874     * @since PECL gmagick >= Unknown
67875     **/
67876    function normalizeimage($channel);
67877
67878    /**
67879     * Applies a special effect filter that simulates an oil painting. Each
67880     * pixel is replaced by the most frequent color occurring in a circular
67881     * region defined by radius.
67882     *
67883     * @param float $radius The radius of the circular neighborhood.
67884     * @return void
67885     * @since PECL gmagick >= Unknown
67886     **/
67887    function oilpaintimage($radius);
67888
67889    /**
67890     * Assocates the previous image in an image list with the Gmagick object.
67891     *
67892     * @return void
67893     * @since PECL gmagick >= Unknown
67894     **/
67895    function previousimage();
67896
67897    /**
67898     * Adds or removes a ICC, IPTC, or generic profile from an image. If the
67899     * profile is NULL, it is removed from the image otherwise added. Use a
67900     * name of '*' and a profile of NULL to remove all profiles from the
67901     * image.
67902     *
67903     * @param string $name Name of profile to add or remove: ICC, IPTC, or
67904     *   generic profile.
67905     * @param string $profile The profile.
67906     * @return void
67907     * @since PECL gmagick >= Unknown
67908     **/
67909    function profileimage($name, $profile);
67910
67911    /**
67912     * Analyzes the colors within a reference image and chooses a fixed
67913     * number of colors to represent the image. The goal of the algorithm is
67914     * to minimize the color difference between the input and output image
67915     * while minimizing the processing time.
67916     *
67917     * @param int $numColors The number of colors.
67918     * @param int $colorspace Perform color reduction in this colorspace,
67919     *   typically RGBColorspace.
67920     * @param int $treeDepth Normally, this integer value is zero or one. A
67921     *   zero or one tells Quantize to choose a optimal tree depth of
67922     *   Log4(number_colors).% A tree of this depth generally allows the best
67923     *   representation of the reference image with the least amount of
67924     *   memory and the fastest computational speed. In some cases, such as
67925     *   an image with low color dispersion (a few number of colors), a value
67926     *   other than Log4(number_colors) is required. To expand the color tree
67927     *   completely, use a value of 8.
67928     * @param bool $dither A value other than zero distributes the
67929     *   difference between an original image and the corresponding color
67930     *   reduced algorithm to neighboring pixels along a Hilbert curve.
67931     * @param bool $measureError A value other than zero measures the
67932     *   difference between the original and quantized images. This
67933     *   difference is the total quantization error. The error is computed by
67934     *   summing over all pixels in an image the distance squared in RGB
67935     *   space between each reference pixel value and its quantized value.
67936     * @return void
67937     * @since PECL gmagick >= Unknown
67938     **/
67939    function quantizeimage($numColors, $colorspace, $treeDepth, $dither, $measureError);
67940
67941    /**
67942     * Analyzes the colors within a sequence of images and chooses a fixed
67943     * number of colors to represent the image. The goal of the algorithm is
67944     * to minimize the color difference between the input and output image
67945     * while minimizing the processing time.
67946     *
67947     * @param int $numColors The number of colors.
67948     * @param int $colorspace Perform color reduction in this colorspace,
67949     *   typically RGBColorspace.
67950     * @param int $treeDepth Normally, this integer value is zero or one. A
67951     *   zero or one tells Quantize to choose a optimal tree depth of
67952     *   Log4(number_colors).% A tree of this depth generally allows the best
67953     *   representation of the reference image with the least amount of
67954     *   memory and the fastest computational speed. In some cases, such as
67955     *   an image with low color dispersion (a few number of colors), a value
67956     *   other than Log4(number_colors) is required. To expand the color tree
67957     *   completely, use a value of 8.
67958     * @param bool $dither A value other than zero distributes the
67959     *   difference between an original image and the corresponding color
67960     *   reduced algorithm to neighboring pixels along a Hilbert curve.
67961     * @param bool $measureError A value other than zero measures the
67962     *   difference between the original and quantized images. This
67963     *   difference is the total quantization error. The error is computed by
67964     *   summing over all pixels in an image the distance squared in RGB
67965     *   space between each reference pixel value and its quantized value.
67966     * @return void
67967     * @since PECL gmagick >= Unknown
67968     **/
67969    function quantizeimages($numColors, $colorspace, $treeDepth, $dither, $measureError);
67970
67971    /**
67972     * MagickQueryFontMetrics() returns an array representing the font
67973     * metrics.
67974     *
67975     * @return void
67976     * @since PECL gmagick >= Unknown
67977     **/
67978    function queryfontmetrics();
67979
67980    /**
67981     * Returns fonts supported by Gmagick.
67982     *
67983     * @return void
67984     * @since PECL gmagick >= Unknown
67985     **/
67986    function queryfonts();
67987
67988    /**
67989     * Returns formats supported by Gmagick.
67990     *
67991     * @param string $pattern Specifies a pointer to a text string
67992     *   containing a pattern.
67993     * @return void
67994     * @since PECL gmagick >= Unknown
67995     **/
67996    function queryformats($pattern);
67997
67998    /**
67999     * Radial blurs an image.
68000     *
68001     * @param float $angle The angle of the blur in degrees.
68002     * @param int $channel Related channel
68003     * @return void
68004     * @since PECL gmagick >= Unknown
68005     **/
68006    function radialblurimage($angle, $channel);
68007
68008    /**
68009     * Creates a simulated three-dimensional button-like effect by lightening
68010     * and darkening the edges of the image. Members width and height of
68011     * raise_info define the width of the vertical and horizontal edge of the
68012     * effect.
68013     *
68014     * @param int $width Width of the area to raise.
68015     * @param int $height Height of the area to raise.
68016     * @param int $x X coordinate
68017     * @param int $y Y coordinate
68018     * @param bool $raise A value other than zero creates a 3-D raise
68019     *   effect, otherwise it has a lowered effect.
68020     * @return void
68021     * @since PECL gmagick >= Unknown
68022     **/
68023    function raiseimage($width, $height, $x, $y, $raise);
68024
68025    /**
68026     * Reads image from filename.
68027     *
68028     * @param string $filename The image filename.
68029     * @return void
68030     * @since PECL gmagick >= Unknown
68031     **/
68032    function read($filename);
68033
68034    /**
68035     * Reads image from filename.
68036     *
68037     * @param string $filename The image filename.
68038     * @return void
68039     * @since PECL gmagick >= Unknown
68040     **/
68041    function readimage($filename);
68042
68043    /**
68044     * Reads image from a binary string.
68045     *
68046     * @param string $imageContents Content of image
68047     * @param string $filename The image filename.
68048     * @return void
68049     * @since PECL gmagick >= Unknown
68050     **/
68051    function readimageblob($imageContents, $filename);
68052
68053    /**
68054     * Reads an image or image sequence from an open file descriptor.
68055     *
68056     * @param string $fp The file descriptor.
68057     * @return void
68058     * @since PECL gmagick >= Unknown
68059     **/
68060    function readimagefile($fp);
68061
68062    /**
68063     * Smooths the contours of an image while still preserving edge
68064     * information. The algorithm works by replacing each pixel with its
68065     * neighbor closest in value. A neighbor is defined by radius. Use a
68066     * radius of 0 and Gmagick::reduceNoiseImage() selects a suitable radius
68067     * for you.
68068     *
68069     * @param float $radius The radius of the pixel neighborhood.
68070     * @return void
68071     * @since PECL gmagick >= Unknown
68072     **/
68073    function reducenoiseimage($radius);
68074
68075    /**
68076     * Removes an image from the image list.
68077     *
68078     * @return void
68079     * @since PECL gmagick >= Unknown
68080     **/
68081    function removeimage();
68082
68083    /**
68084     * Removes the named image profile and returns it.
68085     *
68086     * @param string $name Name of profile to return: ICC, IPTC, or generic
68087     *   profile.
68088     * @return void
68089     * @since PECL gmagick >= Unknown
68090     **/
68091    function removeimageprofile($name);
68092
68093    /**
68094     * Resample image to desired resolution.
68095     *
68096     * @param float $xResolution The new image x resolution.
68097     * @param float $yResolution The new image y resolution.
68098     * @param int $filter Image filter to use.
68099     * @param float $blur The blur factor where larger than 1 is blurry,
68100     *   smaller than 1 is sharp.
68101     * @return void
68102     * @since PECL gmagick >= Unknown
68103     **/
68104    function resampleimage($xResolution, $yResolution, $filter, $blur);
68105
68106    /**
68107     * Scales an image to the desired dimensions with a filter.
68108     *
68109     * @param int $width The number of columns in the scaled image.
68110     * @param int $height The number of rows in the scaled image.
68111     * @param int $filter Image filter to use.
68112     * @param float $blur The blur factor where larger than 1 is blurry,
68113     *   lesser than 1 is sharp.
68114     * @param bool $fit
68115     * @return void
68116     * @since PECL gmagick >= Unknown
68117     **/
68118    function resizeimage($width, $height, $filter, $blur, $fit);
68119
68120    /**
68121     * Offsets an image as defined by x and y.
68122     *
68123     * @param int $x The x offset.
68124     * @param int $y The y offset.
68125     * @return void
68126     * @since PECL gmagick >= Unknown
68127     **/
68128    function rollimage($x, $y);
68129
68130    /**
68131     * Rotates an image the specified number of degrees. Empty triangles left
68132     * over from rotating the image are filled with the background color.
68133     *
68134     * @param mixed $color The background pixel.
68135     * @param float $degrees The number of degrees to rotate the image.
68136     * @return void
68137     * @since PECL gmagick >= Unknown
68138     **/
68139    function rotateimage($color, $degrees);
68140
68141    /**
68142     * Scales the size of an image to the given dimensions. The other
68143     * parameter will be calculated if 0 is passed as either param.
68144     *
68145     * @param int $width The number of columns in the scaled image.
68146     * @param int $height The number of rows in the scaled image.
68147     * @return void
68148     * @since PECL gmagick >= Unknown
68149     **/
68150    function scaleimage($width, $height);
68151
68152    /**
68153     * Separates a channel from the image and returns a grayscale image. A
68154     * channel is a particular color component of each pixel in the image.
68155     *
68156     * @param int $channel Identify which channel to extract: RedChannel,
68157     *   GreenChannel, BlueChannel, OpacityChannel, CyanChannel,
68158     *   MagentaChannel, YellowChannel, BlackChannel.
68159     * @return void
68160     * @since PECL gmagick >= Unknown
68161     **/
68162    function separateimagechannel($channel);
68163
68164    /**
68165     * Sets the filename before you read or write an image file.
68166     *
68167     * @param string $filename The image filename.
68168     * @return void
68169     * @since PECL gmagick >= Unknown
68170     **/
68171    function setfilename($filename);
68172
68173    /**
68174     * Sets the image background color.
68175     *
68176     * @param GmagickPixel $color The background pixel wand.
68177     * @return void
68178     * @since PECL gmagick >= Unknown
68179     **/
68180    function setimagebackgroundcolor($color);
68181
68182    /**
68183     * Sets the image chromaticity blue primary point.
68184     *
68185     * @param float $x The blue primary x-point.
68186     * @param float $y The blue primary y-point.
68187     * @return void
68188     * @since PECL gmagick >= Unknown
68189     **/
68190    function setimageblueprimary($x, $y);
68191
68192    /**
68193     * Sets the image border color.
68194     *
68195     * @param GmagickPixel $color The border pixel wand.
68196     * @return void
68197     * @since PECL gmagick >= Unknown
68198     **/
68199    function setimagebordercolor($color);
68200
68201    /**
68202     * Sets the depth of a particular image channel.
68203     *
68204     * @param int $channel Identify which channel to extract: RedChannel,
68205     *   GreenChannel, BlueChannel, OpacityChannel, CyanChannel,
68206     *   MagentaChannel, YellowChannel, BlackChannel.
68207     * @param int $depth The image depth in bits.
68208     * @return void
68209     * @since PECL gmagick >= Unknown
68210     **/
68211    function setimagechanneldepth($channel, $depth);
68212
68213    /**
68214     * Sets the image colorspace.
68215     *
68216     * @param int $colorspace The image colorspace: UndefinedColorspace,
68217     *   RGBColorspace, GRAYColorspace, TransparentColorspace,
68218     *   OHTAColorspace, XYZColorspace, YCbCrColorspace, YCCColorspace,
68219     *   YIQColorspace, YPbPrColorspace, YPbPrColorspace, YUVColorspace,
68220     *   CMYKColorspace, sRGBColorspace, HSLColorspace, or HWBColorspace.
68221     * @return void
68222     * @since PECL gmagick >= Unknown
68223     **/
68224    function setimagecolorspace($colorspace);
68225
68226    /**
68227     * Sets the image composite operator.
68228     *
68229     * @param int $composite The image composite operator.
68230     * @return void
68231     * @since PECL gmagick >= Unknown
68232     **/
68233    function setimagecompose($composite);
68234
68235    /**
68236     * Sets the image delay
68237     *
68238     * @param int $delay The image delay in 1/100th of a second.
68239     * @return void
68240     * @since PECL gmagick >= Unknown
68241     **/
68242    function setimagedelay($delay);
68243
68244    /**
68245     * Sets the image depth
68246     *
68247     * @param float $depth The image depth in bits: 8, 16, or 32.
68248     * @return void
68249     * @since PECL gmagick >= Unknown
68250     **/
68251    function setimagedepth($depth);
68252
68253    /**
68254     * Sets the image disposal method.
68255     *
68256     * @param int $disposeType The image disposal type.
68257     * @return void
68258     * @since PECL gmagick >= Unknown
68259     **/
68260    function setimagedispose($disposeType);
68261
68262    /**
68263     * Sets the filename of a particular image in a sequence.
68264     *
68265     * @param string $filename The image filename.
68266     * @return void
68267     * @since PECL gmagick >= Unknown
68268     **/
68269    function setimagefilename($filename);
68270
68271    /**
68272     * Sets the format of a particular image in a sequence.
68273     *
68274     * @param string $imageFormat The image format.
68275     * @return void
68276     * @since PECL gmagick >= Unknown
68277     **/
68278    function setimageformat($imageFormat);
68279
68280    /**
68281     * Sets the image gamma.
68282     *
68283     * @param float $gamma The image gamma.
68284     * @return void
68285     * @since PECL gmagick >= Unknown
68286     **/
68287    function setimagegamma($gamma);
68288
68289    /**
68290     * Sets the image chromaticity green primary point.
68291     *
68292     * @param float $x The chromaticity green primary x-point.
68293     * @param float $y The chromaticity green primary y-point.
68294     * @return void
68295     * @since PECL gmagick >= Unknown
68296     **/
68297    function setimagegreenprimary($x, $y);
68298
68299    /**
68300     * Set the iterator to the position in the image list specified with the
68301     * index parameter.
68302     *
68303     * @param int $index The scene number.
68304     * @return void
68305     * @since PECL gmagick >= Unknown
68306     **/
68307    function setimageindex($index);
68308
68309    /**
68310     * Sets the interlace scheme of the image.
68311     *
68312     * @param int $interlace The image interlace scheme: NoInterlace,
68313     *   LineInterlace, PlaneInterlace, PartitionInterlace.
68314     * @return void
68315     * @since PECL gmagick >= Unknown
68316     **/
68317    function setimageinterlacescheme($interlace);
68318
68319    /**
68320     * Sets the image iterations.
68321     *
68322     * @param int $iterations The image delay in 1/100th of a second.
68323     * @return void
68324     * @since PECL gmagick >= Unknown
68325     **/
68326    function setimageiterations($iterations);
68327
68328    /**
68329     * Adds a named profile to the Gmagick object. If a profile with the same
68330     * name already exists, it is replaced. This method differs from the
68331     * Gmagick::ProfileImage() method in that it does not apply any CMS color
68332     * profiles.
68333     *
68334     * @param string $name Name of profile to add or remove: ICC, IPTC, or
68335     *   generic profile.
68336     * @param string $profile The profile.
68337     * @return void
68338     * @since PECL gmagick >= Unknown
68339     **/
68340    function setimageprofile($name, $profile);
68341
68342    /**
68343     * Sets the image chromaticity red primary point.
68344     *
68345     * @param float $x The red primary x-point.
68346     * @param float $y The red primary y-point.
68347     * @return void
68348     * @since PECL gmagick >= Unknown
68349     **/
68350    function setimageredprimary($x, $y);
68351
68352    /**
68353     * Sets the image rendering intent.
68354     *
68355     * @param int $rendering_intent The image rendering intent:
68356     *   UndefinedIntent, SaturationIntent, PerceptualIntent, AbsoluteIntent,
68357     *   or RelativeIntent.
68358     * @return void
68359     * @since PECL gmagick >= Unknown
68360     **/
68361    function setimagerenderingintent($rendering_intent);
68362
68363    /**
68364     * Sets the image resolution.
68365     *
68366     * @param float $xResolution The image x resolution.
68367     * @param float $yResolution The image y resolution.
68368     * @return void
68369     * @since PECL gmagick >= Unknown
68370     **/
68371    function setimageresolution($xResolution, $yResolution);
68372
68373    /**
68374     * Sets the image scene.
68375     *
68376     * @param string $scene The image scene number.
68377     * @return void
68378     * @since PECL gmagick >= Unknown
68379     **/
68380    function setimagescene($scene);
68381
68382    /**
68383     * Sets the image type.
68384     *
68385     * @param string $imgType The image type: UndefinedType, BilevelType,
68386     *   GrayscaleType, GrayscaleMatteType, PaletteType, PaletteMatteType,
68387     *   TrueColorType, TrueColorMatteType, ColorSeparationType,
68388     *   ColorSeparationMatteType, or OptimizeType.
68389     * @return void
68390     * @since PECL gmagick >= Unknown
68391     **/
68392    function setimagetype($imgType);
68393
68394    /**
68395     * Sets the image units of resolution.
68396     *
68397     * @param int $resolution The image units of resolution :
68398     *   Undefinedresolution, PixelsPerInchResolution, or
68399     *   PixelsPerCentimeterResolution.
68400     * @return void
68401     * @since PECL gmagick >= Unknown
68402     **/
68403    function setimageunits($resolution);
68404
68405    /**
68406     * Sets the image chromaticity white point.
68407     *
68408     * @param float $x The white x-point.
68409     * @param float $y The white y-point.
68410     * @return void
68411     * @since PECL gmagick >= Unknown
68412     **/
68413    function setimagewhitepoint($x, $y);
68414
68415    /**
68416     * Sets the image sampling factors.
68417     *
68418     * @param array $factors An array of doubles representing the sampling
68419     *   factor for each color component (in RGB order).
68420     * @return void
68421     * @since PECL gmagick >= Unknown
68422     **/
68423    function setsamplingfactors($factors);
68424
68425    /**
68426     * Sets the size of the Gmagick object. Set it before you read a raw
68427     * image format such as RGB, GRAY, or CMYK.
68428     *
68429     * @param int $columns The width in pixels.
68430     * @param int $rows The height in pixels.
68431     * @return void
68432     * @since PECL gmagick >= Unknown
68433     **/
68434    function setsize($columns, $rows);
68435
68436    /**
68437     * Slides one edge of an image along the X or Y axis, creating a
68438     * parallelogram. An X direction shear slides an edge along the X axis,
68439     * while a Y direction shear slides an edge along the Y axis. The amount
68440     * of the shear is controlled by a shear angle. For X direction shears,
68441     * x_shear is measured relative to the Y axis, and similarly, for Y
68442     * direction shears y_shear is measured relative to the X axis. Empty
68443     * triangles left over from shearing the image are filled with the
68444     * background color.
68445     *
68446     * @param mixed $color The background pixel wand.
68447     * @param float $xShear The number of degrees to shear the image.
68448     * @param float $yShear The number of degrees to shear the image.
68449     * @return void
68450     * @since PECL gmagick >= Unknown
68451     **/
68452    function shearimage($color, $xShear, $yShear);
68453
68454    /**
68455     * Applies a special effect to the image, similar to the effect achieved
68456     * in a photo darkroom by selectively exposing areas of photo sensitive
68457     * paper to light. Threshold ranges from 0 to QuantumRange and is a
68458     * measure of the extent of the solarization.
68459     *
68460     * @param float $threshold Define the extent of the solarization.
68461     * @return void
68462     * @since PECL gmagick >= Unknown
68463     **/
68464    function solarizeimage($threshold);
68465
68466    /**
68467     * Special effects method that randomly displaces each pixel in a block
68468     * defined by the radius parameter.
68469     *
68470     * @param float $radius Choose a random pixel in a neighborhood of this
68471     *   extent.
68472     * @return void
68473     * @since PECL gmagick >= Unknown
68474     **/
68475    function spreadimage($radius);
68476
68477    /**
68478     * Strips an image of all profiles and comments.
68479     *
68480     * @return void
68481     * @since PECL gmagick >= Unknown
68482     **/
68483    function stripimage();
68484
68485    /**
68486     * Swirls the pixels about the center of the image, where degrees
68487     * indicates the sweep of the arc through which each pixel is moved. You
68488     * get a more dramatic effect as the degrees move from 1 to 360.
68489     *
68490     * @param float $degrees Define the tightness of the swirling effect.
68491     * @return void
68492     * @since PECL gmagick >= Unknown
68493     **/
68494    function swirlimage($degrees);
68495
68496    /**
68497     * Changes the size of an image to the given dimensions and removes any
68498     * associated profiles. The goal is to produce small low cost thumbnail
68499     * images suited for display on the Web. If TRUE is given as a third
68500     * parameter then columns and rows parameters are used as maximums for
68501     * each side. Both sides will be scaled down until the match or are
68502     * smaller than the parameter given for the side.
68503     *
68504     * @param int $width Image width
68505     * @param int $height Image height
68506     * @return void
68507     * @since PECL gmagick >= Unknown
68508     **/
68509    function thumbnailimage($width, $height);
68510
68511    /**
68512     * Remove edges that are the background color from the image.
68513     *
68514     * @param float $fuzz By default target must match a particular pixel
68515     *   color exactly. However, in many cases two colors may differ by a
68516     *   small amount. The fuzz member of image defines how much tolerance is
68517     *   acceptable to consider two colors as the same. This parameter
68518     *   represents the variation on the quantum range.
68519     * @return void
68520     * @since PECL gmagick >= Unknown
68521     **/
68522    function trimimage($fuzz);
68523
68524    /**
68525     * Writes an image to the specified filename. If the filename parameter
68526     * is NULL, the image is written to the filename set by
68527     * Gmagick::ReadImage() or Gmagick::SetImageFilename().
68528     *
68529     * @param string $filename The image filename.
68530     * @return void
68531     * @since PECL gmagick >= Unknown
68532     **/
68533    function write($filename);
68534
68535    /**
68536     * Writes an image to the specified filename. If the filename parameter
68537     * is NULL, the image is written to the filename set by
68538     * Gmagick::ReadImage() or Gmagick::SetImageFilename().
68539     *
68540     * @param string $filename The image filename.
68541     * @return void
68542     * @since PECL gmagick >= Unknown
68543     **/
68544    function writeimage($filename);
68545
68546    /**
68547     * The Gmagick constructor.
68548     *
68549     * @param string $filename The path to an image to load or array of
68550     *   paths
68551     * @since PECL gmagick >= Unknown
68552     **/
68553    function __construct($filename);
68554
68555}
68556/**
68557 * Description of the class.
68558 **/
68559class GmagickDraw {
68560    /**
68561     * Draws text on the image.
68562     *
68563     * @param float $x x ordinate to left of text
68564     * @param float $y y ordinate to text baseline
68565     * @param string $text text to draw
68566     * @return void
68567     * @since PECL gmagick >= Unknown
68568     **/
68569    function annotate($x, $y, $text){}
68570
68571    /**
68572     * Draws an arc falling within a specified bounding rectangle on the
68573     * image.
68574     *
68575     * @param float $sx starting x ordinate of bounding rectangle
68576     * @param float $sy starting y ordinate of bounding rectangle
68577     * @param float $ex ending x ordinate of bounding rectangle
68578     * @param float $ey ending y ordinate of bounding rectangle
68579     * @param float $sd starting degrees of rotation
68580     * @param float $ed ending degrees of rotation
68581     * @return void
68582     * @since PECL gmagick >= Unknown
68583     **/
68584    function arc($sx, $sy, $ex, $ey, $sd, $ed){}
68585
68586    /**
68587     * Draws a bezier curve through a set of points on the image.
68588     *
68589     * @param array $coordinate_array Coordinates array
68590     * @return void
68591     * @since PECL gmagick >= Unknown
68592     **/
68593    function bezier($coordinate_array){}
68594
68595    /**
68596     * Draws an ellipse on the image.
68597     *
68598     * @param float $ox origin x ordinate
68599     * @param float $oy origin y ordinate
68600     * @param float $rx radius in x
68601     * @param float $ry radius in y
68602     * @param float $start starting rotation in degrees
68603     * @param float $end ending rotation in degrees
68604     * @return void
68605     * @since PECL gmagick >= Unknown
68606     **/
68607    function ellipse($ox, $oy, $rx, $ry, $start, $end){}
68608
68609    /**
68610     * Returns the fill color used for drawing filled objects.
68611     *
68612     * @return void
68613     * @since PECL gmagick >= Unknown
68614     **/
68615    function getfillcolor(){}
68616
68617    /**
68618     * Returns the opacity used when drawing
68619     *
68620     * @return void
68621     * @since PECL gmagick >= Unknown
68622     **/
68623    function getfillopacity(){}
68624
68625    /**
68626     * Returns a string specifying the font used when annotating with text.
68627     *
68628     * @return void
68629     * @since PECL gmagick >= Unknown
68630     **/
68631    function getfont(){}
68632
68633    /**
68634     * Returns the font pointsize used when annotating with text.
68635     *
68636     * @return void
68637     * @since PECL gmagick >= Unknown
68638     **/
68639    function getfontsize(){}
68640
68641    /**
68642     * Returns the font style used when annotating with text.
68643     *
68644     * @return void
68645     * @since PECL gmagick >= Unknown
68646     **/
68647    function getfontstyle(){}
68648
68649    /**
68650     * Returns the font weight used when annotating with text.
68651     *
68652     * @return void
68653     * @since PECL gmagick >= Unknown
68654     **/
68655    function getfontweight(){}
68656
68657    /**
68658     * Returns the color used for stroking object outlines.
68659     *
68660     * @return void
68661     * @since PECL gmagick >= Unknown
68662     **/
68663    function getstrokecolor(){}
68664
68665    /**
68666     * Returns the opacity of stroked object outlines.
68667     *
68668     * @return void
68669     * @since PECL gmagick >= Unknown
68670     **/
68671    function getstrokeopacity(){}
68672
68673    /**
68674     * Returns the width of the stroke used to draw object outlines.
68675     *
68676     * @return void
68677     * @since PECL gmagick >= Unknown
68678     **/
68679    function getstrokewidth(){}
68680
68681    /**
68682     * Returns the decoration applied when annotating with text.
68683     *
68684     * @return void
68685     * @since PECL gmagick >= Unknown
68686     **/
68687    function gettextdecoration(){}
68688
68689    /**
68690     * Returns a string which specifies the code set used for text
68691     * annotations.
68692     *
68693     * @return void
68694     * @since PECL gmagick >= Unknown
68695     **/
68696    function gettextencoding(){}
68697
68698    /**
68699     * Draws a line on the image using the current stroke color, stroke
68700     * opacity, and stroke width.
68701     *
68702     * @param float $sx starting x ordinate
68703     * @param float $sy starting y ordinate
68704     * @param float $ex ending x ordinate
68705     * @param float $ey ending y ordinate
68706     * @return void
68707     * @since PECL gmagick >= Unknown
68708     **/
68709    function line($sx, $sy, $ex, $ey){}
68710
68711    /**
68712     * Draws a point using the current stroke color and stroke thickness at
68713     * the specified coordinates.
68714     *
68715     * @param float $x target x coordinate
68716     * @param float $y target y coordinate
68717     * @return void
68718     * @since PECL gmagick >= Unknown
68719     **/
68720    function point($x, $y){}
68721
68722    /**
68723     * Draws a polygon using the current stroke, stroke width, and fill color
68724     * or texture, using the specified array of coordinates.
68725     *
68726     * @param array $coordinates coordinate array
68727     * @return void
68728     * @since PECL gmagick >= Unknown
68729     **/
68730    function polygon($coordinates){}
68731
68732    /**
68733     * Draws a polyline using the current stroke, stroke width, and fill
68734     * color or texture, using the specified array of coordinates.
68735     *
68736     * @param array $coordinate_array The array of coordinates
68737     * @return void
68738     * @since PECL gmagick >= Unknown
68739     **/
68740    function polyline($coordinate_array){}
68741
68742    /**
68743     * Draws a rectangle given two coordinates and using the current stroke,
68744     * stroke width, and fill settings.
68745     *
68746     * @param float $x1 x ordinate of first coordinate
68747     * @param float $y1 y ordinate of first coordinate
68748     * @param float $x2 x ordinate of second coordinate
68749     * @param float $y2 y ordinate of second coordinate
68750     * @return void
68751     * @since PECL gmagick >= Unknown
68752     **/
68753    function rectangle($x1, $y1, $x2, $y2){}
68754
68755    /**
68756     * Applies the specified rotation to the current coordinate space.
68757     *
68758     * @param float $degrees degrees of rotation
68759     * @return void
68760     * @since PECL gmagick >= Unknown
68761     **/
68762    function rotate($degrees){}
68763
68764    /**
68765     * Draws a rounded rectangle given two coordinates, x and y corner
68766     * radiuses and using the current stroke, stroke width, and fill
68767     * settings.
68768     *
68769     * @param float $x1 x ordinate of first coordinate
68770     * @param float $y1 y ordinate of first coordinate
68771     * @param float $x2 x ordinate of second coordinate
68772     * @param float $y2 y ordinate of second coordinate
68773     * @param float $rx radius of corner in horizontal direction
68774     * @param float $ry radius of corner in vertical direction
68775     * @return void
68776     * @since PECL gmagick >= Unknown
68777     **/
68778    function roundrectangle($x1, $y1, $x2, $y2, $rx, $ry){}
68779
68780    /**
68781     * Adjusts the scaling factor to apply in the horizontal and vertical
68782     * directions to the current coordinate space.
68783     *
68784     * @param float $x horizontal scale factor
68785     * @param float $y vertical scale factor
68786     * @return void
68787     * @since PECL gmagick >= Unknown
68788     **/
68789    function scale($x, $y){}
68790
68791    /**
68792     * Sets the fill color to be used for drawing filled objects.
68793     *
68794     * @param string $color GmagickPixel indicating color to use for
68795     *   filling.
68796     * @return void
68797     * @since PECL gmagick >= Unknown
68798     **/
68799    function setfillcolor($color){}
68800
68801    /**
68802     * Sets the opacity to use when drawing using the fill color or fill
68803     * texture. Setting it to 1.0 will make fill full opaque.
68804     *
68805     * @param float $fill_opacity Fill opacity
68806     * @return void
68807     * @since PECL gmagick >= Unknown
68808     **/
68809    function setfillopacity($fill_opacity){}
68810
68811    /**
68812     * Sets the fully-specified font to use when annotating with text
68813     *
68814     * @param string $font font name
68815     * @return void
68816     * @since PECL gmagick >= Unknown
68817     **/
68818    function setfont($font){}
68819
68820    /**
68821     * Sets the font pointsize to use when annotating with text.
68822     *
68823     * @param float $pointsize Text pointsize
68824     * @return void
68825     * @since PECL gmagick >= Unknown
68826     **/
68827    function setfontsize($pointsize){}
68828
68829    /**
68830     * Sets the font style to use when annotating with text. The AnyStyle
68831     * enumeration acts as a wild-card "don't care" option.
68832     *
68833     * @param string $style Font style (NormalStyle, ItalicStyle,
68834     *   ObliqueStyle, AnyStyle)
68835     * @return void
68836     * @since PECL gmagick >= Unknown
68837     **/
68838    function setfontstyle($style){}
68839
68840    /**
68841     * Sets the font weight to use when annotating with text.
68842     *
68843     * @param int $weight Font weight (valid range 100-900)
68844     * @return void
68845     * @since PECL gmagick >= Unknown
68846     **/
68847    function setfontweight($weight){}
68848
68849    /**
68850     * Sets the color used for stroking object outlines.
68851     *
68852     * @param GmagickPixel $color GmagickPixel representing the color for
68853     *   the stroke.
68854     * @return void
68855     * @since PECL gmagick >= Unknown
68856     **/
68857    function setstrokecolor($color){}
68858
68859    /**
68860     * Specifies the opacity of stroked object outlines.
68861     *
68862     * @param float $stroke_opacity Stroke opacity. The value 1.0 is
68863     *   opaque.
68864     * @return void
68865     * @since PECL gmagick >= Unknown
68866     **/
68867    function setstrokeopacity($stroke_opacity){}
68868
68869    /**
68870     * Sets the width of the stroke used to draw object outlines
68871     *
68872     * @param float $width Stroke width
68873     * @return void
68874     * @since PECL gmagick >= Unknown
68875     **/
68876    function setstrokewidth($width){}
68877
68878    /**
68879     * Specifies a decoration to be applied when annotating with text.
68880     *
68881     * @param int $decoration Text decoration. One of NoDecoration,
68882     *   UnderlineDecoration, OverlineDecoration, or LineThroughDecoration
68883     * @return void
68884     * @since PECL gmagick >= Unknown
68885     **/
68886    function settextdecoration($decoration){}
68887
68888    /**
68889     * Specifies specifies the code set to use for text annotations. The only
68890     * character encoding which may be specified at this time is "UTF-8" for
68891     * representing Unicode as a sequence of bytes. Specify an empty string
68892     * to set text encoding to the system's default. Successful text
68893     * annotation using Unicode may require fonts designed to support
68894     * Unicode.
68895     *
68896     * @param string $encoding Character string specifying text encoding
68897     * @return void
68898     * @since PECL gmagick >= Unknown
68899     **/
68900    function settextencoding($encoding){}
68901
68902}
68903/**
68904 * GmagickException class
68905 **/
68906class GmagickException extends Exception {
68907}
68908/**
68909 * Description of the class.
68910 **/
68911class GmagickPixel {
68912    /**
68913     * Returns the color described by the GmagickPixel object, as an array.
68914     * If the color has an opacity channel set, this is provided as a fourth
68915     * value in the list.
68916     *
68917     * @param bool $as_array True to indicate return of array instead of
68918     *   string
68919     * @param bool $normalize_array Normalize the color values
68920     * @return void
68921     * @since PECL gmagick >= Unknown
68922     **/
68923    function getcolor($as_array, $normalize_array){}
68924
68925    /**
68926     * Returns the color count associated with this color
68927     *
68928     * @param bool $as_array
68929     * @param bool $normalize_array
68930     * @return void
68931     * @since PECL gmagick >= Unknown
68932     **/
68933    function getcolorcount($as_array, $normalize_array){}
68934
68935    /**
68936     * Retrieves the value of the color channel specified, as a
68937     * floating-point number between 0 and 1.
68938     *
68939     * @param int $color The channel to check, specified as one of the
68940     *   Gmagick channel constants.
68941     * @return void
68942     * @since PECL gmagick >= Unknown
68943     **/
68944    function getcolorvalue($color){}
68945
68946    /**
68947     * Sets the color described by the GmagickPixel object, with a string
68948     * (e.g. "blue", "#0000ff", "rgb(0,0,255)", "cmyk(100,100,100,10)",
68949     * etc.).
68950     *
68951     * @param string $color The color definition to use in order to
68952     *   initialise the GmagickPixel object.
68953     * @return void
68954     * @since PECL gmagick >= Unknown
68955     **/
68956    function setcolor($color){}
68957
68958    /**
68959     * Sets the value of the specified channel of this object to the provided
68960     * value, which should be between 0 and 1. This function can be used to
68961     * provide an opacity channel to a GmagickPixel object.
68962     *
68963     * @param int $color One of the Gmagick channel color constants.
68964     * @param float $value The value to set this channel to, ranging from 0
68965     *   to 1.
68966     * @return void
68967     * @since PECL gmagick >= Unknown
68968     **/
68969    function setcolorvalue($color, $value){}
68970
68971    /**
68972     * Constructs an GmagickPixel object. If a color is specified, the object
68973     * is constructed and then initialised with that color before being
68974     * returned.
68975     *
68976     * @param string $color The optional color string to use as the initial
68977     *   value of this object.
68978     * @since PECL gmagick >= Unknown
68979     **/
68980    function __construct($color){}
68981
68982}
68983/**
68984 * Description of the class.
68985 **/
68986class GmagickPixelException extends Exception {
68987}
68988/**
68989 * Haru PDF Annotation Class.
68990 **/
68991class HaruAnnotation {
68992    /**
68993     * Defines the style of the border of the annotation. This function may
68994     * be used with link annotations only.
68995     *
68996     * @param float $width The width of the border line.
68997     * @param int $dash_on The dash style.
68998     * @param int $dash_off The dash style.
68999     * @return bool
69000     * @since PECL haru >= 0.0.1
69001     **/
69002    function setBorderStyle($width, $dash_on, $dash_off){}
69003
69004    /**
69005     * Defines the appearance of the annotation when clicked. This function
69006     * may be used with link annotations only.
69007     *
69008     * @param int $mode The highlighting mode of the annotation. Can take
69009     *   only these values: HaruAnnotation::NO_HIGHLIGHT - no highlighting.
69010     *   HaruAnnotation::INVERT_BOX - invert the contents of the annotation.
69011     *   HaruAnnotation::INVERT_BORDER - invert the border of the annotation.
69012     *   HaruAnnotation::DOWN_APPEARANCE - dent the annotation.
69013     * @return bool
69014     * @since PECL haru >= 0.0.1
69015     **/
69016    function setHighlightMode($mode){}
69017
69018    /**
69019     * Defines the style of the annotation icon. This function may be used
69020     * with text annotations only.
69021     *
69022     * @param int $icon The style of the icon. Can take only these values:
69023     *   HaruAnnotation::ICON_COMMENT HaruAnnotation::ICON_KEY
69024     *   HaruAnnotation::ICON_NOTE HaruAnnotation::ICON_HELP
69025     *   HaruAnnotation::ICON_NEW_PARAGRAPH HaruAnnotation::ICON_PARAGRAPH
69026     *   HaruAnnotation::ICON_INSERT
69027     * @return bool
69028     * @since PECL haru >= 0.0.1
69029     **/
69030    function setIcon($icon){}
69031
69032    /**
69033     * Defines whether the annotation is initially displayed open. This
69034     * function may be used with text annotations only.
69035     *
69036     * @param bool $opened means the annotation is initially displayed
69037     *   open, - means it's closed.
69038     * @return bool
69039     * @since PECL haru >= 0.0.1
69040     **/
69041    function setOpened($opened){}
69042
69043}
69044/**
69045 * Haru PDF Destination Class.
69046 **/
69047class HaruDestination {
69048    /**
69049     * Defines the appearance of the page to fit the window.
69050     *
69051     * @return bool
69052     * @since PECL haru >= 0.0.1
69053     **/
69054    function setFit(){}
69055
69056    /**
69057     * Defines the appearance of the page to fit the bounding box of the page
69058     * within the window.
69059     *
69060     * @return bool
69061     * @since PECL haru >= 0.0.1
69062     **/
69063    function setFitB(){}
69064
69065    /**
69066     * Defines the appearance of the page to magnifying to fit the width of
69067     * the bounding box and setting the top position of the page to the value
69068     * of {@link top}.
69069     *
69070     * @param float $top The top coordinates of the page.
69071     * @return bool
69072     * @since PECL haru >= 0.0.1
69073     **/
69074    function setFitBH($top){}
69075
69076    /**
69077     * Defines the appearance of the page to magnifying to fit the height of
69078     * the bounding box and setting the left position of the page to the
69079     * value of {@link left}.
69080     *
69081     * @param float $left The left coordinates of the page.
69082     * @return bool
69083     * @since PECL haru >= 0.0.1
69084     **/
69085    function setFitBV($left){}
69086
69087    /**
69088     * Defines the appearance of the page to fit the window width and sets
69089     * the top position of the page to the value of {@link top}.
69090     *
69091     * @param float $top The top position of the page.
69092     * @return bool
69093     * @since PECL haru >= 0.0.1
69094     **/
69095    function setFitH($top){}
69096
69097    /**
69098     * Defines the appearance of the page to fit the rectangle by the
69099     * parameters.
69100     *
69101     * @param float $left The left coordinates of the page.
69102     * @param float $bottom The bottom coordinates of the page.
69103     * @param float $right The right coordinates of the page.
69104     * @param float $top The top coordinates of the page.
69105     * @return bool
69106     * @since PECL haru >= 0.0.1
69107     **/
69108    function setFitR($left, $bottom, $right, $top){}
69109
69110    /**
69111     * Defines the appearance of the page to fit the window height.
69112     *
69113     * @param float $left The left position of the page.
69114     * @return bool
69115     * @since PECL haru >= 0.0.1
69116     **/
69117    function setFitV($left){}
69118
69119    /**
69120     * Defines the appearance of the page using three parameters: {@link
69121     * left}, {@link top} and {@link zoom}.
69122     *
69123     * @param float $left The left position of the page.
69124     * @param float $top The top position of the page.
69125     * @param float $zoom The magnification factor. The value must be
69126     *   between 0.08 (8%) and 32 (3200%).
69127     * @return bool
69128     * @since PECL haru >= 0.0.1
69129     **/
69130    function setXYZ($left, $top, $zoom){}
69131
69132}
69133/**
69134 * Haru PDF Document Class.
69135 **/
69136class HaruDoc {
69137    /**
69138     * Adds a new page to the document.
69139     *
69140     * @return object
69141     * @since PECL haru >= 0.0.1
69142     **/
69143    function addPage(){}
69144
69145    /**
69146     * Set the numbering style for the specified range of pages.
69147     *
69148     * @param int $first_page The first page included into the labeling
69149     *   range.
69150     * @param int $style The numbering style. The following values are
69151     *   allowed: HaruPage::NUM_STYLE_DECIMAL - page label is displayed using
69152     *   decimal numerals. HaruPage::NUM_STYLE_UPPER_ROMAN - page label is
69153     *   displayed using uppercase Roman numerals.
69154     *   HaruPage::NUM_STYLE_LOWER_ROMAN - page label is displayed using
69155     *   lowercase Roman numerals. HaruPage::NUM_STYLE_UPPER_LETTER - page
69156     *   label is displayed using uppercase letters (from A to Z).
69157     *   HaruPage::NUM_STYLE_LOWER_LETTERS - page label is displayed using
69158     *   lowercase letters (from a to z).
69159     * @param int $first_num The first page number in this range.
69160     * @param string $prefix The prefix for the page label.
69161     * @return bool
69162     * @since PECL haru >= 0.0.1
69163     **/
69164    function addPageLabel($first_page, $style, $first_num, $prefix){}
69165
69166    /**
69167     * Create a HaruOutline instance.
69168     *
69169     * @param string $title The caption of new outline object.
69170     * @param object $parent_outline A valid HaruOutline instance or .
69171     * @param object $encoder A valid HaruEncoder instance or .
69172     * @return object
69173     * @since PECL haru >= 0.0.1
69174     **/
69175    function createOutline($title, $parent_outline, $encoder){}
69176
69177    /**
69178     * Get the HaruEncoder currently used in the document.
69179     *
69180     * @return object
69181     * @since PECL haru >= 0.0.1
69182     **/
69183    function getCurrentEncoder(){}
69184
69185    /**
69186     * Get current page of the document.
69187     *
69188     * @return object
69189     * @since PECL haru >= 0.0.1
69190     **/
69191    function getCurrentPage(){}
69192
69193    /**
69194     * Get the HaruEncoder instance for the specified encoding.
69195     *
69196     * @param string $encoding The encoding name. See Builtin Encodings for
69197     *   the list of allowed values.
69198     * @return object
69199     * @since PECL haru >= 0.0.1
69200     **/
69201    function getEncoder($encoding){}
69202
69203    /**
69204     * Get a HaruFont instance.
69205     *
69206     * @param string $fontname The name of the font. See Builtin Fonts for
69207     *   the list of builtin fonts. You can also use the name of a font
69208     *   loaded via HaruDoc::loadTTF, HaruDoc::loadTTC and
69209     *   HaruDoc::loadType1.
69210     * @param string $encoding The encoding to use. See Builtin Encodings
69211     *   for the list of supported encodings.
69212     * @return object
69213     * @since PECL haru >= 0.0.1
69214     **/
69215    function getFont($fontname, $encoding){}
69216
69217    /**
69218     * Get the current value of the specified document attribute.
69219     *
69220     * @param int $type The type of the attribute. The following values are
69221     *   available: HaruDoc::INFO_AUTHOR HaruDoc::INFO_CREATOR
69222     *   HaruDoc::INFO_TITLE HaruDoc::INFO_SUBJECT HaruDoc::INFO_KEYWORDS
69223     *   HaruDoc::INFO_CREATION_DATE HaruDoc::INFO_MOD_DATE
69224     * @return string
69225     * @since PECL haru >= 0.0.1
69226     **/
69227    function getInfoAttr($type){}
69228
69229    /**
69230     * Get the current page layout. See HaruDoc::setPageLayout for the list
69231     * of possible values.
69232     *
69233     * @return int
69234     * @since PECL haru >= 0.0.1
69235     **/
69236    function getPageLayout(){}
69237
69238    /**
69239     * Get the current page mode. See HaruDoc::setPageMode for the list of
69240     * possible values.
69241     *
69242     * @return int
69243     * @since PECL haru >= 0.0.1
69244     **/
69245    function getPageMode(){}
69246
69247    /**
69248     * Get the size of the temporary stream.
69249     *
69250     * @return int
69251     * @since PECL haru >= 0.0.1
69252     **/
69253    function getStreamSize(){}
69254
69255    /**
69256     * Creates a new page and inserts just before the specified page.
69257     *
69258     * @param object $page A valid HaruPage instance.
69259     * @return object
69260     * @since PECL haru >= 0.0.1
69261     **/
69262    function insertPage($page){}
69263
69264    /**
69265     * Loads the specified JPEG image.
69266     *
69267     * @param string $filename A valid JPEG image file.
69268     * @return object
69269     * @since PECL haru >= 0.0.1
69270     **/
69271    function loadJPEG($filename){}
69272
69273    /**
69274     * Loads a PNG image.
69275     *
69276     * Libharu might be built without libpng support, in this case each call
69277     * to this function would result in exception.
69278     *
69279     * @param string $filename The name of a PNG image file.
69280     * @param bool $deferred Do not load data immediately. You can set
69281     *   {@link deferred} parameter to for deferred data loading, in this
69282     *   case only size and color are loaded immediately.
69283     * @return object
69284     * @since PECL haru >= 0.0.1
69285     **/
69286    function loadPNG($filename, $deferred){}
69287
69288    /**
69289     * Loads a RAW image.
69290     *
69291     * @param string $filename The name of a RAW image file.
69292     * @param int $width The width of the image.
69293     * @param int $height The height of the image.
69294     * @param int $color_space The color space of the image. Can be one of
69295     *   the following values: HaruDoc::CS_DEVICE_GRAY HaruDoc::CS_DEVICE_RGB
69296     *   HaruDoc::CS_DEVICE_CMYK
69297     * @return object
69298     * @since PECL haru >= 0.0.1
69299     **/
69300    function loadRaw($filename, $width, $height, $color_space){}
69301
69302    /**
69303     * Loads the TrueType font with the specified index from a TrueType
69304     * collection file.
69305     *
69306     * @param string $fontfile The TrueType collection file.
69307     * @param int $index The index of the font in the collection file.
69308     * @param bool $embed When set to , the glyph data of the font is
69309     *   embedded into the PDF file, otherwise only the matrix data is
69310     *   included.
69311     * @return string
69312     * @since PECL haru >= 0.0.1
69313     **/
69314    function loadTTC($fontfile, $index, $embed){}
69315
69316    /**
69317     * Loads the given TTF file and (optionally) embed its data into the
69318     * document.
69319     *
69320     * @param string $fontfile The TTF file to load.
69321     * @param bool $embed When set to , the glyph data of the font is
69322     *   embedded into the PDF file, otherwise only the matrix data is
69323     *   included.
69324     * @return string
69325     * @since PECL haru >= 0.0.1
69326     **/
69327    function loadTTF($fontfile, $embed){}
69328
69329    /**
69330     * Loads Type1 font from the given file and registers it in the PDF
69331     * document.
69332     *
69333     * @param string $afmfile Path to an AFM file.
69334     * @param string $pfmfile Path to a PFA/PFB file, optional. If it's not
69335     *   set only the glyph data of the font is embedded into the PDF
69336     *   document.
69337     * @return string
69338     * @since PECL haru >= 0.0.1
69339     **/
69340    function loadType1($afmfile, $pfmfile){}
69341
69342    /**
69343     * Writes the document data into standard output.
69344     *
69345     * @return bool
69346     * @since PECL haru >= 0.0.1
69347     **/
69348    function output(){}
69349
69350    /**
69351     * Read data from the temporary stream.
69352     *
69353     * @param int $bytes The {@link bytes} parameter specifies how many
69354     *   bytes to read, though the stream may contain less bytes than
69355     *   requested.
69356     * @return string
69357     * @since PECL haru >= 0.0.1
69358     **/
69359    function readFromStream($bytes){}
69360
69361    /**
69362     * Once an error code is set, most of the operations, including I/O
69363     * processing functions cannot be performed. In case if you want to
69364     * continue after the cause of the error has been fixed, you have to
69365     * invoke this function in order to reset the document error state.
69366     *
69367     * @return bool
69368     * @since PECL haru >= 0.0.1
69369     **/
69370    function resetError(){}
69371
69372    /**
69373     * Rewinds the temporary stream of the document.
69374     *
69375     * @return bool
69376     * @since PECL haru >= 0.0.1
69377     **/
69378    function resetStream(){}
69379
69380    /**
69381     * Saves the document into the specified file.
69382     *
69383     * @param string $file The file to save the document to.
69384     * @return bool
69385     * @since PECL haru >= 0.0.1
69386     **/
69387    function save($file){}
69388
69389    /**
69390     * Saves the document data into a temporary stream.
69391     *
69392     * @return bool
69393     * @since PECL haru >= 0.0.1
69394     **/
69395    function saveToStream(){}
69396
69397    /**
69398     * Defines compression mode for the document. In case when libharu was
69399     * compiled without Zlib support this function will always throw
69400     * HaruException.
69401     *
69402     * @param int $mode The compression mode to use. The value is a
69403     *   combination of the following flags: HaruDoc::COMP_NONE - all
69404     *   contents is not compressed. HaruDoc::COMP_TEXT - compress the text
69405     *   data. HaruDoc::COMP_IMAGE - compress the image data.
69406     *   HaruDoc::COMP_METADATA - compress other data (fonts, cmaps).
69407     *   HaruDoc::COMP_ALL - compress all data.
69408     * @return bool
69409     * @since PECL haru >= 0.0.1
69410     **/
69411    function setCompressionMode($mode){}
69412
69413    /**
69414     * Defines the encoder currently used in the document.
69415     *
69416     * @param string $encoding The name of the encoding to use. See Builtin
69417     *   Encodings for the list of allowed values.
69418     * @return bool
69419     * @since PECL haru >= 0.0.1
69420     **/
69421    function setCurrentEncoder($encoding){}
69422
69423    /**
69424     * Defines encryption mode for the document. The encryption mode cannot
69425     * be set before setting the password.
69426     *
69427     * @param int $mode The encryption mode to use. Can be one of the
69428     *   following: HaruDoc::ENCRYPT_R2 - use "revision2" algorithm.
69429     *   HaruDoc::ENCRYPT_R3 - use "revision3" algorithm. Using this value
69430     *   bumps the version of PDF to 1.4.
69431     * @param int $key_len The encryption key length in bytes. This
69432     *   parameter is optional and used only when mode is
69433     *   HaruDoc::ENCRYPT_R3. The default value is 5 (40bit).
69434     * @return bool
69435     * @since PECL haru >= 0.0.1
69436     **/
69437    function setEncryptionMode($mode, $key_len){}
69438
69439    /**
69440     * Defines an info attribute. Uses the current encoding of the document.
69441     *
69442     * @param int $type The type of the attribute. Can be one of the
69443     *   following: HaruDoc::INFO_AUTHOR HaruDoc::INFO_CREATOR
69444     *   HaruDoc::INFO_TITLE HaruDoc::INFO_SUBJECT HaruDoc::INFO_KEYWORDS
69445     * @param string $info The value of the attribute.
69446     * @return bool
69447     * @since PECL haru >= 0.0.1
69448     **/
69449    function setInfoAttr($type, $info){}
69450
69451    /**
69452     * Sets the datetime info attributes of the document.
69453     *
69454     * @param int $type The type of the attribute. Can be one of the
69455     *   following: HaruDoc::INFO_CREATION_DATE HaruDoc::INFO_MOD_DATE
69456     * @param int $year
69457     * @param int $month Between 1 and 12.
69458     * @param int $day Between 1 and 31, 30, 29 or 28 (different for each
69459     *   month).
69460     * @param int $hour Between 0 and 23.
69461     * @param int $min Between 0 and 59.
69462     * @param int $sec Between 0 and 59.
69463     * @param string $ind The timezone relation to UTC, can be "", " ",
69464     *   "+", "-" and "Z".
69465     * @param int $off_hour If {@link ind} is not " " or "", values between
69466     *   0 and 23 are valid. Otherwise, this parameter is ignored.
69467     * @param int $off_min If {@link ind} is not " " or "", values between
69468     *   0 and 59 are valid. Otherwise, this parameter is ignored.
69469     * @return bool
69470     * @since PECL haru >= 0.0.1
69471     **/
69472    function setInfoDateAttr($type, $year, $month, $day, $hour, $min, $sec, $ind, $off_hour, $off_min){}
69473
69474    /**
69475     * Defines which page should be shown when the document is opened.
69476     *
69477     * @param object $destination A valid HaruDestination instance.
69478     * @return bool
69479     * @since PECL haru >= 0.0.1
69480     **/
69481    function setOpenAction($destination){}
69482
69483    /**
69484     * Defines how pages should be displayed.
69485     *
69486     * @param int $layout The following values are accepted:
69487     *   HaruDoc::PAGE_LAYOUT_SINGLE - only one page is displayed.
69488     *   HaruDoc::PAGE_LAYOUT_ONE_COLUMN - display the pages in one column.
69489     *   HaruDoc::PAGE_LAYOUT_TWO_COLUMN_LEFT - display pages in two columns,
69490     *   first page left. HaruDoc::PAGE_LAYOUT_TWO_COLUMN_RIGHT - display
69491     *   pages in two columns, first page right.
69492     * @return bool
69493     * @since PECL haru >= 0.0.1
69494     **/
69495    function setPageLayout($layout){}
69496
69497    /**
69498     * Defines how the document should be displayed.
69499     *
69500     * @param int $mode The following values are accepted:
69501     *   HaruDoc::PAGE_MODE_USE_NONE - display the document with neither
69502     *   outline nor thumbnail. HaruDoc::PAGE_MODE_USE_OUTLINE - display the
69503     *   document with outline pane. HaruDoc::PAGE_MODE_USE_THUMBS - display
69504     *   the document with thumbnail pane. HaruDoc::PAGE_MODE_FULL_SCREEN -
69505     *   display the document with full screen mode.
69506     * @return bool
69507     * @since PECL haru >= 0.0.1
69508     **/
69509    function setPageMode($mode){}
69510
69511    /**
69512     * By default the document has one pages object as a root for all pages.
69513     * All page objects are create as branches of this object. One pages
69514     * object can contain only 8191, therefore the maximum number of pages
69515     * per document is 8191. But you can change that fact by setting {@link
69516     * page_per_pages} parameter, so that the root pages object contains 8191
69517     * more pages (not page) objects, which in turn contain 8191 pages each.
69518     * So the maximum number of pages in the document becomes 8191*{@link
69519     * page_per_pages}.
69520     *
69521     * @param int $page_per_pages The numbers of pages that a pages object
69522     *   can contain.
69523     * @return bool
69524     * @since PECL haru >= 0.0.1
69525     **/
69526    function setPagesConfiguration($page_per_pages){}
69527
69528    /**
69529     * Defines owner and user passwords for the document. Setting the
69530     * passwords makes the document contents encrypted.
69531     *
69532     * @param string $owner_password The password of the owner, which can
69533     *   change permissions of the document. Empty password is not accepted.
69534     *   Owner's password cannot be the same as the user's password.
69535     * @param string $user_password The password of the user. Can be empty.
69536     * @return bool
69537     * @since PECL haru >= 0.0.1
69538     **/
69539    function setPassword($owner_password, $user_password){}
69540
69541    /**
69542     * Defines permissions for the document.
69543     *
69544     * @param int $permission The values is a combination of these flags:
69545     *   HaruDoc::ENABLE_READ - user can read the document.
69546     *   HaruDoc::ENABLE_PRINT - user can print the document.
69547     *   HaruDoc::ENABLE_EDIT_ALL - user can edit the contents of the
69548     *   document other than annotations and form fields.
69549     *   HaruDoc::ENABLE_COPY - user can copy the text and the graphics of
69550     *   the document. HaruDoc::ENABLE_EDIT - user can add or modify the
69551     *   annotations and form fields of the document.
69552     * @return bool
69553     * @since PECL haru >= 0.0.1
69554     **/
69555    function setPermission($permission){}
69556
69557    /**
69558     * Enables Chinese simplified encodings.
69559     *
69560     * @return bool
69561     * @since PECL haru >= 0.0.1
69562     **/
69563    function useCNSEncodings(){}
69564
69565    /**
69566     * Enables builtin Chinese simplified fonts.
69567     *
69568     * @return bool
69569     * @since PECL haru >= 0.0.1
69570     **/
69571    function useCNSFonts(){}
69572
69573    /**
69574     * Enables Chinese traditional encodings.
69575     *
69576     * @return bool
69577     * @since PECL haru >= 0.0.1
69578     **/
69579    function useCNTEncodings(){}
69580
69581    /**
69582     * Enables builtin Chinese traditional fonts.
69583     *
69584     * @return bool
69585     * @since PECL haru >= 0.0.1
69586     **/
69587    function useCNTFonts(){}
69588
69589    /**
69590     * Enables Japanese encodings.
69591     *
69592     * @return bool
69593     * @since PECL haru >= 0.0.1
69594     **/
69595    function useJPEncodings(){}
69596
69597    /**
69598     * Enables builtin Japanese fonts.
69599     *
69600     * @return bool
69601     * @since PECL haru >= 0.0.1
69602     **/
69603    function useJPFonts(){}
69604
69605    /**
69606     * Enables Korean encodings.
69607     *
69608     * @return bool
69609     * @since PECL haru >= 0.0.1
69610     **/
69611    function useKREncodings(){}
69612
69613    /**
69614     * Enables builtin Korean fonts.
69615     *
69616     * @return bool
69617     * @since PECL haru >= 0.0.1
69618     **/
69619    function useKRFonts(){}
69620
69621    /**
69622     * Constructs new HaruDoc instance.
69623     *
69624     * @return void
69625     * @since PECL haru >= 0.0.1
69626     **/
69627    function __construct(){}
69628
69629}
69630/**
69631 * Haru PDF Encoder Class.
69632 **/
69633class HaruEncoder {
69634    /**
69635     * Get the type of the byte in the text.
69636     *
69637     * @param string $text The text.
69638     * @param int $index The position in the text.
69639     * @return int
69640     * @since PECL haru >= 0.0.1
69641     **/
69642    function getByteType($text, $index){}
69643
69644    /**
69645     * Get the type of the encoder.
69646     *
69647     * @return int
69648     * @since PECL haru >= 0.0.1
69649     **/
69650    function getType(){}
69651
69652    /**
69653     * Converts the specified character to unicode.
69654     *
69655     * @param int $character The character code to convert.
69656     * @return int
69657     * @since PECL haru >= 0.0.1
69658     **/
69659    function getUnicode($character){}
69660
69661    /**
69662     * Get the writing mode of the encoder.
69663     *
69664     * @return int
69665     * @since PECL haru >= 0.0.1
69666     **/
69667    function getWritingMode(){}
69668
69669}
69670/**
69671 * Haru PDF Exception Class.
69672 **/
69673class HaruException extends Exception {
69674}
69675/**
69676 * Haru PDF Font Class.
69677 **/
69678class HaruFont {
69679    /**
69680     * Get the vertical ascent of the font.
69681     *
69682     * @return int
69683     * @since PECL haru >= 0.0.1
69684     **/
69685    function getAscent(){}
69686
69687    /**
69688     * Get the distance from the baseline of uppercase letters.
69689     *
69690     * @return int
69691     * @since PECL haru >= 0.0.1
69692     **/
69693    function getCapHeight(){}
69694
69695    /**
69696     * Get the vertical descent of the font.
69697     *
69698     * @return int
69699     * @since PECL haru >= 0.0.1
69700     **/
69701    function getDescent(){}
69702
69703    /**
69704     * Get the name of the font encoding.
69705     *
69706     * @return string
69707     * @since PECL haru >= 0.0.1
69708     **/
69709    function getEncodingName(){}
69710
69711    /**
69712     * Get the name of the font.
69713     *
69714     * @return string
69715     * @since PECL haru >= 0.0.1
69716     **/
69717    function getFontName(){}
69718
69719    /**
69720     * Get the total width of the text, number of characters, number of words
69721     * and number of spaces.
69722     *
69723     * @param string $text The text to measure.
69724     * @return array
69725     * @since PECL haru >= 0.0.1
69726     **/
69727    function getTextWidth($text){}
69728
69729    /**
69730     * Get the width of the character in the font.
69731     *
69732     * @param int $character The code of the character.
69733     * @return int
69734     * @since PECL haru >= 0.0.1
69735     **/
69736    function getUnicodeWidth($character){}
69737
69738    /**
69739     * Gets the distance from the baseline of lowercase letters.
69740     *
69741     * @return int
69742     * @since PECL haru >= 0.0.1
69743     **/
69744    function getXHeight(){}
69745
69746    /**
69747     * Calculate the number of characters which can be included within the
69748     * specified width.
69749     *
69750     * @param string $text The text to fit the width.
69751     * @param float $width The width of the area to put the text to.
69752     * @param float $font_size The size of the font.
69753     * @param float $char_space The character spacing.
69754     * @param float $word_space The word spacing.
69755     * @param bool $word_wrap When this parameter is set to the function
69756     *   "emulates" word wrapping and doesn't include the part of the current
69757     *   word if reached the end of the area.
69758     * @return int
69759     * @since PECL haru >= 0.0.1
69760     **/
69761    function measureText($text, $width, $font_size, $char_space, $word_space, $word_wrap){}
69762
69763}
69764/**
69765 * Haru PDF Image Class.
69766 **/
69767class HaruImage {
69768    /**
69769     * Gets the number of bits used to describe each color component of the
69770     * image.
69771     *
69772     * @return int
69773     * @since PECL haru >= 0.0.1
69774     **/
69775    function getBitsPerComponent(){}
69776
69777    /**
69778     * Get the name of the color space.
69779     *
69780     * @return string
69781     * @since PECL haru >= 0.0.1
69782     **/
69783    function getColorSpace(){}
69784
69785    /**
69786     * Get the height of the image.
69787     *
69788     * @return int
69789     * @since PECL haru >= 0.0.1
69790     **/
69791    function getHeight(){}
69792
69793    /**
69794     * Get the size of the image.
69795     *
69796     * @return array
69797     * @since PECL haru >= 0.0.1
69798     **/
69799    function getSize(){}
69800
69801    /**
69802     * Get the width of the image.
69803     *
69804     * @return int
69805     * @since PECL haru >= 0.0.1
69806     **/
69807    function getWidth(){}
69808
69809    /**
69810     * Defines the transparent color of the image using the RGB range values.
69811     * The color within the range is displayed as a transparent color. The
69812     * color space of the image must be RGB.
69813     *
69814     * @param int $rmin The lower limit of red. Must be between 0 and 255.
69815     * @param int $rmax The upper limit of red. Must be between 0 and 255.
69816     * @param int $gmin The lower limit of green. Must be between 0 and
69817     *   255.
69818     * @param int $gmax The upper limit of green. Must be between 0 and
69819     *   255.
69820     * @param int $bmin The lower limit of blue. Must be between 0 and 255.
69821     * @param int $bmax The upper limit of blue. Must be between 0 and 255.
69822     * @return bool
69823     * @since PECL haru >= 0.0.1
69824     **/
69825    function setColorMask($rmin, $rmax, $gmin, $gmax, $bmin, $bmax){}
69826
69827    /**
69828     * Sets the image used as image-mask. It must be 1bit gray-scale color
69829     * image.
69830     *
69831     * @param object $mask_image A valid HaruImage instance.
69832     * @return bool
69833     * @since PECL haru >= 0.0.1
69834     **/
69835    function setMaskImage($mask_image){}
69836
69837}
69838/**
69839 * Haru PDF Outline Class.
69840 **/
69841class HaruOutline {
69842    /**
69843     * Sets a destination object which becomes a target to jump to when the
69844     * outline is clicked.
69845     *
69846     * @param object $destination A valid HaruDestination instance.
69847     * @return bool
69848     * @since PECL haru >= 0.0.1
69849     **/
69850    function setDestination($destination){}
69851
69852    /**
69853     * Defines whether this node is opened or not when the outline is
69854     * displayed for the first time.
69855     *
69856     * @param bool $opened means open, - closed.
69857     * @return bool
69858     * @since PECL haru >= 0.0.1
69859     **/
69860    function setOpened($opened){}
69861
69862}
69863/**
69864 * Haru PDF Page Class.
69865 **/
69866class HaruPage {
69867    /**
69868     * Appends an arc to the current path.
69869     *
69870     * @param float $x Horizontal coordinate of the center.
69871     * @param float $y Vertical coordinate of the center.
69872     * @param float $ray The ray of the arc.
69873     * @param float $ang1 The angle of the beginning.
69874     * @param float $ang2 The angle of the end. Must be greater than {@link
69875     *   ang1}.
69876     * @return bool
69877     * @since PECL haru >= 0.0.1
69878     **/
69879    function arc($x, $y, $ray, $ang1, $ang2){}
69880
69881    /**
69882     * Begins new text object and sets the current text position to (0,0).
69883     *
69884     * @return bool
69885     * @since PECL haru >= 0.0.1
69886     **/
69887    function beginText(){}
69888
69889    /**
69890     * Appends a circle to the current path.
69891     *
69892     * @param float $x Horizontal coordinate of the center point.
69893     * @param float $y Vertical coordinate of the center point.
69894     * @param float $ray The ray of the circle.
69895     * @return bool
69896     * @since PECL haru >= 0.0.1
69897     **/
69898    function circle($x, $y, $ray){}
69899
69900    /**
69901     * Appends a straight line from the current point to the start point of
69902     * the path.
69903     *
69904     * @return bool
69905     * @since PECL haru >= 0.0.1
69906     **/
69907    function closePath(){}
69908
69909    /**
69910     * Concatenates current transformation matrix of the page and the
69911     * specified matrix.
69912     *
69913     * @param float $a
69914     * @param float $b
69915     * @param float $c
69916     * @param float $d
69917     * @param float $x
69918     * @param float $y
69919     * @return bool
69920     * @since PECL haru >= 0.0.1
69921     **/
69922    function concat($a, $b, $c, $d, $x, $y){}
69923
69924    /**
69925     * Create a new HaruDestination instance.
69926     *
69927     * @return object
69928     * @since PECL haru >= 0.0.1
69929     **/
69930    function createDestination(){}
69931
69932    /**
69933     * Creates a new HaruAnnotation instance.
69934     *
69935     * @param array $rectangle An array with 4 coordinates of the clickable
69936     *   area.
69937     * @param object $destination Valid HaruDestination instance.
69938     * @return object
69939     * @since PECL haru >= 0.0.1
69940     **/
69941    function createLinkAnnotation($rectangle, $destination){}
69942
69943    /**
69944     * Creates a new HaruAnnotation instance.
69945     *
69946     * @param array $rectangle An array with 4 coordinates of the
69947     *   annotation area.
69948     * @param string $text The text to be displayed.
69949     * @param object $encoder Optional HaruEncoder instance.
69950     * @return object
69951     * @since PECL haru >= 0.0.1
69952     **/
69953    function createTextAnnotation($rectangle, $text, $encoder){}
69954
69955    /**
69956     * Creates a new HaruAnnotation instance.
69957     *
69958     * @param array $rectangle An array with 4 coordinates of the clickable
69959     *   area.
69960     * @param string $url The URL to open.
69961     * @return object
69962     * @since PECL haru >= 0.0.1
69963     **/
69964    function createURLAnnotation($rectangle, $url){}
69965
69966    /**
69967     * Append a Bezier curve to the current path. The point (x1, y1) and the
69968     * point (x2, y2) are used as the control points for a Bezier curve and
69969     * current point is moved to the point (x3, y3).
69970     *
69971     * @param float $x1 A Bezier curve control point.
69972     * @param float $y1 A Bezier curve control point.
69973     * @param float $x2 A Bezier curve control point.
69974     * @param float $y2 A Bezier curve control point.
69975     * @param float $x3 The current point moves here.
69976     * @param float $y3 The current point moves here.
69977     * @return bool
69978     * @since PECL haru >= 0.0.1
69979     **/
69980    function curveTo($x1, $y1, $x2, $y2, $x3, $y3){}
69981
69982    /**
69983     * Appends a Bezier curve to the current path. The current point and the
69984     * point (x2, y2) are used as the control points for the Bezier curve and
69985     * current point is moved to the point (x3, y3).
69986     *
69987     * @param float $x2 A Bezier curve control point.
69988     * @param float $y2 A Bezier curve control point.
69989     * @param float $x3 The current point moves here.
69990     * @param float $y3 The current point moves here.
69991     * @return bool
69992     * @since PECL haru >= 0.0.1
69993     **/
69994    function curveTo2($x2, $y2, $x3, $y3){}
69995
69996    /**
69997     * Appends a Bezier curve to the current path. The point (x1, y1) and the
69998     * point (x3, y3) are used as the control points for a Bezier curve and
69999     * current point is moved to the point (x3, y3).
70000     *
70001     * @param float $x1 A Bezier curve control point.
70002     * @param float $y1 A Bezier curve control point.
70003     * @param float $x3 The current point moves here.
70004     * @param float $y3 The current point moves here.
70005     * @return bool
70006     * @since PECL haru >= 0.0.1
70007     **/
70008    function curveTo3($x1, $y1, $x3, $y3){}
70009
70010    /**
70011     * Show image at the page.
70012     *
70013     * @param object $image Valid HaruImage instance.
70014     * @param float $x The left border of the area where the image is
70015     *   displayed.
70016     * @param float $y The lower border of the area where the image is
70017     *   displayed.
70018     * @param float $width The width of the image area.
70019     * @param float $height The height of the image area.
70020     * @return bool
70021     * @since PECL haru >= 0.0.1
70022     **/
70023    function drawImage($image, $x, $y, $width, $height){}
70024
70025    /**
70026     * Appends an ellipse to the current path.
70027     *
70028     * @param float $x Horizontal coordinate of the center.
70029     * @param float $y Vertical coordinate of the center.
70030     * @param float $xray The ray of the ellipse in the x direction.
70031     * @param float $yray The ray of the ellipse in the y direction.
70032     * @return bool
70033     * @since PECL haru >= 0.0.1
70034     **/
70035    function ellipse($x, $y, $xray, $yray){}
70036
70037    /**
70038     * Ends current path object without performing filling and painting
70039     * operations.
70040     *
70041     * @return bool
70042     * @since PECL haru >= 0.0.1
70043     **/
70044    function endPath(){}
70045
70046    /**
70047     * Finalizes current text object.
70048     *
70049     * @return bool
70050     * @since PECL haru >= 0.0.1
70051     **/
70052    function endText(){}
70053
70054    /**
70055     * Fills current path using even-odd rule.
70056     *
70057     * @return bool
70058     * @since PECL haru >= 0.0.1
70059     **/
70060    function eofill(){}
70061
70062    /**
70063     * Fills current path using even-odd rule, then paints the path.
70064     *
70065     * @param bool $close_path Optional parameter. When set to , the
70066     *   function closes the current path. Default to .
70067     * @return bool
70068     * @since PECL haru >= 0.0.1
70069     **/
70070    function eoFillStroke($close_path){}
70071
70072    /**
70073     * Fills current path using nonzero winding number rule.
70074     *
70075     * @return bool
70076     * @since PECL haru >= 0.0.1
70077     **/
70078    function fill(){}
70079
70080    /**
70081     * Fills current path using nonzero winding number rule, then paints the
70082     * path.
70083     *
70084     * @param bool $close_path Optional parameter. When set to , the
70085     *   function closes the current path. Default to .
70086     * @return bool
70087     * @since PECL haru >= 0.0.1
70088     **/
70089    function fillStroke($close_path){}
70090
70091    /**
70092     * Get the current value of character spacing.
70093     *
70094     * @return float
70095     * @since PECL haru >= 0.0.1
70096     **/
70097    function getCharSpace(){}
70098
70099    /**
70100     * Returns the current filling color.
70101     *
70102     * @return array
70103     * @since PECL haru >= 0.0.1
70104     **/
70105    function getCMYKFill(){}
70106
70107    /**
70108     * Get the current stroking color.
70109     *
70110     * @return array
70111     * @since PECL haru >= 0.0.1
70112     **/
70113    function getCMYKStroke(){}
70114
70115    /**
70116     * Get the currently used font.
70117     *
70118     * @return object
70119     * @since PECL haru >= 0.0.1
70120     **/
70121    function getCurrentFont(){}
70122
70123    /**
70124     * Get the current font size.
70125     *
70126     * @return float
70127     * @since PECL haru >= 0.0.1
70128     **/
70129    function getCurrentFontSize(){}
70130
70131    /**
70132     * Get the current position for path painting.
70133     *
70134     * @return array
70135     * @since PECL haru >= 0.0.1
70136     **/
70137    function getCurrentPos(){}
70138
70139    /**
70140     * Get the current position for text printing.
70141     *
70142     * @return array
70143     * @since PECL haru >= 0.0.1
70144     **/
70145    function getCurrentTextPos(){}
70146
70147    /**
70148     * Get the current dash pattern. See HaruPage::setDash for more
70149     * information on dash patterns.
70150     *
70151     * @return array
70152     * @since PECL haru >= 0.0.1
70153     **/
70154    function getDash(){}
70155
70156    /**
70157     * Get the current filling color space.
70158     *
70159     * @return int
70160     * @since PECL haru >= 0.0.1
70161     **/
70162    function getFillingColorSpace(){}
70163
70164    /**
70165     * Get the flatness of the page.
70166     *
70167     * @return float
70168     * @since PECL haru >= 0.0.1
70169     **/
70170    function getFlatness(){}
70171
70172    /**
70173     * Get the current graphics mode.
70174     *
70175     * @return int
70176     * @since PECL haru >= 0.0.1
70177     **/
70178    function getGMode(){}
70179
70180    /**
70181     * Get the current filling color.
70182     *
70183     * @return float
70184     * @since PECL haru >= 0.0.1
70185     **/
70186    function getGrayFill(){}
70187
70188    /**
70189     * Get the current stroking color.
70190     *
70191     * @return float
70192     * @since PECL haru >= 0.0.1
70193     **/
70194    function getGrayStroke(){}
70195
70196    /**
70197     * Get the height of the page.
70198     *
70199     * @return float
70200     * @since PECL haru >= 0.0.1
70201     **/
70202    function getHeight(){}
70203
70204    /**
70205     * Get the current value of the horizontal scaling.
70206     *
70207     * @return float
70208     * @since PECL haru >= 0.0.1
70209     **/
70210    function getHorizontalScaling(){}
70211
70212    /**
70213     * Get the current line cap style.
70214     *
70215     * @return int
70216     * @since PECL haru >= 0.0.1
70217     **/
70218    function getLineCap(){}
70219
70220    /**
70221     * Get the current line join style.
70222     *
70223     * @return int
70224     * @since PECL haru >= 0.0.1
70225     **/
70226    function getLineJoin(){}
70227
70228    /**
70229     * Get the current line width.
70230     *
70231     * @return float
70232     * @since PECL haru >= 0.0.1
70233     **/
70234    function getLineWidth(){}
70235
70236    /**
70237     * Get the value of the miter limit.
70238     *
70239     * @return float
70240     * @since PECL haru >= 0.0.1
70241     **/
70242    function getMiterLimit(){}
70243
70244    /**
70245     * Get the current filling color.
70246     *
70247     * @return array
70248     * @since PECL haru >= 0.0.1
70249     **/
70250    function getRGBFill(){}
70251
70252    /**
70253     * Get the current stroking color.
70254     *
70255     * @return array
70256     * @since PECL haru >= 0.0.1
70257     **/
70258    function getRGBStroke(){}
70259
70260    /**
70261     * Get the current stroking color space.
70262     *
70263     * @return int
70264     * @since PECL haru >= 0.0.1
70265     **/
70266    function getStrokingColorSpace(){}
70267
70268    /**
70269     * Get the current value of line spacing.
70270     *
70271     * @return float
70272     * @since PECL haru >= 0.0.1
70273     **/
70274    function getTextLeading(){}
70275
70276    /**
70277     * Get the current text transformation matrix of the page.
70278     *
70279     * @return array
70280     * @since PECL haru >= 0.0.1
70281     **/
70282    function getTextMatrix(){}
70283
70284    /**
70285     * Get the current text rendering mode.
70286     *
70287     * @return int
70288     * @since PECL haru >= 0.0.1
70289     **/
70290    function getTextRenderingMode(){}
70291
70292    /**
70293     * Get the current value of text rising.
70294     *
70295     * @return float
70296     * @since PECL haru >= 0.0.1
70297     **/
70298    function getTextRise(){}
70299
70300    /**
70301     * Get the width of the text using current fontsize, character spacing
70302     * and word spacing
70303     *
70304     * @param string $text The text to measure.
70305     * @return float
70306     * @since PECL haru >= 0.0.1
70307     **/
70308    function getTextWidth($text){}
70309
70310    /**
70311     * Get the current transformation matrix of the page.
70312     *
70313     * @return array
70314     * @since PECL haru >= 0.0.1
70315     **/
70316    function getTransMatrix(){}
70317
70318    /**
70319     * Get the width of the page.
70320     *
70321     * @return float
70322     * @since PECL haru >= 0.0.1
70323     **/
70324    function getWidth(){}
70325
70326    /**
70327     * Get the current value of word spacing.
70328     *
70329     * @return float
70330     * @since PECL haru >= 0.0.1
70331     **/
70332    function getWordSpace(){}
70333
70334    /**
70335     * Draws a line from the current point to the specified point.
70336     *
70337     * @param float $x
70338     * @param float $y
70339     * @return bool
70340     * @since PECL haru >= 0.0.1
70341     **/
70342    function lineTo($x, $y){}
70343
70344    /**
70345     * Get the number of characters which can be included within the
70346     * specified width.
70347     *
70348     * @param string $text The text to measure.
70349     * @param float $width The width of the area to put the text to.
70350     * @param bool $wordwrap When this parameter is set to the function
70351     *   "emulates" word wrapping and doesn't include the part of the current
70352     *   word if reached the end of the area.
70353     * @return int
70354     * @since PECL haru >= 0.0.1
70355     **/
70356    function measureText($text, $width, $wordwrap){}
70357
70358    /**
70359     * Moves text position to the specified offset. If the start position of
70360     * the current line is (x1, y1), the start of the next line is (x1 +
70361     * {@link x}, y1 + {@link y}).
70362     *
70363     * @param float $x The specified text position offset.
70364     * @param float $y The specified text position offset.
70365     * @param bool $set_leading If set to , the function sets the text
70366     *   leading to -{@link y}.
70367     * @return bool
70368     * @since PECL haru >= 0.0.1
70369     **/
70370    function moveTextPos($x, $y, $set_leading){}
70371
70372    /**
70373     * Defines starting point for new drawing path.
70374     *
70375     * @param float $x A new starting point coordinate.
70376     * @param float $y A new starting point coordinate.
70377     * @return bool
70378     * @since PECL haru >= 0.0.1
70379     **/
70380    function moveTo($x, $y){}
70381
70382    /**
70383     * Moves text position to the start of the next line.
70384     *
70385     * @return bool
70386     * @since PECL haru >= 0.0.1
70387     **/
70388    function moveToNextLine(){}
70389
70390    /**
70391     * Appends a rectangle to the current drawing path.
70392     *
70393     * @param float $x The left border of the rectangle.
70394     * @param float $y The lower border of the rectangle.
70395     * @param float $width The width of the rectangle.
70396     * @param float $height The height of the rectangle.
70397     * @return bool
70398     * @since PECL haru >= 0.0.1
70399     **/
70400    function rectangle($x, $y, $width, $height){}
70401
70402    /**
70403     * Defines character spacing for the page.
70404     *
70405     * @param float $char_space The new character spacing for the page.
70406     * @return bool
70407     * @since PECL haru >= 0.0.1
70408     **/
70409    function setCharSpace($char_space){}
70410
70411    /**
70412     * Defines filling color for the page.
70413     *
70414     * @param float $c
70415     * @param float $m
70416     * @param float $y
70417     * @param float $k
70418     * @return bool
70419     * @since PECL haru >= 0.0.1
70420     **/
70421    function setCMYKFill($c, $m, $y, $k){}
70422
70423    /**
70424     * Defines stroking color for the page.
70425     *
70426     * @param float $c
70427     * @param float $m
70428     * @param float $y
70429     * @param float $k
70430     * @return bool
70431     * @since PECL haru >= 0.0.1
70432     **/
70433    function setCMYKStroke($c, $m, $y, $k){}
70434
70435    /**
70436     * Defines the dash pattern for the page.
70437     *
70438     * @param array $pattern An array (8 elements max) which contains a
70439     *   pattern of dashes and gaps used for lines on the page.
70440     * @param int $phase The phase on which the pattern begins.
70441     * @return bool
70442     * @since PECL haru >= 0.0.1
70443     **/
70444    function setDash($pattern, $phase){}
70445
70446    /**
70447     * Defines flatness for the page.
70448     *
70449     * @param float $flatness The defined flatness for the page.
70450     * @return bool
70451     * @since PECL haru >= 0.0.1
70452     **/
70453    function setFlatness($flatness){}
70454
70455    /**
70456     * Defines current font and its size for the page.
70457     *
70458     * @param object $font A valid HaruFont instance.
70459     * @param float $size The size of the font.
70460     * @return bool
70461     * @since PECL haru >= 0.0.1
70462     **/
70463    function setFontAndSize($font, $size){}
70464
70465    /**
70466     * Defines filling color for the page.
70467     *
70468     * @param float $value The value of gray level between 0 and 1.
70469     * @return bool
70470     * @since PECL haru >= 0.0.1
70471     **/
70472    function setGrayFill($value){}
70473
70474    /**
70475     * Defines stroking color for the page.
70476     *
70477     * @param float $value The value of gray level between 0 and 1.
70478     * @return bool
70479     * @since PECL haru >= 0.0.1
70480     **/
70481    function setGrayStroke($value){}
70482
70483    /**
70484     * Defines height of the page.
70485     *
70486     * @param float $height The defined height for the page.
70487     * @return bool
70488     * @since PECL haru >= 0.0.1
70489     **/
70490    function setHeight($height){}
70491
70492    /**
70493     * Set the horizontal scaling for the page.
70494     *
70495     * @param float $scaling The horizontal scaling for text showing on the
70496     *   page. The initial value is 100.
70497     * @return bool
70498     * @since PECL haru >= 0.0.1
70499     **/
70500    function setHorizontalScaling($scaling){}
70501
70502    /**
70503     * Defines the shape to be used at the ends of lines.
70504     *
70505     * @param int $cap Must be one of the following values:
70506     *   HaruPage::BUTT_END - the line is squared off at the endpoint of the
70507     *   path. HaruPage::ROUND_END - the end of the line becomes a semicircle
70508     *   with center in the end point of the path.
70509     *   HaruPage::PROJECTING_SCUARE_END - the line continues to the point
70510     *   that exceeds half of the stroke width the end point.
70511     * @return bool
70512     * @since PECL haru >= 0.0.1
70513     **/
70514    function setLineCap($cap){}
70515
70516    /**
70517     * Defines line join style for the page.
70518     *
70519     * @param int $join Must be one of the following values:
70520     *   HaruPage::MITER_JOIN HaruPage::ROUND_JOIN HaruPage::BEVEL_JOIN
70521     * @return bool
70522     * @since PECL haru >= 0.0.1
70523     **/
70524    function setLineJoin($join){}
70525
70526    /**
70527     * Defines line width for the page.
70528     *
70529     * @param float $width The defined line width for the page.
70530     * @return bool
70531     * @since PECL haru >= 0.0.1
70532     **/
70533    function setLineWidth($width){}
70534
70535    /**
70536     * Set the current value of the miter limit of the page.
70537     *
70538     * @param float $limit Defines the current value of the miter limit of
70539     *   the page.
70540     * @return bool
70541     * @since PECL haru >= 0.0.1
70542     **/
70543    function setMiterLimit($limit){}
70544
70545    /**
70546     * Defines filling color for the page. All values must be between 0 and
70547     * 1.
70548     *
70549     * @param float $r
70550     * @param float $g
70551     * @param float $b
70552     * @return bool
70553     * @since PECL haru >= 0.0.1
70554     **/
70555    function setRGBFill($r, $g, $b){}
70556
70557    /**
70558     * Defines stroking color for the page. All values must be between 0 and
70559     * 1.
70560     *
70561     * @param float $r
70562     * @param float $g
70563     * @param float $b
70564     * @return bool
70565     * @since PECL haru >= 0.0.1
70566     **/
70567    function setRGBStroke($r, $g, $b){}
70568
70569    /**
70570     * Defines rotation angle of the page.
70571     *
70572     * @param int $angle Must be a multiple of 90 degrees.
70573     * @return bool
70574     * @since PECL haru >= 0.0.1
70575     **/
70576    function setRotate($angle){}
70577
70578    /**
70579     * Changes size and direction of the page to a predefined format.
70580     *
70581     * @param int $size Must be one of the following values:
70582     *   HaruPage::SIZE_LETTER HaruPage::SIZE_LEGAL HaruPage::SIZE_A3
70583     *   HaruPage::SIZE_A4 HaruPage::SIZE_A5 HaruPage::SIZE_B4
70584     *   HaruPage::SIZE_B5 HaruPage::SIZE_EXECUTIVE HaruPage::SIZE_US4x6
70585     *   HaruPage::SIZE_US4x8 HaruPage::SIZE_US5x7 HaruPage::SIZE_COMM10
70586     * @param int $direction Must be one of the following values:
70587     *   HaruPage::PORTRAIT HaruPage::LANDSCAPE
70588     * @return bool
70589     * @since PECL haru >= 0.0.1
70590     **/
70591    function setSize($size, $direction){}
70592
70593    /**
70594     * Defines transition style for the page.
70595     *
70596     * @param int $type Must be one of the following values:
70597     *   HaruPage::TS_WIPE_RIGHT HaruPage::TS_WIPE_LEFT HaruPage::TS_WIPE_UP
70598     *   HaruPage::TS_WIPE_DOWN HaruPage::TS_BARN_DOORS_HORIZONTAL_OUT
70599     *   HaruPage::TS_BARN_DOORS_HORIZONTAL_IN
70600     *   HaruPage::TS_BARN_DOORS_VERTICAL_OUT
70601     *   HaruPage::TS_BARN_DOORS_VERTICAL_IN HaruPage::TS_BOX_OUT
70602     *   HaruPage::TS_BOX_IN HaruPage::TS_BLINDS_HORIZONTAL
70603     *   HaruPage::TS_BLINDS_VERTICAL HaruPage::TS_DISSOLVE
70604     *   HaruPage::TS_GLITTER_RIGHT HaruPage::TS_GLITTER_DOWN
70605     *   HaruPage::TS_GLITTER_TOP_LEFT_TO_BOTTOM_RIGHT HaruPage::TS_REPLACE
70606     * @param float $disp_time The display duration of the page in seconds.
70607     * @param float $trans_time The duration of the transition effect in
70608     *   seconds.
70609     * @return bool
70610     * @since PECL haru >= 0.0.1
70611     **/
70612    function setSlideShow($type, $disp_time, $trans_time){}
70613
70614    /**
70615     * Set the text leading (line spacing) for the page.
70616     *
70617     * @param float $text_leading Defines line spacing for the page.
70618     * @return bool
70619     * @since PECL haru >= 0.0.1
70620     **/
70621    function setTextLeading($text_leading){}
70622
70623    /**
70624     * Defines the text transformation matrix of the page.
70625     *
70626     * @param float $a Width multiplier.
70627     * @param float $b Vertical skew in radians.
70628     * @param float $c Horizontal skew in radians.
70629     * @param float $d Height multiplier.
70630     * @param float $x Horizontal position for text.
70631     * @param float $y Vertical position for text.
70632     * @return bool
70633     * @since PECL haru >= 0.0.1
70634     **/
70635    function setTextMatrix($a, $b, $c, $d, $x, $y){}
70636
70637    /**
70638     * Defines text rendering mode for the page.
70639     *
70640     * @param int $mode Must be one of the following values: HaruPage::FILL
70641     *   HaruPage::STROKE HaruPage::FILL_THEN_STROKE HaruPage::INVISIBLE
70642     *   HaruPage::FILL_CLIPPING HaruPage::STROKE_CLIPPING
70643     *   HaruPage::FILL_STROKE_CLIPPING HaruPage::CLIPPING
70644     * @return bool
70645     * @since PECL haru >= 0.0.1
70646     **/
70647    function setTextRenderingMode($mode){}
70648
70649    /**
70650     * Set the current value of text rising.
70651     *
70652     * @param float $rise Defines the current value of text rising.
70653     * @return bool
70654     * @since PECL haru >= 0.0.1
70655     **/
70656    function setTextRise($rise){}
70657
70658    /**
70659     * Set the width of the page.
70660     *
70661     * @param float $width Defines width of the page.
70662     * @return bool
70663     * @since PECL haru >= 0.0.1
70664     **/
70665    function setWidth($width){}
70666
70667    /**
70668     * Set the word spacing for the page.
70669     *
70670     * @param float $word_space Defines word spacing for the page.
70671     * @return bool
70672     * @since PECL haru >= 0.0.1
70673     **/
70674    function setWordSpace($word_space){}
70675
70676    /**
70677     * Prints out the text at the current position of the page.
70678     *
70679     * @param string $text The text to show.
70680     * @return bool
70681     * @since PECL haru >= 0.0.1
70682     **/
70683    function showText($text){}
70684
70685    /**
70686     * Moves the current position to the start of the next line and print out
70687     * the text.
70688     *
70689     * @param string $text The text to show.
70690     * @param float $word_space The word spacing.
70691     * @param float $char_space The character spacing.
70692     * @return bool
70693     * @since PECL haru >= 0.0.1
70694     **/
70695    function showTextNextLine($text, $word_space, $char_space){}
70696
70697    /**
70698     * Paints the current path.
70699     *
70700     * @param bool $close_path Closes the current path if set to .
70701     * @return bool
70702     * @since PECL haru >= 0.0.1
70703     **/
70704    function stroke($close_path){}
70705
70706    /**
70707     * Prints the text on the specified position.
70708     *
70709     * @param float $x
70710     * @param float $y
70711     * @param string $text
70712     * @return bool
70713     * @since PECL haru >= 0.0.1
70714     **/
70715    function textOut($x, $y, $text){}
70716
70717    /**
70718     * Prints the text inside the specified region.
70719     *
70720     * @param float $left Left border of the text area.
70721     * @param float $top Top border of the text area.
70722     * @param float $right Right border of the text area.
70723     * @param float $bottom Lower border of the text area.
70724     * @param string $text The text to print.
70725     * @param int $align Text alignment. Must be one of the following
70726     *   values: HaruPage::TALIGN_LEFT HaruPage::TALIGN_RIGHT
70727     *   HaruPage::TALIGN_CENTER HaruPage::TALIGN_JUSTIFY
70728     * @return bool
70729     * @since PECL haru >= 0.0.1
70730     **/
70731    function textRect($left, $top, $right, $bottom, $text, $align){}
70732
70733}
70734class HttpDeflateStream {
70735    /**
70736     * Creates a new HttpDeflateStream object instance.
70737     *
70738     * See the deflate stream constants table for possible {@link flags}.
70739     *
70740     * @param int $flags initialization flags
70741     * @param string $class_name name of a subclass of HttpDeflateStream
70742     * @return HttpDeflateStream
70743     * @since PECL pecl_http >= 1.4.0
70744     **/
70745    function factory($flags, $class_name){}
70746
70747    /**
70748     * Finalizes the deflate stream. The deflate stream can be reused after
70749     * finalizing.
70750     *
70751     * @param string $data data to deflate
70752     * @return string
70753     * @since PECL pecl_http >= 0.21.0
70754     **/
70755    function finish($data){}
70756
70757    /**
70758     * Flushes the deflate stream.
70759     *
70760     * @param string $data more data to deflate
70761     * @return string
70762     * @since PECL pecl_http >= 0.21.0
70763     **/
70764    function flush($data){}
70765
70766    /**
70767     * Passes more data through the deflate stream.
70768     *
70769     * @param string $data data to deflate
70770     * @return string
70771     * @since PECL pecl_http >= 0.21.0
70772     **/
70773    function update($data){}
70774
70775    /**
70776     * Creates a new HttpDeflateStream object instance.
70777     *
70778     * See the deflate stream constants table for possible {@link flags}.
70779     *
70780     * @param int $flags initialization flags
70781     * @return void
70782     * @since PECL pecl_http >= 0.21.0
70783     **/
70784    function __construct($flags){}
70785
70786}
70787class HttpInflateStream {
70788    /**
70789     * Creates a new HttpInflateStream object instance.
70790     *
70791     * See the inflate constants table for possible {@link flags}.
70792     *
70793     * @param int $flags initialization flags
70794     * @param string $class_name name of a subclass of HttpInflateStream
70795     * @return HttpInflateStream
70796     * @since PECL pecl_http >= 1.4.0
70797     **/
70798    function factory($flags, $class_name){}
70799
70800    /**
70801     * Finalizes the inflate stream. The inflate stream can be reused after
70802     * finalizing.
70803     *
70804     * @param string $data data to inflate
70805     * @return string
70806     * @since PECL pecl_http >= 0.21.0
70807     **/
70808    function finish($data){}
70809
70810    /**
70811     * Flushes the inflate stream.
70812     *
70813     * @param string $data more data to inflate
70814     * @return string
70815     * @since PECL pecl_http >= 0.21.0
70816     **/
70817    function flush($data){}
70818
70819    /**
70820     * Passes more data through the inflate stream.
70821     *
70822     * @param string $data data to inflate
70823     * @return string
70824     * @since PECL pecl_http >= 0.21.0
70825     **/
70826    function update($data){}
70827
70828    /**
70829     * Creates a new HttpInflateStream object instance.
70830     *
70831     * See the inflate constants table for possible {@link flags}.
70832     *
70833     * @param int $flags initialization flags
70834     * @return void
70835     * @since PECL pecl_http >= 1.0.0
70836     **/
70837    function __construct($flags){}
70838
70839}
70840class HttpMessage implements Iterator, Countable, Serializable {
70841    /**
70842     * Add headers. If append is true, headers with the same name will be
70843     * separated, else overwritten.
70844     *
70845     * @param array $headers associative array containing the additional
70846     *   HTTP headers to add to the messages existing headers
70847     * @param bool $append if true, and a header with the same name of one
70848     *   to add exists already, this respective header will be converted to
70849     *   an array containing both header values, otherwise it will be
70850     *   overwritten with the new header value
70851     * @return void
70852     * @since PECL pecl_http >= 0.10.0
70853     **/
70854    function addHeaders($headers, $append){}
70855
70856    /**
70857     * Returns a clone of an HttpMessage object detached from any parent
70858     * messages.
70859     *
70860     * @return HttpMessage
70861     * @since PECL pecl_http >= 0.22.0
70862     **/
70863    function detach(){}
70864
70865    /**
70866     * Create an HttpMessage object from a string.
70867     *
70868     * @param string $raw_message a single or several consecutive HTTP
70869     *   messages
70870     * @param string $class_name a class extending HttpMessage
70871     * @return HttpMessage
70872     * @since PECL pecl_http >= 1.4.0
70873     **/
70874    function factory($raw_message, $class_name){}
70875
70876    /**
70877     * Create an HttpMessage object from script environment.
70878     *
70879     * @param int $message_type The message type. See HttpMessage type
70880     *   constants.
70881     * @param string $class_name a class extending HttpMessage
70882     * @return HttpMessage
70883     * @since PECL pecl_http >= 1.5.0
70884     **/
70885    function fromEnv($message_type, $class_name){}
70886
70887    /**
70888     * Create an HttpMessage object from a string.
70889     *
70890     * @param string $raw_message a single or several consecutive HTTP
70891     *   messages
70892     * @param string $class_name a class extending HttpMessage
70893     * @return HttpMessage
70894     * @since PECL pecl_http 0.10.0-1.3.3
70895     **/
70896    function fromString($raw_message, $class_name){}
70897
70898    /**
70899     * Get the body of the parsed HttpMessage.
70900     *
70901     * @return string
70902     * @since PECL pecl_http >= 0.10.0
70903     **/
70904    function getBody(){}
70905
70906    /**
70907     * Get message header.
70908     *
70909     * @param string $header header name
70910     * @return string
70911     * @since PECL pecl_http >= 1.1.0
70912     **/
70913    function getHeader($header){}
70914
70915    /**
70916     * Get message headers.
70917     *
70918     * @return array
70919     * @since PECL pecl_http >= 0.10.0
70920     **/
70921    function getHeaders(){}
70922
70923    /**
70924     * Get the HTTP Protocol Version of the Message.
70925     *
70926     * @return string
70927     * @since PECL pecl_http >= 0.10.0
70928     **/
70929    function getHttpVersion(){}
70930
70931    /**
70932     * Get parent Message.
70933     *
70934     * @return HttpMessage
70935     * @since PECL pecl_http >= 0.10.0
70936     **/
70937    function getParentMessage(){}
70938
70939    /**
70940     * Get the Request Method of the Message.
70941     *
70942     * @return string
70943     * @since PECL pecl_http >= 0.10.0
70944     **/
70945    function getRequestMethod(){}
70946
70947    /**
70948     * Get the Request URL of the Message.
70949     *
70950     * @return string
70951     * @since PECL pecl_http >= 0.21.0
70952     **/
70953    function getRequestUrl(){}
70954
70955    /**
70956     * Get the Response Code of the Message.
70957     *
70958     * @return int
70959     * @since PECL pecl_http >= 0.10.0
70960     **/
70961    function getResponseCode(){}
70962
70963    /**
70964     * Get the Response Status of the message (i.e. the string following the
70965     * response code).
70966     *
70967     * @return string
70968     * @since PECL pecl_http >= 0.23.0
70969     **/
70970    function getResponseStatus(){}
70971
70972    /**
70973     * Get Message Type. Either HTTP_MSG_NONE, HTTP_MSG_REQUEST or
70974     * HTTP_MSG_RESPONSE.
70975     *
70976     * @return int
70977     * @since PECL pecl_http >= 0.10.0
70978     **/
70979    function getType(){}
70980
70981    /**
70982     * Attempts to guess the content type of the message body through
70983     * libmagic.
70984     *
70985     * @param string $magic_file the magic.mime database to use
70986     * @param int $magic_mode flags for libmagic
70987     * @return string
70988     * @since PECL pecl_http >= 1.0.0
70989     **/
70990    function guessContentType($magic_file, $magic_mode){}
70991
70992    /**
70993     * Prepends message(s) to the HTTP message.
70994     *
70995     * @param HttpMessage $message HttpMessage object to prepend
70996     * @param bool $top whether to prepend to the top most or right this
70997     *   message
70998     * @return void
70999     * @since PECL pecl_http >= 0.22.0
71000     **/
71001    function prepend($message, $top){}
71002
71003    /**
71004     * Reorders the message chain in reverse order.
71005     *
71006     * @return HttpMessage
71007     * @since PECL pecl_http >= 0.23.0
71008     **/
71009    function reverse(){}
71010
71011    /**
71012     * Send the Message according to its type as Response or Request.
71013     *
71014     * This provides limited functionality compared to HttpRequest and
71015     * HttpResponse.
71016     *
71017     * @return bool
71018     * @since PECL pecl_http >= 0.10.0
71019     **/
71020    function send(){}
71021
71022    /**
71023     * Set the body of the HttpMessage.
71024     *
71025     * @param string $body the new body of the message
71026     * @return void
71027     * @since PECL pecl_http >= 0.14.0
71028     **/
71029    function setBody($body){}
71030
71031    /**
71032     * Sets new headers.
71033     *
71034     * @param array $headers associative array containing the new HTTP
71035     *   headers, which will replace all previous HTTP headers of the message
71036     * @return void
71037     * @since PECL pecl_http >= 0.10.0
71038     **/
71039    function setHeaders($headers){}
71040
71041    /**
71042     * Set the HTTP Protocol version of the Message.
71043     *
71044     * @param string $version the HTTP protocol version
71045     * @return bool
71046     * @since PECL pecl_http >= 0.10.0
71047     **/
71048    function setHttpVersion($version){}
71049
71050    /**
71051     * Set the Request Method of the HTTP Message.
71052     *
71053     * @param string $method the request method name
71054     * @return bool
71055     * @since PECL pecl_http >= 0.10.0
71056     **/
71057    function setRequestMethod($method){}
71058
71059    /**
71060     * Set the Request URL of the HTTP Message.
71061     *
71062     * @param string $url the request URL
71063     * @return bool
71064     * @since PECL pecl_http >= 0.21.0
71065     **/
71066    function setRequestUrl($url){}
71067
71068    /**
71069     * Set the response code of an HTTP Response Message.
71070     *
71071     * @param int $code HTTP response code
71072     * @return bool
71073     * @since PECL pecl_http >= 0.10.0
71074     **/
71075    function setResponseCode($code){}
71076
71077    /**
71078     * Set the Response Status of the HTTP message (i.e. the string following
71079     * the response code).
71080     *
71081     * @param string $status the response status text
71082     * @return bool
71083     * @since PECL pecl_http >= 0.23.0
71084     **/
71085    function setResponseStatus($status){}
71086
71087    /**
71088     * Set Message Type. Either HTTP_MSG_NONE, HTTP_MSG_REQUEST or
71089     * HTTP_MSG_RESPONSE.
71090     *
71091     * @param int $type the HttpMessage::TYPE
71092     * @return void
71093     * @since PECL pecl_http >= 0.10.0
71094     **/
71095    function setType($type){}
71096
71097    /**
71098     * Creates an object regarding to the type of the message.
71099     *
71100     * @return HttpRequest|HttpResponse
71101     * @since PECL pecl_http >= 0.22.0
71102     **/
71103    function toMessageTypeObject(){}
71104
71105    /**
71106     * Get the string representation of the Message.
71107     *
71108     * @param bool $include_parent specifies whether the returned string
71109     *   should also contain any parent messages
71110     * @return string
71111     * @since PECL pecl_http >= 0.10.0
71112     **/
71113    function toString($include_parent){}
71114
71115    /**
71116     * Instantiate a new HttpMessage object.
71117     *
71118     * The constructed object will actually represent the last message of the
71119     * passed string. If there were prior messages, those can be accessed by
71120     * HttpMessage::{@link getParentMessage}.
71121     *
71122     * @param string $message a single or several consecutive HTTP messages
71123     * @return void
71124     * @since PECL pecl_http >= 0.10.0
71125     **/
71126    function __construct($message){}
71127
71128}
71129class HttpQueryString implements ArrayAccess, Serializable {
71130    /**
71131     * Get (part of) the query string.
71132     *
71133     * The type parameter is either one of the HttpQueryString::TYPE_*
71134     * constants or a type abbreviation like b for bool, i for int, f for
71135     * float, s for string, a for array and o for a stdClass object.
71136     *
71137     * @param string $key key of the query string param to retrieve
71138     * @param mixed $type which variable type to enforce
71139     * @param mixed $defval default value if key does not exist
71140     * @param bool $delete whether to remove the key/value pair from the
71141     *   query string
71142     * @return mixed
71143     * @since PECL pecl_http >= 0.22.0
71144     **/
71145    function get($key, $type, $defval, $delete){}
71146
71147    /**
71148     * Copies the query string object and sets provided params at the clone.
71149     *
71150     * @param mixed $params query string params to add
71151     * @return HttpQueryString
71152     * @since PECL pecl_http >= 1.1.0
71153     **/
71154    function mod($params){}
71155
71156    /**
71157     * Set query string entry/entries. NULL values will unset the variable.
71158     *
71159     * @param mixed $params query string params to add
71160     * @return string
71161     * @since PECL pecl_http >= 0.22.0
71162     **/
71163    function set($params){}
71164
71165    /**
71166     * Get a single instance (differentiates between the global setting).
71167     *
71168     * @param bool $global whether to operate on $_GET and
71169     *   $_SERVER['QUERY_STRING']
71170     * @return HttpQueryString
71171     * @since PECL pecl_http >= 0.25.0
71172     **/
71173    function singleton($global){}
71174
71175    /**
71176     * Get the query string represented as associative array.
71177     *
71178     * @return array
71179     * @since PECL pecl_http >= 0.22.0
71180     **/
71181    function toArray(){}
71182
71183    /**
71184     * Get the query string.
71185     *
71186     * @return string
71187     * @since PECL pecl_http >= 0.22.0
71188     **/
71189    function toString(){}
71190
71191    /**
71192     * Converts the query string from the source encoding ie to the target
71193     * encoding oe.
71194     *
71195     * @param string $ie input encoding
71196     * @param string $oe output encoding
71197     * @return bool
71198     * @since PECL pecl_http >= 0.25.0
71199     **/
71200    function xlate($ie, $oe){}
71201
71202    /**
71203     * Creates a new HttpQueryString object instance.
71204     *
71205     * Operates on and modifies $_GET and $_SERVER['QUERY_STRING'] if global
71206     * is TRUE.
71207     *
71208     * @param bool $global whether to operate on $_GET and
71209     *   $_SERVER['QUERY_STRING']
71210     * @param mixed $add additional/initial query string parameters
71211     * @return void
71212     * @since PECL pecl_http >= 0.22.0
71213     **/
71214    function __construct($global, $add){}
71215
71216}
71217class HttpRequest {
71218    /**
71219     * Add custom cookies.
71220     *
71221     * @param array $cookies an associative array containing any cookie
71222     *   name/value pairs to add
71223     * @return bool
71224     * @since PECL pecl_http >= 0.10.0
71225     **/
71226    function addCookies($cookies){}
71227
71228    /**
71229     * Add request header name/value pairs.
71230     *
71231     * @param array $headers an associative array as parameter containing
71232     *   additional header name/value pairs
71233     * @return bool
71234     * @since PECL pecl_http >= 0.10.0
71235     **/
71236    function addHeaders($headers){}
71237
71238    /**
71239     * Adds POST data entries, leaving previously set unchanged, unless a
71240     * post entry with the same name already exists.
71241     *
71242     * Affects only POST and custom requests.
71243     *
71244     * @param array $post_data an associative array as parameter containing
71245     *   the post fields
71246     * @return bool
71247     * @since PECL pecl_http >= 0.10.0
71248     **/
71249    function addPostFields($post_data){}
71250
71251    /**
71252     * Add a file to the POST request, leaving previously set files
71253     * unchanged.
71254     *
71255     * Affects only POST and custom requests. Cannot be used with raw post
71256     * data.
71257     *
71258     * @param string $name the form element name
71259     * @param string $file the path to the file
71260     * @param string $content_type the content type of the file
71261     * @return bool
71262     * @since PECL pecl_http >= 0.10.0
71263     **/
71264    function addPostFile($name, $file, $content_type){}
71265
71266    /**
71267     * Add PUT data, leaving previously set PUT data unchanged.
71268     *
71269     * Affects only PUT requests.
71270     *
71271     * @param string $put_data the data to concatenate
71272     * @return bool
71273     * @since PECL pecl_http >= 0.25.0
71274     **/
71275    function addPutData($put_data){}
71276
71277    /**
71278     * Add parameters to the query parameter list, leaving previously set
71279     * unchanged.
71280     *
71281     * Affects any request type.
71282     *
71283     * @param array $query_params an associative array as parameter
71284     *   containing the query fields to add
71285     * @return bool
71286     * @since PECL pecl_http >= 0.10.0
71287     **/
71288    function addQueryData($query_params){}
71289
71290    /**
71291     * Add raw post data, leaving previously set raw post data unchanged.
71292     *
71293     * Affects only POST and custom requests.
71294     *
71295     * @param string $raw_post_data the raw post data to concatenate
71296     * @return bool
71297     * @since PECL pecl_http 0.14.0-1.4.1
71298     **/
71299    function addRawPostData($raw_post_data){}
71300
71301    /**
71302     * Set additional SSL options.
71303     *
71304     * @param array $options an associative array as parameter containing
71305     *   additional SSL specific options
71306     * @return bool
71307     * @since PECL pecl_http >= 0.12.0
71308     **/
71309    function addSslOptions($options){}
71310
71311    /**
71312     * Clears all history messages.
71313     *
71314     * @return void
71315     * @since PECL pecl_http >= 0.15.0
71316     **/
71317    function clearHistory(){}
71318
71319    /**
71320     * Enable automatic sending of received cookies.
71321     *
71322     * @return bool
71323     * @since PECL pecl_http >= 1.0.0
71324     **/
71325    function enableCookies(){}
71326
71327    /**
71328     * Get the previously set content type.
71329     *
71330     * @return string
71331     * @since PECL pecl_http >= 0.10.0
71332     **/
71333    function getContentType(){}
71334
71335    /**
71336     * Get previously set cookies.
71337     *
71338     * @return array
71339     * @since PECL pecl_http >= 0.10.0
71340     **/
71341    function getCookies(){}
71342
71343    /**
71344     * Get previously set request headers.
71345     *
71346     * @return array
71347     * @since PECL pecl_http >= 0.10.0
71348     **/
71349    function getHeaders(){}
71350
71351    /**
71352     * Get all sent requests and received responses as an HttpMessage object.
71353     *
71354     * If you want to record history, set the instance variable
71355     * HttpRequest::recordHistory to TRUE.
71356     *
71357     * The returned object references the last received response, use {@link
71358     * HttpMessage::getParentMessage} to access the data of previously sent
71359     * requests and received responses.
71360     *
71361     * @return HttpMessage
71362     * @since PECL pecl_http >= 0.15.0
71363     **/
71364    function getHistory(){}
71365
71366    /**
71367     * Get the previously set request method.
71368     *
71369     * @return int
71370     * @since PECL pecl_http >= 0.10.0
71371     **/
71372    function getMethod(){}
71373
71374    /**
71375     * Get currently set options.
71376     *
71377     * @return array
71378     * @since PECL pecl_http >= 0.10.0
71379     **/
71380    function getOptions(){}
71381
71382    /**
71383     * Get previously set POST data.
71384     *
71385     * @return array
71386     * @since PECL pecl_http >= 0.10.0
71387     **/
71388    function getPostFields(){}
71389
71390    /**
71391     * Get all previously added POST files.
71392     *
71393     * @return array
71394     * @since PECL pecl_http >= 0.10.0
71395     **/
71396    function getPostFiles(){}
71397
71398    /**
71399     * Get previously set PUT data.
71400     *
71401     * @return string
71402     * @since PECL pecl_http >= 0.25.0
71403     **/
71404    function getPutData(){}
71405
71406    /**
71407     * Get previously set put file.
71408     *
71409     * @return string
71410     * @since PECL pecl_http >= 0.10.0
71411     **/
71412    function getPutFile(){}
71413
71414    /**
71415     * Get the current query data in form of an urlencoded query string.
71416     *
71417     * @return string
71418     * @since PECL pecl_http >= 0.10.0
71419     **/
71420    function getQueryData(){}
71421
71422    /**
71423     * Get previously set raw post data.
71424     *
71425     * @return string
71426     * @since PECL pecl_http 0.14.0-1.4.1
71427     **/
71428    function getRawPostData(){}
71429
71430    /**
71431     * Get sent HTTP message.
71432     *
71433     * @return string
71434     * @since PECL pecl_http >= 0.21.0
71435     **/
71436    function getRawRequestMessage(){}
71437
71438    /**
71439     * Get the entire HTTP response.
71440     *
71441     * @return string
71442     * @since PECL pecl_http >= 0.21.0
71443     **/
71444    function getRawResponseMessage(){}
71445
71446    /**
71447     * Get sent HTTP message.
71448     *
71449     * If redirects were allowed and several responses were received, the
71450     * data references the last received response. Use {@link
71451     * HttpMessage::getParentMessage} to access the data of previously sent
71452     * requests within this request cycle.
71453     *
71454     * @return HttpMessage
71455     * @since PECL pecl_http >= 0.11.0
71456     **/
71457    function getRequestMessage(){}
71458
71459    /**
71460     * Get the response body after the request has been sent.
71461     *
71462     * If redirects were allowed and several responses were received, the
71463     * data references the last received response.
71464     *
71465     * @return string
71466     * @since PECL pecl_http >= 0.10.0
71467     **/
71468    function getResponseBody(){}
71469
71470    /**
71471     * Get the response code after the request has been sent.
71472     *
71473     * If redirects were allowed and several responses were received, the
71474     * data references the last received response.
71475     *
71476     * @return int
71477     * @since PECL pecl_http >= 0.10.0
71478     **/
71479    function getResponseCode(){}
71480
71481    /**
71482     * Get response cookie(s) after the request has been sent.
71483     *
71484     * If redirects were allowed and several responses were received, the
71485     * data references the last received response.
71486     *
71487     * @param int $flags {@link http_parse_cookie} flags
71488     * @param array $allowed_extras allowed keys treated as extra
71489     *   information instead of cookie names
71490     * @return array
71491     * @since PECL pecl_http >= 0.23.0
71492     **/
71493    function getResponseCookies($flags, $allowed_extras){}
71494
71495    /**
71496     * * Get all response data after the request has been sent.
71497     *
71498     * If redirects were allowed and several responses were received, the
71499     * data references the last received response.
71500     *
71501     * @return array
71502     * @since PECL pecl_http >= 0.10.0
71503     **/
71504    function getResponseData(){}
71505
71506    /**
71507     * Get response header(s) after the request has been sent.
71508     *
71509     * If redirects were allowed and several responses were received, the
71510     * data references the last received response.
71511     *
71512     * @param string $name header to read; if empty, all response headers
71513     *   will be returned
71514     * @return mixed
71515     * @since PECL pecl_http >= 0.10.0
71516     **/
71517    function getResponseHeader($name){}
71518
71519    /**
71520     * Get response info after the request has been sent.
71521     *
71522     * See {@link http_get} for a full list of returned info.
71523     *
71524     * If redirects were allowed and several responses were received, the
71525     * data references the last received response.
71526     *
71527     * @param string $name the info to read; if empty or omitted, an
71528     *   associative array containing all available info will be returned
71529     * @return mixed
71530     * @since PECL pecl_http >= 0.10.0
71531     **/
71532    function getResponseInfo($name){}
71533
71534    /**
71535     * Get the full response as HttpMessage object after the request has been
71536     * sent.
71537     *
71538     * If redirects were allowed and several responses were received, the
71539     * data references the last received response. Use {@link
71540     * HttpMessage::getParentMessage} to access the data of previously
71541     * received responses within this request cycle.
71542     *
71543     * @return HttpMessage
71544     * @since PECL pecl_http >= 0.10.0
71545     **/
71546    function getResponseMessage(){}
71547
71548    /**
71549     * Get the response status (i.e. the string after the response code)
71550     * after the message has been sent.
71551     *
71552     * @return string
71553     * @since PECL pecl_http >= 0.23.0
71554     **/
71555    function getResponseStatus(){}
71556
71557    /**
71558     * Get previously set SSL options.
71559     *
71560     * @return array
71561     * @since PECL pecl_http >= 0.10.0
71562     **/
71563    function getSslOptions(){}
71564
71565    /**
71566     * Get the previously set request URL.
71567     *
71568     * @return string
71569     * @since PECL pecl_http >= 0.10.0
71570     **/
71571    function getUrl(){}
71572
71573    /**
71574     * Reset all automatically received/sent cookies.
71575     *
71576     * @param bool $session_only whether only session cookies should be
71577     *   reset (needs libcurl >= v7.15.4, else libcurl >= v7.14.1)
71578     * @return bool
71579     * @since PECL pecl_http >= 1.0.0
71580     **/
71581    function resetCookies($session_only){}
71582
71583    /**
71584     * Send the HTTP request.
71585     *
71586     * @return HttpMessage
71587     * @since PECL pecl_http >= 0.10.0
71588     **/
71589    function send(){}
71590
71591    /**
71592     * Set the content type the post request should have.
71593     *
71594     * @param string $content_type the content type of the request
71595     *   (primary/secondary)
71596     * @return bool
71597     * @since PECL pecl_http >= 0.10.0
71598     **/
71599    function setContentType($content_type){}
71600
71601    /**
71602     * Set custom cookies.
71603     *
71604     * @param array $cookies an associative array as parameter containing
71605     *   cookie name/value pairs; if empty or omitted, all previously set
71606     *   cookies will be unset
71607     * @return bool
71608     * @since PECL pecl_http >= 0.12.0
71609     **/
71610    function setCookies($cookies){}
71611
71612    /**
71613     * Set request header name/value pairs.
71614     *
71615     * @param array $headers an associative array as parameter containing
71616     *   header name/value pairs; if empty or omitted, all previously set
71617     *   headers will be unset
71618     * @return bool
71619     * @since PECL pecl_http >= 0.12.0
71620     **/
71621    function setHeaders($headers){}
71622
71623    /**
71624     * Set the request method.
71625     *
71626     * @param int $request_method the request method to use
71627     * @return bool
71628     * @since PECL pecl_http >= 0.10.0
71629     **/
71630    function setMethod($request_method){}
71631
71632    /**
71633     * Set the request options to use.
71634     *
71635     * @param array $options an associative array, which values will
71636     *   overwrite the currently set request options; if empty or omitted,
71637     *   the options of the HttpRequest object will be reset
71638     * @return bool
71639     * @since PECL pecl_http >= 0.10.0
71640     **/
71641    function setOptions($options){}
71642
71643    /**
71644     * Set the POST data entries, overwriting previously set POST data.
71645     *
71646     * Affects only POST and custom requests.
71647     *
71648     * @param array $post_data an associative array containing the post
71649     *   fields; if empty, the post data will be unset
71650     * @return bool
71651     * @since PECL pecl_http >= 0.10.0
71652     **/
71653    function setPostFields($post_data){}
71654
71655    /**
71656     * Set files to post, overwriting previously set post files.
71657     *
71658     * Affects only POST and requests. Cannot be used with raw post data.
71659     *
71660     * @param array $post_files an array containing the files to post; if
71661     *   empty, the post files will be unset
71662     * @return bool
71663     * @since PECL pecl_http >= 0.10.0
71664     **/
71665    function setPostFiles($post_files){}
71666
71667    /**
71668     * Set PUT data to send, overwriting previously set PUT data.
71669     *
71670     * Affects only PUT requests.
71671     *
71672     * Only either PUT data or PUT file can be used for each request. PUT
71673     * data has higher precedence and will be used even if a PUT file is set.
71674     *
71675     * @param string $put_data the data to upload
71676     * @return bool
71677     * @since PECL pecl_http >= 0.25.0
71678     **/
71679    function setPutData($put_data){}
71680
71681    /**
71682     * Set file to put. Affects only PUT requests.
71683     *
71684     * @param string $file the path to the file to send; if empty or
71685     *   omitted the put file will be unset
71686     * @return bool
71687     * @since PECL pecl_http >= 0.10.0
71688     **/
71689    function setPutFile($file){}
71690
71691    /**
71692     * Set the URL query parameters to use, overwriting previously set query
71693     * parameters.
71694     *
71695     * Affects any request types.
71696     *
71697     * @param mixed $query_data a string or associative array parameter
71698     *   containing the pre-encoded query string or to be encoded query
71699     *   fields; if empty, the query data will be unset
71700     * @return bool
71701     * @since PECL pecl_http >= 0.10.0
71702     **/
71703    function setQueryData($query_data){}
71704
71705    /**
71706     * Set raw post data to send, overwriting previously set raw post data.
71707     * Don't forget to specify a content type. Affects only POST and custom
71708     * requests.
71709     *
71710     * Only either post fields or raw post data can be used for each request.
71711     * Raw post data has higher precedence and will be used even if post
71712     * fields are set.
71713     *
71714     * @param string $raw_post_data raw post data
71715     * @return bool
71716     * @since PECL pecl_http 0.14.0-1.4.1
71717     **/
71718    function setRawPostData($raw_post_data){}
71719
71720    /**
71721     * Set SSL options.
71722     *
71723     * @param array $options an associative array containing any SSL
71724     *   specific options; if empty or omitted, the SSL options will be reset
71725     * @return bool
71726     * @since PECL pecl_http >= 0.10.0
71727     **/
71728    function setSslOptions($options){}
71729
71730    /**
71731     * Set the request URL.
71732     *
71733     * @param string $url the request url
71734     * @return bool
71735     * @since PECL pecl_http >= 0.10.0
71736     **/
71737    function setUrl($url){}
71738
71739    /**
71740     * Instantiate a new HttpRequest object.
71741     *
71742     * @param string $url the target request url
71743     * @param int $request_method the request method to use
71744     * @param array $options an associative array with request options
71745     * @return void
71746     * @since PECL pecl_http >= 0.10.0
71747     **/
71748    function __construct($url, $request_method, $options){}
71749
71750}
71751class HttpRequestPool implements Iterator, Countable {
71752    /**
71753     * Attach an HttpRequest object to this HttpRequestPool.
71754     *
71755     * @param HttpRequest $request an HttpRequest object not already
71756     *   attached to any HttpRequestPool object
71757     * @return bool
71758     * @since PECL pecl_http >= 0.10.0
71759     **/
71760    function attach($request){}
71761
71762    /**
71763     * Detach an HttpRequest object from this HttpRequestPool.
71764     *
71765     * @param HttpRequest $request an HttpRequest object attached to this
71766     *   HttpRequestPool object
71767     * @return bool
71768     * @since PECL pecl_http >= 0.10.0
71769     **/
71770    function detach($request){}
71771
71772    /**
71773     * Get attached HttpRequest objects.
71774     *
71775     * @return array
71776     * @since PECL pecl_http >= 0.16.0
71777     **/
71778    function getAttachedRequests(){}
71779
71780    /**
71781     * Get attached HttpRequest objects that already have finished their
71782     * work.
71783     *
71784     * @return array
71785     * @since PECL pecl_http >= 0.16.0
71786     **/
71787    function getFinishedRequests(){}
71788
71789    /**
71790     * Detach all attached HttpRequest objects.
71791     *
71792     * @return void
71793     * @since PECL pecl_http >= 0.10.0
71794     **/
71795    function reset(){}
71796
71797    /**
71798     * Send all attached HttpRequest objects in parallel.
71799     *
71800     * @return bool
71801     * @since PECL pecl_http >= 0.10.0
71802     **/
71803    function send(){}
71804
71805    /**
71806     * Returns TRUE until each request has finished its transaction.
71807     *
71808     * @return bool
71809     * @since PECL pecl_http >= 0.15.0
71810     **/
71811    function socketPerform(){}
71812
71813    /**
71814     * @return bool
71815     * @since PECL pecl_http >= 0.10.0
71816     **/
71817    function socketSelect(){}
71818
71819    /**
71820     * Instantiate a new HttpRequestPool object. An HttpRequestPool is able
71821     * to send several HttpRequests in parallel.
71822     *
71823     * Accepts virtually infinite optional parameters each referencing an
71824     * HttpRequest object.
71825     *
71826     * @param HttpRequest $request HttpRequest object to attach
71827     * @return void
71828     * @since PECL pecl_http >= 0.10.0
71829     **/
71830    function __construct($request){}
71831
71832    /**
71833     * Clean up HttpRequestPool object.
71834     *
71835     * @return void
71836     * @since PECL pecl_http >= 0.10.0
71837     **/
71838    function __destruct(){}
71839
71840}
71841class HttpResponse {
71842    /**
71843     * Capture script output.
71844     *
71845     * @return void
71846     * @since PECL pecl_http >= 0.10.0
71847     **/
71848    function capture(){}
71849
71850    /**
71851     * Get current buffer size.
71852     *
71853     * @return int
71854     * @since PECL pecl_http >= 0.10.0
71855     **/
71856    function getBufferSize(){}
71857
71858    /**
71859     * Get current caching setting.
71860     *
71861     * @return bool
71862     * @since PECL pecl_http >= 0.10.0
71863     **/
71864    function getCache(){}
71865
71866    /**
71867     * Get current Cache-Control header setting.
71868     *
71869     * @return string
71870     * @since PECL pecl_http >= 0.10.0
71871     **/
71872    function getCacheControl(){}
71873
71874    /**
71875     * Get current Content-Disposition setting.
71876     *
71877     * @return string
71878     * @since PECL pecl_http >= 0.10.0
71879     **/
71880    function getContentDisposition(){}
71881
71882    /**
71883     * Get current Content-Type header setting.
71884     *
71885     * @return string
71886     * @since PECL pecl_http >= 0.10.0
71887     **/
71888    function getContentType(){}
71889
71890    /**
71891     * Get the previously set data to be sent.
71892     *
71893     * @return string
71894     * @since PECL pecl_http >= 0.10.0
71895     **/
71896    function getData(){}
71897
71898    /**
71899     * Get calculated or previously set custom ETag.
71900     *
71901     * @return string
71902     * @since PECL pecl_http >= 0.10.0
71903     **/
71904    function getETag(){}
71905
71906    /**
71907     * Get the previously set file to be sent.
71908     *
71909     * @return string
71910     * @since PECL pecl_http >= 0.10.0
71911     **/
71912    function getFile(){}
71913
71914    /**
71915     * Get current gzip'ing setting.
71916     *
71917     * @return bool
71918     * @since PECL pecl_http >= 0.10.0
71919     **/
71920    function getGzip(){}
71921
71922    /**
71923     * Get header(s) about to be sent.
71924     *
71925     * @param string $name specifies the name of the header to read; if
71926     *   empty or omitted, an associative array with all headers will be
71927     *   returned
71928     * @return mixed
71929     * @since PECL pecl_http >= 0.12.0
71930     **/
71931    function getHeader($name){}
71932
71933    /**
71934     * Get calculated or previously set custom Last-Modified date.
71935     *
71936     * @return int
71937     * @since PECL pecl_http >= 0.12.0
71938     **/
71939    function getLastModified(){}
71940
71941    /**
71942     * {@link http_get_request_body}.
71943     *
71944     * @return string
71945     * @since PECL pecl_http >= 0.10.0
71946     **/
71947    function getRequestBody(){}
71948
71949    /**
71950     * {@link http_get_request_body_stream}.
71951     *
71952     * @return resource
71953     * @since PECL pecl_http >= 0.10.0
71954     **/
71955    function getRequestBodyStream(){}
71956
71957    /**
71958     * {@link http_get_request_headers}.
71959     *
71960     * @return array
71961     * @since PECL pecl_http >= 0.10.0
71962     **/
71963    function getRequestHeaders(){}
71964
71965    /**
71966     * Get the previously set resource to be sent.
71967     *
71968     * @return resource
71969     * @since PECL pecl_http >= 0.10.0
71970     **/
71971    function getStream(){}
71972
71973    /**
71974     * Get the current throttle delay.
71975     *
71976     * @return double
71977     * @since PECL pecl_http >= 0.10.0
71978     **/
71979    function getThrottleDelay(){}
71980
71981    /**
71982     * Attempts to guess the content type of supplied payload through
71983     * libmagic.
71984     *
71985     * If the attempt is successful, the guessed Content-Type will
71986     * automatically be set as response Content-Type.
71987     *
71988     * @param string $magic_file specifies the magic.mime database to use
71989     * @param int $magic_mode flags for libmagic
71990     * @return string
71991     * @since PECL pecl_http >= 0.13.0
71992     **/
71993    function guessContentType($magic_file, $magic_mode){}
71994
71995    /**
71996     * {@link http_redirect}.
71997     *
71998     * @param string $url
71999     * @param array $params
72000     * @param bool $session
72001     * @param int $status
72002     * @return void
72003     * @since PECL pecl_http >= 0.10.0
72004     **/
72005    function redirect($url, $params, $session, $status){}
72006
72007    /**
72008     * Finally send the entity.
72009     *
72010     * A successful caching attempt will exit PHP, and write a log entry if
72011     * the http.log.cache is set.
72012     *
72013     * @param bool $clean_ob whether to destroy all previously started
72014     *   output handlers and their buffers
72015     * @return bool
72016     * @since PECL pecl_http >= 0.10.0
72017     **/
72018    function send($clean_ob){}
72019
72020    /**
72021     * Sets the send buffer size of the throttling mechanism.
72022     *
72023     * @param int $bytes the chunk size in bytes
72024     * @return bool
72025     * @since PECL pecl_http >= 0.10.0
72026     **/
72027    function setBufferSize($bytes){}
72028
72029    /**
72030     * Whether it should be attempted to cache the entity.
72031     *
72032     * This will result in necessary caching headers and checks of clients
72033     * If-Modified-Since and If-None-Match headers. If one of those headers
72034     * matches a 304 Not Modified status code will be issued.
72035     *
72036     * @param bool $cache whether caching should be attempted
72037     * @return bool
72038     * @since PECL pecl_http >= 0.10.0
72039     **/
72040    function setCache($cache){}
72041
72042    /**
72043     * Define a custom Cache-Control header, usually being private or public;
72044     *
72045     * @param string $control the primary cache control setting
72046     * @param int $max_age the max-age in seconds, suggesting how long the
72047     *   cache entry is valid on the client side
72048     * @param bool $must_revalidate whether the cached entity should be
72049     *   revalidated by the client for every request
72050     * @return bool
72051     * @since PECL pecl_http >= 0.10.0
72052     **/
72053    function setCacheControl($control, $max_age, $must_revalidate){}
72054
72055    /**
72056     * Set the Content-Disposition.
72057     *
72058     * @param string $filename the file name the Save as... dialog should
72059     *   display
72060     * @param bool $inline if set to true and the user agent knows how to
72061     *   handle the content type, it will probably not cause the popup window
72062     *   to be shown
72063     * @return bool
72064     * @since PECL pecl_http >= 0.10.0
72065     **/
72066    function setContentDisposition($filename, $inline){}
72067
72068    /**
72069     * Set the Content-Type of the sent entity.
72070     *
72071     * @param string $content_type the content type of the sent entity
72072     *   (primary/secondary)
72073     * @return bool
72074     * @since PECL pecl_http >= 0.10.0
72075     **/
72076    function setContentType($content_type){}
72077
72078    /**
72079     * Set the data to be sent.
72080     *
72081     * @param mixed $data data to send
72082     * @return bool
72083     * @since PECL pecl_http >= 0.10.0
72084     **/
72085    function setData($data){}
72086
72087    /**
72088     * Set a custom ETag. Use this only if you know what you're doing.
72089     *
72090     * @param string $etag unquoted string as parameter containing the ETag
72091     * @return bool
72092     * @since PECL pecl_http >= 0.10.0
72093     **/
72094    function setETag($etag){}
72095
72096    /**
72097     * Set the file to be sent.
72098     *
72099     * @param string $file the path to the file to send
72100     * @return bool
72101     * @since PECL pecl_http >= 0.10.0
72102     **/
72103    function setFile($file){}
72104
72105    /**
72106     * Enable on-thy-fly gzip'ing of the sent entity.
72107     *
72108     * @param bool $gzip whether GZip compression should be enabled
72109     * @return bool
72110     * @since PECL pecl_http >= 0.10.0
72111     **/
72112    function setGzip($gzip){}
72113
72114    /**
72115     * Send an HTTP header.
72116     *
72117     * @param string $name the name of the header
72118     * @param mixed $value the value of the header; if not set, no header
72119     *   with this name will be sent
72120     * @param bool $replace whether an existing header should be replaced
72121     * @return bool
72122     * @since PECL pecl_http >= 0.12.0
72123     **/
72124    function setHeader($name, $value, $replace){}
72125
72126    /**
72127     * Set a custom Last-Modified date.
72128     *
72129     * @param int $timestamp Unix timestamp representing the last
72130     *   modification time of the sent entity
72131     * @return bool
72132     * @since PECL pecl_http >= 0.12.0
72133     **/
72134    function setLastModified($timestamp){}
72135
72136    /**
72137     * Set the resource to be sent.
72138     *
72139     * @param resource $stream already opened stream from which the data to
72140     *   send will be read
72141     * @return bool
72142     * @since PECL pecl_http >= 0.10.0
72143     **/
72144    function setStream($stream){}
72145
72146    /**
72147     * Sets the throttle delay.
72148     *
72149     * @param float $seconds seconds to sleep after each chunk sent
72150     * @return bool
72151     * @since PECL pecl_http >= 0.10.0
72152     **/
72153    function setThrottleDelay($seconds){}
72154
72155    /**
72156     * {@link http_send_status}.
72157     *
72158     * @param int $status
72159     * @return bool
72160     * @since PECL pecl_http >= 0.12.0
72161     **/
72162    function status($status){}
72163
72164}
72165class hw_api {
72166    /**
72167     * This function checks in an object or a whole hierarchy of objects. The
72168     * parameters array contains the required element 'objectIdentifier' and
72169     * the optional element 'version', 'comment', 'mode' and 'objectQuery'.
72170     * 'version' sets the version of the object. It consists of the major and
72171     * minor version separated by a period. If the version is not set, the
72172     * minor version is incremented. 'mode' can be one of the following
72173     * values: HW_API_CHECKIN_NORMAL Checks in and commits the object. The
72174     * object must be a document. HW_API_CHECKIN_RECURSIVE If the object to
72175     * check in is a collection, all children will be checked in recursively
72176     * if they are documents. Trying to check in a collection would result in
72177     * an error. HW_API_CHECKIN_FORCE_VERSION_CONTROL Checks in an object
72178     * even if it is not under version control.
72179     * HW_API_CHECKIN_REVERT_IF_NOT_CHANGED Check if the new version is
72180     * different from the last version. Unless this is the case the object
72181     * will be checked in. HW_API_CHECKIN_KEEP_TIME_MODIFIED Keeps the time
72182     * modified from the most recent object. HW_API_CHECKIN_NO_AUTO_COMMIT
72183     * The object is not automatically committed on check-in.
72184     *
72185     * @param array $parameter
72186     * @return bool
72187     **/
72188    function checkin($parameter){}
72189
72190    /**
72191     * This function checks out an object or a whole hierarchy of objects.
72192     *
72193     * @param array $parameter The parameters array contains the required
72194     *   element 'objectIdentifier' and the optional element 'version',
72195     *   'mode' and 'objectQuery'. 'mode' can be one of the following values:
72196     *   HW_API_CHECKIN_NORMAL Checks out an object. The object must be a
72197     *   document. HW_API_CHECKIN_RECURSIVE If the object to check out is a
72198     *   collection, all children will be checked out recursively if they are
72199     *   documents. Trying to check out a collection would result in an
72200     *   error.
72201     * @return bool
72202     **/
72203    function checkout($parameter){}
72204
72205    /**
72206     * Retrieves the children of a collection or the attributes of a
72207     * document. The children can be further filtered by specifying an object
72208     * query.
72209     *
72210     * @param array $parameter The parameter array contains the required
72211     *   elements 'objectIdentifier' and the optional elements
72212     *   'attributeSelector' and 'objectQuery'.
72213     * @return array
72214     **/
72215    function children($parameter){}
72216
72217    /**
72218     * This function returns the content of a document as an object of type
72219     * hw_api_content.
72220     *
72221     * @param array $parameter The parameter array contains the required
72222     *   elements 'objectidentifier' and the optional element 'mode'. The
72223     *   mode can be one of the constants HW_API_CONTENT_ALLLINKS,
72224     *   HW_API_CONTENT_REACHABLELINKS or HW_API_CONTENT_PLAIN.
72225     *   HW_API_CONTENT_ALLLINKS means to insert all anchors even if the
72226     *   destination is not reachable. HW_API_CONTENT_REACHABLELINKS tells
72227     *   this method to insert only reachable links and HW_API_CONTENT_PLAIN
72228     *   will lead to document without any links.
72229     * @return HW_API_Content
72230     **/
72231    function content($parameter){}
72232
72233    /**
72234     * This function will make a physical copy including the content if it
72235     * exists and returns the new object or an error object.
72236     *
72237     * @param array $parameter The parameter array contains the required
72238     *   elements 'objectIdentifier' and 'destinationParentIdentifier'. The
72239     *   optional parameter is 'attributeSelector'`
72240     * @return hw_api_content
72241     **/
72242    function copy($parameter){}
72243
72244    /**
72245     * Returns statistics about database server.
72246     *
72247     * @param array $parameter
72248     * @return hw_api_object
72249     **/
72250    function dbstat($parameter){}
72251
72252    /**
72253     * Returns statistics about document cache server.
72254     *
72255     * @param array $parameter
72256     * @return hw_api_object
72257     **/
72258    function dcstat($parameter){}
72259
72260    /**
72261     * Retrieves all destination anchors of an object.
72262     *
72263     * @param array $parameter The parameter array contains the required
72264     *   element 'objectIdentifier' and the optional elements
72265     *   'attributeSelector' and 'objectQuery'.
72266     * @return array
72267     **/
72268    function dstanchors($parameter){}
72269
72270    /**
72271     * Retrieves the destination object pointed by the specified source
72272     * anchors. The destination object can either be a destination anchor or
72273     * a whole document.
72274     *
72275     * @param array $parameter The parameters array contains the required
72276     *   element 'objectIdentifier' and the optional element
72277     *   'attributeSelector'.
72278     * @return hw_api_object
72279     **/
72280    function dstofsrcanchor($parameter){}
72281
72282    /**
72283     * This functions searches for objects either by executing a key or/and
72284     * full text query. The found objects can further be filtered by an
72285     * optional object query. They are sorted by their importance. The second
72286     * search operation is relatively slow and its result can be limited to a
72287     * certain number of hits. This allows to perform an incremental search,
72288     * each returning just a subset of all found documents, starting at a
72289     * given index.
72290     *
72291     * @param array $parameter The parameter array contains the 'keyquery'
72292     *   or/and 'fulltextquery' depending on who you would like to search.
72293     *   Optional parameters are 'objectquery', 'scope', 'languages' and
72294     *   'attributeselector'. In case of an incremental search the optional
72295     *   parameters 'startIndex', 'numberOfObjectsToGet' and 'exactMatchUnit'
72296     *   can be passed.
72297     * @return array
72298     **/
72299    function find($parameter){}
72300
72301    /**
72302     * Returns statistics about fulltext server.
72303     *
72304     * @param array $parameter
72305     * @return hw_api_object
72306     **/
72307    function ftstat($parameter){}
72308
72309    /**
72310     * Returns statistics about Hyperwave server.
72311     *
72312     * @param array $parameter
72313     * @return hw_api_object
72314     **/
72315    function hwstat($parameter){}
72316
72317    /**
72318     * Logs into the Hyperwave Server.
72319     *
72320     * @param array $parameter The parameter array must contain the
72321     *   elements 'username' and 'password'.
72322     * @return bool
72323     **/
72324    function identify($parameter){}
72325
72326    /**
72327     * Returns information about server configuration.
72328     *
72329     * @param array $parameter
72330     * @return array
72331     **/
72332    function info($parameter){}
72333
72334    /**
72335     * Insert a new object. The object type can be user, group, document or
72336     * anchor. Depending on the type other object attributes has to be set.
72337     *
72338     * @param array $parameter The parameter array contains the required
72339     *   elements 'object' and 'content' (if the object is a document) and
72340     *   the optional parameters 'parameters', 'mode' and
72341     *   'attributeSelector'. The 'object' must contain all attributes of the
72342     *   object. 'parameters' is an object as well holding further attributes
72343     *   like the destination (attribute key is 'Parent'). 'content' is the
72344     *   content of the document. 'mode' can be a combination of the
72345     *   following flags: HW_API_INSERT_NORMAL The object in inserted into
72346     *   the server. HW_API_INSERT_FORCE_VERSION_CONTROL
72347     *   HW_API_INSERT_AUTOMATIC_CHECKOUT HW_API_INSERT_PLAIN
72348     *   HW_API_INSERT_KEEP_TIME_MODIFIED HW_API_INSERT_DELAY_INDEXING
72349     * @return hw_api_object
72350     **/
72351    function insert($parameter){}
72352
72353    /**
72354     * This function is a shortcut for {@link hwapi_insert}. It inserts an
72355     * object of type anchor and sets some of the attributes required for an
72356     * anchor.
72357     *
72358     * @param array $parameter The parameter array contains the required
72359     *   elements 'object' and 'documentIdentifier' and the optional elements
72360     *   'destinationIdentifier', 'parameter', 'hint' and
72361     *   'attributeSelector'. The 'documentIdentifier' specifies the document
72362     *   where the anchor shall be inserted. The target of the anchor is set
72363     *   in 'destinationIdentifier' if it already exists. If the target does
72364     *   not exists the element 'hint' has to be set to the name of object
72365     *   which is supposed to be inserted later. Once it is inserted the
72366     *   anchor target is resolved automatically.
72367     * @return hw_api_object
72368     **/
72369    function insertanchor($parameter){}
72370
72371    /**
72372     * This function is a shortcut for {@link hwapi_insert}. It inserts an
72373     * object of type collection and sets some of the attributes required for
72374     * a collection.
72375     *
72376     * @param array $parameter The parameter array contains the required
72377     *   elements 'object' and 'parentIdentifier' and the optional elements
72378     *   'parameter' and 'attributeSelector'. See {@link hwapi_insert} for
72379     *   the meaning of each element.
72380     * @return hw_api_object
72381     **/
72382    function insertcollection($parameter){}
72383
72384    /**
72385     * This function is a shortcut for {@link hwapi_insert}. It inserts an
72386     * object with content and sets some of the attributes required for a
72387     * document.
72388     *
72389     * @param array $parameter The parameter array contains the required
72390     *   elements 'object', 'parentIdentifier' and 'content' and the optional
72391     *   elements 'mode', 'parameter' and 'attributeSelector'. See {@link
72392     *   hwapi_insert} for the meaning of each element.
72393     * @return hw_api_object
72394     **/
72395    function insertdocument($parameter){}
72396
72397    /**
72398     * Creates a link to an object. Accessing this link is like accessing the
72399     * object to links points to.
72400     *
72401     * @param array $parameter The parameter array contains the required
72402     *   elements 'objectIdentifier' and 'destinationParentIdentifier'.
72403     *   'destinationParentIdentifier' is the target collection.
72404     * @return bool
72405     **/
72406    function link($parameter){}
72407
72408    /**
72409     * Locks an object for exclusive editing by the user calling this
72410     * function. The object can be only unlocked by this user or the system
72411     * user.
72412     *
72413     * @param array $parameter The parameter array contains the required
72414     *   element 'objectIdentifier' and the optional parameters 'mode' and
72415     *   'objectquery'. 'mode' determines how an object is locked.
72416     *   HW_API_LOCK_NORMAL means, an object is locked until it is unlocked.
72417     *   HW_API_LOCK_RECURSIVE is only valid for collection and locks all
72418     *   objects within the collection and possible subcollections.
72419     *   HW_API_LOCK_SESSION means, an object is locked only as long as the
72420     *   session is valid.
72421     * @return bool
72422     **/
72423    function lock($parameter){}
72424
72425    /**
72426     * Moves object between collections.
72427     *
72428     * @param array $parameter
72429     * @return bool
72430     **/
72431    function move($parameter){}
72432
72433    /**
72434     * This function retrieves the attribute information of an object of any
72435     * version. It will not return the document content.
72436     *
72437     * @param array $parameter The parameter array contains the required
72438     *   elements 'objectIdentifier' and the optional elements
72439     *   'attributeSelector' and 'version'.
72440     * @return hw_api_object
72441     **/
72442    function object($parameter){}
72443
72444    /**
72445     * This function retrieves an object the specified anchor belongs to.
72446     *
72447     * @param array $parameter The parameter array contains the required
72448     *   element 'objectIdentifier' and the optional element
72449     *   'attributeSelector'.
72450     * @return hw_api_object
72451     **/
72452    function objectbyanchor($parameter){}
72453
72454    /**
72455     * Retrieves the parents of an object. The parents can be further
72456     * filtered by specifying an object query.
72457     *
72458     * @param array $parameter The parameter array contains the required
72459     *   elements 'objectidentifier' and the optional elements
72460     *   'attributeselector' and 'objectquery'.
72461     * @return array
72462     **/
72463    function parents($parameter){}
72464
72465    /**
72466     * Removes an object from the specified parent. Collections will be
72467     * removed recursively.
72468     *
72469     * @param array $parameter You can pass an optional object query to
72470     *   remove only those objects which match the query. An object will be
72471     *   deleted physically if it is the last instance. The parameter array
72472     *   contains the required elements 'objectidentifier' and
72473     *   'parentidentifier'. If you want to remove a user or group
72474     *   'parentidentifier' can be skipped. The optional parameter 'mode'
72475     *   determines how the deletion is performed. In normal mode the object
72476     *   will not be removed physically until all instances are removed. In
72477     *   physical mode all instances of the object will be deleted
72478     *   immediately. In removelinks mode all references to and from the
72479     *   objects will be deleted as well. In nonrecursive the deletion is not
72480     *   performed recursive. Removing a collection which is not empty will
72481     *   cause an error.
72482     * @return bool
72483     **/
72484    function remove($parameter){}
72485
72486    /**
72487     * Replaces the attributes and the content of an object.
72488     *
72489     * @param array $parameter The parameter array contains the required
72490     *   elements 'objectIdentifier' and 'object' and the optional parameters
72491     *   'content', 'parameters', 'mode' and 'attributeSelector'.
72492     *   'objectIdentifier' contains the object to be replaced. 'object'
72493     *   contains the new object. 'content' contains the new content.
72494     *   'parameters' contain extra information for HTML documents.
72495     *   HTML_Language is the letter abbreviation of the language of the
72496     *   title. HTML_Base sets the base attribute of the HTML document.
72497     *   'mode' can be a combination of the following flags:
72498     *   HW_API_REPLACE_NORMAL The object on the server is replace with the
72499     *   object passed. HW_API_REPLACE_FORCE_VERSION_CONTROL
72500     *   HW_API_REPLACE_AUTOMATIC_CHECKOUT HW_API_REPLACE_AUTOMATIC_CHECKIN
72501     *   HW_API_REPLACE_PLAIN HW_API_REPLACE_REVERT_IF_NOT_CHANGED
72502     *   HW_API_REPLACE_KEEP_TIME_MODIFIED
72503     * @return hw_api_object
72504     **/
72505    function replace($parameter){}
72506
72507    /**
72508     * Commits a version of a document. The committed version is the one
72509     * which is visible to users with read access. By default the last
72510     * version is the committed version.
72511     *
72512     * @param array $parameter
72513     * @return hw_api_object
72514     **/
72515    function setcommittedversion($parameter){}
72516
72517    /**
72518     * Retrieves all source anchors of an object.
72519     *
72520     * @param array $parameter The parameter array contains the required
72521     *   element 'objectIdentifier' and the optional elements
72522     *   'attributeSelector' and 'objectQuery'.
72523     * @return array
72524     **/
72525    function srcanchors($parameter){}
72526
72527    /**
72528     * Retrieves all the source anchors pointing to the specified
72529     * destination. The destination object can either be a destination anchor
72530     * or a whole document.
72531     *
72532     * @param array $parameter The parameters array contains the required
72533     *   element 'objectIdentifier' and the optional element
72534     *   'attributeSelector' and 'objectQuery'. The function returns an array
72535     *   of objects or an error.
72536     * @return array
72537     **/
72538    function srcsofdst($parameter){}
72539
72540    /**
72541     * Unlocks a locked object. Only the user who has locked the object and
72542     * the system user may unlock an object.
72543     *
72544     * @param array $parameter The parameter array contains the required
72545     *   element 'objectIdentifier' and the optional parameters 'mode' and
72546     *   'objectquery'. The meaning of 'mode' is the same as in function
72547     *   {@link hwapi_lock}.
72548     * @return bool
72549     **/
72550    function unlock($parameter){}
72551
72552    /**
72553     * Returns the own user object.
72554     *
72555     * @param array $parameter
72556     * @return hw_api_object
72557     **/
72558    function user($parameter){}
72559
72560    /**
72561     * Returns a list of all logged in users.
72562     *
72563     * @param array $parameter
72564     * @return array
72565     **/
72566    function userlist($parameter){}
72567
72568}
72569class hw_api_attribute {
72570    /**
72571     * Returns the name of the attribute.
72572     *
72573     * @return string
72574     **/
72575    function key(){}
72576
72577    /**
72578     * Returns the value in the given language of the attribute.
72579     *
72580     * @param string $language
72581     * @return string
72582     **/
72583    function langdepvalue($language){}
72584
72585    /**
72586     * Gets the value of the attribute.
72587     *
72588     * @return string
72589     **/
72590    function value(){}
72591
72592    /**
72593     * Gets all values of the attribute.
72594     *
72595     * @return array
72596     **/
72597    function values(){}
72598
72599}
72600class hw_api_content {
72601    /**
72602     * Returns the mimetype of the content.
72603     *
72604     * @return string
72605     **/
72606    function mimetype(){}
72607
72608    /**
72609     * Reads {@link len} bytes from the content into the given buffer.
72610     *
72611     * @param string $buffer
72612     * @param int $len Number of bytes to read.
72613     * @return string
72614     **/
72615    function read($buffer, $len){}
72616
72617}
72618class hw_api_error {
72619    /**
72620     * Returns the number of error reasons.
72621     *
72622     * @return int
72623     **/
72624    function count(){}
72625
72626    /**
72627     * Returns the first error reason.
72628     *
72629     * @return HW_API_Reason
72630     **/
72631    function reason(){}
72632
72633}
72634class hw_api_object {
72635    /**
72636     * Clones the attributes of an object.
72637     *
72638     * @param array $parameter
72639     * @return bool
72640     **/
72641    function assign($parameter){}
72642
72643    /**
72644     * Checks whether an attribute is editable.
72645     *
72646     * @param array $parameter
72647     * @return bool
72648     **/
72649    function attreditable($parameter){}
72650
72651    /**
72652     * Returns the number of attributes.
72653     *
72654     * @param array $parameter
72655     * @return int
72656     **/
72657    function count($parameter){}
72658
72659    /**
72660     * Adds an attribute to the object.
72661     *
72662     * @param HW_API_Attribute $attribute
72663     * @return bool
72664     **/
72665    function insert($attribute){}
72666
72667    /**
72668     * Removes the attribute with the given name.
72669     *
72670     * @param string $name The attribute name.
72671     * @return bool
72672     **/
72673    function remove($name){}
72674
72675    /**
72676     * Returns the title attribute.
72677     *
72678     * @param array $parameter
72679     * @return string
72680     **/
72681    function title($parameter){}
72682
72683    /**
72684     * Returns value of an attribute.
72685     *
72686     * @param string $name The attribute name.
72687     * @return string
72688     **/
72689    function value($name){}
72690
72691}
72692class hw_api_reason {
72693    /**
72694     * Returns the description of a reason
72695     *
72696     * @return string
72697     **/
72698    function description(){}
72699
72700    /**
72701     * Returns the type of a reason.
72702     *
72703     * @return HW_API_Reason
72704     **/
72705    function type(){}
72706
72707}
72708/**
72709 * The Imagick class has the ability to hold and operate on multiple
72710 * images simultaneously. This is achieved through an internal stack.
72711 * There is always an internal pointer that points at the current image.
72712 * Some functions operate on all images in the Imagick class, but most
72713 * operate only on the current image in the internal stack. As a
72714 * convention, method names can contain the word Image to denote they
72715 * affect only the current image in the stack.
72716 *
72717 * Because there are so many methods, here is a handy list of methods,
72718 * somewhat reduced to their general purpose:
72719 **/
72720class Imagick implements Iterator, Traversable {
72721    /**
72722     * Adds an adaptive blur filter to image. The intensity of an adaptive
72723     * blur depends is dramatically decreased at edge of the image, whereas a
72724     * standard blur is uniform across the image.
72725     *
72726     * @param float $radius The radius of the Gaussian, in pixels, not
72727     *   counting the center pixel. Provide a value of 0 and the radius will
72728     *   be chosen automagically.
72729     * @param float $sigma The standard deviation of the Gaussian, in
72730     *   pixels.
72731     * @param int $channel
72732     * @return bool
72733     * @since PECL imagick 2.0.0
72734     **/
72735    function adaptiveBlurImage($radius, $sigma, $channel){}
72736
72737    /**
72738     * Adaptively resize image with data-dependent triangulation. Avoids
72739     * blurring across sharp color changes. Most useful when used to shrink
72740     * images slightly to a slightly smaller "web size"; may not look good
72741     * when a full-sized image is adaptively resized to a thumbnail.
72742     *
72743     * @param int $columns The number of columns in the scaled image.
72744     * @param int $rows The number of rows in the scaled image.
72745     * @param bool $bestfit Whether to fit the image inside a bounding box.
72746     * @return bool
72747     * @since PECL imagick 2.0.0
72748     **/
72749    function adaptiveResizeImage($columns, $rows, $bestfit){}
72750
72751    /**
72752     * Adaptively sharpen the image by sharpening more intensely near image
72753     * edges and less intensely far from edges.
72754     *
72755     * @param float $radius The radius of the Gaussian, in pixels, not
72756     *   counting the center pixel. Use 0 for auto-select.
72757     * @param float $sigma The standard deviation of the Gaussian, in
72758     *   pixels.
72759     * @param int $channel
72760     * @return bool
72761     * @since PECL imagick 2.0.0
72762     **/
72763    function adaptiveSharpenImage($radius, $sigma, $channel){}
72764
72765    /**
72766     * Selects an individual threshold for each pixel based on the range of
72767     * intensity values in its local neighborhood. This allows for
72768     * thresholding of an image whose global intensity histogram doesn't
72769     * contain distinctive peaks.
72770     *
72771     * @param int $width Width of the local neighborhood.
72772     * @param int $height Height of the local neighborhood.
72773     * @param int $offset The mean offset
72774     * @return bool
72775     * @since PECL imagick 2.0.0
72776     **/
72777    function adaptiveThresholdImage($width, $height, $offset){}
72778
72779    /**
72780     * Adds new image to Imagick object from the current position of the
72781     * source object. After the operation iterator position is moved at the
72782     * end of the list.
72783     *
72784     * @param Imagick $source The source Imagick object
72785     * @return bool
72786     * @since PECL imagick 2.0.0
72787     **/
72788    function addImage($source){}
72789
72790    /**
72791     * Adds random noise to the image.
72792     *
72793     * @param int $noise_type The type of the noise. Refer to this list of
72794     *   noise constants.
72795     * @param int $channel
72796     * @return bool
72797     * @since PECL imagick 2.0.0
72798     **/
72799    function addNoiseImage($noise_type, $channel){}
72800
72801    /**
72802     * Transforms an image as dictated by the affine matrix.
72803     *
72804     * @param ImagickDraw $matrix The affine matrix
72805     * @return bool
72806     * @since PECL imagick 2.0.0
72807     **/
72808    function affineTransformImage($matrix){}
72809
72810    /**
72811     * This method animates the image onto a local or remote X server. This
72812     * method is not available on Windows.
72813     *
72814     * @param string $x_server X server address
72815     * @return bool
72816     **/
72817    function animateImages($x_server){}
72818
72819    /**
72820     * Annotates an image with text.
72821     *
72822     * @param ImagickDraw $draw_settings The ImagickDraw object that
72823     *   contains settings for drawing the text
72824     * @param float $x Horizontal offset in pixels to the left of text
72825     * @param float $y Vertical offset in pixels to the baseline of text
72826     * @param float $angle The angle at which to write the text
72827     * @param string $text The string to draw
72828     * @return bool
72829     * @since PECL imagick 2.0.0
72830     **/
72831    function annotateImage($draw_settings, $x, $y, $angle, $text){}
72832
72833    /**
72834     * Append a set of images into one larger image.
72835     *
72836     * @param bool $stack The direction of the stack (top to bottom or
72837     *   bottom to top)
72838     * @return Imagick
72839     * @since PECL imagick 2.0.0
72840     **/
72841    function appendImages($stack){}
72842
72843    /**
72844     * Average a set of images.
72845     *
72846     * @return Imagick
72847     * @since PECL imagick 2.0.0
72848     **/
72849    function averageImages(){}
72850
72851    /**
72852     * Is like Imagick::thresholdImage() but forces all pixels below the
72853     * threshold into black while leaving all pixels above the threshold
72854     * unchanged.
72855     *
72856     * @param mixed $threshold The threshold below which everything turns
72857     *   black
72858     * @return bool
72859     * @since PECL imagick 2.0.0
72860     **/
72861    function blackThresholdImage($threshold){}
72862
72863    /**
72864     * Adds blur filter to image. Optional third parameter to blur a specific
72865     * channel.
72866     *
72867     * @param float $radius Blur radius
72868     * @param float $sigma Standard deviation
72869     * @param int $channel The Channeltype constant. When not supplied, all
72870     *   channels are blurred.
72871     * @return bool
72872     * @since PECL imagick 2.0.0
72873     **/
72874    function blurImage($radius, $sigma, $channel){}
72875
72876    /**
72877     * Surrounds the image with a border of the color defined by the
72878     * bordercolor ImagickPixel object.
72879     *
72880     * @param mixed $bordercolor ImagickPixel object or a string containing
72881     *   the border color
72882     * @param int $width Border width
72883     * @param int $height Border height
72884     * @return bool
72885     * @since PECL imagick 2.0.0
72886     **/
72887    function borderImage($bordercolor, $width, $height){}
72888
72889    /**
72890     * Simulates a charcoal drawing.
72891     *
72892     * @param float $radius The radius of the Gaussian, in pixels, not
72893     *   counting the center pixel
72894     * @param float $sigma The standard deviation of the Gaussian, in
72895     *   pixels
72896     * @return bool
72897     * @since PECL imagick 2.0.0
72898     **/
72899    function charcoalImage($radius, $sigma){}
72900
72901    /**
72902     * Removes a region of an image and collapses the image to occupy the
72903     * removed portion.
72904     *
72905     * @param int $width Width of the chopped area
72906     * @param int $height Height of the chopped area
72907     * @param int $x X origo of the chopped area
72908     * @param int $y Y origo of the chopped area
72909     * @return bool
72910     * @since PECL imagick 2.0.0
72911     **/
72912    function chopImage($width, $height, $x, $y){}
72913
72914    /**
72915     * Clears all resources associated to Imagick object
72916     *
72917     * @return bool
72918     * @since PECL imagick 2.0.0
72919     **/
72920    function clear(){}
72921
72922    /**
72923     * Clips along the first path from the 8BIM profile, if present.
72924     *
72925     * @return bool
72926     * @since PECL imagick 2.0.0
72927     **/
72928    function clipImage(){}
72929
72930    /**
72931     * Clips along the named paths from the 8BIM profile, if present. Later
72932     * operations take effect inside the path. It may be a number if preceded
72933     * with #, to work on a numbered path, e.g., "#1" to use the first path.
72934     *
72935     * @param string $pathname The name of the path
72936     * @param bool $inside If later operations take effect inside clipping
72937     *   path. Otherwise later operations take effect outside clipping path.
72938     * @return bool
72939     * @since PECL imagick 2.0.0
72940     **/
72941    function clipPathImage($pathname, $inside){}
72942
72943    /**
72944     * Replaces colors in the image from a color lookup table. Optional
72945     * second parameter to replace colors in a specific channel.
72946     *
72947     * @param Imagick $lookup_table Imagick object containing the color
72948     *   lookup table
72949     * @param float $channel The Channeltype constant. When not supplied,
72950     *   default channels are replaced.
72951     * @return bool
72952     * @since PECL imagick 2.0.0
72953     **/
72954    function clutImage($lookup_table, $channel){}
72955
72956    /**
72957     * Composites a set of images while respecting any page offsets and
72958     * disposal methods. GIF, MIFF, and MNG animation sequences typically
72959     * start with an image background and each subsequent image varies in
72960     * size and offset. Returns a new Imagick object where each image in the
72961     * sequence is the same size as the first and composited with the next
72962     * image in the sequence.
72963     *
72964     * @return Imagick
72965     * @since PECL imagick 2.0.0
72966     **/
72967    function coalesceImages(){}
72968
72969    /**
72970     * Changes the color value of any pixel that matches target and is an
72971     * immediate neighbor.
72972     *
72973     * @param mixed $fill ImagickPixel object containing the fill color
72974     * @param float $fuzz The amount of fuzz. For example, set fuzz to 10
72975     *   and the color red at intensities of 100 and 102 respectively are now
72976     *   interpreted as the same color for the purposes of the floodfill.
72977     * @param mixed $bordercolor ImagickPixel object containing the border
72978     *   color
72979     * @param int $x X start position of the floodfill
72980     * @param int $y Y start position of the floodfill
72981     * @return bool
72982     * @since PECL imagick 2.0.0
72983     **/
72984    function colorFloodfillImage($fill, $fuzz, $bordercolor, $x, $y){}
72985
72986    /**
72987     * Blends the fill color with each pixel in the image.
72988     *
72989     * @param mixed $colorize ImagickPixel object or a string containing
72990     *   the colorize color
72991     * @param mixed $opacity ImagickPixel object or an float containing the
72992     *   opacity value. 1.0 is fully opaque and 0.0 is fully transparent.
72993     * @return bool
72994     * @since PECL imagick 2.0.0
72995     **/
72996    function colorizeImage($colorize, $opacity){}
72997
72998    /**
72999     * Combines one or more images into a single image. The grayscale value
73000     * of the pixels of each image in the sequence is assigned in order to
73001     * the specified channels of the combined image. The typical ordering
73002     * would be image 1 => Red, 2 => Green, 3 => Blue, etc.
73003     *
73004     * @param int $channelType Provide any channel constant that is valid
73005     *   for your channel mode. To apply to more than one channel, combine
73006     *   channeltype constants using bitwise operators. Refer to this list of
73007     *   channel constants.
73008     * @return Imagick
73009     * @since PECL imagick 2.0.0
73010     **/
73011    function combineImages($channelType){}
73012
73013    /**
73014     * Adds a comment to your image.
73015     *
73016     * @param string $comment The comment to add
73017     * @return bool
73018     * @since PECL imagick 2.0.0
73019     **/
73020    function commentImage($comment){}
73021
73022    /**
73023     * Compares one or more images and returns the difference image.
73024     *
73025     * @param Imagick $image Imagick object containing the image to
73026     *   compare.
73027     * @param int $channelType Provide any channel constant that is valid
73028     *   for your channel mode. To apply to more than one channel, combine
73029     *   channeltype constants using bitwise operators. Refer to this list of
73030     *   channel constants.
73031     * @param int $metricType One of the metric type constants.
73032     * @return array
73033     * @since PECL imagick 2.0.0
73034     **/
73035    function compareImageChannels($image, $channelType, $metricType){}
73036
73037    /**
73038     * Compares each image with the next in a sequence and returns the
73039     * maximum bounding region of any pixel differences it discovers.
73040     *
73041     * @param int $method One of the layer method constants.
73042     * @return Imagick
73043     * @since PECL imagick 2.0.0
73044     **/
73045    function compareImageLayers($method){}
73046
73047    /**
73048     * Returns an array containing a reconstructed image and the difference
73049     * between images.
73050     *
73051     * @param Imagick $compare An image to compare to.
73052     * @param int $metric Provide a valid metric type constant. Refer to
73053     *   this list of metric constants.
73054     * @return array
73055     * @since PECL imagick 2.0.0
73056     **/
73057    function compareImages($compare, $metric){}
73058
73059    /**
73060     * Composite one image onto another at the specified offset.
73061     *
73062     * @param Imagick $composite_object Imagick object which holds the
73063     *   composite image
73064     * @param int $composite Composite operator. See Composite Operator
73065     *   Constants
73066     * @param int $x The column offset of the composited image
73067     * @param int $y The row offset of the composited image
73068     * @param int $channel Provide any channel constant that is valid for
73069     *   your channel mode. To apply to more than one channel, combine
73070     *   channeltype constants using bitwise operators. Refer to this list of
73071     *   channel constants.
73072     * @return bool
73073     * @since PECL imagick 2.0.0
73074     **/
73075    function compositeImage($composite_object, $composite, $x, $y, $channel){}
73076
73077    /**
73078     * Enhances the intensity differences between the lighter and darker
73079     * elements of the image. Set sharpen to a value other than 0 to increase
73080     * the image contrast otherwise the contrast is reduced.
73081     *
73082     * @param bool $sharpen The sharpen value
73083     * @return bool
73084     * @since PECL imagick 2.0.0
73085     **/
73086    function contrastImage($sharpen){}
73087
73088    /**
73089     * Enhances the contrast of a color image by adjusting the pixels color
73090     * to span the entire range of colors available.
73091     *
73092     * @param float $black_point The black point.
73093     * @param float $white_point The white point.
73094     * @param int $channel Provide any channel constant that is valid for
73095     *   your channel mode. To apply to more than one channel, combine
73096     *   channeltype constants using bitwise operators. Imagick::CHANNEL_ALL.
73097     *   Refer to this list of channel constants.
73098     * @return bool
73099     * @since PECL imagick 2.0.0
73100     **/
73101    function contrastStretchImage($black_point, $white_point, $channel){}
73102
73103    /**
73104     * Applies a custom convolution kernel to the image.
73105     *
73106     * @param array $kernel The convolution kernel
73107     * @param int $channel Provide any channel constant that is valid for
73108     *   your channel mode. To apply to more than one channel, combine
73109     *   channeltype constants using bitwise operators. Refer to this list of
73110     *   channel constants.
73111     * @return bool
73112     * @since PECL imagick 2.0.0
73113     **/
73114    function convolveImage($kernel, $channel){}
73115
73116    /**
73117     * Extracts a region of the image.
73118     *
73119     * @param int $width The width of the crop
73120     * @param int $height The height of the crop
73121     * @param int $x The X coordinate of the cropped region's top left
73122     *   corner
73123     * @param int $y The Y coordinate of the cropped region's top left
73124     *   corner
73125     * @return bool
73126     * @since PECL imagick 2.0.0
73127     **/
73128    function cropImage($width, $height, $x, $y){}
73129
73130    /**
73131     * Creates a fixed size thumbnail by first scaling the image up or down
73132     * and cropping a specified area from the center.
73133     *
73134     * @param int $width The width of the thumbnail
73135     * @param int $height The Height of the thumbnail
73136     * @return bool
73137     * @since PECL imagick 2.0.0
73138     **/
73139    function cropThumbnailImage($width, $height){}
73140
73141    /**
73142     * Returns reference to the current imagick object with image pointer at
73143     * the correct sequence.
73144     *
73145     * @return Imagick
73146     * @since PECL imagick 2.0.0
73147     **/
73148    function current(){}
73149
73150    /**
73151     * Displaces an image's colormap by a given number of positions. If you
73152     * cycle the colormap a number of times you can produce a psychedelic
73153     * effect.
73154     *
73155     * @param int $displace The amount to displace the colormap.
73156     * @return bool
73157     * @since PECL imagick 2.0.0
73158     **/
73159    function cycleColormapImage($displace){}
73160
73161    /**
73162     * Deciphers image that has been enciphered before. The image must be
73163     * enciphered using {@link Imagick::encipherImage}.
73164     *
73165     * @param string $passphrase The passphrase
73166     * @return bool
73167     **/
73168    function decipherImage($passphrase){}
73169
73170    /**
73171     * Compares each image with the next in a sequence and returns the
73172     * maximum bounding region of any pixel differences it discovers.
73173     *
73174     * @return Imagick
73175     * @since PECL imagick 2.0.0
73176     **/
73177    function deconstructImages(){}
73178
73179    /**
73180     * This method can be used to remove skew from for example scanned images
73181     * where the paper was not properly placed on the scanning surface.
73182     *
73183     * @param float $threshold Deskew threshold
73184     * @return void
73185     **/
73186    function deskewImage($threshold){}
73187
73188    /**
73189     * Reduces the speckle noise in an image while preserving the edges of
73190     * the original image.
73191     *
73192     * @return bool
73193     * @since PECL imagick 2.0.0
73194     **/
73195    function despeckleImage(){}
73196
73197    /**
73198     * Destroys the Imagick object and frees all resources associated with
73199     * it.
73200     *
73201     * @return bool
73202     * @since PECL imagick 2.0.0
73203     **/
73204    function destroy(){}
73205
73206    /**
73207     * This method displays an image on a X server.
73208     *
73209     * @param string $servername The X server name
73210     * @return bool
73211     * @since PECL imagick 2.0.0
73212     **/
73213    function displayImage($servername){}
73214
73215    /**
73216     * Displays an image or image sequence on a X server.
73217     *
73218     * @param string $servername The X server name
73219     * @return bool
73220     * @since PECL imagick 2.0.0
73221     **/
73222    function displayImages($servername){}
73223
73224    /**
73225     * Distorts an image using various distortion methods, by mapping color
73226     * lookups of the source image to a new destination image usually of the
73227     * same size as the source image, unless 'bestfit' is set to .
73228     *
73229     * If 'bestfit' is enabled, and distortion allows it, the destination
73230     * image is adjusted to ensure the whole source 'image' will just fit
73231     * within the final destination image, which will be sized and offset
73232     * accordingly. Also in many cases the virtual offset of the source image
73233     * will be taken into account in the mapping.
73234     *
73235     * @param int $method The method of image distortion. See distortion
73236     *   constants
73237     * @param array $arguments The arguments for this distortion method
73238     * @param bool $bestfit Attempt to resize destination to fit distorted
73239     *   source
73240     * @return bool
73241     * @since PECL imagick 2.0.1
73242     **/
73243    function distortImage($method, $arguments, $bestfit){}
73244
73245    /**
73246     * Renders the ImagickDraw object on the current image.
73247     *
73248     * @param ImagickDraw $draw The drawing operations to render on the
73249     *   image.
73250     * @return bool
73251     * @since PECL imagick 2.0.0
73252     **/
73253    function drawImage($draw){}
73254
73255    /**
73256     * Enhance edges within the image with a convolution filter of the given
73257     * radius. Use radius 0 and it will be auto-selected.
73258     *
73259     * @param float $radius The radius of the operation.
73260     * @return bool
73261     * @since PECL imagick 2.0.0
73262     **/
73263    function edgeImage($radius){}
73264
73265    /**
73266     * Returns a grayscale image with a three-dimensional effect. We convolve
73267     * the image with a Gaussian operator of the given radius and standard
73268     * deviation (sigma). For reasonable results, radius should be larger
73269     * than sigma. Use a radius of 0 and it will choose a suitable radius for
73270     * you.
73271     *
73272     * @param float $radius The radius of the effect
73273     * @param float $sigma The sigma of the effect
73274     * @return bool
73275     * @since PECL imagick 2.0.0
73276     **/
73277    function embossImage($radius, $sigma){}
73278
73279    /**
73280     * Converts plain pixels to enciphered pixels. The image is not readable
73281     * until it has been deciphered using {@link Imagick::decipherImage}
73282     *
73283     * @param string $passphrase The passphrase
73284     * @return bool
73285     **/
73286    function encipherImage($passphrase){}
73287
73288    /**
73289     * Applies a digital filter that improves the quality of a noisy image.
73290     *
73291     * @return bool
73292     * @since PECL imagick 2.0.0
73293     **/
73294    function enhanceImage(){}
73295
73296    /**
73297     * Equalizes the image histogram.
73298     *
73299     * @return bool
73300     * @since PECL imagick 2.0.0
73301     **/
73302    function equalizeImage(){}
73303
73304    /**
73305     * Applys an arithmetic, relational, or logical expression to an image.
73306     * Use these operators to lighten or darken an image, to increase or
73307     * decrease contrast in an image, or to produce the "negative" of an
73308     * image.
73309     *
73310     * @param int $op The operator
73311     * @param float $constant The value of the operator
73312     * @param int $channel Provide any channel constant that is valid for
73313     *   your channel mode. To apply to more than one channel, combine
73314     *   channeltype constants using bitwise operators. Refer to this list of
73315     *   channel constants.
73316     * @return bool
73317     * @since PECL imagick 2.0.0
73318     **/
73319    function evaluateImage($op, $constant, $channel){}
73320
73321    /**
73322     * Exports image pixels into an array. The map defines the ordering of
73323     * the exported pixels. The size of the returned array is width * height
73324     * * strlen(map).
73325     *
73326     * @param int $x X-coordinate of the exported area
73327     * @param int $y Y-coordinate of the exported area
73328     * @param int $width Width of the exported aread
73329     * @param int $height Height of the exported area
73330     * @param string $map Ordering of the exported pixels. For example
73331     *   "RGB". Valid characters for the map are R, G, B, A, O, C, Y, M, K, I
73332     *   and P.
73333     * @param int $STORAGE Refer to this list of pixel type constants
73334     * @return array
73335     **/
73336    function exportImagePixels($x, $y, $width, $height, $map, $STORAGE){}
73337
73338    /**
73339     * Comfortability method for setting image size. The method sets the
73340     * image size and allows setting x,y coordinates where the new area
73341     * begins.
73342     *
73343     * @param int $width The new width
73344     * @param int $height The new height
73345     * @param int $x X position for the new size
73346     * @param int $y Y position for the new size
73347     * @return bool
73348     **/
73349    function extentImage($width, $height, $x, $y){}
73350
73351    /**
73352     * Merges a sequence of images. This is useful for combining Photoshop
73353     * layers into a single image.
73354     *
73355     * @return Imagick
73356     * @since PECL imagick 2.0.0
73357     **/
73358    function flattenImages(){}
73359
73360    /**
73361     * Creates a vertical mirror image by reflecting the pixels around the
73362     * central x-axis.
73363     *
73364     * @return bool
73365     * @since PECL imagick 2.0.0
73366     **/
73367    function flipImage(){}
73368
73369    /**
73370     * Changes the color value of any pixel that matches target and is an
73371     * immediate neighbor. This method is a replacement for deprecated {@link
73372     * Imagick::paintFloodFillImage}.
73373     *
73374     * @param mixed $fill ImagickPixel object or a string containing the
73375     *   fill color
73376     * @param float $fuzz
73377     * @param mixed $target ImagickPixel object or a string containing the
73378     *   target color to paint
73379     * @param int $x X start position of the floodfill
73380     * @param int $y Y start position of the floodfill
73381     * @param bool $invert If paints any pixel that does not match the
73382     *   target color.
73383     * @param int $channel
73384     * @return bool
73385     **/
73386    function floodFillPaintImage($fill, $fuzz, $target, $x, $y, $invert, $channel){}
73387
73388    /**
73389     * Creates a horizontal mirror image by reflecting the pixels around the
73390     * central y-axis.
73391     *
73392     * @return bool
73393     * @since PECL imagick 2.0.0
73394     **/
73395    function flopImage(){}
73396
73397    /**
73398     * Adds a simulated three-dimensional border around the image. The width
73399     * and height specify the border width of the vertical and horizontal
73400     * sides of the frame. The inner and outer bevels indicate the width of
73401     * the inner and outer shadows of the frame.
73402     *
73403     * @param mixed $matte_color ImagickPixel object or a string
73404     *   representing the matte color
73405     * @param int $width The width of the border
73406     * @param int $height The height of the border
73407     * @param int $inner_bevel The inner bevel width
73408     * @param int $outer_bevel The outer bevel width
73409     * @return bool
73410     * @since PECL imagick 2.0.0
73411     **/
73412    function frameImage($matte_color, $width, $height, $inner_bevel, $outer_bevel){}
73413
73414    /**
73415     * Applies an arithmetic, relational, or logical expression to an image.
73416     * Use these operators to create lighter or darker versions of an image,
73417     * to increase or decrease contrast in an image, or to negate the image
73418     * colors.
73419     *
73420     * @param integer $function Refer to this list of function constants
73421     * @param array $arguments Array of arguments to pass to this function.
73422     * @return boolean
73423     **/
73424    function functionImage($function, $arguments){}
73425
73426    /**
73427     * Evaluate expression for each pixel in the image. Consult The Fx
73428     * Special Effects Image Operator for more information.
73429     *
73430     * @param string $expression The expression.
73431     * @param int $channel Provide any channel constant that is valid for
73432     *   your channel mode. To apply to more than one channel, combine
73433     *   channeltype constants using bitwise operators. Refer to this list of
73434     *   channel constants.
73435     * @return Imagick
73436     * @since PECL imagick 2.0.0
73437     **/
73438    function fxImage($expression, $channel){}
73439
73440    /**
73441     * Gamma-corrects an image. The same image viewed on different devices
73442     * will have perceptual differences in the way the image's intensities
73443     * are represented on the screen. Specify individual gamma levels for the
73444     * red, green, and blue channels, or adjust all three with the gamma
73445     * parameter. Values typically range from 0.8 to 2.3.
73446     *
73447     * @param float $gamma The amount of gamma-correction.
73448     * @param int $channel Provide any channel constant that is valid for
73449     *   your channel mode. To apply to more than one channel, combine
73450     *   channeltype constants using bitwise operators. Refer to this list of
73451     *   channel constants.
73452     * @return bool
73453     * @since PECL imagick 2.0.0
73454     **/
73455    function gammaImage($gamma, $channel){}
73456
73457    /**
73458     * Blurs an image. We convolve the image with a Gaussian operator of the
73459     * given radius and standard deviation (sigma). For reasonable results,
73460     * the radius should be larger than sigma. Use a radius of 0 and selects
73461     * a suitable radius for you.
73462     *
73463     * @param float $radius The radius of the Gaussian, in pixels, not
73464     *   counting the center pixel.
73465     * @param float $sigma The standard deviation of the Gaussian, in
73466     *   pixels.
73467     * @param int $channel Provide any channel constant that is valid for
73468     *   your channel mode. To apply to more than one channel, combine
73469     *   channeltype constants using bitwise operators. Refer to this list of
73470     *   channel constants.
73471     * @return bool
73472     * @since PECL imagick 2.0.0
73473     **/
73474    function gaussianBlurImage($radius, $sigma, $channel){}
73475
73476    /**
73477     * Gets the object compression type.
73478     *
73479     * @return int
73480     * @since PECL imagick 2.0.0
73481     **/
73482    function getCompression(){}
73483
73484    /**
73485     * Gets the object compression quality.
73486     *
73487     * @return int
73488     * @since PECL imagick 2.0.0
73489     **/
73490    function getCompressionQuality(){}
73491
73492    /**
73493     * Returns the ImageMagick API copyright as a string.
73494     *
73495     * @return string
73496     * @since PECL imagick 2.0.0
73497     **/
73498    function getCopyright(){}
73499
73500    /**
73501     * Returns the filename associated with an image sequence.
73502     *
73503     * @return string
73504     * @since PECL imagick 2.0.0
73505     **/
73506    function getFilename(){}
73507
73508    /**
73509     * Returns the objects font property.
73510     *
73511     * @return string
73512     * @since PECL imagick 2.1.0
73513     **/
73514    function getFont(){}
73515
73516    /**
73517     * Returns the format of the Imagick object.
73518     *
73519     * @return string
73520     * @since PECL imagick 2.0.0
73521     **/
73522    function getFormat(){}
73523
73524    /**
73525     * Gets the global gravity property for the Imagick object.
73526     *
73527     * @return bool
73528     **/
73529    function getGravity(){}
73530
73531    /**
73532     * Returns the ImageMagick home URL.
73533     *
73534     * @return string
73535     * @since PECL imagick 2.0.0
73536     **/
73537    function getHomeURL(){}
73538
73539    /**
73540     * Returns a new Imagick object with the current image sequence.
73541     *
73542     * @return Imagick
73543     * @since PECL imagick 2.0.0
73544     **/
73545    function getImage(){}
73546
73547    /**
73548     * Gets the image alpha channel value. The returned value is one of the
73549     * alpha channel constants.
73550     *
73551     * @return int
73552     **/
73553    function getImageAlphaChannel(){}
73554
73555    /**
73556     * Returns the image background color.
73557     *
73558     * @return ImagickPixel
73559     * @since PECL imagick 2.0.0
73560     **/
73561    function getImageBackgroundColor(){}
73562
73563    /**
73564     * Implements direct to memory image formats. It returns the image
73565     * sequence as a string. The format of the image determines the format of
73566     * the returned blob (GIF, JPEG, PNG, etc.). To return a different image
73567     * format, use Imagick::setImageFormat().
73568     *
73569     * @return string
73570     * @since PECL imagick 2.0.0
73571     **/
73572    function getImageBlob(){}
73573
73574    /**
73575     * Returns the chromaticity blue primary point for the image.
73576     *
73577     * @param float $x The chromaticity blue primary x-point.
73578     * @param float $y The chromaticity blue primary y-point.
73579     * @return array
73580     * @since PECL imagick 2.0.0
73581     **/
73582    function getImageBluePrimary($x, $y){}
73583
73584    /**
73585     * Returns the image border color.
73586     *
73587     * @return ImagickPixel
73588     * @since PECL imagick 2.0.0
73589     **/
73590    function getImageBorderColor(){}
73591
73592    /**
73593     * Gets the depth for a particular image channel.
73594     *
73595     * @param int $channel
73596     * @return int
73597     * @since PECL imagick 2.0.0
73598     **/
73599    function getImageChannelDepth($channel){}
73600
73601    /**
73602     * Compares one or more image channels of an image to a reconstructed
73603     * image and returns the specified distortion metric.
73604     *
73605     * @param Imagick $reference Imagick object to compare to.
73606     * @param int $channel Provide any channel constant that is valid for
73607     *   your channel mode. To apply to more than one channel, combine
73608     *   channeltype constants using bitwise operators. Refer to this list of
73609     *   channel constants.
73610     * @param int $metric One of the metric type constants.
73611     * @return float
73612     * @since PECL imagick 2.0.0
73613     **/
73614    function getImageChannelDistortion($reference, $channel, $metric){}
73615
73616    /**
73617     * Compares one or more image channels of an image to a reconstructed
73618     * image and returns the specified distortion metrics
73619     *
73620     * @param Imagick $reference Imagick object containing the reference
73621     *   image
73622     * @param int $metric Refer to this list of metric type constants.
73623     * @param int $channel
73624     * @return double
73625     **/
73626    function getImageChannelDistortions($reference, $metric, $channel){}
73627
73628    /**
73629     * Gets the extrema for one or more image channels. Return value is an
73630     * associative array with the keys "minima" and "maxima".
73631     *
73632     * @param int $channel Provide any channel constant that is valid for
73633     *   your channel mode. To apply to more than one channel, combine
73634     *   channeltype constants using bitwise operators. Refer to this list of
73635     *   channel constants.
73636     * @return array
73637     * @since PECL imagick 2.0.0
73638     **/
73639    function getImageChannelExtrema($channel){}
73640
73641    /**
73642     * Get the kurtosis and skewness of a specific channel.
73643     *
73644     * @param int $channel
73645     * @return array
73646     **/
73647    function getImageChannelKurtosis($channel){}
73648
73649    /**
73650     * Gets the mean and standard deviation of one or more image channels.
73651     * Return value is an associative array with the keys "mean" and
73652     * "standardDeviation".
73653     *
73654     * @param int $channel Provide any channel constant that is valid for
73655     *   your channel mode. To apply to more than one channel, combine
73656     *   channeltype constants using bitwise operators. Refer to this list of
73657     *   channel constants.
73658     * @return array
73659     * @since PECL imagick 2.0.0
73660     **/
73661    function getImageChannelMean($channel){}
73662
73663    /**
73664     * Gets the range for one or more image channels.
73665     *
73666     * @param int $channel
73667     * @return bool
73668     * @since PECL imagick 2.2.1
73669     **/
73670    function getImageChannelRange($channel){}
73671
73672    /**
73673     * Returns statistics for each channel in the image. The statistics
73674     * include the channel depth, its minima and maxima, the mean, and the
73675     * standard deviation. You can access the red channel mean, for example,
73676     * like this:
73677     *
73678     * @return array
73679     * @since PECL imagick 2.0.0
73680     **/
73681    function getImageChannelStatistics(){}
73682
73683    /**
73684     * Returns the image clip mask. The clip mask is an Imagick object
73685     * containing the clip mask.
73686     *
73687     * @return Imagick
73688     **/
73689    function getImageClipMask(){}
73690
73691    /**
73692     * Returns the color of the specified colormap index.
73693     *
73694     * @param int $index The offset into the image colormap.
73695     * @return ImagickPixel
73696     * @since PECL imagick 2.0.0
73697     **/
73698    function getImageColormapColor($index){}
73699
73700    /**
73701     * Gets the number of unique colors in the image.
73702     *
73703     * @return int
73704     * @since PECL imagick 2.0.0
73705     **/
73706    function getImageColors(){}
73707
73708    /**
73709     * Gets the image colorspace.
73710     *
73711     * @return int
73712     * @since PECL imagick 2.0.0
73713     **/
73714    function getImageColorspace(){}
73715
73716    /**
73717     * Returns the composite operator associated with the image.
73718     *
73719     * @return int
73720     * @since PECL imagick 2.0.0
73721     **/
73722    function getImageCompose(){}
73723
73724    /**
73725     * Gets the current image's compression type.
73726     *
73727     * @return int
73728     * @since PECL imagick 2.2.2
73729     **/
73730    function getImageCompression(){}
73731
73732    /**
73733     * Gets the image delay.
73734     *
73735     * @return int
73736     * @since PECL imagick 2.0.0
73737     **/
73738    function getImageDelay(){}
73739
73740    /**
73741     * Gets the image depth.
73742     *
73743     * @return int
73744     **/
73745    function getImageDepth(){}
73746
73747    /**
73748     * Gets the image disposal method.
73749     *
73750     * @return int
73751     * @since PECL imagick 2.0.0
73752     **/
73753    function getImageDispose(){}
73754
73755    /**
73756     * Compares an image to a reconstructed image and returns the specified
73757     * distortion metric.
73758     *
73759     * @param MagickWand $reference Imagick object to compare to.
73760     * @param int $metric One of the metric type constants.
73761     * @return float
73762     * @since PECL imagick 2.0.0
73763     **/
73764    function getImageDistortion($reference, $metric){}
73765
73766    /**
73767     * Gets the extrema for the image. Returns an associative array with the
73768     * keys "min" and "max".
73769     *
73770     * @return array
73771     * @since PECL imagick 2.0.0
73772     **/
73773    function getImageExtrema(){}
73774
73775    /**
73776     * Returns the filename of a particular image in a sequence.
73777     *
73778     * @return string
73779     * @since PECL imagick 2.0.0
73780     **/
73781    function getImageFilename(){}
73782
73783    /**
73784     * Returns the format of a particular image in a sequence.
73785     *
73786     * @return string
73787     * @since PECL imagick 2.0.0
73788     **/
73789    function getImageFormat(){}
73790
73791    /**
73792     * Gets the image gamma.
73793     *
73794     * @return float
73795     * @since PECL imagick 2.0.0
73796     **/
73797    function getImageGamma(){}
73798
73799    /**
73800     * Returns the width and height as an associative array.
73801     *
73802     * @return array
73803     * @since PECL imagick 2.0.0
73804     **/
73805    function getImageGeometry(){}
73806
73807    /**
73808     * Gets the current gravity value of the image. Unlike {@link
73809     * Imagick::getGravity}, this method returns the gravity defined for the
73810     * current image sequence.
73811     *
73812     * @return bool
73813     **/
73814    function getImageGravity(){}
73815
73816    /**
73817     * Returns the chromaticity green primary point. Returns an array with
73818     * the keys "x" and "y".
73819     *
73820     * @return array
73821     * @since PECL imagick 2.0.0
73822     **/
73823    function getImageGreenPrimary(){}
73824
73825    /**
73826     * Returns the image height.
73827     *
73828     * @return int
73829     * @since PECL imagick 2.0.0
73830     **/
73831    function getImageHeight(){}
73832
73833    /**
73834     * Returns the image histogram as an array of ImagickPixel objects.
73835     *
73836     * @return array
73837     * @since PECL imagick 2.0.0
73838     **/
73839    function getImageHistogram(){}
73840
73841    /**
73842     * Returns the index of the current active image within the Imagick
73843     * object. This method has been deprecated. See Imagick::getIteratorIndex
73844     *
73845     * @return int
73846     * @since PECL imagick 2.0.0
73847     **/
73848    function getImageIndex(){}
73849
73850    /**
73851     * Gets the image interlace scheme.
73852     *
73853     * @return int
73854     * @since PECL imagick 2.0.0
73855     **/
73856    function getImageInterlaceScheme(){}
73857
73858    /**
73859     * Returns the interpolation method for the specified image. The method
73860     * is one of the Imagick::INTERPOLATE_* constants.
73861     *
73862     * @return int
73863     * @since PECL imagick 2.0.0
73864     **/
73865    function getImageInterpolateMethod(){}
73866
73867    /**
73868     * Gets the image iterations.
73869     *
73870     * @return int
73871     * @since PECL imagick 2.0.0
73872     **/
73873    function getImageIterations(){}
73874
73875    /**
73876     * Returns the image length in bytes
73877     *
73878     * @return int
73879     * @since PECL imagick 2.0.0
73880     **/
73881    function getImageLength(){}
73882
73883    /**
73884     * Returns a string containing the ImageMagick license
73885     *
73886     * @return string
73887     * @since PECL imagick 2.0.0
73888     **/
73889    function getImageMagickLicense(){}
73890
73891    /**
73892     * Returns if the image has a matte channel otherwise false.
73893     *
73894     * @return int
73895     * @since PECL imagick 2.0.0
73896     **/
73897    function getImageMatte(){}
73898
73899    /**
73900     * Returns the image matte color.
73901     *
73902     * @return ImagickPixel
73903     * @since PECL imagick 2.0.0
73904     **/
73905    function getImageMatteColor(){}
73906
73907    /**
73908     * Gets the image orientation. The return value is one of the orientation
73909     * constants.
73910     *
73911     * @return int
73912     * @since PECL imagick 2.0.0
73913     **/
73914    function getImageOrientation(){}
73915
73916    /**
73917     * Returns the page geometry associated with the image in an array with
73918     * the keys "width", "height", "x", and "y".
73919     *
73920     * @return array
73921     * @since PECL imagick 2.0.0
73922     **/
73923    function getImagePage(){}
73924
73925    /**
73926     * Returns the color of the specified pixel.
73927     *
73928     * @param int $x The x-coordinate of the pixel
73929     * @param int $y The y-coordinate of the pixel
73930     * @return ImagickPixel
73931     * @since PECL imagick 2.0.0
73932     **/
73933    function getImagePixelColor($x, $y){}
73934
73935    /**
73936     * Returns the named image profile.
73937     *
73938     * @param string $name The name of the profile to return.
73939     * @return string
73940     * @since PECL imagick 2.0.0
73941     **/
73942    function getImageProfile($name){}
73943
73944    /**
73945     * Returns all associated profiles that match the pattern. If is passed
73946     * as second parameter only the profile names are returned.
73947     *
73948     * @param string $pattern The pattern for profile names.
73949     * @param bool $only_names Whether to return only profile names. If
73950     *   then values are returned as well
73951     * @return array
73952     * @since PECL imagick 2.0.0
73953     **/
73954    function getImageProfiles($pattern, $only_names){}
73955
73956    /**
73957     * Returns all associated properties that match the pattern. If is passed
73958     * as second parameter only the property names are returned.
73959     *
73960     * @param string $pattern The pattern for property names.
73961     * @param bool $only_names Whether to return only property names. If
73962     *   then also the values are returned
73963     * @return array
73964     * @since PECL imagick 2.0.0
73965     **/
73966    function getImageProperties($pattern, $only_names){}
73967
73968    /**
73969     * Returns the named image property.
73970     *
73971     * @param string $name name of the property (for example Exif:DateTime)
73972     * @return string
73973     * @since PECL imagick 2.0.0
73974     **/
73975    function getImageProperty($name){}
73976
73977    /**
73978     * Returns the chromaticity red primary point as an array with the keys
73979     * "x" and "y".
73980     *
73981     * @return array
73982     * @since PECL imagick 2.0.0
73983     **/
73984    function getImageRedPrimary(){}
73985
73986    /**
73987     * Extracts a region of the image and returns it as a new Imagick object.
73988     *
73989     * @param int $width The width of the extracted region.
73990     * @param int $height The height of the extracted region.
73991     * @param int $x X-coordinate of the top-left corner of the extracted
73992     *   region.
73993     * @param int $y Y-coordinate of the top-left corner of the extracted
73994     *   region.
73995     * @return Imagick
73996     * @since PECL imagick 2.0.0
73997     **/
73998    function getImageRegion($width, $height, $x, $y){}
73999
74000    /**
74001     * Gets the image rendering intent.
74002     *
74003     * @return int
74004     * @since PECL imagick 2.0.0
74005     **/
74006    function getImageRenderingIntent(){}
74007
74008    /**
74009     * Gets the image X and Y resolution.
74010     *
74011     * @return array
74012     * @since PECL imagick 2.0.0
74013     **/
74014    function getImageResolution(){}
74015
74016    /**
74017     * Implements direct to memory image formats. It returns all image
74018     * sequences as a string. The format of the image determines the format
74019     * of the returned blob (GIF, JPEG, PNG, etc.). To return a different
74020     * image format, use Imagick::setImageFormat().
74021     *
74022     * @return string
74023     * @since PECL imagick 2.0.0
74024     **/
74025    function getImagesBlob(){}
74026
74027    /**
74028     * Gets the image scene.
74029     *
74030     * @return int
74031     * @since PECL imagick 2.0.0
74032     **/
74033    function getImageScene(){}
74034
74035    /**
74036     * Generates an SHA-256 message digest for the image pixel stream.
74037     *
74038     * @return string
74039     * @since PECL imagick 2.0.0
74040     **/
74041    function getImageSignature(){}
74042
74043    /**
74044     * Returns the image length in bytes
74045     *
74046     * @return int
74047     * @since PECL imagick 2.0.0
74048     **/
74049    function getImageSize(){}
74050
74051    /**
74052     * Gets the image ticks-per-second.
74053     *
74054     * @return int
74055     * @since PECL imagick 2.0.0
74056     **/
74057    function getImageTicksPerSecond(){}
74058
74059    /**
74060     * Gets the image total ink density.
74061     *
74062     * @return float
74063     * @since PECL imagick 2.0.0
74064     **/
74065    function getImageTotalInkDensity(){}
74066
74067    /**
74068     * Gets the potential image type.
74069     *
74070     * @return int
74071     **/
74072    function getImageType(){}
74073
74074    /**
74075     * Gets the image units of resolution.
74076     *
74077     * @return int
74078     * @since PECL imagick 2.0.0
74079     **/
74080    function getImageUnits(){}
74081
74082    /**
74083     * Returns the virtual pixel method for the specified image.
74084     *
74085     * @return int
74086     * @since PECL imagick 2.0.0
74087     **/
74088    function getImageVirtualPixelMethod(){}
74089
74090    /**
74091     * Returns the chromaticity white point as an associative array with the
74092     * keys "x" and "y".
74093     *
74094     * @return array
74095     * @since PECL imagick 2.0.0
74096     **/
74097    function getImageWhitePoint(){}
74098
74099    /**
74100     * Returns the image width.
74101     *
74102     * @return int
74103     * @since PECL imagick 2.0.0
74104     **/
74105    function getImageWidth(){}
74106
74107    /**
74108     * Gets the object interlace scheme.
74109     *
74110     * @return int
74111     * @since PECL imagick 2.0.0
74112     **/
74113    function getInterlaceScheme(){}
74114
74115    /**
74116     * Returns the index of the current active image within the Imagick
74117     * object.
74118     *
74119     * @return int
74120     * @since PECL imagick 2.0.0
74121     **/
74122    function getIteratorIndex(){}
74123
74124    /**
74125     * Returns the number of images associated with Imagick object.
74126     *
74127     * @return int
74128     * @since PECL imagick 2.0.0
74129     **/
74130    function getNumberImages(){}
74131
74132    /**
74133     * Returns a value associated within the object for the specified key.
74134     *
74135     * @param string $key The name of the option
74136     * @return string
74137     * @since PECL imagick 2.0.0
74138     **/
74139    function getOption($key){}
74140
74141    /**
74142     * Returns the ImageMagick package name.
74143     *
74144     * @return string
74145     * @since PECL imagick 2.0.0
74146     **/
74147    function getPackageName(){}
74148
74149    /**
74150     * Returns the page geometry associated with the Imagick object in an
74151     * associative array with the keys "width", "height", "x", and "y".
74152     *
74153     * @return array
74154     * @since PECL imagick 2.0.0
74155     **/
74156    function getPage(){}
74157
74158    /**
74159     * Returns a MagickPixelIterator.
74160     *
74161     * @return ImagickPixelIterator
74162     * @since PECL imagick 2.0.0
74163     **/
74164    function getPixelIterator(){}
74165
74166    /**
74167     * Get an ImagickPixelIterator for an image section.
74168     *
74169     * @param int $x The x-coordinate of the region.
74170     * @param int $y The y-coordinate of the region.
74171     * @param int $columns The width of the region.
74172     * @param int $rows The height of the region.
74173     * @return ImagickPixelIterator
74174     * @since PECL imagick 2.0.0
74175     **/
74176    function getPixelRegionIterator($x, $y, $columns, $rows){}
74177
74178    /**
74179     * Returns the objects point size property.
74180     *
74181     * @return string
74182     **/
74183    function getPointSize(){}
74184
74185    /**
74186     * Returns the Imagick quantum depth as a string.
74187     *
74188     * @return array
74189     * @since PECL imagick 2.0.0
74190     **/
74191    function getQuantumDepth(){}
74192
74193    /**
74194     * Returns the Imagick quantum range as a string.
74195     *
74196     * @return array
74197     * @since PECL imagick 2.0.0
74198     **/
74199    function getQuantumRange(){}
74200
74201    /**
74202     * Returns the ImageMagick release date as a string.
74203     *
74204     * @return string
74205     * @since PECL imagick 2.0.0
74206     **/
74207    function getReleaseDate(){}
74208
74209    /**
74210     * Returns the specified resource's memory usage in megabytes.
74211     *
74212     * @param int $type Refer to the list of resourcetype constants.
74213     * @return int
74214     * @since PECL imagick 2.0.0
74215     **/
74216    function getResource($type){}
74217
74218    /**
74219     * Returns the specified resource limit in megabytes.
74220     *
74221     * @param int $type Refer to the list of resourcetype constants.
74222     * @return int
74223     * @since PECL imagick 2.0.0
74224     **/
74225    function getResourceLimit($type){}
74226
74227    /**
74228     * Gets the horizontal and vertical sampling factor.
74229     *
74230     * @return array
74231     * @since PECL imagick 2.0.0
74232     **/
74233    function getSamplingFactors(){}
74234
74235    /**
74236     * Returns the size associated with the Imagick object as an array with
74237     * the keys "columns" and "rows".
74238     *
74239     * @return array
74240     * @since PECL imagick 2.0.0
74241     **/
74242    function getSize(){}
74243
74244    /**
74245     * Returns the size offset associated with the Imagick object.
74246     *
74247     * @return int
74248     * @since PECL imagick 2.0.0
74249     **/
74250    function getSizeOffset(){}
74251
74252    /**
74253     * Returns the ImageMagick API version as a string and as a number.
74254     *
74255     * @return array
74256     * @since PECL imagick 2.0.0
74257     **/
74258    function getVersion(){}
74259
74260    /**
74261     * Replaces colors in the image using a Hald lookup table. Hald images
74262     * can be created using HALD color coder.
74263     *
74264     * @param Imagick $clut Imagick object containing the Hald lookup
74265     *   image.
74266     * @param int $channel
74267     * @return boolean
74268     **/
74269    function haldClutImage($clut, $channel){}
74270
74271    /**
74272     * Returns if the object has more images when traversing the list in the
74273     * forward direction.
74274     *
74275     * @return bool
74276     * @since PECL imagick 2.0.0
74277     **/
74278    function hasNextImage(){}
74279
74280    /**
74281     * Returns if the object has more images when traversing the list in the
74282     * reverse direction
74283     *
74284     * @return bool
74285     * @since PECL imagick 2.0.0
74286     **/
74287    function hasPreviousImage(){}
74288
74289    /**
74290     * Identifies an image and returns the attributes. Attributes include the
74291     * image width, height, size, and others.
74292     *
74293     * @param bool $appendRawOutput
74294     * @return array
74295     * @since PECL imagick 2.0.0
74296     **/
74297    function identifyImage($appendRawOutput){}
74298
74299    /**
74300     * Creates a new image that is a copy of an existing one with the image
74301     * pixels "imploded" by the specified percentage.
74302     *
74303     * @param float $radius The radius of the implode
74304     * @return bool
74305     * @since PECL imagick 2.0.0
74306     **/
74307    function implodeImage($radius){}
74308
74309    /**
74310     * Imports pixels from an array into an image. The {@link map} is usually
74311     * 'RGB'. This method imposes the following constraints for the
74312     * parameters: amount of pixels in the array must match {@link width} x
74313     * {@link height} x length of the map.
74314     *
74315     * @param int $x The image x position
74316     * @param int $y The image y position
74317     * @param int $width The image width
74318     * @param int $height The image height
74319     * @param string $map Map of pixel ordering as a string. This can be
74320     *   for example RGB. The value can be any combination or order of R =
74321     *   red, G = green, B = blue, A = alpha (0 is transparent), O = opacity
74322     *   (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I =
74323     *   intensity (for grayscale), P = pad.
74324     * @param int $storage The pixel storage method. Refer to this list of
74325     *   pixel constants.
74326     * @param array $pixels The array of pixels
74327     * @return bool
74328     **/
74329    function importImagePixels($x, $y, $width, $height, $map, $storage, $pixels){}
74330
74331    /**
74332     * Adds a label to an image.
74333     *
74334     * @param string $label The label to add
74335     * @return bool
74336     * @since PECL imagick 2.0.0
74337     **/
74338    function labelImage($label){}
74339
74340    /**
74341     * Adjusts the levels of an image by scaling the colors falling between
74342     * specified white and black points to the full available quantum range.
74343     * The parameters provided represent the black, mid, and white points.
74344     * The black point specifies the darkest color in the image. Colors
74345     * darker than the black point are set to zero. Mid point specifies a
74346     * gamma correction to apply to the image. White point specifies the
74347     * lightest color in the image. Colors brighter than the white point are
74348     * set to the maximum quantum value.
74349     *
74350     * @param float $blackPoint The image black point
74351     * @param float $gamma The gamma value
74352     * @param float $whitePoint The image white point
74353     * @param int $channel Provide any channel constant that is valid for
74354     *   your channel mode. To apply to more than one channel, combine
74355     *   channeltype constants using bitwise operators. Refer to this list of
74356     *   channel constants.
74357     * @return bool
74358     * @since PECL imagick 2.0.0
74359     **/
74360    function levelImage($blackPoint, $gamma, $whitePoint, $channel){}
74361
74362    /**
74363     * Stretches with saturation the image intensity.
74364     *
74365     * @param float $blackPoint The image black point
74366     * @param float $whitePoint The image white point
74367     * @return bool
74368     * @since PECL imagick 2.0.0
74369     **/
74370    function linearStretchImage($blackPoint, $whitePoint){}
74371
74372    /**
74373     * This method scales the images using liquid rescaling method. This
74374     * method is an implementation of a technique called seam carving. In
74375     * order for this method to work as expected ImageMagick must be compiled
74376     * with liblqr support.
74377     *
74378     * @param int $width The width of the target size
74379     * @param int $height The height of the target size
74380     * @param float $delta_x How much the seam can traverse on x-axis.
74381     *   Passing 0 causes the seams to be straight.
74382     * @param float $rigidity Introduces a bias for non-straight seams.
74383     *   This parameter is typically 0.
74384     * @return bool
74385     **/
74386    function liquidRescaleImage($width, $height, $delta_x, $rigidity){}
74387
74388    /**
74389     * Is a convenience method that scales an image proportionally to twice
74390     * its original size.
74391     *
74392     * @return bool
74393     * @since PECL imagick 2.0.0
74394     **/
74395    function magnifyImage(){}
74396
74397    /**
74398     * @param Imagick $map
74399     * @param bool $dither
74400     * @return bool
74401     * @since PECL imagick 2.0.0
74402     **/
74403    function mapImage($map, $dither){}
74404
74405    /**
74406     * Changes the transparency value of any pixel that matches target and is
74407     * an immediate neighbor. If the method FillToBorderMethod is specified,
74408     * the transparency value is changed for any neighbor pixel that does not
74409     * match the bordercolor member of image.
74410     *
74411     * @param float $alpha The level of transparency: 1.0 is fully opaque
74412     *   and 0.0 is fully transparent.
74413     * @param float $fuzz The fuzz member of image defines how much
74414     *   tolerance is acceptable to consider two colors as the same.
74415     * @param mixed $bordercolor An ImagickPixel object or string
74416     *   representing the border color.
74417     * @param int $x The starting x coordinate of the operation.
74418     * @param int $y The starting y coordinate of the operation.
74419     * @return bool
74420     * @since PECL imagick 2.0.0
74421     **/
74422    function matteFloodfillImage($alpha, $fuzz, $bordercolor, $x, $y){}
74423
74424    /**
74425     * Applies a digital filter that improves the quality of a noisy image.
74426     * Each pixel is replaced by the median in a set of neighboring pixels as
74427     * defined by radius.
74428     *
74429     * @param float $radius The radius of the pixel neighborhood.
74430     * @return bool
74431     * @since PECL imagick 2.0.0
74432     **/
74433    function medianFilterImage($radius){}
74434
74435    /**
74436     * Merges image layers into one. This method is useful when working with
74437     * image formats that use multiple layers such as PSD. The merging is
74438     * controlled using the {@link layer_method} which defines how the layers
74439     * are merged.
74440     *
74441     * @param int $layer_method One of the Imagick::LAYERMETHOD_* constants
74442     * @return bool
74443     * @since PECL imagick 2.1.0
74444     **/
74445    function mergeImageLayers($layer_method){}
74446
74447    /**
74448     * Is a convenience method that scales an image proportionally to
74449     * one-half its original size
74450     *
74451     * @return bool
74452     * @since PECL imagick 2.0.0
74453     **/
74454    function minifyImage(){}
74455
74456    /**
74457     * Lets you control the brightness, saturation, and hue of an image. Hue
74458     * is the percentage of absolute rotation from the current position. For
74459     * example 50 results in a counter-clockwise rotation of 90 degrees, 150
74460     * results in a clockwise rotation of 90 degrees, with 0 and 200 both
74461     * resulting in a rotation of 180 degrees.
74462     *
74463     * @param float $brightness
74464     * @param float $saturation
74465     * @param float $hue
74466     * @return bool
74467     * @since PECL imagick 2.0.0
74468     **/
74469    function modulateImage($brightness, $saturation, $hue){}
74470
74471    /**
74472     * Creates a composite image by combining several separate images. The
74473     * images are tiled on the composite image with the name of the image
74474     * optionally appearing just below the individual tile.
74475     *
74476     * @param ImagickDraw $draw The font name, size, and color are obtained
74477     *   from this object.
74478     * @param string $tile_geometry The number of tiles per row and page
74479     *   (e.g. 6x4+0+0).
74480     * @param string $thumbnail_geometry Preferred image size and border
74481     *   size of each thumbnail (e.g. 120x120+4+3>).
74482     * @param int $mode Thumbnail framing mode, see Montage Mode constants.
74483     * @param string $frame Surround the image with an ornamental border
74484     *   (e.g. 15x15+3+3). The frame color is that of the thumbnail's matte
74485     *   color.
74486     * @return Imagick
74487     * @since PECL imagick 2.0.0
74488     **/
74489    function montageImage($draw, $tile_geometry, $thumbnail_geometry, $mode, $frame){}
74490
74491    /**
74492     * Method morphs a set of images. Both the image pixels and size are
74493     * linearly interpolated to give the appearance of a meta-morphosis from
74494     * one image to the next.
74495     *
74496     * @param int $number_frames The number of in-between images to
74497     *   generate.
74498     * @return Imagick
74499     * @since PECL imagick 2.0.0
74500     **/
74501    function morphImages($number_frames){}
74502
74503    /**
74504     * Inlays an image sequence to form a single coherent picture. It returns
74505     * a wand with each image in the sequence composited at the location
74506     * defined by the page offset of the image.
74507     *
74508     * @return Imagick
74509     * @since PECL imagick 2.0.0
74510     **/
74511    function mosaicImages(){}
74512
74513    /**
74514     * Simulates motion blur. We convolve the image with a Gaussian operator
74515     * of the given radius and standard deviation (sigma). For reasonable
74516     * results, radius should be larger than sigma. Use a radius of 0 and
74517     * MotionBlurImage() selects a suitable radius for you. Angle gives the
74518     * angle of the blurring motion.
74519     *
74520     * @param float $radius The radius of the Gaussian, in pixels, not
74521     *   counting the center pixel.
74522     * @param float $sigma The standard deviation of the Gaussian, in
74523     *   pixels.
74524     * @param float $angle Apply the effect along this angle.
74525     * @param int $channel Provide any channel constant that is valid for
74526     *   your channel mode. To apply to more than one channel, combine
74527     *   channeltype constants using bitwise operators. Refer to this list of
74528     *   channel constants. The channel argument affects only if Imagick is
74529     *   compiled against ImageMagick version 6.4.4 or greater.
74530     * @return bool
74531     * @since PECL imagick 2.0.0
74532     **/
74533    function motionBlurImage($radius, $sigma, $angle, $channel){}
74534
74535    /**
74536     * Negates the colors in the reference image. The Grayscale option means
74537     * that only grayscale values within the image are negated.
74538     *
74539     * @param bool $gray Whether to only negate grayscale pixels within the
74540     *   image.
74541     * @param int $channel Provide any channel constant that is valid for
74542     *   your channel mode. To apply to more than one channel, combine
74543     *   channeltype constants using bitwise operators. Refer to this list of
74544     *   channel constants.
74545     * @return bool
74546     * @since PECL imagick 2.0.0
74547     **/
74548    function negateImage($gray, $channel){}
74549
74550    /**
74551     * Creates a new image and associates ImagickPixel value as background
74552     * color
74553     *
74554     * @param int $cols Columns in the new image
74555     * @param int $rows Rows in the new image
74556     * @param mixed $background The background color used for this image
74557     * @param string $format Image format. This parameter was added in
74558     *   Imagick version 2.0.1.
74559     * @return bool
74560     * @since PECL imagick 2.0.0
74561     **/
74562    function newImage($cols, $rows, $background, $format){}
74563
74564    /**
74565     * Creates a new image using ImageMagick pseudo-formats.
74566     *
74567     * @param int $columns columns in the new image
74568     * @param int $rows rows in the new image
74569     * @param string $pseudoString string containing pseudo image
74570     *   definition.
74571     * @return bool
74572     * @since PECL imagick 2.0.0
74573     **/
74574    function newPseudoImage($columns, $rows, $pseudoString){}
74575
74576    /**
74577     * Associates the next image in the image list with an Imagick object.
74578     *
74579     * @return bool
74580     * @since PECL imagick 2.0.0
74581     **/
74582    function nextImage(){}
74583
74584    /**
74585     * Enhances the contrast of a color image by adjusting the pixels color
74586     * to span the entire range of colors available.
74587     *
74588     * @param int $channel Provide any channel constant that is valid for
74589     *   your channel mode. To apply to more than one channel, combine
74590     *   channeltype constants using bitwise operators. Refer to this list of
74591     *   channel constants.
74592     * @return bool
74593     * @since PECL imagick 2.0.0
74594     **/
74595    function normalizeImage($channel){}
74596
74597    /**
74598     * Applies a special effect filter that simulates an oil painting. Each
74599     * pixel is replaced by the most frequent color occurring in a circular
74600     * region defined by radius.
74601     *
74602     * @param float $radius The radius of the circular neighborhood.
74603     * @return bool
74604     * @since PECL imagick 2.0.0
74605     **/
74606    function oilPaintImage($radius){}
74607
74608    /**
74609     * Changes any pixel that matches color with the color defined by fill.
74610     *
74611     * @param mixed $target ImagickPixel object or a string containing the
74612     *   color to change
74613     * @param mixed $fill The replacement color
74614     * @param float $fuzz
74615     * @param bool $invert If paints any pixel that does not match the
74616     *   target color.
74617     * @param int $channel
74618     * @return bool
74619     **/
74620    function opaquePaintImage($target, $fill, $fuzz, $invert, $channel){}
74621
74622    /**
74623     * Compares each image the GIF disposed forms of the previous image in
74624     * the sequence. From this it attempts to select the smallest cropped
74625     * image to replace each frame, while preserving the results of the
74626     * animation.
74627     *
74628     * @return bool
74629     * @since PECL imagick 2.0.0
74630     **/
74631    function optimizeImageLayers(){}
74632
74633    /**
74634     * Performs an ordered dither based on a number of pre-defined dithering
74635     * threshold maps, but over multiple intensity levels, which can be
74636     * different for different channels, according to the input arguments.
74637     *
74638     * @param string $threshold_map A string containing the name of the
74639     *   threshold dither map to use
74640     * @param int $channel Provide any channel constant that is valid for
74641     *   your channel mode. To apply to more than one channel, combine
74642     *   channeltype constants using bitwise operators. Refer to this list of
74643     *   channel constants.
74644     * @return bool
74645     * @since PECL imagick 2.2.2
74646     **/
74647    function orderedPosterizeImage($threshold_map, $channel){}
74648
74649    /**
74650     * Changes the color value of any pixel that matches target and is an
74651     * immediate neighbor. As of ImageMagick 6.3.8 this method has been
74652     * deprecated and {@link Imagick::floodfillPaintImage} should be used
74653     * instead.
74654     *
74655     * @param mixed $fill ImagickPixel object or a string containing the
74656     *   fill color
74657     * @param float $fuzz The amount of fuzz. For example, set fuzz to 10
74658     *   and the color red at intensities of 100 and 102 respectively are now
74659     *   interpreted as the same color for the purposes of the floodfill.
74660     * @param mixed $bordercolor ImagickPixel object or a string containing
74661     *   the border color
74662     * @param int $x X start position of the floodfill
74663     * @param int $y Y start position of the floodfill
74664     * @param int $channel
74665     * @return bool
74666     * @since PECL imagick 2.1.0
74667     **/
74668    function paintFloodfillImage($fill, $fuzz, $bordercolor, $x, $y, $channel){}
74669
74670    /**
74671     * Changes any pixel that matches color with the color defined by fill.
74672     *
74673     * @param mixed $target Change this target color to the fill color
74674     *   within the image. An ImagickPixel object or a string representing
74675     *   the target color.
74676     * @param mixed $fill An ImagickPixel object or a string representing
74677     *   the fill color.
74678     * @param float $fuzz The fuzz member of image defines how much
74679     *   tolerance is acceptable to consider two colors as the same.
74680     * @param int $channel Provide any channel constant that is valid for
74681     *   your channel mode. To apply to more than one channel, combine
74682     *   channeltype constants using bitwise operators. Refer to this list of
74683     *   channel constants.
74684     * @return bool
74685     * @since PECL imagick 2.0.0
74686     **/
74687    function paintOpaqueImage($target, $fill, $fuzz, $channel){}
74688
74689    /**
74690     * Changes any pixel that matches color with the color defined by fill.
74691     *
74692     * @param mixed $target Change this target color to specified opacity
74693     *   value within the image.
74694     * @param float $alpha The level of transparency: 1.0 is fully opaque
74695     *   and 0.0 is fully transparent.
74696     * @param float $fuzz The fuzz member of image defines how much
74697     *   tolerance is acceptable to consider two colors as the same.
74698     * @return bool
74699     * @since PECL imagick 2.0.0
74700     **/
74701    function paintTransparentImage($target, $alpha, $fuzz){}
74702
74703    /**
74704     * This method can be used to query image width, height, size, and format
74705     * without reading the whole image in to memory.
74706     *
74707     * @param string $filename The filename to read the information from.
74708     * @return bool
74709     * @since PECL imagick 2.0.0
74710     **/
74711    function pingImage($filename){}
74712
74713    /**
74714     * This method can be used to query image width, height, size, and format
74715     * without reading the whole image to memory.
74716     *
74717     * @param string $image A string containing the image.
74718     * @return bool
74719     * @since PECL imagick 2.0.0
74720     **/
74721    function pingImageBlob($image){}
74722
74723    /**
74724     * This method can be used to query image width, height, size, and format
74725     * without reading the whole image to memory.
74726     *
74727     * @param resource $filehandle An open filehandle to the image.
74728     * @param string $fileName Optional filename for this image.
74729     * @return bool
74730     * @since PECL imagick 2.0.0
74731     **/
74732    function pingImageFile($filehandle, $fileName){}
74733
74734    /**
74735     * Simulates a Polaroid picture.
74736     *
74737     * @param ImagickDraw $properties The polaroid properties
74738     * @param float $angle The polaroid angle
74739     * @return bool
74740     * @since PECL imagick 2.0.0
74741     **/
74742    function polaroidImage($properties, $angle){}
74743
74744    /**
74745     * Reduces the image to a limited number of color level.
74746     *
74747     * @param int $levels
74748     * @param bool $dither
74749     * @return bool
74750     * @since PECL imagick 2.0.0
74751     **/
74752    function posterizeImage($levels, $dither){}
74753
74754    /**
74755     * Tiles 9 thumbnails of the specified image with an image processing
74756     * operation applied at varying strengths. This is helpful to quickly
74757     * pin-point an appropriate parameter for an image processing operation.
74758     *
74759     * @param int $preview Preview type. See Preview type constants
74760     * @return bool
74761     * @since PECL imagick 2.0.0
74762     **/
74763    function previewImages($preview){}
74764
74765    /**
74766     * Assocates the previous image in an image list with the Imagick object.
74767     *
74768     * @return bool
74769     * @since PECL imagick 2.0.0
74770     **/
74771    function previousImage(){}
74772
74773    /**
74774     * Adds or removes a ICC, IPTC, or generic profile from an image. If the
74775     * profile is NULL, it is removed from the image otherwise added. Use a
74776     * name of '*' and a profile of NULL to remove all profiles from the
74777     * image.
74778     *
74779     * @param string $name
74780     * @param string $profile
74781     * @return bool
74782     * @since PECL imagick 2.0.0
74783     **/
74784    function profileImage($name, $profile){}
74785
74786    /**
74787     * @param int $numberColors
74788     * @param int $colorspace
74789     * @param int $treedepth
74790     * @param bool $dither
74791     * @param bool $measureError
74792     * @return bool
74793     * @since PECL imagick 2.0.0
74794     **/
74795    function quantizeImage($numberColors, $colorspace, $treedepth, $dither, $measureError){}
74796
74797    /**
74798     * @param int $numberColors
74799     * @param int $colorspace
74800     * @param int $treedepth
74801     * @param bool $dither
74802     * @param bool $measureError
74803     * @return bool
74804     * @since PECL imagick 2.0.0
74805     **/
74806    function quantizeImages($numberColors, $colorspace, $treedepth, $dither, $measureError){}
74807
74808    /**
74809     * Returns a multi-dimensional array representing the font metrics.
74810     *
74811     * @param ImagickDraw $properties ImagickDraw object containing font
74812     *   properties
74813     * @param string $text The text
74814     * @param bool $multiline Multiline parameter. If left empty it is
74815     *   autodetected
74816     * @return array
74817     * @since PECL imagick 2.0.0
74818     **/
74819    function queryFontMetrics($properties, $text, $multiline){}
74820
74821    /**
74822     * Returns the configured fonts.
74823     *
74824     * @param string $pattern The query pattern
74825     * @return array
74826     * @since PECL imagick 2.0.0
74827     **/
74828    function queryFonts($pattern){}
74829
74830    /**
74831     * Returns formats supported by Imagick.
74832     *
74833     * @param string $pattern
74834     * @return array
74835     * @since PECL imagick 2.0.0
74836     **/
74837    function queryFormats($pattern){}
74838
74839    /**
74840     * Radial blurs an image.
74841     *
74842     * @param float $angle
74843     * @param int $channel
74844     * @return bool
74845     * @since PECL imagick 2.0.0
74846     **/
74847    function radialBlurImage($angle, $channel){}
74848
74849    /**
74850     * Creates a simulated three-dimensional button-like effect by lightening
74851     * and darkening the edges of the image. Members width and height of
74852     * raise_info define the width of the vertical and horizontal edge of the
74853     * effect.
74854     *
74855     * @param int $width
74856     * @param int $height
74857     * @param int $x
74858     * @param int $y
74859     * @param bool $raise
74860     * @return bool
74861     * @since PECL imagick 2.0.0
74862     **/
74863    function raiseImage($width, $height, $x, $y, $raise){}
74864
74865    /**
74866     * Changes the value of individual pixels based on the intensity of each
74867     * pixel compared to threshold. The result is a high-contrast, two color
74868     * image.
74869     *
74870     * @param float $low The low point
74871     * @param float $high The high point
74872     * @param int $channel Provide any channel constant that is valid for
74873     *   your channel mode. To apply to more than one channel, combine
74874     *   channeltype constants using bitwise operators. Refer to this list of
74875     *   channel constants.
74876     * @return bool
74877     * @since PECL imagick 2.0.0
74878     **/
74879    function randomThresholdImage($low, $high, $channel){}
74880
74881    /**
74882     * Reads image from filename
74883     *
74884     * @param string $filename
74885     * @return bool
74886     **/
74887    function readImage($filename){}
74888
74889    /**
74890     * Reads image from a binary string
74891     *
74892     * @param string $image
74893     * @param string $filename
74894     * @return bool
74895     * @since PECL imagick 2.0.0
74896     **/
74897    function readImageBlob($image, $filename){}
74898
74899    /**
74900     * Reads image from open filehandle
74901     *
74902     * @param resource $filehandle
74903     * @param string $fileName
74904     * @return bool
74905     * @since PECL imagick 2.0.0
74906     **/
74907    function readImageFile($filehandle, $fileName){}
74908
74909    /**
74910     * Translate, scale, shear, or rotate image colors. This method supports
74911     * variable sized matrices but normally 5x5 matrix is used for RGBA and
74912     * 6x6 is used for CMYK. The last row should contain the normalized
74913     * values.
74914     *
74915     * @param array $matrix The matrix containing the color values
74916     * @return bool
74917     **/
74918    function recolorImage($matrix){}
74919
74920    /**
74921     * Smooths the contours of an image while still preserving edge
74922     * information. The algorithm works by replacing each pixel with its
74923     * neighbor closest in value. A neighbor is defined by radius. Use a
74924     * radius of 0 and Imagick::reduceNoiseImage() selects a suitable radius
74925     * for you.
74926     *
74927     * @param float $radius
74928     * @return bool
74929     * @since PECL imagick 2.0.0
74930     **/
74931    function reduceNoiseImage($radius){}
74932
74933    /**
74934     * Replaces colors an image with those defined by {@link replacement}.
74935     * The colors are replaced with the closest possible color.
74936     *
74937     * @param Imagick $replacement An Imagick object containing the
74938     *   replacement colors
74939     * @param int $DITHER Refer to this list of dither method constants
74940     * @return void
74941     **/
74942    function remapImage($replacement, $DITHER){}
74943
74944    /**
74945     * Removes an image from the image list.
74946     *
74947     * @return bool
74948     * @since PECL imagick 2.0.0
74949     **/
74950    function removeImage(){}
74951
74952    /**
74953     * Removes the named image profile and returns it.
74954     *
74955     * @param string $name
74956     * @return string
74957     * @since PECL imagick 2.0.0
74958     **/
74959    function removeImageProfile($name){}
74960
74961    /**
74962     * Renders all preceding drawing commands.
74963     *
74964     * @return bool
74965     * @since PECL imagick 2.0.0
74966     **/
74967    function render(){}
74968
74969    /**
74970     * Resample image to desired resolution.
74971     *
74972     * @param float $x_resolution
74973     * @param float $y_resolution
74974     * @param int $filter
74975     * @param float $blur
74976     * @return bool
74977     * @since PECL imagick 2.0.0
74978     **/
74979    function resampleImage($x_resolution, $y_resolution, $filter, $blur){}
74980
74981    /**
74982     * The page definition as a string. The string is in format WxH+x+y.
74983     *
74984     * @param string $page The page definition. For example 7168x5147+0+0
74985     * @return bool
74986     **/
74987    function resetImagePage($page){}
74988
74989    /**
74990     * Scales an image to the desired dimensions with a filter.
74991     *
74992     * @param int $columns Width of the image
74993     * @param int $rows Height of the image
74994     * @param int $filter Refer to the list of filter constants.
74995     * @param float $blur The blur factor where > 1 is blurry, < 1 is
74996     *   sharp.
74997     * @param bool $bestfit Optional fit parameter.
74998     * @return bool
74999     * @since PECL imagick 2.0.0
75000     **/
75001    function resizeImage($columns, $rows, $filter, $blur, $bestfit){}
75002
75003    /**
75004     * Offsets an image as defined by x and y.
75005     *
75006     * @param int $x The X offset.
75007     * @param int $y The Y offset.
75008     * @return bool
75009     * @since PECL imagick 2.0.0
75010     **/
75011    function rollImage($x, $y){}
75012
75013    /**
75014     * Rotates an image the specified number of degrees. Empty triangles left
75015     * over from rotating the image are filled with the background color.
75016     *
75017     * @param mixed $background The background color
75018     * @param float $degrees The number of degrees to rotate the image
75019     * @return bool
75020     * @since PECL imagick 2.0.0
75021     **/
75022    function rotateImage($background, $degrees){}
75023
75024    /**
75025     * Rounds image corners. The first two parameters control the amount of
75026     * rounding and the three last parameters can be used to fine-tune the
75027     * rounding process.
75028     *
75029     * @param float $x_rounding x rounding
75030     * @param float $y_rounding y rounding
75031     * @param float $stroke_width stroke width
75032     * @param float $displace image displace
75033     * @param float $size_correction size correction
75034     * @return bool
75035     * @since PECL imagick 2.0.0
75036     **/
75037    function roundCorners($x_rounding, $y_rounding, $stroke_width, $displace, $size_correction){}
75038
75039    /**
75040     * Scales an image to the desired dimensions with pixel sampling. Unlike
75041     * other scaling methods, this method does not introduce any additional
75042     * color into the scaled image.
75043     *
75044     * @param int $columns
75045     * @param int $rows
75046     * @return bool
75047     * @since PECL imagick 2.0.0
75048     **/
75049    function sampleImage($columns, $rows){}
75050
75051    /**
75052     * Scales the size of an image to the given dimensions. The other
75053     * parameter will be calculated if 0 is passed as either param.
75054     *
75055     * @param int $cols
75056     * @param int $rows
75057     * @param bool $bestfit
75058     * @return bool
75059     * @since PECL imagick 2.0.0
75060     **/
75061    function scaleImage($cols, $rows, $bestfit){}
75062
75063    /**
75064     * Analyses the image and identifies units that are similar.
75065     *
75066     * @param int $COLORSPACE One of the COLORSPACE constants.
75067     * @param float $cluster_threshold A percentage describing minimum
75068     *   number of pixels contained in hexedra before it is considered valid.
75069     * @param float $smooth_threshold Eliminates noise from the histogram.
75070     * @param boolean $verbose Whether to output detailed information about
75071     *   recognised classes.
75072     * @return void
75073     **/
75074    function segmentImage($COLORSPACE, $cluster_threshold, $smooth_threshold, $verbose){}
75075
75076    /**
75077     * Separates a channel from the image and returns a grayscale image. A
75078     * channel is a particular color component of each pixel in the image.
75079     *
75080     * @param int $channel
75081     * @return bool
75082     * @since PECL imagick 2.0.0
75083     **/
75084    function separateImageChannel($channel){}
75085
75086    /**
75087     * Applies a special effect to the image, similar to the effect achieved
75088     * in a photo darkroom by sepia toning. Threshold ranges from 0 to
75089     * QuantumRange and is a measure of the extent of the sepia toning. A
75090     * threshold of 80 is a good starting point for a reasonable tone.
75091     *
75092     * @param float $threshold
75093     * @return bool
75094     * @since PECL imagick 2.0.0
75095     **/
75096    function sepiaToneImage($threshold){}
75097
75098    /**
75099     * Sets the object's default background color.
75100     *
75101     * @param mixed $background
75102     * @return bool
75103     * @since PECL imagick 2.0.0
75104     **/
75105    function setBackgroundColor($background){}
75106
75107    /**
75108     * Sets the object's default compression type
75109     *
75110     * @param int $compression
75111     * @return bool
75112     * @since PECL imagick 2.0.0
75113     **/
75114    function setCompression($compression){}
75115
75116    /**
75117     * Sets the object's default compression quality.
75118     *
75119     * @param int $quality
75120     * @return bool
75121     **/
75122    function setCompressionQuality($quality){}
75123
75124    /**
75125     * Sets the filename before you read or write an image file.
75126     *
75127     * @param string $filename
75128     * @return bool
75129     * @since PECL imagick 2.0.0
75130     **/
75131    function setFilename($filename){}
75132
75133    /**
75134     * Sets the Imagick iterator to the first image.
75135     *
75136     * @return bool
75137     * @since PECL imagick 2.0.0
75138     **/
75139    function setFirstIterator(){}
75140
75141    /**
75142     * Sets object's font property. This method can be used for example to
75143     * set font for caption: pseudo-format. The font needs to be configured
75144     * in ImageMagick confiration or a file by the name of {@link font} must
75145     * exist. This method should not be confused with {@link
75146     * ImagickDraw::setFont} which sets the font for a specific ImagickDraw
75147     * object.
75148     *
75149     * @param string $font Font name or a filename
75150     * @return bool
75151     * @since PECL imagick 2.1.0
75152     **/
75153    function setFont($font){}
75154
75155    /**
75156     * Sets the format of the Imagick object.
75157     *
75158     * @param string $format
75159     * @return bool
75160     * @since PECL imagick 2.0.0
75161     **/
75162    function setFormat($format){}
75163
75164    /**
75165     * Sets the global gravity property for the Imagick object.
75166     *
75167     * @param int $gravity The gravity property. Refer to the list of
75168     *   gravity constants.
75169     * @return bool
75170     **/
75171    function setGravity($gravity){}
75172
75173    /**
75174     * Replaces the current image sequence with the image from replace
75175     * object.
75176     *
75177     * @param Imagick $replace The replace Imagick object
75178     * @return bool
75179     * @since PECL imagick 2.0.0
75180     **/
75181    function setImage($replace){}
75182
75183    /**
75184     * Activate or deactivate image alpha channel. The {@link mode} is one of
75185     * the Imagick::ALPHACHANNEL_* constants.
75186     *
75187     * @param int $mode One of the Imagick::ALPHACHANNEL_* constants
75188     * @return bool
75189     **/
75190    function setImageAlphaChannel($mode){}
75191
75192    /**
75193     * Sets the image background color.
75194     *
75195     * @param mixed $background
75196     * @return bool
75197     * @since PECL imagick 2.0.0
75198     **/
75199    function setImageBackgroundColor($background){}
75200
75201    /**
75202     * Sets the image bias for any method that convolves an image (e.g.
75203     * Imagick::ConvolveImage()).
75204     *
75205     * @param float $bias
75206     * @return bool
75207     * @since PECL imagick 2.0.0
75208     **/
75209    function setImageBias($bias){}
75210
75211    /**
75212     * Sets the image chromaticity blue primary point.
75213     *
75214     * @param float $x
75215     * @param float $y
75216     * @return bool
75217     * @since PECL imagick 2.0.0
75218     **/
75219    function setImageBluePrimary($x, $y){}
75220
75221    /**
75222     * Sets the image border color.
75223     *
75224     * @param mixed $border The border color
75225     * @return bool
75226     * @since PECL imagick 2.0.0
75227     **/
75228    function setImageBorderColor($border){}
75229
75230    /**
75231     * Sets the depth of a particular image channel.
75232     *
75233     * @param int $channel
75234     * @param int $depth
75235     * @return bool
75236     * @since PECL imagick 2.0.0
75237     **/
75238    function setImageChannelDepth($channel, $depth){}
75239
75240    /**
75241     * Sets image clip mask from another Imagick object.
75242     *
75243     * @param Imagick $clip_mask The Imagick object containing the clip
75244     *   mask
75245     * @return bool
75246     **/
75247    function setImageClipMask($clip_mask){}
75248
75249    /**
75250     * Sets the color of the specified colormap index.
75251     *
75252     * @param int $index
75253     * @param ImagickPixel $color
75254     * @return bool
75255     * @since PECL imagick 2.0.0
75256     **/
75257    function setImageColormapColor($index, $color){}
75258
75259    /**
75260     * Sets the image colorspace.
75261     *
75262     * @param int $colorspace
75263     * @return bool
75264     * @since PECL imagick 2.0.0
75265     **/
75266    function setImageColorspace($colorspace){}
75267
75268    /**
75269     * Sets the image composite operator, useful for specifying how to
75270     * composite the image thumbnail when using the Imagick::montageImage()
75271     * method.
75272     *
75273     * @param int $compose
75274     * @return bool
75275     * @since PECL imagick 2.0.0
75276     **/
75277    function setImageCompose($compose){}
75278
75279    /**
75280     * @param int $compression One of the COMPRESSION constants
75281     * @return bool
75282     * @since PECL imagick 2.0.0
75283     **/
75284    function setImageCompression($compression){}
75285
75286    /**
75287     * Sets the image compression quality.
75288     *
75289     * @param int $quality The image compression quality as an integer
75290     * @return bool
75291     **/
75292    function setImageCompressionQuality($quality){}
75293
75294    /**
75295     * Sets the image delay.
75296     *
75297     * @param int $delay
75298     * @return bool
75299     * @since PECL imagick 2.0.0
75300     **/
75301    function setImageDelay($delay){}
75302
75303    /**
75304     * Sets the image depth.
75305     *
75306     * @param int $depth
75307     * @return bool
75308     * @since PECL imagick 2.0.0
75309     **/
75310    function setImageDepth($depth){}
75311
75312    /**
75313     * Sets the image disposal method.
75314     *
75315     * @param int $dispose
75316     * @return bool
75317     * @since PECL imagick 2.0.0
75318     **/
75319    function setImageDispose($dispose){}
75320
75321    /**
75322     * Sets the image size (i.e. columns & rows).
75323     *
75324     * @param int $columns
75325     * @param int $rows
75326     * @return bool
75327     * @since PECL imagick 2.0.0
75328     **/
75329    function setImageExtent($columns, $rows){}
75330
75331    /**
75332     * Sets the filename of a particular image in a sequence.
75333     *
75334     * @param string $filename
75335     * @return bool
75336     * @since PECL imagick 2.0.0
75337     **/
75338    function setImageFilename($filename){}
75339
75340    /**
75341     * Sets the format of a particular image in a sequence.
75342     *
75343     * @param string $format String presentation of the image format.
75344     *   Format support depends on the ImageMagick installation.
75345     * @return bool
75346     * @since PECL imagick 2.0.0
75347     **/
75348    function setImageFormat($format){}
75349
75350    /**
75351     * Sets the image gamma.
75352     *
75353     * @param float $gamma
75354     * @return bool
75355     * @since PECL imagick 2.0.0
75356     **/
75357    function setImageGamma($gamma){}
75358
75359    /**
75360     * Sets the gravity property for the current image. This method can be
75361     * used to set the gravity property for a single image sequence.
75362     *
75363     * @param int $gravity The gravity property. Refer to the list of
75364     *   gravity constants.
75365     * @return bool
75366     **/
75367    function setImageGravity($gravity){}
75368
75369    /**
75370     * Sets the image chromaticity green primary point.
75371     *
75372     * @param float $x
75373     * @param float $y
75374     * @return bool
75375     * @since PECL imagick 2.0.0
75376     **/
75377    function setImageGreenPrimary($x, $y){}
75378
75379    /**
75380     * Set the iterator to the position in the image list specified with the
75381     * index parameter.
75382     *
75383     * This method has been deprecated. See Imagick::setIteratorIndex
75384     *
75385     * @param int $index The position to set the iterator to
75386     * @return bool
75387     * @since PECL imagick 2.0.0
75388     **/
75389    function setImageIndex($index){}
75390
75391    /**
75392     * Sets the image compression.
75393     *
75394     * @param int $interlace_scheme
75395     * @return bool
75396     * @since PECL imagick 2.0.0
75397     **/
75398    function setImageInterlaceScheme($interlace_scheme){}
75399
75400    /**
75401     * Sets the image interpolate pixel method.
75402     *
75403     * @param int $method The method is one of the Imagick::INTERPOLATE_*
75404     *   constants
75405     * @return bool
75406     * @since PECL imagick 2.0.0
75407     **/
75408    function setImageInterpolateMethod($method){}
75409
75410    /**
75411     * Sets the image iterations.
75412     *
75413     * @param int $iterations
75414     * @return bool
75415     * @since PECL imagick 2.0.0
75416     **/
75417    function setImageIterations($iterations){}
75418
75419    /**
75420     * Sets the image matte channel.
75421     *
75422     * @param bool $matte True activates the matte channel and false
75423     *   disables it.
75424     * @return bool
75425     * @since PECL imagick 2.0.0
75426     **/
75427    function setImageMatte($matte){}
75428
75429    /**
75430     * Sets the image matte color.
75431     *
75432     * @param mixed $matte
75433     * @return bool
75434     * @since PECL imagick 2.0.0
75435     **/
75436    function setImageMatteColor($matte){}
75437
75438    /**
75439     * Sets the image to the specified opacity level.
75440     *
75441     * @param float $opacity The level of transparency: 1.0 is fully opaque
75442     *   and 0.0 is fully transparent.
75443     * @return bool
75444     * @since PECL imagick 2.0.0
75445     **/
75446    function setImageOpacity($opacity){}
75447
75448    /**
75449     * Sets the image orientation.
75450     *
75451     * @param int $orientation One of the orientation constants
75452     * @return bool
75453     * @since PECL imagick 2.0.0
75454     **/
75455    function setImageOrientation($orientation){}
75456
75457    /**
75458     * Sets the page geometry of the image.
75459     *
75460     * @param int $width
75461     * @param int $height
75462     * @param int $x
75463     * @param int $y
75464     * @return bool
75465     * @since PECL imagick 2.0.0
75466     **/
75467    function setImagePage($width, $height, $x, $y){}
75468
75469    /**
75470     * Adds a named profile to the Imagick object. If a profile with the same
75471     * name already exists, it is replaced. This method differs from the
75472     * Imagick::ProfileImage() method in that it does not apply any CMS color
75473     * profiles.
75474     *
75475     * @param string $name
75476     * @param string $profile
75477     * @return bool
75478     * @since PECL imagick 2.0.0
75479     **/
75480    function setImageProfile($name, $profile){}
75481
75482    /**
75483     * Sets a named property to the image.
75484     *
75485     * @param string $name
75486     * @param string $value
75487     * @return bool
75488     * @since PECL imagick 2.0.0
75489     **/
75490    function setImageProperty($name, $value){}
75491
75492    /**
75493     * Sets the image chromaticity red primary point.
75494     *
75495     * @param float $x
75496     * @param float $y
75497     * @return bool
75498     * @since PECL imagick 2.0.0
75499     **/
75500    function setImageRedPrimary($x, $y){}
75501
75502    /**
75503     * Sets the image rendering intent.
75504     *
75505     * @param int $rendering_intent
75506     * @return bool
75507     * @since PECL imagick 2.0.0
75508     **/
75509    function setImageRenderingIntent($rendering_intent){}
75510
75511    /**
75512     * Sets the image resolution.
75513     *
75514     * @param float $x_resolution
75515     * @param float $y_resolution
75516     * @return bool
75517     * @since PECL imagick 2.0.0
75518     **/
75519    function setImageResolution($x_resolution, $y_resolution){}
75520
75521    /**
75522     * Sets the image scene.
75523     *
75524     * @param int $scene
75525     * @return bool
75526     * @since PECL imagick 2.0.0
75527     **/
75528    function setImageScene($scene){}
75529
75530    /**
75531     * Sets the image ticks-per-second.
75532     *
75533     * @param int $ticks_persecond
75534     * @return bool
75535     * @since PECL imagick 2.0.0
75536     **/
75537    function setImageTicksPerSecond($ticks_persecond){}
75538
75539    /**
75540     * Sets the image type.
75541     *
75542     * @param int $image_type
75543     * @return bool
75544     * @since PECL imagick 2.0.0
75545     **/
75546    function setImageType($image_type){}
75547
75548    /**
75549     * Sets the image units of resolution.
75550     *
75551     * @param int $units
75552     * @return bool
75553     * @since PECL imagick 2.0.0
75554     **/
75555    function setImageUnits($units){}
75556
75557    /**
75558     * Sets the image virtual pixel method.
75559     *
75560     * @param int $method
75561     * @return bool
75562     * @since PECL imagick 2.0.0
75563     **/
75564    function setImageVirtualPixelMethod($method){}
75565
75566    /**
75567     * Sets the image chromaticity white point.
75568     *
75569     * @param float $x
75570     * @param float $y
75571     * @return bool
75572     * @since PECL imagick 2.0.0
75573     **/
75574    function setImageWhitePoint($x, $y){}
75575
75576    /**
75577     * Sets the image compression.
75578     *
75579     * @param int $interlace_scheme
75580     * @return bool
75581     * @since PECL imagick 2.0.0
75582     **/
75583    function setInterlaceScheme($interlace_scheme){}
75584
75585    /**
75586     * Set the iterator to the position in the image list specified with the
75587     * index parameter.
75588     *
75589     * @param int $index The position to set the iterator to
75590     * @return bool
75591     * @since PECL imagick 2.0.0
75592     **/
75593    function setIteratorIndex($index){}
75594
75595    /**
75596     * Sets the Imagick iterator to the last image.
75597     *
75598     * @return bool
75599     * @since PECL imagick 2.0.1
75600     **/
75601    function setLastIterator(){}
75602
75603    /**
75604     * Associates one or more options with the wand.
75605     *
75606     * @param string $key
75607     * @param string $value
75608     * @return bool
75609     * @since PECL imagick 2.0.0
75610     **/
75611    function setOption($key, $value){}
75612
75613    /**
75614     * Sets the page geometry of the Imagick object.
75615     *
75616     * @param int $width
75617     * @param int $height
75618     * @param int $x
75619     * @param int $y
75620     * @return bool
75621     * @since PECL imagick 2.0.0
75622     **/
75623    function setPage($width, $height, $x, $y){}
75624
75625    /**
75626     * Sets object's point size property. This method can be used for example
75627     * to set font size for caption: pseudo-format.
75628     *
75629     * @param float $point_size Point size
75630     * @return bool
75631     * @since PECL imagick 2.1.0
75632     **/
75633    function setPointSize($point_size){}
75634
75635    /**
75636     * Sets the image resolution.
75637     *
75638     * @param float $x_resolution
75639     * @param float $y_resolution
75640     * @return bool
75641     * @since PECL imagick 2.0.0
75642     **/
75643    function setResolution($x_resolution, $y_resolution){}
75644
75645    /**
75646     * Sets the limit for a particular resource in megabytes.
75647     *
75648     * @param int $type
75649     * @param int $limit
75650     * @return bool
75651     * @since PECL imagick 2.0.0
75652     **/
75653    function setResourceLimit($type, $limit){}
75654
75655    /**
75656     * Sets the image sampling factors.
75657     *
75658     * @param array $factors
75659     * @return bool
75660     * @since PECL imagick 2.0.0
75661     **/
75662    function setSamplingFactors($factors){}
75663
75664    /**
75665     * Sets the size of the Imagick object. Set it before you read a raw
75666     * image format such as RGB, GRAY, or CMYK.
75667     *
75668     * @param int $columns
75669     * @param int $rows
75670     * @return bool
75671     * @since PECL imagick 2.0.0
75672     **/
75673    function setSize($columns, $rows){}
75674
75675    /**
75676     * Sets the size and offset of the Imagick object. Set it before you read
75677     * a raw image format such as RGB, GRAY, or CMYK.
75678     *
75679     * @param int $columns The width in pixels.
75680     * @param int $rows The height in pixels.
75681     * @param int $offset The image offset.
75682     * @return bool
75683     * @since PECL imagick 2.0.0
75684     **/
75685    function setSizeOffset($columns, $rows, $offset){}
75686
75687    /**
75688     * Sets the image type attribute.
75689     *
75690     * @param int $image_type
75691     * @return bool
75692     * @since PECL imagick 2.0.0
75693     **/
75694    function setType($image_type){}
75695
75696    /**
75697     * Shines a distant light on an image to create a three-dimensional
75698     * effect. You control the positioning of the light with azimuth and
75699     * elevation; azimuth is measured in degrees off the x axis and elevation
75700     * is measured in pixels above the Z axis.
75701     *
75702     * @param bool $gray A value other than zero shades the intensity of
75703     *   each pixel.
75704     * @param float $azimuth Defines the light source direction.
75705     * @param float $elevation Defines the light source direction.
75706     * @return bool
75707     * @since PECL imagick 2.0.0
75708     **/
75709    function shadeImage($gray, $azimuth, $elevation){}
75710
75711    /**
75712     * Simulates an image shadow.
75713     *
75714     * @param float $opacity
75715     * @param float $sigma
75716     * @param int $x
75717     * @param int $y
75718     * @return bool
75719     * @since PECL imagick 2.0.0
75720     **/
75721    function shadowImage($opacity, $sigma, $x, $y){}
75722
75723    /**
75724     * Sharpens an image. We convolve the image with a Gaussian operator of
75725     * the given radius and standard deviation (sigma). For reasonable
75726     * results, the radius should be larger than sigma. Use a radius of 0 and
75727     * selects a suitable radius for you.
75728     *
75729     * @param float $radius
75730     * @param float $sigma
75731     * @param int $channel
75732     * @return bool
75733     * @since PECL imagick 2.0.0
75734     **/
75735    function sharpenImage($radius, $sigma, $channel){}
75736
75737    /**
75738     * Shaves pixels from the image edges. It allocates the memory necessary
75739     * for the new Image structure and returns a pointer to the new image.
75740     *
75741     * @param int $columns
75742     * @param int $rows
75743     * @return bool
75744     * @since PECL imagick 2.0.0
75745     **/
75746    function shaveImage($columns, $rows){}
75747
75748    /**
75749     * Slides one edge of an image along the X or Y axis, creating a
75750     * parallelogram. An X direction shear slides an edge along the X axis,
75751     * while a Y direction shear slides an edge along the Y axis. The amount
75752     * of the shear is controlled by a shear angle. For X direction shears,
75753     * x_shear is measured relative to the Y axis, and similarly, for Y
75754     * direction shears y_shear is measured relative to the X axis. Empty
75755     * triangles left over from shearing the image are filled with the
75756     * background color.
75757     *
75758     * @param mixed $background The background color
75759     * @param float $x_shear The number of degrees to shear on the x axis
75760     * @param float $y_shear The number of degrees to shear on the y axis
75761     * @return bool
75762     * @since PECL imagick 2.0.0
75763     **/
75764    function shearImage($background, $x_shear, $y_shear){}
75765
75766    /**
75767     * Adjusts the contrast of an image with a non-linear sigmoidal contrast
75768     * algorithm. Increase the contrast of the image using a sigmoidal
75769     * transfer function without saturating highlights or shadows. Contrast
75770     * indicates how much to increase the contrast (0 is none; 3 is typical;
75771     * 20 is pushing it); mid-point indicates where midtones fall in the
75772     * resultant image (0 is white; 50 is middle-gray; 100 is black). Set
75773     * sharpen to to increase the image contrast otherwise the contrast is
75774     * reduced.
75775     *
75776     * @param bool $sharpen
75777     * @param float $alpha
75778     * @param float $beta
75779     * @param int $channel
75780     * @return bool
75781     * @since PECL imagick 2.0.0
75782     **/
75783    function sigmoidalContrastImage($sharpen, $alpha, $beta, $channel){}
75784
75785    /**
75786     * Simulates a pencil sketch. We convolve the image with a Gaussian
75787     * operator of the given radius and standard deviation (sigma). For
75788     * reasonable results, radius should be larger than sigma. Use a radius
75789     * of 0 and Imagick::sketchImage() selects a suitable radius for you.
75790     * Angle gives the angle of the blurring motion.
75791     *
75792     * @param float $radius The radius of the Gaussian, in pixels, not
75793     *   counting the center pixel
75794     * @param float $sigma The standard deviation of the Gaussian, in
75795     *   pixels.
75796     * @param float $angle Apply the effect along this angle.
75797     * @return bool
75798     * @since PECL imagick 2.0.0
75799     **/
75800    function sketchImage($radius, $sigma, $angle){}
75801
75802    /**
75803     * Applies a special effect to the image, similar to the effect achieved
75804     * in a photo darkroom by selectively exposing areas of photo sensitive
75805     * paper to light. Threshold ranges from 0 to QuantumRange and is a
75806     * measure of the extent of the solarization.
75807     *
75808     * @param int $threshold
75809     * @return bool
75810     * @since PECL imagick 2.0.0
75811     **/
75812    function solarizeImage($threshold){}
75813
75814    /**
75815     * Given the arguments array containing numeric values this method
75816     * interpolates the colors found at those coordinates across the whole
75817     * image using {@link sparse_method}.
75818     *
75819     * @param int $SPARSE_METHOD Refer to this list of sparse method
75820     *   constants
75821     * @param array $arguments An array containing the coordinates. The
75822     *   array is in format array(1,1, 2,45)
75823     * @param int $channel
75824     * @return boolean
75825     **/
75826    function sparseColorImage($SPARSE_METHOD, $arguments, $channel){}
75827
75828    /**
75829     * Splices a solid color into the image.
75830     *
75831     * @param int $width
75832     * @param int $height
75833     * @param int $x
75834     * @param int $y
75835     * @return bool
75836     * @since PECL imagick 2.0.0
75837     **/
75838    function spliceImage($width, $height, $x, $y){}
75839
75840    /**
75841     * Special effects method that randomly displaces each pixel in a block
75842     * defined by the radius parameter.
75843     *
75844     * @param float $radius
75845     * @return bool
75846     * @since PECL imagick 2.0.0
75847     **/
75848    function spreadImage($radius){}
75849
75850    /**
75851     * Hides a digital watermark within the image. Recover the hidden
75852     * watermark later to prove that the authenticity of an image. Offset
75853     * defines the start position within the image to hide the watermark.
75854     *
75855     * @param Imagick $watermark_wand
75856     * @param int $offset
75857     * @return Imagick
75858     * @since PECL imagick 2.0.0
75859     **/
75860    function steganoImage($watermark_wand, $offset){}
75861
75862    /**
75863     * Composites two images and produces a single image that is the
75864     * composite of a left and right image of a stereo pair.
75865     *
75866     * @param Imagick $offset_wand
75867     * @return bool
75868     * @since PECL imagick 2.0.0
75869     **/
75870    function stereoImage($offset_wand){}
75871
75872    /**
75873     * Strips an image of all profiles and comments.
75874     *
75875     * @return bool
75876     * @since PECL imagick 2.0.0
75877     **/
75878    function stripImage(){}
75879
75880    /**
75881     * Swirls the pixels about the center of the image, where degrees
75882     * indicates the sweep of the arc through which each pixel is moved. You
75883     * get a more dramatic effect as the degrees move from 1 to 360.
75884     *
75885     * @param float $degrees
75886     * @return bool
75887     * @since PECL imagick 2.0.0
75888     **/
75889    function swirlImage($degrees){}
75890
75891    /**
75892     * Repeatedly tiles the texture image across and down the image canvas.
75893     *
75894     * @param Imagick $texture_wand
75895     * @return bool
75896     * @since PECL imagick 2.0.0
75897     **/
75898    function textureImage($texture_wand){}
75899
75900    /**
75901     * Changes the value of individual pixels based on the intensity of each
75902     * pixel compared to threshold. The result is a high-contrast, two color
75903     * image.
75904     *
75905     * @param float $threshold
75906     * @param int $channel
75907     * @return bool
75908     * @since PECL imagick 2.0.0
75909     **/
75910    function thresholdImage($threshold, $channel){}
75911
75912    /**
75913     * Changes the size of an image to the given dimensions and removes any
75914     * associated profiles. The goal is to produce small low cost thumbnail
75915     * images suited for display on the Web.
75916     *
75917     * If is given as a third parameter then columns and rows parameters are
75918     * used as maximums for each side. Both sides will be scaled down until
75919     * the match or are smaller than the parameter given for the side.
75920     *
75921     * @param int $columns Image width
75922     * @param int $rows Image height
75923     * @param bool $bestfit Whether to force maximum values
75924     * @return bool
75925     * @since PECL imagick 2.0.0
75926     **/
75927    function thumbnailImage($columns, $rows, $bestfit){}
75928
75929    /**
75930     * Applies a color vector to each pixel in the image. The length of the
75931     * vector is 0 for black and white and at its maximum for the midtones.
75932     * The vector weighing function is f(x)=(1-(4.0*((x-0.5)*(x-0.5)))).
75933     *
75934     * @param mixed $tint
75935     * @param mixed $opacity
75936     * @return bool
75937     * @since PECL imagick 2.0.0
75938     **/
75939    function tintImage($tint, $opacity){}
75940
75941    /**
75942     * A convenience method for setting crop size and the image geometry from
75943     * strings.
75944     *
75945     * @param string $crop A crop geometry string. This geometry defines a
75946     *   subregion of the image to crop.
75947     * @param string $geometry An image geometry string. This geometry
75948     *   defines the final size of the image.
75949     * @return Imagick
75950     * @since PECL imagick 2.0.0
75951     **/
75952    function transformImage($crop, $geometry){}
75953
75954    /**
75955     * Paints pixels matching the target color transparent.
75956     *
75957     * @param mixed $target The target color to paint
75958     * @param float $alpha
75959     * @param float $fuzz
75960     * @param bool $invert If paints any pixel that does not match the
75961     *   target color.
75962     * @return bool
75963     **/
75964    function transparentPaintImage($target, $alpha, $fuzz, $invert){}
75965
75966    /**
75967     * Creates a vertical mirror image by reflecting the pixels around the
75968     * central x-axis while rotating them 90-degrees.
75969     *
75970     * @return bool
75971     * @since PECL imagick 2.0.0
75972     **/
75973    function transposeImage(){}
75974
75975    /**
75976     * Creates a horizontal mirror image by reflecting the pixels around the
75977     * central y-axis while rotating them 270-degrees.
75978     *
75979     * @return bool
75980     * @since PECL imagick 2.0.0
75981     **/
75982    function transverseImage(){}
75983
75984    /**
75985     * Remove edges that are the background color from the image.
75986     *
75987     * @param float $fuzz By default target must match a particular pixel
75988     *   color exactly. However, in many cases two colors may differ by a
75989     *   small amount. The fuzz member of image defines how much tolerance is
75990     *   acceptable to consider two colors as the same. This parameter
75991     *   represents the variation on the quantum range.
75992     * @return bool
75993     * @since PECL imagick 2.0.0
75994     **/
75995    function trimImage($fuzz){}
75996
75997    /**
75998     * Discards all but one of any pixel color.
75999     *
76000     * @return bool
76001     * @since PECL imagick 2.0.0
76002     **/
76003    function uniqueImageColors(){}
76004
76005    /**
76006     * Sharpens an image. We convolve the image with a Gaussian operator of
76007     * the given radius and standard deviation (sigma). For reasonable
76008     * results, radius should be larger than sigma. Use a radius of 0 and
76009     * Imagick::UnsharpMaskImage() selects a suitable radius for you.
76010     *
76011     * @param float $radius
76012     * @param float $sigma
76013     * @param float $amount
76014     * @param float $threshold
76015     * @param int $channel
76016     * @return bool
76017     * @since PECL imagick 2.0.0
76018     **/
76019    function unsharpMaskImage($radius, $sigma, $amount, $threshold, $channel){}
76020
76021    /**
76022     * Checks if the current item is valid.
76023     *
76024     * @return bool
76025     * @since PECL imagick 2.0.0
76026     **/
76027    function valid(){}
76028
76029    /**
76030     * Softens the edges of the image in vignette style.
76031     *
76032     * @param float $blackPoint The black point.
76033     * @param float $whitePoint The white point
76034     * @param int $x X offset of the ellipse
76035     * @param int $y Y offset of the ellipse
76036     * @return bool
76037     * @since PECL imagick 2.0.0
76038     **/
76039    function vignetteImage($blackPoint, $whitePoint, $x, $y){}
76040
76041    /**
76042     * Applies a wave filter to the image.
76043     *
76044     * @param float $amplitude The amplitude of the wave.
76045     * @param float $length The length of the wave.
76046     * @return bool
76047     * @since PECL imagick 2.0.0
76048     **/
76049    function waveImage($amplitude, $length){}
76050
76051    /**
76052     * Is like Imagick::ThresholdImage() but force all pixels above the
76053     * threshold into white while leaving all pixels below the threshold
76054     * unchanged.
76055     *
76056     * @param mixed $threshold
76057     * @return bool
76058     * @since PECL imagick 2.0.0
76059     **/
76060    function whiteThresholdImage($threshold){}
76061
76062    /**
76063     * Writes an image to the specified filename. If the filename parameter
76064     * is NULL, the image is written to the filename set by
76065     * Imagick::ReadImage() or Imagick::SetImageFilename().
76066     *
76067     * @param string $filename
76068     * @return bool
76069     **/
76070    function writeImage($filename){}
76071
76072    /**
76073     * Writes the image sequence to an open filehandle. The handle must be
76074     * opened with for example fopen.
76075     *
76076     * @param resource $filehandle Filehandle where to write the image
76077     * @return bool
76078     **/
76079    function writeImageFile($filehandle){}
76080
76081    /**
76082     * Writes an image or image sequence.
76083     *
76084     * @param string $filename
76085     * @param bool $adjoin
76086     * @return bool
76087     **/
76088    function writeImages($filename, $adjoin){}
76089
76090    /**
76091     * Writes all image frames into an open filehandle. This method can be
76092     * used to write animated gifs or other multiframe images into open
76093     * filehandle.
76094     *
76095     * @param resource $filehandle Filehandle where to write the images
76096     * @return bool
76097     **/
76098    function writeImagesFile($filehandle){}
76099
76100    /**
76101     * The Imagick constructor
76102     *
76103     * @param mixed $files The path to an image to load or array of paths
76104     * @return Imagick
76105     **/
76106    function __construct($files){}
76107
76108}
76109class ImagickDraw {
76110    /**
76111     * Adjusts the current affine transformation matrix with the specified
76112     * affine transformation matrix.
76113     *
76114     * @param array $affine Affine matrix parameters
76115     * @return bool
76116     * @since PECL imagick 2.0.0
76117     **/
76118    function affine($affine){}
76119
76120    /**
76121     * Draws text on the image.
76122     *
76123     * @param float $x The x coordinate where text is drawn
76124     * @param float $y The y coordinate where text is drawn
76125     * @param string $text The text to draw on the image
76126     * @return bool
76127     * @since PECL imagick 2.0.0
76128     **/
76129    function annotation($x, $y, $text){}
76130
76131    /**
76132     * Draws an arc falling within a specified bounding rectangle on the
76133     * image.
76134     *
76135     * @param float $sx Starting x ordinate of bounding rectangle
76136     * @param float $sy starting y ordinate of bounding rectangle
76137     * @param float $ex ending x ordinate of bounding rectangle
76138     * @param float $ey ending y ordinate of bounding rectangle
76139     * @param float $sd starting degrees of rotation
76140     * @param float $ed ending degrees of rotation
76141     * @return bool
76142     * @since PECL imagick 2.0.0
76143     **/
76144    function arc($sx, $sy, $ex, $ey, $sd, $ed){}
76145
76146    /**
76147     * Draws a bezier curve through a set of points on the image.
76148     *
76149     * @param array $coordinates Multidimensional array like array( array(
76150     *   'x' => 1, 'y' => 2 ), array( 'x' => 3, 'y' => 4 ) )
76151     * @return bool
76152     * @since PECL imagick 2.0.0
76153     **/
76154    function bezier($coordinates){}
76155
76156    /**
76157     * Draws a circle on the image.
76158     *
76159     * @param float $ox origin x coordinate
76160     * @param float $oy origin y coordinate
76161     * @param float $px perimeter x coordinate
76162     * @param float $py perimeter y coordinate
76163     * @return bool
76164     * @since PECL imagick 2.0.0
76165     **/
76166    function circle($ox, $oy, $px, $py){}
76167
76168    /**
76169     * Clears the ImagickDraw object of any accumulated commands, and resets
76170     * the settings it contains to their defaults.
76171     *
76172     * @return bool
76173     * @since PECL imagick 2.0.0
76174     **/
76175    function clear(){}
76176
76177    /**
76178     * Draws color on image using the current fill color, starting at
76179     * specified position, and using specified paint method.
76180     *
76181     * @param float $x x coordinate of the paint
76182     * @param float $y y coordinate of the paint
76183     * @param int $paintMethod one of the PAINT_ constants
76184     * @return bool
76185     * @since PECL imagick 2.0.0
76186     **/
76187    function color($x, $y, $paintMethod){}
76188
76189    /**
76190     * Adds a comment to a vector output stream.
76191     *
76192     * @param string $comment The comment string to add to vector output
76193     *   stream
76194     * @return bool
76195     * @since PECL imagick 2.0.0
76196     **/
76197    function comment($comment){}
76198
76199    /**
76200     * Composites an image onto the current image, using the specified
76201     * composition operator, specified position, and at the specified size.
76202     *
76203     * @param int $compose composition operator. One of COMPOSITE_
76204     *   constants
76205     * @param float $x x coordinate of the top left corner
76206     * @param float $y y coordinate of the top left corner
76207     * @param float $width width of the composition image
76208     * @param float $height height of the composition image
76209     * @param Imagick $compositeWand the Imagick object where composition
76210     *   image is taken from
76211     * @return bool
76212     * @since PECL imagick 2.0.0
76213     **/
76214    function composite($compose, $x, $y, $width, $height, $compositeWand){}
76215
76216    /**
76217     * Frees all resources associated with the ImagickDraw object.
76218     *
76219     * @return bool
76220     * @since PECL imagick 2.0.0
76221     **/
76222    function destroy(){}
76223
76224    /**
76225     * Draws an ellipse on the image.
76226     *
76227     * @param float $ox
76228     * @param float $oy
76229     * @param float $rx
76230     * @param float $ry
76231     * @param float $start
76232     * @param float $end
76233     * @return bool
76234     * @since PECL imagick 2.0.0
76235     **/
76236    function ellipse($ox, $oy, $rx, $ry, $start, $end){}
76237
76238    /**
76239     * Obtains the current clipping path ID.
76240     *
76241     * @return string
76242     * @since PECL imagick 2.0.0
76243     **/
76244    function getClipPath(){}
76245
76246    /**
76247     * Returns the current polygon fill rule to be used by the clipping path.
76248     *
76249     * @return int
76250     * @since PECL imagick 2.0.0
76251     **/
76252    function getClipRule(){}
76253
76254    /**
76255     * Returns the interpretation of clip path units.
76256     *
76257     * @return int
76258     * @since PECL imagick 2.0.0
76259     **/
76260    function getClipUnits(){}
76261
76262    /**
76263     * Returns the fill color used for drawing filled objects.
76264     *
76265     * @return ImagickPixel
76266     * @since PECL imagick 2.0.0
76267     **/
76268    function getFillColor(){}
76269
76270    /**
76271     * Returns the opacity used when drawing using the fill color or fill
76272     * texture. Fully opaque is 1.0.
76273     *
76274     * @return float
76275     * @since PECL imagick 2.0.0
76276     **/
76277    function getFillOpacity(){}
76278
76279    /**
76280     * Returns the fill rule used while drawing polygons.
76281     *
76282     * @return int
76283     * @since PECL imagick 2.0.0
76284     **/
76285    function getFillRule(){}
76286
76287    /**
76288     * Returns a string specifying the font used when annotating with text.
76289     *
76290     * @return string
76291     * @since PECL imagick 2.0.0
76292     **/
76293    function getFont(){}
76294
76295    /**
76296     * Returns the font family to use when annotating with text.
76297     *
76298     * @return string
76299     * @since PECL imagick 2.0.0
76300     **/
76301    function getFontFamily(){}
76302
76303    /**
76304     * Returns the font pointsize used when annotating with text.
76305     *
76306     * @return float
76307     * @since PECL imagick 2.0.0
76308     **/
76309    function getFontSize(){}
76310
76311    /**
76312     * Returns the font style used when annotating with text.
76313     *
76314     * @return int
76315     * @since PECL imagick 2.0.0
76316     **/
76317    function getFontStyle(){}
76318
76319    /**
76320     * Returns the font weight used when annotating with text.
76321     *
76322     * @return int
76323     * @since PECL imagick 2.0.0
76324     **/
76325    function getFontWeight(){}
76326
76327    /**
76328     * Returns the text placement gravity used when annotating with text.
76329     *
76330     * @return int
76331     * @since PECL imagick 2.0.0
76332     **/
76333    function getGravity(){}
76334
76335    /**
76336     * Returns the current stroke antialias setting. Stroked outlines are
76337     * antialiased by default. When antialiasing is disabled stroked pixels
76338     * are thresholded to determine if the stroke color or underlying canvas
76339     * color should be used.
76340     *
76341     * @return bool
76342     * @since PECL imagick 2.0.0
76343     **/
76344    function getStrokeAntialias(){}
76345
76346    /**
76347     * Returns the color used for stroking object outlines.
76348     *
76349     * @param ImagickPixel $stroke_color
76350     * @return ImagickPixel
76351     * @since PECL imagick 2.0.0
76352     **/
76353    function getStrokeColor($stroke_color){}
76354
76355    /**
76356     * Returns an array representing the pattern of dashes and gaps used to
76357     * stroke paths.
76358     *
76359     * @return array
76360     * @since PECL imagick 2.0.0
76361     **/
76362    function getStrokeDashArray(){}
76363
76364    /**
76365     * Returns the offset into the dash pattern to start the dash.
76366     *
76367     * @return float
76368     * @since PECL imagick 2.0.0
76369     **/
76370    function getStrokeDashOffset(){}
76371
76372    /**
76373     * Returns the shape to be used at the end of open subpaths when they are
76374     * stroked.
76375     *
76376     * @return int
76377     * @since PECL imagick 2.0.0
76378     **/
76379    function getStrokeLineCap(){}
76380
76381    /**
76382     * Returns the shape to be used at the corners of paths (or other vector
76383     * shapes) when they are stroked.
76384     *
76385     * @return int
76386     * @since PECL imagick 2.0.0
76387     **/
76388    function getStrokeLineJoin(){}
76389
76390    /**
76391     * Returns the miter limit. When two line segments meet at a sharp angle
76392     * and miter joins have been specified for 'lineJoin', it is possible for
76393     * the miter to extend far beyond the thickness of the line stroking the
76394     * path. The 'miterLimit' imposes a limit on the ratio of the miter
76395     * length to the 'lineWidth'.
76396     *
76397     * @return int
76398     * @since PECL imagick 2.0.0
76399     **/
76400    function getStrokeMiterLimit(){}
76401
76402    /**
76403     * Returns the opacity of stroked object outlines.
76404     *
76405     * @return float
76406     * @since PECL imagick 2.0.0
76407     **/
76408    function getStrokeOpacity(){}
76409
76410    /**
76411     * Returns the width of the stroke used to draw object outlines.
76412     *
76413     * @return float
76414     * @since PECL imagick 2.0.0
76415     **/
76416    function getStrokeWidth(){}
76417
76418    /**
76419     * Returns the alignment applied when annotating with text.
76420     *
76421     * @return int
76422     * @since PECL imagick 2.0.0
76423     **/
76424    function getTextAlignment(){}
76425
76426    /**
76427     * Returns the current text antialias setting, which determines whether
76428     * text is antialiased. Text is antialiased by default.
76429     *
76430     * @return bool
76431     * @since PECL imagick 2.0.0
76432     **/
76433    function getTextAntialias(){}
76434
76435    /**
76436     * Returns the decoration applied when annotating with text.
76437     *
76438     * @return int
76439     * @since PECL imagick 2.0.0
76440     **/
76441    function getTextDecoration(){}
76442
76443    /**
76444     * Returns a string which specifies the code set used for text
76445     * annotations.
76446     *
76447     * @return string
76448     * @since PECL imagick 2.0.0
76449     **/
76450    function getTextEncoding(){}
76451
76452    /**
76453     * Returns the color of a background rectangle to place under text
76454     * annotations.
76455     *
76456     * @return ImagickPixel
76457     * @since PECL imagick 2.0.0
76458     **/
76459    function getTextUnderColor(){}
76460
76461    /**
76462     * Returns a string which specifies the vector graphics generated by any
76463     * graphics calls made since the ImagickDraw object was instantiated.
76464     *
76465     * @return string
76466     * @since PECL imagick 2.0.0
76467     **/
76468    function getVectorGraphics(){}
76469
76470    /**
76471     * Draws a line on the image using the current stroke color, stroke
76472     * opacity, and stroke width.
76473     *
76474     * @param float $sx starting x coordinate
76475     * @param float $sy starting y coordinate
76476     * @param float $ex ending x coordinate
76477     * @param float $ey ending y coordinate
76478     * @return bool
76479     * @since PECL imagick 2.0.0
76480     **/
76481    function line($sx, $sy, $ex, $ey){}
76482
76483    /**
76484     * Paints on the image's opacity channel in order to set effected pixels
76485     * to transparent, to influence the opacity of pixels.
76486     *
76487     * @param float $x x coordinate of the matte
76488     * @param float $y y coordinate of the matte
76489     * @param int $paintMethod PAINT_ constant
76490     * @return bool
76491     * @since PECL imagick 2.0.0
76492     **/
76493    function matte($x, $y, $paintMethod){}
76494
76495    /**
76496     * Adds a path element to the current path which closes the current
76497     * subpath by drawing a straight line from the current point to the
76498     * current subpath's most recent starting point (usually, the most recent
76499     * moveto point).
76500     *
76501     * @return bool
76502     * @since PECL imagick 2.0.0
76503     **/
76504    function pathClose(){}
76505
76506    /**
76507     * Draws a cubic Bezier curve from the current point to (x,y) using
76508     * (x1,y1) as the control point at the beginning of the curve and (x2,y2)
76509     * as the control point at the end of the curve using absolute
76510     * coordinates. At the end of the command, the new current point becomes
76511     * the final (x,y) coordinate pair used in the polybezier.
76512     *
76513     * @param float $x1 x coordinate of the first control point
76514     * @param float $y1 y coordinate of the first control point
76515     * @param float $x2 x coordinate of the second control point
76516     * @param float $y2 y coordinate of the first control point
76517     * @param float $x x coordinate of the curve end
76518     * @param float $y y coordinate of the curve end
76519     * @return bool
76520     * @since PECL imagick 2.0.0
76521     **/
76522    function pathCurveToAbsolute($x1, $y1, $x2, $y2, $x, $y){}
76523
76524    /**
76525     * Draws a quadratic Bezier curve from the current point to (x,y) using
76526     * (x1,y1) as the control point using absolute coordinates. At the end of
76527     * the command, the new current point becomes the final (x,y) coordinate
76528     * pair used in the polybezier.
76529     *
76530     * @param float $x1 x coordinate of the control point
76531     * @param float $y1 y coordinate of the control point
76532     * @param float $x x coordinate of the end point
76533     * @param float $y y coordinate of the end point
76534     * @return bool
76535     * @since PECL imagick 2.0.0
76536     **/
76537    function pathCurveToQuadraticBezierAbsolute($x1, $y1, $x, $y){}
76538
76539    /**
76540     * Draws a quadratic Bezier curve from the current point to (x,y) using
76541     * (x1,y1) as the control point using relative coordinates. At the end of
76542     * the command, the new current point becomes the final (x,y) coordinate
76543     * pair used in the polybezier.
76544     *
76545     * @param float $x1 starting x coordinate
76546     * @param float $y1 starting y coordinate
76547     * @param float $x ending x coordinate
76548     * @param float $y ending y coordinate
76549     * @return bool
76550     * @since PECL imagick 2.0.0
76551     **/
76552    function pathCurveToQuadraticBezierRelative($x1, $y1, $x, $y){}
76553
76554    /**
76555     * Draws a quadratic Bezier curve (using absolute coordinates) from the
76556     * current point to (x,y). The control point is assumed to be the
76557     * reflection of the control point on the previous command relative to
76558     * the current point. (If there is no previous command or if the previous
76559     * command was not a DrawPathCurveToQuadraticBezierAbsolute,
76560     * DrawPathCurveToQuadraticBezierRelative,
76561     * DrawPathCurveToQuadraticBezierSmoothAbsolut or
76562     * DrawPathCurveToQuadraticBezierSmoothRelative, assume the control point
76563     * is coincident with the current point.). At the end of the command, the
76564     * new current point becomes the final (x,y) coordinate pair used in the
76565     * polybezier.
76566     *
76567     * @param float $x ending x coordinate
76568     * @param float $y ending y coordinate
76569     * @return bool
76570     * @since PECL imagick 2.0.0
76571     **/
76572    function pathCurveToQuadraticBezierSmoothAbsolute($x, $y){}
76573
76574    /**
76575     * Draws a quadratic Bezier curve (using relative coordinates) from the
76576     * current point to (x, y). The control point is assumed to be the
76577     * reflection of the control point on the previous command relative to
76578     * the current point. (If there is no previous command or if the previous
76579     * command was not a DrawPathCurveToQuadraticBezierAbsolute,
76580     * DrawPathCurveToQuadraticBezierRelative,
76581     * DrawPathCurveToQuadraticBezierSmoothAbsolut or
76582     * DrawPathCurveToQuadraticBezierSmoothRelative, assume the control point
76583     * is coincident with the current point). At the end of the command, the
76584     * new current point becomes the final (x, y) coordinate pair used in the
76585     * polybezier.
76586     *
76587     * @param float $x ending x coordinate
76588     * @param float $y ending y coordinate
76589     * @return bool
76590     * @since PECL imagick 2.0.0
76591     **/
76592    function pathCurveToQuadraticBezierSmoothRelative($x, $y){}
76593
76594    /**
76595     * Draws a cubic Bezier curve from the current point to (x,y) using
76596     * (x1,y1) as the control point at the beginning of the curve and (x2,y2)
76597     * as the control point at the end of the curve using relative
76598     * coordinates. At the end of the command, the new current point becomes
76599     * the final (x,y) coordinate pair used in the polybezier.
76600     *
76601     * @param float $x1 x coordinate of starting control point
76602     * @param float $y1 y coordinate of starting control point
76603     * @param float $x2 x coordinate of ending control point
76604     * @param float $y2 y coordinate of ending control point
76605     * @param float $x ending x coordinate
76606     * @param float $y ending y coordinate
76607     * @return bool
76608     * @since PECL imagick 2.0.0
76609     **/
76610    function pathCurveToRelative($x1, $y1, $x2, $y2, $x, $y){}
76611
76612    /**
76613     * Draws a cubic Bezier curve from the current point to (x,y) using
76614     * absolute coordinates. The first control point is assumed to be the
76615     * reflection of the second control point on the previous command
76616     * relative to the current point. (If there is no previous command or if
76617     * the previous command was not an DrawPathCurveToAbsolute,
76618     * DrawPathCurveToRelative, DrawPathCurveToSmoothAbsolute or
76619     * DrawPathCurveToSmoothRelative, assume the first control point is
76620     * coincident with the current point.) (x2,y2) is the second control
76621     * point (i.e., the control point at the end of the curve). At the end of
76622     * the command, the new current point becomes the final (x,y) coordinate
76623     * pair used in the polybezier.
76624     *
76625     * @param float $x2 x coordinate of the second control point
76626     * @param float $y2 y coordinate of the second control point
76627     * @param float $x x coordinate of the ending point
76628     * @param float $y y coordinate of the ending point
76629     * @return bool
76630     * @since PECL imagick 2.0.0
76631     **/
76632    function pathCurveToSmoothAbsolute($x2, $y2, $x, $y){}
76633
76634    /**
76635     * Draws a cubic Bezier curve from the current point to (x,y) using
76636     * relative coordinates. The first control point is assumed to be the
76637     * reflection of the second control point on the previous command
76638     * relative to the current point. (If there is no previous command or if
76639     * the previous command was not an DrawPathCurveToAbsolute,
76640     * DrawPathCurveToRelative, DrawPathCurveToSmoothAbsolute or
76641     * DrawPathCurveToSmoothRelative, assume the first control point is
76642     * coincident with the current point.) (x2,y2) is the second control
76643     * point (i.e., the control point at the end of the curve). At the end of
76644     * the command, the new current point becomes the final (x,y) coordinate
76645     * pair used in the polybezier.
76646     *
76647     * @param float $x2 x coordinate of the second control point
76648     * @param float $y2 y coordinate of the second control point
76649     * @param float $x x coordinate of the ending point
76650     * @param float $y y coordinate of the ending point
76651     * @return bool
76652     * @since PECL imagick 2.0.0
76653     **/
76654    function pathCurveToSmoothRelative($x2, $y2, $x, $y){}
76655
76656    /**
76657     * Draws an elliptical arc from the current point to (x, y) using
76658     * absolute coordinates. The size and orientation of the ellipse are
76659     * defined by two radii (rx, ry) and an xAxisRotation, which indicates
76660     * how the ellipse as a whole is rotated relative to the current
76661     * coordinate system. The center (cx, cy) of the ellipse is calculated
76662     * automatically to satisfy the constraints imposed by the other
76663     * parameters. largeArcFlag and sweepFlag contribute to the automatic
76664     * calculations and help determine how the arc is drawn. If largeArcFlag
76665     * is then draw the larger of the available arcs. If sweepFlag is true,
76666     * then draw the arc matching a clock-wise rotation.
76667     *
76668     * @param float $rx x radius
76669     * @param float $ry y radius
76670     * @param float $x_axis_rotation x axis rotation
76671     * @param bool $large_arc_flag large arc flag
76672     * @param bool $sweep_flag sweep flag
76673     * @param float $x x coordinate
76674     * @param float $y y coordinate
76675     * @return bool
76676     * @since PECL imagick 2.0.0
76677     **/
76678    function pathEllipticArcAbsolute($rx, $ry, $x_axis_rotation, $large_arc_flag, $sweep_flag, $x, $y){}
76679
76680    /**
76681     * Draws an elliptical arc from the current point to (x, y) using
76682     * relative coordinates. The size and orientation of the ellipse are
76683     * defined by two radii (rx, ry) and an xAxisRotation, which indicates
76684     * how the ellipse as a whole is rotated relative to the current
76685     * coordinate system. The center (cx, cy) of the ellipse is calculated
76686     * automatically to satisfy the constraints imposed by the other
76687     * parameters. largeArcFlag and sweepFlag contribute to the automatic
76688     * calculations and help determine how the arc is drawn. If largeArcFlag
76689     * is then draw the larger of the available arcs. If sweepFlag is true,
76690     * then draw the arc matching a clock-wise rotation.
76691     *
76692     * @param float $rx x radius
76693     * @param float $ry y radius
76694     * @param float $x_axis_rotation x axis rotation
76695     * @param bool $large_arc_flag large arc flag
76696     * @param bool $sweep_flag sweep flag
76697     * @param float $x x coordinate
76698     * @param float $y y coordinate
76699     * @return bool
76700     * @since PECL imagick 2.0.0
76701     **/
76702    function pathEllipticArcRelative($rx, $ry, $x_axis_rotation, $large_arc_flag, $sweep_flag, $x, $y){}
76703
76704    /**
76705     * Terminates the current path.
76706     *
76707     * @return bool
76708     * @since PECL imagick 2.0.0
76709     **/
76710    function pathFinish(){}
76711
76712    /**
76713     * Draws a line path from the current point to the given coordinate using
76714     * absolute coordinates. The coordinate then becomes the new current
76715     * point.
76716     *
76717     * @param float $x starting x coordinate
76718     * @param float $y ending x coordinate
76719     * @return bool
76720     * @since PECL imagick 2.0.0
76721     **/
76722    function pathLineToAbsolute($x, $y){}
76723
76724    /**
76725     * Draws a horizontal line path from the current point to the target
76726     * point using absolute coordinates. The target point then becomes the
76727     * new current point.
76728     *
76729     * @param float $x x coordinate
76730     * @return bool
76731     * @since PECL imagick 2.0.0
76732     **/
76733    function pathLineToHorizontalAbsolute($x){}
76734
76735    /**
76736     * Draws a horizontal line path from the current point to the target
76737     * point using relative coordinates. The target point then becomes the
76738     * new current point.
76739     *
76740     * @param float $x x coordinate
76741     * @return bool
76742     * @since PECL imagick 2.0.0
76743     **/
76744    function pathLineToHorizontalRelative($x){}
76745
76746    /**
76747     * Draws a line path from the current point to the given coordinate using
76748     * relative coordinates. The coordinate then becomes the new current
76749     * point.
76750     *
76751     * @param float $x starting x coordinate
76752     * @param float $y starting y coordinate
76753     * @return bool
76754     * @since PECL imagick 2.0.0
76755     **/
76756    function pathLineToRelative($x, $y){}
76757
76758    /**
76759     * Draws a vertical line path from the current point to the target point
76760     * using absolute coordinates. The target point then becomes the new
76761     * current point.
76762     *
76763     * @param float $y y coordinate
76764     * @return bool
76765     * @since PECL imagick 2.0.0
76766     **/
76767    function pathLineToVerticalAbsolute($y){}
76768
76769    /**
76770     * Draws a vertical line path from the current point to the target point
76771     * using relative coordinates. The target point then becomes the new
76772     * current point.
76773     *
76774     * @param float $y y coordinate
76775     * @return bool
76776     * @since PECL imagick 2.0.0
76777     **/
76778    function pathLineToVerticalRelative($y){}
76779
76780    /**
76781     * Starts a new sub-path at the given coordinate using absolute
76782     * coordinates. The current point then becomes the specified coordinate.
76783     *
76784     * @param float $x x coordinate of the starting point
76785     * @param float $y y coordinate of the starting point
76786     * @return bool
76787     * @since PECL imagick 2.0.0
76788     **/
76789    function pathMoveToAbsolute($x, $y){}
76790
76791    /**
76792     * Starts a new sub-path at the given coordinate using relative
76793     * coordinates. The current point then becomes the specified coordinate.
76794     *
76795     * @param float $x target x coordinate
76796     * @param float $y target y coordinate
76797     * @return bool
76798     * @since PECL imagick 2.0.0
76799     **/
76800    function pathMoveToRelative($x, $y){}
76801
76802    /**
76803     * Declares the start of a path drawing list which is terminated by a
76804     * matching DrawPathFinish() command. All other DrawPath commands must be
76805     * enclosed between a and a DrawPathFinish() command. This is because
76806     * path drawing commands are subordinate commands and they do not
76807     * function by themselves.
76808     *
76809     * @return bool
76810     * @since PECL imagick 2.0.0
76811     **/
76812    function pathStart(){}
76813
76814    /**
76815     * Draws a point using the current stroke color and stroke thickness at
76816     * the specified coordinates.
76817     *
76818     * @param float $x point's x coordinate
76819     * @param float $y point's y coordinate
76820     * @return bool
76821     * @since PECL imagick 2.0.0
76822     **/
76823    function point($x, $y){}
76824
76825    /**
76826     * Draws a polygon using the current stroke, stroke width, and fill color
76827     * or texture, using the specified array of coordinates.
76828     *
76829     * @param array $coordinates multidimensional array like array( array(
76830     *   'x' => 3, 'y' => 4 ), array( 'x' => 2, 'y' => 6 ) );
76831     * @return bool
76832     * @since PECL imagick 2.0.0
76833     **/
76834    function polygon($coordinates){}
76835
76836    /**
76837     * Draws a polyline using the current stroke, stroke width, and fill
76838     * color or texture, using the specified array of coordinates.
76839     *
76840     * @param array $coordinates array of x and y coordinates: array(
76841     *   array( 'x' => 4, 'y' => 6 ), array( 'x' => 8, 'y' => 10 ) )
76842     * @return bool
76843     * @since PECL imagick 2.0.0
76844     **/
76845    function polyline($coordinates){}
76846
76847    /**
76848     * Destroys the current ImagickDraw in the stack, and returns to the
76849     * previously pushed ImagickDraw. Multiple ImagickDraws may exist. It is
76850     * an error to attempt to pop more ImagickDraws than have been pushed,
76851     * and it is proper form to pop all ImagickDraws which have been pushed.
76852     *
76853     * @return bool
76854     * @since PECL imagick 2.0.0
76855     **/
76856    function pop(){}
76857
76858    /**
76859     * Terminates a clip path definition.
76860     *
76861     * @return bool
76862     * @since PECL imagick 2.0.0
76863     **/
76864    function popClipPath(){}
76865
76866    /**
76867     * Terminates a definition list.
76868     *
76869     * @return bool
76870     * @since PECL imagick 2.0.0
76871     **/
76872    function popDefs(){}
76873
76874    /**
76875     * Terminates a pattern definition.
76876     *
76877     * @return bool
76878     * @since PECL imagick 2.0.0
76879     **/
76880    function popPattern(){}
76881
76882    /**
76883     * Clones the current ImagickDraw to create a new ImagickDraw, which is
76884     * then added to the ImagickDraw stack. The original drawing
76885     * ImagickDraw(s) may be returned to by invoking pop(). The ImagickDraws
76886     * are stored on a ImagickDraw stack. For every Pop there must have
76887     * already been an equivalent Push.
76888     *
76889     * @return bool
76890     * @since PECL imagick 2.0.0
76891     **/
76892    function push(){}
76893
76894    /**
76895     * Starts a clip path definition which is comprised of any number of
76896     * drawing commands and terminated by a ImagickDraw::popClipPath()
76897     * command.
76898     *
76899     * @param string $clip_mask_id Clip mask Id
76900     * @return bool
76901     * @since PECL imagick 2.0.0
76902     **/
76903    function pushClipPath($clip_mask_id){}
76904
76905    /**
76906     * Indicates that commands up to a terminating ImagickDraw::popDefs()
76907     * command create named elements (e.g. clip-paths, textures, etc.) which
76908     * may safely be processed earlier for the sake of efficiency.
76909     *
76910     * @return bool
76911     * @since PECL imagick 2.0.0
76912     **/
76913    function pushDefs(){}
76914
76915    /**
76916     * Indicates that subsequent commands up to a DrawPopPattern() command
76917     * comprise the definition of a named pattern. The pattern space is
76918     * assigned top left corner coordinates, a width and height, and becomes
76919     * its own drawing space. Anything which can be drawn may be used in a
76920     * pattern definition. Named patterns may be used as stroke or brush
76921     * definitions.
76922     *
76923     * @param string $pattern_id the pattern Id
76924     * @param float $x x coordinate of the top-left corner
76925     * @param float $y y coordinate of the top-left corner
76926     * @param float $width width of the pattern
76927     * @param float $height height of the pattern
76928     * @return bool
76929     * @since PECL imagick 2.0.0
76930     **/
76931    function pushPattern($pattern_id, $x, $y, $width, $height){}
76932
76933    /**
76934     * Draws a rectangle given two coordinates and using the current stroke,
76935     * stroke width, and fill settings.
76936     *
76937     * @param float $x1 x coordinate of the top left corner
76938     * @param float $y1 y coordinate of the top left corner
76939     * @param float $x2 x coordinate of the bottom right corner
76940     * @param float $y2 y coordinate of the bottom right corner
76941     * @return bool
76942     * @since PECL imagick 2.0.0
76943     **/
76944    function rectangle($x1, $y1, $x2, $y2){}
76945
76946    /**
76947     * Renders all preceding drawing commands onto the image.
76948     *
76949     * @return bool
76950     * @since PECL imagick 2.0.0
76951     **/
76952    function render(){}
76953
76954    /**
76955     * Applies the specified rotation to the current coordinate space.
76956     *
76957     * @param float $degrees degrees to rotate
76958     * @return bool
76959     * @since PECL imagick 2.0.0
76960     **/
76961    function rotate($degrees){}
76962
76963    /**
76964     * Draws a rounded rectangle given two coordinates, x & y corner radiuses
76965     * and using the current stroke, stroke width, and fill settings.
76966     *
76967     * @param float $x1 x coordinate of the top left corner
76968     * @param float $y1 y coordinate of the top left corner
76969     * @param float $x2 x coordinate of the bottom right
76970     * @param float $y2 y coordinate of the bottom right
76971     * @param float $rx x rounding
76972     * @param float $ry y rounding
76973     * @return bool
76974     * @since PECL imagick 2.0.0
76975     **/
76976    function roundRectangle($x1, $y1, $x2, $y2, $rx, $ry){}
76977
76978    /**
76979     * Adjusts the scaling factor to apply in the horizontal and vertical
76980     * directions to the current coordinate space.
76981     *
76982     * @param float $x horizontal factor
76983     * @param float $y vertical factor
76984     * @return bool
76985     * @since PECL imagick 2.0.0
76986     **/
76987    function scale($x, $y){}
76988
76989    /**
76990     * Associates a named clipping path with the image. Only the areas drawn
76991     * on by the clipping path will be modified as long as it remains in
76992     * effect.
76993     *
76994     * @param string $clip_mask the clipping path name
76995     * @return bool
76996     * @since PECL imagick 2.0.0
76997     **/
76998    function setClipPath($clip_mask){}
76999
77000    /**
77001     * Set the polygon fill rule to be used by the clipping path.
77002     *
77003     * @param int $fill_rule FILLRULE_ constant
77004     * @return bool
77005     * @since PECL imagick 2.0.0
77006     **/
77007    function setClipRule($fill_rule){}
77008
77009    /**
77010     * Sets the interpretation of clip path units.
77011     *
77012     * @param int $clip_units the number of clip units
77013     * @return bool
77014     * @since PECL imagick 2.0.0
77015     **/
77016    function setClipUnits($clip_units){}
77017
77018    /**
77019     * Sets the opacity to use when drawing using the fill color or fill
77020     * texture. Fully opaque is 1.0.
77021     *
77022     * @param float $opacity fill alpha
77023     * @return bool
77024     * @since PECL imagick 2.0.0
77025     **/
77026    function setFillAlpha($opacity){}
77027
77028    /**
77029     * Sets the fill color to be used for drawing filled objects.
77030     *
77031     * @param ImagickPixel $fill_pixel ImagickPixel to use to set the color
77032     * @return bool
77033     * @since PECL imagick 2.0.0
77034     **/
77035    function setFillColor($fill_pixel){}
77036
77037    /**
77038     * Sets the opacity to use when drawing using the fill color or fill
77039     * texture. Fully opaque is 1.0.
77040     *
77041     * @param float $fillOpacity the fill opacity
77042     * @return bool
77043     * @since PECL imagick 2.0.0
77044     **/
77045    function setFillOpacity($fillOpacity){}
77046
77047    /**
77048     * Sets the URL to use as a fill pattern for filling objects. Only local
77049     * URLs ("#identifier") are supported at this time. These local URLs are
77050     * normally created by defining a named fill pattern with
77051     * DrawPushPattern/DrawPopPattern.
77052     *
77053     * @param string $fill_url URL to use to obtain fill pattern.
77054     * @return bool
77055     * @since PECL imagick 2.0.0
77056     **/
77057    function setFillPatternURL($fill_url){}
77058
77059    /**
77060     * Sets the fill rule to use while drawing polygons.
77061     *
77062     * @param int $fill_rule FILLRULE_ constant
77063     * @return bool
77064     * @since PECL imagick 2.0.0
77065     **/
77066    function setFillRule($fill_rule){}
77067
77068    /**
77069     * Sets the fully-specified font to use when annotating with text.
77070     *
77071     * @param string $font_name
77072     * @return bool
77073     * @since PECL imagick 2.0.0
77074     **/
77075    function setFont($font_name){}
77076
77077    /**
77078     * Sets the font family to use when annotating with text.
77079     *
77080     * @param string $font_family the font family
77081     * @return bool
77082     * @since PECL imagick 2.0.0
77083     **/
77084    function setFontFamily($font_family){}
77085
77086    /**
77087     * Sets the font pointsize to use when annotating with text.
77088     *
77089     * @param float $pointsize the point size
77090     * @return bool
77091     * @since PECL imagick 2.0.0
77092     **/
77093    function setFontSize($pointsize){}
77094
77095    /**
77096     * Sets the font stretch to use when annotating with text. The AnyStretch
77097     * enumeration acts as a wild-card "don't care" option.
77098     *
77099     * @param int $fontStretch STRETCH_ constant
77100     * @return bool
77101     * @since PECL imagick 2.0.0
77102     **/
77103    function setFontStretch($fontStretch){}
77104
77105    /**
77106     * Sets the font style to use when annotating with text. The AnyStyle
77107     * enumeration acts as a wild-card "don't care" option.
77108     *
77109     * @param int $style STYLETYPE_ constant
77110     * @return bool
77111     * @since PECL imagick 2.0.0
77112     **/
77113    function setFontStyle($style){}
77114
77115    /**
77116     * Sets the font weight to use when annotating with text.
77117     *
77118     * @param int $font_weight
77119     * @return bool
77120     * @since PECL imagick 2.0.0
77121     **/
77122    function setFontWeight($font_weight){}
77123
77124    /**
77125     * Sets the text placement gravity to use when annotating with text.
77126     *
77127     * @param int $gravity GRAVITY_ constant
77128     * @return bool
77129     * @since PECL imagick 2.0.0
77130     **/
77131    function setGravity($gravity){}
77132
77133    /**
77134     * Specifies the opacity of stroked object outlines.
77135     *
77136     * @param float $opacity opacity
77137     * @return bool
77138     * @since PECL imagick 2.0.0
77139     **/
77140    function setStrokeAlpha($opacity){}
77141
77142    /**
77143     * Controls whether stroked outlines are antialiased. Stroked outlines
77144     * are antialiased by default. When antialiasing is disabled stroked
77145     * pixels are thresholded to determine if the stroke color or underlying
77146     * canvas color should be used.
77147     *
77148     * @param bool $stroke_antialias the antialias setting
77149     * @return bool
77150     * @since PECL imagick 2.0.0
77151     **/
77152    function setStrokeAntialias($stroke_antialias){}
77153
77154    /**
77155     * Sets the color used for stroking object outlines.
77156     *
77157     * @param ImagickPixel $stroke_pixel the stroke color
77158     * @return bool
77159     * @since PECL imagick 2.0.0
77160     **/
77161    function setStrokeColor($stroke_pixel){}
77162
77163    /**
77164     * Specifies the pattern of dashes and gaps used to stroke paths. The
77165     * strokeDashArray represents an array of numbers that specify the
77166     * lengths of alternating dashes and gaps in pixels. If an odd number of
77167     * values is provided, then the list of values is repeated to yield an
77168     * even number of values. To remove an existing dash array, pass a zero
77169     * number_elements argument and null dash_array. A typical
77170     * strokeDashArray_ array might contain the members 5 3 2.
77171     *
77172     * @param array $dashArray array of floats
77173     * @return bool
77174     * @since PECL imagick 2.0.0
77175     **/
77176    function setStrokeDashArray($dashArray){}
77177
77178    /**
77179     * Specifies the offset into the dash pattern to start the dash.
77180     *
77181     * @param float $dash_offset dash offset
77182     * @return bool
77183     * @since PECL imagick 2.0.0
77184     **/
77185    function setStrokeDashOffset($dash_offset){}
77186
77187    /**
77188     * Specifies the shape to be used at the end of open subpaths when they
77189     * are stroked.
77190     *
77191     * @param int $linecap LINECAP_ constant
77192     * @return bool
77193     * @since PECL imagick 2.0.0
77194     **/
77195    function setStrokeLineCap($linecap){}
77196
77197    /**
77198     * Specifies the shape to be used at the corners of paths (or other
77199     * vector shapes) when they are stroked.
77200     *
77201     * @param int $linejoin LINEJOIN_ constant
77202     * @return bool
77203     * @since PECL imagick 2.0.0
77204     **/
77205    function setStrokeLineJoin($linejoin){}
77206
77207    /**
77208     * Specifies the miter limit. When two line segments meet at a sharp
77209     * angle and miter joins have been specified for 'lineJoin', it is
77210     * possible for the miter to extend far beyond the thickness of the line
77211     * stroking the path. The miterLimit' imposes a limit on the ratio of the
77212     * miter length to the 'lineWidth'.
77213     *
77214     * @param int $miterlimit the miter limit
77215     * @return bool
77216     * @since PECL imagick 2.0.0
77217     **/
77218    function setStrokeMiterLimit($miterlimit){}
77219
77220    /**
77221     * Specifies the opacity of stroked object outlines.
77222     *
77223     * @param float $stroke_opacity stroke opacity. 1.0 is fully opaque
77224     * @return bool
77225     * @since PECL imagick 2.0.0
77226     **/
77227    function setStrokeOpacity($stroke_opacity){}
77228
77229    /**
77230     * Sets the pattern used for stroking object outlines.
77231     *
77232     * @param string $stroke_url stroke URL
77233     * @return bool
77234     * @since PECL imagick 2.0.0
77235     **/
77236    function setStrokePatternURL($stroke_url){}
77237
77238    /**
77239     * Sets the width of the stroke used to draw object outlines.
77240     *
77241     * @param float $stroke_width stroke width
77242     * @return bool
77243     * @since PECL imagick 2.0.0
77244     **/
77245    function setStrokeWidth($stroke_width){}
77246
77247    /**
77248     * Specifies a text alignment to be applied when annotating with text.
77249     *
77250     * @param int $alignment ALIGN_ constant
77251     * @return bool
77252     * @since PECL imagick 2.0.0
77253     **/
77254    function setTextAlignment($alignment){}
77255
77256    /**
77257     * Controls whether text is antialiased. Text is antialiased by default.
77258     *
77259     * @param bool $antiAlias
77260     * @return bool
77261     * @since PECL imagick 2.0.0
77262     **/
77263    function setTextAntialias($antiAlias){}
77264
77265    /**
77266     * Specifies a decoration to be applied when annotating with text.
77267     *
77268     * @param int $decoration DECORATION_ constant
77269     * @return bool
77270     * @since PECL imagick 2.0.0
77271     **/
77272    function setTextDecoration($decoration){}
77273
77274    /**
77275     * Specifies specifies the code set to use for text annotations. The only
77276     * character encoding which may be specified at this time is "UTF-8" for
77277     * representing Unicode as a sequence of bytes. Specify an empty string
77278     * to set text encoding to the system's default. Successful text
77279     * annotation using Unicode may require fonts designed to support
77280     * Unicode.
77281     *
77282     * @param string $encoding the encoding name
77283     * @return bool
77284     * @since PECL imagick 2.0.0
77285     **/
77286    function setTextEncoding($encoding){}
77287
77288    /**
77289     * Specifies the color of a background rectangle to place under text
77290     * annotations.
77291     *
77292     * @param ImagickPixel $under_color the under color
77293     * @return bool
77294     * @since PECL imagick 2.0.0
77295     **/
77296    function setTextUnderColor($under_color){}
77297
77298    /**
77299     * Sets the vector graphics associated with the specified ImagickDraw
77300     * object. Use this method with ImagickDraw::getVectorGraphics() as a
77301     * method to persist the vector graphics state.
77302     *
77303     * @param string $xml xml containing the vector graphics
77304     * @return bool
77305     * @since PECL imagick 2.0.0
77306     **/
77307    function setVectorGraphics($xml){}
77308
77309    /**
77310     * Sets the overall canvas size to be recorded with the drawing vector
77311     * data. Usually this will be specified using the same size as the canvas
77312     * image. When the vector data is saved to SVG or MVG formats, the
77313     * viewbox is use to specify the size of the canvas image that a viewer
77314     * will render the vector data on.
77315     *
77316     * @param int $x1 left x coordinate
77317     * @param int $y1 left y coordinate
77318     * @param int $x2 right x coordinate
77319     * @param int $y2 right y coordinate
77320     * @return bool
77321     * @since PECL imagick 2.0.0
77322     **/
77323    function setViewbox($x1, $y1, $x2, $y2){}
77324
77325    /**
77326     * Skews the current coordinate system in the horizontal direction.
77327     *
77328     * @param float $degrees degrees to skew
77329     * @return bool
77330     * @since PECL imagick 2.0.0
77331     **/
77332    function skewX($degrees){}
77333
77334    /**
77335     * Skews the current coordinate system in the vertical direction.
77336     *
77337     * @param float $degrees degrees to skew
77338     * @return bool
77339     * @since PECL imagick 2.0.0
77340     **/
77341    function skewY($degrees){}
77342
77343    /**
77344     * Applies a translation to the current coordinate system which moves the
77345     * coordinate system origin to the specified coordinate.
77346     *
77347     * @param float $x horizontal translation
77348     * @param float $y vertical translation
77349     * @return bool
77350     * @since PECL imagick 2.0.0
77351     **/
77352    function translate($x, $y){}
77353
77354    /**
77355     * The ImagickDraw constructor
77356     *
77357     * @return ImagickDraw
77358     **/
77359    function __construct(){}
77360
77361}
77362class ImagickPixel {
77363    /**
77364     * Clears the ImagickPixel object, leaving it in a fresh state. This also
77365     * unsets any color associated with the object.
77366     *
77367     * @return bool
77368     * @since PECL imagick 2.0.0
77369     **/
77370    function clear(){}
77371
77372    /**
77373     * Deallocates any resources used by the ImagickPixel object, and unsets
77374     * any associated color. The object should not be used after the destroy
77375     * function has been called.
77376     *
77377     * @return bool
77378     * @since PECL imagick 2.0.0
77379     **/
77380    function destroy(){}
77381
77382    /**
77383     * Returns the color described by the ImagickPixel object, as an array.
77384     * If the color has an opacity channel set, this is provided as a fourth
77385     * value in the list.
77386     *
77387     * @param bool $normalized Normalize the color values
77388     * @return array
77389     * @since PECL imagick 2.0.0
77390     **/
77391    function getColor($normalized){}
77392
77393    /**
77394     * Returns the color of the ImagickPixel object as a string.
77395     *
77396     * @return string
77397     * @since PECL imagick 2.1.0
77398     **/
77399    function getColorAsString(){}
77400
77401    /**
77402     * Returns the color count associated with this color.
77403     *
77404     * @return int
77405     * @since PECL imagick 2.0.0
77406     **/
77407    function getColorCount(){}
77408
77409    /**
77410     * Retrieves the value of the color channel specified, as a
77411     * floating-point number between 0 and 1.
77412     *
77413     * @param int $color The channel to check, specified as one of the
77414     *   Imagick channel constants.
77415     * @return float
77416     * @since PECL imagick 2.0.0
77417     **/
77418    function getColorValue($color){}
77419
77420    /**
77421     * Returns the normalized HSL color described by the ImagickPixel object,
77422     * with each of the three values as floating point numbers between 0.0
77423     * and 1.0.
77424     *
77425     * @return array
77426     * @since PECL imagick 2.0.0
77427     **/
77428    function getHSL(){}
77429
77430    /**
77431     * Checks the distance between the color described by this ImagickPixel
77432     * object and that of the provided object, by plotting their RGB values
77433     * on the color cube. If the distance between the two points is less than
77434     * the fuzz value given, the colors are similar.
77435     *
77436     * @param ImagickPixel $color The ImagickPixel object to compare this
77437     *   object against.
77438     * @param float $fuzz The maximum distance within which to consider
77439     *   these colors as similar. The theoretical maximum for this value is
77440     *   the square root of three (1.732).
77441     * @return bool
77442     * @since PECL imagick 2.0.0
77443     **/
77444    function isSimilar($color, $fuzz){}
77445
77446    /**
77447     * Sets the color described by the ImagickPixel object, with a string
77448     * (e.g. "blue", "#0000ff", "rgb(0,0,255)", "cmyk(100,100,100,10)",
77449     * etc.).
77450     *
77451     * @param string $color The color definition to use in order to
77452     *   initialise the ImagickPixel object.
77453     * @return bool
77454     * @since PECL imagick 2.0.0
77455     **/
77456    function setColor($color){}
77457
77458    /**
77459     * Sets the value of the specified channel of this object to the provided
77460     * value, which should be between 0 and 1. This function can be used to
77461     * provide an opacity channel to an ImagickPixel object.
77462     *
77463     * @param int $color One of the Imagick channel color constants.
77464     * @param float $value The value to set this channel to, ranging from 0
77465     *   to 1.
77466     * @return bool
77467     * @since PECL imagick 2.0.0
77468     **/
77469    function setColorValue($color, $value){}
77470
77471    /**
77472     * Sets the color described by the ImagickPixel object using normalized
77473     * values for hue, saturation and luminosity.
77474     *
77475     * @param float $hue The normalized value for hue, described as a
77476     *   fractional arc (between 0 and 1) of the hue circle, where the zero
77477     *   value is red.
77478     * @param float $saturation The normalized value for saturation, with 1
77479     *   as full saturation.
77480     * @param float $luminosity The normalized value for luminosity, on a
77481     *   scale from black at 0 to white at 1, with the full HS value at 0.5
77482     *   luminosity.
77483     * @return bool
77484     * @since PECL imagick 2.0.0
77485     **/
77486    function setHSL($hue, $saturation, $luminosity){}
77487
77488    /**
77489     * Constructs an ImagickPixel object. If a color is specified, the object
77490     * is constructed and then initialised with that color before being
77491     * returned.
77492     *
77493     * @param string $color The optional color string to use as the initial
77494     *   value of this object.
77495     * @return ImagickPixel
77496     * @since PECL imagick 2.0.0
77497     **/
77498    function __construct($color){}
77499
77500}
77501class ImagickPixelIterator {
77502    /**
77503     * Clear resources associated with a PixelIterator.
77504     *
77505     * @return bool
77506     * @since PECL imagick 2.0.0
77507     **/
77508    function clear(){}
77509
77510    /**
77511     * Deallocates resources associated with a PixelIterator.
77512     *
77513     * @return bool
77514     * @since PECL imagick 2.0.0
77515     **/
77516    function destroy(){}
77517
77518    /**
77519     * Returns the current row as an array of ImagickPixel objects from the
77520     * pixel iterator.
77521     *
77522     * @return array
77523     * @since PECL imagick 2.0.0
77524     **/
77525    function getCurrentIteratorRow(){}
77526
77527    /**
77528     * Returns the current pixel iterator row.
77529     *
77530     * @return int
77531     * @since PECL imagick 2.0.0
77532     **/
77533    function getIteratorRow(){}
77534
77535    /**
77536     * Returns the next row as an array of pixel wands from the pixel
77537     * iterator.
77538     *
77539     * @return array
77540     * @since PECL imagick 2.0.0
77541     **/
77542    function getNextIteratorRow(){}
77543
77544    /**
77545     * Returns the previous row as an array of pixel wands from the pixel
77546     * iterator.
77547     *
77548     * @return array
77549     * @since PECL imagick 2.0.0
77550     **/
77551    function getPreviousIteratorRow(){}
77552
77553    /**
77554     * Returns a new pixel iterator.
77555     *
77556     * @param Imagick $wand
77557     * @return bool
77558     * @since PECL imagick 2.0.0
77559     **/
77560    function newPixelIterator($wand){}
77561
77562    /**
77563     * Returns a new pixel iterator.
77564     *
77565     * @param Imagick $wand
77566     * @param int $x
77567     * @param int $y
77568     * @param int $columns
77569     * @param int $rows
77570     * @return bool
77571     * @since PECL imagick 2.0.0
77572     **/
77573    function newPixelRegionIterator($wand, $x, $y, $columns, $rows){}
77574
77575    /**
77576     * Resets the pixel iterator. Use it in conjunction with
77577     * ImagickPixelIterator::getNextIteratorRow() to iterate over all the
77578     * pixels in a pixel container.
77579     *
77580     * @return bool
77581     * @since PECL imagick 2.0.0
77582     **/
77583    function resetIterator(){}
77584
77585    /**
77586     * Sets the pixel iterator to the first pixel row.
77587     *
77588     * @return bool
77589     * @since PECL imagick 2.0.0
77590     **/
77591    function setIteratorFirstRow(){}
77592
77593    /**
77594     * Sets the pixel iterator to the last pixel row.
77595     *
77596     * @return bool
77597     * @since PECL imagick 2.0.0
77598     **/
77599    function setIteratorLastRow(){}
77600
77601    /**
77602     * Set the pixel iterator row.
77603     *
77604     * @param int $row
77605     * @return bool
77606     * @since PECL imagick 2.0.0
77607     **/
77608    function setIteratorRow($row){}
77609
77610    /**
77611     * Syncs the pixel iterator.
77612     *
77613     * @return bool
77614     * @since PECL imagick 2.0.0
77615     **/
77616    function syncIterator(){}
77617
77618    /**
77619     * The ImagickPixelIterator constructor
77620     *
77621     * @param Imagick $wand
77622     * @return ImagickPixelIterator
77623     * @since PECL imagick 2.0.0
77624     **/
77625    function __construct($wand){}
77626
77627}
77628/**
77629 * The allows one to infinitely iterate over an iterator without having
77630 * to manually rewind the iterator upon reaching its end.
77631 **/
77632class InfiniteIterator extends IteratorIterator implements OuterIterator, Traversable, Iterator {
77633    /**
77634     * Moves the inner Iterator forward to its next element if there is one,
77635     * otherwise rewinds the inner Iterator back to the beginning.
77636     *
77637     * @return void
77638     * @since PHP 5 >= 5.1.0
77639     **/
77640    function next(){}
77641
77642    /**
77643     * Constructs an InfiniteIterator from an Iterator.
77644     *
77645     * @param Iterator $iterator The iterator to infinitely iterate over.
77646     * @since PHP 5 >= 5.1.0
77647     **/
77648    function __construct($iterator){}
77649
77650}
77651class IntlDateFormatter {
77652    /**
77653     * Create a date formatter
77654     *
77655     * @param string $locale Locale to use when formatting or parsing.
77656     * @param int $datetype Date type to use (none, short, medium, long,
77657     *   full). This is one of the IntlDateFormatter constants.
77658     * @param int $timetype Time type to use (none, short, medium, long,
77659     *   full). This is one of the IntlDateFormatter constants.
77660     * @param string $timezone Time zone ID, default is system default.
77661     * @param int $calendar Calendar to use for formatting or parsing;
77662     *   default is Gregorian. This is one of the IntlDateFormatter calendar
77663     *   constants.
77664     * @param string $pattern Optional pattern to use when formatting or
77665     *   parsing. Possible patterns are documented at .
77666     * @return IntlDateFormatter
77667     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77668     **/
77669    function create($locale, $datetype, $timetype, $timezone, $calendar, $pattern){}
77670
77671    /**
77672     * Formats the time value as a string.
77673     *
77674     * @param mixed $value The date formatter resource.
77675     * @return string
77676     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77677     **/
77678    function format($value){}
77679
77680    /**
77681     * @return int
77682     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77683     **/
77684    function getCalendar(){}
77685
77686    /**
77687     * Returns date type used by the formatter.
77688     *
77689     * @return int
77690     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77691     **/
77692    function getDateType(){}
77693
77694    /**
77695     * Get the error code from last operation. Returns error code from the
77696     * last number formatting operation.
77697     *
77698     * @return int
77699     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77700     **/
77701    function getErrorCode(){}
77702
77703    /**
77704     * Get the error text from the last operation.
77705     *
77706     * @return string
77707     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77708     **/
77709    function getErrorMessage(){}
77710
77711    /**
77712     * Get locale used by the formatter.
77713     *
77714     * @param int $which The formatter resource
77715     * @return string
77716     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77717     **/
77718    function getLocale($which){}
77719
77720    /**
77721     * Get pattern used by the formatter.
77722     *
77723     * @return string
77724     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77725     **/
77726    function getPattern(){}
77727
77728    /**
77729     * Return time type used by the formatter.
77730     *
77731     * @return int
77732     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77733     **/
77734    function getTimeType(){}
77735
77736    /**
77737     * Get the timezone-id used for the IntlDateFormatter.
77738     *
77739     * @return string
77740     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77741     **/
77742    function getTimeZoneId(){}
77743
77744    /**
77745     * Check if the parser is strict or lenient in interpreting inputs that
77746     * do not match the pattern exactly.
77747     *
77748     * @return bool
77749     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77750     **/
77751    function isLenient(){}
77752
77753    /**
77754     * Converts string $value to a field-based time value ( an array of
77755     * various fields), starting at $parse_pos and consuming as much of the
77756     * input value as possible.
77757     *
77758     * @param string $value The formatter resource
77759     * @param int $position string to convert to a time
77760     * @return array
77761     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77762     **/
77763    function localtime($value, &$position){}
77764
77765    /**
77766     * Converts string $value to an incremental time value, starting at
77767     * $parse_pos and consuming as much of the input value as possible.
77768     *
77769     * @param string $value The formatter resource
77770     * @param int $position string to convert to a time
77771     * @return int
77772     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77773     **/
77774    function parse($value, &$position){}
77775
77776    /**
77777     * Sets the calendar used by the formatter.
77778     *
77779     * @param int $which The formatter resource.
77780     * @return bool
77781     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77782     **/
77783    function setCalendar($which){}
77784
77785    /**
77786     * Define if the parser is strict or lenient in interpreting inputs that
77787     * do not match the pattern exactly. Enabling lenient parsing allows the
77788     * parser to accept otherwise flawed date or time patterns, parsing as
77789     * much as possible to obtain a value. Extra space, unrecognized tokens,
77790     * or invalid values ("February 30th") are not accepted.
77791     *
77792     * @param bool $lenient The formatter resource
77793     * @return bool
77794     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77795     **/
77796    function setLenient($lenient){}
77797
77798    /**
77799     * Set the pattern used for the IntlDateFormatter.
77800     *
77801     * @param string $pattern The formatter resource.
77802     * @return bool
77803     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77804     **/
77805    function setPattern($pattern){}
77806
77807    /**
77808     * Sets the time zone to use.
77809     *
77810     * @param string $zone The formatter resource.
77811     * @return bool
77812     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
77813     **/
77814    function setTimeZoneId($zone){}
77815
77816}
77817/**
77818 * Exception thrown if an argument does not match with the expected value
77819 **/
77820class InvalidArgumentException extends LogicException {
77821}
77822/**
77823 * Interface for external iterators or objects that can be iterated
77824 * themselves internally.
77825 **/
77826interface Iterator extends Traversable {
77827    /**
77828     * Returns the current element.
77829     *
77830     * @return mixed
77831     * @since PHP 5 >= 5.1.0
77832     **/
77833    function current();
77834
77835    /**
77836     * Returns the key of the current element.
77837     *
77838     * @return scalar
77839     * @since PHP 5 >= 5.1.0
77840     **/
77841    function key();
77842
77843    /**
77844     * Moves the current position to the next element.
77845     *
77846     * @return void
77847     * @since PHP 5 >= 5.1.0
77848     **/
77849    function next();
77850
77851    /**
77852     * Rewinds back to the first element of the Iterator.
77853     *
77854     * @return void
77855     * @since PHP 5 >= 5.1.0
77856     **/
77857    function rewind();
77858
77859    /**
77860     * This method is called after Iterator::rewind and Iterator::next to
77861     * check if the current position is valid.
77862     *
77863     * @return boolean
77864     * @since PHP 5 >= 5.1.0
77865     **/
77866    function valid();
77867
77868}
77869/**
77870 * Interface to create an external Iterator.
77871 **/
77872interface IteratorAggregate extends Traversable {
77873    /**
77874     * Returns an external iterator.
77875     *
77876     * @return Traversable
77877     * @since PHP 5 >= 5.1.0
77878     **/
77879    function getIterator();
77880
77881}
77882/**
77883 * This iterator wrapper allows the conversion of anything that is into
77884 * an Iterator. It is important to understand that most classes that do
77885 * not implement Iterators have reasons as most likely they do not allow
77886 * the full Iterator feature set. If so, techniques should be provided to
77887 * prevent misuse, otherwise expect exceptions or fatal errors.
77888 **/
77889class IteratorIterator implements Iterator, Traversable, OuterIterator {
77890    /**
77891     * Get the value of the current element.
77892     *
77893     * @return void
77894     * @since PHP 5 >= 5.1.0
77895     **/
77896    function current(){}
77897
77898    /**
77899     * Get the inner iterator.
77900     *
77901     * @return void
77902     * @since PHP 5 >= 5.1.0
77903     **/
77904    function getInnerIterator(){}
77905
77906    /**
77907     * Get the key of the current element.
77908     *
77909     * @return void
77910     * @since PHP 5 >= 5.1.0
77911     **/
77912    function key(){}
77913
77914    /**
77915     * Forward to the next element.
77916     *
77917     * @return void
77918     * @since PHP 5 >= 5.1.0
77919     **/
77920    function next(){}
77921
77922    /**
77923     * Rewinds to the first element.
77924     *
77925     * @return void
77926     * @since PHP 5 >= 5.1.0
77927     **/
77928    function rewind(){}
77929
77930    /**
77931     * Checks if the iterator is valid.
77932     *
77933     * @return bool
77934     * @since PHP 5 >= 5.1.0
77935     **/
77936    function valid(){}
77937
77938    /**
77939     * Creates an iterator from anything that is traversable.
77940     *
77941     * @param Traversable $iterator The traversable iterator.
77942     * @since PHP 5 >= 5.1.0
77943     **/
77944    function __construct($iterator){}
77945
77946}
77947interface KTaglib_ID3v2_AttachedPictureFrame {
77948    const Artist = 0;
77949    const BackCover = 0;
77950    const Band = 0;
77951    const BandLogo = 0;
77952    const ColouredFish = 0;
77953    const Composer = 0;
77954    const Conductor = 0;
77955    const DuringPerformance = 0;
77956    const DuringRecording = 0;
77957    const FileIcon = 0;
77958    const FrontCover = 0;
77959    const Illustration = 0;
77960    const LeadArtist = 0;
77961    const LeafletPage = 0;
77962    const Lyricist = 0;
77963    const Media = 0;
77964    const MovieScreenCapture = 0;
77965    const Other = 0;
77966    const OtherFileIcon = 0;
77967    const RecordingLocation = 0;
77968    /**
77969     * Returns the attached description for a picture frame in an ID3v2.x
77970     * frame.
77971     *
77972     * @return string
77973     * @since 0.0.1
77974     **/
77975    function getDescription();
77976
77977    /**
77978     * Sets the mime type of the image. This should in most cases be
77979     * "image/png" or "image/jpeg".
77980     *
77981     * @param string $type
77982     * @return string
77983     * @since 0.2.0
77984     **/
77985    function getMimeType($type);
77986
77987    /**
77988     * Returns the type of the image.
77989     *
77990     * The ID3v2 specification allows an AttachedPictureFrame to set the type
77991     * of an image. This can be e.g. FrontCover or FileIcon. Please refer to
77992     * the KTagLib_ID3v2_AttachedPictureFrame class description for a list of
77993     * available types.
77994     *
77995     * @return int
77996     * @since 0.2.0
77997     **/
77998    function getType();
77999
78000    /**
78001     * Saves the attached picture to the given filename.
78002     *
78003     * @param string $filename
78004     * @return bool
78005     * @since 0.0.1
78006     **/
78007    function savePicture($filename);
78008
78009    /**
78010     * Sets the picture to the give image. The image is loaded from the given
78011     * filename. Please note that the picture is not saved unless you call
78012     * the save method of the corresponding file object.
78013     *
78014     * @param string $filename
78015     * @return void
78016     * @since 0.0.1
78017     **/
78018    function setPicture($filename);
78019
78020    /**
78021     * Sets the type of the image. This can be e.g. FrontCover or FileIcon.
78022     * Please refer to the KTaglib_ID3v2_AttachedPictureFrame class
78023     * description for a list of available types and their constant mappings.
78024     *
78025     * @param int $type
78026     * @return void
78027     * @since 0.2.0
78028     **/
78029    function setType($type);
78030
78031}
78032class KTaglib_ID3v2_Frame extends KTagLib_ID3v2_Frame {
78033    /**
78034     * Returns the size of the frame in bytes. Please refer to id3.org to see
78035     * what ID3v2 frames are and how they are defined.
78036     *
78037     * @return int
78038     * @since 0.0.1
78039     **/
78040    function getSize(){}
78041
78042    /**
78043     * Returns a string representation of the frame. This might be just the
78044     * frame id, but might contain more information. Please see the ktaglib
78045     * documentation for more information
78046     *
78047     * @return string
78048     * @since 0.0.1
78049     **/
78050    function __toString(){}
78051
78052}
78053class KTaglib_ID3v2_Tag {
78054    /**
78055     * Adds a frame to the ID3v2 tag. The frame must be a valid
78056     * KTagLib_ID3v2_Frame object. To save the tag, the save function needs
78057     * to be invoked.
78058     *
78059     * @param KTagLib_ID3v2_Frame $frame
78060     * @return bool
78061     * @since 0.0.1
78062     **/
78063    function addFrame($frame){}
78064
78065    /**
78066     * Returns an array of ID3v2 frames, associated with the ID3v2 tag.
78067     *
78068     * @return array
78069     * @since 0.0.1
78070     **/
78071    function getFrameList(){}
78072
78073}
78074class KTaglib_MPEG_AudioProperties {
78075    /**
78076     * Returns the bitrate of the MPEG file
78077     *
78078     * @return int
78079     * @since 0.0.1
78080     **/
78081    function getBitrate(){}
78082
78083    /**
78084     * Returns the amount of channels of the MPEG file
78085     *
78086     * @return int
78087     * @since 0.0.1
78088     **/
78089    function getChannels(){}
78090
78091    /**
78092     * Returns the layer of the MPEG file (usually 3 for MP3).
78093     *
78094     * @return int
78095     * @since 0.0.1
78096     **/
78097    function getLayer(){}
78098
78099    /**
78100     * Returns the length of the MPEG file
78101     *
78102     * @return int
78103     * @since 0.0.1
78104     **/
78105    function getLength(){}
78106
78107    /**
78108     * Returns the sample bitrate of the MPEG file
78109     *
78110     * @return int
78111     * @since 0.0.1
78112     **/
78113    function getSampleBitrate(){}
78114
78115    /**
78116     * Returns the version of the MPEG file header. The possible versions are
78117     * defined in Tag_MPEG_Header (Version1, Version2, Version2.5).
78118     *
78119     * @return int
78120     * @since 0.0.1
78121     **/
78122    function getVersion(){}
78123
78124    /**
78125     * Returns true if the MPEG file is copyrighted
78126     *
78127     * @return bool
78128     * @since 0.0.1
78129     **/
78130    function isCopyrighted(){}
78131
78132    /**
78133     * Returns true if the file is marked as the original file
78134     *
78135     * @return bool
78136     * @since 0.0.1
78137     **/
78138    function isOriginal(){}
78139
78140    /**
78141     * Returns true if protection mechanism (like DRM) are enabled for this
78142     * file
78143     *
78144     * @return bool
78145     * @since 0.0.1
78146     **/
78147    function isProtectionEnabled(){}
78148
78149}
78150class KTagLib_MPEG_File {
78151    /**
78152     * Returns an object that provides access to the audio properties of the
78153     * mpeg file.
78154     *
78155     * @return KTaglib_MPEG_File:
78156     * @since 0.0.1
78157     **/
78158    function getAudioProperties(){}
78159
78160    /**
78161     * Returns an object that represents an ID3v1 tag, which can be used to
78162     * get information about the ID3v1 tag.
78163     *
78164     * @param bool $create
78165     * @return KTaglib_ID3v1_Tag
78166     * @since 0.0.1
78167     **/
78168    function getID3v1Tag($create){}
78169
78170    /**
78171     * Returns a ID3v2 object for the mpeg file. If no ID3v2 Tag is present,
78172     * an KTaglib_TagNotFoundException is thrown.
78173     *
78174     * @param bool $create
78175     * @return KTaglib_ID3v2_Tag
78176     * @since 0.0.1
78177     **/
78178    function getID3v2Tag($create){}
78179
78180}
78181interface KTaglib_MPEG_Header {
78182    const Version1 = 0;
78183    const Version2 = 0;
78184    const Version2_5 = 0;
78185}
78186class KTagLib_Tag extends KTagLib_Tag {
78187    /**
78188     * Returns the album string of an ID3 tag. This method is implemented in
78189     * ID3v1 and ID3v2 tags.
78190     *
78191     * @return string
78192     * @since 0.0.1
78193     **/
78194    function getAlbum(){}
78195
78196    /**
78197     * Returns the artist string of an ID3 tag. This method is implemented in
78198     * ID3v1 and ID3v2 tags.
78199     *
78200     * @return string
78201     * @since 0.0.1
78202     **/
78203    function getArtist(){}
78204
78205    /**
78206     * Returns the comment of an ID3 tag. This method is implemented in ID3v1
78207     * and ID3v2 tags.
78208     *
78209     * @return string
78210     * @since 0.0.1
78211     **/
78212    function getComment(){}
78213
78214    /**
78215     * Returns the genre of an ID3 tag. This method is implemented in ID3v1
78216     * and ID3v2 tags.
78217     *
78218     * @return string
78219     * @since 0.0.1
78220     **/
78221    function getGenre(){}
78222
78223    /**
78224     * Returns the title string of an ID3 tag. This method is implemented in
78225     * ID3v1 and ID3v2 tags.
78226     *
78227     * @return string
78228     * @since 0.0.1
78229     **/
78230    function getTitle(){}
78231
78232    /**
78233     * Returns the track number of an ID3 tag. This method is implemented in
78234     * ID3v1 and ID3v2 tags.
78235     *
78236     * @return int
78237     * @since 0.0.1
78238     **/
78239    function getTrack(){}
78240
78241    /**
78242     * Returns the year of an ID3 tag. This method is implemented in ID3v1
78243     * and ID3v2 tags.
78244     *
78245     * @return int
78246     * @since 0.0.1
78247     **/
78248    function getYear(){}
78249
78250    /**
78251     * Returns true if the tag exists, but is empty. This method is
78252     * implemented in ID3v1 and ID3v2 tags.
78253     *
78254     * @return bool
78255     * @since 0.0.1
78256     **/
78257    function isEmpty(){}
78258
78259}
78260/**
78261 * Exception thrown if a length is invalid
78262 **/
78263class LengthException extends LogicException {
78264}
78265/**
78266 * Contains various information about errors thrown by libxml. The error
78267 * codes are described within the official .
78268 **/
78269class libXMLError {
78270}
78271/**
78272 * The class allows iteration over a limited subset of items in an .
78273 **/
78274class LimitIterator extends IteratorIterator implements OuterIterator, Traversable, Iterator {
78275    /**
78276     * Gets the current element of the inner Iterator.
78277     *
78278     * @return mixed
78279     * @since PHP 5 >= 5.1.0
78280     **/
78281    function current(){}
78282
78283    /**
78284     * Gets the inner Iterator.
78285     *
78286     * @return Iterator
78287     * @since PHP 5 >= 5.1.0
78288     **/
78289    function getInnerIterator(){}
78290
78291    /**
78292     * Gets the current zero-based position of the inner Iterator.
78293     *
78294     * @return int
78295     * @since PHP 5 >= 5.1.0
78296     **/
78297    function getPosition(){}
78298
78299    /**
78300     * Gets the key for the current item in the inner Iterator.
78301     *
78302     * @return mixed
78303     * @since PHP 5 >= 5.1.0
78304     **/
78305    function key(){}
78306
78307    /**
78308     * Moves the iterator forward.
78309     *
78310     * @return void
78311     * @since PHP 5 >= 5.1.0
78312     **/
78313    function next(){}
78314
78315    /**
78316     * Rewinds the iterator to the starting offset specified in
78317     * LimitIterator::__construct.
78318     *
78319     * @return void
78320     * @since PHP 5 >= 5.1.0
78321     **/
78322    function rewind(){}
78323
78324    /**
78325     * Moves the iterator to the offset specified by {@link position}.
78326     *
78327     * @param int $position The position to seek to.
78328     * @return int
78329     * @since PHP 5 >= 5.1.0
78330     **/
78331    function seek($position){}
78332
78333    /**
78334     * Checks whether the current element is valid.
78335     *
78336     * @return bool
78337     * @since PHP 5 >= 5.1.0
78338     **/
78339    function valid(){}
78340
78341    /**
78342     * Constructs a new LimitIterator from an {@link iterator} with a given
78343     * starting {@link offset} and maximum {@link count}.
78344     *
78345     * @param Iterator $iterator The Iterator to limit.
78346     * @param int $offset Optional offset of the limit.
78347     * @param int $count Optional count of the limit.
78348     * @since PHP 5 >= 5.1.0
78349     **/
78350    function __construct($iterator, $offset, $count){}
78351
78352}
78353/**
78354 * Examples of identifiers include:
78355 **/
78356class Locale {
78357    /**
78358     * Tries to find locale that can satisfy the language list that is
78359     * requested by the HTTP "Accept-Language" header.
78360     *
78361     * @param string $header The string containing the "Accept-Language"
78362     *   header according to format in RFC 2616.
78363     * @return string
78364     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78365     **/
78366    function acceptFromHttp($header){}
78367
78368    /**
78369     * Returns a correctly ordered and delimited locale ID the keys identify
78370     * the particular locale ID subtags, and the values are the associated
78371     * subtag values.
78372     *
78373     * @param array $subtags an array containing a list of key-value pairs,
78374     *   where the keys identify the particular locale ID subtags, and the
78375     *   values are the associated subtag values. The 'variant' and 'private'
78376     *   subtags can take maximum 15 values whereas 'extlang' can take
78377     *   maximum 3 values.e.g. Variants are allowed with the suffix ranging
78378     *   from 0-14. Hence the keys for the input array can be variant0,
78379     *   variant1, ...,variant14. In the returned locale id, the subtag is
78380     *   ordered by suffix resulting in variant0 followed by variant1
78381     *   followed by variant2 and so on. The 'variant', 'private' and
78382     *   'extlang' multiple values can be specified both as array under
78383     *   specific key (e.g. 'variant') and as multiple numbered keys (e.g.
78384     *   'variant0', 'variant1', etc.).
78385     * @return string
78386     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78387     **/
78388    function composeLocale($subtags){}
78389
78390    /**
78391     * Checks if a $langtag filter matches with $locale according to RFC
78392     * 4647's basic filtering algorithm
78393     *
78394     * @param string $langtag The language tag to check
78395     * @param string $locale The language range to check against
78396     * @param bool $canonicalize If true, the arguments will be converted
78397     *   to canonical form before matching.
78398     * @return bool
78399     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78400     **/
78401    function filterMatches($langtag, $locale, $canonicalize){}
78402
78403    /**
78404     * Gets the variants for the input locale
78405     *
78406     * @param string $locale The locale to extract the variants from
78407     * @return array
78408     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78409     **/
78410    function getAllVariants($locale){}
78411
78412    /**
78413     * Gets the default locale value. At the PHP initialization this value is
78414     * set to 'intl.default_locale' value from if that value exists or from
78415     * ICU's function uloc_getDefault().
78416     *
78417     * @return string
78418     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78419     **/
78420    function getDefault(){}
78421
78422    /**
78423     * Returns an appropriately localized display name for language of the
78424     * input locale. If is then the default locale is used.
78425     *
78426     * @param string $locale The locale to return a display language for
78427     * @param string $in_locale Optional format locale to use to display
78428     *   the language name
78429     * @return string
78430     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78431     **/
78432    function getDisplayLanguage($locale, $in_locale){}
78433
78434    /**
78435     * Returns an appropriately localized display name for the input locale.
78436     * If is then the default locale is used.
78437     *
78438     * @param string $locale The locale to return a display name for.
78439     * @param string $in_locale optional format locale
78440     * @return string
78441     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78442     **/
78443    function getDisplayName($locale, $in_locale){}
78444
78445    /**
78446     * Returns an appropriately localized display name for region of the
78447     * input locale. If is then the default locale is used.
78448     *
78449     * @param string $locale The locale to return a display region for.
78450     * @param string $in_locale Optional format locale to use to display
78451     *   the region name
78452     * @return string
78453     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78454     **/
78455    function getDisplayRegion($locale, $in_locale){}
78456
78457    /**
78458     * Returns an appropriately localized display name for script of the
78459     * input locale. If is then the default locale is used.
78460     *
78461     * @param string $locale The locale to return a display script for
78462     * @param string $in_locale Optional format locale to use to display
78463     *   the script name
78464     * @return string
78465     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78466     **/
78467    function getDisplayScript($locale, $in_locale){}
78468
78469    /**
78470     * Returns an appropriately localized display name for variants of the
78471     * input locale. If is then the default locale is used.
78472     *
78473     * @param string $locale The locale to return a display variant for
78474     * @param string $in_locale Optional format locale to use to display
78475     *   the variant name
78476     * @return string
78477     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78478     **/
78479    function getDisplayVariant($locale, $in_locale){}
78480
78481    /**
78482     * Gets the keywords for the input locale.
78483     *
78484     * @param string $locale The locale to extract the keywords from
78485     * @return array
78486     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78487     **/
78488    function getKeywords($locale){}
78489
78490    /**
78491     * Gets the primary language for the input locale
78492     *
78493     * @param string $locale The locale to extract the primary language
78494     *   code from
78495     * @return string
78496     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78497     **/
78498    function getPrimaryLanguage($locale){}
78499
78500    /**
78501     * Gets the region for the input locale.
78502     *
78503     * @param string $locale The locale to extract the region code from
78504     * @return string
78505     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78506     **/
78507    function getRegion($locale){}
78508
78509    /**
78510     * Gets the script for the input locale.
78511     *
78512     * @param string $locale The locale to extract the script code from
78513     * @return string
78514     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78515     **/
78516    function getScript($locale){}
78517
78518    /**
78519     * Searches the items in {@link langtag} for the best match to the
78520     * language range specified in {@link locale} according to RFC 4647's
78521     * lookup algorithm.
78522     *
78523     * @param array $langtag An array containing a list of language tags to
78524     *   compare to {@link locale}. Maximum 100 items allowed.
78525     * @param string $locale The locale to use as the language range when
78526     *   matching.
78527     * @param bool $canonicalize If true, the arguments will be converted
78528     *   to canonical form before matching.
78529     * @param string $default The locale to use if no match is found.
78530     * @return string
78531     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78532     **/
78533    function lookup($langtag, $locale, $canonicalize, $default){}
78534
78535    /**
78536     * Returns a key-value array of locale ID subtag elements.
78537     *
78538     * @param string $locale The locale to extract the subtag array from.
78539     *   Note: The 'variant' and 'private' subtags can take maximum 15 values
78540     *   whereas 'extlang' can take maximum 3 values.
78541     * @return array
78542     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78543     **/
78544    function parseLocale($locale){}
78545
78546    /**
78547     * Sets the default runtime locale to $locale. This changes the value of
78548     * INTL global 'default_locale' locale identifier. UAX #35 extensions are
78549     * accepted.
78550     *
78551     * @param string $locale Is a BCP 47 compliant language tag containing
78552     *   the
78553     * @return bool
78554     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
78555     **/
78556    function setDefault($locale){}
78557
78558}
78559/**
78560 * Exception thrown if a logic expression is invalid
78561 **/
78562class LogicException extends Exception {
78563}
78564class maxdb {
78565    /**
78566     * {@link maxdb_affected_rows} returns the number of rows affected by the
78567     * last INSERT, UPDATE, or DELETE query associated with the provided
78568     * {@link link} parameter. If this number cannot be determined, this
78569     * function will return -1.
78570     *
78571     * The {@link maxdb_affected_rows} function only works with queries which
78572     * modify a table. In order to return the number of rows from a SELECT
78573     * query, use the {@link maxdb_num_rows} function instead.
78574     *
78575     * @var int
78576     **/
78577    var $affected_rows;
78578    /**
78579     * The {@link maxdb_errno} function will return the last error code for
78580     * the most recent MaxDB function call that can succeed or fail with
78581     * respect to the database link defined by the {@link link} parameter. If
78582     * no errors have occured, this function will return zero.
78583     *
78584     * @var int
78585     **/
78586    var $errno;
78587    /**
78588     * The {@link maxdb_error} function is identical to the corresponding
78589     * {@link maxdb_errno} function in every way, except instead of returning
78590     * an integer error code the {@link maxdb_error} function will return a
78591     * string representation of the last error to occur for the database
78592     * connection represented by the {@link link} parameter. If no error has
78593     * occured, this function will return an empty string.
78594     *
78595     * @var string
78596     **/
78597    var $error;
78598    /**
78599     * The {@link maxdb_get_host_info} function returns a string describing
78600     * the connection represented by the {@link link} parameter is using.
78601     *
78602     * @var string
78603     **/
78604    var $host_info;
78605    /**
78606     * The {@link maxdb_info} function returns a string providing information
78607     * about the last query executed. The nature of this string is provided
78608     * below:
78609     *
78610     * Possible maxdb_info return values Query type Example result string
78611     * INSERT INTO...SELECT... Records: 100 Duplicates: 0 Warnings: 0 INSERT
78612     * INTO...VALUES (...),(...),(...) Records: 3 Duplicates: 0 Warnings: 0
78613     * LOAD DATA INFILE ... Records: 1 Deleted: 0 Skipped: 0 Warnings: 0
78614     * ALTER TABLE ... Records: 3 Duplicates: 0 Warnings: 0 UPDATE ... Rows
78615     * matched: 40 Changed: 40 Warnings: 0
78616     *
78617     * @var string
78618     **/
78619    var $info;
78620    /**
78621     * The {@link maxdb_insert_id} function returns the ID generated by a
78622     * query on a table with a column having the DEFAULT SERIAL attribute. If
78623     * the last query wasn't an INSERT or UPDATE statement or if the modified
78624     * table does not have a column with the DEFAULT SERIAL attribute, this
78625     * function will return zero.
78626     *
78627     * @var mixed
78628     **/
78629    var $insert_id;
78630    /**
78631     * Returns the number of rows in the result set.
78632     *
78633     * The use of {@link maxdb_num_rows} depends on whether you use buffered
78634     * or unbuffered result sets. In case you use unbuffered resultsets
78635     * {@link maxdb_num_rows} will not correct the correct number of rows
78636     * until all the rows in the result have been retrieved.
78637     *
78638     * @var int
78639     **/
78640    var $num_rows;
78641    /**
78642     * Returns an integer representing the MaxDB protocol version used by the
78643     * connection represented by the {@link link} parameter.
78644     *
78645     * @var string
78646     **/
78647    var $protocol_version;
78648    /**
78649     * Returns a string representing the version of the MaxDB server that the
78650     * MaxDB extension is connected to (represented by the {@link link}
78651     * parameter).
78652     *
78653     * @var string
78654     **/
78655    var $server_info;
78656    /**
78657     * The {@link maxdb_get_server_version} function returns the version of
78658     * the server connected to (represented by the {@link link} parameter) as
78659     * an integer.
78660     *
78661     * The form of this version number is main_version * 10000 +
78662     * minor_version * 100 + sub_version (i.e. version 7.5.0 is 70500).
78663     *
78664     * @var int
78665     **/
78666    var $server_version;
78667    /**
78668     * Returns a string containing the SQLSTATE error code for the last
78669     * error. The error code consists of five characters. '00000' means no
78670     * error. The values are specified by ANSI SQL and ODBC.
78671     *
78672     * @var string
78673     **/
78674    var $sqlstate;
78675    /**
78676     * The {@link maxdb_thread_id} function returns the thread ID for the
78677     * current connection which can then be killed using the {@link
78678     * maxdb_kill} function. If the connection is lost and you reconnect with
78679     * {@link maxdb_ping}, the thread ID will be other. Therefore you should
78680     * get the thread ID only when you need it.
78681     *
78682     * @var int
78683     **/
78684    var $thread_id;
78685    /**
78686     * {@link maxdb_warning_count} returns the number of warnings from the
78687     * last query in the connection represented by the {@link link}
78688     * parameter.
78689     *
78690     * @var int
78691     **/
78692    var $warning_count;
78693    /**
78694     * {@link maxdb_autocommit} is used to turn on or off auto-commit mode on
78695     * queries for the database connection represented by the {@link link}
78696     * resource.
78697     *
78698     * @param bool $mode
78699     * @return bool
78700     **/
78701    function auto_commit($mode){}
78702
78703    /**
78704     * {@link maxdb_change_user} is used to change the user of the specified
78705     * database connection as given by the {@link link} parameter and to set
78706     * the current database to that specified by the {@link database}
78707     * parameter.
78708     *
78709     * In order to successfully change users a valid {@link username} and
78710     * {@link password} parameters must be provided and that user must have
78711     * sufficient permissions to access the desired database. If for any
78712     * reason authorization fails, the current user authentication will
78713     * remain.
78714     *
78715     * @param string $user
78716     * @param string $password
78717     * @param string $database
78718     * @return bool
78719     **/
78720    function change_user($user, $password, $database){}
78721
78722    /**
78723     * Returns the current character set for the database connection
78724     * specified by the {@link link} parameter.
78725     *
78726     * @return string
78727     **/
78728    function character_set_name(){}
78729
78730    /**
78731     * The {@link maxdb_close} function closes a previously opened database
78732     * connection specified by the {@link link} parameter.
78733     *
78734     * @return bool
78735     **/
78736    function close(){}
78737
78738    /**
78739     * Commits the current transaction for the database connection specified
78740     * by the {@link link} parameter.
78741     *
78742     * @return bool
78743     **/
78744    function commit(){}
78745
78746    /**
78747     * @return void
78748     **/
78749    function disable_reads_from_master(){}
78750
78751    /**
78752     * Returns the number of columns for the most recent query on the
78753     * connection represented by the {@link link} parameter. This function
78754     * can be useful when using the {@link maxdb_store_result} function to
78755     * determine if the query should have produced a non-empty result set or
78756     * not without knowing the nature of the query.
78757     *
78758     * @return int
78759     **/
78760    function field_count(){}
78761
78762    /**
78763     * This function is used to disconnect from a MaxDB server specified by
78764     * the {@link processid} parameter.
78765     *
78766     * @param int $processid
78767     * @return bool
78768     **/
78769    function kill($processid){}
78770
78771    /**
78772     * Returns the current character set for the database connection
78773     * specified by the {@link link} parameter.
78774     *
78775     * @return string
78776     **/
78777    function maxdb_client_encoding(){}
78778
78779    /**
78780     * This function is used to create a legal SQL string that you can use in
78781     * an SQL statement. The string escapestr is encoded to an escaped SQL
78782     * string, taking into account the current character set of the
78783     * connection.
78784     *
78785     * Characters encoded are ', ".
78786     *
78787     * @param string $escapestr
78788     * @return string
78789     **/
78790    function maxdb_escape_string($escapestr){}
78791
78792    /**
78793     * {@link maxdb_maxdb_set_opt} can be used to set extra connect
78794     * maxdb_set_opt and affect behavior for a connection.
78795     *
78796     * This function may be called multiple times to set several
78797     * maxdb_set_opt.
78798     *
78799     * {@link maxdb_maxdb_set_opt} should be called after {@link maxdb_init}
78800     * and before {@link maxdb_real_connect}.
78801     *
78802     * The parameter {@link option} is the option that you want to set, the
78803     * {@link value} is the value for the option. For detailed description of
78804     * the maxdb_set_opt see The parameter {@link option} can be one of the
78805     * following values: Valid maxdb_set_opt Name Description MAXDB_COMPNAME
78806     * The component name used to initialise the SQLDBC runtime environment.
78807     * MAXDB_APPLICATION The application to be connected to the database.
78808     * MAXDB_APPVERSION The version of the application. MAXDB_SQLMODE The SQL
78809     * mode. MAXDB_UNICODE TRUE, if the connection is an unicode (UCS2)
78810     * client or FALSE, if not. MAXDB_TIMEOUT The maximum allowed time of
78811     * inactivity after which the connection to the database is closed by the
78812     * system. MAXDB_ISOLATIONLEVEL Specifies whether and how shared locks
78813     * and exclusive locks are implicitly requested or released.
78814     * MAXDB_PACKETCOUNT The number of different request packets used for the
78815     * connection. MAXDB_STATEMENTCACHESIZE The number of prepared statements
78816     * to be cached for the connection for re-use. MAXDB_CURSORPREFIX The
78817     * prefix to use for result tables that are automatically named.
78818     *
78819     * @param int $option
78820     * @param mixed $value
78821     * @return bool
78822     **/
78823    function maxdb_set_opt($option, $value){}
78824
78825    /**
78826     * The {@link maxdb_multi_query} works like the function {@link
78827     * maxdb_query}. Multiple queries are not yet supported.
78828     *
78829     * @param string $query
78830     * @return bool
78831     **/
78832    function multi_query($query){}
78833
78834    /**
78835     * {@link maxdb_options} can be used to set extra connect options and
78836     * affect behavior for a connection.
78837     *
78838     * This function may be called multiple times to set several options.
78839     *
78840     * {@link maxdb_options} should be called after {@link maxdb_init} and
78841     * before {@link maxdb_real_connect}.
78842     *
78843     * The parameter {@link option} is the option that you want to set, the
78844     * {@link value} is the value for the option. For detailed description of
78845     * the options see The parameter {@link option} can be one of the
78846     * following values: Valid options Name Description MAXDB_COMPNAME The
78847     * component name used to initialise the SQLDBC runtime environment.
78848     * MAXDB_APPLICATION The application to be connected to the database.
78849     * MAXDB_APPVERSION The version of the application. MAXDB_SQLMODE The SQL
78850     * mode. MAXDB_UNICODE TRUE, if the connection is an unicode (UCS2)
78851     * client or FALSE, if not. MAXDB_TIMEOUT The maximum allowed time of
78852     * inactivity after which the connection to the database is closed by the
78853     * system. MAXDB_ISOLATIONLEVEL Specifies whether and how shared locks
78854     * and exclusive locks are implicitly requested or released.
78855     * MAXDB_PACKETCOUNT The number of different request packets used for the
78856     * connection. MAXDB_STATEMENTCACHESIZE The number of prepared statements
78857     * to be cached for the connection for re-use. MAXDB_CURSORPREFIX The
78858     * prefix to use for result tables that are automatically named.
78859     *
78860     * @param int $option
78861     * @param mixed $value
78862     * @return bool
78863     **/
78864    function options($option, $value){}
78865
78866    /**
78867     * Checks whether the connection to the server is working. If it has gone
78868     * down, and global option maxdb.reconnect is enabled an automatic
78869     * reconnection is attempted.
78870     *
78871     * This function can be used by clients that remain idle for a long
78872     * while, to check whether the server has closed the connection and
78873     * reconnect if necessary.
78874     *
78875     * @return bool
78876     **/
78877    function ping(){}
78878
78879    /**
78880     * {@link maxdb_prepare} prepares the SQL query pointed to by the
78881     * null-terminated string query, and returns a statement handle to be
78882     * used for further operations on the statement. The query must consist
78883     * of a single SQL statement.
78884     *
78885     * The parameter {@link query} can include one or more parameter markers
78886     * in the SQL statement by embedding question mark (?) characters at the
78887     * appropriate positions.
78888     *
78889     * The parameter markers must be bound to application variables using
78890     * {@link maxdb_stmt_bind_param} and/or {@link maxdb_stmt_bind_result}
78891     * before executing the statement or fetching rows.
78892     *
78893     * @param string $query
78894     * @return maxdb_stmt
78895     **/
78896    function prepare($query){}
78897
78898    /**
78899     * The {@link maxdb_query} function is used to simplify the act of
78900     * performing a query against the database represented by the {@link
78901     * link} parameter.
78902     *
78903     * @param string $query
78904     * @return mixed
78905     **/
78906    function query($query){}
78907
78908    /**
78909     * {@link maxdb_real_connect} attempts to establish a connection to a
78910     * MaxDB database engine running on {@link hostname}.
78911     *
78912     * This function differs from {@link maxdb_connect}:
78913     *
78914     * @param string $hostname
78915     * @param string $username
78916     * @param string $passwd
78917     * @param string $dbname
78918     * @param int $port
78919     * @param string $socket
78920     * @return bool
78921     **/
78922    function real_connect($hostname, $username, $passwd, $dbname, $port, $socket){}
78923
78924    /**
78925     * This function is used to create a legal SQL string that you can use in
78926     * an SQL statement. The string escapestr is encoded to an escaped SQL
78927     * string, taking into account the current character set of the
78928     * connection.
78929     *
78930     * Characters encoded are ', ".
78931     *
78932     * @param string $escapestr
78933     * @return string
78934     **/
78935    function real_escape_sring($escapestr){}
78936
78937    /**
78938     * The {@link maxdb_real_query} is functionally identical with the {@link
78939     * maxdb_query}.
78940     *
78941     * @param string $query
78942     * @return bool
78943     **/
78944    function real_query($query){}
78945
78946    /**
78947     * Rollbacks the current transaction for the database specified by the
78948     * {@link link} parameter.
78949     *
78950     * @return bool
78951     **/
78952    function rollback(){}
78953
78954    /**
78955     * @return int
78956     **/
78957    function rpl_query_type(){}
78958
78959    /**
78960     * @param string $query
78961     * @return bool
78962     **/
78963    function send_query($query){}
78964
78965    /**
78966     * @param string $key
78967     * @param string $cert
78968     * @param string $ca
78969     * @param string $capath
78970     * @param string $cipher
78971     * @return bool
78972     **/
78973    function ssl_set($key, $cert, $ca, $capath, $cipher){}
78974
78975    /**
78976     * {@link maxdb_stat} returns a string containing several information
78977     * about the MaxDB server running.
78978     *
78979     * @return string
78980     **/
78981    function stat(){}
78982
78983    /**
78984     * Allocates and initializes a statement resource suitable for {@link
78985     * maxdb_stmt_prepare}.
78986     *
78987     * @return object
78988     **/
78989    function stmt_init(){}
78990
78991    /**
78992     * This function has no functionally effect.
78993     *
78994     * @return object
78995     **/
78996    function store_result(){}
78997
78998    /**
78999     * {@link maxdb_use_result} has no effect.
79000     *
79001     * @return resource
79002     **/
79003    function use_result(){}
79004
79005}
79006class maxdb_result {
79007    /**
79008     * Returns the position of the field cursor used for the last {@link
79009     * maxdb_fetch_field} call. This value can be used as an argument to
79010     * {@link maxdb_field_seek}.
79011     *
79012     * @var int
79013     **/
79014    var $current_field;
79015    /**
79016     * {@link maxdb_num_fields} returns the number of fields from specified
79017     * result set.
79018     *
79019     * @var int
79020     **/
79021    var $field_count;
79022    /**
79023     * The {@link maxdb_fetch_lengths} function returns an array containing
79024     * the lengths of every column of the current row within the result set
79025     * represented by the {@link result} parameter. If successful, a
79026     * numerically indexed array representing the lengths of each column is
79027     * returned.
79028     *
79029     * @var array
79030     **/
79031    var $lengths;
79032    /**
79033     * The {@link maxdb_data_seek} function seeks to an arbitrary result
79034     * pointer specified by the {@link offset} in the result set represented
79035     * by {@link result}. The {@link offset} parameter must be between zero
79036     * and the total number of rows minus one (0..{@link maxdb_num_rows} -
79037     * 1).
79038     *
79039     * @param int $offset
79040     * @return bool
79041     **/
79042    function data_seek($offset){}
79043
79044    /**
79045     * Returns an array that corresponds to the fetched row or if there are
79046     * no more rows for the resultset represented by the {@link result}
79047     * parameter.
79048     *
79049     * {@link maxdb_fetch_array} is an extended version of the {@link
79050     * maxdb_fetch_row} function. In addition to storing the data in the
79051     * numeric indices of the result array, the {@link maxdb_fetch_array}
79052     * function can also store the data in associative indices, using the
79053     * field names of the result set as keys.
79054     *
79055     * If two or more columns of the result have the same field names, the
79056     * last column will take precedence and overwrite the earlier data. In
79057     * order to access multiple columns with the same name, the numerically
79058     * indexed version of the row must be used.
79059     *
79060     * The optional second argument {@link resulttype} is a constant
79061     * indicating what type of array should be produced from the current row
79062     * data. The possible values for this parameter are the constants
79063     * MAXDB_ASSOC, MAXDB_ASSOC_UPPER, MAXDB_ASSOC_LOWER, MAXDB_NUM, or
79064     * MAXDB_BOTH. By default the {@link maxdb_fetch_array} function will
79065     * assume MAXDB_BOTH, which is a combination of MAXDB_NUM and MAXDB_ASSOC
79066     * for this parameter.
79067     *
79068     * By using the MAXDB_ASSOC constant this function will behave
79069     * identically to the {@link maxdb_fetch_assoc}, while MAXDB_NUM will
79070     * behave identically to the {@link maxdb_fetch_row} function. The final
79071     * option MAXDB_BOTH will create a single array with the attributes of
79072     * both.
79073     *
79074     * By using the MAXDB_ASSOC_UPPER constant, the behaviour of this
79075     * function is identical to the use of MAXDB_ASSOC except the array index
79076     * of a column is the fieldname in upper case.
79077     *
79078     * By using the MAXDB_ASSOC_LOWER constant, the behaviour of this
79079     * function is identical to the use of MAXDB_ASSOC except the array index
79080     * of a column is the fieldname in lower case.
79081     *
79082     * @param int $resulttype
79083     * @return mixed
79084     **/
79085    function fetch_array($resulttype){}
79086
79087    /**
79088     * Returns an associative array that corresponds to the fetched row or if
79089     * there are no more rows.
79090     *
79091     * The {@link maxdb_fetch_assoc} function is used to return an
79092     * associative array representing the next row in the result set for the
79093     * result represented by the {@link result} parameter, where each key in
79094     * the array represents the name of one of the result set's columns.
79095     *
79096     * If two or more columns of the result have the same field names, the
79097     * last column will take precedence. To access the other column(s) of the
79098     * same name, you either need to access the result with numeric indices
79099     * by using {@link maxdb_fetch_row} or add alias names.
79100     *
79101     * @return array
79102     **/
79103    function fetch_assoc(){}
79104
79105    /**
79106     * The {@link maxdb_fetch_field} returns the definition of one column of
79107     * a result set as an resource. Call this function repeatedly to retrieve
79108     * information about all columns in the result set. {@link
79109     * maxdb_fetch_field} returns when no more fields are left.
79110     *
79111     * @return mixed
79112     **/
79113    function fetch_field(){}
79114
79115    /**
79116     * This function serves an identical purpose to the {@link
79117     * maxdb_fetch_field} function with the single difference that, instead
79118     * of returning one resource at a time for each field, the columns are
79119     * returned as an array of resources.
79120     *
79121     * @return mixed
79122     **/
79123    function fetch_fields(){}
79124
79125    /**
79126     * {@link maxdb_fetch_field_direct} returns an resource which contains
79127     * field definition information from specified resultset. The value of
79128     * fieldnr must be in the range from 0 to number of fields - 1.
79129     *
79130     * @param int $fieldnr
79131     * @return mixed
79132     **/
79133    function fetch_field_direct($fieldnr){}
79134
79135    /**
79136     * The {@link maxdb_fetch_object} will return the current row result set
79137     * as an object where the attributes of the object represent the names of
79138     * the fields found within the result set. If no more rows exist in the
79139     * current result set, is returned.
79140     *
79141     * @return object
79142     **/
79143    function fetch_object(){}
79144
79145    /**
79146     * Returns an array that corresponds to the fetched row, or if there are
79147     * no more rows.
79148     *
79149     * {@link maxdb_fetch_row} fetches one row of data from the result set
79150     * represented by {@link result} and returns it as an enumerated array,
79151     * where each column is stored in an array offset starting from 0 (zero).
79152     * Each subsequent call to the {@link maxdb_fetch_row} function will
79153     * return the next row within the result set, or if there are no more
79154     * rows.
79155     *
79156     * @return mixed
79157     **/
79158    function fetch_row(){}
79159
79160    /**
79161     * Sets the field cursor to the given offset. The next call to {@link
79162     * maxdb_fetch_field} will retrieve the field definition of the column
79163     * associated with that offset.
79164     *
79165     * @param int $fieldnr
79166     * @return bool
79167     **/
79168    function field_seek($fieldnr){}
79169
79170    /**
79171     * The {@link maxdb_free_result} function frees the memory associated
79172     * with the result represented by the {@link result} parameter, which was
79173     * allocated by {@link maxdb_query}, {@link maxdb_store_result} or {@link
79174     * maxdb_use_result}.
79175     *
79176     * @return void
79177     **/
79178    function free(){}
79179
79180}
79181class maxdb_stmt {
79182    /**
79183     * {@link maxdb_stmt_affected_rows} returns the number of rows affected
79184     * by INSERT, UPDATE, or DELETE query. If the last query was invalid or
79185     * the number of rows can not determined, this function will return -1.
79186     *
79187     * @var int
79188     **/
79189    var $affected_rows;
79190    /**
79191     * For the statement specified by stmt, {@link maxdb_stmt_errno} returns
79192     * the error code for the most recently invoked statement function that
79193     * can succeed or fail.
79194     *
79195     * @var int
79196     **/
79197    var $errno;
79198    /**
79199     * For the statement specified by stmt, {@link maxdb_stmt_error} returns
79200     * a containing the error message for the most recently invoked statement
79201     * function that can succeed or fail.
79202     *
79203     * @var string
79204     **/
79205    var $error;
79206    /**
79207     * Returns the number of rows in the result set.
79208     *
79209     * @var int
79210     **/
79211    var $num_rows;
79212    /**
79213     * {@link maxdb_stmt_param_count} returns the number of parameter markers
79214     * present in the prepared statement.
79215     *
79216     * @var int
79217     **/
79218    var $param_count;
79219    /**
79220     * {@link maxdb_stmt_param_count} returns the number of parameter markers
79221     * present in the prepared statement.
79222     *
79223     * @var int
79224     **/
79225    var $param_count;
79226    /**
79227     * (extended syntax):
79228     *
79229     * (extended syntax):
79230     *
79231     * {@link maxdb_stmt_bind_param} is used to bind variables for the
79232     * parameter markers in the SQL statement that was passed to {@link
79233     * maxdb_prepare}. The string {@link types} contains one or more
79234     * characters which specify the types for the corresponding bind
79235     * variables.
79236     *
79237     * The extended syntax of {@link maxdb_stmt_bind_param} allows to give
79238     * the parameters as an array instead of a variable list of PHP variables
79239     * to the function. If the array variable has not been used before
79240     * calling {@link maxdb_stmt_bind_param}, it has to be initialized as an
79241     * emtpy array. See the examples how to use {@link maxdb_stmt_bind_param}
79242     * with extended syntax.
79243     *
79244     * Variables for SELECT INTO SQL statements can also be bound using
79245     * {@link maxdb_stmt_bind_param}. Parameters for database procedures can
79246     * be bound using {@link maxdb_stmt_bind_param}. See the examples how to
79247     * use {@link maxdb_stmt_bind_param} in this cases.
79248     *
79249     * If a variable bound as INTO variable to an SQL statement was used
79250     * before, the content of this variable is overwritten by the data of the
79251     * SELECT INTO statement. A reference to this variable will be invalid
79252     * after a call to {@link maxdb_stmt_bind_param}.
79253     *
79254     * For INOUT parameters of database procedures the content of the bound
79255     * INOUT variable is overwritten by the output value of the database
79256     * procedure. A reference to this variable will be invalid after a call
79257     * to {@link maxdb_stmt_bind_param}.
79258     *
79259     * Type specification chars Character Description i corresponding
79260     * variable has type integer d corresponding variable has type double s
79261     * corresponding variable has type string b corresponding variable is a
79262     * blob and will be sent in packages
79263     *
79264     * @param string $types
79265     * @param mixed $var1
79266     * @return bool
79267     **/
79268    function bind_param($types, &$var1){}
79269
79270    /**
79271     * {@link maxdb_stmt_bind_result} is used to associate (bind) columns in
79272     * the result set to variables. When {@link maxdb_stmt_fetch} is called
79273     * to fetch data, the MaxDB client/server protocol places the data for
79274     * the bound columns into the specified variables {@link var1, ...}.
79275     *
79276     * @param mixed $var1
79277     * @return bool
79278     **/
79279    function bind_result(&$var1){}
79280
79281    /**
79282     * Closes a prepared statement. {@link maxdb_stmt_close} also deallocates
79283     * the statement handle pointed to by {@link stmt}. If the current
79284     * statement has pending or unread results, this function cancels them so
79285     * that the next query can be executed.
79286     *
79287     * @return bool
79288     **/
79289    function close(){}
79290
79291    /**
79292     * This function has to be called after a sequence of {@link
79293     * maxdb_stmt_send_long_data}, that was started after {@link
79294     * maxdb_execute}.
79295     *
79296     * {@link param_nr} indicates which parameter to associate the end of
79297     * data with. Parameters are numbered beginning with 0.
79298     *
79299     * @return bool
79300     **/
79301    function close_long_data(){}
79302
79303    /**
79304     * The {@link maxdb_stmt_data_seek} function seeks to an arbitrary result
79305     * pointer specified by the {@link offset} in the statement result set
79306     * represented by {@link statement}. The {@link offset} parameter must be
79307     * between zero and the total number of rows minus one (0..{@link
79308     * maxdb_stmt_num_rows} - 1).
79309     *
79310     * @param int $offset
79311     * @return bool
79312     **/
79313    function data_seek($offset){}
79314
79315    /**
79316     * The {@link maxdb_stmt_execute} function executes a query that has been
79317     * previously prepared using the {@link maxdb_prepare} function
79318     * represented by the {@link stmt} resource. When executed any parameter
79319     * markers which exist will automatically be replaced with the appropiate
79320     * data.
79321     *
79322     * If the statement is UPDATE, DELETE, or INSERT, the total number of
79323     * affected rows can be determined by using the {@link
79324     * maxdb_stmt_affected_rows} function. Likewise, if the query yields a
79325     * result set the {@link maxdb_fetch} function is used.
79326     *
79327     * @return bool
79328     **/
79329    function execute(){}
79330
79331    /**
79332     * {@link maxdb_stmt_fetch} returns row data using the variables bound by
79333     * {@link maxdb_stmt_bind_result}.
79334     *
79335     * @return bool
79336     **/
79337    function fetch(){}
79338
79339    /**
79340     * The {@link maxdb_stmt_free_result} function frees the result memory
79341     * associated with the statement represented by the {@link stmt}
79342     * parameter, which was allocated by {@link maxdb_stmt_store_result}.
79343     *
79344     * @return void
79345     **/
79346    function free_result(){}
79347
79348    /**
79349     * (extended syntax):
79350     *
79351     * (extended syntax):
79352     *
79353     * {@link maxdb_stmt_maxdb_bind_param} is used to bind variables for the
79354     * parameter markers in the SQL statement that was passed to {@link
79355     * maxdb_prepare}. The string {@link types} contains one or more
79356     * characters which specify the types for the corresponding bind
79357     * variables.
79358     *
79359     * The extended syntax of {@link maxdb_stmt_maxdb_bind_param} allows to
79360     * give the parameters as an array instead of a variable list of PHP
79361     * variables to the function. If the array variable has not been used
79362     * before calling {@link maxdb_stmt_maxdb_bind_param}, it has to be
79363     * initialized as an emtpy array. See the examples how to use {@link
79364     * maxdb_stmt_maxdb_bind_param} with extended syntax.
79365     *
79366     * Variables for SELECT INTO SQL statements can also be bound using
79367     * {@link maxdb_stmt_maxdb_bind_param}. Parameters for database
79368     * procedures can be bound using {@link maxdb_stmt_maxdb_bind_param}. See
79369     * the examples how to use {@link maxdb_stmt_maxdb_bind_param} in this
79370     * cases.
79371     *
79372     * If a variable bound as INTO variable to an SQL statement was used
79373     * before, the content of this variable is overwritten by the data of the
79374     * SELECT INTO statement. A reference to this variable will be invalid
79375     * after a call to {@link maxdb_stmt_maxdb_bind_param}.
79376     *
79377     * For INOUT parameters of database procedures the content of the bound
79378     * INOUT variable is overwritten by the output value of the database
79379     * procedure. A reference to this variable will be invalid after a call
79380     * to {@link maxdb_stmt_maxdb_bind_param}.
79381     *
79382     * Type specification chars Character Description i corresponding
79383     * variable has type integer d corresponding variable has type double s
79384     * corresponding variable has type string b corresponding variable is a
79385     * blob and will be sent in packages
79386     *
79387     * @param string $types
79388     * @param mixed $var1
79389     * @return bool
79390     **/
79391    function maxdb_bind_param($types, &$var1){}
79392
79393    /**
79394     * {@link maxdb_stmt_maxdb_bind_result} is used to associate (bind)
79395     * columns in the result set to variables. When {@link maxdb_stmt_fetch}
79396     * is called to fetch data, the MaxDB client/server protocol places the
79397     * data for the bound columns into the specified variables {@link var1,
79398     * ...}.
79399     *
79400     * @param mixed $var1
79401     * @return bool
79402     **/
79403    function maxdb_bind_result(&$var1){}
79404
79405    /**
79406     * This function has to be called after a sequence of {@link
79407     * maxdb_stmt_send_long_data}, that was started after {@link
79408     * maxdb_execute}.
79409     *
79410     * {@link param_nr} indicates which parameter to associate the end of
79411     * data with. Parameters are numbered beginning with 0.
79412     *
79413     * @return bool
79414     **/
79415    function maxdb_close_long_data(){}
79416
79417    /**
79418     * The {@link maxdb_stmt_maxdb_execute} function maxdb_executes a query
79419     * that has been previously prepared using the {@link maxdb_prepare}
79420     * function represented by the {@link stmt} resource. When maxdb_executed
79421     * any parameter markers which exist will automatically be replaced with
79422     * the appropiate data.
79423     *
79424     * If the statement is UPDATE, DELETE, or INSERT, the total number of
79425     * affected rows can be determined by using the {@link
79426     * maxdb_stmt_affected_rows} function. Likewise, if the query yields a
79427     * result set the {@link maxdb_fetch} function is used.
79428     *
79429     * @return bool
79430     **/
79431    function maxdb_execute(){}
79432
79433    /**
79434     * {@link maxdb_stmt_maxdb_fetch} returns row data using the variables
79435     * bound by {@link maxdb_stmt_bind_result}.
79436     *
79437     * @return bool
79438     **/
79439    function maxdb_fetch(){}
79440
79441    /**
79442     * If a statement passed to {@link maxdb_prepare} is one that produces a
79443     * result set, {@link maxdb_stmt_maxdb_get_metadata} returns the result
79444     * resource that can be used to process the meta information such as
79445     * total number of fields and individual field information.
79446     *
79447     * The result set structure should be freed when you are done with it,
79448     * which you can do by passing it to {@link maxdb_free_result}
79449     *
79450     * @return resource
79451     **/
79452    function maxdb_get_metadata(){}
79453
79454    /**
79455     * Allows to send parameter data to the server in pieces (or chunks).
79456     * This function can be called multiple times to send the parts of a
79457     * character or binary data value for a column, which must be one of the
79458     * TEXT or BLOB datatypes.
79459     *
79460     * {@link param_nr} indicates which parameter to associate the data with.
79461     * Parameters are numbered beginning with 0. {@link data} is a string
79462     * containing data to be sent.
79463     *
79464     * @param int $param_nr
79465     * @param string $data
79466     * @return bool
79467     **/
79468    function maxdb_send_long_data($param_nr, $data){}
79469
79470    /**
79471     * {@link maxdb_stmt_prepare} prepares the SQL query pointed to by the
79472     * null-terminated string query. The statement resource has to be
79473     * allocated by {@link maxdb_stmt_init}. The query must consist of a
79474     * single SQL statement.
79475     *
79476     * The parameter {@link query} can include one or more parameter markers
79477     * in the SQL statement by embedding question mark (?) characters at the
79478     * appropriate positions.
79479     *
79480     * The parameter markers must be bound to application variables using
79481     * {@link maxdb_stmt_bind_param} and/or {@link maxdb_stmt_bind_result}
79482     * before executing the statement or fetching rows.
79483     *
79484     * @param string $query
79485     * @return mixed
79486     **/
79487    function prepare($query){}
79488
79489    /**
79490     * @return bool
79491     **/
79492    function reset(){}
79493
79494    /**
79495     * If a statement passed to {@link maxdb_prepare} is one that produces a
79496     * result set, {@link maxdb_stmt_result_metadata} returns the result
79497     * resource that can be used to process the meta information such as
79498     * total number of fields and individual field information.
79499     *
79500     * The result set structure should be freed when you are done with it,
79501     * which you can do by passing it to {@link maxdb_free_result}
79502     *
79503     * @return resource
79504     **/
79505    function result_metadata(){}
79506
79507    /**
79508     * Allows to send parameter data to the server in pieces (or chunks).
79509     * This function can be called multiple times to send the parts of a
79510     * character or binary data value for a column, which must be one of the
79511     * TEXT or BLOB datatypes.
79512     *
79513     * {@link param_nr} indicates which parameter to associate the data with.
79514     * Parameters are numbered beginning with 0. {@link data} is a string
79515     * containing data to be sent.
79516     *
79517     * @param int $param_nr
79518     * @param string $data
79519     * @return bool
79520     **/
79521    function stmt_send_long_data($param_nr, $data){}
79522
79523}
79524/**
79525 * Represents a connection to a set of memcache servers.
79526 **/
79527class Memcache {
79528    /**
79529     * {@link Memcache::add} stores variable {@link var} with {@link key}
79530     * only if such key doesn't exist at the server yet. Also you can use
79531     * {@link memcache_add} function.
79532     *
79533     * @param string $key The key that will be associated with the item.
79534     * @param mixed $var The variable to store. Strings and integers are
79535     *   stored as is, other types are stored serialized.
79536     * @param int $flag Use MEMCACHE_COMPRESSED to store the item
79537     *   compressed (uses zlib).
79538     * @param int $expire Expiration time of the item. If it's equal to
79539     *   zero, the item will never expire. You can also use Unix timestamp or
79540     *   a number of seconds starting from current time, but in the latter
79541     *   case the number of seconds may not exceed 2592000 (30 days).
79542     * @return bool
79543     * @since PECL memcache >= 0.2.0
79544     **/
79545    function add($key, $var, $flag, $expire){}
79546
79547    /**
79548     * {@link Memcache::addServer} adds a server to the connection pool. The
79549     * connection, which was opened using {@link Memcache::addServer} will be
79550     * automatically closed at the end of script execution, you can also
79551     * close it manually with {@link Memcache::close}. You can also use the
79552     * {@link memcache_add_server} function.
79553     *
79554     * When using this method (as opposed to {@link Memcache::connect} and
79555     * {@link Memcache::pconnect}) the network connection is not established
79556     * until actually needed. Thus there is no overhead in adding a large
79557     * number of servers to the pool, even though they might not all be used.
79558     *
79559     * Failover may occur at any stage in any of the methods, as long as
79560     * other servers are available the request the user won't notice. Any
79561     * kind of socket or Memcached server level errors (except out-of-memory)
79562     * may trigger the failover. Normal client errors such as adding an
79563     * existing key will not trigger a failover.
79564     *
79565     * @param string $host Point to the host where memcached is listening
79566     *   for connections. This parameter may also specify other transports
79567     *   like unix:///path/to/memcached.sock to use UNIX domain sockets, in
79568     *   this case {@link port} must also be set to 0.
79569     * @param int $port Point to the port where memcached is listening for
79570     *   connections. Set this parameter to 0 when using UNIX domain sockets.
79571     * @param bool $persistent Controls the use of a persistent connection.
79572     *   Default to .
79573     * @param int $weight Number of buckets to create for this server which
79574     *   in turn control its probability of it being selected. The
79575     *   probability is relative to the total weight of all servers.
79576     * @param int $timeout Value in seconds which will be used for
79577     *   connecting to the daemon. Think twice before changing the default
79578     *   value of 1 second - you can lose all the advantages of caching if
79579     *   your connection is too slow.
79580     * @param int $retry_interval Controls how often a failed server will
79581     *   be retried, the default value is 15 seconds. Setting this parameter
79582     *   to -1 disables automatic retry. Neither this nor the {@link
79583     *   persistent} parameter has any effect when the extension is loaded
79584     *   dynamically via {@link dl}. Each failed connection struct has its
79585     *   own timeout and before it has expired the struct will be skipped
79586     *   when selecting backends to serve a request. Once expired the
79587     *   connection will be successfully reconnected or marked as failed for
79588     *   another {@link retry_interval} seconds. The typical effect is that
79589     *   each web server child will retry the connection about every {@link
79590     *   retry_interval} seconds when serving a page.
79591     * @param bool $status Controls if the server should be flagged as
79592     *   online. Setting this parameter to and {@link retry_interval} to -1
79593     *   allows a failed server to be kept in the pool so as not to affect
79594     *   the key distribution algorithm. Requests for this server will then
79595     *   failover or fail immediately depending on the {@link
79596     *   memcache.allow_failover} setting. Default to , meaning the server
79597     *   should be considered online.
79598     * @param callback $failure_callback Allows the user to specify a
79599     *   callback function to run upon encountering an error. The callback is
79600     *   run before failover is attempted. The function takes two parameters,
79601     *   the hostname and port of the failed server.
79602     * @param int $timeoutms
79603     * @return bool
79604     * @since PECL memcache >= 2.0.0
79605     **/
79606    function addServer($host, $port, $persistent, $weight, $timeout, $retry_interval, $status, $failure_callback, $timeoutms){}
79607
79608    /**
79609     * {@link Memcache::close} closes connection to memcached server. This
79610     * function doesn't close persistent connections, which are closed only
79611     * during web-server shutdown/restart. Also you can use {@link
79612     * memcache_close} function.
79613     *
79614     * @return bool
79615     * @since PECL memcache >= 0.4.0
79616     **/
79617    function close(){}
79618
79619    /**
79620     * {@link Memcache::connect} establishes a connection to the memcached
79621     * server. The connection, which was opened using {@link
79622     * Memcache::connect} will be automatically closed at the end of script
79623     * execution. Also you can close it with {@link Memcache::close}. Also
79624     * you can use {@link memcache_connect} function.
79625     *
79626     * @param string $host Point to the host where memcached is listening
79627     *   for connections. This parameter may also specify other transports
79628     *   like unix:///path/to/memcached.sock to use UNIX domain sockets, in
79629     *   this case {@link port} must also be set to 0.
79630     * @param int $port Point to the port where memcached is listening for
79631     *   connections. Set this parameter to 0 when using UNIX domain sockets.
79632     * @param int $timeout Value in seconds which will be used for
79633     *   connecting to the daemon. Think twice before changing the default
79634     *   value of 1 second - you can lose all the advantages of caching if
79635     *   your connection is too slow.
79636     * @return bool
79637     * @since PECL memcache >= 0.2.0
79638     **/
79639    function connect($host, $port, $timeout){}
79640
79641    /**
79642     * {@link Memcache::decrement} decrements value of the item by {@link
79643     * value}. Similarly to {@link Memcache::increment}, current value of the
79644     * item is being converted to numerical and after that {@link value} is
79645     * substracted. New item's value will not be less than zero. Do not use
79646     * {@link Memcache::decrement} with item, which was stored compressed,
79647     * because consequent call to {@link Memcache::get} will fail. {@link
79648     * Memcache::decrement} does not create an item if it didn't exist. Also
79649     * you can use {@link memcache_decrement} function.
79650     *
79651     * @param string $key Key of the item do decrement.
79652     * @param int $value Decrement the item by {@link value}.
79653     * @return int
79654     * @since PECL memcache >= 0.2.0
79655     **/
79656    function decrement($key, $value){}
79657
79658    /**
79659     * {@link Memcache::delete} deletes item with the {@link key}. If
79660     * parameter {@link timeout} is specified, the item will expire after
79661     * {@link timeout} seconds. Also you can use {@link memcache_delete}
79662     * function.
79663     *
79664     * @param string $key The key associated with the item to delete.
79665     * @param int $timeout Execution time of the item. If it's equal to
79666     *   zero, the item will be deleted right away whereas if you set it to
79667     *   30, the item will be deleted in 30 seconds.
79668     * @return bool
79669     * @since PECL memcache >= 0.2.0
79670     **/
79671    function delete($key, $timeout){}
79672
79673    /**
79674     * {@link Memcache::flush} immediately invalidates all existing items.
79675     * {@link Memcache::flush} doesn't actually free any resources, it only
79676     * marks all the items as expired, so occupied memory will be overwritten
79677     * by new items. Also you can use {@link memcache_flush} function.
79678     *
79679     * @return bool
79680     * @since PECL memcache >= 1.0.0
79681     **/
79682    function flush(){}
79683
79684    /**
79685     * {@link Memcache::get} returns previously stored data if an item with
79686     * such {@link key} exists on the server at this moment.
79687     *
79688     * You can pass array of keys to {@link Memcache::get} to get array of
79689     * values. The result array will contain only found key-value pairs.
79690     *
79691     * @param string $key The key or array of keys to fetch.
79692     * @param int $flags If present, flags fetched along with the values
79693     *   will be written to this parameter. These flags are the same as the
79694     *   ones given to for example {@link Memcache::set}. The lowest byte of
79695     *   the int is reserved for pecl/memcache internal usage (e.g. to
79696     *   indicate compression and serialization status).
79697     * @return string
79698     * @since PECL memcache >= 0.2.0
79699     **/
79700    function get($key, &$flags){}
79701
79702    /**
79703     * {@link Memcache::getExtendedStats} returns a two-dimensional
79704     * associative array with server statistics. Array keys correspond to
79705     * host:port of server and values contain the individual server
79706     * statistics. A failed server will have its corresponding entry set to .
79707     * You can also use the {@link memcache_get_extended_stats} function.
79708     *
79709     * @param string $type The type of statistics to fetch. Valid values
79710     *   are {reset, malloc, maps, cachedump, slabs, items, sizes}. According
79711     *   to the memcached protocol spec these additional arguments "are
79712     *   subject to change for the convenience of memcache developers".
79713     * @param int $slabid Used in conjunction with {@link type} set to
79714     *   cachedump to identify the slab to dump from. The cachedump command
79715     *   ties up the server and is strictly to be used for debugging
79716     *   purposes.
79717     * @param int $limit Used in conjunction with {@link type} set to
79718     *   cachedump to limit the number of entries to dump.
79719     * @return array
79720     * @since PECL memcache >= 2.0.0
79721     **/
79722    function getExtendedStats($type, $slabid, $limit){}
79723
79724    /**
79725     * {@link Memcache::getServerStatus} returns a the servers online/offline
79726     * status. You can also use {@link memcache_get_server_status} function.
79727     *
79728     * @param string $host Point to the host where memcached is listening
79729     *   for connections.
79730     * @param int $port Point to the port where memcached is listening for
79731     *   connections.
79732     * @return int
79733     * @since PECL memcache >= 2.1.0
79734     **/
79735    function getServerStatus($host, $port){}
79736
79737    /**
79738     * {@link Memcache::getStats} returns an associative array with server's
79739     * statistics. Array keys correspond to stats parameters and values to
79740     * parameter's values. Also you can use {@link memcache_get_stats}
79741     * function.
79742     *
79743     * @param string $type The type of statistics to fetch. Valid values
79744     *   are {reset, malloc, maps, cachedump, slabs, items, sizes}. According
79745     *   to the memcached protocol spec these additional arguments "are
79746     *   subject to change for the convenience of memcache developers".
79747     * @param int $slabid Used in conjunction with {@link type} set to
79748     *   cachedump to identify the slab to dump from. The cachedump command
79749     *   ties up the server and is strictly to be used for debugging
79750     *   purposes.
79751     * @param int $limit Used in conjunction with {@link type} set to
79752     *   cachedump to limit the number of entries to dump.
79753     * @return array
79754     * @since PECL memcache >= 0.2.0
79755     **/
79756    function getStats($type, $slabid, $limit){}
79757
79758    /**
79759     * {@link Memcache::getVersion} returns a string with server's version
79760     * number. Also you can use {@link memcache_get_version} function.
79761     *
79762     * @return string
79763     * @since PECL memcache >= 0.2.0
79764     **/
79765    function getVersion(){}
79766
79767    /**
79768     * {@link Memcache::increment} increments value of an item by the
79769     * specified {@link value}. If item specified by {@link key} was not
79770     * numeric and cannot be converted to a number, it will change its value
79771     * to {@link value}. {@link Memcache::increment} does not create an item
79772     * if it doesn't already exist. Do not use {@link Memcache::increment}
79773     * with items that have been stored compressed because subsequent calls
79774     * to {@link Memcache::get} will fail. Also you can use {@link
79775     * memcache_increment} function.
79776     *
79777     * @param string $key Key of the item to increment.
79778     * @param int $value Increment the item by {@link value}.
79779     * @return int
79780     * @since PECL memcache >= 0.2.0
79781     **/
79782    function increment($key, $value){}
79783
79784    /**
79785     * {@link Memcache::pconnect} is similar to {@link Memcache::connect}
79786     * with the difference, that the connection it establishes is persistent.
79787     * This connection is not closed after the end of script execution and by
79788     * {@link Memcache::close} function. Also you can use {@link
79789     * memcache_pconnect} function.
79790     *
79791     * @param string $host Point to the host where memcached is listening
79792     *   for connections. This parameter may also specify other transports
79793     *   like unix:///path/to/memcached.sock to use UNIX domain sockets, in
79794     *   this case {@link port} must also be set to 0.
79795     * @param int $port Point to the port where memcached is listening for
79796     *   connections. Set this parameter to 0 when using UNIX domain sockets.
79797     * @param int $timeout Value in seconds which will be used for
79798     *   connecting to the daemon. Think twice before changing the default
79799     *   value of 1 second - you can lose all the advantages of caching if
79800     *   your connection is too slow.
79801     * @return bool
79802     * @since PECL memcache >= 0.4.0
79803     **/
79804    function pconnect($host, $port, $timeout){}
79805
79806    /**
79807     * {@link Memcache::replace} should be used to replace value of existing
79808     * item with {@link key}. In case if item with such key doesn't exists,
79809     * {@link Memcache::replace} returns . For the rest {@link
79810     * Memcache::replace} behaves similarly to {@link Memcache::set}. Also
79811     * you can use {@link memcache_replace} function.
79812     *
79813     * @param string $key The key that will be associated with the item.
79814     * @param mixed $var The variable to store. Strings and integers are
79815     *   stored as is, other types are stored serialized.
79816     * @param int $flag Use MEMCACHE_COMPRESSED to store the item
79817     *   compressed (uses zlib).
79818     * @param int $expire Expiration time of the item. If it's equal to
79819     *   zero, the item will never expire. You can also use Unix timestamp or
79820     *   a number of seconds starting from current time, but in the latter
79821     *   case the number of seconds may not exceed 2592000 (30 days).
79822     * @return bool
79823     * @since PECL memcache >= 0.2.0
79824     **/
79825    function replace($key, $var, $flag, $expire){}
79826
79827    /**
79828     * {@link Memcache::set} stores an item {@link var} with {@link key} on
79829     * the memcached server. Parameter {@link expire} is expiration time in
79830     * seconds. If it's 0, the item never expires (but memcached server
79831     * doesn't guarantee this item to be stored all the time, it could be
79832     * deleted from the cache to make place for other items). You can use
79833     * MEMCACHE_COMPRESSED constant as {@link flag} value if you want to use
79834     * on-the-fly compression (uses zlib). Remember that resource variables
79835     * (i.e. file and connection descriptors) cannot be stored in the cache,
79836     * because they cannot be adequately represented in serialized state.
79837     * Also you can use {@link memcache_set} function.
79838     *
79839     * @param string $key The key that will be associated with the item.
79840     * @param mixed $var The variable to store. Strings and integers are
79841     *   stored as is, other types are stored serialized.
79842     * @param int $flag Use MEMCACHE_COMPRESSED to store the item
79843     *   compressed (uses zlib).
79844     * @param int $expire Expiration time of the item. If it's equal to
79845     *   zero, the item will never expire. You can also use Unix timestamp or
79846     *   a number of seconds starting from current time, but in the latter
79847     *   case the number of seconds may not exceed 2592000 (30 days).
79848     * @return bool
79849     * @since PECL memcache >= 0.2.0
79850     **/
79851    function set($key, $var, $flag, $expire){}
79852
79853    /**
79854     * {@link Memcache::setCompressThreshold} enables automatic compression
79855     * of large values. You can also use the {@link
79856     * memcache_set_compress_threshold} function.
79857     *
79858     * @param int $threshold Controls the minimum value length before
79859     *   attempting to compress automatically.
79860     * @param float $min_savings Specifies the minimum amount of savings to
79861     *   actually store the value compressed. The supplied value must be
79862     *   between 0 and 1. Default value is 0.2 giving a minimum 20%
79863     *   compression savings.
79864     * @return bool
79865     * @since PECL memcache >= 2.0.0
79866     **/
79867    function setCompressThreshold($threshold, $min_savings){}
79868
79869    /**
79870     * {@link Memcache::setServerParams} changes server parameters at
79871     * runtime. You can also use the {@link memcache_set_server_params}
79872     * function.
79873     *
79874     * @param string $host Point to the host where memcached is listening
79875     *   for connections.
79876     * @param int $port Point to the port where memcached is listening for
79877     *   connections.
79878     * @param int $timeout Value in seconds which will be used for
79879     *   connecting to the daemon. Think twice before changing the default
79880     *   value of 1 second - you can lose all the advantages of caching if
79881     *   your connection is too slow.
79882     * @param int $retry_interval Controls how often a failed server will
79883     *   be retried, the default value is 15 seconds. Setting this parameter
79884     *   to -1 disables automatic retry. Neither this nor the {@link
79885     *   persistent} parameter has any effect when the extension is loaded
79886     *   dynamically via {@link dl}.
79887     * @param bool $status Controls if the server should be flagged as
79888     *   online. Setting this parameter to and {@link retry_interval} to -1
79889     *   allows a failed server to be kept in the pool so as not to affect
79890     *   the key distribution algoritm. Requests for this server will then
79891     *   failover or fail immediately depending on the {@link
79892     *   memcache.allow_failover} setting. Default to , meaning the server
79893     *   should be considered online.
79894     * @param callback $failure_callback Allows the user to specify a
79895     *   callback function to run upon encountering an error. The callback is
79896     *   run before failover is attempted. The function takes two parameters,
79897     *   the hostname and port of the failed server.
79898     * @return bool
79899     * @since PECL memcache >= 2.1.0
79900     **/
79901    function setServerParams($host, $port, $timeout, $retry_interval, $status, $failure_callback){}
79902
79903}
79904/**
79905 * Represents a connection to a set of memcached servers.
79906 **/
79907interface Memcached {
79908    const DISTRIBUTION_CONSISTENT = 0;
79909    const DISTRIBUTION_MODULA = 0;
79910    const GET_PRESERVE_ORDER = 0;
79911    const HASH_CRC = 0;
79912    const HASH_DEFAULT = 0;
79913    const HASH_FNV1A_32 = 0;
79914    const HASH_FNV1A_64 = 0;
79915    const HASH_FNV1_32 = 0;
79916    const HASH_FNV1_64 = 0;
79917    const HASH_HSIEH = 0;
79918    const HASH_MD5 = 0;
79919    const HASH_MURMUR = 0;
79920    const HAVE_IGBINARY = 0;
79921    const HAVE_JSON = 0;
79922    const OPT_BINARY_PROTOCOL = 0;
79923    const OPT_BUFFER_WRITES = 0;
79924    const OPT_CACHE_LOOKUPS = 0;
79925    const OPT_COMPRESSION = 0;
79926    const OPT_CONNECT_TIMEOUT = 0;
79927    const OPT_DISTRIBUTION = 0;
79928    const OPT_HASH = 0;
79929    const OPT_LIBKETAMA_COMPATIBLE = 0;
79930    const OPT_NO_BLOCK = 0;
79931    const OPT_POLL_TIMEOUT = 0;
79932    const OPT_PREFIX_KEY = 0;
79933    const OPT_RECV_TIMEOUT = 0;
79934    const OPT_RETRY_TIMEOUT = 0;
79935    const OPT_SEND_TIMEOUT = 0;
79936    const OPT_SERIALIZER = 0;
79937    const OPT_SERVER_FAILURE_LIMIT = 0;
79938    const OPT_SOCKET_RECV_SIZE = 0;
79939    const OPT_SOCKET_SEND_SIZE = 0;
79940    const OPT_TCP_NODELAY = 0;
79941    const RES_BAD_KEY_PROVIDED = 0;
79942    const RES_BUFFERED = 0;
79943    const RES_CLIENT_ERROR = 0;
79944    const RES_CONNECTION_SOCKET_CREATE_FAILURE = 0;
79945    const RES_DATA_EXISTS = 0;
79946    const RES_END = 0;
79947    const RES_ERRNO = 0;
79948    const RES_FAILURE = 0;
79949    const RES_HOST_LOOKUP_FAILURE = 0;
79950    const RES_NOTFOUND = 0;
79951    const RES_NOTSTORED = 0;
79952    const RES_NO_SERVERS = 0;
79953    const RES_PARTIAL_READ = 0;
79954    const RES_PAYLOAD_FAILURE = 0;
79955    const RES_PROTOCOL_ERROR = 0;
79956    const RES_SERVER_ERROR = 0;
79957    const RES_SOME_ERRORS = 0;
79958    const RES_SUCCESS = 0;
79959    const RES_TIMEOUT = 0;
79960    const RES_UNKNOWN_READ_FAILURE = 0;
79961    const RES_WRITE_FAILURE = 0;
79962    const SERIALIZER_IGBINARY = 0;
79963    const SERIALIZER_JSON = 0;
79964    const SERIALIZER_PHP = 0;
79965    /**
79966     * {@link Memcached::add} is similar to Memcached::set, but the operation
79967     * fails if the {@link key} already exists on the server.
79968     *
79969     * @param string $key
79970     * @param mixed $value
79971     * @param int $expiration
79972     * @return bool
79973     * @since PECL memcached >= 0.1.0
79974     **/
79975    function add($key, $value, $expiration);
79976
79977    /**
79978     * {@link Memcached::addByKey} is functionally equivalent to
79979     * Memcached::add, except that the free-form {@link server_key} can be
79980     * used to map the {@link key} to a specific server. This is useful if
79981     * you need to keep a bunch of related keys on a certain server.
79982     *
79983     * @param string $server_key
79984     * @param string $key
79985     * @param mixed $value
79986     * @param int $expiration
79987     * @return bool
79988     * @since PECL memcached >= 0.1.0
79989     **/
79990    function addByKey($server_key, $key, $value, $expiration);
79991
79992    /**
79993     * {@link Memcached::addServer} adds the specified server to the server
79994     * pool. No connection is established to the server at this time, but if
79995     * you are using consistent key distribution option (via
79996     * Memcached::DISTRIBUTION_CONSISTENT or
79997     * Memcached::OPT_LIBKETAMA_COMPATIBLE), some of the internal data
79998     * structures will have to be updated. Thus, if you need to add multiple
79999     * servers, it is better to use Memcached::addServers as the update then
80000     * happens only once.
80001     *
80002     * The same server may appear multiple times in the server pool, because
80003     * no duplication checks are made. This is not advisable; instead, use
80004     * the {@link weight} option to increase the selection weighting of this
80005     * server.
80006     *
80007     * @param string $host The hostname of the memcache server. If the
80008     *   hostname is invalid, data-related operations will set
80009     *   Memcached::RES_HOST_LOOKUP_FAILURE result code.
80010     * @param int $port The port on which memcache is running. Usually,
80011     *   this is 11211.
80012     * @param int $weight The weight of the server relative to the total
80013     *   weight of all the servers in the pool. This controls the probability
80014     *   of the server being selected for operations. This is used only with
80015     *   consistent distribution option and usually corresponds to the amount
80016     *   of memory available to memcache on that server.
80017     * @return bool
80018     * @since PECL memcached >= 0.1.0
80019     **/
80020    function addServer($host, $port, $weight);
80021
80022    /**
80023     * {@link Memcached::addServers} adds {@link servers} to the server pool.
80024     * Each entry in {@link servers} is supposed to an array containing
80025     * hostname, port, and, optionally, weight of the server. No connection
80026     * is established to the servers at this time.
80027     *
80028     * The same server may appear multiple times in the server pool, because
80029     * no duplication checks are made. This is not advisable; instead, use
80030     * the {@link weight} option to increase the selection weighting of this
80031     * server.
80032     *
80033     * @param array $servers Array of the servers to add to the pool.
80034     * @return bool
80035     * @since PECL memcached >= 0.1.1
80036     **/
80037    function addServers($servers);
80038
80039    /**
80040     * {@link Memcached::append} appends the given {@link value} string to
80041     * the value of an existing item. The reason that {@link value} is forced
80042     * to be a string is that appending mixed types is not well-defined.
80043     *
80044     * @param string $key
80045     * @param string $value The string to append.
80046     * @return bool
80047     * @since PECL memcached >= 0.1.0
80048     **/
80049    function append($key, $value);
80050
80051    /**
80052     * {@link Memcached::appendByKey} is functionally equivalent to
80053     * Memcached::append, except that the free-form {@link server_key} can be
80054     * used to map the {@link key} to a specific server.
80055     *
80056     * @param string $server_key
80057     * @param string $key
80058     * @param string $value The string to append.
80059     * @return bool
80060     * @since PECL memcached >= 0.1.0
80061     **/
80062    function appendByKey($server_key, $key, $value);
80063
80064    /**
80065     * {@link Memcached::cas} performs a "check and set" operation, so that
80066     * the item will be stored only if no other client has updated it since
80067     * it was last fetched by this client. The check is done via the {@link
80068     * cas_token} parameter which is a unique 64-bit value assigned to the
80069     * existing item by memcache. See the documentation for Memcached::get*
80070     * methods for how to obtain this token. Note that the token is
80071     * represented as a double due to the limitations of PHP's integer space.
80072     *
80073     * @param float $cas_token Unique value associated with the existing
80074     *   item. Generated by memcache.
80075     * @param string $key
80076     * @param mixed $value
80077     * @param int $expiration
80078     * @return bool
80079     * @since PECL memcached >= 0.1.0
80080     **/
80081    function cas($cas_token, $key, $value, $expiration);
80082
80083    /**
80084     * {@link Memcached::casByKey} is functionally equivalent to
80085     * Memcached::cas, except that the free-form {@link server_key} can be
80086     * used to map the {@link key} to a specific server. This is useful if
80087     * you need to keep a bunch of related keys on a certain server.
80088     *
80089     * @param float $cas_token Unique value associated with the existing
80090     *   item. Generated by memcache.
80091     * @param string $server_key
80092     * @param string $key
80093     * @param mixed $value
80094     * @param int $expiration
80095     * @return bool
80096     * @since PECL memcached >= 0.1.0
80097     **/
80098    function casByKey($cas_token, $server_key, $key, $value, $expiration);
80099
80100    /**
80101     * {@link Memcached::decrement} decrements a numeric item's value by the
80102     * specified {@link offset}. If the item's value is not numeric, it is
80103     * treated as if the value were 0. If the operation would decrease the
80104     * value below 0, the new value will be 0. {@link Memcached::decrement}
80105     * will fail if the item does not exist.
80106     *
80107     * @param string $key The key of the item to decrement.
80108     * @param int $offset The amount by which to decrement the item's
80109     *   value.
80110     * @return int
80111     * @since PECL memcached >= 0.1.0
80112     **/
80113    function decrement($key, $offset);
80114
80115    /**
80116     * {@link Memcached::delete} deletes the {@link key} from the server. The
80117     * {@link time} parameter is the amount of time in seconds (or Unix time
80118     * until which) the client wishes the server to refuse add and replace
80119     * commands for this key. For this amount of time, the item is put into a
80120     * delete queue, which means that it won't possible to retrieve it by the
80121     * get command, but add and replace command with this key will also fail
80122     * (the set command will succeed, however). After the time passes, the
80123     * item is finally deleted from server memory. The parameter {@link time}
80124     * defaults to 0 (which means that the item will be deleted immediately
80125     * and further storage commands with this key will succeed).
80126     *
80127     * @param string $key The key to be deleted.
80128     * @param int $time The amount of time the server will wait to delete
80129     *   the item.
80130     * @return bool
80131     * @since PECL memcached >= 0.1.0
80132     **/
80133    function delete($key, $time);
80134
80135    /**
80136     * {@link Memcached::deleteByKey} is functionally equivalent to
80137     * Memcached::delete, except that the free-form {@link server_key} can be
80138     * used to map the {@link key} to a specific server.
80139     *
80140     * @param string $server_key
80141     * @param string $key The key to be deleted.
80142     * @param int $time The amount of time the server will wait to delete
80143     *   the item.
80144     * @return bool
80145     * @since PECL memcached >= 0.1.0
80146     **/
80147    function deleteByKey($server_key, $key, $time);
80148
80149    /**
80150     * {@link Memcached::fetch} retrieves the next result from the last
80151     * request.
80152     *
80153     * @return array
80154     * @since PECL memcached >= 0.1.0
80155     **/
80156    function fetch();
80157
80158    /**
80159     * {@link Memcached::fetchAll} retrieves all the remaining results from
80160     * the last request.
80161     *
80162     * @return array
80163     * @since PECL memcached >= 0.1.0
80164     **/
80165    function fetchAll();
80166
80167    /**
80168     * {@link Memcached::flush} invalidates all existing cache items
80169     * immediately (by default) or after the {@link delay} specified. After
80170     * invalidation none of the items will be returned in response to a
80171     * retrieval command (unless it's stored again under the same key after
80172     * {@link Memcached::flush} has invalidated the items). The flush does
80173     * not actually free all the memory taken up by the existing items; that
80174     * will happen gradually as new items are stored.
80175     *
80176     * @param int $delay Numer of seconds to wait before invalidating the
80177     *   items.
80178     * @return bool
80179     * @since PECL memcached >= 0.1.0
80180     **/
80181    function flush($delay);
80182
80183    /**
80184     * {@link Memcached::get} returns the item that was previously stored
80185     * under the {@link key}. If the item is found and {@link cas_token}
80186     * variable is provided, it will contain the CAS token value for the
80187     * item. See Memcached::cas for how to use CAS tokens. Read-through
80188     * caching callback may be specified via {@link cache_cb} parameter.
80189     *
80190     * @param string $key The key of the item to retrieve.
80191     * @param callback $cache_cb Read-through caching callback or .
80192     * @param float $cas_token The variable to store the CAS token in.
80193     * @return mixed
80194     * @since PECL memcached >= 0.1.0
80195     **/
80196    function get($key, $cache_cb, &$cas_token);
80197
80198    /**
80199     * {@link Memcached::getByKey} is functionally equivalent to
80200     * Memcached::get, except that the free-form {@link server_key} can be
80201     * used to map the {@link key} to a specific server.
80202     *
80203     * @param string $server_key
80204     * @param string $key The key of the item to fetch.
80205     * @param callback $cache_cb Read-through caching callback or
80206     * @param float $cas_token The variable to store the CAS token in.
80207     * @return mixed
80208     * @since PECL memcached >= 0.1.0
80209     **/
80210    function getByKey($server_key, $key, $cache_cb, &$cas_token);
80211
80212    /**
80213     * {@link Memcached::getDelayed} issues a request to memcache for
80214     * multiple items the keys of which are specified in the {@link keys}
80215     * array. The method does not wait for response and returns right away.
80216     * When you are ready to collect the items, call either Memcached::fetch
80217     * or Memcached::fetchAll. If {@link with_cas} is true, the CAS token
80218     * values will also be requested.
80219     *
80220     * Instead of fetching the results explicitly, you can specify a result
80221     * callback via {@link value_cb} parameter.
80222     *
80223     * @param array $keys Array of keys to request.
80224     * @param bool $with_cas Whether to request CAS token values also.
80225     * @param callback $value_cb The result callback or .
80226     * @return bool
80227     * @since PECL memcached >= 0.1.0
80228     **/
80229    function getDelayed($keys, $with_cas, $value_cb);
80230
80231    /**
80232     * {@link Memcached::getDelayedByKey} is functionally equivalent to
80233     * Memcached::getDelayed, except that the free-form {@link server_key}
80234     * can be used to map the {@link keys} to a specific server.
80235     *
80236     * @param string $server_key
80237     * @param array $keys Array of keys to request.
80238     * @param bool $with_cas Whether to request CAS token values also.
80239     * @param callback $value_cb The result callback or .
80240     * @return bool
80241     * @since PECL memcached >= 0.1.0
80242     **/
80243    function getDelayedByKey($server_key, $keys, $with_cas, $value_cb);
80244
80245    /**
80246     * {@link Memcached::getMulti} is similar to Memcached::get, but instead
80247     * of a single key item, it retrievess multiple items the keys of which
80248     * are specified in the {@link keys} array. If {@link cas_tokens}
80249     * variable is provided, it is filled with the CAS token values for the
80250     * found items. Unlike Memcached::get it is not possible to specify a
80251     * read-through cache callback for {@link Memcached::getMulti}, because
80252     * the memcache protocol does not provide information on which keys were
80253     * not found in the multi-key request.
80254     *
80255     * The {@link flags} parameter can be used to specify additional options
80256     * for {@link Memcached::getMulti}. Currently, the only available option
80257     * is Memcached::GET_PRESERVE_ORDER that ensures that the keys are
80258     * returned in the same order as they were requested in.
80259     *
80260     * @param array $keys Array of keys to retrieve.
80261     * @param array $cas_tokens The variable to store the CAS tokens for
80262     *   the found items.
80263     * @param int $flags The flags for the get operation.
80264     * @return mixed
80265     * @since PECL memcached >= 0.1.0
80266     **/
80267    function getMulti($keys, &$cas_tokens, $flags);
80268
80269    /**
80270     * {@link Memcached::getMultiByKey} is functionally equivalent to
80271     * Memcached::getMulti, except that the free-form {@link server_key} can
80272     * be used to map the {@link keys} to a specific server.
80273     *
80274     * @param string $server_key
80275     * @param array $keys Array of keys to retrieve.
80276     * @param string $cas_tokens The variable to store the CAS tokens for
80277     *   the found items.
80278     * @param int $flags The flags for the get operation.
80279     * @return void
80280     * @since PECL memcached >= 0.1.0
80281     **/
80282    function getMultiByKey($server_key, $keys, &$cas_tokens, $flags);
80283
80284    /**
80285     * This method returns the value of a Memcached {@link option}. Some
80286     * options correspond to the ones defined by libmemcached, and some are
80287     * specific to the extension. See Memcached Constants for more
80288     * information.
80289     *
80290     * @param int $option One of the Memcached::OPT_* constants.
80291     * @return mixed
80292     * @since PECL memcached >= 0.1.0
80293     **/
80294    function getOption($option);
80295
80296    /**
80297     * {@link Memcached::getResultCode} returns one of the Memcached::RES_*
80298     * constants that is the result of the last executed Memcached method.
80299     *
80300     * @return int
80301     * @since PECL memcached >= 0.1.0
80302     **/
80303    function getResultCode();
80304
80305    /**
80306     * {@link Memcached::getResultMessage} returns a string that describes
80307     * the result code of the last executed Memcached method.
80308     *
80309     * @return string
80310     * @since PECL memcached >= 1.0.0
80311     **/
80312    function getResultMessage();
80313
80314    /**
80315     * {@link Memcached::getServerByKey} returns the server that would be
80316     * selected by a particular {@link server_key} in all the {@link
80317     * Memcached::*ByKey} operations.
80318     *
80319     * @param string $server_key
80320     * @return array
80321     * @since PECL memcached >= 0.1.0
80322     **/
80323    function getServerByKey($server_key);
80324
80325    /**
80326     * {@link Memcached::getServerList} returns the list of all servers that
80327     * are in its server pool.
80328     *
80329     * @return array
80330     * @since PECL memcached >= 0.1.0
80331     **/
80332    function getServerList();
80333
80334    /**
80335     * {@link Memcached::getStats} returns an array containing the state of
80336     * all available memcache servers. See memcache protocol specification
80337     * for details on these statistics.
80338     *
80339     * @return array
80340     * @since PECL memcached >= 0.1.0
80341     **/
80342    function getStats();
80343
80344    /**
80345     * {@link Memcached::getVersion} returns an array containing the version
80346     * info for all available memcache servers.
80347     *
80348     * @return array
80349     * @since PECL memcached >= 0.1.5
80350     **/
80351    function getVersion();
80352
80353    /**
80354     * {@link Memcached::increment} increments a numeric item's value by the
80355     * specified {@link offset}. If the item's value is not numeric, it is
80356     * treated as if the value were 0. {@link Memcached::increment} will fail
80357     * if the item does not exist.
80358     *
80359     * @param string $key The key of the item to increment.
80360     * @param int $offset The amount by which to increment the item's
80361     *   value.
80362     * @return int
80363     * @since PECL memcached >= 0.1.0
80364     **/
80365    function increment($key, $offset);
80366
80367    /**
80368     * {@link Memcached::prepend} prepends the given {@link value} string to
80369     * the value of an existing item. The reason that {@link value} is forced
80370     * to be a string is that prepending mixed types is not well-defined.
80371     *
80372     * @param string $key The key of the item to prepend the data to.
80373     * @param string $value The string to prepend.
80374     * @return bool
80375     * @since PECL memcached >= 0.1.0
80376     **/
80377    function prepend($key, $value);
80378
80379    /**
80380     * {@link Memcached::prependByKey} is functionally equivalent to
80381     * Memcached::prepend, except that the free-form {@link server_key} can
80382     * be used to map the {@link key} to a specific server.
80383     *
80384     * @param string $server_key
80385     * @param string $key The key of the item to prepend the data to.
80386     * @param string $value The string to prepend.
80387     * @return bool
80388     * @since PECL memcached >= 0.1.0
80389     **/
80390    function prependByKey($server_key, $key, $value);
80391
80392    /**
80393     * {@link Memcached::replace} is similar to Memcached::set, but the
80394     * operation fails if the {@link key} does not exist on the server.
80395     *
80396     * @param string $key
80397     * @param mixed $value
80398     * @param int $expiration
80399     * @return bool
80400     * @since PECL memcached >= 0.1.0
80401     **/
80402    function replace($key, $value, $expiration);
80403
80404    /**
80405     * {@link Memcached::replaceByKey} is functionally equivalent to
80406     * Memcached::replace, except that the free-form {@link server_key} can
80407     * be used to map the {@link key} to a specific server. This is useful if
80408     * you need to keep a bunch of related keys on a certain server.
80409     *
80410     * @param string $server_key
80411     * @param string $key
80412     * @param mixed $value
80413     * @param int $expiration
80414     * @return bool
80415     * @since PECL memcached >= 0.1.0
80416     **/
80417    function replaceByKey($server_key, $key, $value, $expiration);
80418
80419    /**
80420     * {@link Memcached::set} stores the {@link value} on a memcache server
80421     * under the specified {@link key}. The {@link expiration} parameter can
80422     * be used to control when the value is considered expired.
80423     *
80424     * The value can be any valid PHP type except for resources, because
80425     * those cannot be represented in a serialized form. If the
80426     * Memcached::OPT_COMPRESSION option is turned on, the serialized value
80427     * will also be compressed before storage.
80428     *
80429     * @param string $key
80430     * @param mixed $value
80431     * @param int $expiration
80432     * @return bool
80433     * @since PECL memcached >= 0.1.0
80434     **/
80435    function set($key, $value, $expiration);
80436
80437    /**
80438     * {@link Memcached::setByKey} is functionally equivalent to
80439     * Memcached::set, except that the free-form {@link server_key} can be
80440     * used to map the {@link key} to a specific server. This is useful if
80441     * you need to keep a bunch of related keys on a certain server.
80442     *
80443     * @param string $server_key
80444     * @param string $key
80445     * @param mixed $value
80446     * @param int $expiration
80447     * @return bool
80448     * @since PECL memcached >= 0.1.0
80449     **/
80450    function setByKey($server_key, $key, $value, $expiration);
80451
80452    /**
80453     * {@link Memcached::setMulti} is similar to Memcached::set, but instead
80454     * of a single key/value item, it works on multiple items specified in
80455     * {@link items}. The {@link expiration} time applies to all the items at
80456     * once.
80457     *
80458     * @param array $items
80459     * @param int $expiration
80460     * @return bool
80461     * @since PECL memcached >= 0.1.0
80462     **/
80463    function setMulti($items, $expiration);
80464
80465    /**
80466     * {@link Memcached::setMultiByKey} is functionally equivalent to
80467     * Memcached::setMulti, except that the free-form {@link server_key} can
80468     * be used to map the keys from {@link items} to a specific server. This
80469     * is useful if you need to keep a bunch of related keys on a certain
80470     * server.
80471     *
80472     * @param string $server_key
80473     * @param array $items
80474     * @param int $expiration
80475     * @return bool
80476     * @since PECL memcached >= 0.1.0
80477     **/
80478    function setMultiByKey($server_key, $items, $expiration);
80479
80480    /**
80481     * This method sets the value of a Memcached {@link option}. Some options
80482     * correspond to the ones defined by libmemcached, and some are specific
80483     * to the extension. See Memcached Constants for more information.
80484     *
80485     * The options listed below require values specified via constants.
80486     * Memcached::OPT_HASH requires Memcached::HASH_* values.
80487     * Memcached::OPT_DISTRIBUTION requires Memcached::DISTRIBUTION_* values.
80488     *
80489     * @param int $option
80490     * @param mixed $value
80491     * @return bool
80492     * @since PECL memcached >= 0.1.0
80493     **/
80494    function setOption($option, $value);
80495
80496}
80497/**
80498 * Description of the class.
80499 **/
80500class MemcachedException extends RuntimeException {
80501}
80502class MessageFormatter {
80503    /**
80504     * Constructs a new Message Formatter
80505     *
80506     * @param string $locale The locale to use when formatting arguments
80507     * @param string $pattern The pattern string to stick arguments into.
80508     *   The pattern uses an 'apostrophe-friendly' syntax; it is run through
80509     *   umsg_autoQuoteApostrophe before being interpreted.
80510     * @return MessageFormatter
80511     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
80512     **/
80513    function create($locale, $pattern){}
80514
80515    /**
80516     * Format the message by substituting the data into the format string
80517     * according to the locale rules
80518     *
80519     * @param array $args The message formatter
80520     * @return string
80521     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
80522     **/
80523    function format($args){}
80524
80525    /**
80526     * Quick formatting function that formats the string without having to
80527     * explicitly create the formatter object. Use this function when the
80528     * format operation is done only once and does not need and parameters or
80529     * state to be kept.
80530     *
80531     * @param string $locale The locale to use for formatting
80532     *   locale-dependent parts
80533     * @param string $pattern The pattern string to insert things into. The
80534     *   pattern uses an 'apostrophe-friendly' syntax; it is run through
80535     *   umsg_autoQuoteApostrophe before being interpreted.
80536     * @param array $args The array of values to insert into the format
80537     *   string
80538     * @return string
80539     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
80540     **/
80541    function formatMessage($locale, $pattern, $args){}
80542
80543    /**
80544     * Get the error code from last operation.
80545     *
80546     * @return int
80547     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
80548     **/
80549    function getErrorCode(){}
80550
80551    /**
80552     * Get the error text from the last operation.
80553     *
80554     * @return string
80555     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
80556     **/
80557    function getErrorMessage(){}
80558
80559    /**
80560     * Get the locale for which the formatter was created.
80561     *
80562     * @return string
80563     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
80564     **/
80565    function getLocale(){}
80566
80567    /**
80568     * Get the pattern used by the formatter
80569     *
80570     * @return string
80571     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
80572     **/
80573    function getPattern(){}
80574
80575    /**
80576     * Parses input string and return any extracted items as an array.
80577     *
80578     * @param string $value The message formatter
80579     * @return array
80580     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
80581     **/
80582    function parse($value){}
80583
80584    /**
80585     * Parses input string without explicitly creating the formatter object.
80586     * Use this function when the format operation is done only once and does
80587     * not need and parameters or state to be kept.
80588     *
80589     * @param string $locale The locale to use for parsing locale-dependent
80590     *   parts
80591     * @param string $value The string to parse for items
80592     * @return array
80593     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
80594     **/
80595    function parseMessage($locale, $value){}
80596
80597    /**
80598     * Set the pattern used by the formatter
80599     *
80600     * @param string $pattern The message formatter
80601     * @return bool
80602     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
80603     **/
80604    function setPattern($pattern){}
80605
80606}
80607/**
80608 * The connection point between MongoDB and PHP.
80609 *
80610 * This class is used to initiate a connection and for database server
80611 * commands. A typical use is:
80612 *
80613 * See for more information about creating connections.
80614 **/
80615class Mongo {
80616    /**
80617     * This method does not need to be called, except in unusual
80618     * circumstances. The driver will cleanly close the database connection
80619     * when the Mongo object goes out of scope.
80620     *
80621     * If you are using a service where objects do not go out of scope
80622     * between requests, you may wish to call close() at the end of your
80623     * program to keep old connections from hanging around. However, it is
80624     * probably more efficient to take advantage of this fact and simply use
80625     * a persistent connection, which will automatically create a connection
80626     * if needed and use it for as many requests as the application server
80627     * allows it to exist.
80628     *
80629     * You may also wish to call close() if you are unsure of the state of a
80630     * connection and wish to guarantee a new connection will happen. For
80631     * example:
80632     *
80633     * vs.
80634     *
80635     * @return boolean
80636     * @since PECL mongo >=0.9.0
80637     **/
80638    function close(){}
80639
80640    /**
80641     * @return boolean
80642     * @since PECL mongo >=0.9.0
80643     **/
80644    function connect(){}
80645
80646    /**
80647     * @return boolean
80648     * @since PECL mongo >=0.9.0
80649     **/
80650    function connectUtil(){}
80651
80652    /**
80653     * @param mixed $db The database to drop. Can be a MongoDB object or
80654     *   the name of the database.
80655     * @return array
80656     * @since PECL mongo >=0.9.0
80657     **/
80658    function dropDB($db){}
80659
80660    /**
80661     * Use {@link MongoDB::forceError} instead.
80662     *
80663     * @return bool
80664     **/
80665    function forceError(){}
80666
80667    /**
80668     * Use {@link MongoDB::lastError} instead.
80669     *
80670     * @return array
80671     **/
80672    function lastError(){}
80673
80674    /**
80675     * @return array
80676     * @since PECL mongo >=1.0.4
80677     **/
80678    function listDBs(){}
80679
80680    /**
80681     * Pass a string of the form "mongodb://server1,server2" to the
80682     * constructor instead of using this method.
80683     *
80684     * @return boolean
80685     * @since PECL mongo >=0.9.0
80686     **/
80687    function pairConnect(){}
80688
80689    /**
80690     * Pass "mongodb://server1,server2" and array("persist" => $id) to the
80691     * constructor instead of using this method.
80692     *
80693     * @param string $username A username used to identify the connection.
80694     * @param string $password A password used to identify the connection.
80695     * @return boolean
80696     * @since PECL mongo >=0.9.0
80697     **/
80698    function pairPersistConnect($username, $password){}
80699
80700    /**
80701     * Pass array("persist" => $id) to the constructor instead of using this
80702     * method.
80703     *
80704     * @param string $username A username used to identify the connection.
80705     * @param string $password A password used to identify the connection.
80706     * @return boolean
80707     * @since PECL mongo >=0.9.0
80708     **/
80709    function persistConnect($username, $password){}
80710
80711    /**
80712     * Use {@link MongoDB::prevError} instead.
80713     *
80714     * @return array
80715     **/
80716    function prevError(){}
80717
80718    /**
80719     * Use {@link MongoDB::resetError} instead.
80720     *
80721     * @return array
80722     **/
80723    function resetError(){}
80724
80725    /**
80726     * @param string $db The database name.
80727     * @param string $collection The collection name.
80728     * @return MongoCollection
80729     * @since PECL mongo >=0.9.0
80730     **/
80731    function selectCollection($db, $collection){}
80732
80733    /**
80734     * @param string $name The database name.
80735     * @return MongoDB
80736     * @since PECL mongo >=0.9.0
80737     **/
80738    function selectDB($name){}
80739
80740    /**
80741     * If no parameters are passed, this connects to "localhost:27017" (or
80742     * whatever was specified in php.ini for mongo.default_host and
80743     * mongo.default_port).
80744     *
80745     * As of version 1.0.2, {@link server} can have a special form:
80746     *
80747     * mongodb://[username:password@]host1[:port1][,host2[:port2:],...]/db
80748     *
80749     * It starts with mongodb://, to indicate it is a connection string in
80750     * this form.
80751     *
80752     * If username and password are specified, the constructor will attempt
80753     * to authenticate the connection with the database before returning.
80754     * Username and password are optional and must be followed by an @, if
80755     * specified.
80756     *
80757     * At least one host must be given (port optional, always defaulting to
80758     * 27017) and as many hosts as desired may be connected to. Host names
80759     * are comma-separated and the constructor will return successfully if it
80760     * connected to at least one host. If it could not connect to any of the
80761     * hosts, it will throw a MongoConnectionException.
80762     *
80763     * Finally, if you specified a username and password, you may specify a
80764     * database to authenticate with. If db is not specified, "admin" will be
80765     * used.
80766     *
80767     * If you elect not to connect immediately (you pass the option
80768     * array("connect" => false)), you will need to call {@link
80769     * Mongo::connect} before doing any database operations.
80770     *
80771     * @param string $server The server name.
80772     * @param array $options An array of options for the connection.
80773     *   Currently available options include: "connect" If the constructor
80774     *   should connect before returning. Default is . "persist" If the
80775     *   connection should be persistent. If set, the connection will be
80776     *   persistent. The string representation of the value is used as an id
80777     *   for the connection, so two instances of Mongo that are initialized
80778     *   with array("persist" => "foobar") will share the same database
80779     *   connection, whereas an instance initialized with array("persist" =>
80780     *   "barbaz") will use a different database connection. "timeout" For
80781     *   how long the driver should try to connect to the database (in
80782     *   milliseconds).
80783     * @since PECL mongo >=0.9.0
80784     **/
80785    function __construct($server, $options){}
80786
80787    /**
80788     * This is the cleanest way of getting a database. If the database name
80789     * has any special characters, {@link Mongo::selectDB} will need to be
80790     * used. However, in most cases, this should be sufficient.
80791     *
80792     * <?php
80793     *
80794     * $mongo = new Mongo();
80795     *
80796     * // the following two lines are equivalent $db =
80797     * $mongo->selectDB("foo"); $db = $mongo->foo;
80798     *
80799     * ?>
80800     *
80801     * @param string $dbname The database name.
80802     * @return MongoDB
80803     * @since PECL mongo >=1.0.2
80804     **/
80805    function __get($dbname){}
80806
80807    /**
80808     * @return string
80809     * @since PECL mongo >=0.9.0
80810     **/
80811    function __toString(){}
80812
80813}
80814/**
80815 * An object that can be used to store or retrieve binary data from the
80816 * database.
80817 *
80818 * The maximum size of a single object that can be inserted into the
80819 * database is 4Mb. For data that is larger than this (movies, music,
80820 * Henry Kissinger's autobiography), use . For data that is smaller than
80821 * 4Mb, it's probably be easier to just embed it into the document using
80822 * .
80823 *
80824 * For example, to embed an image in a document, one could write:
80825 *
80826 * This class contains a field, which currently gives no additional
80827 * functionality in the driver or the database. There are five predefined
80828 * types (which are the class constants listed below), and the user can
80829 * create their own (at the risk of the BSON spec catching up with them).
80830 * By default, the PHP driver always uses type 2: a byte array.
80831 **/
80832class MongoBinData {
80833    /**
80834     * Creates a new binary data object.
80835     *
80836     * There are five types of binary data currently recognized by the BSON
80837     * spec: function (0x01), byte array (0x02), UUID (0x03), MD5 (0x05), and
80838     * user defined (0x80). The default type is byte array (0x02). There is
80839     * no particular difference in how the driver or server interpret
80840     * different types, so by and large they are irrelevant for now. Any
80841     * number (between 0 and 255) could be used for type, if the user is
80842     * willing to assume the risk that the database might eventually do
80843     * something with binary data based on type.
80844     *
80845     * @param string $data Binary data.
80846     * @param int $type Data type.
80847     * @since PECL mongo >= 0.8.1
80848     **/
80849    function __construct($data, $type){}
80850
80851    /**
80852     * @return string
80853     * @since PECL mongo >= 0.8.1
80854     **/
80855    function __toString(){}
80856
80857}
80858/**
80859 * Represents JavaScript code for the database.
80860 *
80861 * MongoCode objects are composed of two parts: a string of code and an
80862 * optional scope. The string of code must be valid JavaScript. The scope
80863 * is a associative array of variable name/value pairs.
80864 **/
80865class MongoCode {
80866    /**
80867     * @param string $code A string of code.
80868     * @param array $scope The scope to use for the code.
80869     * @since PECL mongo >= 0.8.3
80870     **/
80871    function __construct($code, $scope){}
80872
80873    /**
80874     * @return string
80875     * @since PECL mongo >= 0.8.3
80876     **/
80877    function __toString(){}
80878
80879}
80880/**
80881 * Representations a database collection.
80882 *
80883 * Collection names can use any character in the ASCII set. Some valid
80884 * collection names are , ..., my collection, and *&#@.
80885 *
80886 * User-defined collection names cannot contain the $ symbol. There are
80887 * certain system collections which use a $ in their names (e.g.,
80888 * local.oplog.$main), but it is a reserved character. If you attempt to
80889 * create and use a collection with a $ in the name, MongoDB will assert.
80890 **/
80891class MongoCollection extends MongoCollection {
80892    /**
80893     * @param array $a An array of arrays.
80894     * @param array $options Options for the inserts. "safe" Check that the
80895     *   inserts succeeded.
80896     * @return mixed
80897     * @since PECL mongo >=0.9.0
80898     **/
80899    function batchInsert($a, $options){}
80900
80901    /**
80902     * @param mixed $query Array or object with fields to match.
80903     * @return int
80904     * @since PECL mongo >=0.9.0
80905     **/
80906    function count($query){}
80907
80908    /**
80909     * @param array $a Object to which to create a reference.
80910     * @return array
80911     * @since PECL mongo >=0.9.0
80912     **/
80913    function createDBRef($a){}
80914
80915    /**
80916     * This method is identical to:
80917     *
80918     * Each index, when created, is given a unique name. This is generally
80919     * user-set (with {@link MongoCollection::ensureIndex}'s "name" option)
80920     * or generated by the driver from a combination of key names and
80921     * directions. This name is then used by {@link
80922     * MongoCollection::deleteIndex} to remove the function.
80923     *
80924     * Unfortunately, the {@link MongoCollection::ensureIndex} generates
80925     * slightly different names than the shell and, due to backwards
80926     * compatibility issues, {@link MongoCollection::deleteIndex} cannot
80927     * delete custom-named indexes as well. Thus, the best way to delete
80928     * indexes created in the shell or with custom names is to directly call
80929     * the deleteIndexes database command.
80930     *
80931     * Thus, if you named an index "superfast query", you could delete it
80932     * with:
80933     *
80934     * To find what an index is named, you can query the system.indexes
80935     * collection of a database and look for the name field.
80936     *
80937     * @param string|array $keys Field or fields from which to delete the
80938     *   index.
80939     * @return array
80940     * @since PECL mongo >=0.9.0
80941     **/
80942    function deleteIndex($keys){}
80943
80944    /**
80945     * @return array
80946     * @since PECL mongo >=0.9.0
80947     **/
80948    function deleteIndexes(){}
80949
80950    /**
80951     * Drops this collection and deletes its indices.
80952     *
80953     * @return array
80954     * @since PECL mongo >=0.9.0
80955     **/
80956    function drop(){}
80957
80958    /**
80959     * A unique index cannot be created on a field if multiple existing
80960     * documents do not contain the field. The field is effectively for these
80961     * documents and thus already non-unique.
80962     *
80963     * @param array $keys Field or fields to use as index.
80964     * @param array $options This parameter is an associative array of the
80965     *   form array("optionname" => <boolean>, ...). Currently supported
80966     *   options are: "unique" Create a unique index. "dropDups" If a unique
80967     *   index is being created and duplicate values exist, drop all but one
80968     *   duplicate value. "background" If you are using MongoDB version
80969     *   1.3.2+, you can create indexes in the background while other
80970     *   operations are taking place. By default, index creation happens
80971     *   synchronously. If you specify with this option, index creation will
80972     *   be asynchronous. "safe" Starting with driver version 1.0.4, you can
80973     *   specify a boolean value for checking if the index creation
80974     *   succeeded. The driver will throw a MongoCursorException if index
80975     *   creation failed. "name" After driver version 1.0.4 (NOT including
80976     *   1.0.4) you can specify an index name. This can be useful if you are
80977     *   indexing many keys and Mongo complains about the index name being
80978     *   too long.
80979     * @return boolean
80980     * @since PECL mongo >=0.9.0
80981     **/
80982    function ensureIndex($keys, $options){}
80983
80984    /**
80985     * @param array $query The fields for which to search.
80986     * @param array $fields Fields of the results to return.
80987     * @return MongoCursor
80988     * @since PECL mongo >=0.9.0
80989     **/
80990    function find($query, $fields){}
80991
80992    /**
80993     * @param array $query The fields for which to search.
80994     * @param array $fields Fields of the results to return.
80995     * @return array
80996     * @since PECL mongo >=0.9.0
80997     **/
80998    function findOne($query, $fields){}
80999
81000    /**
81001     * @param array $ref A database reference.
81002     * @return array
81003     * @since PECL mongo >=0.9.0
81004     **/
81005    function getDBRef($ref){}
81006
81007    /**
81008     * @return array
81009     * @since PECL mongo >=0.9.0
81010     **/
81011    function getIndexInfo(){}
81012
81013    /**
81014     * @return string
81015     * @since PECL mongo >=0.9.0
81016     **/
81017    function getName(){}
81018
81019    /**
81020     * @param mixed $keys Fields to group by. If an array or non-code
81021     *   object is passed, it will be the key used to group results. 1.0.4+:
81022     *   If {@link keys} is an instance of MongoCode, {@link keys} will be
81023     *   treated as a function that returns the key to group by (see the
81024     *   "Passing a {@link keys} function" example below).
81025     * @param array $initial Initial value of the aggregation counter
81026     *   object.
81027     * @param MongoCode $reduce A function that takes two arguments (the
81028     *   current document and the aggregation to this point) and does the
81029     *   aggregation.
81030     * @param array $condition Optional parameters to the group command.
81031     *   Valid options include:
81032     * @return array
81033     * @since PECL mongo >=0.9.2
81034     **/
81035    function group($keys, $initial, $reduce, $condition){}
81036
81037    /**
81038     * All strings sent to the database must be UTF-8. If a string is not
81039     * UTF-8, a MongoException will be thrown. To insert (or query for) a
81040     * non-UTF-8 string, use MongoBinData.
81041     *
81042     * @param array $a An array.
81043     * @param array $options Options for the insert. "safe" Check that the
81044     *   insert succeeded.
81045     * @return mixed
81046     * @since PECL mongo >=0.9.0
81047     **/
81048    function insert($a, $options){}
81049
81050    /**
81051     * @param array $criteria Description of records to remove.
81052     * @param array $options Options for remove. "justOne" Remove at most
81053     *   one record matching this criteria. "safe" Check that the remove
81054     *   succeeded and how many items were removed.
81055     * @return mixed
81056     * @since PECL mongo >=0.9.0
81057     **/
81058    function remove($criteria, $options){}
81059
81060    /**
81061     * If the object is from the database, update the existing database
81062     * object, otherwise insert this object.
81063     *
81064     * @param array $a Array to save.
81065     * @param array $options Options for the save. "safe" Check that the
81066     *   save succeeded.
81067     * @return mixed
81068     * @since PECL mongo >=0.9.0
81069     **/
81070    function save($a, $options){}
81071
81072    /**
81073     * @param array $criteria Description of the objects to update.
81074     * @param array $newobj The object with which to update the matching
81075     *   records.
81076     * @param array $options This parameter is an associative array of the
81077     *   form array("optionname" => <boolean>, ...). Currently supported
81078     *   options are: "upsert" If no document matches $criteria, a new
81079     *   document will be created from $criteria and $newobj (see upsert
81080     *   example below). "multiple" All documents matching $criteria will be
81081     *   updated. {@link MongoCollection::update} has exactly the opposite
81082     *   behavior of {@link MongoCollection::remove}: it updates one document
81083     *   by default, not all matching documents. It is recommended that you
81084     *   always specify whether you want to update multiple documents or a
81085     *   single document, as the database may change its default behavior at
81086     *   some point in the future. "safe" Check that the update succeeded.
81087     * @return boolean
81088     * @since PECL mongo >=0.9.0
81089     **/
81090    function update($criteria, $newobj, $options){}
81091
81092    /**
81093     * @param bool $scan_data Only validate indices, not the base
81094     *   collection.
81095     * @return array
81096     * @since PECL mongo >=0.9.0
81097     **/
81098    function validate($scan_data){}
81099
81100    /**
81101     * @param MongoDB $db Parent database.
81102     * @param string $name Name for this collection.
81103     * @since PECL mongo >=0.9.0
81104     **/
81105    function __construct($db, $name){}
81106
81107    /**
81108     * A concise syntax for getting a collection with a dot-separated name.
81109     * If a collection name contains strange characters, you may have to use
81110     * {@link MongoDB::selectCollection} instead.
81111     *
81112     * <?php
81113     *
81114     * $mongo = new Mongo();
81115     *
81116     * // the following two lines are equivalent $collection =
81117     * $mongo->selectDB("foo")->selectCollection("bar.baz"); $collection =
81118     * $mongo->foo->bar->baz;
81119     *
81120     * ?>
81121     *
81122     * @param string $name The next string in the collection name.
81123     * @return MongoCollection
81124     * @since PECL mongo >=1.0.2
81125     **/
81126    function __get($name){}
81127
81128    /**
81129     * @return string
81130     * @since PECL mongo >=0.9.0
81131     **/
81132    function __toString(){}
81133
81134}
81135class MongoCursor extends MongoCursor {
81136    /**
81137     * This is an advanced function and should not be used unless you know
81138     * what you're doing.
81139     *
81140     * A query can optionally be nested in a "query" field if other options,
81141     * such as a sort or hint, are given. For instance, adding a sort causes
81142     * the query to become a subfield of a bigger query object, like:
81143     *
81144     * <?php
81145     *
81146     * $query = array("query" => $query, "orderby" => $sort);
81147     *
81148     * ?>
81149     *
81150     * This method is for adding a top-level field to a query. It makes the
81151     * query a subobject (if it isn't already) and adds the key/value pair of
81152     * your chosing to the top level.
81153     *
81154     * @param string $key Fieldname to add.
81155     * @param mixed $value Value to add.
81156     * @return MongoCursor
81157     * @since PECL mongo >=1.0.4
81158     **/
81159    function addOption($key, $value){}
81160
81161    /**
81162     * @param boolean $all Send cursor limit and skip information to the
81163     *   count function, if applicable.
81164     * @return int
81165     * @since PECL mongo >=0.9.2
81166     **/
81167    function count($all){}
81168
81169    /**
81170     * This returns until {@link MongoCursor::next} is called.
81171     *
81172     * @return array
81173     * @since PECL mongo >=0.9.0
81174     **/
81175    function current(){}
81176
81177    /**
81178     * The database sends responses in batches of documents, up to 4Mb of
81179     * documents per response. This method checks if the database has more
81180     * batches or if the result set has been exhausted.
81181     *
81182     * A cursor being "dead" does not mean that {@link MongoCursor::hasNext}
81183     * will return , it only means that the database is done sending results
81184     * to the client. The client should continue iterating through results
81185     * until {@link MongoCursor::hasNext} is .
81186     *
81187     * @return boolean
81188     * @since PECL mongo >=0.9.6
81189     **/
81190    function dead(){}
81191
81192    /**
81193     * @return void
81194     **/
81195    function doQuery(){}
81196
81197    /**
81198     * @return array
81199     * @since PECL mongo >=0.9.2
81200     **/
81201    function explain(){}
81202
81203    /**
81204     * Fields are specified by "fieldname" : bool. indicates that a field
81205     * should be returned, indicates that it should not be returned. You can
81206     * also use 1 and 0 instead of and .
81207     *
81208     * Thus, to return only the "summary" field, one could say:
81209     *
81210     * To return all fields except the "hidden" field:
81211     *
81212     * @param array $f Fields to return (or not return).
81213     * @return MongoCursor
81214     * @since PECL mongo >=1.0.6
81215     **/
81216    function fields($f){}
81217
81218    /**
81219     * This is identical to the function:
81220     *
81221     * @return array
81222     * @since PECL mongo >=0.9.0
81223     **/
81224    function getNext(){}
81225
81226    /**
81227     * @return boolean
81228     * @since PECL mongo >=0.9.0
81229     **/
81230    function hasNext(){}
81231
81232    /**
81233     * @param array $key_pattern Indexes to use for the query.
81234     * @return MongoCursor
81235     * @since PECL mongo >=0.9.0
81236     **/
81237    function hint($key_pattern){}
81238
81239    /**
81240     * After remaining idle for some amount of time, cursor, by default,
81241     * "die." This is generally the behavior one wants. The database cleans
81242     * up a cursor once all of its results have been sent to the client, but
81243     * if the client doesn't request all of the results, the cursor will
81244     * languish there, taking up resources. Thus, after a few minutes, the
81245     * cursor "times out" and the database assumes the client has gotten
81246     * everything it needs and cleans up its the cursor's resources.
81247     *
81248     * If, for some reason, you need a cursor to hang around for a long time,
81249     * you can prevent the database from cleaning it up by using this method.
81250     * However, if you make a cursor immortal, you need to iterate through
81251     * all of its results (or at least until {@link Cursor::dead} returns )
81252     * or the cursor will hang around the database forever, taking up
81253     * resources.
81254     *
81255     * @param boolean $liveForever If the cursor should be immortal.
81256     * @return MongoCursor
81257     * @since PECL mongo >=1.0.1
81258     **/
81259    function immortal($liveForever){}
81260
81261    /**
81262     * This can be called before or after the query.
81263     *
81264     * @return array
81265     * @since PECL mongo >=1.0.5
81266     **/
81267    function info(){}
81268
81269    /**
81270     * @return string
81271     * @since PECL mongo >=0.9.0
81272     **/
81273    function key(){}
81274
81275    /**
81276     * @param int $num The number of results to return.
81277     * @return MongoCursor
81278     * @since PECL mongo >=0.9.0
81279     **/
81280    function limit($num){}
81281
81282    /**
81283     * @return void
81284     * @since PECL mongo >=0.9.0
81285     **/
81286    function next(){}
81287
81288    /**
81289     * @return void
81290     * @since PECL mongo >=0.9.0
81291     **/
81292    function reset(){}
81293
81294    /**
81295     * This is identical to the function:
81296     *
81297     * @return void
81298     * @since PECL mongo >=0.9.0
81299     **/
81300    function rewind(){}
81301
81302    /**
81303     * @param int $num The number of results to skip.
81304     * @return MongoCursor
81305     * @since PECL mongo >=0.9.0
81306     **/
81307    function skip($num){}
81308
81309    /**
81310     * This method will override the static class variable slaveOkay.
81311     *
81312     * @param boolean $okay If it is okay to query the slave.
81313     * @return MongoCursor
81314     * @since PECL mongo >=0.9.4
81315     **/
81316    function slaveOkay($okay){}
81317
81318    /**
81319     * Use snapshot mode for the query. Snapshot mode assures no duplicates
81320     * are returned, or objects missed, which were present at both the start
81321     * and end of the query's execution (if an object is new during the
81322     * query, or deleted during the query, it may or may not be returned,
81323     * even with snapshot mode).
81324     *
81325     * Note that short query responses (less than 1MB) are always effectively
81326     * snapshotted.
81327     *
81328     * Currently, snapshot mode may not be used with sorting or explicit
81329     * hints.
81330     *
81331     * @return MongoCursor
81332     * @since PECL mongo >=0.9.4
81333     **/
81334    function snapshot(){}
81335
81336    /**
81337     * @param array $fields The fields by which to sort.
81338     * @return MongoCursor
81339     * @since PECL mongo >=0.9.0
81340     **/
81341    function sort($fields){}
81342
81343    /**
81344     * Mongo has a feature known as tailable cursors which are similar to the
81345     * Unix "tail -f" command.
81346     *
81347     * Tailable means cursor is not closed when the last data is retrieved.
81348     * Rather, the cursor marks the final object's position. you can resume
81349     * using the cursor later, from where it was located, if more data were
81350     * received.
81351     *
81352     * Like any "latent cursor", the cursor may become invalid at some point
81353     * -- for example if that final object it references were deleted. Thus,
81354     * you should be prepared to requery if the cursor is {@link
81355     * MongoCursor::dead}.
81356     *
81357     * @param boolean $tail If the cursor should be tailable.
81358     * @return MongoCursor
81359     * @since PECL mongo >=0.9.4
81360     **/
81361    function tailable($tail){}
81362
81363    /**
81364     * A timeout can be set at any time and will affect subsequent queries on
81365     * the cursor, including fetching more results from the database. For
81366     * example, to wait forever for an initial response but timeout after 100
81367     * ms for subsequent results, one could say:
81368     *
81369     * <?php
81370     *
81371     * $cursor = $collection->find();
81372     *
81373     * // $cursor->hasNext() executes the query. No timeout has been set, so
81374     * the // program will wait as long as necessary for a response.
81375     *
81376     * while ($cursor->hasNext()) { $cursor->timeout(100);
81377     *
81378     * // now the timeout has been set, so if the cursor needs to get more
81379     * results // from the database, it will only wait 100 ms for the
81380     * database's reply
81381     *
81382     * try { print_r($cursor->getNext()); } catch(MongoCursorTimeoutException
81383     * $e) { echo "query took too long!"; } }
81384     *
81385     * ?>
81386     *
81387     * A timeout of 0 (or a negative number) will wait forever so it can be
81388     * used to reset the cursor if a timeout is no longer needed.
81389     *
81390     * @param int $ms The number of milliseconds for the cursor to wait for
81391     *   a response. By default, the cursor will wait forever.
81392     * @return MongoCursor
81393     * @since PECL mongo >=1.0.3
81394     **/
81395    function timeout($ms){}
81396
81397    /**
81398     * @return boolean
81399     * @since PECL mongo >=0.9.0
81400     **/
81401    function valid(){}
81402
81403    /**
81404     * @param resource $connection Database connection.
81405     * @param string $ns Full name of database and collection.
81406     * @param array $query Database query.
81407     * @param array $fields Fields to return.
81408     * @since PECL mongo >=0.9.0
81409     **/
81410    function __construct($connection, $ns, $query, $fields){}
81411
81412}
81413class MongoCursorException extends MongoCursorException {
81414}
81415/**
81416 * Represent date objects for the database. This class should be used to
81417 * save dates to the database and to query for dates. For example:
81418 **/
81419class MongoDate {
81420    /**
81421     * Creates a new date. If no parameters are given, the current time is
81422     * used.
81423     *
81424     * @param long $sec Number of seconds since January 1st, 1970.
81425     * @param long $usec Microseconds.
81426     * @since PECL mongo >= 0.8.1
81427     **/
81428    function __construct($sec, $usec){}
81429
81430    /**
81431     * Returns a string representation of this date, similar to the
81432     * representation returned by {@link microtime()}.
81433     *
81434     * @return string
81435     * @since PECL mongo >= 0.8.1
81436     **/
81437    function __toString(){}
81438
81439}
81440/**
81441 * Instances of this class are used to interact with a database. To get a
81442 * database: Database names can use almost any character in the ASCII
81443 * range. However, they cannot contain , . or be the empty string.
81444 *
81445 * A few unusual, but valid, database names: null, [x,y], 3, \, /.
81446 *
81447 * Unlike collection names, database names may contain $.
81448 **/
81449class MongoDB {
81450    /**
81451     * This method causes its connection to be authenticated. If
81452     * authentication is enabled for the database server (it's not, by
81453     * default), you need to log in before the database will allow you to do
81454     * anything.
81455     *
81456     * This method is identical to running:
81457     *
81458     * <?php
81459     *
81460     * $salted = "${username}:mongo:${password}"; $hash = md5($salted);
81461     *
81462     * $nonce = $db->command(array("getnonce" => 1));
81463     *
81464     * $saltedHash = md5($nonce["nonce"]."${username}${hash}");
81465     *
81466     * $result = $db->command(array("authenticate" => 1, "user" => $username,
81467     * "nonce" => $nonce["nonce"], "key" => $saltedHash);
81468     *
81469     * ?>
81470     *
81471     * Once a connection has been authenticated, it can only be
81472     * un-authenticated by using the "logout" database command:
81473     *
81474     * <?php
81475     *
81476     * $db->command(array("logout" => 1));
81477     *
81478     * ?>
81479     *
81480     * @param string $username The username.
81481     * @param string $password The password (in plaintext).
81482     * @return array
81483     * @since PECL mongo >=1.0.1
81484     **/
81485    function authenticate($username, $password){}
81486
81487    /**
81488     * Almost everything that is not a CRUD operation can be done with a
81489     * database command. Need to know the database version? There's a command
81490     * for that. Need to do aggregation? There's a command for that. Need to
81491     * turn up logging? You get the idea.
81492     *
81493     * This method is identical to the function:
81494     *
81495     * <?php
81496     *
81497     * public function command($data) { return
81498     * $this->selectCollection('$cmd')->findOne($data); }
81499     *
81500     * ?>
81501     *
81502     * @param array $data The query to send.
81503     * @return array
81504     * @since PECL mongo >=0.9.2
81505     **/
81506    function command($data){}
81507
81508    /**
81509     * This method is used to create capped collections and other collections
81510     * requiring special options. It is identical to running:
81511     *
81512     * <?php
81513     *
81514     * $collection = $db->command(array("create" => $name, "size" => $size,
81515     * "capped" => $capped, "max" => $max));
81516     *
81517     * ?>
81518     *
81519     * See {@link MongoDB::command} for more information about database
81520     * commands.
81521     *
81522     * @param string $name The name of the collection.
81523     * @param bool $capped If the collection should be a fixed size.
81524     * @param int $size If the collection is fixed size, its size in bytes.
81525     * @param int $max If the collection is fixed size, the maximum number
81526     *   of elements to store in the collection.
81527     * @return MongoCollection
81528     * @since PECL mongo >=0.9.0
81529     **/
81530    function createCollection($name, $capped, $size, $max){}
81531
81532    /**
81533     * This method is a flexible interface for creating database refrences
81534     * (see MongoDBRef).
81535     *
81536     * @param string $collection The collection to which the database
81537     *   reference will point.
81538     * @param mixed $a Object or _id to which to create a reference. If an
81539     *   object or associative array is given, this will create a reference
81540     *   using the _id field.
81541     * @return array
81542     * @since PECL mongo >=0.9.0
81543     **/
81544    function createDBRef($collection, $a){}
81545
81546    /**
81547     * @return array
81548     * @since PECL mongo >=0.9.0
81549     **/
81550    function drop(){}
81551
81552    /**
81553     * @param mixed $coll MongoCollection or name of collection to drop.
81554     * @return array
81555     * @since PECL mongo >=0.9.0
81556     **/
81557    function dropCollection($coll){}
81558
81559    /**
81560     * The Mongo database server runs a JavaScript engine. This method allows
81561     * you to run arbitary JavaScript on the database. This can be useful if
81562     * you want touch a number of collections lightly, or process some
81563     * results on the database side to reduce the amount that has to be sent
81564     * to the client.
81565     *
81566     * @param mixed $code MongoCode or string to execute.
81567     * @param array $args Arguments to be passed to code.
81568     * @return array
81569     * @since PECL mongo >=0.9.3
81570     **/
81571    function execute($code, $args){}
81572
81573    /**
81574     * @return bool
81575     * @since PECL mongo >=0.9.5
81576     **/
81577    function forceError(){}
81578
81579    /**
81580     * @param array $ref A database reference.
81581     * @return array
81582     * @since PECL mongo >=0.9.0
81583     **/
81584    function getDBRef($ref){}
81585
81586    /**
81587     * @param string $prefix The prefix for the files and chunks
81588     *   collections.
81589     * @return MongoGridFS
81590     * @since PECL mongo >=0.9.0
81591     **/
81592    function getGridFS($prefix){}
81593
81594    /**
81595     * @return int
81596     * @since PECL mongo >=0.9.0
81597     **/
81598    function getProfilingLevel(){}
81599
81600    /**
81601     * @return array
81602     * @since PECL mongo >=0.9.5
81603     **/
81604    function lastError(){}
81605
81606    /**
81607     * @return array
81608     * @since PECL mongo >=0.9.0
81609     **/
81610    function listCollections(){}
81611
81612    /**
81613     * @return array
81614     * @since PECL mongo >=0.9.5
81615     **/
81616    function prevError(){}
81617
81618    /**
81619     * @param bool $preserve_cloned_files If cloned files should be kept if
81620     *   the repair fails.
81621     * @param bool $backup_original_files If original files should be
81622     *   backed up.
81623     * @return array
81624     * @since PECL mongo >=0.9.0
81625     **/
81626    function repair($preserve_cloned_files, $backup_original_files){}
81627
81628    /**
81629     * @return array
81630     * @since PECL mongo >=0.9.5
81631     **/
81632    function resetError(){}
81633
81634    /**
81635     * @param string $name The name of the collection.
81636     * @return MongoCollection
81637     * @since PECL mongo >=0.9.0
81638     **/
81639    function selectCollection($name){}
81640
81641    /**
81642     * @param int $level Profiling level.
81643     * @return int
81644     * @since PECL mongo >=0.9.0
81645     **/
81646    function setProfilingLevel($level){}
81647
81648    /**
81649     * This method is not meant to be called directly. The preferred way to
81650     * create an instance of MongoDB is through {@link Mongo::__get} or
81651     * {@link Mongo::selectDB}.
81652     *
81653     * If you're ignoring the previous paragraph and want to call it directly
81654     * you can do so:
81655     *
81656     * But don't. Isn't this much nicer:
81657     *
81658     * @param Mongo $conn Database connection.
81659     * @param string $name Database name.
81660     * @since PECL mongo >=0.9.0
81661     **/
81662    function __construct($conn, $name){}
81663
81664    /**
81665     * This is the easiest way of getting a collection from a database
81666     * object. If a collection name contains strange characters, you may have
81667     * to use {@link MongoDB::selectCollection} instead.
81668     *
81669     * <?php
81670     *
81671     * $mongo = new Mongo();
81672     *
81673     * // the following two lines are equivalent $collection =
81674     * $mongo->selectDB("foo")->selectCollection("bar"); $collection =
81675     * $mongo->foo->bar;
81676     *
81677     * ?>
81678     *
81679     * @param string $name The name of the collection.
81680     * @return MongoCollection
81681     * @since PECL mongo >=1.0.2
81682     **/
81683    function __get($name){}
81684
81685    /**
81686     * @return string
81687     * @since PECL mongo >=0.9.0
81688     **/
81689    function __toString(){}
81690
81691}
81692/**
81693 * This class can be used to create lightweight links between objects in
81694 * different collections.
81695 *
81696 * : Suppose we need to refer to a document in another collection. The
81697 * easiest way is to create a field in the current document. For example,
81698 * if we had a "people" collection and an "addresses" collection, we
81699 * might want to create a link between each person document and and
81700 * address document:
81701 *
81702 * Then, later on, we can find the person's address by querying the
81703 * "addresses" collection with the we saved in the "people" collection.
81704 *
81705 * Suppose now that we have a more general case, where we don't know
81706 * which collection (or even which database) contains the referenced
81707 * document. is a good choice for this case, as it is a common format
81708 * that all of the drivers and the database understand.
81709 *
81710 * If each person had a list of things they liked which could come from
81711 * multiple collections, such as "hobbies", "sports", "books", etc., we
81712 * could use s to keep track of what "like" went with what collection:
81713 *
81714 * Database references can be thought of as hyperlinks: they give the
81715 * unique address of another document, but they do not load it or
81716 * automatically follow the link/reference.
81717 *
81718 * A database reference is just a normal associative array, not an
81719 * instance of , so this class is a little different than the other data
81720 * type classes. This class contains exclusively static methods for
81721 * manipulating database references.
81722 **/
81723class MongoDBRef {
81724    /**
81725     * If no database is given, the current database is used.
81726     *
81727     * @param string $collection Collection name.
81728     * @param mixed $id The _id field of the object to which to link.
81729     * @param string $database Database name.
81730     * @return array
81731     * @since PECL mongo >= 0.9.0
81732     **/
81733    function create($collection, $id, $database){}
81734
81735    /**
81736     * @param MongoDB $db Database to use.
81737     * @param array $ref Reference to fetch.
81738     * @return array
81739     * @since PECL mongo >= 0.9.0
81740     **/
81741    function get($db, $ref){}
81742
81743    /**
81744     * This not actually follow the reference, so it does not determine if it
81745     * is broken or not. It merely checks that {@link ref} is in valid
81746     * database reference format (in that it is an object or array with $ref
81747     * and $id fields).
81748     *
81749     * @param mixed $ref Array or object to check.
81750     * @return boolean
81751     * @since PECL mongo >= 0.9.0
81752     **/
81753    function isRef($ref){}
81754
81755}
81756class MongoException extends MongoException {
81757}
81758class MongoGridFS {
81759    /**
81760     * @param mixed $id _id of the file to remove.
81761     * @return boolean
81762     * @since PECL mongo >=1.0.8
81763     **/
81764    function delete($id){}
81765
81766    /**
81767     * @return array
81768     * @since PECL mongo >=0.9.0
81769     **/
81770    function drop(){}
81771
81772    /**
81773     * @param array $query The query.
81774     * @param array $fields Fields to return.
81775     * @return MongoGridFSCursor
81776     * @since PECL mongo >=0.9.0
81777     **/
81778    function find($query, $fields){}
81779
81780    /**
81781     * @param mixed $query The filename or criteria for which to search.
81782     * @return MongoGridFSFile
81783     * @since PECL mongo >=0.9.0
81784     **/
81785    function findOne($query){}
81786
81787    /**
81788     * @param mixed $id _id of the file to find.
81789     * @return MongoGridFSFile
81790     * @since PECL mongo >=1.0.8
81791     **/
81792    function get($id){}
81793
81794    /**
81795     * @param string $filename The name of the file.
81796     * @param array $extra Other metadata to add to the file saved.
81797     * @return mixed
81798     * @since PECL mongo >=1.0.8
81799     **/
81800    function put($filename, $extra){}
81801
81802    /**
81803     * @param array $criteria The filename or criteria for which to search.
81804     * @return boolean
81805     * @since PECL mongo >=0.9.0
81806     **/
81807    function remove($criteria){}
81808
81809    /**
81810     * @param string $bytes A string of bytes to store.
81811     * @param array $extra Other metadata to add to the file saved.
81812     * @param array $options Options for the store. "safe" Check that this
81813     *   store succeeded.
81814     * @return mixed
81815     * @since PECL mongo >=0.9.2
81816     **/
81817    function storeBytes($bytes, $extra, $options){}
81818
81819    /**
81820     * @param string $filename The name of the file.
81821     * @param array $extra Other metadata to add to the file saved.
81822     * @param array $options Options for the store. "safe" Check that this
81823     *   store succeeded.
81824     * @return mixed
81825     * @since PECL mongo >=0.9.0
81826     **/
81827    function storeFile($filename, $extra, $options){}
81828
81829    /**
81830     * @param string $name The name field of the uploaded file.
81831     * @param string $filename String to be used as filename field in the
81832     *   database.
81833     * @return mixed
81834     * @since PECL mongo >=0.9.0
81835     **/
81836    function storeUpload($name, $filename){}
81837
81838    /**
81839     * Files as stored across two collections, the first containing file meta
81840     * information, the second containing chunks of the actual file. By
81841     * default, fs.files and fs.chunks are the collection names used.
81842     *
81843     * Use one argument to specify a prefix other than "fs":
81844     *
81845     * $fs = new MongoGridFS($db, "myfiles");
81846     *
81847     * uses myfiles.files and myfiles.chunks collections.
81848     *
81849     * @param MongoDB $db Database.
81850     * @param string $prefix Optional collection name prefix.
81851     * @since PECL mongo >=0.9.0
81852     **/
81853    function __construct($db, $prefix){}
81854
81855}
81856class MongoGridFSCursor {
81857    /**
81858     * @return MongoGridFSFile
81859     * @since PECL mongo >=0.9.0
81860     **/
81861    function current(){}
81862
81863    /**
81864     * @return MongoGridFSFile
81865     * @since PECL mongo >=0.9.0
81866     **/
81867    function getNext(){}
81868
81869    /**
81870     * @return string
81871     * @since PECL mongo >=0.9.0
81872     **/
81873    function key(){}
81874
81875    /**
81876     * @param MongoGridFS $gridfs Related GridFS collection.
81877     * @param resource $connection Database connection.
81878     * @param string $ns Full name of database and collection.
81879     * @param array $query Database query.
81880     * @param array $fields Fields to return.
81881     * @since PECL mongo >=0.9.0
81882     **/
81883    function __construct($gridfs, $connection, $ns, $query, $fields){}
81884
81885}
81886/**
81887 * A database file object.
81888 **/
81889class MongoGridFSFile {
81890    /**
81891     * Warning: this will load the file into memory. If the file is bigger
81892     * than your memory, this will cause problems!
81893     *
81894     * @return string
81895     * @since PECL mongo >=0.9.0
81896     **/
81897    function getBytes(){}
81898
81899    /**
81900     * @return string
81901     * @since PECL mongo >=0.9.0
81902     **/
81903    function getFilename(){}
81904
81905    /**
81906     * @return int
81907     * @since PECL mongo >=0.9.0
81908     **/
81909    function getSize(){}
81910
81911    /**
81912     * @param string $filename The location to which to write the file. If
81913     *   none is given, the stored filename will be used.
81914     * @return int
81915     * @since PECL mongo >=0.9.0
81916     **/
81917    function write($filename){}
81918
81919    /**
81920     * @param MongoGridFS $gridfs The parent MongoGridFS instance.
81921     * @param array $file A file from the database.
81922     * @since PECL mongo >=0.9.0
81923     **/
81924    function __construct($gridfs, $file){}
81925
81926}
81927/**
81928 * A unique identifier created for database objects. If an object is
81929 * inserted into the database without an _id field, an _id field will be
81930 * added to it with a instance as its value. If the data has a naturally
81931 * occuring unique field (say, a username or timestamp) it is fine to use
81932 * this as the _id field instead, and it will not be replaced with a .
81933 *
81934 * Instances of the class fulfill the role that autoincrementing does in
81935 * a relational database: to provide a unique key if the data does not
81936 * natually have one. Autoincrementing does not work well with a sharded
81937 * database, as it is impossible to find what the next number should be
81938 * quickly. This class fulfills the constraints of quickly generating a
81939 * value that is unique across shards.
81940 *
81941 * Each MongoId is 12 bytes (making its string form 24 hexidecimal
81942 * characters). The first four bytes are a timestamp, the next three are
81943 * a hash of the client machine's hostname, the next two are the two
81944 * least significant bytes of the process id running the script, and the
81945 * last three bytes are an incrementing value.
81946 *
81947 * s are serializable/unserializable. Their serialized form is similar to
81948 * their string form:
81949 **/
81950class MongoId {
81951    /**
81952     * This returns the hostname MongoId is using to generate unique ids.
81953     * This should be the same value {@link gethostname} returns.
81954     *
81955     * It is identical to the function:
81956     *
81957     * @return string
81958     * @since PECL mongo >= 1.0.8
81959     **/
81960    function getHostname(){}
81961
81962    /**
81963     * This returns the same thing as running {@link time()} when the id is
81964     * created.
81965     *
81966     * @return int
81967     * @since PECL mongo >= 1.0.1
81968     **/
81969    function getTimestamp(){}
81970
81971    /**
81972     * @param string $id A string to use as the id. Must be 24 hexidecimal
81973     *   characters. If an invalid string is passed to this constructor, the
81974     *   constructor will ignore it and create a new id value.
81975     * @since PECL mongo >= 0.8.0
81976     **/
81977    function __construct($id){}
81978
81979    /**
81980     * This function is only used by PHP internally, it shouldn't need to
81981     * ever be called by the user.
81982     *
81983     * It is identical to the function:
81984     *
81985     * @param array $props Theoretically, an array of properties used to
81986     *   create the new id. However, as MongoId instances have no properties,
81987     *   this is not used.
81988     * @return MongoId
81989     * @since PECL mongo >= 1.0.8
81990     **/
81991    function __set_state($props){}
81992
81993    /**
81994     * @return string
81995     * @since PECL mongo >= 0.8.0
81996     **/
81997    function __toString(){}
81998
81999}
82000/**
82001 * is a special type used by the database that evaluates to greater than
82002 * any other type. Thus, if a query is sorted by a given field in
82003 * ascending order, any document with a as its value will be returned
82004 * last.
82005 *
82006 * has no associated fields, methods, or constants. It is merely the
82007 * "largest" thing that can be inserted into the database.
82008 *
82009 * The cursor will contain the staff meeting document, then the dishes
82010 * document. The dishes document will always be returned last, regardless
82011 * of what else is added to the collection (unless other documents are
82012 * added with in the "do by" field).
82013 **/
82014class MongoMaxKey {
82015}
82016/**
82017 * is a special type used by the database that evaluates to less than any
82018 * other type. Thus, if a query is sorted by a given field in ascending
82019 * order, any document with a as its value will be returned first.
82020 *
82021 * has no associated fields, methods, or constants. It is merely the
82022 * "smallest" thing that can be inserted into the database.
82023 *
82024 * The cursor will contain the lunch document, then the staff meeting
82025 * document. The lunch document will always be returned first, regardless
82026 * of what else is added to the collection (unless other documents are
82027 * added with in the "do by" field).
82028 **/
82029class MongoMinKey {
82030}
82031/**
82032 * This class can be used to create regular expressions. Typically, these
82033 * expressions will be used to query the database and find matching
82034 * strings. More unusually, they can be saved to the database and
82035 * retrieved.
82036 *
82037 * Mongo recognizes six regular expression flags:
82038 **/
82039class MongoRegex {
82040    /**
82041     * Creates a new regular expression.
82042     *
82043     * @param string $regex Regular expression string of the form
82044     *   /expr/flags.
82045     * @since PECL mongo >= 0.8.1
82046     **/
82047    function __construct($regex){}
82048
82049    /**
82050     * Returns a string representation of this regular expression.
82051     *
82052     * @return string
82053     * @since PECL mongo >= 0.8.1
82054     **/
82055    function __toString(){}
82056
82057}
82058/**
82059 * is used by sharding. If you're not looking to write sharding tools,
82060 * what you probably want is .
82061 *
82062 * is 4 bytes of timestamp (seconds since the epoch) and 4 bytes of
82063 * increment.
82064 *
82065 * Unless you are writing something that interacts with the sharding
82066 * internals, stop, go directly to , do not pass go, do not collect 200
82067 * dollars. This is not the class you are looking for.
82068 *
82069 * If you are writing sharding tools, read on.
82070 **/
82071class MongoTimestamp {
82072    /**
82073     * Creates a new timestamp. If no parameters are given, the current time
82074     * is used and the increment is automatically provided. The increment is
82075     * set to 0 when the module is loaded and is incremented every time this
82076     * constructor is called (without the $inc parameter passed in).
82077     *
82078     * @param long $sec Number of seconds since January 1st, 1970.
82079     * @param long $inc Increment.
82080     * @since PECL mongo >= 1.0.1
82081     **/
82082    function __construct($sec, $inc){}
82083
82084    /**
82085     * Returns the "sec" field of this timestamp.
82086     *
82087     * @return string
82088     * @since PECL mongo >= 1.0.1
82089     **/
82090    function __toString(){}
82091
82092}
82093/**
82094 * An Iterator that iterates over several iterators one after the other.
82095 **/
82096class MultipleIterator implements Iterator, Traversable {
82097    /**
82098     * Attaches iterator information.
82099     *
82100     * @param Iterator $iterator The new iterator to attach.
82101     * @param string $infos The associative information for the Iterator,
82102     *   which must be an integer, a string, or .
82103     * @return void
82104     * @since PHP 5 >= 5.3.0
82105     **/
82106    function attachIterator($iterator, $infos){}
82107
82108    /**
82109     * Checks if an iterator is attached or not.
82110     *
82111     * @param Iterator $iterator The iterator to check.
82112     * @return void
82113     * @since PHP 5 >= 5.3.0
82114     **/
82115    function containsIterator($iterator){}
82116
82117    /**
82118     * Gets the number of attached iterator instances.
82119     *
82120     * @return void
82121     * @since PHP 5 >= 5.3.0
82122     **/
82123    function countIterators(){}
82124
82125    /**
82126     * Get the registered iterator instances.
82127     *
82128     * @return void
82129     * @since PHP 5 >= 5.3.0
82130     **/
82131    function current(){}
82132
82133    /**
82134     * Detaches an iterator.
82135     *
82136     * @param Iterator $iterator The iterator to detach.
82137     * @return void
82138     * @since PHP 5 >= 5.3.0
82139     **/
82140    function detachIterator($iterator){}
82141
82142    /**
82143     * Gets information about the flags.
82144     *
82145     * @return void
82146     * @since PHP 5 >= 5.3.0
82147     **/
82148    function getFlags(){}
82149
82150    /**
82151     * Get the registered iterator instances.
82152     *
82153     * @return void
82154     * @since PHP 5 >= 5.3.0
82155     **/
82156    function key(){}
82157
82158    /**
82159     * Moves all attached iterator instances forward.
82160     *
82161     * @return void
82162     * @since PHP 5 >= 5.3.0
82163     **/
82164    function next(){}
82165
82166    /**
82167     * Rewinds all attached iterator instances.
82168     *
82169     * @return void
82170     * @since PHP 5 >= 5.3.0
82171     **/
82172    function rewind(){}
82173
82174    /**
82175     * Sets flags.
82176     *
82177     * @param integer $flags The flags to set, according to the Flag
82178     *   Constants
82179     * @return void
82180     * @since PHP 5 >= 5.3.0
82181     **/
82182    function setFlags($flags){}
82183
82184    /**
82185     * Checks the validity of sub iterators.
82186     *
82187     * @return void
82188     * @since PHP 5 >= 5.3.0
82189     **/
82190    function valid(){}
82191
82192    /**
82193     * Construct a new MultipleIterator.
82194     *
82195     * @param integer $flags The flags to set, according to the Flag
82196     *   Constants
82197     * @since PHP 5 >= 5.3.0
82198     **/
82199    function __construct($flags){}
82200
82201}
82202/**
82203 * Represents a connection between PHP and a MySQL database.
82204 **/
82205class MySQLi {
82206    /**
82207     * Returns the number of rows affected by the last INSERT, UPDATE,
82208     * REPLACE or DELETE query.
82209     *
82210     * For SELECT statements {@link mysqli_affected_rows} works like {@link
82211     * mysqli_num_rows}.
82212     *
82213     * @var int
82214     **/
82215    var $affected_rows;
82216    /**
82217     * Returns a string that represents the MySQL client library version.
82218     *
82219     * @var string
82220     **/
82221    var $client_info;
82222    /**
82223     * Returns client version number as an integer.
82224     *
82225     * @var int
82226     **/
82227    var $client_version;
82228    /**
82229     * Returns client version number as an integer.
82230     *
82231     * @var int
82232     **/
82233    var $client_version;
82234    /**
82235     * Returns the last error code number from the last call to {@link
82236     * mysqli_connect}.
82237     *
82238     * @var string
82239     **/
82240    var $connect_errno;
82241    /**
82242     * Returns the last error message string from the last call to {@link
82243     * mysqli_connect}.
82244     *
82245     * @var string
82246     **/
82247    var $connect_error;
82248    /**
82249     * Returns the last error code for the most recent MySQLi function call
82250     * that can succeed or fail.
82251     *
82252     * Client error message numbers are listed in the MySQL errmsg.h header
82253     * file, server error message numbers are listed in mysqld_error.h. In
82254     * the MySQL source distribution you can find a complete list of error
82255     * messages and error numbers in the file Docs/mysqld_error.txt.
82256     *
82257     * @var int
82258     **/
82259    var $errno;
82260    /**
82261     * Returns the last error message for the most recent MySQLi function
82262     * call that can succeed or fail.
82263     *
82264     * @var string
82265     **/
82266    var $error;
82267    /**
82268     * Returns a string describing the connection represented by the {@link
82269     * link} parameter (including the server host name).
82270     *
82271     * @var string
82272     **/
82273    var $host_info;
82274    /**
82275     * The {@link mysqli_info} function returns a string providing
82276     * information about the last query executed. The nature of this string
82277     * is provided below:
82278     *
82279     * Possible mysqli_info return values Query type Example result string
82280     * INSERT INTO...SELECT... Records: 100 Duplicates: 0 Warnings: 0 INSERT
82281     * INTO...VALUES (...),(...),(...) Records: 3 Duplicates: 0 Warnings: 0
82282     * LOAD DATA INFILE ... Records: 1 Deleted: 0 Skipped: 0 Warnings: 0
82283     * ALTER TABLE ... Records: 3 Duplicates: 0 Warnings: 0 UPDATE ... Rows
82284     * matched: 40 Changed: 40 Warnings: 0
82285     *
82286     * @var string
82287     **/
82288    var $info;
82289    /**
82290     * The {@link mysqli_insert_id} function returns the ID generated by a
82291     * query on a table with a column having the AUTO_INCREMENT attribute. If
82292     * the last query wasn't an INSERT or UPDATE statement or if the modified
82293     * table does not have a column with the AUTO_INCREMENT attribute, this
82294     * function will return zero.
82295     *
82296     * @var mixed
82297     **/
82298    var $insert_id;
82299    /**
82300     * Returns an integer representing the MySQL protocol version used by the
82301     * connection represented by the {@link link} parameter.
82302     *
82303     * @var string
82304     **/
82305    var $protocol_version;
82306    /**
82307     * Returns a string representing the version of the MySQL server that the
82308     * MySQLi extension is connected to.
82309     *
82310     * @var string
82311     **/
82312    var $server_info;
82313    /**
82314     * The {@link mysqli_get_server_version} function returns the version of
82315     * the server connected to (represented by the {@link link} parameter) as
82316     * an integer.
82317     *
82318     * @var int
82319     **/
82320    var $server_version;
82321    /**
82322     * Returns a string containing the SQLSTATE error code for the last
82323     * error. The error code consists of five characters. '00000' means no
82324     * error. The values are specified by ANSI SQL and ODBC. For a list of
82325     * possible values, see .
82326     *
82327     * @var string
82328     **/
82329    var $sqlstate;
82330    /**
82331     * The {@link mysqli_thread_id} function returns the thread ID for the
82332     * current connection which can then be killed using the {@link
82333     * mysqli_kill} function. If the connection is lost and you reconnect
82334     * with {@link mysqli_ping}, the thread ID will be other. Therefore you
82335     * should get the thread ID only when you need it.
82336     *
82337     * @var int
82338     **/
82339    var $thread_id;
82340    /**
82341     * Returns the number of warnings from the last query in the connection.
82342     *
82343     * @var int
82344     **/
82345    var $warning_count;
82346    /**
82347     * Turns on or off auto-commit mode on queries for the database
82348     * connection.
82349     *
82350     * To determine the current state of autocommit use the SQL command
82351     * SELECT @@autocommit.
82352     *
82353     * @param bool $mode Whether to turn on auto-commit or not.
82354     * @return bool
82355     **/
82356    function autocommit($mode){}
82357
82358    /**
82359     * Changes the user of the specified database connection and sets the
82360     * current database.
82361     *
82362     * In order to successfully change users a valid {@link username} and
82363     * {@link password} parameters must be provided and that user must have
82364     * sufficient permissions to access the desired database. If for any
82365     * reason authorization fails, the current user authentication will
82366     * remain.
82367     *
82368     * @param string $user The MySQL user name.
82369     * @param string $password The MySQL password.
82370     * @param string $database The database to change to. If desired, the
82371     *   value may be passed resulting in only changing the user and not
82372     *   selecting a database. To select a database in this case use the
82373     *   {@link mysqli_select_db} function.
82374     * @return bool
82375     **/
82376    function change_user($user, $password, $database){}
82377
82378    /**
82379     * Returns the current character set for the database connection.
82380     *
82381     * @return string
82382     **/
82383    function character_set_name(){}
82384
82385    /**
82386     * Closes a previously opened database connection.
82387     *
82388     * @return bool
82389     **/
82390    function close(){}
82391
82392    /**
82393     * Commits the current transaction for the database connection.
82394     *
82395     * @return bool
82396     **/
82397    function commit(){}
82398
82399    /**
82400     * Performs debugging operations using the Fred Fish debugging library.
82401     *
82402     * @param string $message A string representing the debugging operation
82403     *   to perform
82404     * @return bool
82405     **/
82406    function debug($message){}
82407
82408    /**
82409     * @return void
82410     **/
82411    function disable_reads_from_master(){}
82412
82413    /**
82414     * This function is designed to be executed by an user with the SUPER
82415     * privilege and is used to dump debugging information into the log for
82416     * the MySQL Server relating to the connection.
82417     *
82418     * @return bool
82419     **/
82420    function dump_debug_info(){}
82421
82422    /**
82423     * This function is used to create a legal SQL string that you can use in
82424     * an SQL statement. The given string is encoded to an escaped SQL
82425     * string, taking into account the current character set of the
82426     * connection.
82427     *
82428     * @param string $escapestr The string to be escaped. Characters
82429     *   encoded are NUL (ASCII 0), \n, \r, \, ', ", and Control-Z.
82430     * @return string
82431     **/
82432    function escape_string($escapestr){}
82433
82434    /**
82435     * Returns a character set object providing several properties of the
82436     * current active character set.
82437     *
82438     * @return object
82439     **/
82440    function get_charset(){}
82441
82442    /**
82443     * Returns a string that represents the MySQL client library version.
82444     *
82445     * @return string
82446     **/
82447    function get_client_info(){}
82448
82449    /**
82450     * Returns statistics about the client connection.
82451     *
82452     * @return bool
82453     **/
82454    function get_connection_stats(){}
82455
82456    /**
82457     * @return mysqli_warning
82458     **/
82459    function get_warnings(){}
82460
82461    /**
82462     * Allocates or initializes a MYSQL object suitable for {@link
82463     * mysqli_options} and {@link mysqli_real_connect}.
82464     *
82465     * @return mysqli
82466     **/
82467    function init(){}
82468
82469    /**
82470     * This function is used to ask the server to kill a MySQL thread
82471     * specified by the {@link processid} parameter. This value must be
82472     * retrieved by calling the {@link mysqli_thread_id} function.
82473     *
82474     * To stop a running query you should use the SQL command KILL QUERY
82475     * processid.
82476     *
82477     * @param int $processid
82478     * @return bool
82479     **/
82480    function kill($processid){}
82481
82482    /**
82483     * Indicates if one or more result sets are available from a previous
82484     * call to {@link mysqli_multi_query}.
82485     *
82486     * @return bool
82487     **/
82488    function more_results(){}
82489
82490    /**
82491     * Executes one or multiple queries which are concatenated by a
82492     * semicolon.
82493     *
82494     * To retrieve the resultset from the first query you can use {@link
82495     * mysqli_use_result} or {@link mysqli_store_result}. All subsequent
82496     * query results can be processed using {@link mysqli_more_results} and
82497     * {@link mysqli_next_result}.
82498     *
82499     * @param string $query The query, as a string. Data inside the query
82500     *   should be properly escaped.
82501     * @return bool
82502     **/
82503    function multi_query($query){}
82504
82505    /**
82506     * Prepares next result set from a previous call to {@link
82507     * mysqli_multi_query} which can be retrieved by {@link
82508     * mysqli_store_result} or {@link mysqli_use_result}.
82509     *
82510     * @return bool
82511     **/
82512    function next_result(){}
82513
82514    /**
82515     * Used to set extra connect options and affect behavior for a
82516     * connection.
82517     *
82518     * This function may be called multiple times to set several options.
82519     *
82520     * {@link mysqli_options} should be called after {@link mysqli_init} and
82521     * before {@link mysqli_real_connect}.
82522     *
82523     * @param int $option The option that you want to set. It can be one of
82524     *   the following values: Valid options Name Description
82525     *   MYSQLI_OPT_CONNECT_TIMEOUT connection timeout in seconds (supported
82526     *   on Windows with TCP/IP since PHP 5.3.1) MYSQLI_OPT_LOCAL_INFILE
82527     *   enable/disable use of LOAD LOCAL INFILE MYSQLI_INIT_COMMAND command
82528     *   to execute after when connecting to MySQL server
82529     *   MYSQLI_READ_DEFAULT_FILE Read options from named option file instead
82530     *   of my.cnf MYSQLI_READ_DEFAULT_GROUP Read options from the named
82531     *   group from my.cnf or the file specified with
82532     *   MYSQL_READ_DEFAULT_FILE.
82533     * @param mixed $value The value for the option.
82534     * @return bool
82535     **/
82536    function options($option, $value){}
82537
82538    /**
82539     * Checks whether the connection to the server is working. If it has gone
82540     * down, and global option mysqli.reconnect is enabled an automatic
82541     * reconnection is attempted.
82542     *
82543     * This function can be used by clients that remain idle for a long
82544     * while, to check whether the server has closed the connection and
82545     * reconnect if necessary.
82546     *
82547     * @return bool
82548     **/
82549    function ping(){}
82550
82551    /**
82552     * Poll connections.
82553     *
82554     * @param array $read
82555     * @param array $error
82556     * @param array $reject
82557     * @param int $sec Number of seconds to wait, must be non-negative.
82558     * @param int $usec Number of microseconds to wait, must be
82559     *   non-negative.
82560     * @return int
82561     **/
82562    function poll(&$read, &$error, &$reject, $sec, $usec){}
82563
82564    /**
82565     * Prepares the SQL query, and returns a statement handle to be used for
82566     * further operations on the statement. The query must consist of a
82567     * single SQL statement.
82568     *
82569     * The parameter markers must be bound to application variables using
82570     * {@link mysqli_stmt_bind_param} and/or {@link mysqli_stmt_bind_result}
82571     * before executing the statement or fetching rows.
82572     *
82573     * @param string $query The query, as a string. This parameter can
82574     *   include one or more parameter markers in the SQL statement by
82575     *   embedding question mark (?) characters at the appropriate positions.
82576     * @return mysqli_stmt
82577     **/
82578    function prepare($query){}
82579
82580    /**
82581     * Performs a {@link query} against the database.
82582     *
82583     * Functionally, using this function is identical to calling {@link
82584     * mysqli_real_query} followed either by {@link mysqli_use_result} or
82585     * {@link mysqli_store_result}.
82586     *
82587     * @param string $query The query string. Data inside the query should
82588     *   be properly escaped.
82589     * @param int $resultmode Either the constant MYSQLI_USE_RESULT or
82590     *   MYSQLI_STORE_RESULT depending on the desired behavior. By default,
82591     *   MYSQLI_STORE_RESULT is used. If you use MYSQLI_USE_RESULT all
82592     *   subsequent calls will return error Commands out of sync unless you
82593     *   call {@link mysqli_free_result} With MYSQLI_ASYNC (available with
82594     *   mysqlnd), it is possible to perform query asynchronously. {@link
82595     *   mysqli_poll} is then used to get results from such queries.
82596     * @return mixed
82597     **/
82598    function query($query, $resultmode){}
82599
82600    /**
82601     * Establish a connection to a MySQL database engine.
82602     *
82603     * This function differs from {@link mysqli_connect}:
82604     *
82605     * @param string $host Can be either a host name or an IP address.
82606     *   Passing the value or the string "localhost" to this parameter, the
82607     *   local host is assumed. When possible, pipes will be used instead of
82608     *   the TCP/IP protocol.
82609     * @param string $username The MySQL user name.
82610     * @param string $passwd If provided or , the MySQL server will attempt
82611     *   to authenticate the user against those user records which have no
82612     *   password only. This allows one username to be used with different
82613     *   permissions (depending on if a password as provided or not).
82614     * @param string $dbname If provided will specify the default database
82615     *   to be used when performing queries.
82616     * @param int $port Specifies the port number to attempt to connect to
82617     *   the MySQL server.
82618     * @param string $socket Specifies the socket or named pipe that should
82619     *   be used.
82620     * @param int $flags With the parameter {@link flags} you can set
82621     *   different connection options:
82622     * @return bool
82623     **/
82624    function real_connect($host, $username, $passwd, $dbname, $port, $socket, $flags){}
82625
82626    /**
82627     * This function is used to create a legal SQL string that you can use in
82628     * an SQL statement. The given string is encoded to an escaped SQL
82629     * string, taking into account the current character set of the
82630     * connection.
82631     *
82632     * @param string $escapestr The string to be escaped. Characters
82633     *   encoded are NUL (ASCII 0), \n, \r, \, ', ", and Control-Z.
82634     * @return string
82635     **/
82636    function real_escape_string($escapestr){}
82637
82638    /**
82639     * Executes a single query against the database whose result can then be
82640     * retrieved or stored using the {@link mysqli_store_result} or {@link
82641     * mysqli_use_result} functions.
82642     *
82643     * In order to determine if a given query should return a result set or
82644     * not, see {@link mysqli_field_count}.
82645     *
82646     * @param string $query The query, as a string. Data inside the query
82647     *   should be properly escaped.
82648     * @return bool
82649     **/
82650    function real_query($query){}
82651
82652    /**
82653     * Get result from async query.
82654     *
82655     * @return mysqli_result
82656     **/
82657    function reap_async_query(){}
82658
82659    /**
82660     * Rollbacks the current transaction for the database.
82661     *
82662     * @return bool
82663     **/
82664    function rollback(){}
82665
82666    /**
82667     * Returns MYSQLI_RPL_MASTER, MYSQLI_RPL_SLAVE or MYSQLI_RPL_ADMIN
82668     * depending on a query type. INSERT, UPDATE and similar are master
82669     * queries, SELECT is slave, and FLUSH, REPAIR and similar are admin.
82670     *
82671     * @param string $query
82672     * @return int
82673     **/
82674    function rpl_query_type($query){}
82675
82676    /**
82677     * Selects the default database to be used when performing queries
82678     * against the database connection.
82679     *
82680     * @param string $dbname The database name.
82681     * @return bool
82682     **/
82683    function select_db($dbname){}
82684
82685    /**
82686     * @param string $query
82687     * @return bool
82688     **/
82689    function send_query($query){}
82690
82691    /**
82692     * Sets the default character set to be used when sending data from and
82693     * to the database server.
82694     *
82695     * @param string $charset The charset to be set as default.
82696     * @return bool
82697     **/
82698    function set_charset($charset){}
82699
82700    /**
82701     * Set callback function for LOAD DATA LOCAL INFILE command
82702     *
82703     * The callbacks task is to read input from the file specified in the
82704     * LOAD DATA LOCAL INFILE and to reformat it into the format understood
82705     * by LOAD DATA INFILE.
82706     *
82707     * The returned data needs to match the format specified in the LOAD DATA
82708     *
82709     * @param mysqli $link A callback function or object method taking the
82710     *   following parameters:
82711     * @param callback $read_func A PHP stream associated with the SQL
82712     *   commands INFILE
82713     * @return bool
82714     **/
82715    function set_local_infile_handler($link, $read_func){}
82716
82717    /**
82718     * Used for establishing secure connections using SSL. It must be called
82719     * before {@link mysqli_real_connect}. This function does nothing unless
82720     * OpenSSL support is enabled.
82721     *
82722     * Note that MySQL Native Driver does not support SSL, so calling this
82723     * function when using MySQL Native Driver will result in an error. MySQL
82724     * Native Driver is enabled by default on Microsoft Windows from PHP
82725     * version 5.3 onwards.
82726     *
82727     * @param string $key The path name to the key file.
82728     * @param string $cert The path name to the certificate file.
82729     * @param string $ca The path name to the certificate authority file.
82730     * @param string $capath The pathname to a directory that contains
82731     *   trusted SSL CA certificates in PEM format.
82732     * @param string $cipher A list of allowable ciphers to use for SSL
82733     *   encryption.
82734     * @return bool
82735     **/
82736    function ssl_set($key, $cert, $ca, $capath, $cipher){}
82737
82738    /**
82739     * {@link mysqli_stat} returns a string containing information similar to
82740     * that provided by the 'mysqladmin status' command. This includes uptime
82741     * in seconds and the number of running threads, questions, reloads, and
82742     * open tables.
82743     *
82744     * @return string
82745     **/
82746    function stat(){}
82747
82748    /**
82749     * Allocates and initializes a statement object suitable for {@link
82750     * mysqli_stmt_prepare}.
82751     *
82752     * @return mysqli_stmt
82753     **/
82754    function stmt_init(){}
82755
82756    /**
82757     * Transfers the result set from the last query on the database
82758     * connection represented by the {@link link} parameter to be used with
82759     * the {@link mysqli_data_seek} function.
82760     *
82761     * @return mysqli_result
82762     **/
82763    function store_result(){}
82764
82765    /**
82766     * Used to initiate the retrieval of a result set from the last query
82767     * executed using the {@link mysqli_real_query} function on the database
82768     * connection.
82769     *
82770     * Either this or the {@link mysqli_store_result} function must be called
82771     * before the results of a query can be retrieved, and one or the other
82772     * must be called to prevent the next query on that database connection
82773     * from failing.
82774     *
82775     * @return mysqli_result
82776     **/
82777    function use_result(){}
82778
82779}
82780class MySQLi_Driver {
82781    /**
82782     * @return void
82783     **/
82784    function embedded_server_end(){}
82785
82786    /**
82787     * @param bool $start
82788     * @param array $arguments
82789     * @param array $groups
82790     * @return bool
82791     **/
82792    function embedded_server_start($start, $arguments, $groups){}
82793
82794}
82795class MySQLi_Result {
82796    /**
82797     * Returns the position of the field cursor used for the last {@link
82798     * mysqli_fetch_field} call. This value can be used as an argument to
82799     * {@link mysqli_field_seek}.
82800     *
82801     * @var int
82802     **/
82803    var $current_field;
82804    /**
82805     * Returns the number of fields from specified result set.
82806     *
82807     * @var int
82808     **/
82809    var $field_count;
82810    /**
82811     * Returns the number of columns for the most recent query on the
82812     * connection represented by the {@link link} parameter. This function
82813     * can be useful when using the {@link mysqli_store_result} function to
82814     * determine if the query should have produced a non-empty result set or
82815     * not without knowing the nature of the query.
82816     *
82817     * @var int
82818     **/
82819    var $field_count;
82820    /**
82821     * The {@link mysqli_fetch_lengths} function returns an array containing
82822     * the lengths of every column of the current row within the result set.
82823     *
82824     * @var array
82825     **/
82826    var $lengths;
82827    /**
82828     * Returns the number of rows in the result set.
82829     *
82830     * The use of {@link mysqli_num_rows} depends on whether you use buffered
82831     * or unbuffered result sets. In case you use unbuffered resultsets
82832     * {@link mysqli_num_rows} will not return the correct number of rows
82833     * until all the rows in the result have been retrieved.
82834     *
82835     * @var int
82836     **/
82837    var $num_rows;
82838    /**
82839     * Frees the memory associated with the result.
82840     *
82841     * @return void
82842     **/
82843    function close(){}
82844
82845    /**
82846     * The {@link mysqli_data_seek} function seeks to an arbitrary result
82847     * pointer specified by the {@link offset} in the result set.
82848     *
82849     * @param int $offset The field offset. Must be between zero and the
82850     *   total number of rows minus one (0..{@link mysqli_num_rows} - 1).
82851     * @return bool
82852     **/
82853    function data_seek($offset){}
82854
82855    /**
82856     * {@link mysqli_fetch_all} fetches all result rows and returns the
82857     * result set as an associative array, a numeric array, or both.
82858     *
82859     * @param int $resulttype This optional parameter is a constant
82860     *   indicating what type of array should be produced from the current
82861     *   row data. The possible values for this parameter are the constants
82862     *   MYSQLI_ASSOC, MYSQLI_NUM, or MYSQLI_BOTH.
82863     * @return mixed
82864     **/
82865    function fetch_all($resulttype){}
82866
82867    /**
82868     * Returns an array that corresponds to the fetched row or if there are
82869     * no more rows for the resultset represented by the {@link result}
82870     * parameter.
82871     *
82872     * {@link mysqli_fetch_array} is an extended version of the {@link
82873     * mysqli_fetch_row} function. In addition to storing the data in the
82874     * numeric indices of the result array, the {@link mysqli_fetch_array}
82875     * function can also store the data in associative indices, using the
82876     * field names of the result set as keys.
82877     *
82878     * If two or more columns of the result have the same field names, the
82879     * last column will take precedence and overwrite the earlier data. In
82880     * order to access multiple columns with the same name, the numerically
82881     * indexed version of the row must be used.
82882     *
82883     * @param int $resulttype This optional parameter is a constant
82884     *   indicating what type of array should be produced from the current
82885     *   row data. The possible values for this parameter are the constants
82886     *   MYSQLI_ASSOC, MYSQLI_NUM, or MYSQLI_BOTH. By using the MYSQLI_ASSOC
82887     *   constant this function will behave identically to the {@link
82888     *   mysqli_fetch_assoc}, while MYSQLI_NUM will behave identically to the
82889     *   {@link mysqli_fetch_row} function. The final option MYSQLI_BOTH will
82890     *   create a single array with the attributes of both.
82891     * @return mixed
82892     **/
82893    function fetch_array($resulttype){}
82894
82895    /**
82896     * Returns an associative array that corresponds to the fetched row or if
82897     * there are no more rows.
82898     *
82899     * @return array
82900     **/
82901    function fetch_assoc(){}
82902
82903    /**
82904     * Returns the definition of one column of a result set as an object.
82905     * Call this function repeatedly to retrieve information about all
82906     * columns in the result set.
82907     *
82908     * @return object
82909     **/
82910    function fetch_field(){}
82911
82912    /**
82913     * This function serves an identical purpose to the {@link
82914     * mysqli_fetch_field} function with the single difference that, instead
82915     * of returning one object at a time for each field, the columns are
82916     * returned as an array of objects.
82917     *
82918     * @return array
82919     **/
82920    function fetch_fields(){}
82921
82922    /**
82923     * Returns an object which contains field definition information from the
82924     * specified result set.
82925     *
82926     * @param int $fieldnr The field number. This value must be in the
82927     *   range from 0 to number of fields - 1.
82928     * @return object
82929     **/
82930    function fetch_field_direct($fieldnr){}
82931
82932    /**
82933     * The {@link mysqli_fetch_object} will return the current row result set
82934     * as an object where the attributes of the object represent the names of
82935     * the fields found within the result set.
82936     *
82937     * @param string $class_name The name of the class to instantiate, set
82938     *   the properties of and return. If not specified, a stdClass object is
82939     *   returned.
82940     * @param array $params An optional array of parameters to pass to the
82941     *   constructor for {@link class_name} objects.
82942     * @return object
82943     **/
82944    function fetch_object($class_name, $params){}
82945
82946    /**
82947     * Fetches one row of data from the result set and returns it as an
82948     * enumerated array, where each column is stored in an array offset
82949     * starting from 0 (zero). Each subsequent call to this function will
82950     * return the next row within the result set, or if there are no more
82951     * rows.
82952     *
82953     * @return mixed
82954     **/
82955    function fetch_row(){}
82956
82957    /**
82958     * Sets the field cursor to the given offset. The next call to {@link
82959     * mysqli_fetch_field} will retrieve the field definition of the column
82960     * associated with that offset.
82961     *
82962     * @param int $fieldnr The field number. This value must be in the
82963     *   range from 0 to number of fields - 1.
82964     * @return bool
82965     **/
82966    function field_seek($fieldnr){}
82967
82968    /**
82969     * Frees the memory associated with the result.
82970     *
82971     * @return void
82972     **/
82973    function free(){}
82974
82975    /**
82976     * Frees the memory associated with the result.
82977     *
82978     * @return void
82979     **/
82980    function free_result(){}
82981
82982}
82983class MySQLi_STMT {
82984    /**
82985     * Returns the number of rows affected by INSERT, UPDATE, or DELETE
82986     * query.
82987     *
82988     * This function only works with queries which update a table. In order
82989     * to get the number of rows from a SELECT query, use {@link
82990     * mysqli_stmt_num_rows} instead.
82991     *
82992     * @var int
82993     **/
82994    var $affected_rows;
82995    /**
82996     * Returns the error code for the most recently invoked statement
82997     * function that can succeed or fail.
82998     *
82999     * Client error message numbers are listed in the MySQL errmsg.h header
83000     * file, server error message numbers are listed in mysqld_error.h. In
83001     * the MySQL source distribution you can find a complete list of error
83002     * messages and error numbers in the file Docs/mysqld_error.txt.
83003     *
83004     * @var int
83005     **/
83006    var $errno;
83007    /**
83008     * Returns a containing the error message for the most recently invoked
83009     * statement function that can succeed or fail.
83010     *
83011     * @var string
83012     **/
83013    var $error;
83014    /**
83015     * @var int
83016     **/
83017    var $field_count;
83018    /**
83019     * @var int
83020     **/
83021    var $insert_id;
83022    /**
83023     * Returns the number of rows in the result set. The use of {@link
83024     * mysqli_stmt_num_rows} depends on whether or not you used {@link
83025     * mysqli_stmt_store_result} to buffer the entire result set in the
83026     * statement handle.
83027     *
83028     * If you use {@link mysqli_stmt_store_result}, {@link
83029     * mysqli_stmt_num_rows} may be called immediately.
83030     *
83031     * @var int
83032     **/
83033    var $num_rows;
83034    /**
83035     * Returns the number of parameter markers present in the prepared
83036     * statement.
83037     *
83038     * @var int
83039     **/
83040    var $param_count;
83041    /**
83042     * Returns a string containing the SQLSTATE error code for the most
83043     * recently invoked prepared statement function that can succeed or fail.
83044     * The error code consists of five characters. '00000' means no error.
83045     * The values are specified by ANSI SQL and ODBC. For a list of possible
83046     * values, see .
83047     *
83048     * @var string
83049     **/
83050    var $sqlstate;
83051    /**
83052     * Gets the current value of a statement attribute.
83053     *
83054     * @param int $attr The attribute that you want to get.
83055     * @return int
83056     **/
83057    function attr_get($attr){}
83058
83059    /**
83060     * Used to modify the behavior of a prepared statement. This function may
83061     * be called multiple times to set several attributes.
83062     *
83063     * @param int $attr The attribute that you want to set. It can have one
83064     *   of the following values: Attribute values Character Description
83065     *   MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH If set to 1, causes {@link
83066     *   mysqli_stmt_store_result} to update the metadata
83067     *   MYSQL_FIELD->max_length value. MYSQLI_STMT_ATTR_CURSOR_TYPE Type of
83068     *   cursor to open for statement when {@link mysqli_stmt_execute} is
83069     *   invoked. {@link mode} can be MYSQLI_CURSOR_TYPE_NO_CURSOR (the
83070     *   default) or MYSQLI_CURSOR_TYPE_READ_ONLY.
83071     *   MYSQLI_STMT_ATTR_PREFETCH_ROWS Number of rows to fetch from server
83072     *   at a time when using a cursor. {@link mode} can be in the range from
83073     *   1 to the maximum value of unsigned long. The default is 1. If you
83074     *   use the MYSQLI_STMT_ATTR_CURSOR_TYPE option with
83075     *   MYSQLI_CURSOR_TYPE_READ_ONLY, a cursor is opened for the statement
83076     *   when you invoke {@link mysqli_stmt_execute}. If there is already an
83077     *   open cursor from a previous {@link mysqli_stmt_execute} call, it
83078     *   closes the cursor before opening a new one. {@link
83079     *   mysqli_stmt_reset} also closes any open cursor before preparing the
83080     *   statement for re-execution. {@link mysqli_stmt_free_result} closes
83081     *   any open cursor. If you open a cursor for a prepared statement,
83082     *   {@link mysqli_stmt_store_result} is unnecessary.
83083     * @param int $mode The value to assign to the attribute.
83084     * @return bool
83085     **/
83086    function attr_set($attr, $mode){}
83087
83088    /**
83089     * Bind variables for the parameter markers in the SQL statement that was
83090     * passed to {@link mysqli_prepare}.
83091     *
83092     * @param string $types A string that contains one or more characters
83093     *   which specify the types for the corresponding bind variables: Type
83094     *   specification chars Character Description i corresponding variable
83095     *   has type integer d corresponding variable has type double s
83096     *   corresponding variable has type string b corresponding variable is a
83097     *   blob and will be sent in packets
83098     * @param mixed $var1 The number of variables and length of string
83099     *   {@link types} must match the parameters in the statement.
83100     * @return bool
83101     **/
83102    function bind_param($types, &$var1){}
83103
83104    /**
83105     * Binds columns in the result set to variables.
83106     *
83107     * When {@link mysqli_stmt_fetch} is called to fetch data, the MySQL
83108     * client/server protocol places the data for the bound columns into the
83109     * specified variables {@link var1, ...}.
83110     *
83111     * @param mixed $var1 The variable to be bound.
83112     * @return bool
83113     **/
83114    function bind_result(&$var1){}
83115
83116    /**
83117     * Closes a prepared statement. {@link mysqli_stmt_close} also
83118     * deallocates the statement handle. If the current statement has pending
83119     * or unread results, this function cancels them so that the next query
83120     * can be executed.
83121     *
83122     * @return bool
83123     **/
83124    function close(){}
83125
83126    /**
83127     * Seeks to an arbitrary result pointer in the statement result set.
83128     *
83129     * {@link mysqli_stmt_store_result} must be called prior to {@link
83130     * mysqli_stmt_data_seek}.
83131     *
83132     * @param int $offset Must be between zero and the total number of rows
83133     *   minus one (0.. {@link mysqli_stmt_num_rows} - 1).
83134     * @return void
83135     **/
83136    function data_seek($offset){}
83137
83138    /**
83139     * Executes a query that has been previously prepared using the {@link
83140     * mysqli_prepare} function. When executed any parameter markers which
83141     * exist will automatically be replaced with the appropriate data.
83142     *
83143     * If the statement is UPDATE, DELETE, or INSERT, the total number of
83144     * affected rows can be determined by using the {@link
83145     * mysqli_stmt_affected_rows} function. Likewise, if the query yields a
83146     * result set the {@link mysqli_stmt_fetch} function is used.
83147     *
83148     * @return bool
83149     **/
83150    function execute(){}
83151
83152    /**
83153     * Fetch the result from a prepared statement into the variables bound by
83154     * {@link mysqli_stmt_bind_result}.
83155     *
83156     * @return bool
83157     **/
83158    function fetch(){}
83159
83160    /**
83161     * Frees the result memory associated with the statement, which was
83162     * allocated by {@link mysqli_stmt_store_result}.
83163     *
83164     * @return void
83165     **/
83166    function free_result(){}
83167
83168    /**
83169     * @param mysqli_stmt $stmt
83170     * @return object
83171     **/
83172    function get_warnings($stmt){}
83173
83174    /**
83175     * Prepares the SQL query pointed to by the null-terminated string query.
83176     *
83177     * The parameter markers must be bound to application variables using
83178     * {@link mysqli_stmt_bind_param} and/or {@link mysqli_stmt_bind_result}
83179     * before executing the statement or fetching rows.
83180     *
83181     * @param string $query The query, as a string. It must consist of a
83182     *   single SQL statement. You can include one or more parameter markers
83183     *   in the SQL statement by embedding question mark (?) characters at
83184     *   the appropriate positions.
83185     * @return mixed
83186     **/
83187    function prepare($query){}
83188
83189    /**
83190     * Resets a prepared statement on client and server to state after
83191     * prepare.
83192     *
83193     * It resets the statement on the server, data sent using {@link
83194     * mysqli_stmt_send_long_data}, unbuffered result sets and current
83195     * errors. It does not clear bindings or stored result sets. Stored
83196     * result sets will be cleared when executing the prepared statement (or
83197     * closing it).
83198     *
83199     * To prepare a statement with another query use function {@link
83200     * mysqli_stmt_prepare}.
83201     *
83202     * @return bool
83203     **/
83204    function reset(){}
83205
83206    /**
83207     * If a statement passed to {@link mysqli_prepare} is one that produces a
83208     * result set, {@link mysqli_stmt_result_metadata} returns the result
83209     * object that can be used to process the meta information such as total
83210     * number of fields and individual field information.
83211     *
83212     * The result set structure should be freed when you are done with it,
83213     * which you can do by passing it to {@link mysqli_free_result}
83214     *
83215     * @return mysqli_result
83216     **/
83217    function result_metadata(){}
83218
83219    /**
83220     * Allows to send parameter data to the server in pieces (or chunks),
83221     * e.g. if the size of a blob exceeds the size of max_allowed_packet.
83222     * This function can be called multiple times to send the parts of a
83223     * character or binary data value for a column, which must be one of the
83224     * TEXT or BLOB datatypes.
83225     *
83226     * @param int $param_nr Indicates which parameter to associate the data
83227     *   with. Parameters are numbered beginning with 0.
83228     * @param string $data A string containing data to be sent.
83229     * @return bool
83230     **/
83231    function send_long_data($param_nr, $data){}
83232
83233    /**
83234     * You must call {@link mysqli_stmt_store_result} for every query that
83235     * successfully produces a result set (SELECT, SHOW, DESCRIBE, EXPLAIN),
83236     * and only if you want to buffer the complete result set by the client,
83237     * so that the subsequent {@link mysqli_stmt_fetch} call returns buffered
83238     * data.
83239     *
83240     * @return bool
83241     **/
83242    function store_result(){}
83243
83244}
83245class mysqli_warning {
83246    /**
83247     * @return void
83248     **/
83249    function next(){}
83250
83251    function __construct(){}
83252
83253}
83254/**
83255 * This iterator cannot be rewinded.
83256 **/
83257class NoRewindIterator extends IteratorIterator {
83258    /**
83259     * Gets the current value.
83260     *
83261     * @return mixed
83262     * @since PHP 5 >= 5.1.0
83263     **/
83264    function current(){}
83265
83266    /**
83267     * Gets the inner iterator, that was passed in to NoRewindIterator.
83268     *
83269     * @return iterator
83270     * @since PHP 5 >= 5.1.0
83271     **/
83272    function getInnerIterator(){}
83273
83274    /**
83275     * Gets the current key.
83276     *
83277     * @return mixed
83278     * @since PHP 5 >= 5.1.0
83279     **/
83280    function key(){}
83281
83282    /**
83283     * Forwards to the next element.
83284     *
83285     * @return void
83286     * @since PHP 5 >= 5.1.0
83287     **/
83288    function next(){}
83289
83290    /**
83291     * Prevents the rewind operation on the inner iterator.
83292     *
83293     * @return void
83294     * @since PHP 5 >= 5.1.0
83295     **/
83296    function rewind(){}
83297
83298    /**
83299     * Checks whether the iterator is valid.
83300     *
83301     * @return bool
83302     * @since PHP 5 >= 5.1.0
83303     **/
83304    function valid(){}
83305
83306    /**
83307     * Constructs a NoRewindIterator.
83308     *
83309     * @param Iterator $iterator The iterator being used.
83310     * @since PHP 5 >= 5.1.0
83311     **/
83312    function __construct($iterator){}
83313
83314}
83315/**
83316 * The Unicode Consortium has defined a number of normalization forms
83317 * reflecting the various needs of applications: The different forms are
83318 * defined in terms of a set of transformations on the text,
83319 * transformations that are expressed by both an algorithm and a set of
83320 * data files.
83321 **/
83322class Normalizer {
83323    /**
83324     * Checks if the provided string is already in the specified
83325     * normalization form.
83326     *
83327     * @param string $input The input string to normalize
83328     * @param string $form One of the normalization forms.
83329     * @return bool
83330     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83331     **/
83332    function isNormalized($input, $form){}
83333
83334    /**
83335     * Normalizes the input provided and returns the normalized string
83336     *
83337     * @param string $input The input string to normalize
83338     * @param string $form One of the normalization forms.
83339     * @return string
83340     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83341     **/
83342    function normalize($input, $form){}
83343
83344}
83345/**
83346 * For currencies you can use currency format type to create a formatter
83347 * that returns a string with the formatted number and the appropriate
83348 * currency sign. Of course, the NumberFormatter class is unaware of
83349 * exchange rates so, the number output is the same regardless of the
83350 * specified currency. This means that the same number has different
83351 * monetary values depending on the currency locale. If the number is
83352 * 9988776.65 the results will be:
83353 **/
83354class NumberFormatter {
83355    /**
83356     * Creates a number formatter.
83357     *
83358     * @param string $locale Locale in which the number would be formatted
83359     *   (locale name, e.g. en_CA).
83360     * @param int $style Style of the formatting, one of the format style
83361     *   constants. If NumberFormatter::PATTERN_DECIMAL or
83362     *   NumberFormatter::PATTERN_RULEBASED is passed then the number format
83363     *   is opened using the given pattern, which must conform to the syntax
83364     *   described in ICU DecimalFormat documentation or ICU
83365     *   RuleBasedNumberFormat documentation, respectively.
83366     * @param string $pattern Pattern string in case chosen style requires
83367     *   pattern.
83368     * @return NumberFormatter
83369     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83370     **/
83371    function create($locale, $style, $pattern){}
83372
83373    /**
83374     * Format a numeric value according to the formatter rules.
83375     *
83376     * @param number $value NumberFormatter object.
83377     * @param int $type The value to format. Can be integer or double,
83378     *   other values will be converted to a numeric value.
83379     * @return string
83380     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83381     **/
83382    function format($value, $type){}
83383
83384    /**
83385     * Format the currency value according to the formatter rules.
83386     *
83387     * @param float $value NumberFormatter object.
83388     * @param string $currency The numeric currency value.
83389     * @return string
83390     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83391     **/
83392    function formatCurrency($value, $currency){}
83393
83394    /**
83395     * Get a numeric attribute associated with the formatter. An example of a
83396     * numeric attribute is the number of integer digits the formatter will
83397     * produce.
83398     *
83399     * @param int $attr NumberFormatter object.
83400     * @return int
83401     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83402     **/
83403    function getAttribute($attr){}
83404
83405    /**
83406     * Get error code from the last function performed by the formatter.
83407     *
83408     * @return int
83409     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83410     **/
83411    function getErrorCode(){}
83412
83413    /**
83414     * Get error message from the last function performed by the formatter.
83415     *
83416     * @return string
83417     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83418     **/
83419    function getErrorMessage(){}
83420
83421    /**
83422     * Get formatter locale name.
83423     *
83424     * @param int $type NumberFormatter object.
83425     * @return string
83426     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83427     **/
83428    function getLocale($type){}
83429
83430    /**
83431     * Extract pattern used by the formatter.
83432     *
83433     * @return string
83434     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83435     **/
83436    function getPattern(){}
83437
83438    /**
83439     * Get a symbol associated with the formatter. The formatter uses symbols
83440     * to represent the special locale-dependent characters in a number, for
83441     * example the percent sign. This API is not supported for rule-based
83442     * formatters.
83443     *
83444     * @param int $attr NumberFormatter object.
83445     * @return string
83446     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83447     **/
83448    function getSymbol($attr){}
83449
83450    /**
83451     * Get a text attribute associated with the formatter. An example of a
83452     * text attribute is the suffix for positive numbers. If the formatter
83453     * does not understand the attribute, U_UNSUPPORTED_ERROR error is
83454     * produced. Rule-based formatters only understand
83455     * NumberFormatter::DEFAULT_RULESET and NumberFormatter::PUBLIC_RULESETS.
83456     *
83457     * @param int $attr NumberFormatter object.
83458     * @return string
83459     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83460     **/
83461    function getTextAttribute($attr){}
83462
83463    /**
83464     * Parse a string into a number using the current formatter rules.
83465     *
83466     * @param string $value NumberFormatter object.
83467     * @param int $type The formatting type to use. By default,
83468     *   NumberFormatter::TYPE_DOUBLE is used.
83469     * @param int $position Offset in the string at which to begin parsing.
83470     *   On return, this value will hold the offset at which parsing ended.
83471     * @return mixed
83472     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83473     **/
83474    function parse($value, $type, &$position){}
83475
83476    /**
83477     * Parse a string into a double and a currency using the current
83478     * formatter.
83479     *
83480     * @param string $value NumberFormatter object.
83481     * @param string $currency Parameter to receive the currency name
83482     *   (3-letter ISO 4217 currency code).
83483     * @param int $position Offset in the string at which to begin parsing.
83484     *   On return, this value will hold the offset at which parsing ended.
83485     * @return float
83486     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83487     **/
83488    function parseCurrency($value, &$currency, &$position){}
83489
83490    /**
83491     * Set a numeric attribute associated with the formatter. An example of a
83492     * numeric attribute is the number of integer digits the formatter will
83493     * produce.
83494     *
83495     * @param int $attr NumberFormatter object.
83496     * @param int $value Attribute specifier - one of the numeric attribute
83497     *   constants.
83498     * @return bool
83499     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83500     **/
83501    function setAttribute($attr, $value){}
83502
83503    /**
83504     * Set the pattern used by the formatter. Can not be used on a rule-based
83505     * formatter.
83506     *
83507     * @param string $pattern NumberFormatter object.
83508     * @return bool
83509     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83510     **/
83511    function setPattern($pattern){}
83512
83513    /**
83514     * Set a symbol associated with the formatter. The formatter uses symbols
83515     * to represent the special locale-dependent characters in a number, for
83516     * example the percent sign. This API is not supported for rule-based
83517     * formatters.
83518     *
83519     * @param int $attr NumberFormatter object.
83520     * @param string $value Symbol specifier, one of the format symbol
83521     *   constants.
83522     * @return bool
83523     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83524     **/
83525    function setSymbol($attr, $value){}
83526
83527    /**
83528     * Set a text attribute associated with the formatter. An example of a
83529     * text attribute is the suffix for positive numbers. If the formatter
83530     * does not understand the attribute, U_UNSUPPORTED_ERROR error is
83531     * produced. Rule-based formatters only understand
83532     * NumberFormatter::DEFAULT_RULESET and NumberFormatter::PUBLIC_RULESETS.
83533     *
83534     * @param int $attr NumberFormatter object.
83535     * @param string $value Attribute specifier - one of the text attribute
83536     *   constants.
83537     * @return bool
83538     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
83539     **/
83540    function setTextAttribute($attr, $value){}
83541
83542}
83543/**
83544 * The OAuth extension provides a simple interface to interact with data
83545 * providers using the OAuth HTTP specification to protect private
83546 * resources.
83547 **/
83548class OAuth {
83549    /**
83550     * Turns off verbose request information (off by default). Alternatively,
83551     * the debug property can be set to a value to turn debug off.
83552     *
83553     * @return bool
83554     * @since PECL OAuth >= 0.99.3
83555     **/
83556    function disableDebug(){}
83557
83558    /**
83559     * Disable redirects from being followed automatically, thus allowing the
83560     * request to be manually redirected.
83561     *
83562     * @return bool
83563     * @since PECL OAuth >= 0.99.9
83564     **/
83565    function disableRedirects(){}
83566
83567    /**
83568     * Turns off the usual SSL peer certificate and host checks, this is not
83569     * for production environments. Alternatively, the {@link sslChecks}
83570     * member can be set to to turn SSL checks off.
83571     *
83572     * @return bool
83573     * @since PECL OAuth >= 0.99.5
83574     **/
83575    function disableSSLChecks(){}
83576
83577    /**
83578     * Turns on verbose request information useful for debugging, the debug
83579     * information is stored in the {@link debugInfo} member. Alternatively,
83580     * the {@link debug} member can be set to a non- value to turn debug on.
83581     *
83582     * @return bool
83583     * @since PECL OAuth >= 0.99.3
83584     **/
83585    function enableDebug(){}
83586
83587    /**
83588     * Follow and sign redirects automatically, which is enabled by default.
83589     *
83590     * @return bool
83591     * @since PECL OAuth >= 0.99.9
83592     **/
83593    function enableRedirects(){}
83594
83595    /**
83596     * Turns on the usual SSL peer certificate and host checks (enabled by
83597     * default). Alternatively, the {@link sslChecks} member can be set to a
83598     * non- value to turn SSL checks off.
83599     *
83600     * @return bool
83601     * @since PECL OAuth >= 0.99.5
83602     **/
83603    function enableSSLChecks(){}
83604
83605    /**
83606     * Fetch a resource.
83607     *
83608     * @param string $protected_resource_url URL to the OAuth protected
83609     *   resource.
83610     * @param array $extra_parameters Extra parameters to send with the
83611     *   request for the resource.
83612     * @param string $http_method One of the OAUTH_HTTP_METHOD_* OAUTH
83613     *   constants, which includes GET, POST, PUT, HEAD, or DELETE. HEAD
83614     *   (OAUTH_HTTP_METHOD_HEAD) can be useful for discovering information
83615     *   prior to the request (if OAuth credentials are in the Authorization
83616     *   header).
83617     * @param array $http_headers HTTP client headers (such as User-Agent,
83618     *   Accept, etc.)
83619     * @return mixed
83620     * @since PECL OAuth >= 0.99.1
83621     **/
83622    function fetch($protected_resource_url, $extra_parameters, $http_method, $http_headers){}
83623
83624    /**
83625     * Fetch an access token, secret and any additional response parameters
83626     * from the service provider.
83627     *
83628     * @param string $access_token_url URL to the access token API.
83629     * @param string $auth_session_handle Authorization session handle,
83630     *   this parameter does not have any citation in the core OAuth 1.0
83631     *   specification but may be implemented by large providers. See
83632     *   ScalableOAuth for more information.
83633     * @param string $verifier_token For service providers which support
83634     *   1.0a, a {@link verifier_token} must be passed while exchanging the
83635     *   request token for the access token. If the {@link verifier_token} is
83636     *   present in {@link $_GET} or {@link $_POST} it is passed
83637     *   automatically and the caller does not need to specify a {@link
83638     *   verifier_token} (usually if the access token is exchanged at the
83639     *   oauth_callback URL). See ScalableOAuth for more information.
83640     * @return array
83641     * @since PECL OAuth >= 0.99.1
83642     **/
83643    function getAccessToken($access_token_url, $auth_session_handle, $verifier_token){}
83644
83645    /**
83646     * Gets the Certificate Authority information, which includes the ca_path
83647     * and ca_info set by OAuth::setCaPath.
83648     *
83649     * @return array
83650     * @since PECL OAuth >= 0.99.8
83651     **/
83652    function getCAPath(){}
83653
83654    /**
83655     * Get the raw response of the most recent request.
83656     *
83657     * @return string
83658     * @since PECL OAuth >= 0.99.1
83659     **/
83660    function getLastResponse(){}
83661
83662    /**
83663     * Get HTTP information about the last response.
83664     *
83665     * @return array
83666     * @since PECL OAuth >= 0.99.1
83667     **/
83668    function getLastResponseInfo(){}
83669
83670    /**
83671     * Fetch a request token, secret and any additional response parameters
83672     * from the service provider.
83673     *
83674     * @param string $request_token_url URL to the request token API.
83675     * @param string $callback_url OAuth callback URL. If {@link
83676     *   callback_url} is passed and is an empty value, it is set to "oob" to
83677     *   address the OAuth 2009.1 advisory.
83678     * @return array
83679     * @since PECL OAuth >= 0.99.1
83680     **/
83681    function getRequestToken($request_token_url, $callback_url){}
83682
83683    /**
83684     * Set where the OAuth parameters should be passed.
83685     *
83686     * @param int $auth_type {@link auth_type} can be one of the following
83687     *   flags (in order of decreasing preference as per OAuth 1.0 section
83688     *   5.2): OAUTH_AUTH_TYPE_AUTHORIZATION Pass the OAuth parameters in the
83689     *   HTTP Authorization header. OAUTH_AUTH_TYPE_FORM Append the OAuth
83690     *   parameters to the HTTP POST request body. OAUTH_AUTH_TYPE_URI Append
83691     *   the OAuth parameters to the request URI. OAUTH_AUTH_TYPE_NONE None.
83692     * @return mixed
83693     * @since PECL OAuth >= 0.99.1
83694     **/
83695    function setAuthType($auth_type){}
83696
83697    /**
83698     * Sets the Certificate Authority (CA), both for path and info.
83699     *
83700     * @param string $ca_path The CA Path being set.
83701     * @param string $ca_info The CA Info being set.
83702     * @return mixed
83703     * @since PECL OAuth >= 0.99.8
83704     **/
83705    function setCAPath($ca_path, $ca_info){}
83706
83707    /**
83708     * Sets the nonce for all subsequent requests.
83709     *
83710     * @param string $nonce The value for oauth_nonce.
83711     * @return mixed
83712     * @since PECL OAuth >= 0.99.1
83713     **/
83714    function setNonce($nonce){}
83715
83716    /**
83717     * Sets the Request Engine, that will be sending the HTTP requests.
83718     *
83719     * @param string $reqengine The desired request engine. Set to
83720     *   OAUTH_REQENGINE_STREAMS to use PHP Streams, or OAUTH_REQENGINE_CURL
83721     *   to use Curl.
83722     * @return void
83723     * @since PECL OAuth >= 1.0.0
83724     **/
83725    function setRequestEngine($reqengine){}
83726
83727    /**
83728     * Sets the RSA certificate.
83729     *
83730     * @param string $cert The RSA certificate.
83731     * @return mixed
83732     * @since PECL OAuth >= 1.0.0
83733     **/
83734    function setRSACertificate($cert){}
83735
83736    /**
83737     * Sets the OAuth timestamp for subsequent requests.
83738     *
83739     * @param string $timestamp The timestamp.
83740     * @return mixed
83741     * @since PECL OAuth >= 1.0.0
83742     **/
83743    function setTimestamp($timestamp){}
83744
83745    /**
83746     * Set the token and secret for subsequent requests.
83747     *
83748     * @param string $token The OAuth token.
83749     * @param string $token_secret The OAuth token secret.
83750     * @return bool
83751     * @since PECL OAuth >= 0.99.1
83752     **/
83753    function setToken($token, $token_secret){}
83754
83755    /**
83756     * Sets the OAuth version for subsequent requests
83757     *
83758     * @param string $version OAuth version, default value is always "1.0"
83759     * @return bool
83760     * @since PECL OAuth >= 0.99.1
83761     **/
83762    function setVersion($version){}
83763
83764    /**
83765     * Creates a new OAuth object
83766     *
83767     * @param string $consumer_key The consumer key provided by the service
83768     *   provider.
83769     * @param string $consumer_secret The consumer secret provided by the
83770     *   service provider.
83771     * @param string $signature_method This optional parameter defines
83772     *   which signature method to use, by default it is
83773     *   OAUTH_SIG_METHOD_HMACSHA1 (HMAC-SHA1).
83774     * @param int $auth_type This optional parameter defines how to pass
83775     *   the OAuth parameters to a consumer, by default it is
83776     *   OAUTH_AUTH_TYPE_AUTHORIZATION (in the Authorization header).
83777     * @since PECL OAuth >= 0.99.1
83778     **/
83779    function __construct($consumer_key, $consumer_secret, $signature_method, $auth_type){}
83780
83781    /**
83782     * The destructor.
83783     *
83784     * @return void
83785     * @since PECL OAuth >= 0.99.9
83786     **/
83787    function __destruct(){}
83788
83789}
83790/**
83791 * This exception is thrown when exceptional errors occur while using the
83792 * OAuth extension and contains useful debugging information.
83793 **/
83794class OAuthException extends Exception {
83795}
83796/**
83797 * Manages an OAuth provider class.
83798 *
83799 * See also an external in-depth tutorial titled , which takes a hands-on
83800 * approach to providing this service. There are also within the OAuth
83801 * extensions sources.
83802 **/
83803class OAuthProvider {
83804    /**
83805     * Add required oauth provider parameters.
83806     *
83807     * @param string $req_params The required parameters.
83808     * @return bool
83809     * @since PECL OAuth >= 1.0.0
83810     **/
83811    function addRequiredParameter($req_params){}
83812
83813    /**
83814     * Calls the registered consumer handler callback function, which is set
83815     * with OAuthProvider::consumerHandler.
83816     *
83817     * @return void
83818     **/
83819    function callconsumerHandler(){}
83820
83821    /**
83822     * Calls the registered timestamp handler callback function, which is set
83823     * with OAuthProvider::timestampNonceHandler.
83824     *
83825     * @return void
83826     * @since PECL OAuth >= 1.0.0
83827     **/
83828    function callTimestampNonceHandler(){}
83829
83830    /**
83831     * Calls the registered token handler callback function, which is set
83832     * with OAuthProvider::tokenHandler.
83833     *
83834     * @return void
83835     * @since PECL OAuth >= 1.0.0
83836     **/
83837    function calltokenHandler(){}
83838
83839    /**
83840     * Checks an OAuth request.
83841     *
83842     * @param string $uri The optional URI, or endpoint.
83843     * @param string $method The HTTP method. Optionally pass in one of the
83844     *   OAUTH_HTTP_METHOD_* OAuth constants.
83845     * @return void
83846     * @since PECL OAuth >= 1.0.0
83847     **/
83848    function checkOAuthRequest($uri, $method){}
83849
83850    /**
83851     * Sets the consumer handler callback, which will later be called with
83852     * OAuthProvider::callConsumerHandler.
83853     *
83854     * @param callback $callback_function The callback functions name.
83855     * @return void
83856     * @since PECL OAuth >= 1.0.0
83857     **/
83858    function consumerHandler($callback_function){}
83859
83860    /**
83861     * Generates a string of pseudo-random bytes.
83862     *
83863     * @param int $size The desired token length, in terms of bytes.
83864     * @param bool $strong Setting to means /dev/random will be used for
83865     *   entropy, as otherwise the non-blocking /dev/urandom is used. This
83866     *   parameter is ignored on Windows.
83867     * @return string
83868     * @since PECL OAuth >= 1.0.0
83869     **/
83870    function generateToken($size, $strong){}
83871
83872    /**
83873     * The 2-legged flow, or request signing. It does not require a token.
83874     *
83875     * @param mixed $params_array
83876     * @return void
83877     * @since PECL OAuth >= 1.0.0
83878     **/
83879    function is2LeggedEndpoint($params_array){}
83880
83881    /**
83882     * @param bool $will_issue_request_token Sets whether or not it will
83883     *   issue a request token, thus determining if
83884     *   OAuthProvider::tokenHandler needs to be called.
83885     * @return void
83886     * @since PECL OAuth >= 1.0.0
83887     **/
83888    function isRequestTokenEndpoint($will_issue_request_token){}
83889
83890    /**
83891     * Removes a required parameter.
83892     *
83893     * @param string $req_params The required parameter to be removed.
83894     * @return bool
83895     * @since PECL OAuth >= 1.0.0
83896     **/
83897    function removeRequiredParameter($req_params){}
83898
83899    /**
83900     * Pass in a problem as an OAuthException, with possible problems listed
83901     * in the OAuth constants section.
83902     *
83903     * @param string $oauthexception The OAuthException.
83904     * @return void
83905     * @since PECL OAuth >= 1.0.0
83906     **/
83907    function reportProblem($oauthexception){}
83908
83909    /**
83910     * Sets a parameter.
83911     *
83912     * @param string $param_key The parameter key.
83913     * @param mixed $param_val The optional parameter value.
83914     * @return bool
83915     * @since PECL OAuth >= 1.0.0
83916     **/
83917    function setParam($param_key, $param_val){}
83918
83919    /**
83920     * Sets the request tokens path.
83921     *
83922     * @param string $path The path.
83923     * @return bool
83924     * @since PECL OAuth >= 1.0.0
83925     **/
83926    function setRequestTokenPath($path){}
83927
83928    /**
83929     * Sets the timestamp nonce handler callback, which will later be called
83930     * with OAuthProvider::callTimestampNonceHandler. Errors related to
83931     * timestamp/nonce are thrown to this callback.
83932     *
83933     * @param callback $callback_function The callback functions name.
83934     * @return void
83935     * @since PECL OAuth >= 1.0.0
83936     **/
83937    function timestampNonceHandler($callback_function){}
83938
83939    /**
83940     * Sets the token handler callback, which will later be called with
83941     * OAuthProvider::callTokenHandler.
83942     *
83943     * @param callback $callback_function The callback functions name.
83944     * @return void
83945     * @since PECL OAuth >= 1.0.0
83946     **/
83947    function tokenHandler($callback_function){}
83948
83949    /**
83950     * Initiates a new OAuthProvider object.
83951     *
83952     * @param array $params_array Setting these these optional parameters
83953     *   is limited to the CLI SAPI.
83954     * @since PECL OAuth >= 1.0.0
83955     **/
83956    function __construct($params_array){}
83957
83958}
83959/**
83960 * Classes implementing can be used to iterate over iterators.
83961 **/
83962interface OuterIterator extends Iterator {
83963    /**
83964     * Returns the inner iterator for the current iterator entry.
83965     *
83966     * @return Iterator
83967     * @since PHP 5 >= 5.1.0
83968     **/
83969    function getInnerIterator();
83970
83971}
83972/**
83973 * Exception thrown if a value is not a valid key
83974 **/
83975class OutOfBoundsException extends RuntimeException {
83976}
83977/**
83978 * Exception thrown when a value does not match with a range
83979 **/
83980class OutOfRangeException extends LogicException {
83981}
83982/**
83983 * Exception thrown when you add an element into a full container
83984 **/
83985class OverflowException extends RuntimeException {
83986}
83987/**
83988 * ...
83989 **/
83990class ParentIterator extends RecursiveFilterIterator implements RecursiveIterator, OuterIterator, Traversable, Iterator {
83991    /**
83992     * Determines if the current element has children.
83993     *
83994     * @return bool
83995     * @since PHP 5 >= 5.1.0
83996     **/
83997    function accept(){}
83998
83999    /**
84000     * Get the inner iterator's children contained in a ParentIterator.
84001     *
84002     * @return ParentIterator
84003     * @since PHP 5 >= 5.1.0
84004     **/
84005    function getChildren(){}
84006
84007    /**
84008     * Check whether the inner iterator's current element has children.
84009     *
84010     * @return bool
84011     * @since PHP 5 >= 5.1.0
84012     **/
84013    function hasChildren(){}
84014
84015    /**
84016     * Moves the iterator forward.
84017     *
84018     * @return void
84019     * @since PHP 5 >= 5.1.0
84020     **/
84021    function next(){}
84022
84023    /**
84024     * Rewinds the iterator.
84025     *
84026     * @return void
84027     * @since PHP 5 >= 5.1.0
84028     **/
84029    function rewind(){}
84030
84031    /**
84032     * Constructs a ParentIterator on an iterator.
84033     *
84034     * @param RecursiveIterator $iterator The iterator being constructed
84035     *   upon.
84036     * @since PHP 5 >= 5.1.0
84037     **/
84038    function __construct($iterator){}
84039
84040}
84041/**
84042 * Represents a connection between PHP and a database server.
84043 **/
84044interface PDO {
84045    const ATTR_AUTOCOMMIT = 0;
84046    const ATTR_CASE = 0;
84047    const ATTR_CLIENT_VERSION = 0;
84048    const ATTR_CONNECTION_STATUS = 0;
84049    const ATTR_CURSOR = 0;
84050    const ATTR_CURSOR_NAME = 0;
84051    const ATTR_DEFAULT_FETCH_MODE = 0;
84052    const ATTR_DRIVER_NAME = '';
84053    const ATTR_EMULATE_PREPARES = 0;
84054    const ATTR_ERRMODE = 0;
84055    const ATTR_FETCH_CATALOG_NAMES = 0;
84056    const ATTR_FETCH_TABLE_NAMES = 0;
84057    const ATTR_MAX_COLUMN_LEN = 0;
84058    const ATTR_ORACLE_NULLS = 0;
84059    const ATTR_PERSISTENT = 0;
84060    const ATTR_PREFETCH = 0;
84061    const ATTR_SERVER_INFO = 0;
84062    const ATTR_SERVER_VERSION = 0;
84063    const ATTR_STATEMENT_CLASS = 0;
84064    const ATTR_STRINGIFY_FETCHES = 0;
84065    const ATTR_TIMEOUT = 0;
84066    const CASE_LOWER = 0;
84067    const CASE_NATURAL = 0;
84068    const CASE_UPPER = 0;
84069    const CURSOR_FWDONLY = 0;
84070    const CURSOR_SCROLL = 0;
84071    const ERRMODE_EXCEPTION = 0;
84072    const ERRMODE_SILENT = 0;
84073    const ERRMODE_WARNING = 0;
84074    const ERR_NONE = '';
84075    const FB_ATTR_DATE_FORMAT = 0;
84076    const FB_ATTR_TIMESTAMP_FORMAT = 0;
84077    const FB_ATTR_TIME_FORMAT = 0;
84078    const FETCH_ASSOC = 0;
84079    const FETCH_BOTH = 0;
84080    const FETCH_BOUND = 0;
84081    const FETCH_CLASS = 0;
84082    const FETCH_CLASSTYPE = 0;
84083    const FETCH_COLUMN = 0;
84084    const FETCH_FUNC = 0;
84085    const FETCH_GROUP = 0;
84086    const FETCH_INTO = 0;
84087    const FETCH_KEY_PAIR = 0;
84088    const FETCH_LAZY = 0;
84089    const FETCH_NAMED = 0;
84090    const FETCH_NUM = 0;
84091    const FETCH_OBJ = 0;
84092    const FETCH_ORI_ABS = 0;
84093    const FETCH_ORI_FIRST = 0;
84094    const FETCH_ORI_LAST = 0;
84095    const FETCH_ORI_NEXT = 0;
84096    const FETCH_ORI_PRIOR = 0;
84097    const FETCH_ORI_REL = 0;
84098    const FETCH_PROPS_LATE = 0;
84099    const FETCH_SERIALIZE = 0;
84100    const FETCH_UNIQUE = 0;
84101    const MYSQL_ATTR_DIRECT_QUERY = 0;
84102    const MYSQL_ATTR_INIT_COMMAND = 0;
84103    const MYSQL_ATTR_LOCAL_INFILE = 0;
84104    const MYSQL_ATTR_MAX_BUFFER_SIZE = 0;
84105    const MYSQL_ATTR_READ_DEFAULT_FILE = 0;
84106    const MYSQL_ATTR_READ_DEFAULT_GROUP = 0;
84107    const MYSQL_ATTR_USE_BUFFERED_QUERY = 0;
84108    const NULL_EMPTY_STRING = 0;
84109    const NULL_NATURAL = 0;
84110    const NULL_TO_STRING = 0;
84111    const PARAM_BOOL = 0;
84112    const PARAM_EVT_ALLOC = 0;
84113    const PARAM_EVT_EXEC_POST = 0;
84114    const PARAM_EVT_EXEC_PRE = 0;
84115    const PARAM_EVT_FETCH_POST = 0;
84116    const PARAM_EVT_FETCH_PRE = 0;
84117    const PARAM_EVT_FREE = 0;
84118    const PARAM_EVT_NORMALIZE = 0;
84119    const PARAM_INPUT_OUTPUT = 0;
84120    const PARAM_INT = 0;
84121    const PARAM_LOB = 0;
84122    const PARAM_NULL = 0;
84123    const PARAM_STMT = 0;
84124    const PARAM_STR = 0;
84125    /**
84126     * Turns off autocommit mode. While autocommit mode is turned off,
84127     * changes made to the database via the PDO object instance are not
84128     * committed until you end the transaction by calling {@link
84129     * PDO::commit}. Calling {@link PDO::rollBack} will roll back all changes
84130     * to the database and return the connection to autocommit mode.
84131     *
84132     * Some databases, including MySQL, automatically issue an implicit
84133     * COMMIT when a database definition language (DDL) statement such as
84134     * DROP TABLE or CREATE TABLE is issued within a transaction. The
84135     * implicit COMMIT will prevent you from rolling back any other changes
84136     * within the transaction boundary.
84137     *
84138     * @return bool
84139     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84140     **/
84141    function beginTransaction();
84142
84143    /**
84144     * Commits a transaction, returning the database connection to autocommit
84145     * mode until the next call to {@link PDO::beginTransaction} starts a new
84146     * transaction.
84147     *
84148     * @return bool
84149     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84150     **/
84151    function commit();
84152
84153    /**
84154     * @return mixed
84155     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84156     **/
84157    function errorCode();
84158
84159    /**
84160     * @return array
84161     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84162     **/
84163    function errorInfo();
84164
84165    /**
84166     * {@link PDO::exec} executes an SQL statement in a single function call,
84167     * returning the number of rows affected by the statement.
84168     *
84169     * {@link PDO::exec} does not return results from a SELECT statement. For
84170     * a SELECT statement that you only need to issue once during your
84171     * program, consider issuing {@link PDO::query}. For a statement that you
84172     * need to issue multiple times, prepare a PDOStatement object with
84173     * {@link PDO::prepare} and issue the statement with {@link
84174     * PDOStatement::execute}.
84175     *
84176     * @param string $statement The SQL statement to prepare and execute.
84177     *   Data inside the query should be properly escaped.
84178     * @return int
84179     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84180     **/
84181    function exec($statement);
84182
84183    /**
84184     * This function returns the value of a database connection attribute. To
84185     * retrieve PDOStatement attributes, refer to {@link
84186     * PDOStatement::getAttribute}.
84187     *
84188     * Note that some database/driver combinations may not support all of the
84189     * database connection attributes.
84190     *
84191     * @param int $attribute One of the PDO::ATTR_* constants. The
84192     *   constants that apply to database connections are as follows:
84193     *   PDO::ATTR_AUTOCOMMIT PDO::ATTR_CASE PDO::ATTR_CLIENT_VERSION
84194     *   PDO::ATTR_CONNECTION_STATUS PDO::ATTR_DRIVER_NAME PDO::ATTR_ERRMODE
84195     *   PDO::ATTR_ORACLE_NULLS PDO::ATTR_PERSISTENT PDO::ATTR_PREFETCH
84196     *   PDO::ATTR_SERVER_INFO PDO::ATTR_SERVER_VERSION PDO::ATTR_TIMEOUT
84197     * @return mixed
84198     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.2.0
84199     **/
84200    function getAttribute($attribute);
84201
84202    /**
84203     * This function returns all currently available PDO drivers which can be
84204     * used in {@link DSN} parameter of {@link PDO::__construct}. This is a
84205     * static method.
84206     *
84207     * @return array
84208     * @since PHP 5 >= 5.1.3, PECL pdo >= 1.0.3
84209     **/
84210    function getAvailableDrivers();
84211
84212    /**
84213     * Returns the ID of the last inserted row, or the last value from a
84214     * sequence object, depending on the underlying driver. For example,
84215     * {@link PDO_PGSQL} requires you to specify the name of a sequence
84216     * object for the {@link name} parameter.
84217     *
84218     * @param string $name Name of the sequence object from which the ID
84219     *   should be returned.
84220     * @return string
84221     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84222     **/
84223    function lastInsertId($name);
84224
84225    /**
84226     * {@link PDO::pgsqlLOBCreate} creates a large object and returns the OID
84227     * of that object. You may then open a stream on the object using {@link
84228     * PDO::pgsqlLOBOpen} to read or write data to it. The OID can be stored
84229     * in columns of type OID and be used to reference the large object,
84230     * without causing the row to grow arbitrarily large. The large object
84231     * will continue to live in the database until it is removed by calling
84232     * {@link PDO::pgsqlLOBUnlink}.
84233     *
84234     * Large objects can be up to 2GB in size, but are cumbersome to use; you
84235     * need to ensure that {@link PDO::pgsqlLOBUnlink} is called prior to
84236     * deleting the last row that references its OID from your database. In
84237     * addition, large objects have no access controls. As an alternative,
84238     * try the bytea column type; recent versions of PostgreSQL allow bytea
84239     * columns of up to 1GB in size and transparently manage the storage for
84240     * optimal row size.
84241     *
84242     * @return string
84243     * @since PHP 5 >= 5.1.2, PECL pdo_pgsql >= 1.0.2
84244     **/
84245    function pgsqlLOBCreate();
84246
84247    /**
84248     * {@link PDO::pgsqlLOBOpen} opens a stream to access the data referenced
84249     * by {@link oid}. If {@link mode} is r, the stream is opened for
84250     * reading, if {@link mode} is w, then the stream will be opened for
84251     * writing. You can use all the usual filesystem functions, such as
84252     * {@link fread}, {@link fwrite} and {@link fgets} to manipulate the
84253     * contents of the stream.
84254     *
84255     * @param string $oid A large object identifier.
84256     * @param string $mode If mode is r, open the stream for reading. If
84257     *   mode is w, open the stream for writing.
84258     * @return resource
84259     * @since PHP 5 >= 5.1.2, PECL pdo_pgsql >= 1.0.2
84260     **/
84261    function pgsqlLOBOpen($oid, $mode);
84262
84263    /**
84264     * Deletes a large object from the database identified by OID.
84265     *
84266     * @param string $oid A large object identifier
84267     * @return bool
84268     * @since PHP 5 >= 5.1.2, PECL pdo_pgsql >= 1.0.2
84269     **/
84270    function pgsqlLOBUnlink($oid);
84271
84272    /**
84273     * Prepares an SQL statement to be executed by the {@link
84274     * PDOStatement::execute} method. The SQL statement can contain zero or
84275     * more named (:name) or question mark (?) parameter markers for which
84276     * real values will be substituted when the statement is executed. You
84277     * cannot use both named and question mark parameter markers within the
84278     * same SQL statement; pick one or the other parameter style. Use these
84279     * parameters to bind any user-input, do not include the user-input
84280     * directly in the query.
84281     *
84282     * You must include a unique parameter marker for each value you wish to
84283     * pass in to the statement when you call {@link PDOStatement::execute}.
84284     * You cannot use a named parameter marker of the same name twice in a
84285     * prepared statement. You cannot bind multiple values to a single named
84286     * parameter in, for example, the IN() clause of an SQL statement.
84287     *
84288     * Calling {@link PDO::prepare} and {@link PDOStatement::execute} for
84289     * statements that will be issued multiple times with different parameter
84290     * values optimizes the performance of your application by allowing the
84291     * driver to negotiate client and/or server side caching of the query
84292     * plan and meta information, and helps to prevent SQL injection attacks
84293     * by eliminating the need to manually quote the parameters.
84294     *
84295     * PDO will emulate prepared statements/bound parameters for drivers that
84296     * do not natively support them, and can also rewrite named or question
84297     * mark style parameter markers to something more appropriate, if the
84298     * driver supports one style but not the other.
84299     *
84300     * @param string $statement This must be a valid SQL statement for the
84301     *   target database server.
84302     * @param array $driver_options This array holds one or more key=>value
84303     *   pairs to set attribute values for the PDOStatement object that this
84304     *   method returns. You would most commonly use this to set the
84305     *   PDO::ATTR_CURSOR value to PDO::CURSOR_SCROLL to request a scrollable
84306     *   cursor. Some drivers have driver specific options that may be set at
84307     *   prepare-time.
84308     * @return PDOStatement
84309     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84310     **/
84311    function prepare($statement, $driver_options);
84312
84313    /**
84314     * {@link PDO::query} executes an SQL statement in a single function
84315     * call, returning the result set (if any) returned by the statement as a
84316     * PDOStatement object.
84317     *
84318     * For a query that you need to issue multiple times, you will realize
84319     * better performance if you prepare a PDOStatement object using {@link
84320     * PDO::prepare} and issue the statement with multiple calls to {@link
84321     * PDOStatement::execute}.
84322     *
84323     * If you do not fetch all of the data in a result set before issuing
84324     * your next call to {@link PDO::query}, your call may fail. Call {@link
84325     * PDOStatement::closeCursor} to release the database resources
84326     * associated with the PDOStatement object before issuing your next call
84327     * to {@link PDO::query}.
84328     *
84329     * @param string $statement The SQL statement to prepare and execute.
84330     *   Data inside the query should be properly escaped.
84331     * @return PDOStatement
84332     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.2.0
84333     **/
84334    function query($statement);
84335
84336    /**
84337     * {@link PDO::quote} places quotes around the input string (if required)
84338     * and escapes special characters within the input string, using a
84339     * quoting style appropriate to the underlying driver.
84340     *
84341     * If you are using this function to build SQL statements, you are
84342     * strongly recommended to use {@link PDO::prepare} to prepare SQL
84343     * statements with bound parameters instead of using {@link PDO::quote}
84344     * to interpolate user input into an SQL statement. Prepared statements
84345     * with bound parameters are not only more portable, more convenient,
84346     * immune to SQL injection, but are often much faster to execute than
84347     * interpolated queries, as both the server and client side can cache a
84348     * compiled form of the query.
84349     *
84350     * Not all PDO drivers implement this method (notably PDO_ODBC). Consider
84351     * using prepared statements instead.
84352     *
84353     * @param string $string The string to be quoted.
84354     * @param int $parameter_type Provides a data type hint for drivers
84355     *   that have alternate quoting styles.
84356     * @return string
84357     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.2.1
84358     **/
84359    function quote($string, $parameter_type);
84360
84361    /**
84362     * Rolls back the current transaction, as initiated by {@link
84363     * PDO::beginTransaction}. It is an error to call this method if no
84364     * transaction is active.
84365     *
84366     * If the database was set to autocommit mode, this function will restore
84367     * autocommit mode after it has rolled back the transaction.
84368     *
84369     * Some databases, including MySQL, automatically issue an implicit
84370     * COMMIT when a database definition language (DDL) statement such as
84371     * DROP TABLE or CREATE TABLE is issued within a transaction. The
84372     * implicit COMMIT will prevent you from rolling back any other changes
84373     * within the transaction boundary.
84374     *
84375     * @return bool
84376     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84377     **/
84378    function rollBack();
84379
84380    /**
84381     * Sets an attribute on the database handle. Some of the available
84382     * generic attributes are listed below; some drivers may make use of
84383     * additional driver specific attributes. PDO::ATTR_CASE: Force column
84384     * names to a specific case. PDO::CASE_LOWER: Force column names to lower
84385     * case. PDO::CASE_NATURAL: Leave column names as returned by the
84386     * database driver. PDO::CASE_UPPER: Force column names to upper case.
84387     * PDO::ATTR_ERRMODE: Error reporting. PDO::ERRMODE_SILENT: Just set
84388     * error codes. PDO::ERRMODE_WARNING: Raise E_WARNING.
84389     * PDO::ERRMODE_EXCEPTION: Throw exceptions. PDO::ATTR_ORACLE_NULLS
84390     * (available with all drivers, not just Oracle): Conversion of NULL and
84391     * empty strings. PDO::NULL_NATURAL: No conversion.
84392     * PDO::NULL_EMPTY_STRING: Empty string is converted to .
84393     * PDO::NULL_TO_STRING: NULL is converted to an empty string.
84394     * PDO::ATTR_STRINGIFY_FETCHES: Convert numeric values to strings when
84395     * fetching. Requires bool. PDO::ATTR_STATEMENT_CLASS: Set user-supplied
84396     * statement class derived from PDOStatement. Cannot be used with
84397     * persistent PDO instances. Requires array(string classname, array(mixed
84398     * constructor_args)). PDO::ATTR_TIMEOUT: Specifies the timeout duration
84399     * in seconds. Not all drivers support this option, and it's meaning may
84400     * differ from driver to driver. For example, sqlite will wait for up to
84401     * this time value before giving up on obtaining an writable lock, but
84402     * other drivers may interpret this as a connect or a read timeout
84403     * interval. Requires int. PDO::ATTR_AUTOCOMMIT (available in OCI,
84404     * Firebird and MySQL): Whether to autocommit every single statement.
84405     * PDO::MYSQL_ATTR_USE_BUFFERED_QUERY (available in MySQL): Use buffered
84406     * queries.
84407     *
84408     * @param int $attribute
84409     * @param mixed $value
84410     * @return bool
84411     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84412     **/
84413    function setAttribute($attribute, $value);
84414
84415    /**
84416     * This method is similar to except that it registers functions that can
84417     * be used to calculate a result aggregated across all the rows of a
84418     * query.
84419     *
84420     * The key difference between this method and is that two functions are
84421     * required to manage the aggregate.
84422     *
84423     * @param string $function_name The name of the function used in SQL
84424     *   statements.
84425     * @param callback $step_func Callback function called for each row of
84426     *   the result set. Your PHP function should accumulate the result and
84427     *   store it in the aggregation context. This function need to be
84428     *   defined as: step mixed{@link context} int{@link rownumber}
84429     *   mixed{@link value1} mixed{@link value2} mixed{@link ..} context will
84430     *   be for the first row; on subsequent rows it will have the value that
84431     *   was previously returned from the step function; you should use this
84432     *   to maintain the aggregate state. rownumber will hold the current row
84433     *   number.
84434     * @param callback $finalize_func Callback function to aggregate the
84435     *   "stepped" data from each row. Once all the rows have been processed,
84436     *   this function will be called and it should then take the data from
84437     *   the aggregation context and return the result. Callback functions
84438     *   should return a type understood by SQLite (i.e. scalar type). This
84439     *   function need to be defined as: fini mixed{@link context} int{@link
84440     *   rownumber} context will hold the return value from the very last
84441     *   call to the step function. rownumber will hold the number of rows
84442     *   over which the aggregate was performed. The return value of this
84443     *   function will be used as the return value for the aggregate.
84444     * @param int $num_args Hint to the SQLite parser if the callback
84445     *   function accepts a predetermined number of arguments.
84446     * @return bool
84447     * @since PHP 5 >= 5.1.0, PECL pdo_sqlite >= 1.0.0
84448     **/
84449    function sqliteCreateAggregate($function_name, $step_func, $finalize_func, $num_args);
84450
84451    /**
84452     * This method allows you to register a PHP function with SQLite as an
84453     * UDF (User Defined Function), so that it can be called from within your
84454     * SQL statements.
84455     *
84456     * The UDF can be used in any SQL statement that can call functions, such
84457     * as SELECT and UPDATE statements and also in triggers.
84458     *
84459     * @param string $function_name The name of the function used in SQL
84460     *   statements.
84461     * @param callback $callback Callback function to handle the defined
84462     *   SQL function.
84463     * @param int $num_args Hint to the SQLite parser if the callback
84464     *   function accepts a predetermined number of arguments.
84465     * @return bool
84466     * @since PHP 5 >= 5.1.0, PECL pdo_sqlite >= 1.0.0
84467     **/
84468    function sqliteCreateFunction($function_name, $callback, $num_args);
84469
84470}
84471/**
84472 * Represents an error raised by PDO. You should not throw a from your
84473 * own code. See for more information about Exceptions in PHP.
84474 **/
84475class PDOException extends RuntimeException {
84476}
84477/**
84478 * Represents a prepared statement and, after the statement is executed,
84479 * an associated result set.
84480 **/
84481class PDOStatement implements Traversable {
84482    /**
84483     * {@link PDOStatement::bindColumn} arranges to have a particular
84484     * variable bound to a given column in the result-set from a query. Each
84485     * call to {@link PDOStatement::fetch} or {@link PDOStatement::fetchAll}
84486     * will update all the variables that are bound to columns.
84487     *
84488     * @param mixed $column Number of the column (1-indexed) or name of the
84489     *   column in the result set. If using the column name, be aware that
84490     *   the name should match the case of the column, as returned by the
84491     *   driver.
84492     * @param mixed $param Name of the PHP variable to which the column
84493     *   will be bound.
84494     * @param int $type Data type of the parameter, specified by the
84495     *   PDO::PARAM_* constants.
84496     * @param int $maxlen A hint for pre-allocation.
84497     * @param mixed $driverdata Optional parameter(s) for the driver.
84498     * @return bool
84499     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84500     **/
84501    function bindColumn($column, &$param, $type, $maxlen, $driverdata){}
84502
84503    /**
84504     * Binds a PHP variable to a corresponding named or question mark
84505     * placeholder in the SQL statement that was use to prepare the
84506     * statement. Unlike {@link PDOStatement::bindValue}, the variable is
84507     * bound as a reference and will only be evaluated at the time that
84508     * {@link PDOStatement::execute} is called.
84509     *
84510     * Most parameters are input parameters, that is, parameters that are
84511     * used in a read-only fashion to build up the query. Some drivers
84512     * support the invocation of stored procedures that return data as output
84513     * parameters, and some also as input/output parameters that both send in
84514     * data and are updated to receive it.
84515     *
84516     * @param mixed $parameter Parameter identifier. For a prepared
84517     *   statement using named placeholders, this will be a parameter name of
84518     *   the form :name. For a prepared statement using question mark
84519     *   placeholders, this will be the 1-indexed position of the parameter.
84520     * @param mixed $variable Name of the PHP variable to bind to the SQL
84521     *   statement parameter.
84522     * @param int $data_type Explicit data type for the parameter using the
84523     *   PDO::PARAM_* constants. To return an INOUT parameter from a stored
84524     *   procedure, use the bitwise OR operator to set the
84525     *   PDO::PARAM_INPUT_OUTPUT bits for the {@link data_type} parameter.
84526     * @param int $length Length of the data type. To indicate that a
84527     *   parameter is an OUT parameter from a stored procedure, you must
84528     *   explicitly set the length.
84529     * @param mixed $driver_options
84530     * @return bool
84531     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84532     **/
84533    function bindParam($parameter, &$variable, $data_type, $length, $driver_options){}
84534
84535    /**
84536     * Binds a value to a corresponding named or question mark placeholder in
84537     * the SQL statement that was use to prepare the statement.
84538     *
84539     * @param mixed $parameter Parameter identifier. For a prepared
84540     *   statement using named placeholders, this will be a parameter name of
84541     *   the form :name. For a prepared statement using question mark
84542     *   placeholders, this will be the 1-indexed position of the parameter.
84543     * @param mixed $value The value to bind to the parameter.
84544     * @param int $data_type Explicit data type for the parameter using the
84545     *   PDO::PARAM_* constants.
84546     * @return bool
84547     * @since PHP 5 >= 5.1.0, PECL pdo >= 1.0.0
84548     **/
84549    function bindValue($parameter, $value, $data_type){}
84550
84551    /**
84552     * {@link PDOStatement::closeCursor} frees up the connection to the
84553     * server so that other SQL statements may be issued, but leaves the
84554     * statement in a state that enables it to be executed again.
84555     *
84556     * This method is useful for database drivers that do not support
84557     * executing a PDOStatement object when a previously executed
84558     * PDOStatement object still has unfetched rows. If your database driver
84559     * suffers from this limitation, the problem may manifest itself in an
84560     * out-of-sequence error.
84561     *
84562     * {@link PDOStatement::closeCursor} is implemented either as an optional
84563     * driver specific method (allowing for maximum efficiency), or as the
84564     * generic PDO fallback if no driver specific function is installed. The
84565     * PDO generic fallback is semantically the same as writing the following
84566     * code in your PHP script:
84567     *
84568     * <?php do { while ($stmt->fetch()) ; if (!$stmt->nextRowset()) break; }
84569     * while (true); ?>
84570     *
84571     * @return bool
84572     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.9.0
84573     **/
84574    function closeCursor(){}
84575
84576    /**
84577     * Use {@link PDOStatement::columnCount} to return the number of columns
84578     * in the result set represented by the PDOStatement object.
84579     *
84580     * If the PDOStatement object was returned from {@link PDO::query}, the
84581     * column count is immediately available.
84582     *
84583     * If the PDOStatement object was returned from {@link PDO::prepare}, an
84584     * accurate column count will not be available until you invoke {@link
84585     * PDOStatement::execute}.
84586     *
84587     * @return int
84588     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.2.0
84589     **/
84590    function columnCount(){}
84591
84592    /**
84593     * Dumps the informations contained by a prepared statement directly on
84594     * the output. It will provide the SQL query in use, the number of
84595     * parameters used (Params), the list of parameters, with their name,
84596     * type (paramtype) as an integer, their key name or position, the value,
84597     * and the position in the query (if this is supported by the PDO driver,
84598     * otherwise, it will be -1).
84599     *
84600     * This is a debug function, which dump directly the data on the normal
84601     * output.
84602     *
84603     * This will only dumps the parameters in the statement at the moment of
84604     * the dump. Extra parameters are not stored in the statement, and not
84605     * displayed.
84606     *
84607     * @return bool
84608     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.9.0
84609     **/
84610    function debugDumpParams(){}
84611
84612    /**
84613     * @return string
84614     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84615     **/
84616    function errorCode(){}
84617
84618    /**
84619     * @return array
84620     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84621     **/
84622    function errorInfo(){}
84623
84624    /**
84625     * Execute the prepared statement. If the prepared statement included
84626     * parameter markers, you must either: call {@link
84627     * PDOStatement::bindParam} to bind PHP variables to the parameter
84628     * markers: bound variables pass their value as input and receive the
84629     * output value, if any, of their associated parameter markers or pass an
84630     * array of input-only parameter values
84631     *
84632     * @param array $input_parameters An array of values with as many
84633     *   elements as there are bound parameters in the SQL statement being
84634     *   executed. All values are treated as PDO::PARAM_STR. You cannot bind
84635     *   multiple values to a single parameter; for example, you cannot bind
84636     *   two values to a single named parameter in an IN() clause.
84637     * @return bool
84638     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84639     **/
84640    function execute($input_parameters){}
84641
84642    /**
84643     * Fetches a row from a result set associated with a PDOStatement object.
84644     * The {@link fetch_style} parameter determines how PDO returns the row.
84645     *
84646     * @param int $fetch_style Controls how the next row will be returned
84647     *   to the caller. This value must be one of the PDO::FETCH_* constants,
84648     *   defaulting to PDO::FETCH_BOTH. PDO::FETCH_ASSOC: returns an array
84649     *   indexed by column name as returned in your result set
84650     *   PDO::FETCH_BOTH (default): returns an array indexed by both column
84651     *   name and 0-indexed column number as returned in your result set
84652     *   PDO::FETCH_BOUND: returns and assigns the values of the columns in
84653     *   your result set to the PHP variables to which they were bound with
84654     *   the {@link PDOStatement::bindColumn} method PDO::FETCH_CLASS:
84655     *   returns a new instance of the requested class, mapping the columns
84656     *   of the result set to named properties in the class. If {@link
84657     *   fetch_style} includes PDO::FETCH_CLASSTYPE (e.g. PDO::FETCH_CLASS |
84658     *   PDO::FETCH_CLASSTYPE) then the name of the class is determined from
84659     *   a value of the first column. PDO::FETCH_INTO: updates an existing
84660     *   instance of the requested class, mapping the columns of the result
84661     *   set to named properties in the class PDO::FETCH_LAZY: combines
84662     *   PDO::FETCH_BOTH and PDO::FETCH_OBJ, creating the object variable
84663     *   names as they are accessed PDO::FETCH_NUM: returns an array indexed
84664     *   by column number as returned in your result set, starting at column
84665     *   0 PDO::FETCH_OBJ: returns an anonymous object with property names
84666     *   that correspond to the column names returned in your result set
84667     * @param int $cursor_orientation For a PDOStatement object
84668     *   representing a scrollable cursor, this value determines which row
84669     *   will be returned to the caller. This value must be one of the
84670     *   PDO::FETCH_ORI_* constants, defaulting to PDO::FETCH_ORI_NEXT. To
84671     *   request a scrollable cursor for your PDOStatement object, you must
84672     *   set the PDO::ATTR_CURSOR attribute to PDO::CURSOR_SCROLL when you
84673     *   prepare the SQL statement with {@link PDO::prepare}.
84674     * @param int $cursor_offset For a PDOStatement object representing a
84675     *   scrollable cursor for which the cursor_orientation parameter is set
84676     *   to PDO::FETCH_ORI_ABS, this value specifies the absolute number of
84677     *   the row in the result set that shall be fetched. For a PDOStatement
84678     *   object representing a scrollable cursor for which the
84679     *   cursor_orientation parameter is set to PDO::FETCH_ORI_REL, this
84680     *   value specifies the row to fetch relative to the cursor position
84681     *   before {@link PDOStatement::fetch} was called.
84682     * @return mixed
84683     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84684     **/
84685    function fetch($fetch_style, $cursor_orientation, $cursor_offset){}
84686
84687    /**
84688     * @param int $fetch_style Controls the contents of the returned array
84689     *   as documented in {@link PDOStatement::fetch}. To return an array
84690     *   consisting of all values of a single column from the result set,
84691     *   specify PDO::FETCH_COLUMN. You can specify which column you want
84692     *   with the {@link column-index} parameter. To fetch only the unique
84693     *   values of a single column from the result set, bitwise-OR
84694     *   PDO::FETCH_COLUMN with PDO::FETCH_UNIQUE. To return an associative
84695     *   array grouped by the values of a specified column, bitwise-OR
84696     *   PDO::FETCH_COLUMN with PDO::FETCH_GROUP.
84697     * @param int $column_index Returns the indicated 0-indexed column when
84698     *   the value of {@link fetch_style} is PDO::FETCH_COLUMN.
84699     * @param array $ctor_args Arguments of custom class constructor.
84700     * @return array
84701     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84702     **/
84703    function fetchAll($fetch_style, $column_index, $ctor_args){}
84704
84705    /**
84706     * Returns a single column from the next row of a result set or if there
84707     * are no more rows.
84708     *
84709     * @param int $column_number 0-indexed number of the column you wish to
84710     *   retrieve from the row. If no value is supplied, {@link
84711     *   PDOStatement::fetchColumn} fetches the first column.
84712     * @return string
84713     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.9.0
84714     **/
84715    function fetchColumn($column_number){}
84716
84717    /**
84718     * Fetches the next row and returns it as an object. This function is an
84719     * alternative to {@link PDOStatement::fetch} with PDO::FETCH_CLASS or
84720     * PDO::FETCH_OBJ style.
84721     *
84722     * @param string $class_name Name of the created class.
84723     * @param array $ctor_args Elements of this array are passed to the
84724     *   constructor.
84725     * @return mixed
84726     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.2.4
84727     **/
84728    function fetchObject($class_name, $ctor_args){}
84729
84730    /**
84731     * Gets an attribute of the statement. Currently, no generic attributes
84732     * exist but only driver specific: PDO::ATTR_CURSOR_NAME (Firebird and
84733     * ODBC specific): Get the name of cursor for UPDATE ... WHERE CURRENT
84734     * OF.
84735     *
84736     * @param int $attribute
84737     * @return mixed
84738     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.2.0
84739     **/
84740    function getAttribute($attribute){}
84741
84742    /**
84743     * Retrieves the metadata for a 0-indexed column in a result set as an
84744     * associative array.
84745     *
84746     * @param int $column The 0-indexed column in the result set.
84747     * @return array
84748     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.2.0
84749     **/
84750    function getColumnMeta($column){}
84751
84752    /**
84753     * Some database servers support stored procedures that return more than
84754     * one rowset (also known as a result set). {@link
84755     * PDOStatement::nextRowset} enables you to access the second and
84756     * subsequent rowsets associated with a PDOStatement object. Each rowset
84757     * can have a different set of columns from the preceding rowset.
84758     *
84759     * @return bool
84760     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.2.0
84761     **/
84762    function nextRowset(){}
84763
84764    /**
84765     * {@link PDOStatement::rowCount} returns the number of rows affected by
84766     * the last DELETE, INSERT, or UPDATE statement executed by the
84767     * corresponding PDOStatement object.
84768     *
84769     * If the last SQL statement executed by the associated PDOStatement was
84770     * a SELECT statement, some databases may return the number of rows
84771     * returned by that statement. However, this behaviour is not guaranteed
84772     * for all databases and should not be relied on for portable
84773     * applications.
84774     *
84775     * @return int
84776     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.1.0
84777     **/
84778    function rowCount(){}
84779
84780    /**
84781     * Sets an attribute on the statement. Currently, no generic attributes
84782     * are set but only driver specific: PDO::ATTR_CURSOR_NAME (Firebird and
84783     * ODBC specific): Set the name of cursor for UPDATE ... WHERE CURRENT
84784     * OF.
84785     *
84786     * @param int $attribute
84787     * @param mixed $value
84788     * @return bool
84789     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.2.0
84790     **/
84791    function setAttribute($attribute, $value){}
84792
84793    /**
84794     * @param int $mode The fetch mode must be one of the PDO::FETCH_*
84795     *   constants.
84796     * @return bool
84797     * @since PHP 5 >= 5.1.0, PECL pdo >= 0.2.0
84798     **/
84799    function setFetchMode($mode){}
84800
84801}
84802class Phar extends RecursiveDirectoryIterator implements Countable, ArrayAccess {
84803    const BZ2 = 0;
84804    const COMPRESSED = 0;
84805    const GZ = 0;
84806    const MD5 = 0;
84807    const NONE = 0;
84808    const OPENSSL = 0;
84809    const PHAR = 0;
84810    const PHP = 0;
84811    const PHPS = 0;
84812    const SAME = 0;
84813    const SHA1 = 0;
84814    const SHA256 = 0;
84815    const SHA512 = 0;
84816    const TAR = 0;
84817    const ZIP = 0;
84818    /**
84819     * With this method, an empty directory is created with path dirname.
84820     * This method is similar to {@link ZipArchive::addEmptyDir}.
84821     *
84822     * @param string $dirname The name of the empty directory to create in
84823     *   the phar archive
84824     * @return void
84825     * @since Unknown
84826     **/
84827    function addEmptyDir($dirname){}
84828
84829    /**
84830     * With this method, any file or URL can be added to the tar/zip archive.
84831     * If the optional second parameter localname is specified, the file will
84832     * be stored in the archive with that name, otherwise the file parameter
84833     * is used as the path to store within the archive. URLs must have a
84834     * localname or an exception is thrown. This method is similar to {@link
84835     * ZipArchive::addFile}.
84836     *
84837     * @param string $file Full or relative path to a file on disk to be
84838     *   added to the phar archive.
84839     * @param string $localname Path that the file will be stored in the
84840     *   archive.
84841     * @return void
84842     * @since Unknown
84843     **/
84844    function addFile($file, $localname){}
84845
84846    /**
84847     * With this method, any string can be added to the phar archive. The
84848     * file will be stored in the archive with localname as its path. This
84849     * method is similar to {@link ZipArchive::addFromString}.
84850     *
84851     * @param string $localname Path that the file will be stored in the
84852     *   archive.
84853     * @param string $contents The file contents to store
84854     * @return void
84855     * @since Unknown
84856     **/
84857    function addFromString($localname, $contents){}
84858
84859    /**
84860     * Return the API version of the phar file format that will be used when
84861     * creating phars. The Phar extension supports reading API version 1.0.0
84862     * or newer. API version 1.1.0 is required for SHA-256 and SHA-512 hash,
84863     * and API version 1.1.1 is required to store empty directories.
84864     *
84865     * @return string
84866     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
84867     **/
84868    function apiVersion(){}
84869
84870    /**
84871     * Populate a tar/zip archive from directory contents. The optional
84872     * second parameter is a regular expression (pcre) that is used to
84873     * exclude files. Any filename that matches the regular expression will
84874     * be included, all others will be excluded. For more fine-grained
84875     * control, use {@link PharData::buildFromIterator}.
84876     *
84877     * @param string $base_dir The full or relative path to the directory
84878     *   that contains all files to add to the archive.
84879     * @param string $regex An optional pcre regular expression that is
84880     *   used to filter the list of files. Only file paths matching the
84881     *   regular expression will be included in the archive.
84882     * @return array
84883     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
84884     **/
84885    function buildFromDirectory($base_dir, $regex){}
84886
84887    /**
84888     * Populate a phar archive from an iterator. Two styles of iterators are
84889     * supported, iterators that map the filename within the phar to the name
84890     * of a file on disk, and iterators like DirectoryIterator that return
84891     * SplFileInfo objects. For iterators that return SplFileInfo objects,
84892     * the second parameter is required.
84893     *
84894     * @param Iterator $iter Any iterator that either associatively maps
84895     *   phar file to location or returns SplFileInfo objects
84896     * @param string $base_directory For iterators that return SplFileInfo
84897     *   objects, the portion of each file's full path to remove when adding
84898     *   to the phar archive
84899     * @return array
84900     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
84901     **/
84902    function buildFromIterator($iter, $base_directory){}
84903
84904    /**
84905     * This should be used to test whether compression is possible prior to
84906     * loading a phar archive containing compressed files.
84907     *
84908     * @param int $type Either Phar::GZ or Phar::BZ2 can be used to test
84909     *   whether compression is possible with a specific compression
84910     *   algorithm (zlib or bzip2).
84911     * @return bool
84912     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
84913     **/
84914    function canCompress($type){}
84915
84916    /**
84917     * This static method determines whether write access has been disabled
84918     * in the system php.ini via the phar.readonly ini variable.
84919     *
84920     * @return bool
84921     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
84922     **/
84923    function canWrite(){}
84924
84925    /**
84926     * For tar-based and phar-based phar archives, this method compresses the
84927     * entire archive using gzip compression or bzip2 compression. The
84928     * resulting file can be processed with the gunzip command/bunzip
84929     * command, or accessed directly and transparently with the Phar
84930     * extension.
84931     *
84932     * For Zip-based phar archives, this method fails with an exception. The
84933     * zlib extension must be enabled to compress with gzip compression, the
84934     * bzip2 extension must be enabled in order to compress with bzip2
84935     * compression. As with all functionality that modifies the contents of a
84936     * phar, the phar.readonly INI variable must be off in order to succeed.
84937     *
84938     * In addition, this method automatically renames the archive, appending
84939     * .gz, .bz2 or removing the extension if passed Phar::NONE to remove
84940     * compression. Alternatively, a file extension may be specified with the
84941     * second parameter.
84942     *
84943     * @param int $compression Compression must be one of Phar::GZ,
84944     *   Phar::BZ2 to add compression, or Phar::NONE to remove compression.
84945     * @param string $extension By default, the extension is .phar.gz or
84946     *   .phar.bz2 for compressing phar archives, and .phar.tar.gz or
84947     *   .phar.tar.bz2 for compressing tar archives. For decompressing, the
84948     *   default file extensions are .phar and .phar.tar.
84949     * @return object
84950     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
84951     **/
84952    function compress($compression, $extension){}
84953
84954    /**
84955     * This method compresses all files in the Phar archive using bzip2
84956     * compression. The bzip2 extension must be enabled to take advantage of
84957     * this feature. In addition, if any files are already compressed using
84958     * gzip compression, the zlib extension must be enabled in order to
84959     * decompress the files prior to re-compressing with bzip2 compression.
84960     * As with all functionality that modifies the contents of a phar, the
84961     * phar.readonly INI variable must be off in order to succeed.
84962     *
84963     * @return bool
84964     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
84965     **/
84966    function compressAllFilesBZIP2(){}
84967
84968    /**
84969     * For tar-based phar archives, this method compresses the entire archive
84970     * using gzip compression. The resulting file can be processed with the
84971     * gunzip command, or accessed directly and transparently with the Phar
84972     * extension.
84973     *
84974     * For Zip-based and phar-based phar archives, this method compresses all
84975     * files in the Phar archive using gzip compression. The zlib extension
84976     * must be enabled to take advantage of this feature. In addition, if any
84977     * files are already compressed using bzip2 compression, the bzip2
84978     * extension must be enabled in order to decompress the files prior to
84979     * re-compressing with gzip compression. As with all functionality that
84980     * modifies the contents of a phar, the phar.readonly INI variable must
84981     * be off in order to succeed.
84982     *
84983     * @return bool
84984     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
84985     **/
84986    function compressAllFilesGZ(){}
84987
84988    /**
84989     * For tar-based phar archives, this method throws a
84990     * BadMethodCallException, as compression of individual files within a
84991     * tar archive is not supported by the file format. Use {@link
84992     * Phar::compress} to compress an entire tar-based phar archive.
84993     *
84994     * For Zip-based and phar-based phar archives, this method compresses all
84995     * files in the Phar archive using the specified compression. The zlib or
84996     * bzip2 extensions must be enabled to take advantage of this feature. In
84997     * addition, if any files are already compressed using bzip2/zlib
84998     * compression, the respective extension must be enabled in order to
84999     * decompress the files prior to re-compressing. As with all
85000     * functionality that modifies the contents of a phar, the phar.readonly
85001     * INI variable must be off in order to succeed.
85002     *
85003     * @param int $compression Compression must be one of Phar::GZ,
85004     *   Phar::BZ2 to add compression, or Phar::NONE to remove compression.
85005     * @return void
85006     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85007     **/
85008    function compressFiles($compression){}
85009
85010    /**
85011     * This method is used to convert an executable phar archive to either a
85012     * tar or zip file. To make the tar or zip non-executable, the phar stub
85013     * and phar alias files are removed from the newly created archive.
85014     *
85015     * If no changes are specified, this method throws a
85016     * BadMethodCallException if the archive is in phar file format. For
85017     * archives in tar or zip file format, this method converts the archive
85018     * to a non-executable archive.
85019     *
85020     * If successful, the method creates a new archive on disk and returns a
85021     * PharData object. The old archive is not removed from disk, and should
85022     * be done manually after the process has finished.
85023     *
85024     * @param int $format This should be one of Phar::TAR or Phar::ZIP. If
85025     *   set to , the existing file format will be preserved.
85026     * @param int $compression This should be one of Phar::NONE for no
85027     *   whole-archive compression, Phar::GZ for zlib-based compression, and
85028     *   Phar::BZ2 for bzip-based compression.
85029     * @param string $extension This parameter is used to override the
85030     *   default file extension for a converted archive. Note that .phar
85031     *   cannot be used anywhere in the filename for a non-executable tar or
85032     *   zip archive. If converting to a tar-based phar archive, the default
85033     *   extensions are .tar, .tar.gz, and .tar.bz2 depending on specified
85034     *   compression. For zip-based archives, the default extension is .zip.
85035     * @return PharData
85036     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85037     **/
85038    function convertToData($format, $compression, $extension){}
85039
85040    /**
85041     * This method is used to convert a phar archive to another file format.
85042     * For instance, it can be used to create a tar-based executable phar
85043     * archive from a zip-based executable phar archive, or from an
85044     * executable phar archive in the phar file format. In addition, it can
85045     * be used to apply whole-archive compression to a tar or phar-based
85046     * archive.
85047     *
85048     * If no changes are specified, this method throws a
85049     * BadMethodCallException.
85050     *
85051     * If successful, the method creates a new archive on disk and returns a
85052     * Phar object. The old archive is not removed from disk, and should be
85053     * done manually after the process has finished.
85054     *
85055     * @param int $format This should be one of Phar::PHAR, Phar::TAR, or
85056     *   Phar::ZIP. If set to , the existing file format will be preserved.
85057     * @param int $compression This should be one of Phar::NONE for no
85058     *   whole-archive compression, Phar::GZ for zlib-based compression, and
85059     *   Phar::BZ2 for bzip-based compression.
85060     * @param string $extension This parameter is used to override the
85061     *   default file extension for a converted archive. Note that all zip-
85062     *   and tar-based phar archives must contain .phar in their file
85063     *   extension in order to be processed as a phar archive. If converting
85064     *   to a phar-based archive, the default extensions are .phar, .phar.gz,
85065     *   or .phar.bz2 depending on the specified compression. For tar-based
85066     *   phar archives, the default extensions are .phar.tar, .phar.tar.gz,
85067     *   and .phar.tar.bz2. For zip-based phar archives, the default
85068     *   extension is .phar.zip.
85069     * @return Phar
85070     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85071     **/
85072    function convertToExecutable($format, $compression, $extension){}
85073
85074    /**
85075     * Copy a file internal to the phar archive to another new file within
85076     * the phar. This is an object-oriented alternative to using {@link copy}
85077     * with the phar stream wrapper.
85078     *
85079     * @param string $oldfile
85080     * @param string $newfile
85081     * @return bool
85082     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85083     **/
85084    function copy($oldfile, $newfile){}
85085
85086    /**
85087     * @return int
85088     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85089     **/
85090    function count(){}
85091
85092    /**
85093     * This method is intended for creation of phar-file format-specific
85094     * stubs, and is not intended for use with tar- or zip-based phar
85095     * archives.
85096     *
85097     * Phar archives contain a bootstrap loader, or stub written in PHP that
85098     * is executed when the archive is executed in PHP either via include:
85099     * <?php include 'myphar.phar'; ?> or by simple execution: php
85100     * myphar.phar
85101     *
85102     * This method provides a simple and easy method to create a stub that
85103     * will run a startup file from the phar archive. In addition, different
85104     * files can be specified for running the phar archive from the command
85105     * line versus through a web server. The loader stub also calls {@link
85106     * Phar::interceptFileFuncs} to allow easy bundling of a PHP application
85107     * that accesses the file system. If the phar extension is not present,
85108     * the loader stub will extract the phar archive to a temporary directory
85109     * and then operate on the files. A shutdown function erases the
85110     * temporary files on exit.
85111     *
85112     * @param string $indexfile
85113     * @param string $webindexfile
85114     * @return string
85115     * @since Unknown
85116     **/
85117    function createDefaultStub($indexfile, $webindexfile){}
85118
85119    /**
85120     * For tar-based and phar-based phar archives, this method decompresses
85121     * the entire archive.
85122     *
85123     * For Zip-based phar archives, this method fails with an exception. The
85124     * zlib extension must be enabled to decompress an archive compressed
85125     * with with gzip compression, and the bzip2 extension must be enabled in
85126     * order to decompress an archive compressed with bzip2 compression. As
85127     * with all functionality that modifies the contents of a phar, the
85128     * phar.readonly INI variable must be off in order to succeed.
85129     *
85130     * In addition, this method automatically changes the file extension of
85131     * the archive, .phar by default for phar archives, or .phar.tar for
85132     * tar-based phar archives. Alternatively, a file extension may be
85133     * specified with the second parameter.
85134     *
85135     * @param string $extension For decompressing, the default file
85136     *   extensions are .phar and .phar.tar. Use this parameter to specify
85137     *   another file extension. Be aware that all executable phar archives
85138     *   must contain .phar in their filename.
85139     * @return object
85140     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85141     **/
85142    function decompress($extension){}
85143
85144    /**
85145     * For tar-based phar archives, this method throws a
85146     * BadMethodCallException, as compression of individual files within a
85147     * tar archive is not supported by the file format. Use {@link
85148     * Phar::compress} to compress an entire tar-based phar archive.
85149     *
85150     * For Zip-based and phar-based phar archives, this method decompresses
85151     * all files in the Phar archive. The zlib or bzip2 extensions must be
85152     * enabled to take advantage of this feature if any files are compressed
85153     * using bzip2/zlib compression. As with all functionality that modifies
85154     * the contents of a phar, the phar.readonly INI variable must be off in
85155     * order to succeed.
85156     *
85157     * @return bool
85158     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85159     **/
85160    function decompressFiles(){}
85161
85162    /**
85163     * Delete a file within an archive. This is the functional equivalent of
85164     * calling {@link unlink} on the stream wrapper equivalent, as shown in
85165     * the example below.
85166     *
85167     * @param string $entry Path within an archive to the file to delete.
85168     * @return bool
85169     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85170     **/
85171    function delete($entry){}
85172
85173    /**
85174     * Deletes the global metadata of the phar
85175     *
85176     * @return bool
85177     * @since PHP >= 5.3.0, PECL phar >= 1.2.0
85178     **/
85179    function delMetadata(){}
85180
85181    /**
85182     * Extract all files within a phar archive to disk. Extracted files and
85183     * directories preserve permissions as stored in the archive. The
85184     * optional parameters allow optional control over which files are
85185     * extracted, and whether existing files on disk can be overwritten. The
85186     * second parameter files can be either the name of a file or directory
85187     * to extract, or an array of names of files and directories to extract.
85188     * By default, this method will not overwrite existing files, the third
85189     * parameter can be set to true to enable overwriting of files. This
85190     * method is similar to {@link ZipArchive::extractTo}.
85191     *
85192     * @param string $pathto Path within an archive to the file to delete.
85193     * @param string|array $files The name of a file or directory to
85194     *   extract, or an array of files/directories to extract
85195     * @param bool $overwrite Set to to enable overwriting existing files
85196     * @return bool
85197     * @since Unknown
85198     **/
85199    function extractTo($pathto, $files, $overwrite){}
85200
85201    /**
85202     * Retrieve archive meta-data. Meta-data can be any PHP variable that can
85203     * be serialized.
85204     *
85205     * @return mixed
85206     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85207     **/
85208    function getMetaData(){}
85209
85210    /**
85211     * This method can be used to determine whether a phar has either had an
85212     * internal file deleted, or contents of a file changed in some way.
85213     *
85214     * @return bool
85215     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85216     **/
85217    function getModified(){}
85218
85219    /**
85220     * Returns the verification signature of a phar archive in a hexadecimal
85221     * string.
85222     *
85223     * @return array
85224     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85225     **/
85226    function getSignature(){}
85227
85228    /**
85229     * Phar archives contain a bootstrap loader, or stub written in PHP that
85230     * is executed when the archive is executed in PHP either via include:
85231     * <?php include 'myphar.phar'; ?> or by simple execution: php
85232     * myphar.phar
85233     *
85234     * @return string
85235     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85236     **/
85237    function getStub(){}
85238
85239    /**
85240     * @return array
85241     * @since PHP >= 5.3.0, PECL phar >= 1.2.0
85242     **/
85243    function getSupportedCompression(){}
85244
85245    /**
85246     * Return array of supported signature types
85247     *
85248     * @return array
85249     * @since PHP >= 5.3.0, PECL phar >= 1.1.0
85250     **/
85251    function getSupportedSignatures(){}
85252
85253    /**
85254     * Returns the API version of an opened Phar archive.
85255     *
85256     * @return string
85257     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85258     **/
85259    function getVersion(){}
85260
85261    /**
85262     * Returns whether phar has global meta-data set.
85263     *
85264     * @return bool
85265     * @since PHP >= 5.3.0, PECL phar >= 1.2.0
85266     **/
85267    function hasMetadata(){}
85268
85269    /**
85270     * instructs phar to intercept {@link fopen}, {@link readfile}, {@link
85271     * file_get_contents}, {@link opendir}, and all of the stat-related
85272     * functions. If any of these functions is called from within a phar
85273     * archive with a relative path, the call is modified to access a file
85274     * within the phar archive. Absolute paths are assumed to be attempts to
85275     * load external files from the filesystem.
85276     *
85277     * This function makes it possible to run PHP applications designed to
85278     * run off of a hard disk as a phar application.
85279     *
85280     * @return void
85281     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85282     **/
85283    function interceptFileFuncs(){}
85284
85285    /**
85286     * This method can be used to determine whether a Phar will save changes
85287     * to disk immediately, or whether a call to {@link Phar->stopBuffering}
85288     * is needed to enable saving changes.
85289     *
85290     * Phar write buffering is per-archive, buffering active for the foo.phar
85291     * Phar archive does not affect changes to the bar.phar Phar archive.
85292     *
85293     * @return bool
85294     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85295     **/
85296    function isBuffering(){}
85297
85298    /**
85299     * Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed
85300     * (.tar.gz/tar.bz and so on). Zip-based phar archives cannot be
85301     * compressed as a file, and so this method will always return if a
85302     * zip-based phar archive is queried.
85303     *
85304     * @return mixed
85305     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85306     **/
85307    function isCompressed(){}
85308
85309    /**
85310     * @param int $format Either Phar::PHAR, Phar::TAR, or Phar::ZIP to
85311     *   test for the format of the archive.
85312     * @return bool
85313     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85314     **/
85315    function isFileFormat($format){}
85316
85317    /**
85318     * Returns whether the given filename is a valid phar filename that will
85319     * be recognized as a phar archive by the phar extension. This can be
85320     * used to test a name without having to instantiate a phar archive and
85321     * catch the inevitable Exception that will be thrown if an invalid name
85322     * is specified.
85323     *
85324     * @param string $filename The name or full path to a phar archive not
85325     *   yet created
85326     * @param bool $executable This parameter determines whether the
85327     *   filename should be treated as a phar executable archive, or a data
85328     *   non-executable archive
85329     * @return bool
85330     * @since PHP >= 5.3.0, PECL phar >= 1.2.0
85331     **/
85332    function isValidPharFilename($filename, $executable){}
85333
85334    /**
85335     * This method returns if phar.readonly is 0, and the actual phar archive
85336     * on disk is not read-only.
85337     *
85338     * @return bool
85339     * @since Unknown
85340     **/
85341    function isWritable(){}
85342
85343    /**
85344     * This can be used to read the contents of an external Phar archive.
85345     * This is most useful for assigning an alias to a phar so that
85346     * subsequent references to the phar can use the shorter alias, or for
85347     * loading Phar archives that only contain data and are not intended for
85348     * execution/inclusion in PHP scripts.
85349     *
85350     * @param string $filename the full or relative path to the phar
85351     *   archive to open
85352     * @param string $alias The alias that may be used to refer to the phar
85353     *   archive. Note that many phar archives specify an explicit alias
85354     *   inside the phar archive, and a PharException will be thrown if a new
85355     *   alias is specified in this case.
85356     * @return bool
85357     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85358     **/
85359    function loadPhar($filename, $alias){}
85360
85361    /**
85362     * This static method can only be used inside a Phar archive's loader
85363     * stub in order to initialize the phar when it is directly executed, or
85364     * when it is included in another script.
85365     *
85366     * @param string $alias The alias that can be used in phar:// URLs to
85367     *   refer to this archive, rather than its full path.
85368     * @param int $dataoffset Unused variable, here for compatibility with
85369     *   PEAR's PHP_Archive.
85370     * @return bool
85371     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85372     **/
85373    function mapPhar($alias, $dataoffset){}
85374
85375    /**
85376     * Much like the unix file system concept of mounting external devices to
85377     * paths within the directory tree, {@link Phar::mount} allows referring
85378     * to external files and directories as if they were inside of an
85379     * archive. This allows powerful abstraction such as referring to
85380     * external configuration files as if they were inside the archive.
85381     *
85382     * @param string $pharpath The internal path within the phar archive to
85383     *   use as the mounted path location. If executed within a phar archive,
85384     *   this may be a relative path, otherwise this must be a full phar URL.
85385     * @param string $externalpath A path or URL to an external file or
85386     *   directory to mount within the phar archive
85387     * @return void
85388     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85389     **/
85390    function mount($pharpath, $externalpath){}
85391
85392    /**
85393     * {@link Phar::mungServer} should only be called within the stub of a
85394     * phar archive.
85395     *
85396     * Defines a list of up to 4 $_SERVER variables that should be modified
85397     * for execution. Variables that can be modified to remove traces of phar
85398     * execution are REQUEST_URI, PHP_SELF, SCRIPT_NAME and SCRIPT_FILENAME.
85399     *
85400     * On its own, this method does nothing. Only when combined with {@link
85401     * Phar::webPhar} does it take effect, and only when the requested file
85402     * is a PHP file to be parsed. Note that the PATH_INFO and
85403     * PATH_TRANSLATED variables are always modified.
85404     *
85405     * The original values of variables that are modified are stored in the
85406     * SERVER array with PHAR_ prepended, so for instance SCRIPT_NAME would
85407     * be saved as PHAR_SCRIPT_NAME.
85408     *
85409     * @param array $munglist an array containing as string indices any of
85410     *   REQUEST_URI, PHP_SELF, SCRIPT_NAME and SCRIPT_FILENAME. Other values
85411     *   trigger an exception, and {@link Phar::mungServer} is
85412     *   case-sensitive.
85413     * @return void
85414     * @since Unknown
85415     **/
85416    function mungServer($munglist){}
85417
85418    /**
85419     * This is an implementation of the ArrayAccess interface allowing direct
85420     * manipulation of the contents of a Phar archive using array access
85421     * brackets.
85422     *
85423     * offsetExists() is called whenever {@link isset} is called.
85424     *
85425     * @param string $offset The filename (relative path) to look for in a
85426     *   Phar.
85427     * @return bool
85428     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85429     **/
85430    function offsetExists($offset){}
85431
85432    /**
85433     * This is an implementation of the ArrayAccess interface allowing direct
85434     * manipulation of the contents of a Phar archive using array access
85435     * brackets. Phar::offsetGet is used for retrieving files from a Phar
85436     * archive.
85437     *
85438     * @param string $offset The filename (relative path) to look for in a
85439     *   Phar.
85440     * @return int
85441     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85442     **/
85443    function offsetGet($offset){}
85444
85445    /**
85446     * This is an implementation of the ArrayAccess interface allowing direct
85447     * manipulation of the contents of a Phar archive using array access
85448     * brackets. offsetSet is used for modifying an existing file, or adding
85449     * a new file to a Phar archive.
85450     *
85451     * @param string $offset The filename (relative path) to modify in a
85452     *   Phar.
85453     * @param string $value Content of the file.
85454     * @return void
85455     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85456     **/
85457    function offsetSet($offset, $value){}
85458
85459    /**
85460     * This is an implementation of the ArrayAccess interface allowing direct
85461     * manipulation of the contents of a Phar archive using array access
85462     * brackets. offsetUnset is used for deleting an existing file, and is
85463     * called by the {@link unset} language construct.
85464     *
85465     * @param string $offset The filename (relative path) to modify in a
85466     *   Phar.
85467     * @return bool
85468     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85469     **/
85470    function offsetUnset($offset){}
85471
85472    /**
85473     * Returns the full path to the running phar archive. This is intended
85474     * for use much like the __FILE__ magic constant, and only has effect
85475     * inside an executing phar archive.
85476     *
85477     * Inside the stub of an archive, {@link Phar::running} returns . Simply
85478     * use __FILE__ to access the current running phar inside a stub.
85479     *
85480     * @param bool $retphar If , the full path on disk to the phar archive
85481     *   is returned. If , a full phar URL is returned.
85482     * @return string
85483     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85484     **/
85485    function running($retphar){}
85486
85487    /**
85488     * Set the alias for the Phar archive, and write it as the permanent
85489     * alias for this phar archive. An alias can be used internally to a phar
85490     * archive to ensure that use of the phar stream wrapper to access
85491     * internal files always works regardless of the location of the phar
85492     * archive on the filesystem. Another alternative is to rely upon Phar's
85493     * interception of {@link include} or to use {@link
85494     * Phar::interceptFileFuncs} and use relative paths.
85495     *
85496     * @param string $alias A shorthand string that this archive can be
85497     *   referred to in phar stream wrapper access.
85498     * @return bool
85499     * @since PHP >= 5.3.0, PECL phar >= 1.2.1
85500     **/
85501    function setAlias($alias){}
85502
85503    /**
85504     * This method is a convenience method that combines the functionality of
85505     * {@link Phar::createDefaultStub} and {@link Phar::setStub}.
85506     *
85507     * @param string $index Relative path within the phar archive to run if
85508     *   accessed on the command-line
85509     * @param string $webindex Relative path within the phar archive to run
85510     *   if accessed through a web browser
85511     * @return bool
85512     * @since Unknown
85513     **/
85514    function setDefaultStub($index, $webindex){}
85515
85516    /**
85517     * {@link Phar::setMetadata} should be used to store customized data that
85518     * describes something about the phar archive as a complete entity.
85519     * {@link PharFileInfo::setMetadata} should be used for file-specific
85520     * meta-data. Meta-data can slow down the performance of loading a phar
85521     * archive if the data is large.
85522     *
85523     * Some possible uses for meta-data include specifying which file within
85524     * the archive should be used to bootstrap the archive, or the location
85525     * of a file manifest like PEAR's package.xml file. However, any useful
85526     * data that describes the phar archive may be stored.
85527     *
85528     * @param mixed $metadata Any PHP variable containing information to
85529     *   store that describes the phar archive
85530     * @return void
85531     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85532     **/
85533    function setMetadata($metadata){}
85534
85535    /**
85536     * set the signature algorithm for a phar and apply it. The signature
85537     * algorithm must be one of Phar::MD5, Phar::SHA1, Phar::SHA256,
85538     * Phar::SHA512, or Phar::PGP (pgp not yet supported and falls back to
85539     * SHA-1).
85540     *
85541     * @param int $sigtype One of Phar::MD5, Phar::SHA1, Phar::SHA256,
85542     *   Phar::SHA512, or Phar::PGP
85543     * @return void
85544     * @since PHP >= 5.3.0, PECL phar >= 1.1.0
85545     **/
85546    function setSignatureAlgorithm($sigtype){}
85547
85548    /**
85549     * This method is used to add a PHP bootstrap loader stub to a new Phar
85550     * archive, or to replace the loader stub in an existing Phar archive.
85551     *
85552     * The loader stub for a Phar archive is used whenever an archive is
85553     * included directly as in this example:
85554     *
85555     * The loader is not accessed when including a file through the phar
85556     * stream wrapper like so:
85557     *
85558     * @param string $stub A string or an open stream handle to use as the
85559     *   executable stub for this phar archive.
85560     * @return bool
85561     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85562     **/
85563    function setStub($stub){}
85564
85565    /**
85566     * Although technically unnecessary, the {@link Phar::startBuffering}
85567     * method can provide a significant performance boost when creating or
85568     * modifying a Phar archive with a large number of files. Ordinarily,
85569     * every time a file within a Phar archive is created or modified in any
85570     * way, the entire Phar archive will be recreated with the changes. In
85571     * this way, the archive will be up-to-date with the activity performed
85572     * on it.
85573     *
85574     * However, this can be unnecessary when simply creating a new Phar
85575     * archive, when it would make more sense to write the entire archive out
85576     * at once. Similarly, it is often necessary to make a series of changes
85577     * and to ensure that they all are possible before making any changes on
85578     * disk, similar to the relational database concept of transactions. the
85579     * {@link Phar::startBuffering}/{@link Phar::stopBuffering} pair of
85580     * methods is provided for this purpose.
85581     *
85582     * Phar write buffering is per-archive, buffering active for the foo.phar
85583     * Phar archive does not affect changes to the bar.phar Phar archive.
85584     *
85585     * @return void
85586     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85587     **/
85588    function startBuffering(){}
85589
85590    /**
85591     * {@link Phar::stopBuffering} is used in conjunction with the {@link
85592     * Phar::startBuffering} method. {@link Phar::startBuffering} can provide
85593     * a significant performance boost when creating or modifying a Phar
85594     * archive with a large number of files. Ordinarily, every time a file
85595     * within a Phar archive is created or modified in any way, the entire
85596     * Phar archive will be recreated with the changes. In this way, the
85597     * archive will be up-to-date with the activity performed on it.
85598     *
85599     * However, this can be unnecessary when simply creating a new Phar
85600     * archive, when it would make more sense to write the entire archive out
85601     * at once. Similarly, it is often necessary to make a series of changes
85602     * and to ensure that they all are possible before making any changes on
85603     * disk, similar to the relational database concept of transactions. The
85604     * {@link Phar::startBuffering}/{@link Phar::stopBuffering} pair of
85605     * methods is provided for this purpose.
85606     *
85607     * Phar write buffering is per-archive, buffering active for the foo.phar
85608     * Phar archive does not affect changes to the bar.phar Phar archive.
85609     *
85610     * @return void
85611     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85612     **/
85613    function stopBuffering(){}
85614
85615    /**
85616     * This method decompresses all files in the Phar archive. If any files
85617     * are already compressed using gzip compression, the zlib extension must
85618     * be enabled in order to decompress the files, and any files compressed
85619     * using bzip2 compression require the bzip2 extension to decompress the
85620     * files. As with all functionality that modifies the contents of a phar,
85621     * the phar.readonly INI variable must be off in order to succeed.
85622     *
85623     * @return bool
85624     * @since PECL phar < 2.0.0
85625     **/
85626    function uncompressAllFiles(){}
85627
85628    /**
85629     * Removes a phar archive for disk and memory.
85630     *
85631     * @param string $archive The path on disk to the phar archive.
85632     * @return bool
85633     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85634     **/
85635    function unlinkArchive($archive){}
85636
85637    /**
85638     * {@link Phar::mapPhar} for web-based phars. This method parses
85639     * $_SERVER['REQUEST_URI'] and routes a request from a web browser to an
85640     * internal file within the phar archive. In essence, it simulates a web
85641     * server, routing requests to the correct file, echoing the correct
85642     * headers and parsing PHP files as needed. This powerful method is part
85643     * of what makes it easy to convert an existing PHP application into a
85644     * phar archive. Combined with {@link Phar::mungServer} and {@link
85645     * Phar::interceptFileFuncs}, any web application can be used unmodified
85646     * from a phar archive.
85647     *
85648     * {@link Phar::webPhar} should only be called from the stub of a phar
85649     * archive (see here for more information on what a stub is).
85650     *
85651     * @param string $alias The alias that can be used in phar:// URLs to
85652     *   refer to this archive, rather than its full path.
85653     * @param string $index The location within the phar of the directory
85654     *   index.
85655     * @param string $f404 The location of the script to run when a file is
85656     *   not found. This script should output the proper HTTP 404 headers.
85657     * @param array $mimetypes An array mapping additional file extensions
85658     *   to MIME type. By default, these extensions are mapped to these mime
85659     *   types: <?php $mimes = array( 'phps' => 2, // pass to
85660     *   highlight_file() 'c' => 'text/plain', 'cc' => 'text/plain', 'cpp' =>
85661     *   'text/plain', 'c++' => 'text/plain', 'dtd' => 'text/plain', 'h' =>
85662     *   'text/plain', 'log' => 'text/plain', 'rng' => 'text/plain', 'txt' =>
85663     *   'text/plain', 'xsd' => 'text/plain', 'php' => 1, // parse as PHP
85664     *   'inc' => 1, // parse as PHP 'avi' => 'video/avi', 'bmp' =>
85665     *   'image/bmp', 'css' => 'text/css', 'gif' => 'image/gif', 'htm' =>
85666     *   'text/html', 'html' => 'text/html', 'htmls' => 'text/html', 'ico' =>
85667     *   'image/x-ico', 'jpe' => 'image/jpeg', 'jpg' => 'image/jpeg', 'jpeg'
85668     *   => 'image/jpeg', 'js' => 'application/x-javascript', 'midi' =>
85669     *   'audio/midi', 'mid' => 'audio/midi', 'mod' => 'audio/mod', 'mov' =>
85670     *   'movie/quicktime', 'mp3' => 'audio/mp3', 'mpg' => 'video/mpeg',
85671     *   'mpeg' => 'video/mpeg', 'pdf' => 'application/pdf', 'png' =>
85672     *   'image/png', 'swf' => 'application/shockwave-flash', 'tif' =>
85673     *   'image/tiff', 'tiff' => 'image/tiff', 'wav' => 'audio/wav', 'xbm' =>
85674     *   'image/xbm', 'xml' => 'text/xml', ); ?>
85675     * @param array $rewrites An array mapping URI to internal file,
85676     *   simulating mod_rewrite of apache. For example: <?php array( 'myinfo'
85677     *   => 'myinfo.php' ); ?> would route calls to
85678     *   http://<host>/myphar.phar/myinfo to the file
85679     *   phar:///path/to/myphar.phar/myinfo.php, preserving GET/POST. This
85680     *   does not quite work like mod_rewrite in that it would not match
85681     *   http://<host>/myphar.phar/myinfo/another.
85682     * @return void
85683     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85684     **/
85685    function webPhar($alias, $index, $f404, $mimetypes, $rewrites){}
85686
85687    /**
85688     * @param string $fname Path to an existing Phar archive or
85689     *   to-be-created archive
85690     * @param int $flags Flags to pass to parent class
85691     *   RecursiveDirectoryIterator.
85692     * @param string $alias Alias with which this Phar archive should be
85693     *   referred to in calls to stream functionality.
85694     * @return void
85695     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
85696     **/
85697    function __construct($fname, $flags, $alias){}
85698
85699}
85700class PharData extends Phar {
85701    /**
85702     * With this method, an empty directory is created with path dirname.
85703     * This method is similar to {@link ZipArchive::addEmptyDir}.
85704     *
85705     * @param string $dirname The name of the empty directory to create in
85706     *   the phar archive
85707     * @return bool
85708     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85709     **/
85710    function addEmptyDir($dirname){}
85711
85712    /**
85713     * With this method, any string can be added to the tar/zip archive. The
85714     * file will be stored in the archive with localname as its path. This
85715     * method is similar to {@link ZipArchive::addFromString}.
85716     *
85717     * @param string $localname Path that the file will be stored in the
85718     *   archive.
85719     * @param string $contents The file contents to store
85720     * @return bool
85721     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85722     **/
85723    function addFromString($localname, $contents){}
85724
85725    /**
85726     * Populate a tar or zip archive from an iterator. Two styles of
85727     * iterators are supported, iterators that map the filename within the
85728     * tar/zip to the name of a file on disk, and iterators like
85729     * DirectoryIterator that return SplFileInfo objects. For iterators that
85730     * return SplFileInfo objects, the second parameter is required.
85731     *
85732     * @param Iterator $iter Any iterator that either associatively maps
85733     *   tar/zip file to location or returns SplFileInfo objects
85734     * @param string $base_directory For iterators that return SplFileInfo
85735     *   objects, the portion of each file's full path to remove when adding
85736     *   to the tar/zip archive
85737     * @return array
85738     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85739     **/
85740    function buildFromIterator($iter, $base_directory){}
85741
85742    /**
85743     * For tar archives, this method compresses the entire archive using gzip
85744     * compression or bzip2 compression. The resulting file can be processed
85745     * with the gunzip command/bunzip command, or accessed directly and
85746     * transparently with the Phar extension.
85747     *
85748     * For zip archives, this method fails with an exception. The zlib
85749     * extension must be enabled to compress with gzip compression, the bzip2
85750     * extension must be enabled in order to compress with bzip2 compression.
85751     *
85752     * In addition, this method automatically renames the archive, appending
85753     * .gz, .bz2 or removing the extension if passed Phar::NONE to remove
85754     * compression. Alternatively, a file extension may be specified with the
85755     * second parameter.
85756     *
85757     * @param int $compression Compression must be one of Phar::GZ,
85758     *   Phar::BZ2 to add compression, or Phar::NONE to remove compression.
85759     * @param string $extension By default, the extension is .tar.gz or
85760     *   .tar.bz2 for compressing a tar, and .tar for decompressing.
85761     * @return object
85762     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85763     **/
85764    function compress($compression, $extension){}
85765
85766    /**
85767     * For tar-based archives, this method throws a BadMethodCallException,
85768     * as compression of individual files within a tar archive is not
85769     * supported by the file format. Use {@link PharData::compress} to
85770     * compress an entire tar-based archive.
85771     *
85772     * For Zip-based archives, this method compresses all files in the
85773     * archive using the specified compression. The zlib or bzip2 extensions
85774     * must be enabled to take advantage of this feature. In addition, if any
85775     * files are already compressed using bzip2/zlib compression, the
85776     * respective extension must be enabled in order to decompress the files
85777     * prior to re-compressing.
85778     *
85779     * @param int $compression Compression must be one of Phar::GZ,
85780     *   Phar::BZ2 to add compression, or Phar::NONE to remove compression.
85781     * @return bool
85782     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85783     **/
85784    function compressFiles($compression){}
85785
85786    /**
85787     * This method is used to convert a non-executable tar or zip archive to
85788     * another non-executable format.
85789     *
85790     * If no changes are specified, this method throws a
85791     * BadMethodCallException. This method should be used to convert a tar
85792     * archive to zip format or vice-versa. Although it is possible to simply
85793     * change the compression of a tar archive using this method, it is
85794     * better to use the {@link PharData::compress} method for logical
85795     * consistency.
85796     *
85797     * If successful, the method creates a new archive on disk and returns a
85798     * PharData object. The old archive is not removed from disk, and should
85799     * be done manually after the process has finished.
85800     *
85801     * @param int $format This should be one of Phar::TAR or Phar::ZIP. If
85802     *   set to , the existing file format will be preserved.
85803     * @param int $compression This should be one of Phar::NONE for no
85804     *   whole-archive compression, Phar::GZ for zlib-based compression, and
85805     *   Phar::BZ2 for bzip-based compression.
85806     * @param string $extension This parameter is used to override the
85807     *   default file extension for a converted archive. Note that .phar
85808     *   cannot be used anywhere in the filename for a non-executable tar or
85809     *   zip archive. If converting to a tar-based phar archive, the default
85810     *   extensions are .tar, .tar.gz, and .tar.bz2 depending on specified
85811     *   compression. For zip-based archives, the default extension is .zip.
85812     * @return PharData
85813     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85814     **/
85815    function convertToData($format, $compression, $extension){}
85816
85817    /**
85818     * This method is used to convert a non-executable tar or zip archive to
85819     * an executable phar archive. Any of the three executable file formats
85820     * (phar, tar or zip) can be used, and whole-archive compression can also
85821     * be performed.
85822     *
85823     * If no changes are specified, this method throws a
85824     * BadMethodCallException.
85825     *
85826     * If successful, the method creates a new archive on disk and returns a
85827     * Phar object. The old archive is not removed from disk, and should be
85828     * done manually after the process has finished.
85829     *
85830     * @param int $format This should be one of Phar::PHAR, Phar::TAR, or
85831     *   Phar::ZIP. If set to , the existing file format will be preserved.
85832     * @param int $compression This should be one of Phar::NONE for no
85833     *   whole-archive compression, Phar::GZ for zlib-based compression, and
85834     *   Phar::BZ2 for bzip-based compression.
85835     * @param string $extension This parameter is used to override the
85836     *   default file extension for a converted archive. Note that all zip-
85837     *   and tar-based phar archives must contain .phar in their file
85838     *   extension in order to be processed as a phar archive. If converting
85839     *   to a phar-based archive, the default extensions are .phar, .phar.gz,
85840     *   or .phar.bz2 depending on the specified compression. For tar-based
85841     *   phar archives, the default extensions are .phar.tar, .phar.tar.gz,
85842     *   and .phar.tar.bz2. For zip-based phar archives, the default
85843     *   extension is .phar.zip.
85844     * @return Phar
85845     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85846     **/
85847    function convertToExecutable($format, $compression, $extension){}
85848
85849    /**
85850     * Copy a file internal to the tar/zip archive to another new file within
85851     * the same archive. This is an object-oriented alternative to using
85852     * {@link copy} with the phar stream wrapper.
85853     *
85854     * @param string $oldfile
85855     * @param string $newfile
85856     * @return bool
85857     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85858     **/
85859    function copy($oldfile, $newfile){}
85860
85861    /**
85862     * For tar-based archives, this method decompresses the entire archive.
85863     *
85864     * For Zip-based archives, this method fails with an exception. The zlib
85865     * extension must be enabled to decompress an archive compressed with
85866     * with gzip compression, and the bzip2 extension must be enabled in
85867     * order to decompress an archive compressed with bzip2 compression.
85868     *
85869     * In addition, this method automatically renames the file extension of
85870     * the archive, .tar by default. Alternatively, a file extension may be
85871     * specified with the second parameter.
85872     *
85873     * @param string $extension For decompressing, the default file
85874     *   extension is .phar.tar. Use this parameter to specify another file
85875     *   extension. Be aware that no non-executable archives cannot contain
85876     *   .phar in their filename.
85877     * @return object
85878     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85879     **/
85880    function decompress($extension){}
85881
85882    /**
85883     * For tar-based archives, this method throws a BadMethodCallException,
85884     * as compression of individual files within a tar archive is not
85885     * supported by the file format. Use {@link PharData::compress} to
85886     * compress an entire tar-based archive.
85887     *
85888     * For Zip-based archives, this method decompresses all files in the
85889     * archive. The zlib or bzip2 extensions must be enabled to take
85890     * advantage of this feature if any files are compressed using bzip2/zlib
85891     * compression.
85892     *
85893     * @return bool
85894     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85895     **/
85896    function decompressFiles(){}
85897
85898    /**
85899     * Delete a file within an archive. This is the functional equivalent of
85900     * calling {@link unlink} on the stream wrapper equivalent, as shown in
85901     * the example below.
85902     *
85903     * @param string $entry Path within an archive to the file to delete.
85904     * @return int
85905     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85906     **/
85907    function delete($entry){}
85908
85909    /**
85910     * Deletes the global metadata of the zip archive
85911     *
85912     * @return int
85913     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85914     **/
85915    function delMetadata(){}
85916
85917    /**
85918     * Extract all files within a tar/zip archive to disk. Extracted files
85919     * and directories preserve permissions as stored in the archive. The
85920     * optional parameters allow optional control over which files are
85921     * extracted, and whether existing files on disk can be overwritten. The
85922     * second parameter files can be either the name of a file or directory
85923     * to extract, or an array of names of files and directories to extract.
85924     * By default, this method will not overwrite existing files, the third
85925     * parameter can be set to true to enable overwriting of files. This
85926     * method is similar to {@link ZipArchive::extractTo}.
85927     *
85928     * @param string $pathto Path within an archive to the file to delete.
85929     * @param string|array $files The name of a file or directory to
85930     *   extract, or an array of files/directories to extract
85931     * @param bool $overwrite Set to to enable overwriting existing files
85932     * @return int
85933     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85934     **/
85935    function extractTo($pathto, $files, $overwrite){}
85936
85937    /**
85938     * This method returns if the tar/zip archive on disk is not read-only.
85939     * Unlike {@link Phar::isWritable}, data-only tar/zip archives can be
85940     * modified even if phar.readonly is set to 1.
85941     *
85942     * @return bool
85943     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85944     **/
85945    function isWritable(){}
85946
85947    /**
85948     * This is an implementation of the ArrayAccess interface allowing direct
85949     * manipulation of the contents of a tar/zip archive using array access
85950     * brackets. offsetSet is used for modifying an existing file, or adding
85951     * a new file to a tar/zip archive.
85952     *
85953     * @param string $offset The filename (relative path) to modify in a
85954     *   tar or zip archive.
85955     * @param string $value Content of the file.
85956     * @return void
85957     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85958     **/
85959    function offsetSet($offset, $value){}
85960
85961    /**
85962     * This is an implementation of the ArrayAccess interface allowing direct
85963     * manipulation of the contents of a tar/zip archive using array access
85964     * brackets. offsetUnset is used for deleting an existing file, and is
85965     * called by the {@link unset} language construct.
85966     *
85967     * @param string $offset The filename (relative path) to modify in the
85968     *   tar/zip archive.
85969     * @return bool
85970     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85971     **/
85972    function offsetUnset($offset){}
85973
85974    /**
85975     * Non-executable tar/zip archives cannot have an alias, so this method
85976     * simply throws an exception.
85977     *
85978     * @param string $alias A shorthand string that this archive can be
85979     *   referred to in phar stream wrapper access. This parameter is
85980     *   ignored.
85981     * @return bool
85982     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85983     **/
85984    function setAlias($alias){}
85985
85986    /**
85987     * Non-executable tar/zip archives cannot have a stub, so this method
85988     * simply throws an exception.
85989     *
85990     * @param string $index Relative path within the phar archive to run if
85991     *   accessed on the command-line
85992     * @param string $webindex Relative path within the phar archive to run
85993     *   if accessed through a web browser
85994     * @return void
85995     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
85996     **/
85997    function setDefaultStub($index, $webindex){}
85998
85999    /**
86000     * Non-executable tar/zip archives cannot have a stub, so this method
86001     * simply throws an exception.
86002     *
86003     * @param string $stub A string or an open stream handle to use as the
86004     *   executable stub for this phar archive. This parameter is ignored.
86005     * @return void
86006     * @since PHP >= 5.3.0, PECL phar >= 2.0.0
86007     **/
86008    function setStub($stub){}
86009
86010    /**
86011     * @param string $fname Path to an existing tar/zip archive or
86012     *   to-be-created archive
86013     * @param int $flags Flags to pass to Phar parent class
86014     *   RecursiveDirectoryIterator.
86015     * @return void
86016     **/
86017    function __construct($fname, $flags){}
86018
86019}
86020class PharException extends Exception {
86021}
86022class PharFileInfo extends SplFileInfo {
86023    /**
86024     * {@link PharFileInfo::chmod} allows setting of the executable file
86025     * permissions bit, as well as read-only bits. Writeable bits are
86026     * ignored, and set at runtime based on the phar.readonly INI variable.
86027     * As with all functionality that modifies the contents of a phar, the
86028     * phar.readonly INI variable must be off in order to succeed if the file
86029     * is within a Phar archive. Files within PharData archives do not have
86030     * this restriction.
86031     *
86032     * @param int $permissions permissions (see {@link chmod})
86033     * @return void
86034     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
86035     **/
86036    function chmod($permissions){}
86037
86038    /**
86039     * This method compresses the file inside the Phar archive using either
86040     * bzip2 compression or zlib compression. The bzip2 or zlib extension
86041     * must be enabled to take advantage of this feature. In addition, if the
86042     * file is already compressed, the respective extension must be enabled
86043     * in order to decompress the file. As with all functionality that
86044     * modifies the contents of a phar, the phar.readonly INI variable must
86045     * be off in order to succeed if the file is within a Phar archive. Files
86046     * within PharData archives do not have this restriction.
86047     *
86048     * @param int $compression
86049     * @return bool
86050     **/
86051    function compress($compression){}
86052
86053    /**
86054     * This method decompresses the file inside the Phar archive. Depending
86055     * on how the file is compressed, the bzip2 or zlib extensions must be
86056     * enabled to take advantage of this feature. As with all functionality
86057     * that modifies the contents of a phar, the phar.readonly INI variable
86058     * must be off in order to succeed if the file is within a Phar archive.
86059     * Files within PharData archives do not have this restriction.
86060     *
86061     * @return bool
86062     **/
86063    function decompress(){}
86064
86065    /**
86066     * Deletes the metadata of the entry, if any.
86067     *
86068     * @return bool
86069     * @since PHP >= 5.3.0, PECL phar >= 1.2.0
86070     **/
86071    function delMetadata(){}
86072
86073    /**
86074     * This returns the size of the file within the Phar archive.
86075     * Uncompressed files will return the same value for getCompressedSize as
86076     * they will with {@link filesize}
86077     *
86078     * @return int
86079     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
86080     **/
86081    function getCompressedSize(){}
86082
86083    /**
86084     * This returns the {@link crc32} checksum of the file within the Phar
86085     * archive.
86086     *
86087     * @return int
86088     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
86089     **/
86090    function getCRC32(){}
86091
86092    /**
86093     * Return meta-data that was saved in the Phar archive's manifest for
86094     * this file.
86095     *
86096     * @return mixed
86097     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
86098     **/
86099    function getMetaData(){}
86100
86101    /**
86102     * This returns the flags set in the manifest for a Phar. This will
86103     * always return 0 in the current implementation.
86104     *
86105     * @return int
86106     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
86107     **/
86108    function getPharFlags(){}
86109
86110    /**
86111     * Returns the metadata of a file within a phar archive.
86112     *
86113     * @return bool
86114     * @since PHP >= 5.3.0, PECL phar >= 1.2.0
86115     **/
86116    function hasMetadata(){}
86117
86118    /**
86119     * This returns whether a file is compressed within a Phar archive with
86120     * either Gzip or Bzip2 compression.
86121     *
86122     * @param int $compression_type One of Phar::GZ or Phar::BZ2, defaults
86123     *   to any compression.
86124     * @return bool
86125     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
86126     **/
86127    function isCompressed($compression_type){}
86128
86129    /**
86130     * This returns whether a file is compressed within a Phar archive with
86131     * Bzip2 compression.
86132     *
86133     * @return bool
86134     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
86135     **/
86136    function isCompressedBZIP2(){}
86137
86138    /**
86139     * This returns whether a file is compressed within a Phar archive with
86140     * Gzip compression.
86141     *
86142     * @return bool
86143     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
86144     **/
86145    function isCompressedGZ(){}
86146
86147    /**
86148     * This returns whether a file within a Phar archive has had its CRC
86149     * verified.
86150     *
86151     * @return bool
86152     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
86153     **/
86154    function isCRCChecked(){}
86155
86156    /**
86157     * This method compresses the file inside the Phar archive using bzip2
86158     * compression. The bzip2 extension must be enabled to take advantage of
86159     * this feature. In addition, if the file is already compressed using
86160     * gzip compression, the zlib extension must be enabled in order to
86161     * decompress the file. As with all functionality that modifies the
86162     * contents of a phar, the phar.readonly INI variable must be off in
86163     * order to succeed.
86164     *
86165     * @return bool
86166     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
86167     **/
86168    function setCompressedBZIP2(){}
86169
86170    /**
86171     * This method compresses the file inside the Phar archive using gzip
86172     * compression. The zlib extension must be enabled to take advantage of
86173     * this feature. In addition, if the file is already compressed using
86174     * bzip2 compression, the bzip2 extension must be enabled in order to
86175     * decompress the file. As with all functionality that modifies the
86176     * contents of a phar, the phar.readonly INI variable must be off in
86177     * order to succeed.
86178     *
86179     * @return bool
86180     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
86181     **/
86182    function setCompressedGZ(){}
86183
86184    /**
86185     * {@link PharFileInfo::setMetaData} should only be used to store
86186     * customized data in a file that cannot be represented with existing
86187     * information stored with a file. Meta-data can significantly slow down
86188     * the performance of loading a phar archive if the data is large, or if
86189     * there are many files containing meta-data. It is important to note
86190     * that file permissions are natively supported inside a phar; it is
86191     * possible to set them with the {@link PharFileInfo::chmod} method. As
86192     * with all functionality that modifies the contents of a phar, the
86193     * phar.readonly INI variable must be off in order to succeed if the file
86194     * is within a Phar archive. Files within PharData archives do not have
86195     * this restriction.
86196     *
86197     * Some possible uses for meta-data include passing a user/group that
86198     * should be set when a file is extracted from the phar to disk. Other
86199     * uses could include explicitly specifying a MIME type to return.
86200     * However, any useful data that describes a file, but should not be
86201     * contained inside of it may be stored.
86202     *
86203     * @param mixed $metadata Any PHP variable containing information to
86204     *   store alongside a file
86205     * @return void
86206     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
86207     **/
86208    function setMetaData($metadata){}
86209
86210    /**
86211     * This method decompresses the file inside the Phar archive. Depending
86212     * on how the file is compressed, the bzip2 or zlib extensions must be
86213     * enabled to take advantage of this feature. As with all functionality
86214     * that modifies the contents of a phar, the phar.readonly INI variable
86215     * must be off in order to succeed.
86216     *
86217     * @return bool
86218     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
86219     **/
86220    function setUncompressed(){}
86221
86222    /**
86223     * This should not be called directly. Instead, a PharFileInfo object is
86224     * initialized by calling {@link Phar::offsetGet} through array access.
86225     *
86226     * @param string $entry The full url to retrieve a file. If you wish to
86227     *   retrieve the information for the file my/file.php from the phar
86228     *   boo.phar, the entry should be phar://boo.phar/my/file.php.
86229     * @return void
86230     * @since PHP >= 5.3.0, PECL phar >= 1.0.0
86231     **/
86232    function __construct($entry){}
86233
86234}
86235/**
86236 * Exception thrown when an invalid range is given.
86237 **/
86238class RangeException extends RuntimeException {
86239}
86240/**
86241 * This class represents a RAR archive, which may be formed by several
86242 * volumes (parts) and which contains a number of RAR entries (i.e.,
86243 * files, directories and other special objects such as symbolic links).
86244 *
86245 * Objects of this class can be traversed, yielding the entries stored in
86246 * the respective RAR archive. Those entries can also be obtained through
86247 * and .
86248 **/
86249class RarArchive implements Traversable {
86250    /**
86251     * Close RAR archive and free all allocated resources.
86252     *
86253     * @return bool
86254     * @since PECL rar >= 2.0.0
86255     **/
86256    function close(){}
86257
86258    /**
86259     * Get the (global) comment stored in the RAR archive. It may be up to 64
86260     * KiB long.
86261     *
86262     * @return string
86263     * @since PECL rar >= 2.0.0
86264     **/
86265    function getComment(){}
86266
86267    /**
86268     * Get entries list (files and directories) from the RAR archive.
86269     *
86270     * @return array
86271     * @since PECL rar >= 2.0.0
86272     **/
86273    function getEntries(){}
86274
86275    /**
86276     * Get entry object (file or directory) from the RAR archive.
86277     *
86278     * @param string $entryname A RarArchive object, opened with {@link
86279     *   rar_open}.
86280     * @return RarEntry
86281     * @since PECL rar >= 2.0.0
86282     **/
86283    function getEntry($entryname){}
86284
86285    /**
86286     * This function determines whether an archive is incomplete, i.e., if a
86287     * volume is missing or a volume is truncated.
86288     *
86289     * @return bool
86290     * @since PECL rar >= 3.0.0
86291     **/
86292    function isBroken(){}
86293
86294    /**
86295     * Check whether the RAR archive is solid. Individual file extraction is
86296     * slower on solid archives.
86297     *
86298     * @return bool
86299     * @since PECL rar >= 2.0.0
86300     **/
86301    function isSolid(){}
86302
86303    /**
86304     * Open specified RAR archive and return RarArchive instance representing
86305     * it.
86306     *
86307     * @param string $filename Path to the Rar archive.
86308     * @param string $password A plain password, if needed to decrypt the
86309     *   headers. It will also be used by default if encrypted files are
86310     *   found. Note that the files may have different passwords in respect
86311     *   to the headers and among them.
86312     * @param callback $volume_callback A function that receives one
86313     *   parameter – the path of the volume that was not found – and
86314     *   returns a string with the correct path for such volume or NULL if
86315     *   such volume does not exist or is not known. The programmer should
86316     *   ensure the passed function doesn't cause loops as this function is
86317     *   called repetedly if the path returned in a previous call did not
86318     *   correspond to the needed volume. Specifying this parameter omits the
86319     *   notice that would otherwise be emitted whenever a volume is not
86320     *   found; an implementation that only returns can therefore be used to
86321     *   merely omit such notices.
86322     * @return RarArchive
86323     * @since PECL rar >= 2.0.0
86324     **/
86325    function open($filename, $password, $volume_callback){}
86326
86327    /**
86328     * This method defines whether broken archives can be read or all the
86329     * operations that attempt to extract the archive entries will fail.
86330     * Broken archives are archives for which no error is detected when the
86331     * file is opened but an error occurs when reading the entries.
86332     *
86333     * @param bool $allow_broken A RarArchive object, opened with {@link
86334     *   rar_open}.
86335     * @return bool
86336     * @since PECL rar >= 3.0.0
86337     **/
86338    function setAllowBroken($allow_broken){}
86339
86340    /**
86341     * Provides a string representation for this RarArchive object. It
86342     * currently shows the full path name of the archive volume that was
86343     * opened and whether the resource is valid or was already closed through
86344     * a call to RarArchive::close.
86345     *
86346     * This method may be used only for debugging purposes, as there are no
86347     * guarantees as to which information the result contains or how it is
86348     * formatted.
86349     *
86350     * @return void
86351     * @since PECL rar >= 2.0.0
86352     **/
86353    function __toString(){}
86354
86355}
86356/**
86357 * A RAR entry, representing a directory or a compressed file inside a
86358 * RAR archive.
86359 **/
86360class RarEntry {
86361    /**
86362     * RarEntry::extract extracts the entry's data. It will create new file
86363     * in the specified {@link dir} with the name identical to the entry's
86364     * name, unless the second argument is specified. See below for more
86365     * information.
86366     *
86367     * @param string $dir Path to the directory where files should be
86368     *   extracted. This parameter is considered if and only if {@link
86369     *   filepath} is not. If both parameters are empty an extraction to the
86370     *   current directory will be attempted.
86371     * @param string $filepath Path (relative or absolute) containing the
86372     *   directory and filename of the extracted file. This parameter
86373     *   overrides both the parameter {@link dir} and the original file name.
86374     * @param string $password The password used to encrypt this entry. If
86375     *   the entry is not encrypted, this value will not be used and can be
86376     *   omitted. If this parameter is omitted and the entry is encrypted,
86377     *   the password given to {@link rar_open}, if any, will be used. If a
86378     *   wrong password is given, either explicitly or implicitly via {@link
86379     *   rar_open}, CRC checking will fail and this method will fail and
86380     *   return . If no password is given and one is required, this method
86381     *   will fail and return . You can check whether an entry is encrypted
86382     *   with RarEntry::isEncrypted.
86383     * @param bool $extended_data If , extended information such as NTFS
86384     *   ACLs and Unix owner information will be set in the extract files, as
86385     *   long as it's present in the archive.
86386     * @return bool
86387     * @since PECL rar >= 0.1
86388     **/
86389    function extract($dir, $filepath, $password, $extended_data){}
86390
86391    /**
86392     * Returns the OS-dependent attributes of the archive entry.
86393     *
86394     * @return int
86395     * @since PECL rar >= 0.1
86396     **/
86397    function getAttr(){}
86398
86399    /**
86400     * Returns an hexadecimal string representation of the CRC of the archive
86401     * entry.
86402     *
86403     * @return string
86404     * @since PECL rar >= 0.1
86405     **/
86406    function getCrc(){}
86407
86408    /**
86409     * Gets entry last modification time.
86410     *
86411     * @return string
86412     * @since PECL rar >= 0.1
86413     **/
86414    function getFileTime(){}
86415
86416    /**
86417     * Returns the code of the host OS of the archive entry.
86418     *
86419     * @return int
86420     * @since PECL rar >= 0.1
86421     **/
86422    function getHostOs(){}
86423
86424    /**
86425     * RarEntry::getMethod returns number of the method used when adding
86426     * current archive entry.
86427     *
86428     * @return int
86429     * @since PECL rar >= 0.1
86430     **/
86431    function getMethod(){}
86432
86433    /**
86434     * Returns the name (with path) of the archive entry.
86435     *
86436     * @return string
86437     * @since PECL rar >= 0.1
86438     **/
86439    function getName(){}
86440
86441    /**
86442     * Get packed size of the archive entry.
86443     *
86444     * @return int
86445     * @since PECL rar >= 0.1
86446     **/
86447    function getPackedSize(){}
86448
86449    /**
86450     * Returns a file handler that supports read operations. This handler
86451     * provides on-the-fly decompression for this entry.
86452     *
86453     * The handler is not invalidated by calling {@link rar_close}.
86454     *
86455     * @param string $password The password used to encrypt this entry. If
86456     *   the entry is not encrypted, this value will not be used and can be
86457     *   omitted. If this parameter is omitted and the entry is encrypted,
86458     *   the password given to {@link rar_open}, if any, will be used. If a
86459     *   wrong password is given, either explicitly or implicitly via {@link
86460     *   rar_open}, this method's resulting stream will produce wrong output.
86461     *   If no password is given and one is required, this method will fail
86462     *   and return . You can check whether an entry is encrypted with
86463     *   RarEntry::isEncrypted.
86464     * @return resource
86465     * @since PECL rar >= 2.0.0
86466     **/
86467    function getStream($password){}
86468
86469    /**
86470     * Get unpacked size of the archive entry.
86471     *
86472     * @return int
86473     * @since PECL rar >= 0.1
86474     **/
86475    function getUnpackedSize(){}
86476
86477    /**
86478     * Returns minimum version of RAR program (e.g. WinRAR) required to
86479     * unpack the entry. It is encoded as 10 * major version + minor version.
86480     *
86481     * @return int
86482     * @since PECL rar >= 0.1
86483     **/
86484    function getVersion(){}
86485
86486    /**
86487     * Tests whether the current entry is a directory.
86488     *
86489     * @return bool
86490     * @since PECL rar >= 2.0.0
86491     **/
86492    function isDirectory(){}
86493
86494    /**
86495     * Tests whether the current entry contents are encrypted.
86496     *
86497     * @return bool
86498     * @since PECL rar >= 2.0.0
86499     **/
86500    function isEncrypted(){}
86501
86502    /**
86503     * RarEntry::__toString returns a textual representation for this entry.
86504     * It includes whether the entry is a file or a directory (symbolic links
86505     * and other special objects will be treated as files), the UTF-8 name of
86506     * the entry and its CRC. The form and content of this representation may
86507     * be changed in the future, so they cannot be relied upon.
86508     *
86509     * @return string
86510     * @since PECL rar >= 2.0.0
86511     **/
86512    function __toString(){}
86513
86514}
86515/**
86516 * This class serves two purposes: it is the type of the exceptions
86517 * thrown by the RAR extension functions and methods and it allows,
86518 * through static methods to query and define the error behaviour of the
86519 * extension, i.e., whether exceptions are thrown or only warnings are
86520 * emitted.
86521 *
86522 * The following error codes are used:
86523 **/
86524class RarException extends Exception {
86525    /**
86526     * Checks whether the RAR functions will emit warnings and return error
86527     * values or whether they will throw exceptions in most of the
86528     * circumstances (does not include some programmatic errors such as
86529     * passing the wrong type of arguments).
86530     *
86531     * @return bool
86532     * @since PECL rar >= 2.0.0
86533     **/
86534    function isUsingExceptions(){}
86535
86536    /**
86537     * If and only if the argument is , then, instead of emitting warnings
86538     * and returning a special value indicating error when the UnRAR library
86539     * encounters an error, an exception of type RarException will be thrown.
86540     *
86541     * Exceptions will also be thrown for the following errors, which occur
86542     * outside the library (their error code will be -1):
86543     *
86544     * @param bool $using_exceptions Should be to activate exception
86545     *   throwing, to deactivate (the default).
86546     * @return void
86547     * @since PECL rar >= 2.0.0
86548     **/
86549    function setUsingExceptions($using_exceptions){}
86550
86551}
86552/**
86553 * This iterator allows to unset and modify values and keys while
86554 * iterating over Arrays and Objects in the same way as the .
86555 * Additionally it is possible to iterate over the current iterator
86556 * entry.
86557 **/
86558class RecursiveArrayIterator extends ArrayIterator implements RecursiveIterator {
86559    /**
86560     * Returns an iterator for the current iterator entry.
86561     *
86562     * @return RecursiveArrayIterator
86563     * @since PHP 5 >= 5.1.0
86564     **/
86565    function getChildren(){}
86566
86567    /**
86568     * Returns whether current entry is an array or an object for which an
86569     * iterator can be obtained via RecursiveArrayIterator::getChildren.
86570     *
86571     * @return bool
86572     * @since PHP 5 >= 5.1.0
86573     **/
86574    function hasChildren(){}
86575
86576}
86577/**
86578 * ...
86579 **/
86580class RecursiveCachingIterator extends CachingIterator implements Countable, ArrayAccess, Iterator, Traversable, OuterIterator, RecursiveIterator {
86581    /**
86582     * @return RecursiveCachingIterator
86583     * @since PHP 5 >= 5.1.0
86584     **/
86585    function getChildren(){}
86586
86587    /**
86588     * @return bool
86589     * @since PHP 5 >= 5.1.0
86590     **/
86591    function hasChildren(){}
86592
86593    /**
86594     * Constructs a new RecursiveCachingIterator, which consists of a passed
86595     * in {@link iterator}.
86596     *
86597     * @param Iterator $iterator The iterator being used.
86598     * @param string $flags The flags. Use CALL_TOSTRING to call
86599     *   RecursiveCachingIterator::__toString for every element (the
86600     *   default), and/or CATCH_GET_CHILD to catch exceptions when trying to
86601     *   get children.
86602     * @since PHP 5 >= 5.1.0
86603     **/
86604    function __construct($iterator, $flags){}
86605
86606}
86607/**
86608 * ...
86609 **/
86610class RecursiveDirectoryIterator extends DirectoryIterator implements Traversable, Iterator, RecursiveIterator {
86611    /**
86612     * @return object
86613     * @since PHP 5 >= 5.1.0
86614     **/
86615    function getChildren(){}
86616
86617    /**
86618     * Gets the sub path.
86619     *
86620     * @return string
86621     * @since PHP 5 >= 5.1.0
86622     **/
86623    function getSubPath(){}
86624
86625    /**
86626     * Gets the sub path and filename.
86627     *
86628     * @return string
86629     * @since PHP 5 >= 5.1.0
86630     **/
86631    function getSubPathname(){}
86632
86633    /**
86634     * @param bool $allow_links
86635     * @return bool
86636     * @since PHP 5
86637     **/
86638    function hasChildren($allow_links){}
86639
86640    /**
86641     * @return string
86642     * @since PHP 5
86643     **/
86644    function key(){}
86645
86646    /**
86647     * @return void
86648     * @since PHP 5
86649     **/
86650    function next(){}
86651
86652    /**
86653     * @return void
86654     * @since PHP 5
86655     **/
86656    function rewind(){}
86657
86658    /**
86659     * Constructs a RecursiveDirectoryIterator.
86660     *
86661     * @param string $path Directory path.
86662     * @param string $flags Optional flags.
86663     * @since PHP 5 >= 5.1.2
86664     **/
86665    function __construct($path, $flags){}
86666
86667}
86668/**
86669 * This abstract iterator filters out unwanted values for a . This class
86670 * should be extended to implement custom filters. The must be
86671 * implemented in the subclass.
86672 **/
86673class RecursiveFilterIterator extends FilterIterator implements Iterator, Traversable, OuterIterator, RecursiveIterator {
86674    /**
86675     * Return the inner iterator's children contained in a
86676     * RecursiveFilterIterator.
86677     *
86678     * @return void
86679     * @since PHP 5 >= 5.1.0
86680     **/
86681    function getChildren(){}
86682
86683    /**
86684     * Check whether the inner iterator's current element has children.
86685     *
86686     * @return void
86687     * @since PHP 5 >= 5.1.0
86688     **/
86689    function hasChildren(){}
86690
86691    /**
86692     * Create a RecursiveFilterIterator from a RecursiveIterator.
86693     *
86694     * @param RecursiveIterator $iterator The RecursiveIterator to be
86695     *   filtered.
86696     * @since PHP 5 >= 5.1.0
86697     **/
86698    function __construct($iterator){}
86699
86700}
86701/**
86702 * Classes implementing can be used to iterate over iterators
86703 * recursively.
86704 **/
86705interface RecursiveIterator extends Iterator {
86706    /**
86707     * Returns an iterator for the current iterator entry.
86708     *
86709     * @return RecursiveIterator
86710     * @since PHP 5 >= 5.1.0
86711     **/
86712    function getChildren();
86713
86714    /**
86715     * Returns if an iterator can be created fot the current entry.
86716     * RecursiveIterator::getChildren.
86717     *
86718     * @return bool
86719     * @since PHP 5 >= 5.1.0
86720     **/
86721    function hasChildren();
86722
86723}
86724/**
86725 * Can be used to iterate through recursive iterators.
86726 **/
86727class RecursiveIteratorIterator implements OuterIterator, Traversable, Iterator {
86728    const CHILD_FIRST = 0;
86729    const LEAVES_ONLY = 0;
86730    const SELF_FIRST = 0;
86731    /**
86732     * Is called after calling RecursiveIteratorIterator::getChildren, and
86733     * its associated RecursiveIteratorIterator::rewind.
86734     *
86735     * @return void
86736     * @since PHP 5 >= 5.1.0
86737     **/
86738    function beginChildren(){}
86739
86740    /**
86741     * Called when iteration begins (after the first
86742     * RecursiveIteratorIterator::rewind call.
86743     *
86744     * @return void
86745     * @since PHP 5 >= 5.1.0
86746     **/
86747    function beginIteration(){}
86748
86749    /**
86750     * Get children of the current element.
86751     *
86752     * @return RecursiveIterator
86753     * @since PHP 5 >= 5.1.0
86754     **/
86755    function callGetChildren(){}
86756
86757    /**
86758     * Called for each element to test whether it has children.
86759     *
86760     * @return bool
86761     * @since PHP 5 >= 5.1.0
86762     **/
86763    function callHasChildren(){}
86764
86765    /**
86766     * @return mixed
86767     * @since PHP 5
86768     **/
86769    function current(){}
86770
86771    /**
86772     * Called when end recursing one level.
86773     *
86774     * @return void
86775     * @since PHP 5 >= 5.1.0
86776     **/
86777    function endChildren(){}
86778
86779    /**
86780     * Called when the iteration ends (when RecursiveIteratorIterator::valid
86781     * first returns .
86782     *
86783     * @return void
86784     * @since PHP 5 >= 5.1.0
86785     **/
86786    function endIteration(){}
86787
86788    /**
86789     * @return int
86790     * @since PHP 5
86791     **/
86792    function getDepth(){}
86793
86794    /**
86795     * Gets the current active sub iterator.
86796     *
86797     * @return iterator
86798     * @since PHP 5 >= 5.1.0
86799     **/
86800    function getInnerIterator(){}
86801
86802    /**
86803     * Gets the maximum allowable depth.
86804     *
86805     * @return mixed
86806     * @since PHP 5 >= 5.1.0
86807     **/
86808    function getMaxDepth(){}
86809
86810    /**
86811     * @return RecursiveIterator
86812     * @since PHP 5
86813     **/
86814    function getSubIterator(){}
86815
86816    /**
86817     * @return mixed
86818     * @since PHP 5
86819     **/
86820    function key(){}
86821
86822    /**
86823     * @return void
86824     * @since PHP 5
86825     **/
86826    function next(){}
86827
86828    /**
86829     * Called when the next element is available.
86830     *
86831     * @return void
86832     * @since PHP 5 >= 5.1.0
86833     **/
86834    function nextElement(){}
86835
86836    /**
86837     * @return void
86838     * @since PHP 5
86839     **/
86840    function rewind(){}
86841
86842    /**
86843     * Set the maximum allowed depth.
86844     *
86845     * @param string $max_depth The maximum allowed depth. -1 is used for
86846     *   any depth.
86847     * @return void
86848     * @since PHP 5 >= 5.1.0
86849     **/
86850    function setMaxDepth($max_depth){}
86851
86852    /**
86853     * @return bool
86854     * @since PHP 5
86855     **/
86856    function valid(){}
86857
86858    /**
86859     * Creates a RecursiveIteratorIterator from a RecursiveIterator.
86860     *
86861     * @param Traversable $iterator The iterator being constructed from,
86862     *   which is from a RecursiveIterator or IteratorAggregate.
86863     * @param int $mode The mode. Options are LEAVES_ONLY (default),
86864     *   SELF_FIRST and CHILD_FIRST.
86865     * @param int $flags
86866     * @since PHP 5 >= 5.1.3
86867     **/
86868    function __construct($iterator, $mode, $flags){}
86869
86870}
86871/**
86872 * This recursive iterator can filter another recursive iterator via a
86873 * regular expression.
86874 **/
86875class RecursiveRegexIterator extends RegexIterator implements RecursiveIterator {
86876    /**
86877     * Returns an iterator for the current iterator entry.
86878     *
86879     * @return RecursiveRegexIterator
86880     * @since PHP 5 >= 5.2.0
86881     **/
86882    function getChildren(){}
86883
86884    /**
86885     * Returns whether an iterator can be obtained for the current entry.
86886     * This iterator can be obtained via RecursiveRegexIterator::getChildren.
86887     *
86888     * @return bool
86889     * @since PHP 5 >= 5.2.0
86890     **/
86891    function hasChildren(){}
86892
86893}
86894/**
86895 * Allows iterating over a to generate an ASCII graphic tree.
86896 **/
86897class RecursiveTreeIterator extends RecursiveIteratorIterator implements OuterIterator, Traversable, Iterator {
86898    /**
86899     * Called when recursing one level down.
86900     *
86901     * @return void
86902     * @since PHP 5 >= 5.3.0
86903     **/
86904    function beginChildren(){}
86905
86906    /**
86907     * Called when iteration begins (after the first
86908     * RecursiveTreeIterator::rewind call).
86909     *
86910     * @return RecursiveIterator
86911     * @since PHP 5 >= 5.3.0
86912     **/
86913    function beginIteration(){}
86914
86915    /**
86916     * Gets children of the current element.
86917     *
86918     * @return RecursiveIterator
86919     * @since PHP 5 >= 5.3.0
86920     **/
86921    function callGetChildren(){}
86922
86923    /**
86924     * Called for each element to test whether it has children.
86925     *
86926     * @return bool
86927     * @since PHP 5 >= 5.3.0
86928     **/
86929    function callHasChildren(){}
86930
86931    /**
86932     * Gets the current element prefixed and postfixed.
86933     *
86934     * @return string
86935     * @since PHP 5 >= 5.3.0
86936     **/
86937    function current(){}
86938
86939    /**
86940     * Called when end recursing one level.
86941     *
86942     * @return void
86943     * @since PHP 5 >= 5.3.0
86944     **/
86945    function endChildren(){}
86946
86947    /**
86948     * Called when the iteration ends (when RecursiveTreeIterator::valid
86949     * first returns )
86950     *
86951     * @return void
86952     * @since PHP 5 >= 5.3.0
86953     **/
86954    function endIteration(){}
86955
86956    /**
86957     * Gets the part of the tree built for the current element.
86958     *
86959     * @return string
86960     * @since PHP 5 >= 5.3.0
86961     **/
86962    function getEntry(){}
86963
86964    /**
86965     * Gets the string to place after the current element.
86966     *
86967     * @return void
86968     * @since PHP 5 >= 5.3.0
86969     **/
86970    function getPostfix(){}
86971
86972    /**
86973     * Gets the string to place in front of current element
86974     *
86975     * @return string
86976     * @since PHP 5 >= 5.3.0
86977     **/
86978    function getPrefix(){}
86979
86980    /**
86981     * Gets the current key prefixed and postfixed.
86982     *
86983     * @return string
86984     * @since PHP 5 >= 5.3.0
86985     **/
86986    function key(){}
86987
86988    /**
86989     * Moves forward to the next element.
86990     *
86991     * @return void
86992     * @since PHP 5 >= 5.3.0
86993     **/
86994    function next(){}
86995
86996    /**
86997     * Called when the next element is available.
86998     *
86999     * @return void
87000     * @since PHP 5 >= 5.3.0
87001     **/
87002    function nextElement(){}
87003
87004    /**
87005     * Rewinds the iterator to the first element of the top level inner
87006     * iterator.
87007     *
87008     * @return void
87009     * @since PHP 5 >= 5.3.0
87010     **/
87011    function rewind(){}
87012
87013    /**
87014     * Sets a part of the prefix used in the graphic tree.
87015     *
87016     * @param int $part One of the RecursiveTreeIterator::PREFIX_*
87017     *   constants.
87018     * @param string $value The value to assign to the part of the prefix
87019     *   specified in {@link part}.
87020     * @return void
87021     * @since PHP 5 >= 5.3.0
87022     **/
87023    function setPrefixPart($part, $value){}
87024
87025    /**
87026     * Check whether the current position is valid.
87027     *
87028     * @return bool
87029     * @since PHP 5 >= 5.3.0
87030     **/
87031    function valid(){}
87032
87033    /**
87034     * Constructs a new RecursiveTreeIterator from the supplied recursive
87035     * iterator.
87036     *
87037     * @param RecursiveIterator|IteratorAggregate $it The RecursiveIterator
87038     *   or IteratorAggregate to iterate over.
87039     * @param int $flags Flags may be provided which will affect the
87040     *   behavior of some methods. A list of the flags can found under
87041     *   RecursiveTreeIterator predefined constants.
87042     * @param int $cit_flags Flags to affect the behavior of the
87043     *   RecursiveCachingIterator used internally.
87044     * @param int $mode Flags to affect the behavior of the
87045     *   RecursiveIteratorIterator used internally.
87046     * @since PHP 5 >= 5.3.0
87047     **/
87048    function __construct($it, $flags, $cit_flags, $mode){}
87049
87050}
87051/**
87052 * The reflection class.
87053 **/
87054class Reflection {
87055    /**
87056     * Exports a reflection.
87057     *
87058     * @param Reflector $reflector
87059     * @param string $return
87060     * @return void
87061     * @since PHP 5
87062     **/
87063    function export($reflector, $return){}
87064
87065    /**
87066     * Gets modifier names.
87067     *
87068     * @param int $modifiers The modifiers to get, which is from a numeric
87069     *   value.
87070     * @return array
87071     * @since PHP 5
87072     **/
87073    function getModifierNames($modifiers){}
87074
87075}
87076/**
87077 * The class reports information about a class.
87078 **/
87079class ReflectionClass implements Reflector {
87080    /**
87081     * Exports a reflected class.
87082     *
87083     * @param mixed $argument
87084     * @param bool $return
87085     * @return string
87086     * @since PHP 5
87087     **/
87088    function export($argument, $return){}
87089
87090    /**
87091     * Gets the defined constants.
87092     *
87093     * @param string $name
87094     * @return mixed
87095     * @since PHP 5
87096     **/
87097    function getConstant($name){}
87098
87099    /**
87100     * Gets defined constants from a class.
87101     *
87102     * @return array
87103     * @since PHP 5
87104     **/
87105    function getConstants(){}
87106
87107    /**
87108     * Gets the constructor from a class.
87109     *
87110     * @return object
87111     * @since PHP 5
87112     **/
87113    function getConstructor(){}
87114
87115    /**
87116     * Gets default properties from a class.
87117     *
87118     * @return array
87119     * @since PHP 5
87120     **/
87121    function getDefaultProperties(){}
87122
87123    /**
87124     * Gets doc comments from a class.
87125     *
87126     * @return string
87127     * @since PHP 5 >= 5.1.0
87128     **/
87129    function getDocComment(){}
87130
87131    /**
87132     * Gets end line number from a user-defined class definition.
87133     *
87134     * @return int
87135     * @since PHP 5
87136     **/
87137    function getEndLine(){}
87138
87139    /**
87140     * Gets an extensions ReflectionExtension object.
87141     *
87142     * @return ReflectionExtension
87143     * @since PHP 5
87144     **/
87145    function getExtension(){}
87146
87147    /**
87148     * Gets an extensions name.
87149     *
87150     * @return string
87151     * @since PHP 5
87152     **/
87153    function getExtensionName(){}
87154
87155    /**
87156     * Gets a filename.
87157     *
87158     * @return string
87159     * @since PHP 5
87160     **/
87161    function getFileName(){}
87162
87163    /**
87164     * Get the interface names.
87165     *
87166     * @return array
87167     * @since PHP 5
87168     **/
87169    function getInterfaceNames(){}
87170
87171    /**
87172     * Gets the interfaces.
87173     *
87174     * @return array
87175     * @since PHP 5
87176     **/
87177    function getInterfaces(){}
87178
87179    /**
87180     * Gets a ReflectionMethod about a method.
87181     *
87182     * @param string $name The method name to reflect.
87183     * @return object
87184     * @since PHP 5
87185     **/
87186    function getMethod($name){}
87187
87188    /**
87189     * Gets a list of methods.
87190     *
87191     * @param string $filter Any combination of
87192     *   ReflectionMethod::IS_STATIC, ReflectionMethod::IS_PUBLIC,
87193     *   ReflectionMethod::IS_PROTECTED, ReflectionMethod::IS_PRIVATE,
87194     *   ReflectionMethod::IS_ABSTRACT, ReflectionMethod::IS_FINAL.
87195     * @return array
87196     * @since PHP 5
87197     **/
87198    function getMethods($filter){}
87199
87200    /**
87201     * @return int
87202     * @since PHP 5
87203     **/
87204    function getModifiers(){}
87205
87206    /**
87207     * Gets the class name.
87208     *
87209     * @return string
87210     * @since PHP 5
87211     **/
87212    function getName(){}
87213
87214    /**
87215     * Gets the namespace name.
87216     *
87217     * @return string
87218     * @since PHP 5 >= 5.3.0
87219     **/
87220    function getNamespaceName(){}
87221
87222    /**
87223     * @return object
87224     * @since PHP 5
87225     **/
87226    function getParentClass(){}
87227
87228    /**
87229     * Retrieves reflected properties.
87230     *
87231     * @param int $filter The optional filter, for filtering desired
87232     *   property types. It's configured using the ReflectionProperty
87233     *   constants, and defaults to all property types.
87234     * @return array
87235     * @since PHP 5
87236     **/
87237    function getProperties($filter){}
87238
87239    /**
87240     * Gets a property.
87241     *
87242     * @param string $name The property name.
87243     * @return ReflectionProperty
87244     * @since PHP 5
87245     **/
87246    function getProperty($name){}
87247
87248    /**
87249     * Gets the short name of the class, the part without the namespace.
87250     *
87251     * @return string
87252     * @since PHP 5 >= 5.3.0
87253     **/
87254    function getShortName(){}
87255
87256    /**
87257     * Get the starting line number.
87258     *
87259     * @return int
87260     * @since PHP 5
87261     **/
87262    function getStartLine(){}
87263
87264    /**
87265     * Get the static properties.
87266     *
87267     * @return array
87268     * @since PHP 5
87269     **/
87270    function getStaticProperties(){}
87271
87272    /**
87273     * Gets the static property values.
87274     *
87275     * @param string $name
87276     * @param string $default
87277     * @return mixed
87278     * @since PHP 5 >= 5.1.0
87279     **/
87280    function getStaticPropertyValue($name, $default){}
87281
87282    /**
87283     * Checks whether the class has a specific constant defined or not.
87284     *
87285     * @param string $name The name of the constant being checked for.
87286     * @return bool
87287     * @since PHP 5 >= 5.1.0
87288     **/
87289    function hasConstant($name){}
87290
87291    /**
87292     * Checks whether a specific method is defined in a class.
87293     *
87294     * @param string $name Name of the method being checked for.
87295     * @return bool
87296     * @since PHP 5 >= 5.1.0
87297     **/
87298    function hasMethod($name){}
87299
87300    /**
87301     * Checks whether the specified property is defined.
87302     *
87303     * @param string $name Name of the property being checked for.
87304     * @return bool
87305     * @since PHP 5 >= 5.1.0
87306     **/
87307    function hasProperty($name){}
87308
87309    /**
87310     * Checks whether it implements an interface.
87311     *
87312     * @param string $interface The interface name.
87313     * @return bool
87314     * @since PHP 5
87315     **/
87316    function implementsInterface($interface){}
87317
87318    /**
87319     * Checks if this class is defined in a namespace.
87320     *
87321     * @return bool
87322     * @since PHP 5 >= 5.3.0
87323     **/
87324    function inNamespace(){}
87325
87326    /**
87327     * Checks if the class is abstract.
87328     *
87329     * @return bool
87330     * @since PHP 5
87331     **/
87332    function isAbstract(){}
87333
87334    /**
87335     * Checks if a class is final.
87336     *
87337     * @return bool
87338     * @since PHP 5
87339     **/
87340    function isFinal(){}
87341
87342    /**
87343     * Checks if an object is an instance of a class.
87344     *
87345     * @param object $object The object being compared to.
87346     * @return bool
87347     * @since PHP 5
87348     **/
87349    function isInstance($object){}
87350
87351    /**
87352     * Checks if the class is instanciable.
87353     *
87354     * @return bool
87355     * @since PHP 5
87356     **/
87357    function isInstantiable(){}
87358
87359    /**
87360     * Checks whether the class is an interface.
87361     *
87362     * @return bool
87363     * @since PHP 5
87364     **/
87365    function isInterface(){}
87366
87367    /**
87368     * Checks whether the class is internal, as opposed to user-defined.
87369     *
87370     * @return bool
87371     * @since PHP 5
87372     **/
87373    function isInternal(){}
87374
87375    /**
87376     * Checks whether the class is iterateable.
87377     *
87378     * @return bool
87379     * @since PHP 5
87380     **/
87381    function isIterateable(){}
87382
87383    /**
87384     * Checks if the class is a subclass of a specified class.
87385     *
87386     * @param string $class The class name being checked against.
87387     * @return bool
87388     * @since PHP 5
87389     **/
87390    function isSubclassOf($class){}
87391
87392    /**
87393     * Checks whether the class is user-defined, as opposed to internal.
87394     *
87395     * @return bool
87396     * @since PHP 5
87397     **/
87398    function isUserDefined(){}
87399
87400    /**
87401     * A new instance.
87402     *
87403     * @param mixed $args Accepts a variable number of arguments which are
87404     *   passed to the function much like {@link call_user_func}.
87405     * @return object
87406     * @since PHP 5
87407     **/
87408    function newInstance($args){}
87409
87410    /**
87411     * New instance args.
87412     *
87413     * @param array $args
87414     * @return object
87415     * @since PHP 5 >= 5.1.3
87416     **/
87417    function newInstanceArgs($args){}
87418
87419    /**
87420     * Sets static property value.
87421     *
87422     * @param string $name Property name.
87423     * @param string $value New property value.
87424     * @return void
87425     * @since PHP 5 >= 5.1.0
87426     **/
87427    function setStaticPropertyValue($name, $value){}
87428
87429    /**
87430     * Clones.
87431     *
87432     * @return void
87433     * @since PHP 5
87434     **/
87435    function __clone(){}
87436
87437    /**
87438     * Constructs a new ReflectionClass object.
87439     *
87440     * @param string $argument The class being reflected.
87441     * @since PHP 5
87442     **/
87443    function __construct($argument){}
87444
87445    /**
87446     * To a string.
87447     *
87448     * @return string
87449     * @since PHP 5
87450     **/
87451    function __toString(){}
87452
87453}
87454/**
87455 * The ReflectionException class.
87456 **/
87457class ReflectionException extends Exception {
87458}
87459/**
87460 * The class reports information about an extension.
87461 **/
87462class ReflectionExtension implements Reflector {
87463    /**
87464     * Exports a reflected extension. The output format of this function is
87465     * the same as the CLI argument --re [extension].
87466     *
87467     * @param string $name
87468     * @param string $return
87469     * @return string
87470     * @since PHP 5
87471     **/
87472    function export($name, $return){}
87473
87474    /**
87475     * Gets a list of classes from an extension.
87476     *
87477     * @return array
87478     * @since PHP 5
87479     **/
87480    function getClasses(){}
87481
87482    /**
87483     * Gets a listing of class names as defined in the extension.
87484     *
87485     * @return array
87486     * @since PHP 5
87487     **/
87488    function getClassNames(){}
87489
87490    /**
87491     * Get defined constants from an extension.
87492     *
87493     * @return array
87494     * @since PHP 5
87495     **/
87496    function getConstants(){}
87497
87498    /**
87499     * Gets dependencies, by listing both required and conflicting
87500     * dependencies.
87501     *
87502     * @return array
87503     * @since PHP 5
87504     **/
87505    function getDependencies(){}
87506
87507    /**
87508     * Get defined functions from an extension.
87509     *
87510     * @return array
87511     * @since PHP 5
87512     **/
87513    function getFunctions(){}
87514
87515    /**
87516     * Get the ini entries for an extension.
87517     *
87518     * @return array
87519     * @since PHP 5
87520     **/
87521    function getINIEntries(){}
87522
87523    /**
87524     * Gets the extensions name.
87525     *
87526     * @return string
87527     * @since PHP 5
87528     **/
87529    function getName(){}
87530
87531    /**
87532     * Gets the version of the extension.
87533     *
87534     * @return string
87535     * @since PHP 5
87536     **/
87537    function getVersion(){}
87538
87539    /**
87540     * Gets information about an extension.
87541     *
87542     * @return string
87543     * @since PHP 5
87544     **/
87545    function info(){}
87546
87547    /**
87548     * The clone method prevents an object from being cloned. Reflection
87549     * objects cannot be cloned.
87550     *
87551     * @return void
87552     * @since PHP 5
87553     **/
87554    function __clone(){}
87555
87556    /**
87557     * Construct a ReflectionExtension object.
87558     *
87559     * @param string $name Name of the extension.
87560     * @since PHP 5
87561     **/
87562    function __construct($name){}
87563
87564    /**
87565     * Exports a reflected extension and returns it as a string. This is the
87566     * same as the ReflectionExtension::export with the {@link return} set to
87567     * .
87568     *
87569     * @return string
87570     * @since PHP 5
87571     **/
87572    function __toString(){}
87573
87574}
87575/**
87576 * The class reports information about a function.
87577 *
87578 * Parent class has the same methods except , , and .
87579 **/
87580class ReflectionFunction extends ReflectionFunctionAbstract implements Reflector {
87581    /**
87582     * Exports a Reflected function.
87583     *
87584     * @param string $name
87585     * @param string $return
87586     * @return string
87587     * @since PHP 5
87588     **/
87589    function export($name, $return){}
87590
87591    /**
87592     * Invokes a reflected function.
87593     *
87594     * @param string $args The passed in argument list. It accepts a
87595     *   variable number of arguments which are passed to the function much
87596     *   like {@link call_user_func} is.
87597     * @return mixed
87598     * @since PHP 5
87599     **/
87600    function invoke($args){}
87601
87602    /**
87603     * Invokes args.
87604     *
87605     * @param array $args The args to invoke.
87606     * @return mixed
87607     * @since PHP 5 >= 5.1.0
87608     **/
87609    function invokeArgs($args){}
87610
87611    /**
87612     * Checks if the function is disabled, via the disable_functions
87613     * directive.
87614     *
87615     * @return bool
87616     * @since PHP 5
87617     **/
87618    function isDisabled(){}
87619
87620    /**
87621     * Constructs a ReflectionFunction object.
87622     *
87623     * @param string $name The name of the function to reflect.
87624     * @since PHP 5
87625     **/
87626    function __construct($name){}
87627
87628    /**
87629     * To string.
87630     *
87631     * @return string
87632     * @since PHP 5
87633     **/
87634    function __toString(){}
87635
87636}
87637/**
87638 * A parent class to , read its description for details.
87639 **/
87640class ReflectionFunctionAbstract implements Reflector {
87641    /**
87642     * Get a Doc comment from a function.
87643     *
87644     * @return string
87645     * @since PHP 5 >= 5.1.0
87646     **/
87647    function getDocComment(){}
87648
87649    /**
87650     * Get the ending line number.
87651     *
87652     * @return int
87653     * @since PHP 5
87654     **/
87655    function getEndLine(){}
87656
87657    /**
87658     * Get the extension information of a function.
87659     *
87660     * @return ReflectionExtension
87661     * @since PHP 5
87662     **/
87663    function getExtension(){}
87664
87665    /**
87666     * Get the extensions name.
87667     *
87668     * @return string
87669     * @since PHP 5
87670     **/
87671    function getExtensionName(){}
87672
87673    /**
87674     * Gets the file name from a user-defined function.
87675     *
87676     * @return string
87677     * @since PHP 5
87678     **/
87679    function getFileName(){}
87680
87681    /**
87682     * Get the name of the function.
87683     *
87684     * @return string
87685     * @since PHP 5
87686     **/
87687    function getName(){}
87688
87689    /**
87690     * Get the namespace name where the class is defined.
87691     *
87692     * @return string
87693     * @since PHP 5 >= 5.3.0
87694     **/
87695    function getNamespaceName(){}
87696
87697    /**
87698     * Get the number of parameters that a function defines, both optional
87699     * and required.
87700     *
87701     * @return int
87702     * @since PHP 5 >= 5.0.3
87703     **/
87704    function getNumberOfParameters(){}
87705
87706    /**
87707     * Get the number of required parameters that a function defines.
87708     *
87709     * @return int
87710     * @since PHP 5 >= 5.0.3
87711     **/
87712    function getNumberOfRequiredParameters(){}
87713
87714    /**
87715     * Get the parameters as an array of ReflectionParameter.
87716     *
87717     * @return array
87718     * @since PHP 5
87719     **/
87720    function getParameters(){}
87721
87722    /**
87723     * Get the short name of the function (without the namespace part).
87724     *
87725     * @return string
87726     * @since PHP 5 >= 5.3.0
87727     **/
87728    function getShortName(){}
87729
87730    /**
87731     * Gets the starting line number of the function.
87732     *
87733     * @return int
87734     * @since PHP 5
87735     **/
87736    function getStartLine(){}
87737
87738    /**
87739     * Get the static variables.
87740     *
87741     * @return array
87742     * @since PHP 5
87743     **/
87744    function getStaticVariables(){}
87745
87746    /**
87747     * Checks whether a function is defined in a namespace.
87748     *
87749     * @return bool
87750     * @since PHP 5 >= 5.3.0
87751     **/
87752    function inNamespace(){}
87753
87754    /**
87755     * Checks whether it's a closure.
87756     *
87757     * @return bool
87758     * @since PHP 5 >= 5.3.0
87759     **/
87760    function isClosure(){}
87761
87762    /**
87763     * Checks whether the function is deprecated.
87764     *
87765     * @return bool
87766     * @since PHP 5
87767     **/
87768    function isDeprecated(){}
87769
87770    /**
87771     * Checks whether the function is internal, as opposed to user-defined.
87772     *
87773     * @return bool
87774     * @since PHP 5
87775     **/
87776    function isInternal(){}
87777
87778    /**
87779     * Checks whether the function is user-defined, as opposed to internal.
87780     *
87781     * @return bool
87782     * @since PHP 5
87783     **/
87784    function isUserDefined(){}
87785
87786    /**
87787     * Checks whether the function returns a reference.
87788     *
87789     * @return bool
87790     * @since PHP 5
87791     **/
87792    function returnsReference(){}
87793
87794    /**
87795     * Clones a function.
87796     *
87797     * @return void
87798     * @since PHP 5
87799     **/
87800    function __clone(){}
87801
87802    /**
87803     * To string.
87804     *
87805     * @return void
87806     * @since PHP 5
87807     **/
87808    function __toString(){}
87809
87810}
87811/**
87812 * The class reports information about a method.
87813 **/
87814class ReflectionMethod extends ReflectionFunctionAbstract implements Reflector {
87815    /**
87816     * Exports a ReflectionMethod.
87817     *
87818     * @param string $class The class name.
87819     * @param string $name The name of the method.
87820     * @param bool $return
87821     * @return string
87822     * @since PHP 5
87823     **/
87824    function export($class, $name, $return){}
87825
87826    /**
87827     * Gets the declaring class.
87828     *
87829     * @return ReflectionClass
87830     * @since PHP 5
87831     **/
87832    function getDeclaringClass(){}
87833
87834    /**
87835     * Gets the modifiers.
87836     *
87837     * @return int
87838     * @since PHP 5
87839     **/
87840    function getModifiers(){}
87841
87842    /**
87843     * Gets the methods prototype.
87844     *
87845     * @return void
87846     * @since PHP 5
87847     **/
87848    function getPrototype(){}
87849
87850    /**
87851     * Invokes a reflected method.
87852     *
87853     * @param object $object The object to invoke.
87854     * @param string $args The passed in argument list. It accepts a
87855     *   variable number of arguments which are passed to the function much
87856     *   like {@link call_user_func} is.
87857     * @return mixed
87858     * @since PHP 5
87859     **/
87860    function invoke($object, $args){}
87861
87862    /**
87863     * Invoke arguments.
87864     *
87865     * @param string $object
87866     * @param array $args
87867     * @return mixed
87868     * @since PHP 5 >= 5.1.0
87869     **/
87870    function invokeArgs($object, $args){}
87871
87872    /**
87873     * Checks if the method is abstract.
87874     *
87875     * @return bool
87876     * @since PHP 5
87877     **/
87878    function isAbstract(){}
87879
87880    /**
87881     * Checks if the method is a constructor.
87882     *
87883     * @return bool
87884     * @since PHP 5
87885     **/
87886    function isConstructor(){}
87887
87888    /**
87889     * Checks if the method is a destructor.
87890     *
87891     * @return bool
87892     * @since PHP 5
87893     **/
87894    function isDestructor(){}
87895
87896    /**
87897     * Checks if the method is final.
87898     *
87899     * @return bool
87900     * @since PHP 5
87901     **/
87902    function isFinal(){}
87903
87904    /**
87905     * Checks if the method is private.
87906     *
87907     * @return bool
87908     * @since PHP 5
87909     **/
87910    function isPrivate(){}
87911
87912    /**
87913     * Checks if the method is protected.
87914     *
87915     * @return bool
87916     * @since PHP 5
87917     **/
87918    function isProtected(){}
87919
87920    /**
87921     * Checks if the method is public.
87922     *
87923     * @return bool
87924     * @since PHP 5
87925     **/
87926    function isPublic(){}
87927
87928    /**
87929     * Checks if the method is static.
87930     *
87931     * @return bool
87932     * @since PHP 5
87933     **/
87934    function isStatic(){}
87935
87936    /**
87937     * Sets a method to be accessible. For example, it may allow protected
87938     * and private methods to be invoked.
87939     *
87940     * @param bool $accessible to allow accessibility, or .
87941     * @return void
87942     **/
87943    function setAccessible($accessible){}
87944
87945    /**
87946     * Constructs a new ReflectionMethod.
87947     *
87948     * @param string $class_or_method
87949     * @param string $name
87950     * @since PHP 5
87951     **/
87952    function __construct($class_or_method, $name){}
87953
87954    /**
87955     * To string.
87956     *
87957     * @return string
87958     * @since PHP 5
87959     **/
87960    function __toString(){}
87961
87962}
87963/**
87964 * The class reports information about an .
87965 **/
87966class ReflectionObject extends ReflectionClass implements Reflector {
87967    /**
87968     * Exports a reflection.
87969     *
87970     * @param string $argument
87971     * @param bool $return
87972     * @return string
87973     * @since PHP 5
87974     **/
87975    function export($argument, $return){}
87976
87977    /**
87978     * Constructs a ReflectionObject.
87979     *
87980     * @param object $argument An object instance.
87981     * @since PHP 5
87982     **/
87983    function __construct($argument){}
87984
87985}
87986/**
87987 * The class retrieves information about a function's or method's
87988 * parameters.
87989 *
87990 * To introspect function parameters, first create an instance of the or
87991 * classes and then use their method to retrieve an array of parameters.
87992 **/
87993class ReflectionParameter implements Reflector {
87994    /**
87995     * Checks whether the parameter allows .
87996     *
87997     * @return bool
87998     * @since PHP 5
87999     **/
88000    function allowsNull(){}
88001
88002    /**
88003     * Exports.
88004     *
88005     * @param string $function The function name.
88006     * @param string $parameter The parameter name.
88007     * @param bool $return
88008     * @return string
88009     * @since PHP 5
88010     **/
88011    function export($function, $parameter, $return){}
88012
88013    /**
88014     * Gets a class.
88015     *
88016     * @return ReflectionClass
88017     * @since PHP 5
88018     **/
88019    function getClass(){}
88020
88021    /**
88022     * Gets the declaring class.
88023     *
88024     * @return ReflectionClass
88025     * @since PHP 5
88026     **/
88027    function getDeclaringClass(){}
88028
88029    /**
88030     * Gets the declaring function.
88031     *
88032     * @return ReflectionFunction
88033     * @since PHP 5 >= 5.2.3
88034     **/
88035    function getDeclaringFunction(){}
88036
88037    /**
88038     * Gets the default value of the parameter for a user-defined function or
88039     * method. If the parameter is not optional a ReflectionException will be
88040     * thrown.
88041     *
88042     * @return mixed
88043     * @since PHP 5 >= 5.0.3
88044     **/
88045    function getDefaultValue(){}
88046
88047    /**
88048     * Gets the name of the parameter.
88049     *
88050     * @return string
88051     * @since PHP 5
88052     **/
88053    function getName(){}
88054
88055    /**
88056     * Gets the position of the parameter.
88057     *
88058     * @return int
88059     * @since PHP 5 >= 5.2.3
88060     **/
88061    function getPosition(){}
88062
88063    /**
88064     * Checks if the parameter expects an array.
88065     *
88066     * @return bool
88067     * @since PHP 5 >= 5.1.0
88068     **/
88069    function isArray(){}
88070
88071    /**
88072     * Checks if a default value for the parameter is available.
88073     *
88074     * @return bool
88075     * @since PHP 5 >= 5.0.3
88076     **/
88077    function isDefaultValueAvailable(){}
88078
88079    /**
88080     * Checks if the parameter is optional.
88081     *
88082     * @return bool
88083     * @since PHP 5 >= 5.0.3
88084     **/
88085    function isOptional(){}
88086
88087    /**
88088     * Checks if the parameter is passed in by reference.
88089     *
88090     * @return bool
88091     * @since PHP 5
88092     **/
88093    function isPassedByReference(){}
88094
88095    /**
88096     * Clones.
88097     *
88098     * @return void
88099     * @since PHP 5
88100     **/
88101    function __clone(){}
88102
88103    /**
88104     * Constructs a ReflectionParameter class.
88105     *
88106     * @param string $function The function to reflect parameters from.
88107     * @param string $parameter The parameter.
88108     * @since PHP 5
88109     **/
88110    function __construct($function, $parameter){}
88111
88112    /**
88113     * To string.
88114     *
88115     * @return string
88116     * @since PHP 5
88117     **/
88118    function __toString(){}
88119
88120}
88121/**
88122 * The class reports information about a classes properties.
88123 **/
88124class ReflectionProperty implements Reflector {
88125    /**
88126     * Exports a reflection.
88127     *
88128     * @param mixed $class
88129     * @param string $name The property name.
88130     * @param bool $return
88131     * @return string
88132     * @since PHP 5
88133     **/
88134    function export($class, $name, $return){}
88135
88136    /**
88137     * Gets the declaring class.
88138     *
88139     * @return ReflectionClass
88140     * @since PHP 5
88141     **/
88142    function getDeclaringClass(){}
88143
88144    /**
88145     * Gets the doc comment.
88146     *
88147     * @return string
88148     * @since PHP 5 >= 5.1.0
88149     **/
88150    function getDocComment(){}
88151
88152    /**
88153     * Gets the modifiers.
88154     *
88155     * @return int
88156     * @since PHP 5
88157     **/
88158    function getModifiers(){}
88159
88160    /**
88161     * Gets the properties name.
88162     *
88163     * @return string
88164     * @since PHP 5
88165     **/
88166    function getName(){}
88167
88168    /**
88169     * Gets the properties value.
88170     *
88171     * @param string $object The object being reflected.
88172     * @return mixed
88173     * @since PHP 5
88174     **/
88175    function getValue($object){}
88176
88177    /**
88178     * Checks whether the property is the default.
88179     *
88180     * @return bool
88181     * @since PHP 5
88182     **/
88183    function isDefault(){}
88184
88185    /**
88186     * Checks whether the property is private.
88187     *
88188     * @return bool
88189     * @since PHP 5
88190     **/
88191    function isPrivate(){}
88192
88193    /**
88194     * Checks whether the property is protected.
88195     *
88196     * @return bool
88197     * @since PHP 5
88198     **/
88199    function isProtected(){}
88200
88201    /**
88202     * Checks whether the property is public.
88203     *
88204     * @return bool
88205     * @since PHP 5
88206     **/
88207    function isPublic(){}
88208
88209    /**
88210     * Checks whether the property is static.
88211     *
88212     * @return bool
88213     * @since PHP 5
88214     **/
88215    function isStatic(){}
88216
88217    /**
88218     * Sets a property to be accessible. For example, it may allow protected
88219     * and private properties to be accessed.
88220     *
88221     * @param bool $accessible to allow accessibility, or .
88222     * @return void
88223     * @since PHP 5 >= 5.3.0
88224     **/
88225    function setAccessible($accessible){}
88226
88227    /**
88228     * Sets (changes) a properties value.
88229     *
88230     * @param object $object The object name.
88231     * @param mixed $value The new value.
88232     * @return void
88233     * @since PHP 5
88234     **/
88235    function setValue($object, $value){}
88236
88237    /**
88238     * Clones.
88239     *
88240     * @return void
88241     * @since PHP 5
88242     **/
88243    function __clone(){}
88244
88245    /**
88246     * @param mixed $class The class name, that contains the property.
88247     * @param string $name The name of the property being reflected.
88248     * @since PHP 5
88249     **/
88250    function __construct($class, $name){}
88251
88252    /**
88253     * To string.
88254     *
88255     * @return string
88256     * @since PHP 5
88257     **/
88258    function __toString(){}
88259
88260}
88261/**
88262 * is an interface implemented by all exportable Reflection classes.
88263 **/
88264class Reflector {
88265    /**
88266     * Exports.
88267     *
88268     * @return string
88269     * @since PHP 5
88270     **/
88271    function export(){}
88272
88273    /**
88274     * To string.
88275     *
88276     * @return string
88277     * @since PHP 5
88278     **/
88279    function __toString(){}
88280
88281}
88282/**
88283 * This iterator can be used to filter another iterator based on a
88284 * regular expression.
88285 **/
88286class RegexIterator extends FilterIterator {
88287    /**
88288     * Matches (string) RegexIterator::current (or RegexIterator::key if the
88289     * RegexIterator::USE_KEY flag is set) against the regular expression.
88290     *
88291     * @return bool
88292     * @since PHP 5 >= 5.2.0
88293     **/
88294    function accept(){}
88295
88296    /**
88297     * Returns the flags, see RegexIterator::setFlags for a list of available
88298     * flags.
88299     *
88300     * @return int
88301     * @since PHP 5 >= 5.2.0
88302     **/
88303    function getFlags(){}
88304
88305    /**
88306     * Returns the operation mode, see RegexIterator::setMode for the list of
88307     * operation modes.
88308     *
88309     * @return int
88310     * @since PHP 5 >= 5.2.0
88311     **/
88312    function getMode(){}
88313
88314    /**
88315     * Returns the regular expression flags, see RegexIterator::__construct
88316     * for the list of flags.
88317     *
88318     * @return int
88319     * @since PHP 5 >= 5.2.0
88320     **/
88321    function getPregFlags(){}
88322
88323    /**
88324     * Sets the flags.
88325     *
88326     * @param int $flags The flags to set, a bitmask of class constants.
88327     *   The available flags are listed below. The actual meanings of these
88328     *   flags are described in the predefined constants. RegexIterator flags
88329     *   value constant 1 RegexIterator::USE_KEY
88330     * @return void
88331     * @since PHP 5 >= 5.2.0
88332     **/
88333    function setFlags($flags){}
88334
88335    /**
88336     * Sets the operation mode.
88337     *
88338     * @param int $mode The operation mode. The available modes are listed
88339     *   below. The actual meanings of these modes are described in the
88340     *   predefined constants. RegexIterator modes value constant 0
88341     *   RegexIterator::MATCH 1 RegexIterator::GET_MATCH 2
88342     *   RegexIterator::ALL_MATCHES 3 RegexIterator::SPLIT 4
88343     *   RegexIterator::REPLACE
88344     * @return void
88345     * @since PHP 5 >= 5.2.0
88346     **/
88347    function setMode($mode){}
88348
88349    /**
88350     * Sets the regular expression flags.
88351     *
88352     * @param int $preg_flags The regular expression flags. See
88353     *   RegexIterator::__construct for an overview of available flags.
88354     * @return void
88355     * @since PHP 5 >= 5.2.0
88356     **/
88357    function setPregFlags($preg_flags){}
88358
88359}
88360class ResourceBundle {
88361    /**
88362     * Get the number of elements in the bundle.
88363     *
88364     * @return int
88365     **/
88366    function count(){}
88367
88368    /**
88369     * Creates a resource bundle.
88370     *
88371     * @param string $locale Locale for which the resources should be
88372     *   loaded (locale name, e.g. en_CA).
88373     * @param string $bundlename The directory where the data is stored or
88374     *   the name of the .dat file.
88375     * @param bool $fallback Whether locale should match exactly or
88376     *   fallback to parent locale is allowed.
88377     * @return ResourceBundle
88378     **/
88379    function create($locale, $bundlename, $fallback){}
88380
88381    /**
88382     * Get the data from the bundle by index or string key.
88383     *
88384     * @param string|int $index ResourceBundle object.
88385     * @return mixed
88386     **/
88387    function get($index){}
88388
88389    /**
88390     * Get error code from the last function performed by the bundle object.
88391     *
88392     * @return int
88393     **/
88394    function getErrorCode(){}
88395
88396    /**
88397     * Get error message from the last function performed by the bundle
88398     * object.
88399     *
88400     * @return string
88401     **/
88402    function getErrorMessage(){}
88403
88404    /**
88405     * Get the list of locales supported by the bundle. The list is taken
88406     * from the bundle table named res_index which should contain a table
88407     * named InstalledLocales, which contains locales as keys. This bundle
88408     * should be either in data directory as .res file or part of the .dat
88409     * file for this function to work.
88410     *
88411     * @return array
88412     **/
88413    function getLocales(){}
88414
88415}
88416class Runkit_Sandbox_Parent {
88417    /**
88418     * Instantiating the Runkit_Sandbox_Parent class from within a sandbox
88419     * environment created from the Runkit_Sandbox class provides some
88420     * (controlled) means for a sandbox child to access its parent.
88421     *
88422     * In order for any of the Runkit_Sandbox_Parent features to function.
88423     * Support must be enabled on a per-sandbox basis by enabling the
88424     * parent_access flag from the parent's context.
88425     *
88426     * @return void
88427     **/
88428    function __construct(){}
88429
88430}
88431/**
88432 * Exception thrown if an error which can only be found on runtime occurs
88433 **/
88434class RuntimeException extends Exception {
88435}
88436class SAMConnection {
88437    /**
88438     * Contains the numeric error code of the last executed SAM operation on
88439     * this connection. If the last operation completed successfully this
88440     * property contains 0.
88441     *
88442     * @var int
88443     **/
88444    var $errno;
88445    /**
88446     * Contains the text description of the last failed SAM operation on this
88447     * connection. If the last operation completed successfully this property
88448     * contains an empty string.
88449     *
88450     * @var string
88451     **/
88452    var $error;
88453    /**
88454     * Calling the "commit" method on a Connection object commits (completes)
88455     * all in-flight transactions that are part of the current unit of work.
88456     *
88457     * @return bool
88458     * @since PECL sam >= 0.1.0
88459     **/
88460    function commit(){}
88461
88462    /**
88463     * Calling the "connect" method on a SAMConnection object connects the
88464     * PHP script to a messaging server. No messages can be sent or received
88465     * until a connection is made.
88466     *
88467     * @param string $protocol
88468     * @param array $properties
88469     * @return bool
88470     * @since PECL sam >= 0.1.0
88471     **/
88472    function connect($protocol, $properties){}
88473
88474    /**
88475     * Calling the "disconnect" method on a SAMConnection object disconnects
88476     * the PHP script from a messaging server. No messages can be sent or
88477     * received after a connection has been disconnected.
88478     *
88479     * @return bool
88480     * @since PECL sam >= 0.1.0
88481     **/
88482    function disconnect(){}
88483
88484    /**
88485     * Calling the "isConnected" method on a Connection object will check
88486     * whether the PHP script is connected to a messaging server. No messages
88487     * can be sent or received unless a connection has been established with
88488     * a Messaging server.
88489     *
88490     * @return bool
88491     * @since PECL sam >= 0.1.0
88492     **/
88493    function isConnected(){}
88494
88495    /**
88496     * @param string $target The identity of the queue from which to peek
88497     *   the message.
88498     * @param array $properties An optional associative array of properties
88499     *   describing other parameters to control the peek operation. Property
88500     *   name Possible values SAM_CORRELID This is the target correlation id
88501     *   string of the message. This would typically have been returned by a
88502     *   "send" request. SAM_MESSAGEID This is the message id string of the
88503     *   message which is to be peeked.
88504     * @return SAMMessage
88505     * @since PECL sam >= 0.1.0
88506     **/
88507    function peek($target, $properties){}
88508
88509    /**
88510     * @param string $target The identity of the queue from which messages
88511     *   should be peeked.
88512     * @param array $properties An optional associative array of properties
88513     *   describing other parameters to control the peek operation. Property
88514     *   name Possible values SAM_CORRELID This is the target correlation id
88515     *   string of messages to be peeked. This would typically have been
88516     *   returned by a "send" request. SAM_MESSAGEID This is the message id
88517     *   string of a message which is to be peeked.
88518     * @return array
88519     * @since PECL sam >= 0.2.0
88520     **/
88521    function peekAll($target, $properties){}
88522
88523    /**
88524     * @param string $target The identity of the queue, topic or
88525     *   subscription from which to receive the message.
88526     * @param array $properties An optional associative array of properties
88527     *   describing other parameters to control the receive operation.
88528     *   Property name Possible values SAM_CORRELID Used to request selection
88529     *   of the message to receive based upon the correlation id string of
88530     *   the message. SAM_MESSAGEID Used to request selection of the message
88531     *   to receive based upon the message id string of the message. SAM_WAIT
88532     *   Timeout value in milliseconds to control how long the request should
88533     *   block waiting to receive a message before returning with a failure
88534     *   if no message is available on the queue or topic. The default value
88535     *   is 0 meaning wait indefinitely and should be used with caution as
88536     *   the request may wait until the overall PHP script processing time
88537     *   limit has expired if no message becomes available.
88538     * @return SAMMessage
88539     * @since PECL sam >= 0.1.0
88540     **/
88541    function receive($target, $properties){}
88542
88543    /**
88544     * Removes a message from a queue.
88545     *
88546     * @param string $target The identity of the queue from which to remove
88547     *   the message.
88548     * @param array $properties An optional associative array of properties
88549     *   describing other parameters to control the remove operation.
88550     *   Property name Possible values SAM_CORRELID This is the target
88551     *   correlation id string of the message. This would typically have been
88552     *   returned by a "send" request. SAM_MESSAGEID This is the message id
88553     *   string of the message which is to be removed.
88554     * @return SAMMessage
88555     * @since PECL sam >= 0.1.0
88556     **/
88557    function remove($target, $properties){}
88558
88559    /**
88560     * Rolls back an in-flight unit of work.
88561     *
88562     * @return bool
88563     * @since PECL sam >= 0.1.0
88564     **/
88565    function rollback(){}
88566
88567    /**
88568     * The "send" method is used to send a message to a specific queue or to
88569     * publish to a specific topic. The method returns a correlation id that
88570     * can be used as a selector to identify reply or response messages when
88571     * these are requested.
88572     *
88573     * @param string $target If sending a message, the identity of the
88574     *   queue (queue://queuename) or if publishing to a topic the identity
88575     *   of the topic (topic://topicname) to which the message is to be
88576     *   delivered.
88577     * @param SAMMessage $msg The message to be sent or published.
88578     * @param array $properties An optional associative array of properties
88579     *   describing other parameters to control the receive operation.
88580     *   Property name Possible values SAM_DELIVERYMODE Indicates whether the
88581     *   messaging server should ensure delivery or whether it is acceptable
88582     *   for messages to be lost in the case of system failures. The value of
88583     *   this property may be set to either SAM_PERSISTENT, to indicate that
88584     *   message loss is not acceptable, or SAM_NON_PERSISTENT, if message
88585     *   loss is acceptable. The resulting behaviour of the send will vary
88586     *   depending on the capabilities of the messaging server the PHP script
88587     *   is currently connected to. If the server does not support persistent
88588     *   messages and SAM_PERSISTENT is specified the send request will fail
88589     *   with an error indication showing the capability is not available.
88590     *   SAM_PRIORITY A numeric value between 0 and 9 indicating the desired
88591     *   message delivery priority. A priority value of 0 indicates the
88592     *   lowest priority while 9 indicates highest priority. If no priority
88593     *   is specified a default will be assigned which is dependent on the
88594     *   messaging server being used. SAM_CORRELID A string to be assigned as
88595     *   a correlation id for this message. If no value is given the
88596     *   messaging server may assign a value automatically. SAM_TIMETOLIVE A
88597     *   time in milliseconds indicating how long the messaging server should
88598     *   retain the message on a queue before discarding it. The default
88599     *   value is 0 indicating the message should be retained indefinitely.
88600     *   SAM_WMQ_TARGET_CLIENT This property is only valid when using
88601     *   WebSphere MQ and indicates whether or not an RFH2 header should be
88602     *   included with the message. This option may be set to either 'jms' or
88603     *   'mq'. The default is 'jms' which means that an RFH2 header is
88604     *   included. If the value 'mq' is specified then no RFH2 is included
88605     *   with the message.
88606     * @return string
88607     * @since PECL sam >= 0.1.0
88608     **/
88609    function send($target, $msg, $properties){}
88610
88611    /**
88612     * The "setdebug" method is used to turn on or off additional debugging
88613     * output. The SAM framework will provide method/function entry and exit
88614     * trace data plus additional information. Protocol specific
88615     * implementations also provide extra output.
88616     *
88617     * @param bool $switch If this parameter is set to additional debugging
88618     *   output will be provided. If the value is set to output of additional
88619     *   information will be stopped.
88620     * @return void
88621     * @since PECL sam >= 1.1.0
88622     **/
88623    function setDebug($switch){}
88624
88625    /**
88626     * The "subscribe" method is used to create a new subscription to a
88627     * specified topic.
88628     *
88629     * @param string $targetTopic The identity of the topic
88630     *   (topic://topicname) to subscribe to.
88631     * @return string
88632     * @since PECL sam >= 0.1.0
88633     **/
88634    function subscribe($targetTopic){}
88635
88636    /**
88637     * The "unsubscribe" method is used to delete an existing subscription to
88638     * a specified topic.
88639     *
88640     * @param string $subscriptionId The identifier of an existing
88641     *   subscription as returned by a call to the subscribe method.
88642     * @param string $targetTopic
88643     * @return bool
88644     * @since PECL sam >= 0.1.0
88645     **/
88646    function unsubscribe($subscriptionId, $targetTopic){}
88647
88648}
88649class SAMMessage {
88650    /**
88651     * The "body" property contains the actual body of the message. It may
88652     * not always be set.
88653     *
88654     * @var string
88655     **/
88656    var $body;
88657    /**
88658     * The header property is a container for any system or user properties
88659     * that area associated with the message.
88660     *
88661     * Properties may be assigned by the sender of a message to control the
88662     * way the messaging systems handles it or may be assigned by the
88663     * messaging system itself to tell the recipient extra information about
88664     * the message or the way in which it has been handled.
88665     *
88666     * Some properties are understood by SAM in which case constants have
88667     * been defined for them. The majority of properties however are ignored
88668     * by the SAM implementation and simply passed through to the underlying
88669     * messaging systems allowing the application to use messaging specific
88670     * property names or to define its own "user" properties.
88671     *
88672     * The SAM defined properties are as follows: Property name Possible
88673     * values SAM_MESSAGEID When a message is received this field contains
88674     * the unique identifier of the message as allocated by the underlying
88675     * messaging system. When sending a message this field is ignored.
88676     * SAM_REPLY_TO A string providing the identity of the queue on to which
88677     * responses to this message should be posted. SAM_TYPE An indication of
88678     * the type of message to be sent. The value may be SAM_TEXT indicating
88679     * the contents of the message body is a text string, or SAM_BYTES
88680     * indicating the contents of the message body are some application
88681     * defined format. The way in which this property is used may depend on
88682     * the underlying messaging server. For instance a messaging server that
88683     * supports the JMS (Java Message Service) specification may interpret
88684     * this value and send messages of type "jms_text" and "jms_bytes". In
88685     * addition, if the SAM_TYPE property is set to SAM_TEXT the data
88686     * provided for the message body is expected to be a UTF8 encoded string.
88687     *
88688     * When setting the values of properties it is often useful to give a
88689     * hint as to the format in which the property should be delivered to the
88690     * messaging system. By default property values are delivered as text and
88691     * the following simple syntax may be used to set a value:
88692     *
88693     * Setting a text format property using the default syntax
88694     *
88695     * <?php $msg = new SAMMessage();
88696     *
88697     * $msg->header->myPropertyName = 'textData'; ?>
88698     *
88699     * If it is desired to pass type information an alternative syntax may be
88700     * used where the value and the type hint are passed in an associative
88701     * array:
88702     *
88703     * Setting a text format property using a type hint
88704     *
88705     * <?php $msg = new SAMMessage();
88706     *
88707     * $msg->header->myPropertyName = array('textData', SAM_STRING); ?>
88708     *
88709     * When passing a type hint the type entry should be one of the SAM
88710     * defined constant values as defined by the following table: Constant
88711     * Type description SAM_BOOLEAN Any value passed will be interpreted as
88712     * logical true or false. If the value cannot be interpreted as a PHP
88713     * boolean value the value passed to the messaging system is undefined.
88714     * SAM_BYTE An 8-bit signed integer value. SAM will attempt to convert
88715     * the property value specified into a single byte value to pass to the
88716     * messaging system. If a string value is passed an attempt will be made
88717     * to interpret the string as a numeric value. If the numeric value
88718     * cannot be expressed as an 8-bit signed binary value data may be lost
88719     * in the conversion. SAM_DOUBLE A long floating point value. SAM will
88720     * attempt to convert the property value specified into a floating point
88721     * value with 15 digits of precision. If a string value is passed an
88722     * attempt will be made to interpret the string as a numeric value. If
88723     * the passed value cannot be expressed as a 15 digit floating point
88724     * value data may be lost in the conversion. SAM_FLOAT A short floating
88725     * point value. SAM will attempt to convert the property value specified
88726     * into a floating point value with 7 digits of precision. If a string
88727     * value is passed an attempt will be made to interpret the string as a
88728     * numeric value. If the passed value cannot be expressed as a 7 digit
88729     * floating point value data may be lost in the conversion. SAM_INT An
88730     * 32-bit signed integer value. SAM will attempt to convert the property
88731     * value specified into a 32-bit value to pass to the messaging system.
88732     * If a string value is passed an attempt will be made to interpret the
88733     * string as a numeric value. If the numeric value cannot be expressed as
88734     * an 32-bit signed binary value data may be lost in the conversion.
88735     * SAM_LONG An 64-bit signed integer value. SAM will attempt to convert
88736     * the property value specified into a 64-bit value to pass to the
88737     * messaging system. If a string value is passed an attempt will be made
88738     * to interpret the string as a numeric value. If the numeric value
88739     * cannot be expressed as an 64-bit signed binary value data may be lost
88740     * in the conversion. SAM_STRING SAM will interpret the property value
88741     * specified as a string and pass it to the messaging system accordingly.
88742     *
88743     * @var object
88744     **/
88745    var $header;
88746}
88747class SCA {
88748    /**
88749     * This method is used inside an SCA component that needs to create an
88750     * SDO to return. The parameters are the desired SDO's namespace URI and
88751     * type name. The namespace and type must be defined in one of the schema
88752     * files which are specified on the @types annotation within the
88753     * component.
88754     *
88755     * @param string $type_namespace_uri The namespace of the type.
88756     * @param string $type_name The name of the type.
88757     * @return SDO_DataObject
88758     * @since PECL SDO >= 0.5.0
88759     **/
88760    function createDataObject($type_namespace_uri, $type_name){}
88761
88762    /**
88763     * Examine the target and initialize and return a proxy of the
88764     * appropriate sort. If the target is for a local PHP component the
88765     * returned proxy will be an SCA_LocalProxy. If the target is for a WSDL
88766     * file, the returned proxy will be a SCA_SoapProxy.
88767     *
88768     * @param string $target An absolute or relative path to the target
88769     *   service or service description (e.g. a URL to a json-rpc service
88770     *   description, a PHP component, a WSDL file, and so on.). A relative
88771     *   path, if specified, is resolved relative to the location of the
88772     *   script issuing the {@link getService} call, and not against the
88773     *   include_path or current working directory.
88774     * @param string $binding The binding (i.e. protocol) to use to
88775     *   communicate with the service (e.g binding.jsonrpc for a json-rpc
88776     *   service). Note, some service types can be deduced from the target
88777     *   parameter (e.g. if the target parameter ends in .wsdl then SCA will
88778     *   assume binding.soap). Any binding which can be specified in an
88779     *   annotation can be specified here. For example 'binding.soap' is
88780     *   equivalent to the '@binding.soap' annotation.
88781     * @param array $config Any additional configuration properties for the
88782     *   binding (e.g. array('location' => 'http://example.org')). Any
88783     *   binding configuration which can be specified in an annotation can be
88784     *   specified here. For example, 'location' is equivalent to the
88785     *   '@location' annotation to configure the location of a target soap
88786     *   service.
88787     * @return mixed
88788     * @since PECL SDO >= 0.5.0
88789     **/
88790    function getService($target, $binding, $config){}
88791
88792}
88793class SCA_LocalProxy {
88794    /**
88795     * This method is used inside either an ordinary PHP script or an SCA
88796     * component that needs to create an SDO to pass to a local service. The
88797     * parameters are the desired SDO's namespace URI and type name. The
88798     * namespace and type must be defined in the interface of the component
88799     * that is to be called, so the namespace and type must be defined in one
88800     * of the schema files which are specified on the @types annotation
88801     * within the component for which the SCA_LocalProxy object is a proxy.
88802     *
88803     * @param string $type_namespace_uri The namespace of the type.
88804     * @param string $type_name The name of the type.
88805     * @return SDO_DataObject
88806     * @since PECL SDO >= 0.5.0
88807     **/
88808    function createDataObject($type_namespace_uri, $type_name){}
88809
88810}
88811class SCA_SoapProxy {
88812    /**
88813     * This method is used inside either an ordinary PHP script or an SCA
88814     * component that needs to create an SDO to pass to a web service. The
88815     * parameters are the desired SDO's namespace URI and type name. The
88816     * namespace and type must be defined in the interface of the component
88817     * that is to be called, so the namespace and type must be defined within
88818     * the WSDL for the web service. If the web service is also an SCA
88819     * component then the types will have been defined within one of the
88820     * schema files which are specified on the @types annotation within the
88821     * component for which the SCA_SoapProxy object is a proxy.
88822     *
88823     * @param string $type_namespace_uri The namespace of the type.
88824     * @param string $type_name The name of the type.
88825     * @return SDO_DataObject
88826     * @since PECL SDO >= 0.5.0
88827     **/
88828    function createDataObject($type_namespace_uri, $type_name){}
88829
88830}
88831interface SDO_DAS_ChangeSummary {
88832    const ADDITION = 0;
88833    const DELETION = 0;
88834    const MODIFICATION = 0;
88835    const NONE = 0;
88836    /**
88837     * Begin logging changes made to the SDO_DataObject.
88838     *
88839     * @return void
88840     * @since ^
88841     **/
88842    function beginLogging();
88843
88844    /**
88845     * End logging changes made to an SDO_DataObject.
88846     *
88847     * @return void
88848     * @since ^
88849     **/
88850    function endLogging();
88851
88852    /**
88853     * Get an SDO_List of the SDO_DataObjects which have been changed. These
88854     * data objects can then be used to identify the types of change made to
88855     * each, along with the old values.
88856     *
88857     * @return SDO_List
88858     * @since ^
88859     **/
88860    function getChangedDataObjects();
88861
88862    /**
88863     * Get the type of change which has been made to the supplied
88864     * SDO_DataObject.
88865     *
88866     * @param SDO_DataObject $dataObject The SDO_DataObject which has been
88867     *   changed.
88868     * @return int
88869     * @since ^
88870     **/
88871    function getChangeType($dataObject);
88872
88873    /**
88874     * Get the old container (SDO_DataObject) for a deleted SDO_DataObject.
88875     *
88876     * @param SDO_DataObject $data_object The SDO_DataObject which has been
88877     *   deleted and whose container we wish to identify.
88878     * @return SDO_DataObject
88879     * @since ^
88880     **/
88881    function getOldContainer($data_object);
88882
88883    /**
88884     * Get a list of the old values for a given changed SDO_DataObject.
88885     * Returns a list of SDO_DAS_Settings describing the old values for the
88886     * changed properties of the SDO_DataObject.
88887     *
88888     * @param SDO_DataObject $data_object The data object which has been
88889     *   changed.
88890     * @return SDO_List
88891     * @since ^
88892     **/
88893    function getOldValues($data_object);
88894
88895    /**
88896     * Test to see whether change logging is switched on.
88897     *
88898     * @return bool
88899     * @since ^
88900     **/
88901    function isLogging();
88902
88903}
88904class SDO_DAS_DataFactory {
88905    /**
88906     * Adds a property to a type. The type must already be known to the
88907     * SDO_DAS_DataFactory (i.e. have been added using addType()). The
88908     * property becomes a property of the type. This is how the graph model
88909     * for the structure of an SDO_DataObject is built.
88910     *
88911     * @param string $parent_type_namespace_uri The namespace URI for the
88912     *   parent type.
88913     * @param string $parent_type_name The type name for the parent type.
88914     * @param string $property_name The name by which the property will be
88915     *   known in the parent type.
88916     * @param string $type_namespace_uri The namespace URI for the type of
88917     *   the property.
88918     * @param string $type_name The type name for the type of the property
88919     * @param array $options This array holds one or more key=>value pairs
88920     *   to set attribute values for the property. The optional keywords are:
88921     * @return void
88922     * @since ^
88923     **/
88924    function addPropertyToType($parent_type_namespace_uri, $parent_type_name, $property_name, $type_namespace_uri, $type_name, $options){}
88925
88926    /**
88927     * Add a new type to the SDO_DAS_DataFactory, defined by its namespace
88928     * and type name. The type becomes part of the model of data objects that
88929     * the data factory can create.
88930     *
88931     * @param string $type_namespace_uri The namespace of the type.
88932     * @param string $type_name The name of the type.
88933     * @param array $options This array holds one or more key=>value pairs
88934     *   to set attribute values for the type. The optional keywords are:
88935     * @return void
88936     * @since ^
88937     **/
88938    function addType($type_namespace_uri, $type_name, $options){}
88939
88940    /**
88941     * Static method to get an instance of an SDO_DAS_DataFactory. This
88942     * instance is initially only configured with the basic SDO types. A Data
88943     * Access Service is responsible for populating the data factory model
88944     * and then allowing PHP applications to create SDOs based on the model
88945     * through the SDO_DataFactory interface. PHP applications should always
88946     * obtain a data factory from a configured Data Access Service, not
88947     * through this interface.
88948     *
88949     * @return SDO_DAS_DataFactory
88950     * @since ^
88951     **/
88952    function getDataFactory(){}
88953
88954}
88955class SDO_DAS_DataObject {
88956    /**
88957     * Get the SDO_DAS_ChangeSummary for an SDO_DAS_DataObject, or NULL if it
88958     * does not have one.
88959     *
88960     * @return SDO_DAS_ChangeSummary
88961     * @since ^
88962     **/
88963    function getChangeSummary(){}
88964
88965}
88966class SDO_DAS_Relational {
88967    /**
88968     * Given a PDO database handle and the special root object of a data
88969     * graph, examine the change summary in the datagraph and applies the
88970     * changes to the database. The changes that it can apply can be
88971     * creations of data objects, deletes of data objects, and modifications
88972     * to properties of data objects.
88973     *
88974     * @param PDO $database_handle Constructed using the PDO extension. A
88975     *   typical line to construct a PDO database handle might look like
88976     *   this:
88977     *
88978     *   $dbh = new
88979     *   PDO("mysql:dbname=COMPANYDB;host=localhost",DATABASE_USER,DATABASE_PASSWORD);
88980     * @param SDODataObject $root_data_object The special root object which
88981     *   is at the top of every SDO data graph.
88982     * @return void
88983     * @since ^
88984     **/
88985    function applyChanges($database_handle, $root_data_object){}
88986
88987    /**
88988     * Returns the special root object at the top of an otherwise empty data
88989     * graph. This call is used when the application wants to create a data
88990     * graph from scratch, without having called {@link executeQuery} to
88991     * create a data graph.
88992     *
88993     * The special root object has one multi-valued containment property,
88994     * with a name of the application root type that was passed when the
88995     * Relational DAS was constructed. The property can take values of only
88996     * that type. The only thing that the application can usefully do with
88997     * the root type is to call {@link createDataObject} on it, passing the
88998     * name of the application root type, in order to create a data object of
88999     * their own application type.
89000     *
89001     * @return SDODataObject
89002     * @since ^
89003     **/
89004    function createRootDataObject(){}
89005
89006    /**
89007     * Executes a given query against the relational database, using the
89008     * supplied PDO database handle. Differs from the simpler {@link
89009     * executeQuery} in that it takes a prepared statement and a list of
89010     * values. This is the appropriate call to use either when the statement
89011     * is to executed a number of times with different arguments, and there
89012     * is therefore a performance benefit to be had from preparing the
89013     * statement only once, or when the SQL statement is to contain varying
89014     * values taken from a source that cannot be completely trusted. In this
89015     * latter case it may be unsafe to construct the SQL statement by simply
89016     * concatenating the parts of the statement together, since the values
89017     * may contain pieces of SQL. To guard against this, a so-called SQL
89018     * injection attack, it is safer to prepare the SQL statement with
89019     * placeholders (also known as parameter markers, denoted by '?') and
89020     * supply a list of the values to be substituted as a separate argument.
89021     * Otherwise this function is the same as {@link executeQuery} in that it
89022     * uses the model that it built from the metadata to interpret the result
89023     * set and returns a data graph.
89024     *
89025     * @param PDO $database_handle Constructed using the PDO extension. A
89026     *   typical line to construct a PDO database handle might look like
89027     *   this:
89028     *
89029     *   $dbh = new
89030     *   PDO("mysql:dbname=COMPANYDB;host=localhost",DATABASE_USER,DATABASE_PASSWORD);
89031     * @param PDOStatement $prepared_statement A prepared SQL statement to
89032     *   be executed against the database. This will have been prepared by
89033     *   PDO's {@link prepare} method.
89034     * @param array $value_list An array of the values to be substituted
89035     *   into the SQL statement in place of the placeholders. In the event
89036     *   that there are no placeholders or parameter markers in the SQL
89037     *   statement then this argument can be specified as or as an empty
89038     *   array;
89039     * @param array $column_specifier The Relational DAS needs to examine
89040     *   the result set and for every column, know which table and which
89041     *   column of that table it came from. In some circumstances it can find
89042     *   this information for itself, but sometimes it cannot. In these cases
89043     *   a column specifier is needed, which is an array that identifies the
89044     *   columns. Each entry in the array is simply a string in the form
89045     *   table-name.column_name. The column specifier is needed when there
89046     *   are duplicate column names in the database metadata, For example, in
89047     *   the database used within the examples, all the tables have both a id
89048     *   and a name column. When the Relational DAS fetches the result set
89049     *   from PDO it can do so with the PDO_FETCH_ASSOC attribute, which will
89050     *   cause the columns in the results set to be labelled with the column
89051     *   name, but will not distinguish duplicates. So this will only work
89052     *   when there are no duplicates possible in the results set. To
89053     *   summarise, specify a column specifier array whenever there is any
89054     *   uncertainty about which column could be from which table and only
89055     *   omit it when every column name in the database metadata is unique.
89056     *   All of the examples in the Examples use a column specifier. There is
89057     *   one example in the Scenarios directory of the installation that does
89058     *   not: that which works with just the employee table, and because it
89059     *   works with just one table, there can not exist duplicate column
89060     *   names.
89061     * @return SDODataObject
89062     * @since ^
89063     **/
89064    function executePreparedQuery($database_handle, $prepared_statement, $value_list, $column_specifier){}
89065
89066    /**
89067     * Executes a given query against the relational database, using the
89068     * supplied PDO database handle. Uses the model that it built from the
89069     * metadata to interpret the result set. Returns a data graph.
89070     *
89071     * @param PDO $database_handle Constructed using the PDO extension. A
89072     *   typical line to construct a PDO database handle might look like
89073     *   this:
89074     *
89075     *   $dbh = new
89076     *   PDO("mysql:dbname=COMPANYDB;host=localhost",DATABASE_USER,DATABASE_PASSWORD);
89077     * @param string $SQL_statement The SQL statement to be executed
89078     *   against the database.
89079     * @param array $column_specifier The Relational DAS needs to examine
89080     *   the result set and for every column, know which table and which
89081     *   column of that table it came from. In some circumstances it can find
89082     *   this information for itself, but sometimes it cannot. In these cases
89083     *   a column specifier is needed, which is an array that identifies the
89084     *   columns. Each entry in the array is simply a string in the form
89085     *   table-name.column_name. The column specifier is needed when there
89086     *   are duplicate column names in the database metadata. For example, in
89087     *   the database used within the examples, all the tables have both a id
89088     *   and a name column. When the Relational DAS fetches the result set
89089     *   from PDO it can do so with the PDO_FETCH_ASSOC attribute, which will
89090     *   cause the columns in the results set to be labelled with the column
89091     *   name, but will not distinguish duplicates. So this will only work
89092     *   when there are no duplicates possible in the results set. To
89093     *   summarise, specify a column specifier array whenever there is any
89094     *   uncertainty about which column could be from which table and only
89095     *   omit it when every column name in the database metadata is unique.
89096     *   All of the examples in the Examples use a column specifier. There is
89097     *   one example in the Scenarios directory of the installation that does
89098     *   not: that which works with just the employee table, and because it
89099     *   works with just one table, there can not exist duplicate column
89100     *   names.
89101     * @return SDODataObject
89102     * @since ^
89103     **/
89104    function executeQuery($database_handle, $SQL_statement, $column_specifier){}
89105
89106    /**
89107     * Constructs an instance of a Relational Data Access Service from the
89108     * passed metadata.
89109     *
89110     * @param array $database_metadata An array containing one or more
89111     *   table definitions, each of which is an associative array containing
89112     *   the keys name, columns, PK, and optionally, FK. For a full
89113     *   discussion of the metadata, see the metadata section in the general
89114     *   information about the Relational DAS.
89115     * @param string $application_root_type The root of each data graph is
89116     *   an object of a special root type and the application data objects
89117     *   come below that. Of the various application types in the SDO model,
89118     *   one has to be the application type immediately below the root of the
89119     *   data graph. If there is only one table in the database metadata, so
89120     *   the application root type can be inferred, this argument can be
89121     *   omitted.
89122     * @param array $SDO_containment_references_metadata An array
89123     *   containing one or more definitions of a containment relation, each
89124     *   of which is an associative array containing the keys parent and
89125     *   child. The containment relations describe how the types in the model
89126     *   are connected to form a tree. The type specified as the application
89127     *   root type must be present as one of the parent types in the
89128     *   containment references. If the application only needs to work with
89129     *   one table at a time, and there are no containment relations in the
89130     *   model, this argument can be omitted. For a full discussion of the
89131     *   metadata, see the metadata section in the general information about
89132     *   the Relational DAS.
89133     * @return SDO_DAS_Relational
89134     * @since ^
89135     **/
89136    function __construct($database_metadata, $application_root_type, $SDO_containment_references_metadata){}
89137
89138}
89139class SDO_DAS_Setting {
89140    /**
89141     * Get the list index for a modification made to an element of a
89142     * many-valued property. For example, if we modified the third element of
89143     * a many-valued property we could obtain an SDO_DAS_Setting from the
89144     * change summary corresponding to that modification. A call to {@link
89145     * getListIndex} on that setting would return the value 2 (lists are
89146     * indexed from zero).
89147     *
89148     * @return int
89149     * @since ^
89150     **/
89151    function getListIndex(){}
89152
89153    /**
89154     * Returns the property index for the changed property. This index
89155     * identifies the property which was modified in data object.
89156     *
89157     * @return int
89158     * @since ^
89159     **/
89160    function getPropertyIndex(){}
89161
89162    /**
89163     * Returns the property name for the changed property. This name
89164     * identifies the property which was modified in data object.
89165     *
89166     * @return string
89167     * @since ^
89168     **/
89169    function getPropertyName(){}
89170
89171    /**
89172     * Returns the old value for the changed property. This can be used by a
89173     * Data Access Service when writing updates to a data source. The DAS
89174     * uses the old value to detect conflicts by comparing it with the
89175     * current value in the data source. If they do not match, then the data
89176     * source has been updated since the data object was originally
89177     * populated, and therefore writing any new updates risks compromising
89178     * the integrity of the data.
89179     *
89180     * @return mixed
89181     * @since ^
89182     **/
89183    function getValue(){}
89184
89185}
89186class SDO_DAS_XML {
89187    /**
89188     * Load a second or subsequent schema file to an XML DAS that has already
89189     * been created with the static method {@link create}. Although the file
89190     * may be any valid schema file, a likely reason for using this method is
89191     * to add a schema file containing definitions of extra complex types,
89192     * hence the name. See Example 4 of the parent document for an example.
89193     *
89194     * @param string $xsd_file Path to XSD Schema file.
89195     * @return void
89196     * @since ^
89197     **/
89198    function addTypes($xsd_file){}
89199
89200    /**
89201     * This is the only static method of SDO_DAS_XML class. Used to
89202     * instantiate SDO_DAS_XML object.
89203     *
89204     * @param mixed $xsd_file Path to XSD Schema file. This is optional. If
89205     *   omitted a DAS will be created that only has the SDO base types
89206     *   defined. Schema files can then be loaded with the {@link addTypes}
89207     *   method. Can be string or array of values.
89208     * @param string $key
89209     * @return SDO_DAS_XML
89210     * @since ^
89211     **/
89212    function create($xsd_file, $key){}
89213
89214    /**
89215     * Creates SDO_DataObject for a given namespace URI and type name. The
89216     * type should be defined in the underlying model otherwise
89217     * SDO_TypeNotFoundException will be thrown.
89218     *
89219     * @param string $namespace_uri Namespace URI of the type name.
89220     * @param string $type_name Type Name.
89221     * @return SDO_DataObject
89222     * @since ^
89223     **/
89224    function createDataObject($namespace_uri, $type_name){}
89225
89226    /**
89227     * Creates an XML Document object. This will contain just one empty root
89228     * element on which none of the properties will have been set. The
89229     * purpose of this call is to allow an application to create an XML
89230     * document from scratch without the need to load a document from a file
89231     * or string. The document that is created will be as if a document had
89232     * been loaded that contained just a single empty document element with
89233     * no attributes set or elements within it.
89234     *
89235     * {@link createDocument} may need to be told what the document element
89236     * is. This will not be necessary in simple cases. When there is no
89237     * ambiguity then no parameter need be passed to the method. However it
89238     * is possible to load more than one schema file into the same XML DAS
89239     * and in this case there may be more than one possible document element
89240     * defined: furthermore it is even possible that there are two possible
89241     * document elements that differ only in the namespace. To cope with
89242     * these cases it is possible to specify either the document element
89243     * name, or both the document element name and namespace to the method.
89244     *
89245     * @param string $document_element_name The name of the document
89246     *   element. Only needed if there is more than one possibility.
89247     * @return SDO_DAS_XML_Document
89248     * @since ^
89249     **/
89250    function createDocument($document_element_name){}
89251
89252    /**
89253     * Constructs the tree of SDO_DataObjects from the given address to xml
89254     * instance document. Returns SDO_DAS_XML_Document Object. Use
89255     * SDO_DAS_XML_Document::getRootDataObject method to get root data
89256     * object.
89257     *
89258     * @param string $xml_file Path to Instance document. This can be a
89259     *   path to a local file or it can be a URL.
89260     * @return SDO_XMLDocument
89261     * @since ^
89262     **/
89263    function loadFile($xml_file){}
89264
89265    /**
89266     * Constructs the tree of SDO_DataObjects from the given xml instance
89267     * string. Returns SDO_DAS_XML_Document Object. Use
89268     * SDO_DAS_XML_Document::getRootDataObject method to get root data
89269     * object.
89270     *
89271     * @param string $xml_string xml string.
89272     * @return SDO_DAS_XML_Document
89273     * @since ^
89274     **/
89275    function loadString($xml_string){}
89276
89277    /**
89278     * Saves the SDO_DAS_XML_Document object to a file.
89279     *
89280     * @param SDO_XMLDocument $xdoc SDO_DAS_XML_Document object.
89281     * @param string $xml_file xml file.
89282     * @param int $indent Optional argument to specify that the xml should
89283     *   be formatted. A non-negative integer is the amount to indent each
89284     *   level of the xml. So, the integer 2, for example, will indent the
89285     *   xml so that each contained element is two spaces further to the
89286     *   right than its containing element. The integer 0 will cause the xml
89287     *   to be completely left-aligned. The integer -1 means no formatting -
89288     *   the xml will come out on one long line.
89289     * @return void
89290     * @since ^
89291     **/
89292    function saveFile($xdoc, $xml_file, $indent){}
89293
89294    /**
89295     * Saves the SDO_DAS_XML_Document object to string.
89296     *
89297     * @param SDO_XMLDocument $xdoc SDO_DAS_XML_Document object.
89298     * @param int $indent Optional argument to specify that the xml should
89299     *   be formatted. A non-negative integer is the amount to indent each
89300     *   level of the xml. So, the integer 2, for example, will indent the
89301     *   xml so that each contained element is two spaces further to the
89302     *   right than its containing element. The integer 0 will cause the xml
89303     *   to be completely left-aligned. The integer -1 means no formatting -
89304     *   the xml will come out on one long line.
89305     * @return string
89306     * @since ^
89307     **/
89308    function saveString($xdoc, $indent){}
89309
89310}
89311class SDO_DAS_XML_Document {
89312    /**
89313     * Returns the root SDO_DataObject.
89314     *
89315     * @return SDO_DataObject
89316     * @since ^
89317     **/
89318    function getRootDataObject(){}
89319
89320    /**
89321     * Returns root element's name.
89322     *
89323     * @return string
89324     * @since ^
89325     **/
89326    function getRootElementName(){}
89327
89328    /**
89329     * Returns root element's URI string.
89330     *
89331     * @return string
89332     * @since ^
89333     **/
89334    function getRootElementURI(){}
89335
89336    /**
89337     * Sets the given string as encoding.
89338     *
89339     * @param string $encoding Encoding string.
89340     * @return void
89341     * @since ^
89342     **/
89343    function setEncoding($encoding){}
89344
89345    /**
89346     * Controls whether an XML declaration will be generated at the start of
89347     * the XML document. Set to to generate the XML declaration, or to
89348     * suppress it.
89349     *
89350     * @param bool $xmlDeclatation Boolean value to set the XML
89351     *   declaration.
89352     * @return void
89353     * @since ^
89354     **/
89355    function setXMLDeclaration($xmlDeclatation){}
89356
89357    /**
89358     * Sets the given string as xml version.
89359     *
89360     * @param string $xmlVersion xml version string.
89361     * @return void
89362     * @since ^
89363     **/
89364    function setXMLVersion($xmlVersion){}
89365
89366}
89367class SDO_DataFactory {
89368    /**
89369     * Create a new SDO_DataObject given the data object's namespace URI and
89370     * type name.
89371     *
89372     * @param string $type_namespace_uri The namespace of the type.
89373     * @param string $type_name The name of the type.
89374     * @return void
89375     * @since ^
89376     **/
89377    function create($type_namespace_uri, $type_name){}
89378
89379}
89380class SDO_DataObject {
89381    /**
89382     * Clear an SDO_DataObject's properties. Read-only properties are
89383     * unaffected. Subsequent calls to isset() for the data object will
89384     * return .
89385     *
89386     * @return void
89387     * @since ^
89388     **/
89389    function clear(){}
89390
89391    /**
89392     * Create a child SDO_DataObject of the default type for the property
89393     * identified. The data object is automatically inserted into the tree
89394     * and a reference to it is returned.
89395     *
89396     * @param mixed $identifier Identifies the property for the data object
89397     *   type to be created. Can be either a property name (string), a
89398     *   property index (int), or an SDO_Model_Property.
89399     * @return SDO_DataObject
89400     * @since ^
89401     **/
89402    function createDataObject($identifier){}
89403
89404    /**
89405     * Get the data object which contains this data object.
89406     *
89407     * @return SDO_DataObject
89408     * @since ^
89409     **/
89410    function getContainer(){}
89411
89412    /**
89413     * Return the SDO_Sequence for this SDO_DataObject. Accessing the
89414     * SDO_DataObject through the SDO_Sequence interface acts on the same
89415     * SDO_DataObject instance data, but preserves ordering across
89416     * properties.
89417     *
89418     * @return SDO_Sequence
89419     * @since ^
89420     **/
89421    function getSequence(){}
89422
89423    /**
89424     * Return the name of the type for a data object. A convenience method
89425     * corresponding to SDO_Model_ReflectionDataObject::getType().getName().
89426     *
89427     * @return string
89428     * @since ^
89429     **/
89430    function getTypeName(){}
89431
89432    /**
89433     * Return the namespace URI of the type for a data object. A convenience
89434     * method corresponding to
89435     * SDO_Model_ReflectionDataObject::getType().getNamespaceURI().
89436     *
89437     * @return string
89438     * @since ^
89439     **/
89440    function getTypeNamespaceURI(){}
89441
89442}
89443class SDO_Exception {
89444    /**
89445     * Returns the cause of this exception or NULL if the cause is
89446     * nonexistent or unknown. Typically the cause will be an
89447     * SDO_CPPException object, which may be used to obtain additional
89448     * diagnostic information.
89449     *
89450     * @return mixed
89451     * @since ^
89452     **/
89453    function getCause(){}
89454
89455}
89456class SDO_List {
89457    /**
89458     * Insert a new element at a specified position in the list. All
89459     * subsequent list items are moved up.
89460     *
89461     * @param mixed $value The new value to be inserted. This can be either
89462     *   a primitive or an SDO_DataObject.
89463     * @param int $index The position at which to insert the new element.
89464     *   If this argument is not specified then the new value will be
89465     *   appended.
89466     * @return void
89467     * @since ^
89468     **/
89469    function insert($value, $index){}
89470
89471}
89472class SDO_Model_Property {
89473    /**
89474     * Returns the SDO_Model_Type which contains this property.
89475     *
89476     * @return SDO_Model_Type
89477     * @since ^
89478     **/
89479    function getContainingType(){}
89480
89481    /**
89482     * Returns the default value for the property. Only primitive data type
89483     * properties can have default values.
89484     *
89485     * @return mixed
89486     * @since ^
89487     **/
89488    function getDefault(){}
89489
89490    /**
89491     * Returns the name of the SDO_Model_Property.
89492     *
89493     * @return string
89494     * @since ^
89495     **/
89496    function getName(){}
89497
89498    /**
89499     * Get the SDO_Model_Type of the property. The SDO_Model_Type describes
89500     * the type information for the property, such as its type name,
89501     * namespace URI, whether it is a primitive data type, and so on.
89502     *
89503     * @return SDO_Model_Type
89504     * @since ^
89505     **/
89506    function getType(){}
89507
89508    /**
89509     * Test to see if the property corresponds to a containment relationship.
89510     * Returns if the property defines a containment relationship, or if it
89511     * is reference.
89512     *
89513     * @return bool
89514     * @since ^
89515     **/
89516    function isContainment(){}
89517
89518    /**
89519     * Test to see if the property is many-valued. Returns if this is a
89520     * many-valued property, otherwise returns .
89521     *
89522     * @return bool
89523     * @since ^
89524     **/
89525    function isMany(){}
89526
89527}
89528class SDO_Model_ReflectionDataObject {
89529    /**
89530     * Get a string describing the SDO_DataObject. The default behaviour is
89531     * to print the output, but if is specified for return, it is returned as
89532     * a string.
89533     *
89534     * @param SDO_Model_ReflectionDataObject $rdo An
89535     *   SDO_Model_ReflectionDataObject.
89536     * @param bool $return If , return the output as a string, otherwise
89537     *   print it.
89538     * @return mixed
89539     * @since ^
89540     **/
89541    function export($rdo, $return){}
89542
89543    /**
89544     * Get the SDO_Model_Property that contains the SDO_DataObject. This
89545     * method is used to navigate up to the parent's property which contains
89546     * the data object which has been reflected upon.
89547     *
89548     * @return SDO_Model_Property
89549     * @since ^
89550     **/
89551    function getContainmentProperty(){}
89552
89553    /**
89554     * Get the instance properties for the SDO_DataObject. The instance
89555     * properties consist of all the properties defined on the data object's
89556     * type, plus any instance properties from open content (if the data
89557     * object is an open type).
89558     *
89559     * @return array
89560     * @since ^
89561     **/
89562    function getInstanceProperties(){}
89563
89564    /**
89565     * Returns the SDO_Model_Type for the SDO_DataObject. The SDO_Model_Type
89566     * holds all the information about the data object's type, such as
89567     * namespace URI, type name, whether it is a primitive data type, and so
89568     * on.
89569     *
89570     * @return SDO_Model_Type
89571     * @since ^
89572     **/
89573    function getType(){}
89574
89575    /**
89576     * Construct an SDO_Model_ReflectionDataObject to reflect on an
89577     * SDO_DataObject. Reflecting on an SDO_DataObject gives access to
89578     * information about its model. The model contains information such as
89579     * the data object's type, and whether that type is sequenced (preserves
89580     * ordering across properties) or open (each instance can have its model
89581     * extended). The model also holds information about the data object's
89582     * properties, any default values they may have, and so on.
89583     *
89584     * @param SDO_DataObject $data_object The SDO_DataObject being
89585     *   reflected upon.
89586     * @return SDO_Model_ReflectionDataObject
89587     * @since ^
89588     **/
89589    function __construct($data_object){}
89590
89591}
89592class SDO_Model_Type {
89593    /**
89594     * Get the base type for this type. Returns the SDO_Model_Type for the
89595     * base type if this type inherits from another, otherwise returns . An
89596     * example of when base types occur is when a type defined in XML schema
89597     * inherits from another type by using <extension base="..."> .
89598     *
89599     * @return SDO_Model_Type
89600     * @since ^
89601     **/
89602    function getBaseType(){}
89603
89604    /**
89605     * Returns the name of the type. The combination of type name and
89606     * namespace URI is used to uniquely identify the type.
89607     *
89608     * @return string
89609     * @since ^
89610     **/
89611    function getName(){}
89612
89613    /**
89614     * Returns the namespace URI of the type. The combination of namespace
89615     * URI and type name is used to uniquely identify the type.
89616     *
89617     * @return string
89618     * @since ^
89619     **/
89620    function getNamespaceURI(){}
89621
89622    /**
89623     * Get an array of SDO_Model_Property objects describing the properties
89624     * defined for the SDO_Model_Type. Each SDO_Model_Property holds
89625     * information such as the property name, default value, and so on.
89626     *
89627     * @return array
89628     * @since ^
89629     **/
89630    function getProperties(){}
89631
89632    /**
89633     * Get an SDO_Model_Property of the type, identified by its property
89634     * index or property name.
89635     *
89636     * @param mixed $identifier The property index or property name.
89637     * @return SDO_Model_Property
89638     * @since ^
89639     **/
89640    function getProperty($identifier){}
89641
89642    /**
89643     * Test to see if this SDO_Model_Type is an abstract data type. Returns
89644     * if this type is abstract, that is, no SDO_DataObject of this type can
89645     * be instantiated, though other types may inherit from it.
89646     *
89647     * @return bool
89648     * @since ^
89649     **/
89650    function isAbstractType(){}
89651
89652    /**
89653     * Test to see if this SDO_Model_Type is a primitive data type. Returns
89654     * if this type is a primitive data type, otherwise returns .
89655     *
89656     * @return bool
89657     * @since ^
89658     **/
89659    function isDataType(){}
89660
89661    /**
89662     * Test for an SDO_DataObject being an instance of this SDO_Model_Type.
89663     * Returns if the SDO_DataObject provided is an instance of this
89664     * SDO_Model_Type, or a derived type, otherwise returns .
89665     *
89666     * @param SDO_DataObject $data_object The SDO_DataObject to be tested.
89667     * @return bool
89668     * @since ^
89669     **/
89670    function isInstance($data_object){}
89671
89672    /**
89673     * Test to see if this type is open. Returns if this type is open,
89674     * otherwise returns . An SDO_DataObject whose type is open can have
89675     * properties added to them which are not described by the type. This
89676     * capability is used to support working with XML documents whose schema
89677     * support open content, such as that defined by an <xsd:any> element.
89678     *
89679     * @return bool
89680     * @since ^
89681     **/
89682    function isOpenType(){}
89683
89684    /**
89685     * Test to see if this is a sequenced type. Returns if this type is
89686     * sequence, otherwise returns . Sequenced types can have the ordering
89687     * across properties preserved and can contain unstructured text. For
89688     * more information on sequenced types see the section on Working with
89689     * Sequenced Data Objects.
89690     *
89691     * @return bool
89692     * @since ^
89693     **/
89694    function isSequencedType(){}
89695
89696}
89697class SDO_Sequence {
89698    /**
89699     * Return the property for the specified sequence index.
89700     *
89701     * @param int $sequence_index The position of the element in the
89702     *   sequence.
89703     * @return SDO_Model_Property
89704     * @since ^
89705     **/
89706    function getProperty($sequence_index){}
89707
89708    /**
89709     * Insert a new element at a specified position in the sequence. All
89710     * subsequent sequence items are moved up.
89711     *
89712     * @param mixed $value The new value to be inserted. This can be either
89713     *   a primitive or an SDO_DataObject.
89714     * @param int $sequenceIndex The position at which to insert the new
89715     *   element. Default is NULL, which results in the new value being
89716     *   appended to the sequence.
89717     * @param mixed $propertyIdentifier Either a property index, a property
89718     *   name, or an SDO_Model_Property, used to identify a property in the
89719     *   sequence's corresponding SDO_DataObject. A value of NULL signifies
89720     *   unstructured text.
89721     * @return void
89722     * @since ^
89723     **/
89724    function insert($value, $sequenceIndex, $propertyIdentifier){}
89725
89726    /**
89727     * Modify the position of the item in the sequence, without altering the
89728     * value of the property in the SDO_DataObject.
89729     *
89730     * @param int $toIndex The destination sequence index. If this index is
89731     *   less than zero or greater than the size of the sequence then the
89732     *   value is appended.
89733     * @param int $fromIndex The source sequence index.
89734     * @return void
89735     * @since ^
89736     **/
89737    function move($toIndex, $fromIndex){}
89738
89739}
89740/**
89741 * The Seekable iterator.
89742 **/
89743interface SeekableIterator extends Iterator {
89744    /**
89745     * Seeks to a given position in the iterator.
89746     *
89747     * @param int $position The position to seek to.
89748     * @return void
89749     * @since PHP 5 >= 5.1.0
89750     **/
89751    function seek($position);
89752
89753}
89754/**
89755 * Interface for customized serializing.
89756 *
89757 * Classes that implement this interface no longer support and . The
89758 * method serialize is called whenever an instance needs to be
89759 * serialized. This does not invoke __destruct() or has any other side
89760 * effect unless programmed inside the method. When the data is
89761 * unserialized the class is known and the appropriate unserialize()
89762 * method is called as a constructor instead of calling __construct(). If
89763 * you need to execute the standard constructor you may do so in the
89764 * method.
89765 **/
89766interface Serializable {
89767    /**
89768     * Should return the string representation of the object.
89769     *
89770     * @return string
89771     * @since PHP 5 >= 5.1.0
89772     **/
89773    function serialize();
89774
89775    /**
89776     * Called during unserialization of the object.
89777     *
89778     * @param string $serialized The string representation of the object.
89779     * @return mixed
89780     * @since PHP 5 >= 5.1.0
89781     **/
89782    function unserialize($serialized);
89783
89784}
89785/**
89786 * Represents an element in XML document.
89787 **/
89788class SimpleXMLElement {
89789    /**
89790     * Adds an attribute to the SimpleXML element.
89791     *
89792     * @param string $name The name of the attribute to add.
89793     * @param string $value The value of the attribute.
89794     * @param string $namespace If specified, the namespace to which the
89795     *   attribute belongs.
89796     * @return void
89797     * @since PHP 5 >= 5.1.3
89798     **/
89799    function addAttribute($name, $value, $namespace){}
89800
89801    /**
89802     * Adds a child element to the node and returns a SimpleXMLElement of the
89803     * child.
89804     *
89805     * @param string $name The name of the child element to add.
89806     * @param string $value If specified, the value of the child element.
89807     * @param string $namespace If specified, the namespace to which the
89808     *   child element belongs.
89809     * @return SimpleXMLElement
89810     * @since PHP 5 >= 5.1.3
89811     **/
89812    function addChild($name, $value, $namespace){}
89813
89814    /**
89815     * The asXML method formats the parent object's data in XML version 1.0.
89816     *
89817     * @param string $filename If specified, the function writes the data
89818     *   to the file rather than returning it.
89819     * @return mixed
89820     * @since PHP 5 >= 5.0.1
89821     **/
89822    function asXML($filename){}
89823
89824    /**
89825     * This function provides the attributes and values defined within an xml
89826     * tag.
89827     *
89828     * @param string $ns An optional namespace for the retrieved attributes
89829     * @param bool $is_prefix Default to
89830     * @return SimpleXMLElement
89831     * @since PHP 5 >= 5.0.1
89832     **/
89833    function attributes($ns, $is_prefix){}
89834
89835    /**
89836     * This method finds the children of an element. The result follows
89837     * normal iteration rules.
89838     *
89839     * @param string $ns An XML namespace.
89840     * @param bool $is_prefix If {@link is_prefix} is , {@link ns} will be
89841     *   regarded as a prefix. If , {@link ns} will be regarded as a
89842     *   namespace URL.
89843     * @return SimpleXMLElement
89844     * @since PHP 5 >= 5.0.1
89845     **/
89846    function children($ns, $is_prefix){}
89847
89848    /**
89849     * This method counts the number of children of an element.
89850     *
89851     * @return integer
89852     * @since PHP 5 >= 5.3.0
89853     **/
89854    function count(){}
89855
89856    /**
89857     * Returns namespaces declared in document
89858     *
89859     * @param bool $recursive If specified, returns all namespaces declared
89860     *   in parent and child nodes. Otherwise, returns only namespaces
89861     *   declared in root node.
89862     * @return array
89863     * @since PHP 5 >= 5.1.2
89864     **/
89865    function getDocNamespaces($recursive){}
89866
89867    /**
89868     * Gets the name of the XML element.
89869     *
89870     * @return string
89871     * @since PHP 5 >= 5.1.3
89872     **/
89873    function getName(){}
89874
89875    /**
89876     * Returns namespaces used in document
89877     *
89878     * @param bool $recursive If specified, returns all namespaces used in
89879     *   parent and child nodes. Otherwise, returns only namespaces used in
89880     *   root node.
89881     * @return array
89882     * @since PHP 5 >= 5.1.2
89883     **/
89884    function getNamespaces($recursive){}
89885
89886    /**
89887     * Creates a prefix/ns context for the next XPath query. In particular,
89888     * this is helpful if the provider of the given XML document alters the
89889     * namespace prefixes. registerXPathNamespace will create a prefix for
89890     * the associated namespace, allowing one to access nodes in that
89891     * namespace without the need to change code to allow for the new
89892     * prefixes dictated by the provider.
89893     *
89894     * @param string $prefix The namespace prefix to use in the XPath query
89895     *   for the namespace given in {@link ns}.
89896     * @param string $ns The namespace to use for the XPath query. This
89897     *   must match a namespace in use by the XML document or the XPath query
89898     *   using {@link prefix} will not return any results.
89899     * @return bool
89900     * @since PHP 5 >= 5.2.0
89901     **/
89902    function registerXPathNamespace($prefix, $ns){}
89903
89904    /**
89905     * The xpath method searches the SimpleXML node for children matching the
89906     * XPath {@link path}.
89907     *
89908     * @param string $path An XPath path
89909     * @return array
89910     * @since PHP 5 >= 5.2.0
89911     **/
89912    function xpath($path){}
89913
89914}
89915/**
89916 * The SimpleXMLIterator provides recursive iteration over all nodes of a
89917 * object.
89918 **/
89919class SimpleXMLIterator extends SimpleXMLElement implements RecursiveIterator, Traversable, Iterator, Countable {
89920    /**
89921     * This method returns the current element as a SimpleXMLIterator object
89922     * or .
89923     *
89924     * @return mixed
89925     * @since PHP 5 >= 5.1.3
89926     **/
89927    function current(){}
89928
89929    /**
89930     * This method returns a SimpleXMLIterator object containing sub-elements
89931     * of the current SimpleXMLIterator element.
89932     *
89933     * @return object
89934     * @since PHP 5 >= 5.1.3
89935     **/
89936    function getChildren(){}
89937
89938    /**
89939     * This method checks whether the current SimpleXMLIterator element has
89940     * sub-elements.
89941     *
89942     * @return bool
89943     * @since PHP 5 >= 5.1.3
89944     **/
89945    function hasChildren(){}
89946
89947    /**
89948     * This method gets the XML tag name of the current element.
89949     *
89950     * @return mixed
89951     * @since PHP 5 >= 5.1.3
89952     **/
89953    function key(){}
89954
89955    /**
89956     * This method moves the SimpleXMLIterator to the next element.
89957     *
89958     * @return void
89959     * @since PHP 5 >= 5.1.3
89960     **/
89961    function next(){}
89962
89963    /**
89964     * This method rewinds the SimpleXMLIterator to the first element.
89965     *
89966     * @return void
89967     * @since PHP 5 >= 5.1.3
89968     **/
89969    function rewind(){}
89970
89971    /**
89972     * This method checks if the current element is valid after calls to
89973     * SimpleXMLIterator::rewind or SimpleXMLIterator::next.
89974     *
89975     * @return bool
89976     * @since PHP 5 >= 5.1.3
89977     **/
89978    function valid(){}
89979
89980}
89981/**
89982 * The SoapClient class provides a client for , servers. It can be used
89983 * in WSDL or non-WSDL mode.
89984 **/
89985class SoapClient {
89986    /**
89987     * SoapClient::SoapClient
89988     *
89989     * @param mixed $wsdl
89990     * @param array $options
89991     * @since PHP 5 >= 5.0.1
89992     **/
89993    function SoapClient($wsdl, $options){}
89994
89995    /**
89996     * This method is deprecated. Use instead of it.
89997     *
89998     * @param string $function_name
89999     * @param string $arguments
90000     * @return mixed
90001     * @since PHP 5 >= 5.0.1
90002     **/
90003    function __call($function_name, $arguments){}
90004
90005    /**
90006     * Performs SOAP request over HTTP.
90007     *
90008     * This method can be overridden in subclasses to implement different
90009     * transport layers, perform additional XML processing or other purpose.
90010     *
90011     * @param string $request The XML SOAP request.
90012     * @param string $location The URL to request.
90013     * @param string $action The SOAP action.
90014     * @param int $version The SOAP version.
90015     * @param int $one_way If one_way is set to 1, this method returns
90016     *   nothing. Use this where a response is not expected.
90017     * @return string
90018     * @since PHP 5 >= 5.0.1
90019     **/
90020    function __doRequest($request, $location, $action, $version, $one_way){}
90021
90022    /**
90023     * Returns an array of functions described in the WSDL for the Web
90024     * service.
90025     *
90026     * @return array
90027     * @since PHP 5 >= 5.0.1
90028     **/
90029    function __getFunctions(){}
90030
90031    /**
90032     * Returns the XML sent in the last SOAP request.
90033     *
90034     * @return string
90035     * @since PHP 5 >= 5.0.1
90036     **/
90037    function __getLastRequest(){}
90038
90039    /**
90040     * Returns the SOAP headers from the last request.
90041     *
90042     * @return string
90043     * @since PHP 5 >= 5.0.1
90044     **/
90045    function __getLastRequestHeaders(){}
90046
90047    /**
90048     * Returns the XML received in the last SOAP response.
90049     *
90050     * @return string
90051     * @since PHP 5 >= 5.0.1
90052     **/
90053    function __getLastResponse(){}
90054
90055    /**
90056     * Returns the SOAP headers from the last response.
90057     *
90058     * @return string
90059     * @since PHP 5 >= 5.0.1
90060     **/
90061    function __getLastResponseHeaders(){}
90062
90063    /**
90064     * Returns an array of types described in the WSDL for the Web service.
90065     *
90066     * @return array
90067     * @since PHP 5 >= 5.0.1
90068     **/
90069    function __getTypes(){}
90070
90071    /**
90072     * Defines a cookie to be sent along with the SOAP requests.
90073     *
90074     * @param string $name The name of the cookie.
90075     * @param string $value The value of the cookie. If not specified, the
90076     *   cookie will be deleted.
90077     * @return void
90078     * @since PHP 5 >= 5.0.4
90079     **/
90080    function __setCookie($name, $value){}
90081
90082    /**
90083     * Sets the endpoint URL that will be touched by following SOAP requests.
90084     * This is equivalent to specifying the location option when constructing
90085     * the SoapClient.
90086     *
90087     * @param string $new_location The new endpoint URL.
90088     * @return string
90089     * @since PHP 5 >= 5.0.1
90090     **/
90091    function __setLocation($new_location){}
90092
90093    /**
90094     * Defines headers to be sent along with the SOAP requests.
90095     *
90096     * @param mixed $soapheaders The headers to be set. It could be
90097     *   SoapHeader object or array of SoapHeader objects. If not specified
90098     *   or set to , the headers will be deleted.
90099     * @return bool
90100     * @since PHP 5 >= 5.0.5
90101     **/
90102    function __setSoapHeaders($soapheaders){}
90103
90104    /**
90105     * This is a low level API function that is used to make a SOAP call.
90106     * Usually, in WSDL mode, SOAP functions can be called as methods of the
90107     * SoapClient object. This method is useful in non-WSDL mode when
90108     * soapaction is unknown, uri differs from the default or when sending
90109     * and/or receiving SOAP Headers.
90110     *
90111     * On error, a call to a SOAP function can cause PHP to throw exceptions
90112     * or return a SoapFault object if exceptions are disabled. To check if
90113     * the function call failed to catch the SoapFault exceptions, check the
90114     * result with {@link is_soap_fault}.
90115     *
90116     * @param string $function_name The name of the SOAP function to call.
90117     * @param array $arguments An array of the arguments to pass to the
90118     *   function. This can be either an ordered or an associative array.
90119     * @param array $options An associative array of options to pass to the
90120     *   client. The location option is the URL of the remote Web service.
90121     *   The uri option is the target namespace of the SOAP service. The
90122     *   soapaction option is the action to call.
90123     * @param mixed $input_headers An array of headers to be sent along
90124     *   with the SOAP request.
90125     * @param array $output_headers If supplied, this array will be filled
90126     *   with the headers from the SOAP response.
90127     * @return mixed
90128     * @since PHP 5 >= 5.0.1
90129     **/
90130    function __soapCall($function_name, $arguments, $options, $input_headers, &$output_headers){}
90131
90132}
90133/**
90134 * Represents a SOAP fault.
90135 **/
90136class SoapFault extends Exception {
90137    /**
90138     * This class is used to send SOAP fault responses from the PHP handler.
90139     * {@link faultcode}, {@link faultstring}, {@link faultactor} and {@link
90140     * details} are standard elements of a SOAP Fault.
90141     *
90142     * @param string $faultcode The error code of the SoapFault.
90143     * @param string $faultstring The error message of the SoapFault.
90144     * @param string $faultactor A string identifying the actor that caused
90145     *   the error.
90146     * @param string $detail More details about the cause of the error.
90147     * @param string $faultname Can be used to select the proper fault
90148     *   encoding from WSDL.
90149     * @param string $headerfault Can be used during SOAP header handling
90150     *   to report an error in the response header.
90151     * @since PHP 5 >= 5.0.1
90152     **/
90153    function SoapFault($faultcode, $faultstring, $faultactor, $detail, $faultname, $headerfault){}
90154
90155    /**
90156     * SoapFault::SoapFault
90157     *
90158     * @param string $faultcode
90159     * @param string $faultstring
90160     * @param string $faultactor
90161     * @param string $detail
90162     * @param string $faultname
90163     * @param string $headerfault
90164     * @since PHP 5 >= 5.0.1
90165     **/
90166    function __construct($faultcode, $faultstring, $faultactor, $detail, $faultname, $headerfault){}
90167
90168    /**
90169     * Returns a string representation of the SoapFault.
90170     *
90171     * @return string
90172     * @since PHP 5 >= 5.0.1
90173     **/
90174    function __toString(){}
90175
90176}
90177/**
90178 * Represents a SOAP header.
90179 **/
90180class SoapHeader {
90181    /**
90182     * Constructs a new SoapHeader object.
90183     *
90184     * @param string $namespace The namespace of the SOAP header element.
90185     * @param string $name The name of the SoapHeader object.
90186     * @param mixed $data A SOAP header's content. It can be a PHP value or
90187     *   a SoapVar object.
90188     * @param bool $mustunderstand Value of the mustUnderstand attribute of
90189     *   the SOAP header element.
90190     * @param string $actor Value of the actor attribute of the SOAP header
90191     *   element.
90192     * @since PHP 5 >= 5.0.1
90193     **/
90194    function SoapHeader($namespace, $name, $data, $mustunderstand, $actor){}
90195
90196    /**
90197     * SoapHeader::SoapHeader
90198     *
90199     * @param string $namespace
90200     * @param string $name
90201     * @param mixed $data
90202     * @param bool $mustunderstand
90203     * @param string $actor
90204     * @since PHP 5 >= 5.0.1
90205     **/
90206    function __construct($namespace, $name, $data, $mustunderstand, $actor){}
90207
90208}
90209/**
90210 * Represents parameter to a SOAP call.
90211 **/
90212class SoapParam {
90213    /**
90214     * Constructs a new SoapParam object.
90215     *
90216     * @param mixed $data The data to pass or return. This parameter can be
90217     *   passed directly as PHP value, but in this case it will be named as
90218     *   paramN and the SOAP service may not understand it.
90219     * @param string $name The parameter name.
90220     * @since PHP 5 >= 5.0.1
90221     **/
90222    function SoapParam($data, $name){}
90223
90224    /**
90225     * SoapParam::SoapParam
90226     *
90227     * @param mixed $data
90228     * @param string $name
90229     * @since PHP 5 >= 5.0.1
90230     **/
90231    function __construct($data, $name){}
90232
90233}
90234/**
90235 * The SoapServer class provides a server for the and protocols. It can
90236 * be used with or without a WSDL service description.
90237 **/
90238class SoapServer {
90239    /**
90240     * Exports one or more functions for remote clients
90241     *
90242     * @param string $functions To export one function, pass the function
90243     *   name into this parameter as a string. To export several functions,
90244     *   pass an array of function names. To export all the functions, pass a
90245     *   special constant SOAP_FUNCTIONS_ALL.
90246     * @return void
90247     * @since PHP 5 >= 5.0.1
90248     **/
90249    function addFunction($functions){}
90250
90251    /**
90252     * Adds a SOAP header to be returned with the response to the current
90253     * request.
90254     *
90255     * @param SoapHeader $object The header to be returned.
90256     * @return void
90257     * @since PHP 5 >= 5.0.1
90258     **/
90259    function addSoapHeader($object){}
90260
90261    /**
90262     * Sends a response to the client of the current request indicating an
90263     * error.
90264     *
90265     * @param string $code The error code to return
90266     * @param string $string A brief description of the error
90267     * @param string $actor A string identifying the actor that caused the
90268     *   fault.
90269     * @param string $details More details of the fault
90270     * @param string $name The name of the fault. This can be used to
90271     *   select a name from a WSDL file.
90272     * @return void
90273     * @since PHP 5 >= 5.0.1
90274     **/
90275    function fault($code, $string, $actor, $details, $name){}
90276
90277    /**
90278     * Returns a list of the defined functions in the SoapServer object. This
90279     * method returns the list of all functions added by
90280     * SoapServer::addFunction or SoapServer::setClass.
90281     *
90282     * @return array
90283     * @since PHP 5 >= 5.0.1
90284     **/
90285    function getFunctions(){}
90286
90287    /**
90288     * Processes a SOAP request, calls necessary functions, and sends a
90289     * response back.
90290     *
90291     * @param string $soap_request The SOAP request. If this argument is
90292     *   omitted, the request is assumed to be in the raw POST data of the
90293     *   HTTP request.
90294     * @return void
90295     * @since PHP 5 >= 5.0.1
90296     **/
90297    function handle($soap_request){}
90298
90299    /**
90300     * Exports all methods from specified class.
90301     *
90302     * The object can be made persistent across request for a given PHP
90303     * session with the SoapServer::setPersistence method.
90304     *
90305     * @param string $class_name The name of the exported class.
90306     * @param string $args These optional parameters will be passed to the
90307     *   default class constructor during object creation.
90308     * @return void
90309     * @since PHP 5 >= 5.0.1
90310     **/
90311    function setClass($class_name, $args){}
90312
90313    /**
90314     * This sets a specific object as the handler for SOAP requests, rather
90315     * than just a class as in SoapServer::setClass.
90316     *
90317     * @param string $object The object to handle the requests.
90318     * @return void
90319     * @since PHP 5 >= 5.2.0
90320     **/
90321    function setObject($object){}
90322
90323    /**
90324     * This function allows saving data between requests in a PHP session. It
90325     * works only with a server that exports functions from a class with
90326     * SoapServer::setClass or SoapServer::setObject.
90327     *
90328     * @param string $mode One of the SOAP_PERSISTENCE_XXX constants.
90329     *   SOAP_PERSISTENCE_REQUEST - persist the object for the duration of a
90330     *   request. SOAP_PERSISTENCE_SESSION - persist the object for the
90331     *   duration of a session.
90332     * @return void
90333     * @since PHP 5 >= 5.1.2
90334     **/
90335    function setPersistence($mode){}
90336
90337    /**
90338     * This constructor allows the creation of SoapServer objects in WSDL or
90339     * non-WSDL mode.
90340     *
90341     * @param mixed $wsdl To use the SoapServer in WSDL mode, pass the URI
90342     *   of a WSDL file. Otherwise, pass and set the uri option to the target
90343     *   namespace for the server.
90344     * @param array $options Allow setting a default SOAP version
90345     *   (soap_version), internal character encoding (encoding), and actor
90346     *   URI (actor). The classmap option can be used to map some WSDL types
90347     *   to PHP classes. This option must be an array with WSDL types as keys
90348     *   and names of PHP classes as values. The typemap option is an array
90349     *   of type mappings. Type mapping is an array with keys type_name,
90350     *   type_ns (namespace URI), from_xml (callback accepting one string
90351     *   parameter) and to_xml (callback accepting one object parameter). The
90352     *   cache_wsdl option is one of WSDL_CACHE_NONE, WSDL_CACHE_DISK,
90353     *   WSDL_CACHE_MEMORY or WSDL_CACHE_BOTH. There is also a features
90354     *   option which can be set to SOAP_WAIT_ONE_WAY_CALLS,
90355     *   SOAP_SINGLE_ELEMENT_ARRAYS, SOAP_USE_XSI_ARRAY_TYPE.
90356     * @since PHP 5 >= 5.0.1
90357     **/
90358    function SoapServer($wsdl, $options){}
90359
90360    /**
90361     * SoapServer::SoapServer
90362     *
90363     * @param mixed $wsdl
90364     * @param array $options
90365     * @since PHP 5 >= 5.0.1
90366     **/
90367    function __construct($wsdl, $options){}
90368
90369}
90370/**
90371 * A class representing a variable or object for use with SOAP services.
90372 **/
90373class SoapVar {
90374    /**
90375     * Constructs a new SoapVar object.
90376     *
90377     * @param string $data The data to pass or return.
90378     * @param string $encoding The encoding ID, one of the XSD_...
90379     *   constants.
90380     * @param string $type_name The type name.
90381     * @param string $type_namespace The type namespace.
90382     * @param string $node_name The XML node name.
90383     * @param string $node_namespace The XML node namespace.
90384     * @since PHP 5 >= 5.0.1
90385     **/
90386    function SoapVar($data, $encoding, $type_name, $type_namespace, $node_name, $node_namespace){}
90387
90388    /**
90389     * SoapVar::SoapVar
90390     *
90391     * @param string $data
90392     * @param string $encoding
90393     * @param string $type_name
90394     * @param string $type_namespace
90395     * @param string $node_name
90396     * @param string $node_namespace
90397     * @since PHP 5 >= 5.0.1
90398     **/
90399    function __construct($data, $encoding, $type_name, $type_namespace, $node_name, $node_namespace){}
90400
90401}
90402/**
90403 * Used to send requests to a Solr server. Currently, cloning and
90404 * serialization of SolrClient instances is not supported.
90405 **/
90406class SolrClient {
90407    /**
90408     * This method adds a document to the index.
90409     *
90410     * @param SolrInputDocument $doc The SolrInputDocument instance.
90411     * @param bool $allowDups If duplicates will be overwritten.
90412     * @param int $commitWithin Number of milliseconds within which to
90413     *   commit this document. Available since Solr 1.4
90414     * @return SolrUpdateResponse
90415     * @since PECL solr >= 0.9.2
90416     **/
90417    function addDocument($doc, $allowDups, $commitWithin){}
90418
90419    /**
90420     * Adds a collection of documents to the index.
90421     *
90422     * @param array $docs An array containing the collection of
90423     *   SolrInputDocument instances. This array must be an actual variable.
90424     * @param bool $allowDups If duplicates will be overwritten.
90425     * @param int $commitWithin Number of milliseconds within which to
90426     *   commit the documents to the index. This was only available since
90427     *   Solr 1.4
90428     * @return void
90429     * @since PECL solr >= 0.9.2
90430     **/
90431    function addDocuments($docs, $allowDups, $commitWithin){}
90432
90433    /**
90434     * This method finalizes all add/deletes made to the index.
90435     *
90436     * @param int $maxSegments Optimizes down to at most this number of
90437     *   segments. Since Solr 1.3
90438     * @param bool $waitFlush Block until index changes are flushed to
90439     *   disk.
90440     * @param bool $waitSearcher Block until a new searcher is opened and
90441     *   registered as the main query searcher, making the changes visible.
90442     * @return SolrUpdateResponse
90443     * @since PECL solr >= 0.9.2
90444     **/
90445    function commit($maxSegments, $waitFlush, $waitSearcher){}
90446
90447    /**
90448     * Deletes the document with the specified ID. Where ID is the value of
90449     * the uniqueKey field declared in the schema
90450     *
90451     * @param string $id The value of the uniqueKey field declared in the
90452     *   schema
90453     * @return SolrUpdateResponse
90454     * @since PECL solr >= 0.9.2
90455     **/
90456    function deleteById($id){}
90457
90458    /**
90459     * Deletes a collection of documents with the specified set of ids.
90460     *
90461     * @param array $ids An array of IDs representing the uniqueKey field
90462     *   declared in the schema for each document to be deleted. This must be
90463     *   an actual php variable.
90464     * @return SolrUpdateResponse
90465     * @since PECL solr >= 0.9.2
90466     **/
90467    function deleteByIds($ids){}
90468
90469    /**
90470     * Removes all documents matching any of the queries
90471     *
90472     * @param array $queries The array of queries. This must be an actual
90473     *   php variable.
90474     * @return SolrUpdateResponse
90475     * @since PECL solr >= 0.9.2
90476     **/
90477    function deleteByQueries($queries){}
90478
90479    /**
90480     * Deletes all documents matching the given query.
90481     *
90482     * @param string $query The query
90483     * @return SolrUpdateResponse
90484     * @since PECL solr >= 0.9.2
90485     **/
90486    function deleteByQuery($query){}
90487
90488    /**
90489     * Returns the debug data for the last connection attempt
90490     *
90491     * @return string
90492     * @since PECL solr >= 0.9.7
90493     **/
90494    function getDebug(){}
90495
90496    /**
90497     * Returns the client options set internally. Very useful for debugging.
90498     * The values returned are readonly and can only be set when the object
90499     * is instantiated.
90500     *
90501     * @return array
90502     * @since PECL solr >= 0.9.6
90503     **/
90504    function getOptions(){}
90505
90506    /**
90507     * Defragments the index for faster search performance.
90508     *
90509     * @param int $maxSegments Optimizes down to at most this number of
90510     *   segments. Since Solr 1.3
90511     * @param bool $waitFlush Block until index changes are flushed to
90512     *   disk.
90513     * @param bool $waitSearcher Block until a new searcher is opened and
90514     *   registered as the main query searcher, making the changes visible.
90515     * @return SolrUpdateResponse
90516     * @since PECL solr >= 0.9.2
90517     **/
90518    function optimize($maxSegments, $waitFlush, $waitSearcher){}
90519
90520    /**
90521     * Checks if the Solr server is still alive. Sends a HEAD request to the
90522     * Apache Solr server.
90523     *
90524     * @return SolrPingResponse
90525     * @since PECL solr >= 0.9.2
90526     **/
90527    function ping(){}
90528
90529    /**
90530     * Sends a query to the server.
90531     *
90532     * @param SolrParams $query A SolrParam object. It is recommended to
90533     *   use SolrQuery for advanced queries.
90534     * @return SolrQueryResponse
90535     * @since PECL solr >= 0.9.2
90536     **/
90537    function query($query){}
90538
90539    /**
90540     * Sends a raw XML update request to the server
90541     *
90542     * @param string $raw_request An XML string with the raw request to the
90543     *   server.
90544     * @return void
90545     * @since PECL solr >= 0.9.2
90546     **/
90547    function request($raw_request){}
90548
90549    /**
90550     * Rollbacks all add/deletes made to the index since the last commit. It
90551     * neither calls any event listeners nor creates a new searcher.
90552     *
90553     * @return SolrUpdateResponse
90554     * @since PECL solr >= 0.9.2
90555     **/
90556    function rollback(){}
90557
90558    /**
90559     * Sets the response writer used to prepare the response from Solr
90560     *
90561     * @param string $responseWriter One of the following : - xml -
90562     *   phpnative
90563     * @return void
90564     * @since PECL solr >= 0.9.11
90565     **/
90566    function setResponseWriter($responseWriter){}
90567
90568    /**
90569     * Changes the specified servlet type to a new value
90570     *
90571     * @param int $type One of the following : -
90572     *   SolrClient::SEARCH_SERVLET_TYPE - SolrClient::UPDATE_SERVLET_TYPE -
90573     *   SolrClient::THREADS_SERVLET_TYPE - SolrClient::PING_SERVLET_TYPE -
90574     *   SolrClient::TERMS_SERVLET_TYPE
90575     * @param string $value The new value for the servlet
90576     * @return bool
90577     * @since PECL solr >= 0.9.2
90578     **/
90579    function setServlet($type, $value){}
90580
90581    /**
90582     * Checks the threads status
90583     *
90584     * @return void
90585     * @since PECL solr >= 0.9.2
90586     **/
90587    function threads(){}
90588
90589    /**
90590     * Constructor for the SolrClient object
90591     *
90592     * @param array $clientOptions This is an array containing one of the
90593     *   following keys : - secure (Boolean value indicating whether or not
90594     *   to connect in secure mode) - hostname (The hostname for the Solr
90595     *   server) - port (The port number) - path (The path to solr) - wt (The
90596     *   name of the response writer e.g. xml, phpnative) - login (The
90597     *   username used for HTTP Authentication, if any) - password (The HTTP
90598     *   Authentication password) - proxy_host (The hostname for the proxy
90599     *   server, if any) - proxy_port (The proxy port) - proxy_login (The
90600     *   proxy username) - proxy_password (The proxy password) - timeout
90601     *   (This is maximum time in seconds allowed for the http data transfer
90602     *   operation. Default is 30 seconds) - ssl_cert (File name to a
90603     *   PEM-formatted file containing the private key + private certificate
90604     *   (concatenated in that order) ) - ssl_key (File name to a
90605     *   PEM-formatted private key file only) - ssl_keypassword (Password for
90606     *   private key) - ssl_cainfo (Name of file holding one or more CA
90607     *   certificates to verify peer with) - ssl_capath (Name of directory
90608     *   holding multiple CA certificates to verify peer with ) Please note
90609     *   the if the ssl_cert file only contains the private certificate, you
90610     *   have to specify a separate ssl_key file The ssl_keypassword option
90611     *   is required if the ssl_cert or ssl_key options are set.
90612     * @since PECL solr >= 0.9.2
90613     **/
90614    function __construct($clientOptions){}
90615
90616    /**
90617     * Destructor
90618     *
90619     * @return void
90620     * @since PECL solr >= 0.9.2
90621     **/
90622    function __destruct(){}
90623
90624}
90625/**
90626 * An exception thrown when there is an error while making a request to
90627 * the server from the client.
90628 **/
90629class SolrClientException extends SolrException {
90630    /**
90631     * Returns internal information where the Exception was thrown.
90632     *
90633     * @return array
90634     * @since PECL solr >= 0.9.2
90635     **/
90636    function getInternalInfo(){}
90637
90638}
90639/**
90640 * Represents a Solr document retrieved from a query response.
90641 **/
90642class SolrDocument implements ArrayAccess, Iterator, Traversable, Serializable {
90643    /**
90644     * This method adds a field to the SolrDocument instance.
90645     *
90646     * @param string $fieldName The name of the field
90647     * @param string $fieldValue The value of the field.
90648     * @return bool
90649     * @since PECL solr >= 0.9.2
90650     **/
90651    function addField($fieldName, $fieldValue){}
90652
90653    /**
90654     * Resets the current object. Discards all the fields and resets the
90655     * document boost to zero.
90656     *
90657     * @return bool
90658     * @since PECL solr >= 0.9.2
90659     **/
90660    function clear(){}
90661
90662    /**
90663     * Retrieves the current field
90664     *
90665     * @return SolrDocumentField
90666     * @since PECL solr >= 0.9.2
90667     **/
90668    function current(){}
90669
90670    /**
90671     * Removes a field from the document.
90672     *
90673     * @param string $fieldName Name of the field
90674     * @return bool
90675     * @since PECL solr >= 0.9.2
90676     **/
90677    function deleteField($fieldName){}
90678
90679    /**
90680     * Checks if the requested field as a valid fieldname in the document.
90681     *
90682     * @param string $fieldName The name of the field.
90683     * @return bool
90684     * @since PECL solr >= 0.9.2
90685     **/
90686    function fieldExists($fieldName){}
90687
90688    /**
90689     * Retrieves a field by name.
90690     *
90691     * @param string $fieldName Name of the field.
90692     * @return SolrDocumentField
90693     * @since PECL solr >= 0.9.2
90694     **/
90695    function getField($fieldName){}
90696
90697    /**
90698     * Returns the number of fields in this document. Multi-value fields are
90699     * only counted once.
90700     *
90701     * @return int
90702     * @since PECL solr >= 0.9.2
90703     **/
90704    function getFieldCount(){}
90705
90706    /**
90707     * Returns an array of fields names in the document.
90708     *
90709     * @return array
90710     * @since PECL solr >= 0.9.2
90711     **/
90712    function getFieldNames(){}
90713
90714    /**
90715     * Returns a SolrInputDocument equivalent of the object. This is useful
90716     * if one wishes to resubmit/update a document retrieved from a query.
90717     *
90718     * @return SolrInputDocument
90719     * @since PECL solr >= 0.9.2
90720     **/
90721    function getInputDocument(){}
90722
90723    /**
90724     * Retrieves the current key.
90725     *
90726     * @return string
90727     * @since PECL solr >= 0.9.2
90728     **/
90729    function key(){}
90730
90731    /**
90732     * Merges source to the current SolrDocument.
90733     *
90734     * @param SolrDocument $sourceDoc The source document.
90735     * @param bool $overwrite If this is then fields with the same name in
90736     *   the destination document will be overwritten.
90737     * @return bool
90738     * @since PECL solr >= 0.9.2
90739     **/
90740    function merge($sourceDoc, $overwrite){}
90741
90742    /**
90743     * Moves the internal pointer to the next field.
90744     *
90745     * @return void
90746     * @since PECL solr >= 0.9.2
90747     **/
90748    function next(){}
90749
90750    /**
90751     * Checks if a particular field exists. This is used when the object is
90752     * treated as an array.
90753     *
90754     * @param string $fieldName The name of the field.
90755     * @return bool
90756     * @since PECL solr >= 0.9.2
90757     **/
90758    function offsetExists($fieldName){}
90759
90760    /**
90761     * This is used to retrieve the field when the object is treated as an
90762     * array.
90763     *
90764     * @param string $fieldName The name of the field.
90765     * @return SolrDocumentField
90766     * @since PECL solr >= 0.9.2
90767     **/
90768    function offsetGet($fieldName){}
90769
90770    /**
90771     * Used when the object is treated as an array to add a field to the
90772     * document.
90773     *
90774     * @param string $fieldName The name of the field.
90775     * @param string $fieldValue The value for this field.
90776     * @return void
90777     * @since PECL solr >= 0.9.2
90778     **/
90779    function offsetSet($fieldName, $fieldValue){}
90780
90781    /**
90782     * Removes a field from the document.
90783     *
90784     * @param string $fieldName The name of the field.
90785     * @return void
90786     * @since PECL solr >= 0.9.2
90787     **/
90788    function offsetUnset($fieldName){}
90789
90790    /**
90791     * This is an alias to SolrDocument::clear()
90792     *
90793     * @return bool
90794     * @since PECL solr >= 0.9.2
90795     **/
90796    function reset(){}
90797
90798    /**
90799     * Resets the internal pointer to the beginning.
90800     *
90801     * @return void
90802     * @since PECL solr >= 0.9.2
90803     **/
90804    function rewind(){}
90805
90806    /**
90807     * Used for custom serialization.
90808     *
90809     * @return string
90810     * @since PECL solr >= 0.9.2
90811     **/
90812    function serialize(){}
90813
90814    /**
90815     * The fields are rearranged according to the specified criteria and sort
90816     * direction Fields can be sorted by boost values, field names and number
90817     * of values. The sortOrderBy parameter must be one of : *
90818     * SolrDocument::SORT_FIELD_NAME * SolrDocument::SORT_FIELD_BOOST_VALUE *
90819     * SolrDocument::SORT_FIELD_VALUE_COUNT The sortDirection can be one of :
90820     * * SolrDocument::SORT_DEFAULT * SolrDocument::SORT_ASC *
90821     * SolrDocument::SORT_DESC The default way is to sort in ascending order.
90822     *
90823     * @param int $sortOrderBy The sort criteria.
90824     * @param int $sortDirection The sort direction.
90825     * @return bool
90826     * @since PECL solr >= 0.9.2
90827     **/
90828    function sort($sortOrderBy, $sortDirection){}
90829
90830    /**
90831     * Returns an array representation of the document.
90832     *
90833     * @return array
90834     * @since PECL solr >= 0.9.2
90835     **/
90836    function toArray(){}
90837
90838    /**
90839     * Custom serialization of SolrDocument objects
90840     *
90841     * @param string $serialized An XML representation of the document.
90842     * @return void
90843     * @since PECL solr >= 0.9.2
90844     **/
90845    function unserialize($serialized){}
90846
90847    /**
90848     * Checks if the current position internally is still valid. It is used
90849     * during foreach operations.
90850     *
90851     * @return bool
90852     * @since PECL solr >= 0.9.2
90853     **/
90854    function valid(){}
90855
90856    /**
90857     * Creates a copy of a SolrDocument object. Not to be called directly.
90858     *
90859     * @return void
90860     * @since PECL solr >= 0.9.2
90861     **/
90862    function __clone(){}
90863
90864    /**
90865     * Constructor for SolrDocument
90866     *
90867     * @since PECL solr >= 0.9.2
90868     **/
90869    function __construct(){}
90870
90871    /**
90872     * Destructor for SolrDocument.
90873     *
90874     * @return void
90875     * @since PECL solr >= 0.9.2
90876     **/
90877    function __destruct(){}
90878
90879    /**
90880     * Magic method for accessing the field as a property.
90881     *
90882     * @param string $fieldName The name of the field.
90883     * @return SolrDocumentField
90884     * @since PECL solr >= 0.9.2
90885     **/
90886    function __get($fieldName){}
90887
90888    /**
90889     * Checks if a field exists
90890     *
90891     * @param string $fieldName Name of the field.
90892     * @return bool
90893     * @since PECL solr >= 0.9.2
90894     **/
90895    function __isset($fieldName){}
90896
90897    /**
90898     * Adds another field to the document. Used to set the fields as new
90899     * properties.
90900     *
90901     * @param string $fieldName Name of the field.
90902     * @param string $fieldValue Field value.
90903     * @return bool
90904     * @since PECL solr >= 0.9.2
90905     **/
90906    function __set($fieldName, $fieldValue){}
90907
90908    /**
90909     * Removes a field from the document when the field is access as an
90910     * object property.
90911     *
90912     * @param string $fieldName The name of the field.
90913     * @return bool
90914     * @since PECL solr >= 0.9.2
90915     **/
90916    function __unset($fieldName){}
90917
90918}
90919/**
90920 * This represents a field in a Solr document. All its properties are
90921 * read-only.
90922 **/
90923class SolrDocumentField {
90924    /**
90925     * Constructor.
90926     *
90927     * @since PECL solr >= 0.9.2
90928     **/
90929    function __construct(){}
90930
90931    /**
90932     * Destructor.
90933     *
90934     * @return void
90935     * @since PECL solr >= 0.9.2
90936     **/
90937    function __destruct(){}
90938
90939}
90940/**
90941 * This is the base class for all exception thrown by the Solr extension
90942 * classes.
90943 **/
90944class SolrException extends Exception {
90945    /**
90946     * Returns internal information where the Exception was thrown.
90947     *
90948     * @return array
90949     * @since PECL solr >= 0.9.2
90950     **/
90951    function getInternalInfo(){}
90952
90953}
90954/**
90955 * Represents a response from the solr server.
90956 **/
90957class SolrGenericResponse extends SolrResponse {
90958    /**
90959     * Constructor
90960     *
90961     * @since PECL solr >= 0.9.2
90962     **/
90963    function __construct(){}
90964
90965    /**
90966     * Destructor.
90967     *
90968     * @return void
90969     * @since PECL solr >= 0.9.2
90970     **/
90971    function __destruct(){}
90972
90973}
90974/**
90975 * This object is thrown when an illeglal or invalid argument is passed
90976 * to a method.
90977 **/
90978class SolrIllegalArgumentException extends SolrException {
90979    /**
90980     * Returns internal information where the Exception was thrown.
90981     *
90982     * @return array
90983     * @since PECL solr >= 0.9.2
90984     **/
90985    function getInternalInfo(){}
90986
90987}
90988/**
90989 * This object is thrown when an illegal or unsupported operation is
90990 * performed on an object.
90991 **/
90992class SolrIllegalOperationException extends SolrException {
90993    /**
90994     * Returns internal information where the Exception was thrown.
90995     *
90996     * @return array
90997     * @since PECL solr >= 0.9.2
90998     **/
90999    function getInternalInfo(){}
91000
91001}
91002/**
91003 * This class represents a Solr document that is about to be submitted to
91004 * the Solr index.
91005 **/
91006class SolrInputDocument {
91007    /**
91008     * For multi-value fields, if a valid boost value is specified, the
91009     * specified value will be multiplied by the current boost value for this
91010     * field.
91011     *
91012     * @param string $fieldName The name of the field
91013     * @param string $fieldValue The value for the field.
91014     * @param float $fieldBoostValue The index time boost for the field.
91015     *   Though this cannot be negative, you can still pass values less than
91016     *   1.0 but they must be greater than zero.
91017     * @return bool
91018     * @since PECL solr >= 0.9.2
91019     **/
91020    function addField($fieldName, $fieldValue, $fieldBoostValue){}
91021
91022    /**
91023     * Resets the document by dropping all the fields and resets the document
91024     * boost to zero.
91025     *
91026     * @return bool
91027     * @since PECL solr >= 0.9.2
91028     **/
91029    function clear(){}
91030
91031    /**
91032     * Removes a field from the document.
91033     *
91034     * @param string $fieldName The name of the field.
91035     * @return bool
91036     * @since PECL solr >= 0.9.2
91037     **/
91038    function deleteField($fieldName){}
91039
91040    /**
91041     * Checks if a field exists
91042     *
91043     * @param string $fieldName Name of the field.
91044     * @return bool
91045     * @since PECL solr >= 0.9.2
91046     **/
91047    function fieldExists($fieldName){}
91048
91049    /**
91050     * Retrieves the current boost value for the document.
91051     *
91052     * @return float
91053     * @since PECL solr >= 0.9.2
91054     **/
91055    function getBoost(){}
91056
91057    /**
91058     * Retrieves a field in the document.
91059     *
91060     * @param string $fieldName The name of the field.
91061     * @return SolrDocumentField
91062     * @since PECL solr >= 0.9.2
91063     **/
91064    function getField($fieldName){}
91065
91066    /**
91067     * Retrieves the boost value for a particular field.
91068     *
91069     * @param string $fieldName The name of the field.
91070     * @return float
91071     * @since PECL solr >= 0.9.2
91072     **/
91073    function getFieldBoost($fieldName){}
91074
91075    /**
91076     * Returns the number of fields in the document.
91077     *
91078     * @return int
91079     * @since PECL solr >= 0.9.2
91080     **/
91081    function getFieldCount(){}
91082
91083    /**
91084     * Returns an array containing all the fields in the document.
91085     *
91086     * @return array
91087     * @since PECL solr >= 0.9.2
91088     **/
91089    function getFieldNames(){}
91090
91091    /**
91092     * Merges one input document into another.
91093     *
91094     * @param SolrInputDocument $sourceDoc The source document.
91095     * @param bool $overwrite If this is it will replace matching fields in
91096     *   the destination document.
91097     * @return bool
91098     * @since PECL solr >= 0.9.2
91099     **/
91100    function merge($sourceDoc, $overwrite){}
91101
91102    /**
91103     * This is an alias of SolrInputDocument::clear
91104     *
91105     * @return bool
91106     * @since PECL solr >= 0.9.2
91107     **/
91108    function reset(){}
91109
91110    /**
91111     * Sets the boost value for this document.
91112     *
91113     * @param float $documentBoostValue The index-time boost value for this
91114     *   document.
91115     * @return bool
91116     * @since PECL solr >= 0.9.2
91117     **/
91118    function setBoost($documentBoostValue){}
91119
91120    /**
91121     * Sets the index-time boost value for a field. This replaces the current
91122     * boost value for this field.
91123     *
91124     * @param string $fieldName The name of the field.
91125     * @param float $fieldBoostValue The index time boost value.
91126     * @return bool
91127     * @since PECL solr >= 0.9.2
91128     **/
91129    function setFieldBoost($fieldName, $fieldBoostValue){}
91130
91131    /**
91132     * The fields are rearranged according to the specified criteria and sort
91133     * direction Fields can be sorted by boost values, field names and number
91134     * of values. The $order_by parameter must be one of : *
91135     * SolrInputDocument::SORT_FIELD_NAME *
91136     * SolrInputDocument::SORT_FIELD_BOOST_VALUE *
91137     * SolrInputDocument::SORT_FIELD_VALUE_COUNT The sort direction can be
91138     * one of : * SolrInputDocument::SORT_DEFAULT *
91139     * SolrInputDocument::SORT_ASC * SolrInputDocument::SORT_DESC
91140     *
91141     * @param int $sortOrderBy The sort criteria
91142     * @param int $sortDirection The sort direction
91143     * @return bool
91144     * @since PECL solr >= 0.9.2
91145     **/
91146    function sort($sortOrderBy, $sortDirection){}
91147
91148    /**
91149     * Returns an array representation of the input document.
91150     *
91151     * @return array
91152     * @since PECL solr >= 0.9.2
91153     **/
91154    function toArray(){}
91155
91156    /**
91157     * Should not be called directly. It is used to create a deep copy of a
91158     * SolrInputDocument.
91159     *
91160     * @return void
91161     * @since PECL solr >= 0.9.2
91162     **/
91163    function __clone(){}
91164
91165    /**
91166     * Constructor.
91167     *
91168     * @since PECL solr >= 0.9.2
91169     **/
91170    function __construct(){}
91171
91172    /**
91173     * Destructor
91174     *
91175     * @return void
91176     * @since PECL solr >= 0.9.2
91177     **/
91178    function __destruct(){}
91179
91180}
91181/**
91182 * Represents a collection of name-value pairs sent to the Solr server
91183 * during a request.
91184 **/
91185class SolrModifiableParams extends SolrParams implements Serializable {
91186    /**
91187     * Constructor
91188     *
91189     * @since PECL solr >= 0.9.2
91190     **/
91191    function __construct(){}
91192
91193    /**
91194     * Destructor
91195     *
91196     * @return void
91197     * @since PECL solr >= 0.9.2
91198     **/
91199    function __destruct(){}
91200
91201}
91202/**
91203 * This is an object whose properties can also by accessed using the
91204 * array syntax. All its properties are read-only.
91205 **/
91206class SolrObject implements ArrayAccess {
91207    /**
91208     * Returns an array of all the names of the properties
91209     *
91210     * @return array
91211     * @since PECL solr >= 0.9.2
91212     **/
91213    function getPropertyNames(){}
91214
91215    /**
91216     * Checks if the property exists. This is used when the object is treated
91217     * as an array.
91218     *
91219     * @param string $property_name The name of the property.
91220     * @return bool
91221     * @since PECL solr >= 0.9.2
91222     **/
91223    function offsetExists($property_name){}
91224
91225    /**
91226     * Used to get the value of a property. This is used when the object is
91227     * treated as an array.
91228     *
91229     * @param string $property_name Name of the property.
91230     * @return mixed
91231     * @since PECL solr >= 0.9.2
91232     **/
91233    function offsetGet($property_name){}
91234
91235    /**
91236     * Sets the value for a property. This is used when the object is treated
91237     * as an array. This object is read-only. This should never be attempted.
91238     *
91239     * @param string $property_name The name of the property.
91240     * @param string $property_value The new value.
91241     * @return void
91242     * @since PECL solr >= 0.9.2
91243     **/
91244    function offsetSet($property_name, $property_value){}
91245
91246    /**
91247     * Sets the value for the property. This is used when the object is
91248     * treated as an array. This object is read-only. This should never be
91249     * attempted.
91250     *
91251     * @param string $property_name The name of the property.
91252     * @return void
91253     * @since PECL solr >= 0.9.2
91254     **/
91255    function offsetUnset($property_name){}
91256
91257    /**
91258     * Creates Solr object.
91259     *
91260     * @since PECL solr >= 0.9.2
91261     **/
91262    function __construct(){}
91263
91264    /**
91265     * The destructor
91266     *
91267     * @return void
91268     * @since PECL solr >= 0.9.2
91269     **/
91270    function __destruct(){}
91271
91272}
91273/**
91274 * Represents a collection of name-value pairs sent to the Solr server
91275 * during a request.
91276 **/
91277class SolrParams implements Serializable {
91278    /**
91279     * This is an alias for SolrParams::addParam
91280     *
91281     * @param string $name The name of the parameter
91282     * @param string $value The value of the parameter
91283     * @return SolrParams
91284     * @since PECL solr >= 0.9.2
91285     **/
91286    function add($name, $value){}
91287
91288    /**
91289     * Adds a parameter to the object. This is used for parameters that can
91290     * be specified multiple times.
91291     *
91292     * @param string $name Name of parameter
91293     * @param string $value Value of parameter
91294     * @return SolrParams
91295     * @since PECL solr >= 0.9.2
91296     **/
91297    function addParam($name, $value){}
91298
91299    /**
91300     * This is an alias for SolrParams::getParam
91301     *
91302     * @param string $param_name Then name of the parameter
91303     * @return mixed
91304     * @since PECL solr >= 0.9.2
91305     **/
91306    function get($param_name){}
91307
91308    /**
91309     * Returns a parameter with name param_name
91310     *
91311     * @param string $param_name The name of the parameter
91312     * @return mixed
91313     * @since PECL solr >= 0.9.2
91314     **/
91315    function getParam($param_name){}
91316
91317    /**
91318     * Returns an array of non URL-encoded parameters
91319     *
91320     * @return array
91321     * @since PECL solr >= 0.9.2
91322     **/
91323    function getParams(){}
91324
91325    /**
91326     * Returns an array on URL-encoded parameters
91327     *
91328     * @return array
91329     * @since PECL solr >= 0.9.2
91330     **/
91331    function getPreparedParams(){}
91332
91333    /**
91334     * Used for custom serialization
91335     *
91336     * @return string
91337     * @since PECL solr >= 0.9.2
91338     **/
91339    function serialize(){}
91340
91341    /**
91342     * An alias of SolrParams::setParam
91343     *
91344     * @param string $name Then name of the parameter
91345     * @param string $value The parameter value
91346     * @return void
91347     * @since PECL solr >= 0.9.2
91348     **/
91349    function set($name, $value){}
91350
91351    /**
91352     * Sets the query parameter to the specified value. This is used for
91353     * parameters that can only be specified once. Subsequent calls with the
91354     * same parameter name will override the existing value
91355     *
91356     * @param string $name Name of the parameter
91357     * @param string $value Value of the parameter
91358     * @return SolrParams
91359     * @since PECL solr >= 0.9.2
91360     **/
91361    function setParam($name, $value){}
91362
91363    /**
91364     * Returns all the name-value pair parameters in the object
91365     *
91366     * @param bool $url_encode Whether to return URL-encoded values
91367     * @return string
91368     * @since PECL solr >= 0.9.2
91369     **/
91370    function toString($url_encode){}
91371
91372    /**
91373     * Used for custom serialization
91374     *
91375     * @param string $serialized The serialized representation of the
91376     *   object
91377     * @return void
91378     * @since PECL solr >= 0.9.2
91379     **/
91380    function unserialize($serialized){}
91381
91382}
91383/**
91384 * Represents a response to a ping request to the server
91385 **/
91386class SolrPingResponse extends SolrResponse {
91387    /**
91388     * Returns the response from the server. This should be empty because the
91389     * request as a HEAD request.
91390     *
91391     * @return string
91392     * @since PECL solr >= 0.9.2
91393     **/
91394    function getResponse(){}
91395
91396    /**
91397     * Constructor
91398     *
91399     * @since PECL solr >= 0.9.2
91400     **/
91401    function __construct(){}
91402
91403    /**
91404     * Destructor
91405     *
91406     * @return void
91407     * @since PECL solr >= 0.9.2
91408     **/
91409    function __destruct(){}
91410
91411}
91412/**
91413 * Represents a collection of name-value pairs sent to the Solr server
91414 * during a request.
91415 **/
91416class SolrQuery extends SolrModifiableParams implements Serializable {
91417    /**
91418     * This method allows you to specify a field which should be treated as a
91419     * facet.
91420     *
91421     * It can be used multiple times with different field names to indicate
91422     * multiple facet fields
91423     *
91424     * @param string $dateField The name of the date field.
91425     * @return SolrQuery
91426     * @since PECL solr >= 0.9.2
91427     **/
91428    function addFacetDateField($dateField){}
91429
91430    /**
91431     * Sets the facet.date.other parameter. Accepts an optional field
91432     * override
91433     *
91434     * @param string $value The value to use.
91435     * @param string $field_override The field name for the override.
91436     * @return SolrQuery
91437     * @since PECL solr >= 0.9.2
91438     **/
91439    function addFacetDateOther($value, $field_override){}
91440
91441    /**
91442     * Adds another field to the facet
91443     *
91444     * @param string $field The name of the field
91445     * @return SolrQuery
91446     * @since PECL solr >= 0.9.2
91447     **/
91448    function addFacetField($field){}
91449
91450    /**
91451     * Adds a facet query
91452     *
91453     * @param string $facetQuery The facet query
91454     * @return SolrQuery
91455     * @since PECL solr >= 0.9.2
91456     **/
91457    function addFacetQuery($facetQuery){}
91458
91459    /**
91460     * This method is used to used to specify a set of fields to return,
91461     * thereby restricting the amount of data returned in the response.
91462     *
91463     * It should be called multiple time, once for each field name.
91464     *
91465     * @param string $field The name of the field
91466     * @return SolrQuery
91467     * @since PECL solr >= 0.9.2
91468     **/
91469    function addField($field){}
91470
91471    /**
91472     * Specifies a filter query
91473     *
91474     * @param string $fq The filter query
91475     * @return SolrQuery
91476     * @since PECL solr >= 0.9.2
91477     **/
91478    function addFilterQuery($fq){}
91479
91480    /**
91481     * Maps to hl.fl. This is used to specify that highlighted snippets
91482     * should be generated for a particular field
91483     *
91484     * @param string $field Name of the field
91485     * @return SolrQuery
91486     * @since PECL solr >= 0.9.2
91487     **/
91488    function addHighlightField($field){}
91489
91490    /**
91491     * Maps to mlt.fl. It specifies that a field should be used for
91492     * similarity.
91493     *
91494     * @param string $field The name of the field
91495     * @return SolrQuery
91496     * @since PECL solr >= 0.9.2
91497     **/
91498    function addMltField($field){}
91499
91500    /**
91501     * Maps to mlt.qf. It is used to specify query fields and their boosts
91502     *
91503     * @param string $field The name of the field
91504     * @param float $boost Its boost value
91505     * @return SolrQuery
91506     * @since PECL solr >= 0.9.2
91507     **/
91508    function addMltQueryField($field, $boost){}
91509
91510    /**
91511     * Used to control how the results should be sorted.
91512     *
91513     * @param string $field The name of the field
91514     * @param int $order The sort direction. This should be either
91515     *   SolrQuery::ORDER_ASC or SolrQuery::ORDER_DESC.
91516     * @return SolrQuery
91517     * @since PECL solr >= 0.9.2
91518     **/
91519    function addSortField($field, $order){}
91520
91521    /**
91522     * Requests a return of sub results for values within the given facet.
91523     * Maps to the stats.facet field
91524     *
91525     * @param string $field The name of the field
91526     * @return SolrQuery
91527     * @since PECL solr >= 0.9.2
91528     **/
91529    function addStatsFacet($field){}
91530
91531    /**
91532     * Maps to stats.field parameter This methods adds another stats.field
91533     * parameter.
91534     *
91535     * @param string $field The name of the field
91536     * @return SolrQuery
91537     * @since PECL solr >= 0.9.2
91538     **/
91539    function addStatsField($field){}
91540
91541    /**
91542     * Returns the value of the facet parameter.
91543     *
91544     * @return bool
91545     * @since PECL solr >= 0.9.2
91546     **/
91547    function getFacet(){}
91548
91549    /**
91550     * Returns the value for the facet.date.end parameter. This method
91551     * accepts an optional field override
91552     *
91553     * @param string $field_override The name of the field
91554     * @return string
91555     * @since PECL solr >= 0.9.2
91556     **/
91557    function getFacetDateEnd($field_override){}
91558
91559    /**
91560     * Returns all the facet.date fields
91561     *
91562     * @return array
91563     * @since PECL solr >= 0.9.2
91564     **/
91565    function getFacetDateFields(){}
91566
91567    /**
91568     * Returns the value of the facet.date.gap parameter. It accepts an
91569     * optional field override
91570     *
91571     * @param string $field_override The name of the field
91572     * @return string
91573     * @since PECL solr >= 0.9.2
91574     **/
91575    function getFacetDateGap($field_override){}
91576
91577    /**
91578     * Returns the value of the facet.date.hardend parameter. Accepts an
91579     * optional field override
91580     *
91581     * @param string $field_override The name of the field
91582     * @return string
91583     * @since PECL solr >= 0.9.2
91584     **/
91585    function getFacetDateHardEnd($field_override){}
91586
91587    /**
91588     * Returns the value for the facet.date.other parameter. This method
91589     * accepts an optional field override.
91590     *
91591     * @param string $field_override The name of the field
91592     * @return array
91593     * @since PECL solr >= 0.9.2
91594     **/
91595    function getFacetDateOther($field_override){}
91596
91597    /**
91598     * Returns the lower bound for the first date range for all date faceting
91599     * on this field. Accepts an optional field override
91600     *
91601     * @param string $field_override The name of the field
91602     * @return string
91603     * @since PECL solr >= 0.9.2
91604     **/
91605    function getFacetDateStart($field_override){}
91606
91607    /**
91608     * Returns all the facet fields
91609     *
91610     * @return array
91611     * @since PECL solr >= 0.9.2
91612     **/
91613    function getFacetFields(){}
91614
91615    /**
91616     * Returns the maximum number of constraint counts that should be
91617     * returned for the facet fields. This method accepts an optional field
91618     * override
91619     *
91620     * @param string $field_override The name of the field to override for
91621     * @return int
91622     * @since PECL solr >= 0.9.2
91623     **/
91624    function getFacetLimit($field_override){}
91625
91626    /**
91627     * Returns the value of the facet.method parameter. This accepts an
91628     * optional field override.
91629     *
91630     * @param string $field_override The name of the field
91631     * @return string
91632     * @since PECL solr >= 0.9.2
91633     **/
91634    function getFacetMethod($field_override){}
91635
91636    /**
91637     * Returns the minimum counts for facet fields should be included in the
91638     * response. It accepts an optional field override
91639     *
91640     * @param string $field_override The name of the field
91641     * @return int
91642     * @since PECL solr >= 0.9.2
91643     **/
91644    function getFacetMinCount($field_override){}
91645
91646    /**
91647     * Returns the current state of the facet.missing parameter. This accepts
91648     * an optional field override
91649     *
91650     * @param string $field_override The name of the field
91651     * @return bool
91652     * @since PECL solr >= 0.9.2
91653     **/
91654    function getFacetMissing($field_override){}
91655
91656    /**
91657     * Returns an offset into the list of constraints to be used for
91658     * pagination. Accepts an optional field override
91659     *
91660     * @param string $field_override The name of the field to override for.
91661     * @return int
91662     * @since PECL solr >= 0.9.2
91663     **/
91664    function getFacetOffset($field_override){}
91665
91666    /**
91667     * Returns the facet prefix
91668     *
91669     * @param string $field_override The name of the field
91670     * @return string
91671     * @since PECL solr >= 0.9.2
91672     **/
91673    function getFacetPrefix($field_override){}
91674
91675    /**
91676     * Returns all the facet queries
91677     *
91678     * @return array
91679     * @since PECL solr >= 0.9.2
91680     **/
91681    function getFacetQueries(){}
91682
91683    /**
91684     * Returns an integer (SolrQuery::FACET_SORT_INDEX or
91685     * SolrQuery::FACET_SORT_COUNT)
91686     *
91687     * @param string $field_override The name of the field
91688     * @return int
91689     * @since PECL solr >= 0.9.2
91690     **/
91691    function getFacetSort($field_override){}
91692
91693    /**
91694     * Returns the list of fields that will be returned in the response
91695     *
91696     * @return array
91697     * @since PECL solr >= 0.9.2
91698     **/
91699    function getFields(){}
91700
91701    /**
91702     * Returns an array of filter queries. These are queries that can be used
91703     * to restrict the super set of documents that can be returned, without
91704     * influencing score
91705     *
91706     * @return array
91707     * @since PECL solr >= 0.9.2
91708     **/
91709    function getFilterQueries(){}
91710
91711    /**
91712     * Returns a boolean indicating whether or not to enable highlighted
91713     * snippets to be generated in the query response.
91714     *
91715     * @return bool
91716     * @since PECL solr >= 0.9.2
91717     **/
91718    function getHighlight(){}
91719
91720    /**
91721     * Returns the highlight field to use as backup or default. It accepts an
91722     * optional override.
91723     *
91724     * @param string $field_override The name of the field
91725     * @return string
91726     * @since PECL solr >= 0.9.2
91727     **/
91728    function getHighlightAlternateField($field_override){}
91729
91730    /**
91731     * Returns all the fields that Solr should generate highlighted snippets
91732     * for
91733     *
91734     * @return array
91735     * @since PECL solr >= 0.9.2
91736     **/
91737    function getHighlightFields(){}
91738
91739    /**
91740     * Returns the formatter for the highlighted output
91741     *
91742     * @param string $field_override The name of the field
91743     * @return string
91744     * @since PECL solr >= 0.9.2
91745     **/
91746    function getHighlightFormatter($field_override){}
91747
91748    /**
91749     * Returns the text snippet generator for highlighted text. Accepts an
91750     * optional field override.
91751     *
91752     * @param string $field_override The name of the field
91753     * @return string
91754     * @since PECL solr >= 0.9.2
91755     **/
91756    function getHighlightFragmenter($field_override){}
91757
91758    /**
91759     * Returns the number of characters of fragments to consider for
91760     * highlighting. Zero implies no fragmenting. The entire field should be
91761     * used.
91762     *
91763     * @param string $field_override The name of the field
91764     * @return int
91765     * @since PECL solr >= 0.9.2
91766     **/
91767    function getHighlightFragsize($field_override){}
91768
91769    /**
91770     * Returns whether or not to enable highlighting for
91771     * range/wildcard/fuzzy/prefix queries
91772     *
91773     * @return bool
91774     * @since PECL solr >= 0.9.2
91775     **/
91776    function getHighlightHighlightMultiTerm(){}
91777
91778    /**
91779     * Returns the maximum number of characters of the field to return
91780     *
91781     * @param string $field_override The name of the field
91782     * @return int
91783     * @since PECL solr >= 0.9.2
91784     **/
91785    function getHighlightMaxAlternateFieldLength($field_override){}
91786
91787    /**
91788     * Returns the maximum number of characters into a document to look for
91789     * suitable snippets
91790     *
91791     * @return int
91792     * @since PECL solr >= 0.9.2
91793     **/
91794    function getHighlightMaxAnalyzedChars(){}
91795
91796    /**
91797     * Returns whether or not the collapse contiguous fragments into a single
91798     * fragment. Accepts an optional field override.
91799     *
91800     * @param string $field_override The name of the field
91801     * @return bool
91802     * @since PECL solr >= 0.9.2
91803     **/
91804    function getHighlightMergeContiguous($field_override){}
91805
91806    /**
91807     * Returns the maximum number of characters from a field when using the
91808     * regex fragmenter
91809     *
91810     * @return int
91811     * @since PECL solr >= 0.9.2
91812     **/
91813    function getHighlightRegexMaxAnalyzedChars(){}
91814
91815    /**
91816     * Returns the regular expression used for fragmenting
91817     *
91818     * @return string
91819     * @since PECL solr >= 0.9.2
91820     **/
91821    function getHighlightRegexPattern(){}
91822
91823    /**
91824     * Returns the factor by which the regex fragmenter can deviate from the
91825     * ideal fragment size to accomodate the regular expression
91826     *
91827     * @return float
91828     * @since PECL solr >= 0.9.2
91829     **/
91830    function getHighlightRegexSlop(){}
91831
91832    /**
91833     * Returns if a field will only be highlighted if the query matched in
91834     * this particular field.
91835     *
91836     * @return bool
91837     * @since PECL solr >= 0.9.2
91838     **/
91839    function getHighlightRequireFieldMatch(){}
91840
91841    /**
91842     * Returns the text which appears after a highlighted term. Accepts an
91843     * optional field override
91844     *
91845     * @param string $field_override The name of the field
91846     * @return string
91847     * @since PECL solr >= 0.9.2
91848     **/
91849    function getHighlightSimplePost($field_override){}
91850
91851    /**
91852     * Returns the text which appears before a highlighted term. Accepts an
91853     * optional field override
91854     *
91855     * @param string $field_override The name of the field
91856     * @return string
91857     * @since PECL solr >= 0.9.2
91858     **/
91859    function getHighlightSimplePre($field_override){}
91860
91861    /**
91862     * Returns the maximum number of highlighted snippets to generate per
91863     * field. Accepts an optional field override
91864     *
91865     * @param string $field_override The name of the field
91866     * @return int
91867     * @since PECL solr >= 0.9.2
91868     **/
91869    function getHighlightSnippets($field_override){}
91870
91871    /**
91872     * Returns whether or not to use SpanScorer to highlight phrase terms
91873     * only when they appear within the query phrase in the document.
91874     *
91875     * @return bool
91876     * @since PECL solr >= 0.9.2
91877     **/
91878    function getHighlightUsePhraseHighlighter(){}
91879
91880    /**
91881     * Returns whether or not MoreLikeThis results should be enabled
91882     *
91883     * @return bool
91884     * @since PECL solr >= 0.9.2
91885     **/
91886    function getMlt(){}
91887
91888    /**
91889     * Returns whether or not the query will be boosted by the interesting
91890     * term relevance
91891     *
91892     * @return bool
91893     * @since PECL solr >= 0.9.2
91894     **/
91895    function getMltBoost(){}
91896
91897    /**
91898     * Returns the number of similar documents to return for each result
91899     *
91900     * @return int
91901     * @since PECL solr >= 0.9.2
91902     **/
91903    function getMltCount(){}
91904
91905    /**
91906     * Returns all the fields to use for similarity
91907     *
91908     * @return array
91909     * @since PECL solr >= 0.9.2
91910     **/
91911    function getMltFields(){}
91912
91913    /**
91914     * Returns the maximum number of query terms that will be included in any
91915     * generated query
91916     *
91917     * @return int
91918     * @since PECL solr >= 0.9.2
91919     **/
91920    function getMltMaxNumQueryTerms(){}
91921
91922    /**
91923     * Returns the maximum number of tokens to parse in each document field
91924     * that is not stored with TermVector support
91925     *
91926     * @return int
91927     * @since PECL solr >= 0.9.2
91928     **/
91929    function getMltMaxNumTokens(){}
91930
91931    /**
91932     * Returns the maximum word length above which words will be ignored
91933     *
91934     * @return int
91935     * @since PECL solr >= 0.9.2
91936     **/
91937    function getMltMaxWordLength(){}
91938
91939    /**
91940     * Returns the treshold frequency at which words will be ignored which do
91941     * not occur in at least this many docs
91942     *
91943     * @return int
91944     * @since PECL solr >= 0.9.2
91945     **/
91946    function getMltMinDocFrequency(){}
91947
91948    /**
91949     * Returns the frequency below which terms will be ignored in the source
91950     * document
91951     *
91952     * @return int
91953     * @since PECL solr >= 0.9.2
91954     **/
91955    function getMltMinTermFrequency(){}
91956
91957    /**
91958     * Returns the minimum word length below which words will be ignored
91959     *
91960     * @return int
91961     * @since PECL solr >= 0.9.2
91962     **/
91963    function getMltMinWordLength(){}
91964
91965    /**
91966     * Returns the query fields and their boosts
91967     *
91968     * @return array
91969     * @since PECL solr >= 0.9.2
91970     **/
91971    function getMltQueryFields(){}
91972
91973    /**
91974     * Returns the main search query
91975     *
91976     * @return string
91977     * @since PECL solr >= 0.9.2
91978     **/
91979    function getQuery(){}
91980
91981    /**
91982     * Returns the maximum number of documents from the complete result set
91983     * to return to the client for every request
91984     *
91985     * @return int
91986     * @since PECL solr >= 0.9.2
91987     **/
91988    function getRows(){}
91989
91990    /**
91991     * Returns all the sort fields
91992     *
91993     * @return array
91994     * @since PECL solr >= 0.9.2
91995     **/
91996    function getSortFields(){}
91997
91998    /**
91999     * Returns the offset in the complete result set for the queries where
92000     * the set of returned documents should begin.
92001     *
92002     * @return int
92003     * @since PECL solr >= 0.9.2
92004     **/
92005    function getStart(){}
92006
92007    /**
92008     * Returns whether or not stats is enabled
92009     *
92010     * @return bool
92011     * @since PECL solr >= 0.9.2
92012     **/
92013    function getStats(){}
92014
92015    /**
92016     * Returns all the stats facets that were set
92017     *
92018     * @return array
92019     * @since PECL solr >= 0.9.2
92020     **/
92021    function getStatsFacets(){}
92022
92023    /**
92024     * Returns all the statistics fields
92025     *
92026     * @return array
92027     * @since PECL solr >= 0.9.2
92028     **/
92029    function getStatsFields(){}
92030
92031    /**
92032     * Returns whether or not the TermsComponent is enabled
92033     *
92034     * @return bool
92035     * @since PECL solr >= 0.9.2
92036     **/
92037    function getTerms(){}
92038
92039    /**
92040     * Returns the field from which the terms are retrieved
92041     *
92042     * @return string
92043     * @since PECL solr >= 0.9.2
92044     **/
92045    function getTermsField(){}
92046
92047    /**
92048     * Returns whether or not to include the lower bound in the result set
92049     *
92050     * @return bool
92051     * @since PECL solr >= 0.9.2
92052     **/
92053    function getTermsIncludeLowerBound(){}
92054
92055    /**
92056     * Returns whether or not to include the upper bound term in the result
92057     * set
92058     *
92059     * @return bool
92060     * @since PECL solr >= 0.9.2
92061     **/
92062    function getTermsIncludeUpperBound(){}
92063
92064    /**
92065     * Returns the maximum number of terms Solr should return
92066     *
92067     * @return int
92068     * @since PECL solr >= 0.9.2
92069     **/
92070    function getTermsLimit(){}
92071
92072    /**
92073     * Returns the term to start at
92074     *
92075     * @return string
92076     * @since PECL solr >= 0.9.2
92077     **/
92078    function getTermsLowerBound(){}
92079
92080    /**
92081     * Returns the maximum document frequency
92082     *
92083     * @return int
92084     * @since PECL solr >= 0.9.2
92085     **/
92086    function getTermsMaxCount(){}
92087
92088    /**
92089     * Returns the minimum document frequency to return in order to be
92090     * included
92091     *
92092     * @return int
92093     * @since PECL solr >= 0.9.2
92094     **/
92095    function getTermsMinCount(){}
92096
92097    /**
92098     * Returns the prefix to which matching terms must be restricted. This
92099     * will restrict matches to only terms that start with the prefix
92100     *
92101     * @return string
92102     * @since PECL solr >= 0.9.2
92103     **/
92104    function getTermsPrefix(){}
92105
92106    /**
92107     * Returns a boolean indicating whether or not to return the raw
92108     * characters of the indexed term, regardless of if it is human readable
92109     *
92110     * @return bool
92111     * @since PECL solr >= 0.9.2
92112     **/
92113    function getTermsReturnRaw(){}
92114
92115    /**
92116     * SolrQuery::TERMS_SORT_INDEX indicates that the terms are returned by
92117     * index order. SolrQuery::TERMS_SORT_COUNT implies that the terms are
92118     * sorted by term frequency (highest count first)
92119     *
92120     * @return int
92121     * @since PECL solr >= 0.9.2
92122     **/
92123    function getTermsSort(){}
92124
92125    /**
92126     * Returns the term to stop at
92127     *
92128     * @return string
92129     * @since PECL solr >= 0.9.2
92130     **/
92131    function getTermsUpperBound(){}
92132
92133    /**
92134     * Returns the time in milliseconds allowed for the query to finish.
92135     *
92136     * @return int
92137     * @since PECL solr >= 0.9.2
92138     **/
92139    function getTimeAllowed(){}
92140
92141    /**
92142     * The name of the field
92143     *
92144     * @param string $field The name of the date field to remove
92145     * @return SolrQuery
92146     * @since PECL solr >= 0.9.2
92147     **/
92148    function removeFacetDateField($field){}
92149
92150    /**
92151     * Removes one of the facet.date.other parameters
92152     *
92153     * @param string $value The value
92154     * @param string $field_override The name of the field.
92155     * @return SolrQuery
92156     * @since PECL solr >= 0.9.2
92157     **/
92158    function removeFacetDateOther($value, $field_override){}
92159
92160    /**
92161     * Removes one of the facet.date parameters
92162     *
92163     * @param string $field The name of the field
92164     * @return SolrQuery
92165     * @since PECL solr >= 0.9.2
92166     **/
92167    function removeFacetField($field){}
92168
92169    /**
92170     * Removes one of the facet.query parameters.
92171     *
92172     * @param string $value The value
92173     * @return SolrQuery
92174     * @since PECL solr >= 0.9.2
92175     **/
92176    function removeFacetQuery($value){}
92177
92178    /**
92179     * Removes a field from the list of fields
92180     *
92181     * @param string $field Name of the field.
92182     * @return SolrQuery
92183     * @since PECL solr >= 0.9.2
92184     **/
92185    function removeField($field){}
92186
92187    /**
92188     * Removes a filter query.
92189     *
92190     * @param string $fq The filter query to remove
92191     * @return SolrQuery
92192     * @since PECL solr >= 0.9.2
92193     **/
92194    function removeFilterQuery($fq){}
92195
92196    /**
92197     * Removes one of the fields used for highlighting.
92198     *
92199     * @param string $field The name of the field
92200     * @return SolrQuery
92201     * @since PECL solr >= 0.9.2
92202     **/
92203    function removeHighlightField($field){}
92204
92205    /**
92206     * Removes one of the moreLikeThis fields.
92207     *
92208     * @param string $field Name of the field
92209     * @return SolrQuery
92210     * @since PECL solr >= 0.9.2
92211     **/
92212    function removeMltField($field){}
92213
92214    /**
92215     * Removes one of the moreLikeThis query fields.
92216     *
92217     * @param string $queryField The query field
92218     * @return SolrQuery
92219     * @since PECL solr >= 0.9.2
92220     **/
92221    function removeMltQueryField($queryField){}
92222
92223    /**
92224     * Removes one of the sort fields
92225     *
92226     * @param string $field The name of the field
92227     * @return SolrQuery
92228     * @since PECL solr >= 0.9.2
92229     **/
92230    function removeSortField($field){}
92231
92232    /**
92233     * Removes one of the stats.facet parameters
92234     *
92235     * @param string $value The value
92236     * @return SolrQuery
92237     * @since PECL solr >= 0.9.2
92238     **/
92239    function removeStatsFacet($value){}
92240
92241    /**
92242     * Removes one of the stats.field parameters
92243     *
92244     * @param string $field The name of the field.
92245     * @return SolrQuery
92246     * @since PECL solr >= 0.9.2
92247     **/
92248    function removeStatsField($field){}
92249
92250    /**
92251     * If set to true, Solr places the name of the handle used in the
92252     * response to the client for debugging purposes.
92253     *
92254     * @param bool $flag or
92255     * @return SolrQuery
92256     * @since PECL solr >= 0.9.2
92257     **/
92258    function setEchoHandler($flag){}
92259
92260    /**
92261     * Instructs Solr what kinds of Request parameters should be included in
92262     * the response for debugging purposes, legal values include:
92263     *
92264     * - none - don't include any request parameters for debugging - explicit
92265     * - include the parameters explicitly specified by the client in the
92266     * request - all - include all parameters involved in this request,
92267     * either specified explicitly by the client, or implicit because of the
92268     * request handler configuration.
92269     *
92270     * @param string $type The type of parameters to include
92271     * @return SolrQuery
92272     * @since PECL solr >= 0.9.2
92273     **/
92274    function setEchoParams($type){}
92275
92276    /**
92277     * Sets the explainOther common query parameter
92278     *
92279     * @param string $query The Lucene query to identify a set of documents
92280     * @return SolrQuery
92281     * @since PECL solr >= 0.9.2
92282     **/
92283    function setExplainOther($query){}
92284
92285    /**
92286     * Enables or disables faceting.
92287     *
92288     * @param bool $flag enables faceting and disables it.
92289     * @return SolrQuery
92290     * @since PECL solr >= 0.9.2
92291     **/
92292    function setFacet($flag){}
92293
92294    /**
92295     * Maps to facet.date.end
92296     *
92297     * @param string $value See facet.date.end
92298     * @param string $field_override Name of the field
92299     * @return SolrQuery
92300     * @since PECL solr >= 0.9.2
92301     **/
92302    function setFacetDateEnd($value, $field_override){}
92303
92304    /**
92305     * Maps to facet.date.gap
92306     *
92307     * @param string $value See facet.date.gap
92308     * @param string $field_override The name of the field
92309     * @return SolrQuery
92310     * @since PECL solr >= 0.9.2
92311     **/
92312    function setFacetDateGap($value, $field_override){}
92313
92314    /**
92315     * Maps to facet.date.hardend
92316     *
92317     * @param bool $value See facet.date.hardend
92318     * @param string $field_override The name of the field
92319     * @return SolrQuery
92320     * @since PECL solr >= 0.9.2
92321     **/
92322    function setFacetDateHardEnd($value, $field_override){}
92323
92324    /**
92325     * Maps to facet.date.start
92326     *
92327     * @param string $value See facet.date.start
92328     * @param string $field_override The name of the field.
92329     * @return SolrQuery
92330     * @since PECL solr >= 0.9.2
92331     **/
92332    function setFacetDateStart($value, $field_override){}
92333
92334    /**
92335     * Sets the minimum document frequency used for determining term count
92336     *
92337     * @param int $frequency The minimum frequency
92338     * @param string $field_override The name of the field.
92339     * @return SolrQuery
92340     * @since PECL solr >= 0.9.2
92341     **/
92342    function setFacetEnumCacheMinDefaultFrequency($frequency, $field_override){}
92343
92344    /**
92345     * Maps to facet.limit. Sets the maximum number of constraint counts that
92346     * should be returned for the facet fields.
92347     *
92348     * @param int $limit The maximum number of constraint counts
92349     * @param string $field_override The name of the field.
92350     * @return SolrQuery
92351     * @since PECL solr >= 0.9.2
92352     **/
92353    function setFacetLimit($limit, $field_override){}
92354
92355    /**
92356     * Specifies the type of algorithm to use when faceting a field. This
92357     * method accepts optional field override.
92358     *
92359     * @param string $method The method to use.
92360     * @param string $field_override The name of the field.
92361     * @return SolrQuery
92362     * @since PECL solr >= 0.9.2
92363     **/
92364    function setFacetMethod($method, $field_override){}
92365
92366    /**
92367     * Sets the minimum counts for facet fields that should be included in
92368     * the response
92369     *
92370     * @param int $mincount The minimum count
92371     * @param string $field_override The name of the field.
92372     * @return SolrQuery
92373     * @since PECL solr >= 0.9.2
92374     **/
92375    function setFacetMinCount($mincount, $field_override){}
92376
92377    /**
92378     * Used to indicate that in addition to the Term-based constraints of a
92379     * facet field, a count of all matching results which have no value for
92380     * the field should be computed
92381     *
92382     * @param bool $flag turns this feature on. disables it.
92383     * @param string $field_override The name of the field.
92384     * @return SolrQuery
92385     * @since PECL solr >= 0.9.2
92386     **/
92387    function setFacetMissing($flag, $field_override){}
92388
92389    /**
92390     * Sets the offset into the list of constraints to allow for pagination.
92391     *
92392     * @param int $offset The offset
92393     * @param string $field_override The name of the field.
92394     * @return SolrQuery
92395     * @since PECL solr >= 0.9.2
92396     **/
92397    function setFacetOffset($offset, $field_override){}
92398
92399    /**
92400     * Specifies a string prefix with which to limits the terms on which to
92401     * facet.
92402     *
92403     * @param string $prefix The prefix string
92404     * @param string $field_override The name of the field.
92405     * @return SolrQuery
92406     * @since PECL solr >= 0.9.2
92407     **/
92408    function setFacetPrefix($prefix, $field_override){}
92409
92410    /**
92411     * Determines the ordering of the facet field constraints
92412     *
92413     * @param int $facetSort Use SolrQuery::FACET_SORT_INDEX for sorting by
92414     *   index order or SolrQuery::FACET_SORT_COUNT for sorting by count.
92415     * @param string $field_override The name of the field.
92416     * @return SolrQuery
92417     * @since PECL solr >= 0.9.2
92418     **/
92419    function setFacetSort($facetSort, $field_override){}
92420
92421    /**
92422     * Setting it to enables highlighted snippets to be generated in the
92423     * query response.
92424     *
92425     * Setting it to disables highlighting
92426     *
92427     * @param bool $flag Enable or disable highlighting
92428     * @return SolrQuery
92429     * @since PECL solr >= 0.9.2
92430     **/
92431    function setHighlight($flag){}
92432
92433    /**
92434     * If a snippet cannot be generated because there were no matching terms,
92435     * one can specify a field to use as the backup or default summary
92436     *
92437     * @param string $field The name of the backup field
92438     * @param string $field_override The name of the field we are
92439     *   overriding this setting for.
92440     * @return SolrQuery
92441     * @since PECL solr >= 0.9.2
92442     **/
92443    function setHighlightAlternateField($field, $field_override){}
92444
92445    /**
92446     * Specify a formatter for the highlight output.
92447     *
92448     * @param string $formatter Currently the only legal value is "simple"
92449     * @param string $field_override The name of the field.
92450     * @return SolrQuery
92451     * @since PECL solr >= 0.9.2
92452     **/
92453    function setHighlightFormatter($formatter, $field_override){}
92454
92455    /**
92456     * Specify a text snippet generator for highlighted text.
92457     *
92458     * @param string $fragmenter The standard fragmenter is gap. Another
92459     *   option is regex, which tries to create fragments that resembles a
92460     *   certain regular expression
92461     * @param string $field_override The name of the field.
92462     * @return SolrQuery
92463     * @since PECL solr >= 0.9.2
92464     **/
92465    function setHighlightFragmenter($fragmenter, $field_override){}
92466
92467    /**
92468     * Sets the size, in characters, of fragments to consider for
92469     * highlighting. "0" indicates that the whole field value should be used
92470     * (no fragmenting).
92471     *
92472     * @param int $size The size, in characters, of fragments to consider
92473     *   for highlighting
92474     * @param string $field_override The name of the field.
92475     * @return SolrQuery
92476     * @since PECL solr >= 0.9.2
92477     **/
92478    function setHighlightFragsize($size, $field_override){}
92479
92480    /**
92481     * Use SpanScorer to highlight phrase terms only when they appear within
92482     * the query phrase in the document.
92483     *
92484     * @param bool $flag Whether or not to use SpanScorer to highlight
92485     *   phrase terms only when they appear within the query phrase in the
92486     *   document.
92487     * @return SolrQuery
92488     * @since PECL solr >= 0.9.2
92489     **/
92490    function setHighlightHighlightMultiTerm($flag){}
92491
92492    /**
92493     * If SolrQuery::setHighlightAlternateField() was passed the value , this
92494     * parameter specifies the maximum number of characters of the field to
92495     * return
92496     *
92497     * Any value less than or equal to 0 means unlimited.
92498     *
92499     * @param int $fieldLength The length of the field
92500     * @param string $field_override The name of the field.
92501     * @return SolrQuery
92502     * @since PECL solr >= 0.9.2
92503     **/
92504    function setHighlightMaxAlternateFieldLength($fieldLength, $field_override){}
92505
92506    /**
92507     * Specifies the number of characters into a document to look for
92508     * suitable snippets
92509     *
92510     * @param int $value The number of characters into a document to look
92511     *   for suitable snippets
92512     * @return SolrQuery
92513     * @since PECL solr >= 0.9.2
92514     **/
92515    function setHighlightMaxAnalyzedChars($value){}
92516
92517    /**
92518     * Whether or not to collapse contiguous fragments into a single fragment
92519     *
92520     * @param bool $flag Whether or not to collapse contiguous fragments
92521     *   into a single fragment
92522     * @param string $field_override The name of the field.
92523     * @return SolrQuery
92524     * @since PECL solr >= 0.9.2
92525     **/
92526    function setHighlightMergeContiguous($flag, $field_override){}
92527
92528    /**
92529     * Specify the maximum number of characters to analyze from a field when
92530     * using the regex fragmenter
92531     *
92532     * @param int $maxAnalyzedChars The maximum number of characters to
92533     *   analyze from a field when using the regex fragmenter
92534     * @return SolrQuery
92535     * @since PECL solr >= 0.9.2
92536     **/
92537    function setHighlightRegexMaxAnalyzedChars($maxAnalyzedChars){}
92538
92539    /**
92540     * Specifies the regular expression for fragmenting. This could be used
92541     * to extract sentences
92542     *
92543     * @param string $value The regular expression for fragmenting. This
92544     *   could be used to extract sentences
92545     * @return SolrQuery
92546     * @since PECL solr >= 0.9.2
92547     **/
92548    function setHighlightRegexPattern($value){}
92549
92550    /**
92551     * The factor by which the regex fragmenter can stray from the ideal
92552     * fragment size ( specfied by SolrQuery::setHighlightFragsize )to
92553     * accomodate the regular expression
92554     *
92555     * @param float $factor The factor by which the regex fragmenter can
92556     *   stray from the ideal fragment size
92557     * @return SolrQuery
92558     * @since PECL solr >= 0.9.2
92559     **/
92560    function setHighlightRegexSlop($factor){}
92561
92562    /**
92563     * If , then a field will only be highlighted if the query matched in
92564     * this particular field.
92565     *
92566     * This will only work if SolrQuery::setHighlightUsePhraseHighlighter()
92567     * was set to
92568     *
92569     * @param bool $flag or
92570     * @return SolrQuery
92571     * @since PECL solr >= 0.9.2
92572     **/
92573    function setHighlightRequireFieldMatch($flag){}
92574
92575    /**
92576     * Sets the text which appears before a highlighted term
92577     *
92578     * @param string $simplePost Sets the text which appears after a
92579     *   highlighted term The default is </em>
92580     * @param string $field_override The name of the field.
92581     * @return SolrQuery
92582     * @since PECL solr >= 0.9.2
92583     **/
92584    function setHighlightSimplePost($simplePost, $field_override){}
92585
92586    /**
92587     * Sets the text which appears before a highlighted term
92588     *
92589     * The default is <em>
92590     *
92591     * @param string $simplePre The text which appears before a highlighted
92592     *   term
92593     * @param string $field_override The name of the field.
92594     * @return SolrQuery
92595     * @since PECL solr >= 0.9.2
92596     **/
92597    function setHighlightSimplePre($simplePre, $field_override){}
92598
92599    /**
92600     * Sets the maximum number of highlighted snippets to generate per field
92601     *
92602     * @param int $value The maximum number of highlighted snippets to
92603     *   generate per field
92604     * @param string $field_override The name of the field.
92605     * @return SolrQuery
92606     * @since PECL solr >= 0.9.2
92607     **/
92608    function setHighlightSnippets($value, $field_override){}
92609
92610    /**
92611     * Sets whether or not to use SpanScorer to highlight phrase terms only
92612     * when they appear within the query phrase in the document
92613     *
92614     * @param bool $flag Whether or not to use SpanScorer to highlight
92615     *   phrase terms only when they appear within the query phrase in the
92616     *   document
92617     * @return SolrQuery
92618     * @since PECL solr >= 0.9.2
92619     **/
92620    function setHighlightUsePhraseHighlighter($flag){}
92621
92622    /**
92623     * Enables or disables moreLikeThis
92624     *
92625     * @param bool $flag enables it and turns it off.
92626     * @return SolrQuery
92627     * @since PECL solr >= 0.9.2
92628     **/
92629    function setMlt($flag){}
92630
92631    /**
92632     * Set if the query will be boosted by the interesting term relevance
92633     *
92634     * @param bool $flag Sets to or
92635     * @return SolrQuery
92636     * @since PECL solr >= 0.9.2
92637     **/
92638    function setMltBoost($flag){}
92639
92640    /**
92641     * Set the number of similar documents to return for each result
92642     *
92643     * @param int $count The number of similar documents to return for each
92644     *   result
92645     * @return SolrQuery
92646     * @since PECL solr >= 0.9.2
92647     **/
92648    function setMltCount($count){}
92649
92650    /**
92651     * Sets the maximum number of query terms that will be included in any
92652     * generated query.
92653     *
92654     * @param int $value The maximum number of query terms that will be
92655     *   included in any generated query
92656     * @return SolrQuery
92657     * @since PECL solr >= 0.9.2
92658     **/
92659    function setMltMaxNumQueryTerms($value){}
92660
92661    /**
92662     * Specifies the maximum number of tokens to parse in each example doc
92663     * field that is not stored with TermVector support.
92664     *
92665     * @param int $value The maximum number of tokens to parse
92666     * @return SolrQuery
92667     * @since PECL solr >= 0.9.2
92668     **/
92669    function setMltMaxNumTokens($value){}
92670
92671    /**
92672     * Sets the maximum word length above which words will be ignored.
92673     *
92674     * @param int $maxWordLength The maximum word length above which words
92675     *   will be ignored
92676     * @return SolrQuery
92677     * @since PECL solr >= 0.9.2
92678     **/
92679    function setMltMaxWordLength($maxWordLength){}
92680
92681    /**
92682     * The frequency at which words will be ignored which do not occur in at
92683     * least this many docs.
92684     *
92685     * @param int $minDocFrequency Sets the frequency at which words will
92686     *   be ignored which do not occur in at least this many docs.
92687     * @return SolrQuery
92688     * @since PECL solr >= 0.9.2
92689     **/
92690    function setMltMinDocFrequency($minDocFrequency){}
92691
92692    /**
92693     * Sets the frequency below which terms will be ignored in the source
92694     * docs
92695     *
92696     * @param int $minTermFrequency The frequency below which terms will be
92697     *   ignored in the source docs
92698     * @return SolrQuery
92699     * @since PECL solr >= 0.9.2
92700     **/
92701    function setMltMinTermFrequency($minTermFrequency){}
92702
92703    /**
92704     * Sets the minimum word length below which words will be ignored.
92705     *
92706     * @param int $minWordLength The minimum word length below which words
92707     *   will be ignored
92708     * @return SolrQuery
92709     * @since PECL solr >= 0.9.2
92710     **/
92711    function setMltMinWordLength($minWordLength){}
92712
92713    /**
92714     * Exclude the header from the returned results.
92715     *
92716     * @param bool $flag excludes the header from the result.
92717     * @return SolrQuery
92718     * @since PECL solr >= 0.9.2
92719     **/
92720    function setOmitHeader($flag){}
92721
92722    /**
92723     * Sets the search query.
92724     *
92725     * @param string $query The search query
92726     * @return SolrQuery
92727     * @since PECL solr >= 0.9.2
92728     **/
92729    function setQuery($query){}
92730
92731    /**
92732     * Specifies the maximum number of rows to return in the result
92733     *
92734     * @param int $rows The maximum number of rows to return
92735     * @return SolrQuery
92736     * @since PECL solr >= 0.9.2
92737     **/
92738    function setRows($rows){}
92739
92740    /**
92741     * Whether to show debug info
92742     *
92743     * @param bool $flag Whether to show debug info. or
92744     * @return SolrQuery
92745     * @since PECL solr >= 0.9.2
92746     **/
92747    function setShowDebugInfo($flag){}
92748
92749    /**
92750     * Specifies the number of rows to skip. Useful in pagination of results.
92751     *
92752     * @param int $start The number of rows to skip.
92753     * @return SolrQuery
92754     * @since PECL solr >= 0.9.2
92755     **/
92756    function setStart($start){}
92757
92758    /**
92759     * Enables or disables the Stats component.
92760     *
92761     * @param bool $flag turns on the stats component and disables it.
92762     * @return SolrQuery
92763     * @since PECL solr >= 0.9.2
92764     **/
92765    function setStats($flag){}
92766
92767    /**
92768     * Enables or disables the TermsComponent
92769     *
92770     * @param bool $flag enables it. turns it off
92771     * @return SolrQuery
92772     * @since PECL solr >= 0.9.2
92773     **/
92774    function setTerms($flag){}
92775
92776    /**
92777     * Sets the name of the field to get the terms from
92778     *
92779     * @param string $fieldname The field name
92780     * @return SolrQuery
92781     * @since PECL solr >= 0.9.2
92782     **/
92783    function setTermsField($fieldname){}
92784
92785    /**
92786     * Include the lower bound term in the result set.
92787     *
92788     * @param bool $flag Include the lower bound term in the result set
92789     * @return SolrQuery
92790     * @since PECL solr >= 0.9.2
92791     **/
92792    function setTermsIncludeLowerBound($flag){}
92793
92794    /**
92795     * Include the upper bound term in the result set.
92796     *
92797     * @param bool $flag or
92798     * @return SolrQuery
92799     * @since PECL solr >= 0.9.2
92800     **/
92801    function setTermsIncludeUpperBound($flag){}
92802
92803    /**
92804     * Sets the maximum number of terms to return
92805     *
92806     * @param int $limit The maximum number of terms to return. All the
92807     *   terms will be returned if the limit is negative.
92808     * @return SolrQuery
92809     * @since PECL solr >= 0.9.2
92810     **/
92811    function setTermsLimit($limit){}
92812
92813    /**
92814     * Specifies the Term to start from
92815     *
92816     * @param string $lowerBound The lower bound Term
92817     * @return SolrQuery
92818     * @since PECL solr >= 0.9.2
92819     **/
92820    function setTermsLowerBound($lowerBound){}
92821
92822    /**
92823     * Sets the maximum document frequency.
92824     *
92825     * @param int $frequency The maximum document frequency.
92826     * @return SolrQuery
92827     * @since PECL solr >= 0.9.2
92828     **/
92829    function setTermsMaxCount($frequency){}
92830
92831    /**
92832     * Sets the minimum doc frequency to return in order to be included
92833     *
92834     * @param int $frequency The minimum frequency
92835     * @return SolrQuery
92836     * @since PECL solr >= 0.9.2
92837     **/
92838    function setTermsMinCount($frequency){}
92839
92840    /**
92841     * Restrict matches to terms that start with the prefix
92842     *
92843     * @param string $prefix Restrict matches to terms that start with the
92844     *   prefix
92845     * @return SolrQuery
92846     * @since PECL solr >= 0.9.2
92847     **/
92848    function setTermsPrefix($prefix){}
92849
92850    /**
92851     * If true, return the raw characters of the indexed term, regardless of
92852     * if it is human readable
92853     *
92854     * @param bool $flag or
92855     * @return SolrQuery
92856     * @since PECL solr >= 0.9.2
92857     **/
92858    function setTermsReturnRaw($flag){}
92859
92860    /**
92861     * If SolrQuery::TERMS_SORT_COUNT, sorts the terms by the term frequency
92862     * (highest count first). If SolrQuery::TERMS_SORT_INDEX, returns the
92863     * terms in index order
92864     *
92865     * @param int $sortType SolrQuery::TERMS_SORT_INDEX or
92866     *   SolrQuery::TERMS_SORT_COUNT
92867     * @return SolrQuery
92868     * @since PECL solr >= 0.9.2
92869     **/
92870    function setTermsSort($sortType){}
92871
92872    /**
92873     * Sets the term to stop at
92874     *
92875     * @param string $upperBound The term to stop at
92876     * @return SolrQuery
92877     * @since PECL solr >= 0.9.2
92878     **/
92879    function setTermsUpperBound($upperBound){}
92880
92881    /**
92882     * The time allowed for a search to finish. This value only applies to
92883     * the search and not to requests in general. Time is in milliseconds.
92884     * Values less than or equal to zero implies no time restriction. Partial
92885     * results may be returned, if there are any.
92886     *
92887     * @param int $timeAllowed The time allowed for a search to finish.
92888     * @return SolrQuery
92889     * @since PECL solr >= 0.9.2
92890     **/
92891    function setTimeAllowed($timeAllowed){}
92892
92893    /**
92894     * Constructor.
92895     *
92896     * @param string $q Optional search query
92897     * @since PECL solr >= 0.9.2
92898     **/
92899    function __construct($q){}
92900
92901    /**
92902     * Destructor
92903     *
92904     * @return void
92905     * @since PECL solr >= 0.9.2
92906     **/
92907    function __destruct(){}
92908
92909}
92910/**
92911 * Represents a response to a query request.
92912 **/
92913class SolrQueryResponse extends SolrResponse {
92914    /**
92915     * Constructor
92916     *
92917     * @since PECL solr >= 0.9.2
92918     **/
92919    function __construct(){}
92920
92921    /**
92922     * Destructor.
92923     *
92924     * @return void
92925     * @since PECL solr >= 0.9.2
92926     **/
92927    function __destruct(){}
92928
92929}
92930/**
92931 * Represents a response from the Solr server.
92932 **/
92933class SolrResponse {
92934    /**
92935     * Returns the XML response as serialized PHP data
92936     *
92937     * @return string
92938     * @since PECL solr >= 0.9.2
92939     **/
92940    function getDigestedResponse(){}
92941
92942    /**
92943     * Returns the HTTP status of the response.
92944     *
92945     * @return int
92946     * @since PECL solr >= 0.9.2
92947     **/
92948    function getHttpStatus(){}
92949
92950    /**
92951     * Returns more details on the HTTP status.
92952     *
92953     * @return string
92954     * @since PECL solr >= 0.9.2
92955     **/
92956    function getHttpStatusMessage(){}
92957
92958    /**
92959     * Returns the raw request sent to the Solr server.
92960     *
92961     * @return string
92962     * @since PECL solr >= 0.9.2
92963     **/
92964    function getRawRequest(){}
92965
92966    /**
92967     * Returns the raw request headers sent to the Solr server.
92968     *
92969     * @return string
92970     * @since PECL solr >= 0.9.2
92971     **/
92972    function getRawRequestHeaders(){}
92973
92974    /**
92975     * Returns the raw response from the server.
92976     *
92977     * @return string
92978     * @since PECL solr >= 0.9.2
92979     **/
92980    function getRawResponse(){}
92981
92982    /**
92983     * Returns the raw response headers from the server.
92984     *
92985     * @return string
92986     * @since PECL solr >= 0.9.2
92987     **/
92988    function getRawResponseHeaders(){}
92989
92990    /**
92991     * Returns the full URL the request was sent to.
92992     *
92993     * @return string
92994     * @since PECL solr >= 0.9.2
92995     **/
92996    function getRequestUrl(){}
92997
92998    /**
92999     * Returns a SolrObject representing the XML response from the server.
93000     *
93001     * @return SolrObject
93002     * @since PECL solr >= 0.9.2
93003     **/
93004    function getResponse(){}
93005
93006    /**
93007     * Sets the parse mode.
93008     *
93009     * @param int $parser_mode SolrResponse::PARSE_SOLR_DOC parses
93010     *   documents in SolrDocument instances. SolrResponse::PARSE_SOLR_OBJ
93011     *   parses document into SolrObjects.
93012     * @return bool
93013     * @since PECL solr >= 0.9.2
93014     **/
93015    function setParseMode($parser_mode){}
93016
93017    /**
93018     * Used to check if the request to the server was successful.
93019     *
93020     * @return bool
93021     * @since PECL solr >= 0.9.2
93022     **/
93023    function success(){}
93024
93025}
93026/**
93027 * Represents a response to an update request.
93028 **/
93029class SolrUpdateResponse extends SolrResponse {
93030    /**
93031     * Constructor
93032     *
93033     * @since PECL solr >= 0.9.2
93034     **/
93035    function __construct(){}
93036
93037    /**
93038     * Destructor
93039     *
93040     * @return void
93041     * @since PECL solr >= 0.9.2
93042     **/
93043    function __destruct(){}
93044
93045}
93046/**
93047 * Contains utility methods for retrieving the current extension version
93048 * and preparing query phrases. Also contains method for escaping query
93049 * strings and parsing XML responses.
93050 **/
93051class SolrUtils {
93052    /**
93053     * This method parses an response XML string from the Apache Solr server
93054     * into a SolrObject. It throws a SolrException if there was an error.
93055     *
93056     * @param string $xmlresponse The XML response string from the Solr
93057     *   server.
93058     * @param int $parse_mode Use SolrResponse::PARSE_SOLR_OBJ or
93059     *   SolrResponse::PARSE_SOLR_DOC
93060     * @return SolrObject
93061     * @since PECL solr >= 0.9.2
93062     **/
93063    function digestXmlResponse($xmlresponse, $parse_mode){}
93064
93065    /**
93066     * Lucene supports escaping special characters that are part of the query
93067     * syntax.
93068     *
93069     * The current list special characters are:
93070     *
93071     * + - && || ! ( ) { } [ ] ^ " ~ * ? : \
93072     *
93073     * These characters are part of the query syntax and must be escaped
93074     *
93075     * @param string $str This is the query string to be escaped.
93076     * @return string
93077     * @since PECL solr >= 0.9.2
93078     **/
93079    function escapeQueryChars($str){}
93080
93081    /**
93082     * Returns the current Solr version.
93083     *
93084     * @return string
93085     * @since PECL solr >= 0.9.2
93086     **/
93087    function getSolrVersion(){}
93088
93089    /**
93090     * Prepares a phrase from an unescaped lucene string.
93091     *
93092     * @param string $str The lucene phrase.
93093     * @return string
93094     * @since PECL solr >= 0.9.2
93095     **/
93096    function queryPhrase($str){}
93097
93098}
93099/**
93100 * The SphinxClient class provides object-oriented interface to Sphinx.
93101 **/
93102class SphinxClient {
93103    /**
93104     * Adds query with the current settings to multi-query batch. This method
93105     * doesn't affect current settings (sorting, filtering, grouping etc.) in
93106     * any way.
93107     *
93108     * @param string $query Query string.
93109     * @param string $index An index name (or names).
93110     * @param string $comment
93111     * @return int
93112     * @since PECL sphinx >= 0.1.0
93113     **/
93114    function addQuery($query, $index, $comment){}
93115
93116    /**
93117     * Connects to searchd, requests it to generate excerpts (snippets) from
93118     * the given documents, and returns the results.
93119     *
93120     * @param array $docs Array of strings with documents' contents.
93121     * @param string $index Index name.
93122     * @param string $words Keywords to highlight.
93123     * @param array $opts Associative array of additional highlighting
93124     *   options (see below).
93125     * @return array
93126     * @since PECL sphinx >= 0.1.0
93127     **/
93128    function buildExcerpts($docs, $index, $words, $opts){}
93129
93130    /**
93131     * Extracts keywords from {@link query} using tokenizer settings for the
93132     * given {@link index}, optionally with per-keyword occurrence
93133     * statistics.
93134     *
93135     * @param string $query A query to extract keywords from.
93136     * @param string $index An index to get tokenizing settings and keyword
93137     *   occurrence statistics from.
93138     * @param bool $hits A boolean flag to enable/disable keyword
93139     *   statistics generation.
93140     * @return array
93141     * @since PECL sphinx >= 0.1.0
93142     **/
93143    function buildKeywords($query, $index, $hits){}
93144
93145    /**
93146     * Closes previously opened persistent connection.
93147     *
93148     * @return bool
93149     * @since PECL sphinx >= 1.0.3
93150     **/
93151    function close(){}
93152
93153    /**
93154     * Escapes characters that are treated as special operators by the query
93155     * language parser.
93156     *
93157     * @param string $string String to escape.
93158     * @return string
93159     * @since PECL sphinx >= 0.1.0
93160     **/
93161    function escapeString($string){}
93162
93163    /**
93164     * Returns string with the last error message. If there were no errors
93165     * during the previous API call, empty string is returned. This method
93166     * doesn't reset the error message, so you can safely call it several
93167     * times.
93168     *
93169     * @return string
93170     * @since PECL sphinx >= 0.1.0
93171     **/
93172    function getLastError(){}
93173
93174    /**
93175     * Returns last warning message. If there were no warnings during the
93176     * previous API call, empty string is returned. This method doesn't reset
93177     * the warning, so you can safely call it several times.
93178     *
93179     * @return string
93180     * @since PECL sphinx >= 0.1.0
93181     **/
93182    function getLastWarning(){}
93183
93184    /**
93185     * Opens persistent connection to the server.
93186     *
93187     * @return bool
93188     * @since PECL sphinx >= 1.0.3
93189     **/
93190    function open(){}
93191
93192    /**
93193     * Connects to searchd server, runs the given search query with the
93194     * current settings, obtains and returns the result set.
93195     *
93196     * @param string $query Query string.
93197     * @param string $index An index name (or names).
93198     * @param string $comment
93199     * @return array
93200     * @since PECL sphinx >= 0.1.0
93201     **/
93202    function query($query, $index, $comment){}
93203
93204    /**
93205     * Clears all currently set filters. This call is normally required when
93206     * using multi-queries. You might want to set different filters for
93207     * different queries in the batch. To do that, you should call {@link
93208     * SphinxClient::resetFilters} and add new filters using the respective
93209     * calls.
93210     *
93211     * @return void
93212     * @since PECL sphinx >= 0.1.0
93213     **/
93214    function resetFilters(){}
93215
93216    /**
93217     * Clears all currently group-by settings, and disables group-by. This
93218     * call is normally required only when using multi-queries.
93219     *
93220     * @return void
93221     * @since PECL sphinx >= 0.1.0
93222     **/
93223    function resetGroupBy(){}
93224
93225    /**
93226     * Connects to searchd, runs a batch of all queries added using , obtains
93227     * and returns the result sets.
93228     *
93229     * @return array
93230     * @since PECL sphinx >= 0.1.0
93231     **/
93232    function runQueries(){}
93233
93234    /**
93235     * Controls the format of search results set arrays (whether matches
93236     * should be returned as an array or a hash).
93237     *
93238     * @param bool $array_result If {@link array_result} is , matches are
93239     *   returned as a hash with document IDs as keys, and other information
93240     *   (weight, attributes) as values. If {@link array_result} is , matches
93241     *   are returned as a plain array with complete per-match information
93242     *   including document IDs.
93243     * @return bool
93244     * @since PECL sphinx >= 0.1.0
93245     **/
93246    function setArrayResult($array_result){}
93247
93248    /**
93249     * Sets connection timeout (in seconds) for searchd connection.
93250     *
93251     * @param float $timeout Timeout in seconds.
93252     * @return bool
93253     * @since PECL sphinx >= 0.1.0
93254     **/
93255    function setConnectTimeout($timeout){}
93256
93257    /**
93258     * Binds per-field weights by name.
93259     *
93260     * Match ranking can be affected by per-field weights. See Sphinx
93261     * documentation for an explanation on how phrase proximity ranking is
93262     * affected. This call lets you specify non-default weights for full-text
93263     * fields.
93264     *
93265     * The weights must be positive 32-bit integers, so be careful not to hit
93266     * 32-bit integer maximum. The final weight is a 32-bit integer too.
93267     * Default weight value is 1. Unknown field names are silently ignored.
93268     *
93269     * @param array $weights Associative array of field names and field
93270     *   weights.
93271     * @return bool
93272     * @since PECL sphinx >= 0.1.0
93273     **/
93274    function setFieldWeights($weights){}
93275
93276    /**
93277     * Adds new integer values set filter to the existing list of filters.
93278     *
93279     * @param string $attribute An attribute name.
93280     * @param array $values Plain array of integer values.
93281     * @param bool $exclude If set to , matching documents are excluded
93282     *   from the result set.
93283     * @return bool
93284     * @since PECL sphinx >= 0.1.0
93285     **/
93286    function setFilter($attribute, $values, $exclude){}
93287
93288    /**
93289     * Adds new float range filter to the existing list of filters. Only
93290     * those documents which have {@link attribute} value stored in the index
93291     * between {@link min} and {@link max} (including values that are exactly
93292     * equal to {@link min} or {@link max}) will be matched (or rejected, if
93293     * {@link exclude} is ).
93294     *
93295     * @param string $attribute An attribute name.
93296     * @param float $min Minimum value.
93297     * @param float $max Maximum value.
93298     * @param bool $exclude If set to , matching documents are excluded
93299     *   from the result set.
93300     * @return bool
93301     * @since PECL sphinx >= 0.1.0
93302     **/
93303    function setFilterFloatRange($attribute, $min, $max, $exclude){}
93304
93305    /**
93306     * Adds new integer range filter to the existing list of filters. Only
93307     * those documents which have {@link attribute} value stored in the index
93308     * between {@link min} and {@link max} (including values that are exactly
93309     * equal to {@link min} or {@link max}) will be matched (or rejected, if
93310     * {@link exclude} is ).
93311     *
93312     * @param string $attribute An attribute name.
93313     * @param int $min Minimum value.
93314     * @param int $max Maximum value.
93315     * @param bool $exclude If set to , matching documents are excluded
93316     *   from the result set.
93317     * @return bool
93318     * @since PECL sphinx >= 0.1.0
93319     **/
93320    function setFilterRange($attribute, $min, $max, $exclude){}
93321
93322    /**
93323     * Sets anchor point for a geosphere distance (geodistance) calculations
93324     * and enables them.
93325     *
93326     * Once an anchor point is set, you can use magic "@geodist" attribute
93327     * name in your filters and/or sorting expressions.
93328     *
93329     * @param string $attrlat Name of a latitude attribute.
93330     * @param string $attrlong Name of a longitude attribute.
93331     * @param float $latitude Anchor latitude in radians.
93332     * @param float $longitude Anchor longitude in radians.
93333     * @return bool
93334     * @since PECL sphinx >= 0.1.0
93335     **/
93336    function setGeoAnchor($attrlat, $attrlong, $latitude, $longitude){}
93337
93338    /**
93339     * Sets grouping attribute, function, and group sorting mode, and enables
93340     * grouping.
93341     *
93342     * Grouping feature is very similar to GROUP BY clause in SQL. Results
93343     * produced by this function call are going to be the same as produced by
93344     * the following pseudo code: SELECT ... GROUP BY $func($attribute) ORDER
93345     * BY $groupsort.
93346     *
93347     * @param string $attribute A string containing group-by attribute
93348     *   name.
93349     * @param int $func Constant, which sets a function applied to the
93350     *   attribute value in order to compute group-by key.
93351     * @param string $groupsort An optional clause controlling how the
93352     *   groups are sorted.
93353     * @return bool
93354     * @since PECL sphinx >= 0.1.0
93355     **/
93356    function setGroupBy($attribute, $func, $groupsort){}
93357
93358    /**
93359     * Sets attribute name for per-group distinct values count calculations.
93360     * Only available for grouping queries. For each group, all values of
93361     * {@link attribute} will be stored, then the amount of distinct values
93362     * will be calculated and returned to the client. This feature is similar
93363     * to COUNT(DISTINCT) clause in SQL.
93364     *
93365     * @param string $attribute A string containing group-by attribute
93366     *   name.
93367     * @return bool
93368     * @since PECL sphinx >= 0.1.0
93369     **/
93370    function setGroupDistinct($attribute){}
93371
93372    /**
93373     * Sets an accepted range of document IDs. Default range is from 0 to 0,
93374     * i.e. no limit. Only those records that have document ID between {@link
93375     * min} and {@link max} (including IDs exactly equal to {@link min} or
93376     * {@link max}) will be matched.
93377     *
93378     * @param int $min Minimum ID value.
93379     * @param int $max Maximum ID value.
93380     * @return bool
93381     * @since PECL sphinx >= 0.1.0
93382     **/
93383    function setIDRange($min, $max){}
93384
93385    /**
93386     * Sets per-index weights and enables weighted summing of match weights
93387     * across different indexes.
93388     *
93389     * @param array $weights An associative array mapping string index
93390     *   names to integer weights. Default is empty array, i.e. weighting
93391     *   summing is disabled.
93392     * @return bool
93393     * @since PECL sphinx >= 0.1.0
93394     **/
93395    function setIndexWeights($weights){}
93396
93397    /**
93398     * Sets {@link offset} into server-side result set and amount of matches
93399     * to return to client starting from that offset ({@link limit}). Can
93400     * additionally control maximum server-side result set size for current
93401     * query ({@link max_matches}) and the threshold amount of matches to
93402     * stop searching at ({@link cutoff}).
93403     *
93404     * @param int $offset Result set offset.
93405     * @param int $limit Amount of matches to return.
93406     * @param int $max_matches Controls how much matches searchd will keep
93407     *   in RAM while searching.
93408     * @param int $cutoff Used for advanced performance control. It tells
93409     *   searchd to forcibly stop search query once {@link cutoff} matches
93410     *   have been found and processed.
93411     * @return bool
93412     * @since PECL sphinx >= 0.1.0
93413     **/
93414    function setLimits($offset, $limit, $max_matches, $cutoff){}
93415
93416    /**
93417     * Sets full-text query matching mode. {@link mode} is one of the
93418     * constants listed below. Match modes Constant Description SPH_MATCH_ALL
93419     * Match all query words (default mode). SPH_MATCH_ANY Match any of query
93420     * words. SPH_MATCH_PHRASE Match query as a phrase, requiring perfect
93421     * match. SPH_MATCH_BOOLEAN Match query as a boolean expression.
93422     * SPH_MATCH_EXTENDED Match query as an expression in Sphinx internal
93423     * query language. SPH_MATCH_FULLSCAN Enables fullscan.
93424     * SPH_MATCH_EXTENDED2 The same as SPH_MATCH_EXTENDED plus ranking and
93425     * quorum searching support.
93426     *
93427     * @param int $mode Matching mode.
93428     * @return bool
93429     * @since PECL sphinx >= 0.1.0
93430     **/
93431    function setMatchMode($mode){}
93432
93433    /**
93434     * Sets maximum search query time.
93435     *
93436     * @param int $qtime Maximum query time, in milliseconds. It must be a
93437     *   non-negative integer. Default value is 0, i.e. no limit.
93438     * @return bool
93439     * @since PECL sphinx >= 0.1.0
93440     **/
93441    function setMaxQueryTime($qtime){}
93442
93443    /**
93444     * Sets temporary (per-query) per-document attribute value overrides.
93445     * Override feature lets you "temporary" update attribute values for some
93446     * documents within a single query, leaving all other queries unaffected.
93447     * This might be useful for personalized data
93448     *
93449     * @param string $attribute An attribute name.
93450     * @param int $type An attribute type. Only supports scalar attributes.
93451     * @param array $values Array of attribute values that maps document
93452     *   IDs to overridden attribute values.
93453     * @return bool
93454     * @since PECL sphinx >= 1.0.3
93455     **/
93456    function setOverride($attribute, $type, $values){}
93457
93458    /**
93459     * Sets ranking mode. Only available in SPH_MATCH_EXTENDED2 matching
93460     * mode. Ranking modes Constant Description SPH_RANK_PROXIMITY_BM25
93461     * Default ranking mode which uses both proximity and BM25 ranking.
93462     * SPH_RANK_BM25 Statistical ranking mode which uses BM25 ranking only
93463     * (similar to most of other full-text engines). This mode is faster, but
93464     * may result in worse quality on queries which contain more than 1
93465     * keyword. SPH_RANK_NONE Disables ranking. This mode is the fastest. It
93466     * is essentially equivalent to boolean searching, a weight of 1 is
93467     * assigned to all matches.
93468     *
93469     * @param int $ranker Ranking mode.
93470     * @return bool
93471     * @since PECL sphinx >= 0.1.0
93472     **/
93473    function setRankingMode($ranker){}
93474
93475    /**
93476     * Sets distributed retry count and delay.
93477     *
93478     * On temporary failures searchd will attempt up to {@link count} retries
93479     * per agent. {@link delay} is the delay between the retries, in
93480     * milliseconds. Retries are disabled by default. Note that this call
93481     * will not make the API itself retry on temporary failure; it only tells
93482     * searchd to do so.
93483     *
93484     * @param int $count Number of retries.
93485     * @param int $delay Delay between retries, in milliseconds.
93486     * @return bool
93487     * @since PECL sphinx >= 0.1.0
93488     **/
93489    function setRetries($count, $delay){}
93490
93491    /**
93492     * Sets the select clause, listing specific attributes to fetch, and
93493     * expressions to compute and fetch.
93494     *
93495     * @param string $clause SQL-like clause.
93496     * @return bool
93497     * @since PECL sphinx >= 1.0.1
93498     **/
93499    function setSelect($clause){}
93500
93501    /**
93502     * Sets searchd host name and TCP port. All subsequent requests will use
93503     * the new host and port settings. Default host and port are 'localhost'
93504     * and 3312, respectively.
93505     *
93506     * @param string $server IP or hostname.
93507     * @param int $port Port number.
93508     * @return bool
93509     * @since PECL sphinx >= 0.1.0
93510     **/
93511    function setServer($server, $port){}
93512
93513    /**
93514     * Sets matches sorting mode. See available modes below. Sorting modes
93515     * Constant Description SPH_SORT_RELEVANCE Sort by relevance in
93516     * descending order (best matches first). SPH_SORT_ATTR_DESC Sort by an
93517     * attribute in descending order (bigger attribute values first).
93518     * SPH_SORT_ATTR_ASC Sort by an attribute in ascending order (smaller
93519     * attribute values first). SPH_SORT_TIME_SEGMENTS Sort by time segments
93520     * (last hour/day/week/month) in descending order, and then by relevance
93521     * in descending order. SPH_SORT_EXTENDED Sort by SQL-like combination of
93522     * columns in ASC/DESC order. SPH_SORT_EXPR Sort by an arithmetic
93523     * expression.
93524     *
93525     * @param int $mode Sorting mode.
93526     * @param string $sortby
93527     * @return bool
93528     * @since PECL sphinx >= 0.1.0
93529     **/
93530    function setSortMode($mode, $sortby){}
93531
93532    /**
93533     * Queries searchd status, and returns an array of status variable name
93534     * and value pairs.
93535     *
93536     * @return array
93537     * @since PECL sphinx >= 1.0.3
93538     **/
93539    function status(){}
93540
93541    /**
93542     * Instantly updates given attribute values in given documents.
93543     *
93544     * @param string $index Name of the index (or indexes) to be updated.
93545     * @param array $attributes Array of attribute names, listing
93546     *   attributes that are updated.
93547     * @param array $values Associative array containing document IDs as
93548     *   keys and array of attribute values as values.
93549     * @return int
93550     * @since PECL sphinx >= 0.1.0
93551     **/
93552    function updateAttributes($index, $attributes, $values){}
93553
93554    /**
93555     * Creates a new SphinxClient object.
93556     *
93557     * @since PECL sphinx >= 0.1.0
93558     **/
93559    function __construct(){}
93560
93561}
93562/**
93563 * The SplBool class is used to enforce strong typing of the bool type.
93564 **/
93565class SplBool {
93566}
93567/**
93568 * The SplDoublyLinkedList class provides the main functionalities of a
93569 * doubly linked list.
93570 **/
93571class SplDoublyLinkedList implements Iterator, ArrayAccess, Countable {
93572    /**
93573     * @return mixed
93574     * @since PHP 5 >= 5.3.0
93575     **/
93576    function bottom(){}
93577
93578    /**
93579     * @return int
93580     * @since PHP 5 >= 5.3.0
93581     **/
93582    function count(){}
93583
93584    /**
93585     * Get the current doubly linked list node.
93586     *
93587     * @return mixed
93588     * @since PHP 5 >= 5.3.0
93589     **/
93590    function current(){}
93591
93592    /**
93593     * @return int
93594     * @since PHP 5 >= 5.3.0
93595     **/
93596    function getIteratorMode(){}
93597
93598    /**
93599     * @return bool
93600     * @since PHP 5 >= 5.3.0
93601     **/
93602    function isEmpty(){}
93603
93604    /**
93605     * This function returns the current node index
93606     *
93607     * @return mixed
93608     * @since PHP 5 >= 5.3.0
93609     **/
93610    function key(){}
93611
93612    /**
93613     * Move the iterator to the next node.
93614     *
93615     * @return void
93616     * @since PHP 5 >= 5.3.0
93617     **/
93618    function next(){}
93619
93620    /**
93621     * @param mixed $index The index being checked.
93622     * @return bool
93623     * @since PHP 5 >= 5.3.0
93624     **/
93625    function offsetExists($index){}
93626
93627    /**
93628     * @param mixed $index The index with the value.
93629     * @return mixed
93630     * @since PHP 5 >= 5.3.0
93631     **/
93632    function offsetGet($index){}
93633
93634    /**
93635     * Sets the value at the specified {@link index} to {@link newval}.
93636     *
93637     * @param mixed $index The index being set.
93638     * @param mixed $newval The new value for the {@link index}.
93639     * @return void
93640     * @since PHP 5 >= 5.3.0
93641     **/
93642    function offsetSet($index, $newval){}
93643
93644    /**
93645     * Unsets the value at the specified index.
93646     *
93647     * @param mixed $index The index being unset.
93648     * @return void
93649     * @since PHP 5 >= 5.3.0
93650     **/
93651    function offsetUnset($index){}
93652
93653    /**
93654     * @return mixed
93655     * @since PHP 5 >= 5.3.0
93656     **/
93657    function pop(){}
93658
93659    /**
93660     * Move the iterator to the previous node.
93661     *
93662     * @return void
93663     * @since PHP 5 >= 5.3.0
93664     **/
93665    function prev(){}
93666
93667    /**
93668     * Pushes {@link value} at the end of the doubly linked list.
93669     *
93670     * @param mixed $value The value to push.
93671     * @return void
93672     * @since PHP 5 >= 5.3.0
93673     **/
93674    function push($value){}
93675
93676    /**
93677     * This rewinds the iterator to the beginning.
93678     *
93679     * @return void
93680     * @since PHP 5 >= 5.3.0
93681     **/
93682    function rewind(){}
93683
93684    /**
93685     * @param int $mode There are two orthogonal sets of modes that can be
93686     *   set: The default mode is: SplDoublyLinkedList::IT_MODE_FIFO |
93687     *   SplDoublyLinkedList::IT_MODE_KEEP
93688     * @return void
93689     * @since PHP 5 >= 5.3.0
93690     **/
93691    function setIteratorMode($mode){}
93692
93693    /**
93694     * @return mixed
93695     * @since PHP 5 >= 5.3.0
93696     **/
93697    function shift(){}
93698
93699    /**
93700     * @return mixed
93701     * @since PHP 5 >= 5.3.0
93702     **/
93703    function top(){}
93704
93705    /**
93706     * Prepends {@link value} at the beginning of the doubly linked list.
93707     *
93708     * @param mixed $value The value to unshift.
93709     * @return void
93710     * @since PHP 5 >= 5.3.0
93711     **/
93712    function unshift($value){}
93713
93714    /**
93715     * Checks if the doubly linked list contains any more nodes.
93716     *
93717     * @return bool
93718     * @since PHP 5 >= 5.3.0
93719     **/
93720    function valid(){}
93721
93722}
93723/**
93724 * SplEnum gives the ability to emulate and create "Enum" objects
93725 * natively in PHP.
93726 **/
93727class SplEnum {
93728}
93729/**
93730 * The SplFileInfo class offers a high-level object oriented interface to
93731 * information for an individual file.
93732 **/
93733class SplFileInfo {
93734    /**
93735     * Gets the last access time for the file.
93736     *
93737     * @return int
93738     * @since PHP 5 >= 5.1.2
93739     **/
93740    function getATime(){}
93741
93742    /**
93743     * This method returns the base name of the file, directory, or link
93744     * without path info.
93745     *
93746     * @param string $suffix Optional suffix to omit from the base name
93747     *   returned.
93748     * @return string
93749     * @since PHP 5 >= 5.2.2
93750     **/
93751    function getBasename($suffix){}
93752
93753    /**
93754     * Returns the inode change time for the file. The time returned is a
93755     * Unix timestamp.
93756     *
93757     * @return int
93758     * @since PHP 5 >= 5.1.2
93759     **/
93760    function getCTime(){}
93761
93762    /**
93763     * This method gets an SplFileInfo object for the referenced file.
93764     *
93765     * @param string $class_name Name of an SplFileInfo derived class to
93766     *   use.
93767     * @return SplFileInfo
93768     * @since PHP 5 >= 5.1.2
93769     **/
93770    function getFileInfo($class_name){}
93771
93772    /**
93773     * Gets the filename without any path information.
93774     *
93775     * @return string
93776     * @since PHP 5 >= 5.1.2
93777     **/
93778    function getFilename(){}
93779
93780    /**
93781     * Gets the file group. The group ID is returned in numerical format.
93782     *
93783     * @return int
93784     * @since PHP 5 >= 5.1.2
93785     **/
93786    function getGroup(){}
93787
93788    /**
93789     * Gets the inode number for the filesystem object.
93790     *
93791     * @return int
93792     * @since PHP 5 >= 5.1.2
93793     **/
93794    function getInode(){}
93795
93796    /**
93797     * Gets the target of a filesystem link.
93798     *
93799     * @return string
93800     * @since PHP 5 >= 5.2.2
93801     **/
93802    function getLinkTarget(){}
93803
93804    /**
93805     * Returns the time when the contents of the file were changed. The time
93806     * returned is a Unix timestamp.
93807     *
93808     * @return int
93809     * @since PHP 5 >= 5.1.2
93810     **/
93811    function getMTime(){}
93812
93813    /**
93814     * Gets the file owner. The owner ID is returned in numerical format.
93815     *
93816     * @return int
93817     * @since PHP 5 >= 5.1.2
93818     **/
93819    function getOwner(){}
93820
93821    /**
93822     * Returns the path to the file, omitting the filename and any trailing
93823     * slash.
93824     *
93825     * @return string
93826     * @since PHP 5 >= 5.1.2
93827     **/
93828    function getPath(){}
93829
93830    /**
93831     * Gets an SplFileInfo object for the parent of the current file.
93832     *
93833     * @param string $class_name Name of an SplFileInfo derived class to
93834     *   use.
93835     * @return SplFileInfo
93836     * @since PHP 5 >= 5.1.2
93837     **/
93838    function getPathInfo($class_name){}
93839
93840    /**
93841     * Returns the path to the file.
93842     *
93843     * @return string
93844     * @since PHP 5 >= 5.1.2
93845     **/
93846    function getPathname(){}
93847
93848    /**
93849     * Gets the file permissions for the file.
93850     *
93851     * @return int
93852     * @since PHP 5 >= 5.1.2
93853     **/
93854    function getPerms(){}
93855
93856    /**
93857     * This method expands all symbolic links, resolves relative references
93858     * and returns the real path to the file.
93859     *
93860     * @return string
93861     * @since PHP 5 >= 5.2.2
93862     **/
93863    function getRealPath(){}
93864
93865    /**
93866     * Returns the filesize in bytes for the file referenced.
93867     *
93868     * @return int
93869     * @since PHP 5 >= 5.1.2
93870     **/
93871    function getSize(){}
93872
93873    /**
93874     * Returns the type of the file referenced.
93875     *
93876     * @return string
93877     * @since PHP 5 >= 5.1.2
93878     **/
93879    function getType(){}
93880
93881    /**
93882     * This method can be used to determine if the file is a directory.
93883     *
93884     * @return bool
93885     * @since PHP 5 >= 5.1.2
93886     **/
93887    function isDir(){}
93888
93889    /**
93890     * Checks if the file is executable.
93891     *
93892     * @return bool
93893     * @since PHP 5 >= 5.1.2
93894     **/
93895    function isExecutable(){}
93896
93897    /**
93898     * Checks if the file referenced by this SplFileInfo object exists and is
93899     * a regular file.
93900     *
93901     * @return bool
93902     * @since PHP 5 >= 5.1.2
93903     **/
93904    function isFile(){}
93905
93906    /**
93907     * Use this method to check if the file referenced by the SplFileInfo
93908     * object is a link.
93909     *
93910     * @return bool
93911     * @since PHP 5 >= 5.1.2
93912     **/
93913    function isLink(){}
93914
93915    /**
93916     * Check if the file is readable.
93917     *
93918     * @return bool
93919     * @since PHP 5 >= 5.1.2
93920     **/
93921    function isReadable(){}
93922
93923    /**
93924     * Checks if the current entry is writable.
93925     *
93926     * @return bool
93927     * @since PHP 5 >= 5.1.2
93928     **/
93929    function isWritable(){}
93930
93931    /**
93932     * Creates an SplFileObject object of the file. This is useful because
93933     * SplFileObject contains additional methods for manipulating the file
93934     * whereas SplFileInfo is only useful for gaining information, like
93935     * whether the file is writable.
93936     *
93937     * @param string $open_mode The mode for opening the file. See the
93938     *   {@link fopen} documentation for descriptions of possible modes. The
93939     *   default is read only.
93940     * @param bool $use_include_path
93941     * @param resource $context
93942     * @return SplFileObject
93943     * @since PHP 5 >= 5.1.2
93944     **/
93945    function openFile($open_mode, $use_include_path, $context){}
93946
93947    /**
93948     * Set the class name which SplFileInfo will use to open files with when
93949     * openFile() is called. The class name passed to this method must be
93950     * derived from SplFileObject.
93951     *
93952     * @param string $class_name The class name to use when openFile() is
93953     *   called.
93954     * @return void
93955     * @since PHP 5 >= 5.1.2
93956     **/
93957    function setFileClass($class_name){}
93958
93959    /**
93960     * Use this method to set a custom class which will be used when
93961     * getFileInfo and getPathInfo are called. The class name passed to this
93962     * method must be derived from SplFileInfo.
93963     *
93964     * @param string $class_name The class name to use.
93965     * @return void
93966     * @since PHP 5 >= 5.1.2
93967     **/
93968    function setInfoClass($class_name){}
93969
93970    /**
93971     * Creates a new SplFileInfo object for the file_name specified. The file
93972     * does not need to exist, or be readable.
93973     *
93974     * @param string $file_name Path to the file.
93975     * @since PHP 5 >= 5.1.2
93976     **/
93977    function __construct($file_name){}
93978
93979    /**
93980     * This method will return the file name of the referenced file.
93981     *
93982     * @return void
93983     * @since PHP 5 >= 5.1.2
93984     **/
93985    function __toString(){}
93986
93987}
93988/**
93989 * The SplFileObject class offers an object oriented interface for a
93990 * file.
93991 **/
93992class SplFileObject extends SplFileInfo implements RecursiveIterator, Traversable, Iterator, SeekableIterator {
93993    /**
93994     * Retrieves the current line of the file.
93995     *
93996     * @return string|array
93997     * @since PHP 5 >= 5.1.0
93998     **/
93999    function current(){}
94000
94001    /**
94002     * Determine whether the end of file has been reached
94003     *
94004     * @return boolean
94005     * @since PHP 5 >= 5.1.0
94006     **/
94007    function eof(){}
94008
94009    /**
94010     * Forces a write of all buffered output to the file.
94011     *
94012     * @return boolean
94013     * @since PHP 5 >= 5.1.0
94014     **/
94015    function fflush(){}
94016
94017    /**
94018     * Gets a character from the file.
94019     *
94020     * @return string
94021     * @since PHP 5 >= 5.1.0
94022     **/
94023    function fgetc(){}
94024
94025    /**
94026     * Gets a line from the file which is in CSV format and returns an array
94027     * containing the fields read.
94028     *
94029     * @param string $delimiter The field delimiter (one character only).
94030     *   Defaults as a comma or the value set using
94031     *   SplFileObject::setCsvControl.
94032     * @param string $enclosure The field enclosure character (one
94033     *   character only). Defaults as a double quotation mark or the value
94034     *   set using SplFileObject::setCsvControl.
94035     * @param string $escape The escape character (one character only).
94036     *   Defaults as a backslash (\) or the value set using
94037     *   SplFileObject::setCsvControl.
94038     * @return array
94039     * @since PHP 5 >= 5.1.0
94040     **/
94041    function fgetcsv($delimiter, $enclosure, $escape){}
94042
94043    /**
94044     * Gets a line from the file.
94045     *
94046     * @return string
94047     * @since PHP 5 >= 5.1.0
94048     **/
94049    function fgets(){}
94050
94051    /**
94052     * Identical to SplFileObject::fgets, except that SplFileObject::fgetss
94053     * attempts to strip any HTML and PHP tags from the text it reads.
94054     *
94055     * @param string $allowable_tags You can use the optional third
94056     *   parameter to specify tags which should not be stripped.
94057     * @return string
94058     * @since PHP 5 >= 5.1.0
94059     **/
94060    function fgetss($allowable_tags){}
94061
94062    /**
94063     * Locks or unlocks the file in the same portable way as {@link flock}.
94064     *
94065     * @param int $operation {@link operation} is one of the following:
94066     *   LOCK_SH to acquire a shared lock (reader). LOCK_EX to acquire an
94067     *   exclusive lock (writer). LOCK_UN to release a lock (shared or
94068     *   exclusive). LOCK_NB to not block while locking (not supported on
94069     *   Windows).
94070     * @param int $wouldblock Set to if the lock would block (EWOULDBLOCK
94071     *   errno condition).
94072     * @return bool
94073     * @since PHP 5 >= 5.1.0
94074     **/
94075    function flock($operation, &$wouldblock){}
94076
94077    /**
94078     * Reads to EOF on the given file pointer from the current position and
94079     * writes the results to the output buffer.
94080     *
94081     * You may need to call SplFileObject::rewind to reset the file pointer
94082     * to the beginning of the file if you have already written data to the
94083     * file.
94084     *
94085     * @return int
94086     * @since PHP 5 >= 5.1.0
94087     **/
94088    function fpassthru(){}
94089
94090    /**
94091     * Reads a line from the file and interprets it according to the
94092     * specified {@link format}, which is described in the documentation for
94093     * {@link sprintf}.
94094     *
94095     * Any whitespace in the {@link format} string matches any whitespace in
94096     * the line from the file. This means that even a tab \t in the format
94097     * string can match a single space character in the input stream.
94098     *
94099     * @param string $format The specified format as described in the
94100     *   {@link sprintf} documentation.
94101     * @return mixed
94102     * @since PHP 5 >= 5.1.0
94103     **/
94104    function fscanf($format){}
94105
94106    /**
94107     * Seek to a position in the file measured in bytes from the beginning of
94108     * the file, obtained by adding {@link offset} to the position specified
94109     * by {@link whence}.
94110     *
94111     * @param int $offset The offset. A negative value can be used to move
94112     *   backwards through the file which is useful when SEEK_END is used as
94113     *   the {@link whence} value.
94114     * @param int $whence {@link whence} values are: SEEK_SET - Set
94115     *   position equal to {@link offset} bytes. SEEK_CUR - Set position to
94116     *   current location plus {@link offset}. SEEK_END - Set position to
94117     *   end-of-file plus {@link offset}. If {@link whence} is not specified,
94118     *   it is assumed to be SEEK_SET.
94119     * @return int
94120     * @since PHP 5 >= 5.1.0
94121     **/
94122    function fseek($offset, $whence){}
94123
94124    /**
94125     * Gathers the statistics of the file. Behaves identically to {@link
94126     * fstat}.
94127     *
94128     * @return array
94129     * @since PHP 5 >= 5.1.0
94130     **/
94131    function fstat(){}
94132
94133    /**
94134     * Returns the position of the file pointer which represents the current
94135     * offset in the file stream.
94136     *
94137     * @return int
94138     * @since PHP 5 >= 5.1.0
94139     **/
94140    function ftell(){}
94141
94142    /**
94143     * Truncates the file to {@link size} bytes.
94144     *
94145     * @param int $size The size to truncate to.
94146     * @return bool
94147     * @since PHP 5 >= 5.1.0
94148     **/
94149    function ftruncate($size){}
94150
94151    /**
94152     * Writes the contents of {@link string} to the file
94153     *
94154     * @param string $str The string to be written to the file.
94155     * @param int $length If the {@link length} argument is given, writing
94156     *   will stop after {@link length} bytes have been written or the end of
94157     *   {@link string} is reached, whichever comes first.
94158     * @return int
94159     * @since PHP 5 >= 5.1.0
94160     **/
94161    function fwrite($str, $length){}
94162
94163    /**
94164     * An SplFileObject does not have children so this method returns .
94165     *
94166     * @return void
94167     * @since PHP 5 >= 5.1.0
94168     **/
94169    function getChildren(){}
94170
94171    /**
94172     * Gets the delimiter and enclosure character used for parsing CSV
94173     * fields.
94174     *
94175     * @return array
94176     * @since PHP 5 >= 5.2.0
94177     **/
94178    function getCsvControl(){}
94179
94180    /**
94181     * Gets the flags set for an instance of SplFileObject as an integer.
94182     *
94183     * @return int
94184     * @since PHP 5 >= 5.1.0
94185     **/
94186    function getFlags(){}
94187
94188    /**
94189     * Gets the maximum line length as set by SplFileObject::setMaxLineLen.
94190     *
94191     * @return int
94192     * @since PHP 5 >= 5.1.0
94193     **/
94194    function getMaxLineLen(){}
94195
94196    /**
94197     * An SplFileObject does not have children so this method always return .
94198     *
94199     * @return bool
94200     * @since PHP 5 >= 5.1.2
94201     **/
94202    function hasChildren(){}
94203
94204    /**
94205     * Gets the current line number.
94206     *
94207     * @return int
94208     * @since PHP 5 >= 5.1.0
94209     **/
94210    function key(){}
94211
94212    /**
94213     * Moves ahead to the next line in the file.
94214     *
94215     * @return void
94216     * @since PHP 5 >= 5.1.0
94217     **/
94218    function next(){}
94219
94220    /**
94221     * Rewinds the file back to the first line.
94222     *
94223     * @return void
94224     * @since PHP 5 >= 5.1.0
94225     **/
94226    function rewind(){}
94227
94228    /**
94229     * Seek to specified line in the file.
94230     *
94231     * @param int $line_pos The zero-based line number to seek to.
94232     * @return void
94233     * @since PHP 5 >= 5.1.0
94234     **/
94235    function seek($line_pos){}
94236
94237    /**
94238     * Sets the delimiter and enclosure character for parsing CSV fields.
94239     *
94240     * @param string $delimiter The field delimiter (one character only).
94241     * @param string $enclosure The field enclosure character (one
94242     *   character only).
94243     * @param string $escape The field escape character (one character
94244     *   only).
94245     * @return void
94246     * @since PHP 5 >= 5.2.0
94247     **/
94248    function setCsvControl($delimiter, $enclosure, $escape){}
94249
94250    /**
94251     * Sets the flags to be used by the SplFileObject.
94252     *
94253     * @param int $flags Bit mask of the flags to set. See SplFileObject
94254     *   constants for the available flags.
94255     * @return void
94256     * @since PHP 5 >= 5.1.0
94257     **/
94258    function setFlags($flags){}
94259
94260    /**
94261     * Sets the maximum length of a line to be read.
94262     *
94263     * @param int $max_len The maximum length of a line.
94264     * @return void
94265     * @since PHP 5 >= 5.1.0
94266     **/
94267    function setMaxLineLen($max_len){}
94268
94269    /**
94270     * Check whether EOF has been reached.
94271     *
94272     * @return bool
94273     * @since PHP 5 >= 5.1.0
94274     **/
94275    function valid(){}
94276
94277    /**
94278     * Construct a new file object.
94279     *
94280     * @param string $filename The file to read.
94281     * @param string $open_mode The mode in which to open the file. See
94282     *   {@link fopen} for a list of allowed modes.
94283     * @param bool $use_include_path Whether to search in the include_path
94284     *   for {@link filename}.
94285     * @param resource $context A valid context resource created with
94286     *   {@link stream_context_create}.
94287     * @since PHP 5 >= 5.1.0
94288     **/
94289    function __construct($filename, $open_mode, $use_include_path, $context){}
94290
94291}
94292/**
94293 * The SplFixedArray class provides the main functionalities of array.
94294 * The main differences between a SplFixedArray and a normal PHP array is
94295 * that the SplFixedArray is of fixed length and allows only integers
94296 * within the range as indexes. The advantage is that it allows a faster
94297 * array implementation.
94298 **/
94299class SplFixedArray implements Iterator, ArrayAccess, Countable {
94300    /**
94301     * Returns the size of the array.
94302     *
94303     * @return int
94304     * @since PHP 5 >= 5.3.0
94305     **/
94306    function count(){}
94307
94308    /**
94309     * Get the current array element.
94310     *
94311     * @return mixed
94312     * @since PHP 5 >= 5.3.0
94313     **/
94314    function current(){}
94315
94316    /**
94317     * Import the PHP array {@link array} in a new SplFixedArray instance
94318     *
94319     * @param array $array The array to import.
94320     * @param boolean $save_indexes Try to save the numeric indexes used in
94321     *   the original array.
94322     * @return SplFixedArray
94323     * @since PHP 5 >= 5.3.0
94324     **/
94325    function fromArray($array, $save_indexes){}
94326
94327    /**
94328     * Gets the size of the array.
94329     *
94330     * @return int
94331     * @since PHP 5 >= 5.3.0
94332     **/
94333    function getSize(){}
94334
94335    /**
94336     * Returns the current array index.
94337     *
94338     * @return int
94339     * @since PHP 5 >= 5.3.0
94340     **/
94341    function key(){}
94342
94343    /**
94344     * Move the iterator to the next array entry.
94345     *
94346     * @return void
94347     * @since PHP 5 >= 5.3.0
94348     **/
94349    function next(){}
94350
94351    /**
94352     * Checks whether the requested index {@link index} exists.
94353     *
94354     * @param int $index The index being checked.
94355     * @return bool
94356     * @since PHP 5 >= 5.3.0
94357     **/
94358    function offsetExists($index){}
94359
94360    /**
94361     * Returns the value at the index {@link index}.
94362     *
94363     * @param int $index The index with the value.
94364     * @return mixed
94365     * @since PHP 5 >= 5.3.0
94366     **/
94367    function offsetGet($index){}
94368
94369    /**
94370     * Sets the value at the specified {@link index} to {@link newval}.
94371     *
94372     * @param int $index The index being set.
94373     * @param mixed $newval The new value for the {@link index}.
94374     * @return void
94375     * @since PHP 5 >= 5.3.0
94376     **/
94377    function offsetSet($index, $newval){}
94378
94379    /**
94380     * Unsets the value at the specified index.
94381     *
94382     * @param int $index The index being unset.
94383     * @return void
94384     * @since PHP 5 >= 5.3.0
94385     **/
94386    function offsetUnset($index){}
94387
94388    /**
94389     * Rewinds the iterator to the beginning.
94390     *
94391     * @return void
94392     * @since PHP 5 >= 5.3.0
94393     **/
94394    function rewind(){}
94395
94396    /**
94397     * Change the size of an array to the new size of {@link size}.
94398     *
94399     * @param int $size The new array size.
94400     * @return int
94401     * @since PHP 5 >= 5.3.0
94402     **/
94403    function setSize($size){}
94404
94405    /**
94406     * Returns a PHP array from the fixed array.
94407     *
94408     * @return array
94409     * @since PHP 5 >= 5.3.0
94410     **/
94411    function toArray(){}
94412
94413    /**
94414     * Checks if the array contains any more elements.
94415     *
94416     * @return bool
94417     * @since PHP 5 >= 5.3.0
94418     **/
94419    function valid(){}
94420
94421}
94422/**
94423 * The SplFloat class is used to enforce strong typing of the float type.
94424 **/
94425class SplFloat {
94426}
94427/**
94428 * The SplHeap class provides the main functionalities of an Heap.
94429 **/
94430class SplHeap implements Iterator, Countable {
94431    /**
94432     * Compare {@link value1} with {@link value2}.
94433     *
94434     * @param mixed $value1 The value of the first node being compared.
94435     * @param mixed $value2 The value of the second node being compared.
94436     * @return int
94437     * @since PHP 5 >= 5.3.0
94438     **/
94439    function compare($value1, $value2){}
94440
94441    /**
94442     * @return int
94443     * @since PHP 5 >= 5.3.0
94444     **/
94445    function count(){}
94446
94447    /**
94448     * Get the current datastructure node.
94449     *
94450     * @return mixed
94451     * @since PHP 5 >= 5.3.0
94452     **/
94453    function current(){}
94454
94455    /**
94456     * @return mixed
94457     * @since PHP 5 >= 5.3.0
94458     **/
94459    function extract(){}
94460
94461    /**
94462     * Insert {@link value} in the heap.
94463     *
94464     * @param mixed $value The value to insert.
94465     * @return void
94466     * @since PHP 5 >= 5.3.0
94467     **/
94468    function insert($value){}
94469
94470    /**
94471     * @return bool
94472     * @since PHP 5 >= 5.3.0
94473     **/
94474    function isEmpty(){}
94475
94476    /**
94477     * This function returns the current node index
94478     *
94479     * @return mixed
94480     * @since PHP 5 >= 5.3.0
94481     **/
94482    function key(){}
94483
94484    /**
94485     * Extracts the top node from the heap.
94486     *
94487     * @return void
94488     * @since PHP 5 >= 5.3.0
94489     **/
94490    function next(){}
94491
94492    /**
94493     * @return void
94494     * @since PHP 5 >= 5.3.0
94495     **/
94496    function recoverFromCorruption(){}
94497
94498    /**
94499     * This rewinds the iterator to the beginning. This is a no-op for heaps
94500     * as the iterator is virtual and in fact never moves from the top of the
94501     * heap.
94502     *
94503     * @return void
94504     * @since PHP 5 >= 5.3.0
94505     **/
94506    function rewind(){}
94507
94508    /**
94509     * @return mixed
94510     * @since PHP 5 >= 5.3.0
94511     **/
94512    function top(){}
94513
94514    /**
94515     * Checks if the heap contains any more nodes.
94516     *
94517     * @return bool
94518     * @since PHP 5 >= 5.3.0
94519     **/
94520    function valid(){}
94521
94522}
94523/**
94524 * The SplInt class is used to enforce strong typing of the integer type.
94525 **/
94526class SplInt {
94527}
94528/**
94529 * The SplMaxHeap class provides the main functionalities of a heap,
94530 * keeping the maximum on the top.
94531 **/
94532class SplMaxHeap extends SplHeap implements Iterator, Countable {
94533    /**
94534     * Compare {@link value1} with {@link value2}.
94535     *
94536     * @param mixed $value1 The value of the first node being compared.
94537     * @param mixed $value2 The value of the second node being compared.
94538     * @return void
94539     * @since PHP 5 >= 5.3.0
94540     **/
94541    function compare($value1, $value2){}
94542
94543}
94544/**
94545 * The SplMinHeap class provides the main functionalities of a heap,
94546 * keeping the minimum on the top.
94547 **/
94548class SplMinHeap extends SplHeap implements Iterator, Countable {
94549    /**
94550     * Compare {@link value1} with {@link value2}.
94551     *
94552     * @param mixed $value1 The value of the first node being compared.
94553     * @param mixed $value2 The value of the second node being compared.
94554     * @return void
94555     * @since PHP 5 >= 5.3.0
94556     **/
94557    function compare($value1, $value2){}
94558
94559}
94560/**
94561 * The SplObjectStorage class provides a map from objects to data or, by
94562 * ignoring data, an object set. This dual purpose can be useful in many
94563 * cases involving the need to uniquely identify objects.
94564 **/
94565class SplObjectStorage implements Countable, Iterator, Traversable, Serializable, ArrayAccess {
94566    /**
94567     * Adds all objects-data pairs from a different storage in the current
94568     * storage.
94569     *
94570     * @param SplObjectStorage $storage The storage you want to import.
94571     * @return void
94572     * @since PHP 5 >= 5.3.0
94573     **/
94574    function addAll($storage){}
94575
94576    /**
94577     * Adds an object inside the storage, and optionaly associate it to some
94578     * data.
94579     *
94580     * @param object $object The object to add.
94581     * @param mixed $data The data to associate with the object.
94582     * @return void
94583     * @since PHP 5 >= 5.1.0
94584     **/
94585    function attach($object, $data){}
94586
94587    /**
94588     * Checks if the storage contains the object provided.
94589     *
94590     * @param object $object The object to look for.
94591     * @return boolean
94592     * @since PHP 5 >= 5.1.0
94593     **/
94594    function contains($object){}
94595
94596    /**
94597     * Counts the number of objects in the storage.
94598     *
94599     * @return int
94600     * @since PHP 5 >= 5.1.0
94601     **/
94602    function count(){}
94603
94604    /**
94605     * Returns the current storage entry.
94606     *
94607     * @return object
94608     * @since PHP 5 >= 5.1.0
94609     **/
94610    function current(){}
94611
94612    /**
94613     * Removes the object from the storage.
94614     *
94615     * @param object $object The object to remove.
94616     * @return void
94617     * @since PHP 5 >= 5.1.0
94618     **/
94619    function detach($object){}
94620
94621    /**
94622     * Returns the data, or info, associated with the object pointed by the
94623     * current iterator position.
94624     *
94625     * @return mixed
94626     * @since PHP 5 >= 5.3.0
94627     **/
94628    function getInfo(){}
94629
94630    /**
94631     * Returns the index at which the iterator currently is.
94632     *
94633     * @return int
94634     * @since PHP 5 >= 5.1.0
94635     **/
94636    function key(){}
94637
94638    /**
94639     * Moves the iterator to the next object in the storage.
94640     *
94641     * @return void
94642     * @since PHP 5 >= 5.1.0
94643     **/
94644    function next(){}
94645
94646    /**
94647     * Checks whether an object exists in the storage.
94648     *
94649     * @param object $object The object to look for.
94650     * @return boolean
94651     * @since PHP 5 >= 5.3.0
94652     **/
94653    function offsetExists($object){}
94654
94655    /**
94656     * Returns the data associated with an object in the storage.
94657     *
94658     * @param object $object The object to look for.
94659     * @return mixed
94660     * @since PHP 5 >= 5.3.0
94661     **/
94662    function offsetGet($object){}
94663
94664    /**
94665     * Associate data to an object in the storage.
94666     *
94667     * @param object $object The object to associate data with.
94668     * @param mixed $info The data to associate with the object.
94669     * @return void
94670     * @since PHP 5 >= 5.3.0
94671     **/
94672    function offsetSet($object, $info){}
94673
94674    /**
94675     * Removes an object from the storage.
94676     *
94677     * @param object $object The object to remove.
94678     * @return void
94679     * @since PHP 5 >= 5.3.0
94680     **/
94681    function offsetUnset($object){}
94682
94683    /**
94684     * Removes objects contained in another storage from the current storage.
94685     *
94686     * @param SplObjectStorage $storage The storage containing the elements
94687     *   to remove.
94688     * @return void
94689     * @since PHP 5 >= 5.3.0
94690     **/
94691    function removeAll($storage){}
94692
94693    /**
94694     * Rewind the iterator to the first storage element.
94695     *
94696     * @return void
94697     * @since PHP 5 >= 5.1.0
94698     **/
94699    function rewind(){}
94700
94701    /**
94702     * Returns a string representation of the storage.
94703     *
94704     * @return string
94705     * @since PHP 5 >= 5.2.2
94706     **/
94707    function serialize(){}
94708
94709    /**
94710     * Associates data, or info, with the object currently pointed to by the
94711     * iterator.
94712     *
94713     * @param mixed $data The data to associate with the current iterator
94714     *   entry.
94715     * @return void
94716     * @since PHP 5 >= 5.3.0
94717     **/
94718    function setInfo($data){}
94719
94720    /**
94721     * Unserializes storage entries and attach them to the current storage.
94722     *
94723     * @param string $serialized The serialized representation of a
94724     *   storage.
94725     * @return void
94726     * @since PHP 5 >= 5.2.2
94727     **/
94728    function unserialize($serialized){}
94729
94730    /**
94731     * Returns if the current iterator entry is valid.
94732     *
94733     * @return boolean
94734     * @since PHP 5 >= 5.1.0
94735     **/
94736    function valid(){}
94737
94738}
94739/**
94740 * The interface is used alongside to implement the Observer Design
94741 * Pattern.
94742 **/
94743interface SplObserver {
94744    /**
94745     * This method is called when any SplSubject to which the observer is
94746     * attached calls SplSubject::notify.
94747     *
94748     * @param SplSubject $subject The SplSubject notifying the observer of
94749     *   an update.
94750     * @return void
94751     * @since PHP 5 >= 5.1.0
94752     **/
94753    function update($subject);
94754
94755}
94756/**
94757 * The SplPriorityQueue class provides the main functionalities of an
94758 * prioritized queue, implemented using a heap.
94759 **/
94760class SplPriorityQueue implements Iterator, Countable {
94761    /**
94762     * Compare {@link priority1} with {@link priority2}.
94763     *
94764     * @param mixed $priority1 The priority of the first node being
94765     *   compared.
94766     * @param mixed $priority2 The priority of the second node being
94767     *   compared.
94768     * @return int
94769     * @since PHP 5 >= 5.3.0
94770     **/
94771    function compare($priority1, $priority2){}
94772
94773    /**
94774     * @return int
94775     * @since PHP 5 >= 5.3.0
94776     **/
94777    function count(){}
94778
94779    /**
94780     * Get the current datastructure node.
94781     *
94782     * @return mixed
94783     * @since PHP 5 >= 5.3.0
94784     **/
94785    function current(){}
94786
94787    /**
94788     * @return mixed
94789     * @since PHP 5 >= 5.3.0
94790     **/
94791    function extract(){}
94792
94793    /**
94794     * Insert {@link value} with the priority {@link priority} in the queue.
94795     *
94796     * @param mixed $value The value to insert.
94797     * @param mixed $priority The associated priority.
94798     * @return void
94799     * @since PHP 5 >= 5.3.0
94800     **/
94801    function insert($value, $priority){}
94802
94803    /**
94804     * @return bool
94805     * @since PHP 5 >= 5.3.0
94806     **/
94807    function isEmpty(){}
94808
94809    /**
94810     * This function returns the current node index
94811     *
94812     * @return mixed
94813     * @since PHP 5 >= 5.3.0
94814     **/
94815    function key(){}
94816
94817    /**
94818     * Extracts the top node from the queue.
94819     *
94820     * @return void
94821     * @since PHP 5 >= 5.3.0
94822     **/
94823    function next(){}
94824
94825    /**
94826     * @return void
94827     * @since PHP 5 >= 5.3.0
94828     **/
94829    function recoverFromCorruption(){}
94830
94831    /**
94832     * This rewinds the iterator to the beginning. This is a no-op for heaps
94833     * as the iterator is virtual and in fact never moves from the top of the
94834     * heap.
94835     *
94836     * @return void
94837     * @since PHP 5 >= 5.3.0
94838     **/
94839    function rewind(){}
94840
94841    /**
94842     * @param int $flags Defines what is extracted by
94843     *   SplPriorityQueue::current, SplPriorityQueue::top and
94844     *   SplPriorityQueue::extract. The default mode is
94845     *   SplPriorityQueue::EXTR_DATA.
94846     * @return void
94847     * @since PHP 5 >= 5.3.0
94848     **/
94849    function setExtractFlags($flags){}
94850
94851    /**
94852     * @return mixed
94853     * @since PHP 5 >= 5.3.0
94854     **/
94855    function top(){}
94856
94857    /**
94858     * Checks if the queue contains any more nodes.
94859     *
94860     * @return bool
94861     * @since PHP 5 >= 5.3.0
94862     **/
94863    function valid(){}
94864
94865}
94866/**
94867 * The SplQueue class provides the main functionalities of a queue
94868 * implemented using a doubly linked list.
94869 **/
94870class SplQueue extends SplDoublyLinkedList implements Iterator, ArrayAccess, Countable {
94871    /**
94872     * Dequeues {@link value} from the top of of the queue.
94873     *
94874     * @return mixed
94875     * @since PHP 5 >= 5.3.0
94876     **/
94877    function dequeue(){}
94878
94879    /**
94880     * Enqueues {@link value} at the end of the queue.
94881     *
94882     * @param mixed $value The value to enqueue.
94883     * @return void
94884     * @since PHP 5 >= 5.3.0
94885     **/
94886    function enqueue($value){}
94887
94888    /**
94889     * @param int $mode There is only one iteration parameter you can
94890     *   modify. The default mode is: SplDoublyLinkedList::IT_MODE_FIFO |
94891     *   SplDoublyLinkedList::IT_MODE_KEEP
94892     * @return void
94893     * @since PHP 5 >= 5.3.0
94894     **/
94895    function setIteratorMode($mode){}
94896
94897}
94898/**
94899 * The SplStack class provides the main functionalities of a stack
94900 * implemented using a doubly linked list.
94901 **/
94902class SplStack extends SplDoublyLinkedList implements Iterator, ArrayAccess, Countable {
94903    /**
94904     * @param int $mode There is only one iteration parameter you can
94905     *   modify. The default mode is 0x2 : SplDoublyLinkedList::IT_MODE_LIFO
94906     *   | SplDoublyLinkedList::IT_MODE_KEEP
94907     * @return void
94908     * @since PHP 5 >= 5.3.0
94909     **/
94910    function setIteratorMode($mode){}
94911
94912}
94913/**
94914 * The SplString class is used to enforce strong typing of the string
94915 * type.
94916 **/
94917class SplString {
94918}
94919/**
94920 * The interface is used alongside to implement the Observer Design
94921 * Pattern.
94922 **/
94923interface SplSubject {
94924    /**
94925     * Attaches an SplObserver so that it can be notified of updates.
94926     *
94927     * @param SplObserver $observer The SplObserver to attach.
94928     * @return void
94929     * @since PHP 5 >= 5.1.0
94930     **/
94931    function attach($observer);
94932
94933    /**
94934     * Detaches an observer from the subject to no longer notify it of
94935     * updates.
94936     *
94937     * @param SplObserver $observer The SplObserver to detach.
94938     * @return void
94939     * @since PHP 5 >= 5.1.0
94940     **/
94941    function detach($observer);
94942
94943    /**
94944     * Notifies all attached observers.
94945     *
94946     * @return void
94947     * @since PHP 5 >= 5.1.0
94948     **/
94949    function notify();
94950
94951}
94952/**
94953 * The SplTempFileObject class offers an object oriented interface for a
94954 * temporary file.
94955 **/
94956class SplTempFileObject extends SplFileObject implements SeekableIterator, Iterator, Traversable, RecursiveIterator {
94957    /**
94958     * Construct a new temporary file object.
94959     *
94960     * @param integer $max_memory The maximum amount of memory (in bytes,
94961     *   default is 2 MB) for the temporary file to use. If the temporary
94962     *   file exceeds this size, it will be moved to a file in the system's
94963     *   temp directory. If {@link max_memory} is negative, only memory will
94964     *   be used. If {@link max_memory} is zero, no memory will be used.
94965     * @since PHP 5 >= 5.1.2
94966     **/
94967    function __construct($max_memory){}
94968
94969}
94970/**
94971 * A class that interfaces SQLite 3 databases.
94972 **/
94973class SQLite3 {
94974    /**
94975     * Returns the number of database rows that were changed (or inserted or
94976     * deleted) by the most recent SQL statement.
94977     *
94978     * @return int
94979     * @since PHP 5 >= 5.3.0
94980     **/
94981    function changes(){}
94982
94983    /**
94984     * Closes the database connection.
94985     *
94986     * @return bool
94987     * @since PHP 5 >= 5.3.0
94988     **/
94989    function close(){}
94990
94991    /**
94992     * Registers a PHP function or user-defined function for use as an SQL
94993     * aggregate function for use within SQL statements.
94994     *
94995     * @param string $name Name of the SQL aggregate to be created or
94996     *   redefined.
94997     * @param mixed $step_callback The name of a PHP function or
94998     *   user-defined function to apply as a callback for every item in the
94999     *   aggregate.
95000     * @param mixed $final_callback The name of a PHP function or
95001     *   user-defined function to apply as a callback at the end of the
95002     *   aggregate data.
95003     * @param int $argument_count The number of arguments that the SQL
95004     *   aggregate takes. If this parameter is negative, then the SQL
95005     *   aggregate may take any number of arguments.
95006     * @return bool
95007     * @since PHP 5 >= 5.3.0
95008     **/
95009    function createAggregate($name, $step_callback, $final_callback, $argument_count){}
95010
95011    /**
95012     * Registers a PHP function or user-defined function for use as an SQL
95013     * scalar function for use within SQL statements.
95014     *
95015     * @param string $name Name of the SQL function to be created or
95016     *   redefined.
95017     * @param mixed $callback The name of a PHP function or user-defined
95018     *   function to apply as a callback, defining the behavior of the SQL
95019     *   function.
95020     * @param int $argument_count The number of arguments that the SQL
95021     *   function takes. If this parameter is negative, then the SQL function
95022     *   may take any number of arguments.
95023     * @return bool
95024     * @since PHP 5 >= 5.3.0
95025     **/
95026    function createFunction($name, $callback, $argument_count){}
95027
95028    /**
95029     * Returns a string that has been properly escaped for safe inclusion in
95030     * an SQL statement.
95031     *
95032     * @param string $value The string to be escaped.
95033     * @return string
95034     * @since PHP 5 >= 5.3.0
95035     **/
95036    function escapeString($value){}
95037
95038    /**
95039     * Executes a result-less query against a given database.
95040     *
95041     * @param string $query The SQL query to execute (typically an INSERT,
95042     *   UPDATE, or DELETE query).
95043     * @return bool
95044     * @since PHP 5 >= 5.3.0
95045     **/
95046    function exec($query){}
95047
95048    /**
95049     * Returns the numeric result code of the most recent failed SQLite
95050     * request.
95051     *
95052     * @return int
95053     * @since PHP 5 >= 5.3.0
95054     **/
95055    function lastErrorCode(){}
95056
95057    /**
95058     * Returns English text describing the most recent failed SQLite request.
95059     *
95060     * @return string
95061     * @since PHP 5 >= 5.3.0
95062     **/
95063    function lastErrorMsg(){}
95064
95065    /**
95066     * Returns the row ID of the most recent INSERT into the database.
95067     *
95068     * @return int
95069     * @since PHP 5 >= 5.3.0
95070     **/
95071    function lastInsertRowID(){}
95072
95073    /**
95074     * Attempts to load an SQLite extension library.
95075     *
95076     * @param string $shared_library The name of the library to load. The
95077     *   library must be located in the directory specified in the configure
95078     *   option sqlite3.extension_dir.
95079     * @return bool
95080     * @since PHP 5 >= 5.3.0
95081     **/
95082    function loadExtension($shared_library){}
95083
95084    /**
95085     * Opens an SQLite 3 Database. If the build includes encryption, then it
95086     * will attempt to use the key.
95087     *
95088     * @param string $filename Path to the SQLite database.
95089     * @param int $flags Optional flags used to determine how to open the
95090     *   SQLite database. By default, open uses SQLITE3_OPEN_READWRITE |
95091     *   SQLITE3_OPEN_CREATE. SQLITE3_OPEN_READONLY: Open the database for
95092     *   reading only. SQLITE3_OPEN_READWRITE: Open the database for reading
95093     *   and writing. SQLITE3_OPEN_CREATE: Create the database if it does not
95094     *   exist.
95095     * @param string $encryption_key An optional encryption key used when
95096     *   encrypting and decrypting an SQLite database.
95097     * @return bool
95098     * @since PHP 5 >= 5.3.0
95099     **/
95100    function open($filename, $flags, $encryption_key){}
95101
95102    /**
95103     * Prepares an SQL statement for execution and returns an SQLite3Stmt
95104     * object.
95105     *
95106     * @param string $query The SQL query to prepare.
95107     * @return SQLite3Stmt
95108     * @since PHP 5 >= 5.3.0
95109     **/
95110    function prepare($query){}
95111
95112    /**
95113     * Executes an SQL query, returning an SQLite3Result object if the query
95114     * returns results.
95115     *
95116     * @param string $query The SQL query to execute.
95117     * @return SQLite3Result
95118     * @since PHP 5 >= 5.3.0
95119     **/
95120    function query($query){}
95121
95122    /**
95123     * Executes a query and returns a single result.
95124     *
95125     * @param string $query The SQL query to execute.
95126     * @param bool $entire_row By default, querySingle returns the value of
95127     *   the first column returned by the query. If entire_row is , then it
95128     *   returns an array of the entire first row.
95129     * @return mixed
95130     * @since PHP 5 >= 5.3.0
95131     **/
95132    function querySingle($query, $entire_row){}
95133
95134    /**
95135     * Returns the SQLite3 library version as a string constant and as a
95136     * number.
95137     *
95138     * @return array
95139     * @since PHP 5 >= 5.3.0
95140     **/
95141    function version(){}
95142
95143    /**
95144     * Instantiates an SQLite3 object and opens a connection to an SQLite 3
95145     * database. If the build includes encryption, then it will attempt to
95146     * use the key.
95147     *
95148     * @param string $filename Path to the SQLite database.
95149     * @param int $flags Optional flags used to determine how to open the
95150     *   SQLite database. By default, open uses SQLITE3_OPEN_READWRITE |
95151     *   SQLITE3_OPEN_CREATE. SQLITE3_OPEN_READONLY: Open the database for
95152     *   reading only. SQLITE3_OPEN_READWRITE: Open the database for reading
95153     *   and writing. SQLITE3_OPEN_CREATE: Create the database if it does not
95154     *   exist.
95155     * @param string $encryption_key An optional encryption key used when
95156     *   encrypting and decrypting an SQLite database.
95157     * @since PHP 5 >= 5.3.0
95158     **/
95159    function __construct($filename, $flags, $encryption_key){}
95160
95161}
95162/**
95163 * A class that handles result sets for the SQLite 3 extension.
95164 **/
95165class SQLite3Result {
95166    /**
95167     * Returns the name of the column specified by the {@link column_number}.
95168     *
95169     * @param int $column_number The numeric zero-based index of the
95170     *   column.
95171     * @return string
95172     * @since PHP 5 >= 5.3.0
95173     **/
95174    function columnName($column_number){}
95175
95176    /**
95177     * Returns the type of the column identified by {@link column_number}.
95178     *
95179     * @param int $column_number The numeric zero-based index of the
95180     *   column.
95181     * @return int
95182     * @since PHP 5 >= 5.3.0
95183     **/
95184    function columnType($column_number){}
95185
95186    /**
95187     * Fetches a result row as an associative or numerically indexed array or
95188     * both. By default, fetches as both.
95189     *
95190     * @param int $mode Controls how the next row will be returned to the
95191     *   caller. This value must be one of either SQLITE3_ASSOC, SQLITE3_NUM,
95192     *   or SQLITE3_BOTH. SQLITE3_ASSOC: returns an array indexed by column
95193     *   name as returned in the corresponding result set SQLITE3_NUM:
95194     *   returns an array indexed by column number as returned in the
95195     *   corresponding result set, starting at column 0 SQLITE3_BOTH: returns
95196     *   an array indexed by both column name and number as returned in the
95197     *   corresponding result set, starting at column 0
95198     * @return array
95199     * @since PHP 5 >= 5.3.0
95200     **/
95201    function fetchArray($mode){}
95202
95203    /**
95204     * Closes the result set.
95205     *
95206     * @return bool
95207     * @since PHP 5 >= 5.3.0
95208     **/
95209    function finalize(){}
95210
95211    /**
95212     * Returns the number of columns in the result set.
95213     *
95214     * @return int
95215     * @since PHP 5 >= 5.3.0
95216     **/
95217    function numColumns(){}
95218
95219    /**
95220     * Resets the result set back to the first row.
95221     *
95222     * @return bool
95223     * @since PHP 5 >= 5.3.0
95224     **/
95225    function reset(){}
95226
95227}
95228/**
95229 * A class that handles prepared statements for the SQLite 3 extension.
95230 **/
95231class SQLite3Stmt {
95232    /**
95233     * Binds a parameter to a statement variable.
95234     *
95235     * @param string $sql_param An string identifying the statement
95236     *   variable to which the parameter should be bound.
95237     * @param mixed $param The parameter to bind to a statement variable.
95238     * @param int $type The data type of the parameter to bind.
95239     *   SQLITE3_INTEGER: The value is a signed integer, stored in 1, 2, 3,
95240     *   4, 6, or 8 bytes depending on the magnitude of the value.
95241     *   SQLITE3_FLOAT: The value is a floating point value, stored as an
95242     *   8-byte IEEE floating point number. SQLITE3_TEXT: The value is a text
95243     *   string, stored using the database encoding (UTF-8, UTF-16BE or
95244     *   UTF-16-LE). SQLITE3_BLOB: The value is a blob of data, stored
95245     *   exactly as it was input. SQLITE3_NULL: The value is a NULL value.
95246     * @return bool
95247     * @since PHP 5 >= 5.3.0
95248     **/
95249    function bindParam($sql_param, &$param, $type){}
95250
95251    /**
95252     * Binds the value of a parameter to a statement variable.
95253     *
95254     * @param string $sql_param An string identifying the statement
95255     *   variable to which the value should be bound.
95256     * @param mixed $value The value to bind to a statement variable.
95257     * @param int $type The data type of the value to bind.
95258     *   SQLITE3_INTEGER: The value is a signed integer, stored in 1, 2, 3,
95259     *   4, 6, or 8 bytes depending on the magnitude of the value.
95260     *   SQLITE3_FLOAT: The value is a floating point value, stored as an
95261     *   8-byte IEEE floating point number. SQLITE3_TEXT: The value is a text
95262     *   string, stored using the database encoding (UTF-8, UTF-16BE or
95263     *   UTF-16-LE). SQLITE3_BLOB: The value is a blob of data, stored
95264     *   exactly as it was input. SQLITE3_NULL: The value is a NULL value.
95265     * @return bool
95266     * @since PHP 5 >= 5.3.0
95267     **/
95268    function bindValue($sql_param, $value, $type){}
95269
95270    /**
95271     * Clears all current bound parameters.
95272     *
95273     * @return bool
95274     * @since PHP 5 >= 5.3.0
95275     **/
95276    function clear(){}
95277
95278    /**
95279     * Closes the prepared statement.
95280     *
95281     * @return bool
95282     * @since PHP 5 >= 5.3.0
95283     **/
95284    function close(){}
95285
95286    /**
95287     * Executes a prepared statement and returns a result set object.
95288     *
95289     * @return SQLite3Result
95290     * @since PHP 5 >= 5.3.0
95291     **/
95292    function execute(){}
95293
95294    /**
95295     * Returns the number of parameters within the prepared statement.
95296     *
95297     * @return int
95298     * @since PHP 5 >= 5.3.0
95299     **/
95300    function paramCount(){}
95301
95302    /**
95303     * Resets the prepared statement to its state prior to execution. All
95304     * bindings remain intact after reset.
95305     *
95306     * @return bool
95307     * @since PHP 5 >= 5.3.0
95308     **/
95309    function reset(){}
95310
95311}
95312class SQLiteDatabase {
95313    /**
95314     * {@link sqlite_array_query} executes the given query and returns an
95315     * array of the entire result set. It is similar to calling {@link
95316     * sqlite_query} and then {@link sqlite_fetch_array} for each row in the
95317     * result set. {@link sqlite_array_query} is significantly faster than
95318     * the aforementioned.
95319     *
95320     * @param string $query The query to be executed. Data inside the query
95321     *   should be properly escaped.
95322     * @param int $result_type The SQLite Database resource; returned from
95323     *   {@link sqlite_open} when used procedurally. This parameter is not
95324     *   required when using the object-oriented method.
95325     * @param bool $decode_binary
95326     * @return array
95327     **/
95328    function arrayQuery($query, $result_type, $decode_binary){}
95329
95330    /**
95331     * Set the maximum time, in milliseconds, that SQLite will wait for a
95332     * {@link dbhandle} to become ready for use.
95333     *
95334     * @param int $milliseconds The SQLite Database resource; returned from
95335     *   {@link sqlite_open} when used procedurally. This parameter is not
95336     *   required when using the object-oriented method.
95337     * @return void
95338     **/
95339    function busyTimeout($milliseconds){}
95340
95341    /**
95342     * Returns the numbers of rows that were changed by the most recent SQL
95343     * statement executed against the {@link dbhandle} database handle.
95344     *
95345     * @return int
95346     **/
95347    function changes(){}
95348
95349    /**
95350     * {@link sqlite_create_aggregate} is similar to {@link
95351     * sqlite_create_function} except that it registers functions that can be
95352     * used to calculate a result aggregated across all the rows of a query.
95353     *
95354     * The key difference between this function and {@link
95355     * sqlite_create_function} is that two functions are required to manage
95356     * the aggregate; {@link step_func} is called for each row of the result
95357     * set. Your PHP function should accumulate the result and store it into
95358     * the aggregation context. Once all the rows have been processed, {@link
95359     * finalize_func} will be called and it should then take the data from
95360     * the aggregation context and return the result. Callback functions
95361     * should return a type understood by SQLite (i.e. scalar type).
95362     *
95363     * @param string $function_name The SQLite Database resource; returned
95364     *   from {@link sqlite_open} when used procedurally. This parameter is
95365     *   not required when using the object-oriented method.
95366     * @param callback $step_func The name of the function used in SQL
95367     *   statements.
95368     * @param callback $finalize_func Callback function called for each row
95369     *   of the result set.
95370     * @param int $num_args Callback function to aggregate the "stepped"
95371     *   data from each row.
95372     * @return void
95373     **/
95374    function createAggregate($function_name, $step_func, $finalize_func, $num_args){}
95375
95376    /**
95377     * {@link sqlite_create_function} allows you to register a PHP function
95378     * with SQLite as an UDF (User Defined Function), so that it can be
95379     * called from within your SQL statements.
95380     *
95381     * The UDF can be used in any SQL statement that can call functions, such
95382     * as SELECT and UPDATE statements and also in triggers.
95383     *
95384     * @param string $function_name The SQLite Database resource; returned
95385     *   from {@link sqlite_open} when used procedurally. This parameter is
95386     *   not required when using the object-oriented method.
95387     * @param callback $callback The name of the function used in SQL
95388     *   statements.
95389     * @param int $num_args Callback function to handle the defined SQL
95390     *   function.
95391     * @return void
95392     **/
95393    function createFunction($function_name, $callback, $num_args){}
95394
95395    /**
95396     * {@link sqlite_fetch_column_types} returns an array of column data
95397     * types from the specified {@link table_name} table.
95398     *
95399     * @param string $table_name The table name to query.
95400     * @param int $result_type The SQLite Database resource; returned from
95401     *   {@link sqlite_open} when used procedurally. This parameter is not
95402     *   required when using the object-oriented method.
95403     * @return array
95404     **/
95405    function fetchColumnTypes($table_name, $result_type){}
95406
95407    /**
95408     * Returns the error code from the last operation performed on {@link
95409     * dbhandle} (the database handle), or 0 when no error occurred. A human
95410     * readable description of the error code can be retrieved using {@link
95411     * sqlite_error_string}.
95412     *
95413     * @return int
95414     **/
95415    function lastError(){}
95416
95417    /**
95418     * Returns the rowid of the row that was most recently inserted into the
95419     * database {@link dbhandle}, if it was created as an auto-increment
95420     * field.
95421     *
95422     * @return int
95423     **/
95424    function lastInsertRowid(){}
95425
95426    /**
95427     * Executes an SQL statement given by the {@link query} against a given
95428     * database handle.
95429     *
95430     * @param string $query The SQLite Database resource; returned from
95431     *   {@link sqlite_open} when used procedurally. This parameter is not
95432     *   required when using the object-oriented method.
95433     * @param int $result_type The query to be executed. Data inside the
95434     *   query should be properly escaped.
95435     * @param string $error_msg
95436     * @return SQLiteResult
95437     **/
95438    function query($query, $result_type, &$error_msg){}
95439
95440    /**
95441     * Executes an SQL statement given by the {@link query} against a given
95442     * database handle (specified by the {@link dbhandle} parameter).
95443     *
95444     * @param string $query The SQLite Database resource; returned from
95445     *   {@link sqlite_open} when used procedurally. This parameter is not
95446     *   required when using the object-oriented method.
95447     * @param string $error_msg The query to be executed. Data inside the
95448     *   query should be properly escaped.
95449     * @return bool
95450     **/
95451    function queryExec($query, &$error_msg){}
95452
95453    /**
95454     * @param string $query
95455     * @param bool $first_row_only
95456     * @param bool $decode_binary
95457     * @return array
95458     **/
95459    function singleQuery($query, $first_row_only, $decode_binary){}
95460
95461    /**
95462     * {@link sqlite_unbuffered_query} is identical to {@link sqlite_query}
95463     * except that the result that is returned is a sequential forward-only
95464     * result set that can only be used to read each row, one after the
95465     * other.
95466     *
95467     * This function is ideal for generating things such as HTML tables where
95468     * you only need to process one row at a time and don't need to randomly
95469     * access the row data.
95470     *
95471     * @param string $query The SQLite Database resource; returned from
95472     *   {@link sqlite_open} when used procedurally. This parameter is not
95473     *   required when using the object-oriented method.
95474     * @param int $result_type The query to be executed. Data inside the
95475     *   query should be properly escaped.
95476     * @param string $error_msg
95477     * @return SQLiteUnbuffered
95478     **/
95479    function unbufferedQuery($query, $result_type, &$error_msg){}
95480
95481}
95482class SQLiteResult {
95483    /**
95484     * Fetches the value of a column named {@link index_or_name} (if it is a
95485     * string), or of the ordinal column numbered {@link index_or_name} (if
95486     * it is an integer) from the current row of the query result handle
95487     * {@link result}.
95488     *
95489     * @param mixed $index_or_name The SQLite result resource. This
95490     *   parameter is not required when using the object-oriented method.
95491     * @param bool $decode_binary The column index or name to fetch.
95492     * @return mixed
95493     **/
95494    function column($index_or_name, $decode_binary){}
95495
95496    /**
95497     * {@link sqlite_current} is identical to {@link sqlite_fetch_array}
95498     * except that it does not advance to the next row prior to returning the
95499     * data; it returns the data from the current position only.
95500     *
95501     * @param int $result_type The SQLite result resource. This parameter
95502     *   is not required when using the object-oriented method.
95503     * @param bool $decode_binary
95504     * @return array
95505     **/
95506    function current($result_type, $decode_binary){}
95507
95508    /**
95509     * Fetches the next row from the given {@link result} handle. If there
95510     * are no more rows, returns , otherwise returns an associative array
95511     * representing the row data.
95512     *
95513     * @param int $result_type The SQLite result resource. This parameter
95514     *   is not required when using the object-oriented method.
95515     * @param bool $decode_binary
95516     * @return array
95517     **/
95518    function fetch($result_type, $decode_binary){}
95519
95520    /**
95521     * {@link sqlite_fetch_all} returns an array of the entire result set
95522     * from the {@link result} resource. It is similar to calling {@link
95523     * sqlite_query} (or {@link sqlite_unbuffered_query}) and then {@link
95524     * sqlite_fetch_array} for each row in the result set.
95525     *
95526     * @param int $result_type The SQLite result resource. This parameter
95527     *   is not required when using the object-oriented method.
95528     * @param bool $decode_binary
95529     * @return array
95530     **/
95531    function fetchAll($result_type, $decode_binary){}
95532
95533    /**
95534     * @param string $class_name
95535     * @param array $ctor_params
95536     * @param bool $decode_binary
95537     * @return object
95538     **/
95539    function fetchObject($class_name, $ctor_params, $decode_binary){}
95540
95541    /**
95542     * {@link sqlite_fetch_single} is identical to {@link sqlite_fetch_array}
95543     * except that it returns the value of the first column of the rowset.
95544     *
95545     * This is the most optimal way to retrieve data when you are only
95546     * interested in the values from a single column of data.
95547     *
95548     * @param bool $decode_binary The SQLite result resource. This
95549     *   parameter is not required when using the object-oriented method.
95550     * @return string
95551     **/
95552    function fetchSingle($decode_binary){}
95553
95554    /**
95555     * Given the ordinal column number, {@link field_index}, {@link
95556     * sqlite_field_name} returns the name of that field in the result set
95557     * {@link result}.
95558     *
95559     * @param int $field_index The SQLite result resource. This parameter
95560     *   is not required when using the object-oriented method.
95561     * @return string
95562     **/
95563    function fieldName($field_index){}
95564
95565    /**
95566     * Find whether there are more previous rows from the given result
95567     * handle.
95568     *
95569     * @return bool
95570     **/
95571    function hasPrev(){}
95572
95573    /**
95574     * {@link sqlite_key} returns the current row index of the buffered
95575     * result set {@link result}.
95576     *
95577     * @return int
95578     **/
95579    function key(){}
95580
95581    /**
95582     * {@link sqlite_next} advances the result handle {@link result} to the
95583     * next row.
95584     *
95585     * @return bool
95586     **/
95587    function next(){}
95588
95589    /**
95590     * Returns the number of fields in the {@link result} set.
95591     *
95592     * @return int
95593     **/
95594    function numFields(){}
95595
95596    /**
95597     * Returns the number of rows in the buffered {@link result} set.
95598     *
95599     * @return int
95600     **/
95601    function numRows(){}
95602
95603    /**
95604     * {@link sqlite_prev} seeks back the {@link result} handle to the
95605     * previous row.
95606     *
95607     * @return bool
95608     **/
95609    function prev(){}
95610
95611    /**
95612     * {@link sqlite_rewind} seeks back to the first row in the given result
95613     * set.
95614     *
95615     * @return bool
95616     **/
95617    function rewind(){}
95618
95619    /**
95620     * {@link sqlite_seek} seeks to the row given by the parameter {@link
95621     * rownum}.
95622     *
95623     * @param int $rownum The SQLite result resource. This parameter is not
95624     *   required when using the object-oriented method.
95625     * @return bool
95626     **/
95627    function seek($rownum){}
95628
95629    /**
95630     * {@link sqlite_fetch_single} is identical to {@link sqlite_fetch_array}
95631     * except that it returns the value of the first column of the rowset.
95632     *
95633     * This is the most optimal way to retrieve data when you are only
95634     * interested in the values from a single column of data.
95635     *
95636     * @param bool $decode_binary The SQLite result resource. This
95637     *   parameter is not required when using the object-oriented method.
95638     * @return string
95639     **/
95640    function sqlite_fetch_string($decode_binary){}
95641
95642    /**
95643     * Finds whether more rows are available from the given result handle.
95644     *
95645     * @return bool
95646     **/
95647    function valid(){}
95648
95649}
95650/**
95651 * Created by typecasting to object.
95652 **/
95653class stdClass {
95654}
95655/**
95656 * Represents a connection between PHP and a Stomp compliant Message
95657 * Broker.
95658 **/
95659class Stomp {
95660    /**
95661     * Rolls back a transaction in progress.
95662     *
95663     * @param string $transaction_id The transaction to abort.
95664     * @param array $headers
95665     * @return bool
95666     * @since PECL stomp >= 0.1.0
95667     **/
95668    function abort($transaction_id, $headers){}
95669
95670    /**
95671     * Acknowledges consumption of a message from a subscription using client
95672     * acknowledgment.
95673     *
95674     * @param mixed $msg The message/messageId to be acknowledged.
95675     * @param array $headers
95676     * @return bool
95677     * @since PECL stomp >= 0.1.0
95678     **/
95679    function ack($msg, $headers){}
95680
95681    /**
95682     * Starts a transaction.
95683     *
95684     * @param string $transaction_id The transaction id.
95685     * @param array $headers
95686     * @return bool
95687     * @since PECL stomp >= 0.1.0
95688     **/
95689    function begin($transaction_id, $headers){}
95690
95691    /**
95692     * Commits a transaction in progress.
95693     *
95694     * @param string $transaction_id The transaction id.
95695     * @param array $headers
95696     * @return bool
95697     * @since PECL stomp >= 0.1.0
95698     **/
95699    function commit($transaction_id, $headers){}
95700
95701    /**
95702     * Gets the last stomp error.
95703     *
95704     * @return string
95705     * @since PECL stomp >= 0.1.0
95706     **/
95707    function error(){}
95708
95709    /**
95710     * Gets read timeout
95711     *
95712     * @return array
95713     * @since PECL stomp >= 0.3.0
95714     **/
95715    function getReadTimeout(){}
95716
95717    /**
95718     * Gets the current stomp session ID.
95719     *
95720     * @return string
95721     * @since PECL stomp >= 0.1.0
95722     **/
95723    function getSessionId(){}
95724
95725    /**
95726     * Indicates whether or not there is a frame ready to read.
95727     *
95728     * @return bool
95729     * @since PECL stomp >= 0.1.0
95730     **/
95731    function hasFrame(){}
95732
95733    /**
95734     * Reads the next frame. It is possible to instantiate an object of a
95735     * specific class, and pass parameters to that class's constructor.
95736     *
95737     * @param string $class_name The name of the class to instantiate. If
95738     *   not specified, a stompFrame object is returned.
95739     * @return stompframe
95740     * @since PECL stomp >= 0.1.0
95741     **/
95742    function readFrame($class_name){}
95743
95744    /**
95745     * Sends a message to the Message Broker.
95746     *
95747     * @param string $destination Where to send the message
95748     * @param mixed $msg Message to send.
95749     * @param array $headers
95750     * @return bool
95751     * @since PECL stomp >= 0.1.0
95752     **/
95753    function send($destination, $msg, $headers){}
95754
95755    /**
95756     * Sets read timeout.
95757     *
95758     * @param int $seconds The seconds part of the timeout to be set.
95759     * @param int $microseconds The microseconds part of the timeout to be
95760     *   set.
95761     * @return void
95762     * @since PECL stomp >= 0.3.0
95763     **/
95764    function setReadTimeout($seconds, $microseconds){}
95765
95766    /**
95767     * Registers to listen to a given destination.
95768     *
95769     * @param string $destination Destination to subscribe to.
95770     * @param array $headers
95771     * @return bool
95772     * @since PECL stomp >= 0.1.0
95773     **/
95774    function subscribe($destination, $headers){}
95775
95776    /**
95777     * Removes an existing subscription.
95778     *
95779     * @param string $destination Subscription to remove.
95780     * @param array $headers
95781     * @return bool
95782     * @since PECL stomp >= 0.1.0
95783     **/
95784    function unsubscribe($destination, $headers){}
95785
95786    /**
95787     * Opens a connection to a stomp compliant Message Broker.
95788     *
95789     * @param string $broker The broker URI
95790     * @param string $username The username.
95791     * @param string $password The password.
95792     * @since PECL stomp >= 0.1.0
95793     **/
95794    function __construct($broker, $username, $password){}
95795
95796    /**
95797     * Closes a previously opened connection.
95798     *
95799     * @return bool
95800     * @since PECL stomp >= 0.1.0
95801     **/
95802    function __destruct(){}
95803
95804}
95805/**
95806 * Represents an error raised by the stomp extension. See for more
95807 * information about Exceptions in PHP.
95808 **/
95809class StompException extends Exception {
95810}
95811/**
95812 * Represents a message which was sent or received from a Stomp compliant
95813 * Message Broker.
95814 **/
95815class StompFrame {
95816    /**
95817     * Constructor.
95818     *
95819     * @param string $command Frame command
95820     * @param array $headers Frame headers ().
95821     * @param string $body Frame body.
95822     * @since PECL stomp >= 0.1.0
95823     **/
95824    function __construct($command, $headers, $body){}
95825
95826}
95827/**
95828 * Allows you to implement your own protocol handlers and streams for use
95829 * with all the other filesystem functions (such as , etc.).
95830 *
95831 * An instance of this class is initialized as soon as a stream function
95832 * tries to access the protocol it is associated with.
95833 **/
95834class streamWrapper {
95835    /**
95836     * This method is called in response to {@link closedir}.
95837     *
95838     * Any resources which were locked, or allocated, during opening and use
95839     * of the directory stream should be released.
95840     *
95841     * @return bool
95842     * @since PHP 4 >= 4.3.2, PHP 5
95843     **/
95844    function dir_closedir(){}
95845
95846    /**
95847     * This method is called in response to {@link opendir}.
95848     *
95849     * @param string $path Specifies the URL that was passed to {@link
95850     *   opendir}.
95851     * @param int $options Whether or not to enforce safe_mode (0x04).
95852     * @return bool
95853     * @since PHP 4 >= 4.3.2, PHP 5
95854     **/
95855    function dir_opendir($path, $options){}
95856
95857    /**
95858     * This method is called in response to {@link readdir}.
95859     *
95860     * @return string
95861     * @since PHP 4 >= 4.3.2, PHP 5
95862     **/
95863    function dir_readdir(){}
95864
95865    /**
95866     * This method is called in response to {@link rewinddir}.
95867     *
95868     * Should reset the output generated by streamWrapper::dir_readdir. i.e.:
95869     * The next call to streamWrapper::dir_readdir should return the first
95870     * entry in the location returned by streamWrapper::dir_opendir.
95871     *
95872     * @return bool
95873     * @since PHP 4 >= 4.3.2, PHP 5
95874     **/
95875    function dir_rewinddir(){}
95876
95877    /**
95878     * This method is called in response to {@link mkdir}.
95879     *
95880     * @param string $path Directory which should be created.
95881     * @param int $mode The value passed to {@link mkdir}.
95882     * @param int $options A bitwise mask of values, such as
95883     *   STREAM_MKDIR_RECURSIVE.
95884     * @return bool
95885     * @since PHP 5
95886     **/
95887    function mkdir($path, $mode, $options){}
95888
95889    /**
95890     * This method is called in response to {@link rename}.
95891     *
95892     * Should attempt to rename {@link path_from} to {@link path_to}
95893     *
95894     * @param string $path_from The URL to the current file.
95895     * @param string $path_to The URL which the {@link path_from} should be
95896     *   renamed to.
95897     * @return bool
95898     * @since PHP 5
95899     **/
95900    function rename($path_from, $path_to){}
95901
95902    /**
95903     * This method is called in response to {@link rmdir}.
95904     *
95905     * @param string $path The directory URL which should be removed.
95906     * @param int $options A bitwise mask of values, such as
95907     *   STREAM_MKDIR_RECURSIVE.
95908     * @return bool
95909     * @since PHP 5
95910     **/
95911    function rmdir($path, $options){}
95912
95913    /**
95914     * This method is called in response to {@link stream_select}.
95915     *
95916     * @param int $cast_as Can be STREAM_CAST_FOR_SELECT when {@link
95917     *   stream_select} is calling {@link stream_cast} or
95918     *   STREAM_CAST_AS_STREAM when {@link stream_cast} is called for other
95919     *   uses.
95920     * @return resource
95921     * @since PHP 5 >= 5.3.0
95922     **/
95923    function stream_cast($cast_as){}
95924
95925    /**
95926     * This method is called in response to {@link fclose}.
95927     *
95928     * All resources that were locked, or allocated, by the wrapper should be
95929     * released.
95930     *
95931     * @return void
95932     * @since PHP 4 >= 4.3.2, PHP 5
95933     **/
95934    function stream_close(){}
95935
95936    /**
95937     * This method is called in response to {@link feof}.
95938     *
95939     * @return bool
95940     * @since PHP 4 >= 4.3.2, PHP 5
95941     **/
95942    function stream_eof(){}
95943
95944    /**
95945     * This method is called in response to {@link fflush}.
95946     *
95947     * If you have cached data in your stream but not yet stored it into the
95948     * underlying storage, you should do so now.
95949     *
95950     * @return bool
95951     * @since PHP 4 >= 4.3.2, PHP 5
95952     **/
95953    function stream_flush(){}
95954
95955    /**
95956     * This method is called in response to {@link flock}, when {@link
95957     * file_put_contents} (when {@link flags} contains LOCK_EX), {@link
95958     * stream_set_blocking} and when closing the stream (LOCK_UN).
95959     *
95960     * @param mode $operation {@link operation} is one of the following:
95961     *   LOCK_SH to acquire a shared lock (reader). LOCK_EX to acquire an
95962     *   exclusive lock (writer). LOCK_UN to release a lock (shared or
95963     *   exclusive). LOCK_NB if you don't want {@link flock} to block while
95964     *   locking. (not supported on Windows)
95965     * @return bool
95966     * @since PHP 5
95967     **/
95968    function stream_lock($operation){}
95969
95970    /**
95971     * This method is called immediately after the wrapper is initialized
95972     * (f.e. by {@link fopen} and {@link file_get_contents}).
95973     *
95974     * @param string $path Specifies the URL that was passed to the
95975     *   original function.
95976     * @param string $mode The mode used to open the file, as detailed for
95977     *   {@link fopen}.
95978     * @param int $options Holds additional flags set by the streams API.
95979     *   It can hold one or more of the following values OR'd together. Flag
95980     *   Description STREAM_USE_PATH If {@link path} is relative, search for
95981     *   the resource using the include_path. STREAM_REPORT_ERRORS If this
95982     *   flag is set, you are responsible for raising errors using {@link
95983     *   trigger_error} during opening of the stream. If this flag is not
95984     *   set, you should not raise any errors.
95985     * @param string $opened_path If the {@link path} is opened
95986     *   successfully, and STREAM_USE_PATH is set in {@link options}, {@link
95987     *   opened_path} should be set to the full path of the file/resource
95988     *   that was actually opened.
95989     * @return bool
95990     * @since PHP 4 >= 4.3.2, PHP 5
95991     **/
95992    function stream_open($path, $mode, $options, &$opened_path){}
95993
95994    /**
95995     * This method is called in response to {@link fread} and {@link fgets}.
95996     *
95997     * @param int $count How many bytes of data from the current position
95998     *   should be returned.
95999     * @return string
96000     * @since PHP 4 >= 4.3.2, PHP 5
96001     **/
96002    function stream_read($count){}
96003
96004    /**
96005     * This method is called in response to {@link fseek}.
96006     *
96007     * The read/write position of the stream should be updated according to
96008     * the {@link offset} and {@link whence}.
96009     *
96010     * @param int $offset The stream offset to seek to.
96011     * @param int $whence Possible values: SEEK_SET - Set position equal to
96012     *   {@link offset} bytes. SEEK_CUR - Set position to current location
96013     *   plus {@link offset}. SEEK_END - Set position to end-of-file plus
96014     *   {@link offset}.
96015     * @return bool
96016     * @since PHP 4 >= 4.3.2, PHP 5
96017     **/
96018    function stream_seek($offset, $whence){}
96019
96020    /**
96021     * This method is called to set options on the stream.
96022     *
96023     * @param int $option One of: STREAM_OPTION_BLOCKING (The method was
96024     *   called in response to {@link stream_set_blocking})
96025     *   STREAM_OPTION_READ_TIMEOUT (The method was called in response to
96026     *   {@link stream_set_timeout}) STREAM_OPTION_WRITE_BUFFER (The method
96027     *   was called in response to {@link stream_set_write_buffer})
96028     * @param int $arg1 If {@link option} is STREAM_OPTION_BLOCKING:
96029     *   requested blocking mode (1 meaning block 0 not blocking).
96030     *   STREAM_OPTION_READ_TIMEOUT: the timeout in seconds.
96031     *   STREAM_OPTION_WRITE_BUFFER: buffer mode (STREAM_BUFFER_NONE or
96032     *   STREAM_BUFFER_FULL).
96033     * @param int $arg2 If {@link option} is STREAM_OPTION_BLOCKING: This
96034     *   option is not set. STREAM_OPTION_READ_TIMEOUT: the timeout in
96035     *   microseconds. STREAM_OPTION_WRITE_BUFFER: the requested buffer size.
96036     * @return bool
96037     * @since PHP 5 >= 5.3.0
96038     **/
96039    function stream_set_option($option, $arg1, $arg2){}
96040
96041    /**
96042     * This method is called in response to {@link fstat}.
96043     *
96044     * @return array
96045     * @since PHP 4 >= 4.3.2, PHP 5
96046     **/
96047    function stream_stat(){}
96048
96049    /**
96050     * This method is called in response to {@link ftell}.
96051     *
96052     * @return int
96053     * @since PHP 4 >= 4.3.2, PHP 5
96054     **/
96055    function stream_tell(){}
96056
96057    /**
96058     * This method is called in response to {@link fwrite}.
96059     *
96060     * @param string $data Should be stored into the underlying stream.
96061     * @return int
96062     * @since PHP 4 >= 4.3.2, PHP 5
96063     **/
96064    function stream_write($data){}
96065
96066    /**
96067     * This method is called in response to {@link unlink}.
96068     *
96069     * @param string $path The file URL which should be deleted.
96070     * @return bool
96071     * @since PHP 5
96072     **/
96073    function unlink($path){}
96074
96075    /**
96076     * This method is called in response to all {@link stat} related
96077     * functions, such as: {@link chmod} (only when safe_mode is enabled)
96078     * {@link copy} {@link fileperms} {@link fileinode} {@link filesize}
96079     * {@link fileowner} {@link filegroup} {@link fileatime} {@link
96080     * filemtime} {@link filectime} {@link filetype} {@link is_writable}
96081     * {@link is_readable} {@link is_executable} {@link is_file} {@link
96082     * is_dir} {@link is_link} {@link file_exists} {@link lstat} {@link stat}
96083     * SplFileInfo::getPerms SplFileInfo::getInode SplFileInfo::getSize
96084     * SplFileInfo::getOwner SplFileInfo::getGroup SplFileInfo::getATime
96085     * SplFileInfo::getMTime SplFileInfo::getCTime SplFileInfo::getType
96086     * SplFileInfo::isWritable SplFileInfo::isReadable
96087     * SplFileInfo::isExecutable SplFileInfo::isFile SplFileInfo::isDir
96088     * SplFileInfo::isLink RecursiveDirectoryIterator::hasChildren
96089     *
96090     * @param string $path The file path or URL to stat. Note that in the
96091     *   case of a URL, it must be a :// delimited URL. Other URL forms are
96092     *   not supported.
96093     * @param int $flags Holds additional flags set by the streams API. It
96094     *   can hold one or more of the following values OR'd together. Flag
96095     *   Description STREAM_URL_STAT_LINK For resources with the ability to
96096     *   link to other resource (such as an HTTP Location: forward, or a
96097     *   filesystem symlink). This flag specified that only information about
96098     *   the link itself should be returned, not the resource pointed to by
96099     *   the link. This flag is set in response to calls to {@link lstat},
96100     *   {@link is_link}, or {@link filetype}. STREAM_URL_STAT_QUIET If this
96101     *   flag is set, your wrapper should not raise any errors. If this flag
96102     *   is not set, you are responsible for reporting errors using the
96103     *   {@link trigger_error} function during stating of the path.
96104     * @return array
96105     * @since PHP 4 >= 4.3.2, PHP 5
96106     **/
96107    function url_stat($path, $flags){}
96108
96109    /**
96110     * Called when opening the stream wrapper, right before
96111     * streamWrapper::stream_open.
96112     *
96113     * @since PHP 4 >= 4.3.2, PHP 5
96114     **/
96115    function __construct(){}
96116
96117}
96118/**
96119 * SWFAction.
96120 **/
96121class SWFAction {
96122    /**
96123     * Creates a new SWFAction and compiles the given {@link script} in it.
96124     *
96125     * @param string $script An ActionScript snippet to associate with the
96126     *   SWFAction. See for more details.
96127     * @return SWFAction
96128     * @since PHP 5
96129     **/
96130    function __construct($script){}
96131
96132}
96133/**
96134 * SWFBitmap.
96135 **/
96136class SWFBitmap {
96137    /**
96138     * Returns the bitmap's height.
96139     *
96140     * @return float
96141     * @since PHP 5
96142     **/
96143    function getHeight(){}
96144
96145    /**
96146     * Returns the bitmap's width.
96147     *
96148     * @return float
96149     * @since PHP 5
96150     **/
96151    function getWidth(){}
96152
96153    /**
96154     * Creates the new SWFBitmap object from the given {@link file}.
96155     *
96156     * @param mixed $file You can't import png images directly, though-
96157     *   have to use the png2dbl utility to make a dbl ("define bits
96158     *   lossless") file from the png. The reason for this is that I don't
96159     *   want a dependency on the png library in ming- autoconf should solve
96160     *   this, but that's not set up yet.
96161     * @param mixed $alphafile An MSK file to be used as an alpha mask for
96162     *   a JPEG image.
96163     * @return SWFBitmap
96164     * @since PHP 5
96165     **/
96166    function __construct($file, $alphafile){}
96167
96168}
96169/**
96170 * SWFButton.
96171 **/
96172class SWFButton {
96173    /**
96174     * Adds the given {@link action} to the button for the given conditions.
96175     *
96176     * @param SWFAction $action An SWFAction, returned by .
96177     * @param int $flags The following {@link flags} are valid:
96178     *   SWFBUTTON_MOUSEOVER, SWFBUTTON_MOUSEOUT, SWFBUTTON_MOUSEUP,
96179     *   SWFBUTTON_MOUSEUPOUTSIDE, SWFBUTTON_MOUSEDOWN, SWFBUTTON_DRAGOUT and
96180     *   SWFBUTTON_DRAGOVER.
96181     * @return void
96182     * @since PHP 5
96183     **/
96184    function addAction($action, $flags){}
96185
96186    /**
96187     * @param SWFSound $sound
96188     * @param int $flags
96189     * @return SWFSoundInstance
96190     * @since PHP 5
96191     **/
96192    function addASound($sound, $flags){}
96193
96194    /**
96195     * Adds the given {@link shape} to the button.
96196     *
96197     * @param SWFShape $shape An SWFShape instance
96198     * @param int $flags The following {@link flags} are valid:
96199     *   SWFBUTTON_UP, SWFBUTTON_OVER, SWFBUTTON_DOWN and SWFBUTTON_HIT.
96200     *   SWFBUTTON_HIT isn't ever displayed, it defines the hit region for
96201     *   the button. That is, everywhere the hit shape would be drawn is
96202     *   considered a "touchable" part of the button.
96203     * @return void
96204     * @since PHP 5
96205     **/
96206    function addShape($shape, $flags){}
96207
96208    /**
96209     * Sets the action to be performed when the button is clicked.
96210     *
96211     * This is a shortcut for called with the SWFBUTTON_MOUSEUP flag.
96212     *
96213     * @param SWFAction $action An SWFAction, returned by .
96214     * @return void
96215     * @since PHP 5
96216     **/
96217    function setAction($action){}
96218
96219    /**
96220     * {@link swfbutton->setdown} alias for addShape(shape, SWFBUTTON_DOWN).
96221     *
96222     * @param SWFShape $shape
96223     * @return void
96224     * @since PHP 5
96225     **/
96226    function setDown($shape){}
96227
96228    /**
96229     * {@link swfbutton->sethit} alias for addShape(shape, SWFBUTTON_HIT).
96230     *
96231     * @param SWFShape $shape
96232     * @return void
96233     * @since PHP 5
96234     **/
96235    function setHit($shape){}
96236
96237    /**
96238     * @param int $flag This parameter can be used for a slight different
96239     *   behavior of buttons. You can set it to 0 (off) or 1 (on).
96240     * @return void
96241     * @since PHP 5
96242     **/
96243    function setMenu($flag){}
96244
96245    /**
96246     * {@link swfbutton->setover} alias for addShape(shape, SWFBUTTON_OVER).
96247     *
96248     * @param SWFShape $shape
96249     * @return void
96250     * @since PHP 5
96251     **/
96252    function setOver($shape){}
96253
96254    /**
96255     * {@link swfbutton->setup} alias for addShape(shape, SWFBUTTON_UP).
96256     *
96257     * @param SWFShape $shape
96258     * @return void
96259     * @since PHP 5
96260     **/
96261    function setUp($shape){}
96262
96263    /**
96264     * Creates a new Button.
96265     *
96266     * @return SWFButton
96267     * @since PHP 5
96268     **/
96269    function __construct(){}
96270
96271}
96272/**
96273 * SWFDisplayItem.
96274 **/
96275class SWFDisplayItem {
96276    /**
96277     * @param SWFAction $action An SWFAction, returned by .
96278     * @param int $flags
96279     * @return void
96280     * @since PHP 5
96281     **/
96282    function addAction($action, $flags){}
96283
96284    /**
96285     * {@link swfdisplayitem->addcolor} adds the color to this item's color
96286     * transform. The color is given in its RGB form.
96287     *
96288     * @param int $red
96289     * @param int $green
96290     * @param int $blue
96291     * @param int $a
96292     * @return void
96293     * @since PHP 5
96294     **/
96295    function addColor($red, $green, $blue, $a){}
96296
96297    /**
96298     * @return void
96299     * @since PHP 5
96300     **/
96301    function endMask(){}
96302
96303    /**
96304     * @return float
96305     * @since PHP 5
96306     **/
96307    function getRot(){}
96308
96309    /**
96310     * @return float
96311     * @since PHP 5
96312     **/
96313    function getX(){}
96314
96315    /**
96316     * @return float
96317     * @since PHP 5
96318     **/
96319    function getXScale(){}
96320
96321    /**
96322     * @return float
96323     * @since PHP 5
96324     **/
96325    function getXSkew(){}
96326
96327    /**
96328     * @return float
96329     * @since PHP 5
96330     **/
96331    function getY(){}
96332
96333    /**
96334     * @return float
96335     * @since PHP 5
96336     **/
96337    function getYScale(){}
96338
96339    /**
96340     * @return float
96341     * @since PHP 5
96342     **/
96343    function getYSkew(){}
96344
96345    /**
96346     * {@link swfdisplayitem->move} moves the current object by ({@link
96347     * dx},{@link dy}) from its current position.
96348     *
96349     * @param float $dx
96350     * @param float $dy
96351     * @return void
96352     * @since PHP 5
96353     **/
96354    function move($dx, $dy){}
96355
96356    /**
96357     * {@link swfdisplayitem->moveto} moves the current object to ({@link
96358     * x},{@link y}) in global coordinates.
96359     *
96360     * @param float $x
96361     * @param float $y
96362     * @return void
96363     * @since PHP 5
96364     **/
96365    function moveTo($x, $y){}
96366
96367    /**
96368     * {@link swfdisplayitem->multcolor} multiplies the item's color
96369     * transform by the given values.
96370     *
96371     * @param float $red Value of red component
96372     * @param float $green Value of green component
96373     * @param float $blue Value of blue component
96374     * @param float $a Value of alpha component
96375     * @return void
96376     * @since PHP 5
96377     **/
96378    function multColor($red, $green, $blue, $a){}
96379
96380    /**
96381     * {@link swfdisplayitem->remove} removes this object from the movie's
96382     * display list.
96383     *
96384     * @return void
96385     * @since PHP 5
96386     **/
96387    function remove(){}
96388
96389    /**
96390     * {@link swfdisplayitem->rotate} rotates the current object by {@link
96391     * angle} degrees from its current rotation.
96392     *
96393     * @param float $angle
96394     * @return void
96395     * @since PHP 5
96396     **/
96397    function rotate($angle){}
96398
96399    /**
96400     * {@link swfdisplayitem->rotateto} set the current object rotation to
96401     * {@link angle} degrees in global coordinates.
96402     *
96403     * @param float $angle
96404     * @return void
96405     * @since PHP 5
96406     **/
96407    function rotateTo($angle){}
96408
96409    /**
96410     * {@link swfdisplayitem->scale} scales the current object by ({@link
96411     * dx},{@link dy}) from its current size.
96412     *
96413     * @param float $dx
96414     * @param float $dy
96415     * @return void
96416     * @since PHP 5
96417     **/
96418    function scale($dx, $dy){}
96419
96420    /**
96421     * {@link swfdisplayitem->scaleto} scales the current object to ({@link
96422     * x},{@link y}) in global coordinates.
96423     *
96424     * @param float $x
96425     * @param float $y
96426     * @return void
96427     * @since PHP 5
96428     **/
96429    function scaleTo($x, $y){}
96430
96431    /**
96432     * {@link swfdisplayitem->setdepth} sets the object's z-order to {@link
96433     * depth}. Depth defaults to the order in which instances are created (by
96434     * adding a shape/text to a movie)- newer ones are on top of older ones.
96435     * If two objects are given the same depth, only the later-defined one
96436     * can be moved.
96437     *
96438     * @param int $depth
96439     * @return void
96440     * @since PHP 5
96441     **/
96442    function setDepth($depth){}
96443
96444    /**
96445     * @param int $level
96446     * @return void
96447     * @since PHP 5
96448     **/
96449    function setMaskLevel($level){}
96450
96451    /**
96452     * @param float $a
96453     * @param float $b
96454     * @param float $c
96455     * @param float $d
96456     * @param float $x
96457     * @param float $y
96458     * @return void
96459     * @since PHP 5
96460     **/
96461    function setMatrix($a, $b, $c, $d, $x, $y){}
96462
96463    /**
96464     * {@link swfdisplayitem->setname} sets the object's name to {@link
96465     * name}, for targetting with action script. Only useful on sprites.
96466     *
96467     * @param string $name
96468     * @return void
96469     * @since PHP 5
96470     **/
96471    function setName($name){}
96472
96473    /**
96474     * {@link swfdisplayitem->setratio} sets the object's ratio to {@link
96475     * ratio}. Obviously only useful for morphs.
96476     *
96477     * @param float $ratio
96478     * @return void
96479     * @since PHP 5
96480     **/
96481    function setRatio($ratio){}
96482
96483    /**
96484     * {@link swfdisplayitem->skewx} adds {@link ddegrees} to current x-skew.
96485     *
96486     * @param float $ddegrees
96487     * @return void
96488     * @since PHP 5
96489     **/
96490    function skewX($ddegrees){}
96491
96492    /**
96493     * {@link swfdisplayitem->skewxto} sets the x-skew to {@link degrees}.
96494     * For {@link degrees} is 1.0, it means a 45-degree forward slant. More
96495     * is more forward, less is more backward.
96496     *
96497     * @param float $degrees
96498     * @return void
96499     * @since PHP 5
96500     **/
96501    function skewXTo($degrees){}
96502
96503    /**
96504     * {@link swfdisplayitem->skewy} adds {@link ddegrees} to current y-skew.
96505     *
96506     * @param float $ddegrees
96507     * @return void
96508     * @since PHP 5
96509     **/
96510    function skewY($ddegrees){}
96511
96512    /**
96513     * {@link swfdisplayitem->skewyto} sets the y-skew to {@link degrees}.
96514     * For {@link degrees} is 1.0, it means a 45-degree forward slant. More
96515     * is more upward, less is more downward.
96516     *
96517     * @param float $degrees
96518     * @return void
96519     * @since PHP 5
96520     **/
96521    function skewYTo($degrees){}
96522
96523}
96524/**
96525 * The object allows you to transform (scale, skew, rotate) bitmap and
96526 * gradient fills.
96527 *
96528 * objects are created by the method.
96529 **/
96530class SWFFill {
96531    /**
96532     * Moves the fill origin to the given global coordinates.
96533     *
96534     * @param float $x X-coordinate
96535     * @param float $y Y-coordinate
96536     * @return void
96537     * @since PHP 5
96538     **/
96539    function moveTo($x, $y){}
96540
96541    /**
96542     * Sets the fill rotation to the given {@link angle}.
96543     *
96544     * @param float $angle The rotation angle, in degrees.
96545     * @return void
96546     * @since PHP 5
96547     **/
96548    function rotateTo($angle){}
96549
96550    /**
96551     * Sets the fill scale to the given coordinates.
96552     *
96553     * @param float $x X-coordinate
96554     * @param float $y Y-coordinate
96555     * @return void
96556     * @since PHP 5
96557     **/
96558    function scaleTo($x, $y){}
96559
96560    /**
96561     * Sets the fill x-skew to {@link x}.
96562     *
96563     * @param float $x When {@link x} is 1.0, it is a 45-degree forward
96564     *   slant. More is more forward, less is more backward.
96565     * @return void
96566     * @since PHP 5
96567     **/
96568    function skewXTo($x){}
96569
96570    /**
96571     * Sets the fill y-skew to {@link y}.
96572     *
96573     * @param float $y When {@link y} is 1.0, it is a 45-degree upward
96574     *   slant. More is more upward, less is more downward.
96575     * @return void
96576     * @since PHP 5
96577     **/
96578    function skewYTo($y){}
96579
96580}
96581/**
96582 * The object represent a reference to the font definition, for us with
96583 * and .
96584 **/
96585class SWFFont {
96586    /**
96587     * @return float
96588     * @since PHP 5
96589     **/
96590    function getAscent(){}
96591
96592    /**
96593     * @return float
96594     * @since PHP 5
96595     **/
96596    function getDescent(){}
96597
96598    /**
96599     * @return float
96600     * @since PHP 5
96601     **/
96602    function getLeading(){}
96603
96604    /**
96605     * @param int $code
96606     * @return string
96607     * @since PHP 5
96608     **/
96609    function getShape($code){}
96610
96611    /**
96612     * @param string $string
96613     * @return float
96614     * @since PHP 5
96615     **/
96616    function getUTF8Width($string){}
96617
96618    /**
96619     * {@link swffont->getwidth} returns the string {@link string}'s width,
96620     * using font's default scaling. You'll probably want to use the {@link
96621     * swftext} version of this method which uses the text object's scale.
96622     *
96623     * @param string $string
96624     * @return float
96625     * @since PHP 5
96626     **/
96627    function getWidth($string){}
96628
96629    /**
96630     * If {@link filename} is the name of an FDB file (i.e., it ends in
96631     * ".fdb"), load the font definition found in said file. Otherwise,
96632     * create a browser-defined font reference.
96633     *
96634     * FDB ("font definition block") is a very simple wrapper for the SWF
96635     * DefineFont2 block which contains a full description of a font. One may
96636     * create FDB files from SWT Generator template files with the included
96637     * makefdb utility- look in the util directory off the main ming
96638     * distribution directory.
96639     *
96640     * Browser-defined fonts don't contain any information about the font
96641     * other than its name. It is assumed that the font definition will be
96642     * provided by the movie player. The fonts _serif, _sans, and _typewriter
96643     * should always be available. For example:
96644     *
96645     * <?php $f = newSWFFont("_sans"); ?>
96646     *
96647     * will give you the standard sans-serif font, probably the same as what
96648     * you'd get with <font name="sans-serif"> in HTML.
96649     *
96650     * @param string $filename
96651     * @return SWFFont
96652     * @since PHP 5
96653     **/
96654    function __construct($filename){}
96655
96656}
96657/**
96658 * SWFFontChar.
96659 **/
96660class SWFFontChar {
96661    /**
96662     * @param string $char
96663     * @return void
96664     * @since PHP 5
96665     **/
96666    function addChars($char){}
96667
96668    /**
96669     * @param string $char
96670     * @return void
96671     * @since PHP 5
96672     **/
96673    function addUTF8Chars($char){}
96674
96675}
96676/**
96677 * SWFGradient.
96678 **/
96679class SWFGradient {
96680    /**
96681     * {@link swfgradient->addentry} adds an entry to the gradient list.
96682     * {@link ratio} is a number between 0 and 1 indicating where in the
96683     * gradient this color appears. Thou shalt add entries in order of
96684     * increasing ratio.
96685     *
96686     * {@link red}, {@link green}, {@link blue} is a color (RGB mode).
96687     *
96688     * @param float $ratio
96689     * @param int $red
96690     * @param int $green
96691     * @param int $blue
96692     * @param int $alpha
96693     * @return void
96694     * @since PHP 5
96695     **/
96696    function addEntry($ratio, $red, $green, $blue, $alpha){}
96697
96698    /**
96699     * {@link swfgradient} creates a new SWFGradient object.
96700     *
96701     * This simple example will draw a big black-to-white gradient as
96702     * background, and a reddish disc in its center. {@link swfgradient}
96703     * example
96704     *
96705     * <?php
96706     *
96707     * $m = new SWFMovie(); $m->setDimension(320, 240);
96708     *
96709     * $s = new SWFShape();
96710     *
96711     * // first gradient- black to white $g = new SWFGradient();
96712     * $g->addEntry(0.0, 0, 0, 0); $g->addEntry(1.0, 0xff, 0xff, 0xff);
96713     *
96714     * $f = $s->addFill($g, SWFFILL_LINEAR_GRADIENT); $f->scaleTo(0.01);
96715     * $f->moveTo(160, 120); $s->setRightFill($f); $s->drawLine(320, 0);
96716     * $s->drawLine(0, 240); $s->drawLine(-320, 0); $s->drawLine(0, -240);
96717     *
96718     * $m->add($s);
96719     *
96720     * $s = new SWFShape();
96721     *
96722     * // second gradient- radial gradient from red to transparent $g = new
96723     * SWFGradient(); $g->addEntry(0.0, 0xff, 0, 0, 0xff); $g->addEntry(1.0,
96724     * 0xff, 0, 0, 0);
96725     *
96726     * $f = $s->addFill($g, SWFFILL_RADIAL_GRADIENT); $f->scaleTo(0.005);
96727     * $f->moveTo(160, 120); $s->setRightFill($f); $s->drawLine(320, 0);
96728     * $s->drawLine(0, 240); $s->drawLine(-320, 0); $s->drawLine(0, -240);
96729     *
96730     * $m->add($s);
96731     *
96732     * header('Content-type: application/x-shockwave-flash'); $m->output();
96733     * ?>
96734     *
96735     * @return SWFGradient
96736     * @since PHP 5
96737     **/
96738    function __construct(){}
96739
96740}
96741/**
96742 * The methods here are sort of weird. It would make more sense to just
96743 * have newSWFMorph(shape1, shape2);, but as things are now, shape2 needs
96744 * to know that it's the second part of a morph. (This, because it starts
96745 * writing its output as soon as it gets drawing commands- if it kept its
96746 * own description of its shapes and wrote on completion this and some
96747 * other things would be much easier.)
96748 **/
96749class SWFMorph {
96750    /**
96751     * Gets the morph's starting shape.
96752     *
96753     * @return SWFShape
96754     * @since PHP 5
96755     **/
96756    function getShape1(){}
96757
96758    /**
96759     * Gets the morph's ending shape.
96760     *
96761     * @return SWFShape
96762     * @since PHP 5
96763     **/
96764    function getShape2(){}
96765
96766    /**
96767     * Creates a new SWFMorph object.
96768     *
96769     * Also called a "shape tween". This thing lets you make those tacky
96770     * twisting things that make your computer choke. Oh, joy!
96771     *
96772     * @return SWFMorph
96773     * @since PHP 5
96774     **/
96775    function __construct(){}
96776
96777}
96778/**
96779 * is a movie object representing an SWF movie.
96780 **/
96781class SWFMovie {
96782    /**
96783     * Adds an SWF object {@link instance} to the current movie.
96784     *
96785     * @param object $instance Any type of object instance, like , , .
96786     * @return mixed
96787     * @since PHP 5
96788     **/
96789    function add($instance){}
96790
96791    /**
96792     * @param SWFCharacter $char
96793     * @param string $name
96794     * @return void
96795     * @since PHP 5
96796     **/
96797    function addExport($char, $name){}
96798
96799    /**
96800     * @param SWFFont $font
96801     * @return mixed
96802     * @since PHP 5
96803     **/
96804    function addFont($font){}
96805
96806    /**
96807     * @param string $libswf
96808     * @param string $name
96809     * @return SWFSprite
96810     * @since PHP 5
96811     **/
96812    function importChar($libswf, $name){}
96813
96814    /**
96815     * @param string $libswf
96816     * @param string $name
96817     * @return SWFFontChar
96818     * @since PHP 5
96819     **/
96820    function importFont($libswf, $name){}
96821
96822    /**
96823     * @param string $label
96824     * @return void
96825     * @since PHP 5
96826     **/
96827    function labelFrame($label){}
96828
96829    /**
96830     * Moves to the next frame of the animation.
96831     *
96832     * @return void
96833     * @since PHP 5
96834     **/
96835    function nextFrame(){}
96836
96837    /**
96838     * Dumps the SWFMovie.
96839     *
96840     * Don't forget to send the Content-Type HTTP header file before using
96841     * this function, in order to display the movie in a browser.
96842     *
96843     * @param int $compression The compression level can be a value between
96844     *   0 and 9, defining the SWF compression similar to gzip compression.
96845     *   This parameter is only available as of Flash MX (6).
96846     * @return int
96847     * @since PHP 5
96848     **/
96849    function output($compression){}
96850
96851    /**
96852     * Removes the given object {@link instance} from the display list.
96853     *
96854     * @param object $instance
96855     * @return void
96856     * @since PHP 5.2.1-5.3.0, PECL ming SVN
96857     **/
96858    function remove($instance){}
96859
96860    /**
96861     * Saves the SWF movie to the specified {@link filename}.
96862     *
96863     * @param string $filename The path to the saved SWF document.
96864     * @param int $compression The compression level can be a value between
96865     *   0 and 9, defining the SWF compression similar to gzip compression.
96866     *   This parameter is only available as of Flash MX (6).
96867     * @return int
96868     * @since PHP 5
96869     **/
96870    function save($filename, $compression){}
96871
96872    /**
96873     * @param resource $x
96874     * @param int $compression The compression level can be a value between
96875     *   0 and 9, defining the SWF compression similar to gzip compression.
96876     *   This parameter is only available as of Flash MX (6).
96877     * @return int
96878     * @since PHP 5
96879     **/
96880    function saveToFile($x, $compression){}
96881
96882    /**
96883     * Sets the background color.
96884     *
96885     * Why is there no rgba version? Think about it, you might want to let
96886     * the HTML background show through. There's a way to do that, but it
96887     * only works on IE4. Search the site for details.
96888     *
96889     * @param int $red Value of red component
96890     * @param int $green Value of green component
96891     * @param int $blue Value of blue component
96892     * @return void
96893     * @since PHP 5
96894     **/
96895    function setbackground($red, $green, $blue){}
96896
96897    /**
96898     * Sets the movie's dimension to the specified {@link width} and {@link
96899     * height}.
96900     *
96901     * @param float $width The movie width.
96902     * @param float $height The movie height.
96903     * @return void
96904     * @since PHP 5
96905     **/
96906    function setDimension($width, $height){}
96907
96908    /**
96909     * Sets the total number of frames in the animation to the given {@link
96910     * number}.
96911     *
96912     * @param int $number The number of frames.
96913     * @return void
96914     * @since PHP 5
96915     **/
96916    function setFrames($number){}
96917
96918    /**
96919     * Sets the frame rate to the specified {@link rate}.
96920     *
96921     * Animation will slow down if the player can't render frames fast
96922     * enough- unless there's a streaming sound, in which case display frames
96923     * are sacrificed to keep sound from skipping.
96924     *
96925     * @param float $rate The frame rate, in frame per seconds.
96926     * @return void
96927     * @since PHP 5
96928     **/
96929    function setRate($rate){}
96930
96931    /**
96932     * @param SWFSound $sound
96933     * @return SWFSoundInstance
96934     * @since PHP 5
96935     **/
96936    function startSound($sound){}
96937
96938    /**
96939     * @param SWFSound $sound
96940     * @return void
96941     * @since PHP 5
96942     **/
96943    function stopSound($sound){}
96944
96945    /**
96946     * Streams the given MP3 file {@link mp3file}.
96947     *
96948     * This method is not very robust in dealing with oddities (can skip over
96949     * an initial ID3 tag, but that's about it).
96950     *
96951     * Note that the movie isn't smart enough to put enough frames in to
96952     * contain the entire mp3 stream- you'll have to add (length of song *
96953     * frames per second) frames to get the entire stream in.
96954     *
96955     * @param mixed $mp3file Can be a file pointer returned by {@link
96956     *   fopen} or the MP3 data, as a binary string.
96957     * @param float $skip Number of seconds to skip.
96958     * @return int
96959     * @since PHP 5
96960     **/
96961    function streamMP3($mp3file, $skip){}
96962
96963    /**
96964     * @return void
96965     * @since PHP 5
96966     **/
96967    function writeExports(){}
96968
96969    /**
96970     * Creates a new movie object, representing an SWF movie.
96971     *
96972     * @param int $version The desired SWF version. Default is 4.
96973     * @return SWFMovie
96974     * @since PHP 5
96975     **/
96976    function __construct($version){}
96977
96978}
96979/**
96980 * SWFPrebuiltClip.
96981 **/
96982class SWFPrebuiltClip {
96983    /**
96984     * @param mixed $file
96985     * @return SWFPrebuiltClip
96986     * @since PHP 5.0.5-5.3.0, PECL ming SVN
96987     **/
96988    function __construct($file){}
96989
96990}
96991/**
96992 * SWFShape.
96993 **/
96994class SWFShape {
96995    /**
96996     * {@link SWFShape->addFill} adds a solid fill to the shape's list of
96997     * fill styles. {@link SWFShape->addFill} accepts three different types
96998     * of arguments.
96999     *
97000     * {@link red}, {@link green}, {@link blue} is a color (RGB mode).
97001     *
97002     * The {@link bitmap} argument is an {@link SWFBitmap} object. The {@link
97003     * flags} argument can be one of the following values:
97004     * SWFFILL_CLIPPED_BITMAP, SWFFILL_TILED_BITMAP, SWFFILL_LINEAR_GRADIENT
97005     * or SWFFILL_RADIAL_GRADIENT. Default is SWFFILL_TILED_BITMAP for
97006     * SWFBitmap and SWFFILL_LINEAR_GRADIENT for SWFGradient.
97007     *
97008     * The {@link gradient} argument is an {@link SWFGradient} object. The
97009     * flags argument can be one of the following values :
97010     * SWFFILL_RADIAL_GRADIENT or SWFFILL_LINEAR_GRADIENT. Default is
97011     * SWFFILL_LINEAR_GRADIENT. I'm sure about this one. Really.
97012     *
97013     * {@link SWFShape->addFill} returns an {@link SWFFill} object for use
97014     * with the {@link SWFShape->setLeftFill} and {@link
97015     * SWFShape->setRightFill} functions described below.
97016     *
97017     * @param int $red
97018     * @param int $green
97019     * @param int $blue
97020     * @param int $alpha
97021     * @return SWFFill
97022     * @since PHP 5
97023     **/
97024    function addFill($red, $green, $blue, $alpha){}
97025
97026    /**
97027     * @param float $r
97028     * @param float $startAngle
97029     * @param float $endAngle
97030     * @return void
97031     * @since PHP 5
97032     **/
97033    function drawArc($r, $startAngle, $endAngle){}
97034
97035    /**
97036     * @param float $r
97037     * @return void
97038     * @since PHP 5
97039     **/
97040    function drawCircle($r){}
97041
97042    /**
97043     * @param float $bx
97044     * @param float $by
97045     * @param float $cx
97046     * @param float $cy
97047     * @param float $dx
97048     * @param float $dy
97049     * @return int
97050     * @since PHP 5
97051     **/
97052    function drawCubic($bx, $by, $cx, $cy, $dx, $dy){}
97053
97054    /**
97055     * @param float $bx
97056     * @param float $by
97057     * @param float $cx
97058     * @param float $cy
97059     * @param float $dx
97060     * @param float $dy
97061     * @return int
97062     * @since PHP 5
97063     **/
97064    function drawCubicTo($bx, $by, $cx, $cy, $dx, $dy){}
97065
97066    /**
97067     * @param float $controldx
97068     * @param float $controldy
97069     * @param float $anchordx
97070     * @param float $anchordy
97071     * @param float $targetdx
97072     * @param float $targetdy
97073     * @return int
97074     * @since PHP 5
97075     **/
97076    function drawCurve($controldx, $controldy, $anchordx, $anchordy, $targetdx, $targetdy){}
97077
97078    /**
97079     * @param float $controlx
97080     * @param float $controly
97081     * @param float $anchorx
97082     * @param float $anchory
97083     * @param float $targetx
97084     * @param float $targety
97085     * @return int
97086     * @since PHP 5
97087     **/
97088    function drawCurveTo($controlx, $controly, $anchorx, $anchory, $targetx, $targety){}
97089
97090    /**
97091     * @param SWFFont $font
97092     * @param string $character
97093     * @param int $size
97094     * @return void
97095     * @since PHP 5
97096     **/
97097    function drawGlyph($font, $character, $size){}
97098
97099    /**
97100     * @param float $dx
97101     * @param float $dy
97102     * @return void
97103     * @since PHP 5
97104     **/
97105    function drawLine($dx, $dy){}
97106
97107    /**
97108     * @param float $x
97109     * @param float $y
97110     * @return void
97111     * @since PHP 5
97112     **/
97113    function drawLineTo($x, $y){}
97114
97115    /**
97116     * @param float $dx
97117     * @param float $dy
97118     * @return void
97119     * @since PHP 5
97120     **/
97121    function movePen($dx, $dy){}
97122
97123    /**
97124     * @param float $x
97125     * @param float $y
97126     * @return void
97127     * @since PHP 5
97128     **/
97129    function movePenTo($x, $y){}
97130
97131    /**
97132     * What this nonsense is about is, every edge segment borders at most two
97133     * fills. When rasterizing the object, it's pretty handy to know what
97134     * those fills are ahead of time, so the swf format requires these to be
97135     * specified.
97136     *
97137     * {@link swfshape->setleftfill} sets the fill on the left side of the
97138     * edge- that is, on the interior if you're defining the outline of the
97139     * shape in a counter-clockwise fashion. The fill object is an SWFFill
97140     * object returned from one of the addFill functions above.
97141     *
97142     * This seems to be reversed when you're defining a shape in a morph,
97143     * though. If your browser crashes, just try setting the fill on the
97144     * other side.
97145     *
97146     * @param SWFGradient $fill
97147     * @return void
97148     * @since PHP 5
97149     **/
97150    function setLeftFill($fill){}
97151
97152    /**
97153     * {@link swfshape->setline} sets the shape's line style. {@link width}
97154     * is the line's width. If {@link width} is 0, the line's style is
97155     * removed (then, all other arguments are ignored). If {@link width} > 0,
97156     * then line's color is set to {@link red}, {@link green}, {@link blue}.
97157     * Last parameter {@link a} is optional.
97158     *
97159     * You must declare all line styles before you use them (see example).
97160     *
97161     * @param SWFShape $shape
97162     * @return void
97163     * @since PHP 5
97164     **/
97165    function setLine($shape){}
97166
97167    /**
97168     * @param SWFGradient $fill
97169     * @return void
97170     **/
97171    function setRightFill($fill){}
97172
97173    /**
97174     * Created a new SWFShape object.
97175     *
97176     * @return SWFShape
97177     * @since PHP 5
97178     **/
97179    function __construct(){}
97180
97181}
97182/**
97183 * SWFSound.
97184 **/
97185class SWFSound {
97186    /**
97187     * @param string $filename
97188     * @param int $flags
97189     * @return SWFSound
97190     * @since PHP 5
97191     **/
97192    function __construct($filename, $flags){}
97193
97194}
97195/**
97196 * objects are returned by the and methods.
97197 **/
97198class SWFSoundInstance {
97199    /**
97200     * @param int $point
97201     * @return void
97202     * @since PHP 5
97203     **/
97204    function loopCount($point){}
97205
97206    /**
97207     * @param int $point
97208     * @return void
97209     * @since PHP 5
97210     **/
97211    function loopInPoint($point){}
97212
97213    /**
97214     * @param int $point
97215     * @return void
97216     * @since PHP 5
97217     **/
97218    function loopOutPoint($point){}
97219
97220    /**
97221     * @return void
97222     * @since PHP 5
97223     **/
97224    function noMultiple(){}
97225
97226}
97227/**
97228 * An is also known as a "movie clip", this allows one to create objects
97229 * which are animated in their own timelines. Hence, the sprite has most
97230 * of the same methods as the movie.
97231 **/
97232class SWFSprite {
97233    /**
97234     * {@link swfsprite->add} adds a {@link swfshape}, a {@link swfbutton}, a
97235     * {@link swftext}, a {@link swfaction} or a {@link swfsprite} object.
97236     *
97237     * For displayable types ({@link swfshape}, {@link swfbutton}, {@link
97238     * swftext}, {@link swfaction} or {@link swfsprite}), this returns a
97239     * handle to the object in a display list.
97240     *
97241     * @param object $object
97242     * @return void
97243     * @since PHP 5
97244     **/
97245    function add($object){}
97246
97247    /**
97248     * @param string $label
97249     * @return void
97250     * @since PHP 5
97251     **/
97252    function labelFrame($label){}
97253
97254    /**
97255     * {@link swfsprite->setframes} moves to the next frame of the animation.
97256     *
97257     * @return void
97258     * @since PHP 5
97259     **/
97260    function nextFrame(){}
97261
97262    /**
97263     * {@link swfsprite->remove} remove a {@link swfshape}, a {@link
97264     * swfbutton}, a {@link swftext}, a {@link swfaction} or a {@link
97265     * swfsprite} object from the sprite.
97266     *
97267     * @param object $object
97268     * @return void
97269     * @since PHP 5
97270     **/
97271    function remove($object){}
97272
97273    /**
97274     * {@link swfsprite->setframes} sets the total number of frames in the
97275     * animation to {@link numberofframes}.
97276     *
97277     * @param int $number
97278     * @return void
97279     * @since PHP 5
97280     **/
97281    function setFrames($number){}
97282
97283    /**
97284     * @param SWFSound $sount
97285     * @return SWFSoundInstance
97286     * @since PHP 5
97287     **/
97288    function startSound($sount){}
97289
97290    /**
97291     * @param SWFSound $sount
97292     * @return void
97293     * @since PHP 5
97294     **/
97295    function stopSound($sount){}
97296
97297    /**
97298     * Creates a new SWFSprite object.
97299     *
97300     * @return SWFSprite
97301     * @since PHP 5
97302     **/
97303    function __construct(){}
97304
97305}
97306/**
97307 * SWFText.
97308 **/
97309class SWFText {
97310    /**
97311     * {@link swftext->addstring} draws the string {@link string} at the
97312     * current pen (cursor) location. Pen is at the baseline of the text;
97313     * i.e., ascending text is in the -y direction.
97314     *
97315     * @param string $string
97316     * @return void
97317     * @since PHP 5
97318     **/
97319    function addString($string){}
97320
97321    /**
97322     * @param string $text
97323     * @return void
97324     * @since PHP 5
97325     **/
97326    function addUTF8String($text){}
97327
97328    /**
97329     * @return float
97330     * @since PHP 5
97331     **/
97332    function getAscent(){}
97333
97334    /**
97335     * @return float
97336     * @since PHP 5
97337     **/
97338    function getDescent(){}
97339
97340    /**
97341     * @return float
97342     * @since PHP 5
97343     **/
97344    function getLeading(){}
97345
97346    /**
97347     * @param string $string
97348     * @return float
97349     * @since PHP 5
97350     **/
97351    function getUTF8Width($string){}
97352
97353    /**
97354     * Returns the rendered width of the {@link string} at the text object's
97355     * current font, scale, and spacing settings.
97356     *
97357     * @param string $string
97358     * @return float
97359     * @since PHP 5
97360     **/
97361    function getWidth($string){}
97362
97363    /**
97364     * {@link swftext->moveto} moves the pen (or cursor, if that makes more
97365     * sense) to ({@link x},{@link y}) in text object's coordinate space. If
97366     * either is zero, though, value in that dimension stays the same.
97367     * Annoying, should be fixed.
97368     *
97369     * @param float $x
97370     * @param float $y
97371     * @return void
97372     * @since PHP 5
97373     **/
97374    function moveTo($x, $y){}
97375
97376    /**
97377     * Changes the current text color.
97378     *
97379     * @param int $red Value of red component
97380     * @param int $green Value of green component
97381     * @param int $blue Value of blue component
97382     * @param int $a Value of alpha component
97383     * @return void
97384     * @since PHP 5
97385     **/
97386    function setColor($red, $green, $blue, $a){}
97387
97388    /**
97389     * {@link swftext->setfont} sets the current font to {@link font}.
97390     *
97391     * @param SWFFont $font
97392     * @return void
97393     * @since PHP 5
97394     **/
97395    function setFont($font){}
97396
97397    /**
97398     * {@link swftext->setheight} sets the current font height to {@link
97399     * height}. Default is 240.
97400     *
97401     * @param float $height
97402     * @return void
97403     * @since PHP 5
97404     **/
97405    function setHeight($height){}
97406
97407    /**
97408     * {@link swftext->setspacing} sets the current font spacing to {@link
97409     * spacing}. Default is 1.0. 0 is all of the letters written at the same
97410     * point. This doesn't really work that well because it inflates the
97411     * advance across the letter, doesn't add the same amount of spacing
97412     * between the letters. I should try and explain that better, prolly. Or
97413     * just fix the damn thing to do constant spacing. This was really just a
97414     * way to figure out how letter advances work, anyway.. So nyah.
97415     *
97416     * @param float $spacing
97417     * @return void
97418     * @since PHP 5
97419     **/
97420    function setSpacing($spacing){}
97421
97422    /**
97423     * Creates a new SWFText object, fresh for manipulating.
97424     *
97425     * @return void
97426     * @since PHP 5
97427     **/
97428    function __construct(){}
97429
97430}
97431/**
97432 * SWFTextField.
97433 **/
97434class SWFTextField {
97435    /**
97436     * @param string $chars
97437     * @return void
97438     * @since PHP 5
97439     **/
97440    function addChars($chars){}
97441
97442    /**
97443     * {@link swftextfield->setname} concatenates the string {@link string}
97444     * to the text field.
97445     *
97446     * @param string $string
97447     * @return void
97448     * @since PHP 5
97449     **/
97450    function addString($string){}
97451
97452    /**
97453     * {@link swftextfield->align} sets the text field alignment to {@link
97454     * alignement}. Valid values for {@link alignement} are :
97455     * SWFTEXTFIELD_ALIGN_LEFT, SWFTEXTFIELD_ALIGN_RIGHT,
97456     * SWFTEXTFIELD_ALIGN_CENTER and SWFTEXTFIELD_ALIGN_JUSTIFY.
97457     *
97458     * @param int $alignement
97459     * @return void
97460     * @since PHP 5
97461     **/
97462    function align($alignement){}
97463
97464    /**
97465     * {@link swftextfield->setbounds} sets the text field width to {@link
97466     * width} and height to {@link height}. If you don't set the bounds
97467     * yourself, Ming makes a poor guess at what the bounds are.
97468     *
97469     * @param float $width
97470     * @param float $height
97471     * @return void
97472     * @since PHP 5
97473     **/
97474    function setBounds($width, $height){}
97475
97476    /**
97477     * {@link swftextfield->setcolor} sets the color of the text field.
97478     * Default is fully opaque black. Color is represented using RGB system.
97479     *
97480     * @param int $red Value of red component
97481     * @param int $green Value of green component
97482     * @param int $blue Value of blue component
97483     * @param int $a Value of alpha component
97484     * @return void
97485     * @since PHP 5
97486     **/
97487    function setColor($red, $green, $blue, $a){}
97488
97489    /**
97490     * {@link swftextfield->setfont} sets the text field font to the
97491     * [browser-defined?] {@link font} font.
97492     *
97493     * @param SWFFont $font
97494     * @return void
97495     * @since PHP 5
97496     **/
97497    function setFont($font){}
97498
97499    /**
97500     * {@link swftextfield->setheight} sets the font height of this text
97501     * field font to the given height {@link height}. Default is 240.
97502     *
97503     * @param float $height
97504     * @return void
97505     * @since PHP 5
97506     **/
97507    function setHeight($height){}
97508
97509    /**
97510     * {@link swftextfield->setindentation} sets the indentation of the first
97511     * line in the text field, to {@link width}.
97512     *
97513     * @param float $width
97514     * @return void
97515     * @since PHP 5
97516     **/
97517    function setIndentation($width){}
97518
97519    /**
97520     * {@link swftextfield->setleftmargin} sets the left margin width of the
97521     * text field to {@link width}. Default is 0.
97522     *
97523     * @param float $width
97524     * @return void
97525     * @since PHP 5
97526     **/
97527    function setLeftMargin($width){}
97528
97529    /**
97530     * {@link swftextfield->setlinespacing} sets the line spacing of the text
97531     * field to the height of {@link height}. Default is 40.
97532     *
97533     * @param float $height
97534     * @return void
97535     * @since PHP 5
97536     **/
97537    function setLineSpacing($height){}
97538
97539    /**
97540     * {@link swftextfield->setmargins} set both margins at once, for the man
97541     * on the go.
97542     *
97543     * @param float $left
97544     * @param float $right
97545     * @return void
97546     * @since PHP 5
97547     **/
97548    function setMargins($left, $right){}
97549
97550    /**
97551     * {@link swftextfield->setname} sets the variable name of this text
97552     * field to {@link name}, for form posting and action scripting purposes.
97553     *
97554     * @param string $name
97555     * @return void
97556     * @since PHP 5
97557     **/
97558    function setName($name){}
97559
97560    /**
97561     * @param float $padding
97562     * @return void
97563     * @since PHP 5
97564     **/
97565    function setPadding($padding){}
97566
97567    /**
97568     * {@link swftextfield->setrightmargin} sets the right margin width of
97569     * the text field to {@link width}. Default is 0.
97570     *
97571     * @param float $width
97572     * @return void
97573     * @since PHP 5
97574     **/
97575    function setRightMargin($width){}
97576
97577    /**
97578     * {@link swftextfield} creates a new text field object. Text Fields are
97579     * less flexible than {@link swftext} objects- they can't be rotated,
97580     * scaled non-proportionally, or skewed, but they can be used as form
97581     * entries, and they can use browser-defined fonts.
97582     *
97583     * The optional flags change the text field's behavior. It has the
97584     * following possibles values : SWFTEXTFIELD_DRAWBOX draws the outline of
97585     * the textfield SWFTEXTFIELD_HASLENGTH SWFTEXTFIELD_HTML allows text
97586     * markup using HTML-tags SWFTEXTFIELD_MULTILINE allows multiple lines
97587     * SWFTEXTFIELD_NOEDIT indicates that the field shouldn't be
97588     * user-editable SWFTEXTFIELD_NOSELECT makes the field non-selectable
97589     * SWFTEXTFIELD_PASSWORD obscures the data entry SWFTEXTFIELD_WORDWRAP
97590     * allows text to wrap Flags are combined with the bitwise OR operation.
97591     * For example,
97592     *
97593     * <?php $t = newSWFTextField(SWFTEXTFIELD_PASSWORD |
97594     * SWFTEXTFIELD_NOEDIT); ?>
97595     *
97596     * creates a totally useless non-editable password field.
97597     *
97598     * @param int $flags
97599     * @return SWFTextField
97600     * @since PHP 5
97601     **/
97602    function __construct($flags){}
97603
97604}
97605/**
97606 * SWFVideoStream.
97607 **/
97608class SWFVideoStream {
97609    /**
97610     * This function returns the number of video-frames of a SWFVideoStream.
97611     *
97612     * @return int
97613     * @since PHP 5.0.5-5.3.0, PECL ming SVN
97614     **/
97615    function getNumFrames(){}
97616
97617    /**
97618     * Sets the width and height for streamed videos.
97619     *
97620     * @param int $x Width in pixels.
97621     * @param int $y Height in pixels.
97622     * @return void
97623     * @since PHP 5.0.5-5.3.0, PECL ming SVN
97624     **/
97625    function setDimension($x, $y){}
97626
97627    /**
97628     * @param string $file
97629     * @return SWFVideoStream
97630     * @since PHP 5.0.5-5.3.0, PECL ming SVN
97631     **/
97632    function __construct($file){}
97633
97634}
97635interface Swish {
97636    const IN_ALL = 0;
97637    const IN_BODY = 0;
97638    const IN_BODY_BIT = 0;
97639    const IN_COMMENTS = 0;
97640    const IN_COMMENTS_BIT = 0;
97641    const IN_EMPHASIZED = 0;
97642    const IN_EMPHASIZED_BIT = 0;
97643    const IN_FILE = 0;
97644    const IN_FILE_BIT = 0;
97645    const IN_HEAD = 0;
97646    const IN_HEADER = 0;
97647    const IN_HEADER_BIT = 0;
97648    const IN_HEAD_BIT = 0;
97649    const IN_META = 0;
97650    const IN_META_BIT = 0;
97651    const IN_TITLE = 0;
97652    const IN_TITLE_BIT = 0;
97653    const META_TYPE_DATE = 0;
97654    const META_TYPE_STRING = 0;
97655    const META_TYPE_ULONG = 0;
97656    const META_TYPE_UNDEF = 0;
97657    /**
97658     * @param string $index_name The name of the index file.
97659     * @return array
97660     * @since PECL swish >= 0.1.0
97661     **/
97662    function getMetaList($index_name);
97663
97664    /**
97665     * @param string $index_name The name of the index file.
97666     * @return array
97667     * @since PECL swish >= 0.1.0
97668     **/
97669    function getPropertyList($index_name);
97670
97671    /**
97672     * Prepare and return a search object, which you can later use for
97673     * unlimited number of queries.
97674     *
97675     * @param string $query Optional query string. The query can be also
97676     *   set using {@link SwishSearch->execute} method.
97677     * @return object
97678     * @since PECL swish >= 0.1.0
97679     **/
97680    function prepare($query);
97681
97682    /**
97683     * A quick method to execute a search with default parameters.
97684     *
97685     * @param string $query Query string.
97686     * @return object
97687     * @since PECL swish >= 0.1.0
97688     **/
97689    function query($query);
97690
97691    /**
97692     * @param string $index_names The list of index files separated by
97693     *   spaces.
97694     * @return void
97695     * @since PECL swish >= 0.1.0
97696     **/
97697    function __construct($index_names);
97698
97699}
97700class SwishResult {
97701    /**
97702     * @return array
97703     * @since PECL swish >= 0.1.0
97704     **/
97705    function getMetaList(){}
97706
97707    /**
97708     * Stems the word based on the fuzzy mode used during indexing. Each
97709     * result object is linked with its index, so the results are based on
97710     * this index.
97711     *
97712     * @param string $word The word to stem.
97713     * @return array
97714     * @since PECL swish >= 0.1.0
97715     **/
97716    function stem($word){}
97717
97718}
97719class SwishResults {
97720    /**
97721     * @param string $index_name The name of the index used to initialize
97722     *   Swish object.
97723     * @return array
97724     * @since PECL swish >= 0.1.0
97725     **/
97726    function getParsedWords($index_name){}
97727
97728    /**
97729     * @param string $index_name The name of the index used to initialize
97730     *   Swish object.
97731     * @return array
97732     * @since PECL swish >= 0.1.0
97733     **/
97734    function getRemovedStopwords($index_name){}
97735
97736    /**
97737     * @return object
97738     * @since PECL swish >= 0.1.0
97739     **/
97740    function nextResult(){}
97741
97742    /**
97743     * @param int $position Zero-based position number. Cannot be less than
97744     *   zero.
97745     * @return int
97746     * @since PECL swish >= 0.1.0
97747     **/
97748    function seekResult($position){}
97749
97750}
97751class SwishSearch {
97752    /**
97753     * Searches the index file(s) based on the parameters set in the search
97754     * object.
97755     *
97756     * @param string $query The query string is an optional parameter, it
97757     *   can be also set using {@link Swish->prepare} method. The query
97758     *   string is preserved between executions, so you can set it once, but
97759     *   execute the search multiple times.
97760     * @return object
97761     * @since PECL swish >= 0.1.0
97762     **/
97763    function execute($query){}
97764
97765    /**
97766     * Reset the search limits previous set by .
97767     *
97768     * @return void
97769     * @since PECL swish >= 0.1.0
97770     **/
97771    function resetLimit(){}
97772
97773    /**
97774     * @param string $property Search result property name.
97775     * @param string $low The lowest value of the property.
97776     * @param string $high The highest value of the property.
97777     * @return void
97778     * @since PECL swish >= 0.1.0
97779     **/
97780    function setLimit($property, $low, $high){}
97781
97782    /**
97783     * @param string $delimiter Phrase delimiter character. The default
97784     *   delimiter is double-quotes.
97785     * @return void
97786     * @since PECL swish >= 0.1.0
97787     **/
97788    function setPhraseDelimiter($delimiter){}
97789
97790    /**
97791     * @param string $sort Sort order of the results is a string containing
97792     *   name of a result property combined with sort direction ("asc" or
97793     *   "desc"). Examples: "swishrank desc", "swishdocpath asc", "swishtitle
97794     *   asc", "swishdocsize desc", "swishlastmodified desc" etc.
97795     * @return void
97796     * @since PECL swish >= 0.1.0
97797     **/
97798    function setSort($sort){}
97799
97800    /**
97801     * @param int $structure The structure flag a bitmask is used to limit
97802     *   search to certain parts of HTML documents (like title, meta, body
97803     *   etc.). Its possible values are listed below. To combine several
97804     *   values use bitwise OR operator, see example below.
97805     * @return void
97806     * @since PECL swish >= 0.1.0
97807     **/
97808    function setStructure($structure){}
97809
97810}
97811/**
97812 * An HTML node in an HTML file, as detected by tidy.
97813 **/
97814class Tidy {
97815    /**
97816     * Returns warnings and errors which occurred parsing the specified
97817     * document.
97818     *
97819     * @var string
97820     **/
97821    var $errorBuffer;
97822    /**
97823     * Returns a tidyNode object starting from the <body> tag of the tidy
97824     * parse tree.
97825     *
97826     * @return tidyNode
97827     **/
97828    function body(){}
97829
97830    /**
97831     * This function cleans and repairs the given tidy {@link object}.
97832     *
97833     * @return bool
97834     **/
97835    function cleanRepair(){}
97836
97837    /**
97838     * Runs diagnostic tests on the given tidy {@link object}, adding some
97839     * more information about the document in the error buffer.
97840     *
97841     * @return bool
97842     **/
97843    function diagnose(){}
97844
97845    /**
97846     * Gets the list of the configuration options in use by the given tidy
97847     * {@link object}.
97848     *
97849     * @return array
97850     **/
97851    function getConfig(){}
97852
97853    /**
97854     * Returns the detected HTML version for the specified tidy {@link
97855     * object}.
97856     *
97857     * @return int
97858     **/
97859    function getHtmlVer(){}
97860
97861    /**
97862     * Returns the value of the specified {@link option} for the specified
97863     * tidy {@link object}.
97864     *
97865     * @param string $option
97866     * @return mixed
97867     **/
97868    function getOpt($option){}
97869
97870    /**
97871     * {@link tidy_get_opt_doc} returns the documentation for the given
97872     * option name.
97873     *
97874     * @param string $optname
97875     * @return string
97876     **/
97877    function getOptDoc($optname){}
97878
97879    /**
97880     * Gets the release date of the Tidy library.
97881     *
97882     * @return string
97883     **/
97884    function getRelease(){}
97885
97886    /**
97887     * Returns the status for the specified tidy {@link object}.
97888     *
97889     * @return int
97890     **/
97891    function getStatus(){}
97892
97893    /**
97894     * Returns a tidyNode object starting from the <head> tag of the tidy
97895     * parse tree.
97896     *
97897     * @return tidyNode
97898     **/
97899    function head(){}
97900
97901    /**
97902     * Returns a tidyNode object starting from the <html> tag of the tidy
97903     * parse tree.
97904     *
97905     * @return tidyNode
97906     **/
97907    function html(){}
97908
97909    /**
97910     * Tells if the document is a XHTML document.
97911     *
97912     * @return bool
97913     **/
97914    function isXhtml(){}
97915
97916    /**
97917     * Tells if the document is a generic (non HTML/XHTML) XML document.
97918     *
97919     * @return bool
97920     **/
97921    function isXml(){}
97922
97923    /**
97924     * Parses the given file.
97925     *
97926     * @param string $filename If the {@link filename} parameter is given,
97927     *   this function will also read that file and initialize the object
97928     *   with the file, acting like {@link tidy_parse_file}.
97929     * @param mixed $config The config {@link config} can be passed either
97930     *   as an array or as a string. If a string is passed, it is interpreted
97931     *   as the name of the configuration file, otherwise, it is interpreted
97932     *   as the options themselves. For an explanation about each option, see
97933     *   .
97934     * @param string $encoding The {@link encoding} parameter sets the
97935     *   encoding for input/output documents. The possible values for
97936     *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
97937     *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
97938     * @param bool $use_include_path Search for the file in the
97939     *   include_path.
97940     * @return bool
97941     **/
97942    function parseFile($filename, $config, $encoding, $use_include_path){}
97943
97944    /**
97945     * Parses a document stored in a string.
97946     *
97947     * @param string $input The data to be parsed.
97948     * @param mixed $config The config {@link config} can be passed either
97949     *   as an array or as a string. If a string is passed, it is interpreted
97950     *   as the name of the configuration file, otherwise, it is interpreted
97951     *   as the options themselves. For an explanation about each option,
97952     *   visit .
97953     * @param string $encoding The {@link encoding} parameter sets the
97954     *   encoding for input/output documents. The possible values for
97955     *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
97956     *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
97957     * @return bool
97958     **/
97959    function parseString($input, $config, $encoding){}
97960
97961    /**
97962     * Repairs the given file and returns it as a string.
97963     *
97964     * @param string $filename The file to be repaired.
97965     * @param mixed $config The config {@link config} can be passed either
97966     *   as an array or as a string. If a string is passed, it is interpreted
97967     *   as the name of the configuration file, otherwise, it is interpreted
97968     *   as the options themselves. Check
97969     *   http://tidy.sourceforge.net/docs/quickref.html for an explanation
97970     *   about each option.
97971     * @param string $encoding The {@link encoding} parameter sets the
97972     *   encoding for input/output documents. The possible values for
97973     *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
97974     *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
97975     * @param bool $use_include_path Search for the file in the
97976     *   include_path.
97977     * @return string
97978     **/
97979    function repairFile($filename, $config, $encoding, $use_include_path){}
97980
97981    /**
97982     * Repairs the given string.
97983     *
97984     * @param string $data The data to be repaired.
97985     * @param mixed $config The config {@link config} can be passed either
97986     *   as an array or as a string. If a string is passed, it is interpreted
97987     *   as the name of the configuration file, otherwise, it is interpreted
97988     *   as the options themselves. Check for an explanation about each
97989     *   option.
97990     * @param string $encoding The {@link encoding} parameter sets the
97991     *   encoding for input/output documents. The possible values for
97992     *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
97993     *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
97994     * @return string
97995     **/
97996    function repairString($data, $config, $encoding){}
97997
97998    /**
97999     * Returns a tidyNode object representing the root of the tidy parse
98000     * tree.
98001     *
98002     * @return tidyNode
98003     **/
98004    function root(){}
98005
98006    /**
98007     * Constructs a new tidy object.
98008     *
98009     * @param string $filename If the {@link filename} parameter is given,
98010     *   this function will also read that file and initialize the object
98011     *   with the file, acting like {@link tidy_parse_file}.
98012     * @param mixed $config The config {@link config} can be passed either
98013     *   as an array or as a string. If a string is passed, it is interpreted
98014     *   as the name of the configuration file, otherwise, it is interpreted
98015     *   as the options themselves. For an explanation about each option,
98016     *   visit .
98017     * @param string $encoding The {@link encoding} parameter sets the
98018     *   encoding for input/output documents. The possible values for
98019     *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
98020     *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
98021     * @param bool $use_include_path Search for the file in the
98022     *   include_path.
98023     * @return tidy
98024     * @since PHP 5, PECL tidy >= 0.5.2
98025     **/
98026    function __construct($filename, $config, $encoding, $use_include_path){}
98027
98028}
98029/**
98030 * An HTML node in an HTML file, as detected by tidy.
98031 **/
98032class tidyNode {
98033    /**
98034     * Returns the parent node of the current node.
98035     *
98036     * @return tidyNode
98037     * @since PHP 5 >= 5.2.2
98038     **/
98039    function getParent(){}
98040
98041    /**
98042     * Tells if the node has children.
98043     *
98044     * @return bool
98045     * @since PHP 5 >= 5.0.1
98046     **/
98047    function hasChildren(){}
98048
98049    /**
98050     * Tells if the node has siblings.
98051     *
98052     * @return bool
98053     * @since PHP 5 >= 5.0.1
98054     **/
98055    function hasSiblings(){}
98056
98057    /**
98058     * Tells whether the current node is ASP.
98059     *
98060     * @return bool
98061     * @since PHP 5 >= 5.0.1
98062     **/
98063    function isAsp(){}
98064
98065    /**
98066     * Tells if the node is a comment.
98067     *
98068     * @return bool
98069     * @since PHP 5 >= 5.0.1
98070     **/
98071    function isComment(){}
98072
98073    /**
98074     * Tells if the node is part of HTML document.
98075     *
98076     * @return bool
98077     * @since PHP 5 >= 5.0.1
98078     **/
98079    function isHtml(){}
98080
98081    /**
98082     * Tells if the node is JSTE.
98083     *
98084     * @return bool
98085     * @since PHP 5 >= 5.0.1
98086     **/
98087    function isJste(){}
98088
98089    /**
98090     * Tells if the node is PHP.
98091     *
98092     * @return bool
98093     * @since PHP 5 >= 5.0.1
98094     **/
98095    function isPhp(){}
98096
98097    /**
98098     * Tells if the node represents a text (without any markup).
98099     *
98100     * @return bool
98101     * @since PHP 5 >= 5.0.1
98102     **/
98103    function isText(){}
98104
98105}
98106/**
98107 * The main Tokyo Tyrant class
98108 **/
98109class TokyoTyrant {
98110    /**
98111     * Adds to an int or double value. This increments the value by the given
98112     * amount and returns the new value. If the key does not exist a new key
98113     * is created with initial value of the increment parameter.
98114     *
98115     * @param string $key The string key
98116     * @param number $increment The amount to increment
98117     * @param int $type TokyoTyrant::RDB_RECINT or TokyoTyrant::RDB_RECDBL
98118     *   constant. If this parameter is omitted the type is guessed from the
98119     *   {@link increment} parameters type.
98120     * @return number
98121     * @since PECL tokyo_tyrant >= 0.1.0
98122     **/
98123    function add($key, $increment, $type){}
98124
98125    /**
98126     * Connects to a remote database
98127     *
98128     * @param string $host The hostname
98129     * @param int $port The port. Default: 1978
98130     * @param array $options Connection options: timeout (default: 5.0),
98131     *   reconnect (default: ) and persistent (default: )
98132     * @return TokyoTyrant
98133     * @since PECL tokyo_tyrant >= 0.1.0
98134     **/
98135    function connect($host, $port, $options){}
98136
98137    /**
98138     * Connects to a database using an uri
98139     *
98140     * @param string $uri An URI to the database. For example
98141     *   tcp://localhost:1979/
98142     * @return TokyoTyrant
98143     * @since PECL tokyo_tyrant >= 0.1.0
98144     **/
98145    function connectUri($uri){}
98146
98147    /**
98148     * Makes a copy of the current database
98149     *
98150     * @param string $path Path to where to copy the database. The user
98151     *   running the remote database must have a write access to the
98152     *   directory.
98153     * @return TokyoTyrant
98154     * @since PECL tokyo_tyrant >= 0.1.0
98155     **/
98156    function copy($path){}
98157
98158    /**
98159     * Executes a remote script extension.
98160     *
98161     * @param string $name Name of the function to execute
98162     * @param int $options Either TokyoTyrant::RDBXO_LCKREC for record
98163     *   locking and TokyoTyrant::RDBXO_LCKGLB for global locking.
98164     * @param string $key The key to pass to the function
98165     * @param string $value The value to pass to the function
98166     * @return string
98167     * @since PECL tokyo_tyrant >= 0.1.0
98168     **/
98169    function ext($name, $options, $key, $value){}
98170
98171    /**
98172     * Returns the forward matching keys from the database
98173     *
98174     * @param string $prefix Prefix of the keys
98175     * @param int $max_recs Maximum records to return
98176     * @return array
98177     * @since PECL tokyo_tyrant >= 0.1.0
98178     **/
98179    function fwmKeys($prefix, $max_recs){}
98180
98181    /**
98182     * This method is used to return a value or multiple values. This method
98183     * accepts a string or an array as a value.
98184     *
98185     * @param mixed $keys A string key or an array of string keys
98186     * @return mixed
98187     * @since PECL tokyo_tyrant >= 0.1.0
98188     **/
98189    function get($keys){}
98190
98191    /**
98192     * Gets an iterator for iterating all keys / values in the database.
98193     *
98194     * @return TokyoTyrantIterator
98195     **/
98196    function getIterator(){}
98197
98198    /**
98199     * Returns the number of records in the database
98200     *
98201     * @return int
98202     * @since PECL tokyo_tyrant >= 0.1.0
98203     **/
98204    function num(){}
98205
98206    /**
98207     * Removes a record or multiple records. This method accepts a string for
98208     * a single key or an array of keys for multiple records.
98209     *
98210     * @param mixed $keys A string key or an array of string keys
98211     * @return TokyoTyrant
98212     * @since PECL tokyo_tyrant >= 0.1.0
98213     **/
98214    function out($keys){}
98215
98216    /**
98217     * Puts a key-value pair into the database or multiple key-value pairs.
98218     * If {@link keys} is string then the second parameter value defines the
98219     * value. The second parameter is mandatory if {@link keys} is a string.
98220     * If the key exists the value will be replaced with new value.
98221     *
98222     * @param mixed $keys A string key or an array of key-value pairs
98223     * @param string $value The value in case a string key is used
98224     * @return TokyoTyrant
98225     * @since PECL tokyo_tyrant >= 0.1.0
98226     **/
98227    function put($keys, $value){}
98228
98229    /**
98230     * Appends a value into existing key or multiple values if {@link keys}
98231     * is an array. The second parameter is mandatory if {@link keys} is a
98232     * string. If the record does not exist a new record is created.
98233     *
98234     * @param mixed $keys A string key or an array of key-value pairs
98235     * @param string $value The value in case a string key is used
98236     * @return TokyoTyrant
98237     * @since PECL tokyo_tyrant >= 0.1.0
98238     **/
98239    function putCat($keys, $value){}
98240
98241    /**
98242     * Puts a key-value pair into the database or multiple key-value pairs.
98243     * If {@link keys} is string then the second parameter value defines the
98244     * value. The second parameter is mandatory if {@link keys} is a string.
98245     * If the key already exists this method throws an exception indicating
98246     * that the records exists.
98247     *
98248     * @param mixed $keys A string key or an array of key-value pairs
98249     * @param string $value The string value
98250     * @return TokyoTyrant
98251     * @since PECL tokyo_tyrant >= 0.1.0
98252     **/
98253    function putKeep($keys, $value){}
98254
98255    /**
98256     * Puts a key-value pair into the database or multiple key-value pairs.
98257     * If {@link keys} is string then the second parameter value defines the
98258     * value. The second parameter is mandatory if {@link keys} is a string.
98259     * This method does not wait for the response from the server.
98260     *
98261     * @param mixed $keys A string key or an array of key-value pairs
98262     * @param string $value The value in case a string key is used
98263     * @return TokyoTyrant
98264     * @since PECL tokyo_tyrant >= 0.1.0
98265     **/
98266    function putNr($keys, $value){}
98267
98268    /**
98269     * Concatenate to a record and shift to left.
98270     *
98271     * @param string $key A string key
98272     * @param string $value The value to concatenate
98273     * @param int $width The width of the record
98274     * @return mixed
98275     * @since PECL tokyo_tyrant >= 0.1.0
98276     **/
98277    function putShl($key, $value, $width){}
98278
98279    /**
98280     * Restore the database from the update log.
98281     *
98282     * @param string $log_dir Directory where the log is
98283     * @param int $timestamp Beginning timestamp with microseconds
98284     * @param bool $check_consistency Whether to check consistency:
98285     *   Default:
98286     * @return mixed
98287     * @since PECL tokyo_tyrant >= 0.1.0
98288     **/
98289    function restore($log_dir, $timestamp, $check_consistency){}
98290
98291    /**
98292     * Sets the replication master of the database
98293     *
98294     * @param string $host Hostname of the replication master. If the
98295     *   replication is disabled.
98296     * @param int $port Port of the replication master
98297     * @param int $timestamp Beginning timestamp with microseconds
98298     * @param bool $check_consistency Whether to check consistency.
98299     * @return mixed
98300     * @since PECL tokyo_tyrant >= 0.1.0
98301     **/
98302    function setMaster($host, $port, $timestamp, $check_consistency){}
98303
98304    /**
98305     * Returns the size of a value by key
98306     *
98307     * @param string $key The key of which size to fetch
98308     * @return int
98309     * @since PECL tokyo_tyrant >= 0.1.0
98310     **/
98311    function size($key){}
98312
98313    /**
98314     * Returns statistics of the remote database
98315     *
98316     * @return array
98317     * @since PECL tokyo_tyrant >= 0.1.0
98318     **/
98319    function stat(){}
98320
98321    /**
98322     * Synchronizes the database on to the physical device
98323     *
98324     * @return mixed
98325     * @since PECL tokyo_tyrant >= 0.1.0
98326     **/
98327    function sync(){}
98328
98329    /**
98330     * Tunes database connection options.
98331     *
98332     * @param float $timeout The objects timeout value (default: 5.0)
98333     * @param int $options Bitmask of options to tune. This can be either 0
98334     *   or TokyoTyrant::RDBT_RECON. It is recommended not to change the
98335     *   second parameter.
98336     * @return TokyoTyrant
98337     * @since PECL tokyo_tyrant >= 0.2.0
98338     **/
98339    function tune($timeout, $options){}
98340
98341    /**
98342     * Empties a remote database
98343     *
98344     * @return mixed
98345     * @since PECL tokyo_tyrant >= 0.1.0
98346     **/
98347    function vanish(){}
98348
98349    /**
98350     * Constructs a new TokyoTyrant object and optionally connects to the
98351     * database
98352     *
98353     * @param string $host The hostname. Default:
98354     * @param int $port port number. Default: 1978
98355     * @param array $options Connection options: timeout (default: 5.0),
98356     *   reconnect (default: ) and persistent (default: )
98357     * @since PECL tokyo_tyrant >= 0.1.0
98358     **/
98359    function __construct($host, $port, $options){}
98360
98361}
98362/**
98363 * TokyoTyrantException
98364 **/
98365class tokyotyrantexception extends Exception {
98366}
98367/**
98368 * Provides an iterator for TokyoTyrant and TokyoTyrantTable objects. The
98369 * iterator iterates over over all keys and values in the database.
98370 * TokyoTyrantIterator was added in version 0.2.0.
98371 **/
98372class TokyoTyrantIterator {
98373    /**
98374     * Returns the current value during iteration.
98375     *
98376     * @return mixed
98377     * @since PECL tokyo_tyrant >= 0.2.0
98378     **/
98379    function current(){}
98380
98381    /**
98382     * Returns the current key.
98383     *
98384     * @return mixed
98385     * @since PECL tokyo_tyrant >= 0.2.0
98386     **/
98387    function key(){}
98388
98389    /**
98390     * Move to next key during iteration and return it's value.
98391     *
98392     * @return mixed
98393     * @since PECL tokyo_tyrant >= 0.2.0
98394     **/
98395    function next(){}
98396
98397    /**
98398     * Rewinds the iterator for new iteration. Called automatically at the
98399     * beginning of foreach.
98400     *
98401     * @return void
98402     * @since PECL tokyo_tyrant >= 0.2.0
98403     **/
98404    function rewind(){}
98405
98406    /**
98407     * Checks whether the internal pointer points to valid element.
98408     *
98409     * @return boolean
98410     * @since PECL tokyo_tyrant >= 0.2.0
98411     **/
98412    function valid(){}
98413
98414    /**
98415     * Construct a new TokyoTyrantIterator object. One connection can have
98416     * multiple iterators but it is not quaranteed that all items are
98417     * traversed in that case. {@link object} parameter can be either an of
98418     * instance TokyoTyrant or TokyoTyrantTable.
98419     *
98420     * @param mixed $object
98421     * @return TokyoTyrantIterator
98422     * @since PECL tokyo_tyrant >= 0.2.0
98423     **/
98424    function __construct($object){}
98425
98426}
98427/**
98428 * This class is used to query the table databases
98429 **/
98430class TokyoTyrantQuery implements Iterator, Traversable {
98431    /**
98432     * Adds a condition to the query. Condition can be something like: get
98433     * all keys which value matches expr.
98434     *
98435     * @param string $name Name of the column in the condition
98436     * @param int $op The operator. One of the TokyoTyrant::RDBQC_*
98437     *   constants
98438     * @param string $expr The expression
98439     * @return mixed
98440     * @since PECL tokyo_tyrant >= 0.1.0
98441     **/
98442    function addCond($name, $op, $expr){}
98443
98444    /**
98445     * Returns a count of how many records a query returns.
98446     *
98447     * @return int
98448     **/
98449    function count(){}
98450
98451    /**
98452     * Returns the current element. Part of Iterator interface
98453     *
98454     * @return array
98455     * @since PECL tokyo_tyrant >= 0.1.0
98456     **/
98457    function current(){}
98458
98459    /**
98460     * Get the hint string of the query. The hint string contains information
98461     * about an executed query and it could be compared to for example MySQL
98462     * EXPLAIN statement.
98463     *
98464     * @return string
98465     **/
98466    function hint(){}
98467
98468    /**
98469     * Returns the current key. Part of the Iterator interface
98470     *
98471     * @return string
98472     * @since PECL tokyo_tyrant >= 0.1.0
98473     **/
98474    function key(){}
98475
98476    /**
98477     * Executes multiple queries on a database and returns matching records.
98478     * The current object is always the left most object in the search.
98479     *
98480     * @param array $queries Array of TokyoTyrantQuery objects
98481     * @param int $type One of the TokyoTyrant::RDBMS_* constants
98482     * @return array
98483     **/
98484    function metaSearch($queries, $type){}
98485
98486    /**
98487     * Returns the next result in the resultset. Part of the Iterator
98488     * interface.
98489     *
98490     * @return array
98491     * @since PECL tokyo_tyrant >= 0.1.0
98492     **/
98493    function next(){}
98494
98495    /**
98496     * Removes all records that match the query. Works exactly like search
98497     * but removes the records instead of returning them.
98498     *
98499     * @return TokyoTyrantQuery
98500     * @since PECL tokyo_tyrant >= 0.1.0
98501     **/
98502    function out(){}
98503
98504    /**
98505     * Rewind the resultset and executes the query if it has not been
98506     * executed. Part of the Iterator interface.
98507     *
98508     * @return bool
98509     * @since PECL tokyo_tyrant >= 0.1.0
98510     **/
98511    function rewind(){}
98512
98513    /**
98514     * Executes a search on the table database. Returns an array of arrays
98515     * containing the matching records. In the returned array the first level
98516     * is the primary key of the data and the second level is the row data.
98517     *
98518     * @return array
98519     * @since PECL tokyo_tyrant >= 0.1.0
98520     **/
98521    function search(){}
98522
98523    /**
98524     * Set the maximum amount of records to return on a query.
98525     *
98526     * @param int $max Maximum amount of records. Default: -1
98527     * @param int $skip How many records to skip from the start. Default:
98528     *   -1
98529     * @return mixed
98530     * @since PECL tokyo_tyrant >= 0.1.0
98531     **/
98532    function setLimit($max, $skip){}
98533
98534    /**
98535     * Checks if the current item is valid. Part of the Iterator interface
98536     *
98537     * @return bool
98538     * @since PECL tokyo_tyrant >= 0.1.0
98539     **/
98540    function valid(){}
98541
98542    /**
98543     * Construct a new query object
98544     *
98545     * @param TokyoTyrantTable $table TokyoTyrantTable object with active
98546     *   database connection
98547     * @since PECL tokyo_tyrant >= 0.1.0
98548     **/
98549    function __construct($table){}
98550
98551}
98552/**
98553 * Provides an API to the table databases. A table database can be create
98554 * using the following command: . In Tokyo Tyrant the table API is a
98555 * schemaless database which can store arbitrary amount of key-value
98556 * pairs under a single primary key.
98557 **/
98558class TokyoTyrantTable extends TokyoTyrant {
98559    /**
98560     * This method is not supported with table databases.
98561     *
98562     * @param string $key The string key
98563     * @param mixed $increment The amount to increment
98564     * @param string $type TokyoTyrant::RDB_RECINT or
98565     *   TokyoTyrant::RDB_RECDBL constant. If this parameter is omitted the
98566     *   type is guessed from the {@link increment} parameters type.
98567     * @return void
98568     * @since PECL tokyo_tyrant >= 0.1.0
98569     **/
98570    function add($key, $increment, $type){}
98571
98572    /**
98573     * Generates an unique id inside the table database. In table databases
98574     * rows are referenced using a numeric primary key.
98575     *
98576     * @return int
98577     * @since PECL tokyo_tyrant >= 0.1.0
98578     **/
98579    function genUid(){}
98580
98581    /**
98582     * Gets a row from table database. {@link keys} is a single integer for
98583     * the primary key of the row or an array of integers for multiple rows.
98584     *
98585     * @param mixed $keys The primary key, can be a string or an integer
98586     * @return void
98587     * @since PECL tokyo_tyrant >= 0.1.0
98588     **/
98589    function get($keys){}
98590
98591    /**
98592     * Gets an iterator for iterating all keys / values in the database.
98593     *
98594     * @return TokyoTyrantIterator
98595     **/
98596    function getIterator(){}
98597
98598    /**
98599     * Get a query object to execute searches on the database
98600     *
98601     * @return TokyoTyrantQuery
98602     * @since PECL tokyo_tyrant >= 0.1.0
98603     **/
98604    function getQuery(){}
98605
98606    /**
98607     * Removes records from a table database.
98608     *
98609     * @param mixed $keys A single integer key or an array of integers
98610     * @return void
98611     * @since PECL tokyo_tyrant >= 0.1.0
98612     **/
98613    function out($keys){}
98614
98615    /**
98616     * Puts a new row into the database. This method parameters are {@link
98617     * key} which is the primary key of the row, passing will generate a new
98618     * unique id. {@link value} is an array containing the row contents which
98619     * is usually key value pairs.
98620     *
98621     * @param string $key The primary key of the row
98622     * @param array $columns The row contents
98623     * @return int
98624     * @since PECL tokyo_tyrant >= 0.1.0
98625     **/
98626    function put($key, $columns){}
98627
98628    /**
98629     * This method can be used to add new columns to existing records.
98630     * Existing keys will be left unmodified but any new columns will be
98631     * appended to the row. Passing null as key will generate a new row.
98632     *
98633     * @param string $key The primary key of the row or
98634     * @param array $columns Array of row contents
98635     * @return void
98636     * @since PECL tokyo_tyrant >= 0.1.0
98637     **/
98638    function putCat($key, $columns){}
98639
98640    /**
98641     * Puts a new record into the database. If the key already exists this
98642     * method throws an exception indicating that the records exists.
98643     *
98644     * @param string $key The primary key of the row or
98645     * @param array $columns Array of the row contents
98646     * @return void
98647     * @since PECL tokyo_tyrant >= 0.1.0
98648     **/
98649    function putKeep($key, $columns){}
98650
98651    /**
98652     * This method is not supported on table databases. Calling this method
98653     * through TokyoTyrantTable is considered an error and an
98654     * TokyoTyrantException will be thrown.
98655     *
98656     * @param mixed $keys A string key or an array of key-value pairs
98657     * @param string $value The value in case a string key is used
98658     * @return void
98659     * @since PECL tokyo_tyrant >= 0.1.0
98660     **/
98661    function putNr($keys, $value){}
98662
98663    /**
98664     * This method is not supported on table databases. Calling this method
98665     * through TokyoTyrantTable is considered an error and an
98666     * TokyoTyrantException will be thrown.
98667     *
98668     * @param string $key A string key
98669     * @param string $value The value to concatenate
98670     * @param int $width The width of the record
98671     * @return void
98672     * @since PECL tokyo_tyrant >= 0.1.0
98673     **/
98674    function putShl($key, $value, $width){}
98675
98676    /**
98677     * Sets an index on a specified column. The index type is one of the
98678     * TokyoTyrant::RDBIT_* constants. Passing TokyoTyrant::RDBIT_VOID
98679     * removes the index.
98680     *
98681     * @param string $column The name of the column
98682     * @param int $type The index type
98683     * @return mixed
98684     * @since PECL tokyo_tyrant >= 0.1.0
98685     **/
98686    function setIndex($column, $type){}
98687
98688}
98689/**
98690 * Interface to detect if a class is traversable using .
98691 *
98692 * Abstract base interface that cannot be implemented alone. Instead it
98693 * must be implemented by either or .
98694 *
98695 * This interface has no methods, its only purpose is to be the base
98696 * interface for all traversable classes.
98697 **/
98698interface Traversable {
98699}
98700/**
98701 * Exception thrown when you try to remove an element of an empty
98702 * container
98703 **/
98704class UnderflowException extends RuntimeException {
98705}
98706/**
98707 * Exception thrown if a value does not match with a set of values
98708 **/
98709class UnexpectedValueException extends RuntimeException {
98710}
98711/**
98712 * The XMLReader extension is an XML Pull parser. The reader acts as a
98713 * cursor going forward on the document stream and stopping at each node
98714 * on the way.
98715 **/
98716interface XMLReader {
98717    const ATTRIBUTE = 0;
98718    const CDATA = 0;
98719    const COMMENT = 0;
98720    const DEFAULTATTRS = 0;
98721    const DOC = 0;
98722    const DOC_FRAGMENT = 0;
98723    const DOC_TYPE = 0;
98724    const ELEMENT = 0;
98725    const END_ELEMENT = 0;
98726    const END_ENTITY = 0;
98727    const ENTITY = 0;
98728    const ENTITY_REF = 0;
98729    const LOADDTD = 0;
98730    const NONE = 0;
98731    const NOTATION = 0;
98732    const PI = 0;
98733    const SIGNIFICANT_WHITESPACE = 0;
98734    const SUBST_ENTITIES = 0;
98735    const TEXT = 0;
98736    const VALIDATE = 0;
98737    const WHITESPACE = 0;
98738    const XML_DECLARATION = 0;
98739    /**
98740     * Closes the input the XMLReader object is currently parsing.
98741     *
98742     * @return bool
98743     * @since PHP 5 >= 5.1.2
98744     **/
98745    function close();
98746
98747    /**
98748     * This method copies the current node and returns the appropriate DOM
98749     * object.
98750     *
98751     * @return DOMNode
98752     * @since PHP 5 >= 5.1.2
98753     **/
98754    function expand();
98755
98756    /**
98757     * Returns the value of a named attribute or an empty string if attribute
98758     * does not exist or not positioned on an element node.
98759     *
98760     * @param string $name The name of the attribute.
98761     * @return string
98762     * @since PHP 5 >= 5.1.2
98763     **/
98764    function getAttribute($name);
98765
98766    /**
98767     * Returns the value of an attribute based on its position or an empty
98768     * string if attribute does not exist or not positioned on an element
98769     * node.
98770     *
98771     * @param int $index The position of the attribute.
98772     * @return string
98773     * @since PHP 5 >= 5.1.2
98774     **/
98775    function getAttributeNo($index);
98776
98777    /**
98778     * Returns the value of an attribute by name and namespace URI or an
98779     * empty string if attribute does not exist or not positioned on an
98780     * element node.
98781     *
98782     * @param string $localName The local name.
98783     * @param string $namespaceURI The namespace URI.
98784     * @return string
98785     * @since PHP 5 >= 5.1.2
98786     **/
98787    function getAttributeNs($localName, $namespaceURI);
98788
98789    /**
98790     * Indicates if specified property has been set.
98791     *
98792     * @param int $property One of the parser option constants.
98793     * @return bool
98794     * @since PHP 5 >= 5.1.2
98795     **/
98796    function getParserProperty($property);
98797
98798    /**
98799     * Returns a boolean indicating if the document being parsed is currently
98800     * valid.
98801     *
98802     * @return bool
98803     * @since PHP 5 >= 5.1.2
98804     **/
98805    function isValid();
98806
98807    /**
98808     * Lookup in scope namespace for a given prefix.
98809     *
98810     * @param string $prefix String containing the prefix.
98811     * @return bool
98812     * @since PHP 5 >= 5.1.2
98813     **/
98814    function lookupNamespace($prefix);
98815
98816    /**
98817     * Positions cursor on the named attribute.
98818     *
98819     * @param string $name The name of the attribute.
98820     * @return bool
98821     * @since PHP 5 >= 5.1.2
98822     **/
98823    function moveToAttribute($name);
98824
98825    /**
98826     * Positions cursor on attribute based on its position.
98827     *
98828     * @param int $index The position of the attribute.
98829     * @return bool
98830     * @since PHP 5 >= 5.1.2
98831     **/
98832    function moveToAttributeNo($index);
98833
98834    /**
98835     * Positions cursor on the named attribute in specified namespace.
98836     *
98837     * @param string $localName The local name.
98838     * @param string $namespaceURI The namespace URI.
98839     * @return bool
98840     * @since PHP 5 >= 5.1.2
98841     **/
98842    function moveToAttributeNs($localName, $namespaceURI);
98843
98844    /**
98845     * Moves cursor to the parent Element of current Attribute.
98846     *
98847     * @return bool
98848     * @since PHP 5 >= 5.1.2
98849     **/
98850    function moveToElement();
98851
98852    /**
98853     * Moves cursor to the first Attribute.
98854     *
98855     * @return bool
98856     * @since PHP 5 >= 5.1.2
98857     **/
98858    function moveToFirstAttribute();
98859
98860    /**
98861     * Moves cursor to the next Attribute if positioned on an Attribute or
98862     * moves to first attribute if positioned on an Element.
98863     *
98864     * @return bool
98865     * @since PHP 5 >= 5.1.2
98866     **/
98867    function moveToNextAttribute();
98868
98869    /**
98870     * Positions cursor on the next node skipping all subtrees.
98871     *
98872     * @param string $localname The name of the next node to move to.
98873     * @return bool
98874     * @since PHP 5 >= 5.1.2
98875     **/
98876    function next($localname);
98877
98878    /**
98879     * Set the URI containing the XML document to be parsed.
98880     *
98881     * @param string $URI URI pointing to the document.
98882     * @param string $encoding The document encoding or .
98883     * @param int $options A bitmask of the LIBXML_* constants.
98884     * @return bool
98885     * @since PHP 5 >= 5.1.2
98886     **/
98887    function open($URI, $encoding, $options);
98888
98889    /**
98890     * Moves cursor to the next node in the document.
98891     *
98892     * @return bool
98893     * @since PHP 5 >= 5.1.2
98894     **/
98895    function read();
98896
98897    /**
98898     * Reads the contents of the current node, including child nodes and
98899     * markup.
98900     *
98901     * @return string
98902     * @since PHP 5 >= 5.2.0
98903     **/
98904    function readInnerXML();
98905
98906    /**
98907     * Reads the contents of the current node, including the node itself.
98908     *
98909     * @return string
98910     * @since PHP 5 >= 5.2.0
98911     **/
98912    function readOuterXML();
98913
98914    /**
98915     * Reads the contents of the current node as an string.
98916     *
98917     * @return string
98918     * @since PHP 5 >= 5.2.0
98919     **/
98920    function readString();
98921
98922    /**
98923     * Set or Unset parser option for the parser. The options must be set
98924     * after {@link xmlreader-open} or {@link xmlreader-xml} are called and
98925     * before the first {@link xmlreader-read} call.
98926     *
98927     * @param int $property One of the parser option constants.
98928     * @param bool $value If set to the option will be enabled otherwise
98929     *   will be disabled.
98930     * @return bool
98931     * @since PHP 5 >= 5.1.2
98932     **/
98933    function setParserProperty($property, $value);
98934
98935    /**
98936     * Set the filename or URI for the RelaxNG Schema to use for validation.
98937     *
98938     * @param string $filename filename or URI pointing to a RelaxNG
98939     *   Schema.
98940     * @return bool
98941     * @since PHP 5 >= 5.2.0
98942     **/
98943    function setRelaxNGSchema($filename);
98944
98945    /**
98946     * Set the data containing a RelaxNG Schema to use for validation.
98947     *
98948     * @param string $source String containing the RelaxNG Schema.
98949     * @return bool
98950     * @since PHP 5 >= 5.1.2
98951     **/
98952    function setRelaxNGSchemaSource($source);
98953
98954    /**
98955     * Use W3C XSD schema to validate the document as it is processed.
98956     * Activation is only possible before the first Read().
98957     *
98958     * @param string $filename The filename of the XSD schema.
98959     * @return bool
98960     * @since PHP 5 >= 5.2.0
98961     **/
98962    function setSchema($filename);
98963
98964    /**
98965     * Set the data containing the XML to parse.
98966     *
98967     * @param string $source String containing the XML to be parsed.
98968     * @param string $encoding The document encoding or .
98969     * @param int $options A bitmask of the LIBXML_* constants.
98970     * @return bool
98971     * @since PHP 5 >= 5.1.2
98972     **/
98973    function xml($source, $encoding, $options);
98974
98975}
98976class XMLWriter {
98977    /**
98978     * Ends the current attribute.
98979     *
98980     * @return bool
98981     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
98982     **/
98983    function endAttribute(){}
98984
98985    /**
98986     * Ends the current CDATA section.
98987     *
98988     * @return bool
98989     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
98990     **/
98991    function endCData(){}
98992
98993    /**
98994     * Ends the current comment.
98995     *
98996     * @return bool
98997     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 1.0.0
98998     **/
98999    function endComment(){}
99000
99001    /**
99002     * Ends the current document.
99003     *
99004     * @return bool
99005     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99006     **/
99007    function endDocument(){}
99008
99009    /**
99010     * Ends the DTD of the document.
99011     *
99012     * @return bool
99013     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99014     **/
99015    function endDTD(){}
99016
99017    /**
99018     * Ends the current DTD attribute list.
99019     *
99020     * @return bool
99021     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99022     **/
99023    function endDTDAttlist(){}
99024
99025    /**
99026     * Ends the current DTD element.
99027     *
99028     * @return bool
99029     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99030     **/
99031    function endDTDElement(){}
99032
99033    /**
99034     * Ends the current DTD entity.
99035     *
99036     * @return bool
99037     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99038     **/
99039    function endDTDEntity(){}
99040
99041    /**
99042     * Ends the current element.
99043     *
99044     * @return bool
99045     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99046     **/
99047    function endElement(){}
99048
99049    /**
99050     * Ends the current processing instruction.
99051     *
99052     * @return bool
99053     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99054     **/
99055    function endPI(){}
99056
99057    /**
99058     * Flushes the current buffer.
99059     *
99060     * @param bool $empty Whether to empty the buffer or no. Default is .
99061     * @return mixed
99062     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 1.0.0
99063     **/
99064    function flush($empty){}
99065
99066    /**
99067     * End the current xml element. Writes an end tag even if the element is
99068     * empty.
99069     *
99070     * @return bool
99071     * @since PHP 5 >= 5.2.0, PECL xmlwriter >= 2.0.4
99072     **/
99073    function fullEndElement(){}
99074
99075    /**
99076     * Creates a new XMLWriter using memory for string output.
99077     *
99078     * @return bool
99079     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99080     **/
99081    function openMemory(){}
99082
99083    /**
99084     * Creates a new XMLWriter using {@link uri} for the output.
99085     *
99086     * @param string $uri The URI of the resource for the output.
99087     * @return bool
99088     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99089     **/
99090    function openURI($uri){}
99091
99092    /**
99093     * Returns the current buffer.
99094     *
99095     * @param bool $flush Whether to flush the output buffer or no. Default
99096     *   is .
99097     * @return string
99098     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99099     **/
99100    function outputMemory($flush){}
99101
99102    /**
99103     * Toggles indentation on or off.
99104     *
99105     * @param bool $indent Whether indentation is enabled.
99106     * @return bool
99107     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99108     **/
99109    function setIndent($indent){}
99110
99111    /**
99112     * Sets the string which will be used to indent each element/attribute of
99113     * the resulting xml.
99114     *
99115     * @param string $indentString The indentation string.
99116     * @return bool
99117     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99118     **/
99119    function setIndentString($indentString){}
99120
99121    /**
99122     * Starts an attribute.
99123     *
99124     * @param string $name The attribute name.
99125     * @return bool
99126     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99127     **/
99128    function startAttribute($name){}
99129
99130    /**
99131     * Starts a namespaced attribute.
99132     *
99133     * @param string $prefix The namespace prefix.
99134     * @param string $name The attribute name.
99135     * @param string $uri The namespace URI.
99136     * @return bool
99137     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99138     **/
99139    function startAttributeNS($prefix, $name, $uri){}
99140
99141    /**
99142     * Starts a CDATA.
99143     *
99144     * @return bool
99145     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99146     **/
99147    function startCData(){}
99148
99149    /**
99150     * Starts a comment.
99151     *
99152     * @return bool
99153     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 1.0.0
99154     **/
99155    function startComment(){}
99156
99157    /**
99158     * Starts a document.
99159     *
99160     * @param string $version The version number of the document as part of
99161     *   the XML declaration. Defaults to 1.0.
99162     * @param string $encoding The encoding of the document as part of the
99163     *   XML declaration. by default.
99164     * @param string $standalone yes or no.
99165     * @return bool
99166     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99167     **/
99168    function startDocument($version, $encoding, $standalone){}
99169
99170    /**
99171     * Starts a DTD.
99172     *
99173     * @param string $qualifiedName The qualified name of the document type
99174     *   to create.
99175     * @param string $publicId The external subset public identifier.
99176     * @param string $systemId The external subset system identifier.
99177     * @return bool
99178     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99179     **/
99180    function startDTD($qualifiedName, $publicId, $systemId){}
99181
99182    /**
99183     * Starts a DTD attribute list.
99184     *
99185     * @param string $name The attribute list name.
99186     * @return bool
99187     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99188     **/
99189    function startDTDAttlist($name){}
99190
99191    /**
99192     * Starts a DTD element.
99193     *
99194     * @param string $qualifiedName The qualified name of the document type
99195     *   to create.
99196     * @return bool
99197     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99198     **/
99199    function startDTDElement($qualifiedName){}
99200
99201    /**
99202     * Starts a DTD entity.
99203     *
99204     * @param string $name The name of the entity.
99205     * @param bool $isparam
99206     * @return bool
99207     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99208     **/
99209    function startDTDEntity($name, $isparam){}
99210
99211    /**
99212     * Starts an element.
99213     *
99214     * @param string $name The element name.
99215     * @return bool
99216     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99217     **/
99218    function startElement($name){}
99219
99220    /**
99221     * Starts a namespaced element.
99222     *
99223     * @param string $prefix The namespace prefix.
99224     * @param string $name The element name.
99225     * @param string $uri The namespace URI.
99226     * @return bool
99227     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99228     **/
99229    function startElementNS($prefix, $name, $uri){}
99230
99231    /**
99232     * Starts a processing instruction tag.
99233     *
99234     * @param string $target The target of the processing instruction.
99235     * @return bool
99236     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99237     **/
99238    function startPI($target){}
99239
99240    /**
99241     * Writes a text.
99242     *
99243     * @param string $content The contents of the text.
99244     * @return bool
99245     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99246     **/
99247    function text($content){}
99248
99249    /**
99250     * Writes a full attribute.
99251     *
99252     * @param string $name The name of the attribute.
99253     * @param string $value The value of the attribute.
99254     * @return bool
99255     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99256     **/
99257    function writeAttribute($name, $value){}
99258
99259    /**
99260     * Writes a full namespaced attribute.
99261     *
99262     * @param string $prefix The namespace prefix.
99263     * @param string $name The attribute name.
99264     * @param string $uri The namespace URI.
99265     * @param string $content The attribute value.
99266     * @return bool
99267     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99268     **/
99269    function writeAttributeNS($prefix, $name, $uri, $content){}
99270
99271    /**
99272     * Writes a full CDATA.
99273     *
99274     * @param string $content The contents of the CDATA.
99275     * @return bool
99276     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99277     **/
99278    function writeCData($content){}
99279
99280    /**
99281     * Writes a full comment.
99282     *
99283     * @param string $content The contents of the comment.
99284     * @return bool
99285     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99286     **/
99287    function writeComment($content){}
99288
99289    /**
99290     * Writes a full DTD.
99291     *
99292     * @param string $name The DTD name.
99293     * @param string $publicId The external subset public identifier.
99294     * @param string $systemId The external subset system identifier.
99295     * @param string $subset The content of the DTD.
99296     * @return bool
99297     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99298     **/
99299    function writeDTD($name, $publicId, $systemId, $subset){}
99300
99301    /**
99302     * Writes a DTD attribute list.
99303     *
99304     * @param string $name The name of the DTD attribute list.
99305     * @param string $content The content of the DTD attribute list.
99306     * @return bool
99307     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99308     **/
99309    function writeDTDAttlist($name, $content){}
99310
99311    /**
99312     * Writes a full DTD element.
99313     *
99314     * @param string $name The name of the DTD element.
99315     * @param string $content The content of the element.
99316     * @return bool
99317     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99318     **/
99319    function writeDTDElement($name, $content){}
99320
99321    /**
99322     * Writes a full DTD entity.
99323     *
99324     * @param string $name The name of the entity.
99325     * @param string $content The content of the entity.
99326     * @param bool $pe
99327     * @param string $pubid
99328     * @param string $sysid
99329     * @param string $ndataid
99330     * @return bool
99331     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99332     **/
99333    function writeDTDEntity($name, $content, $pe, $pubid, $sysid, $ndataid){}
99334
99335    /**
99336     * Writes a full element tag.
99337     *
99338     * @param string $name The element name.
99339     * @param string $content The element contents.
99340     * @return bool
99341     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99342     **/
99343    function writeElement($name, $content){}
99344
99345    /**
99346     * Writes a full namespaced element tag.
99347     *
99348     * @param string $prefix The namespace prefix.
99349     * @param string $name The element name.
99350     * @param string $uri The namespace URI.
99351     * @param string $content The element contents.
99352     * @return bool
99353     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99354     **/
99355    function writeElementNS($prefix, $name, $uri, $content){}
99356
99357    /**
99358     * Writes a processing instruction.
99359     *
99360     * @param string $target The target of the processing instruction.
99361     * @param string $content The content of the processing instruction.
99362     * @return bool
99363     * @since PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0
99364     **/
99365    function writePI($target, $content){}
99366
99367    /**
99368     * Writes a raw xml text.
99369     *
99370     * @param string $content The text string to write.
99371     * @return bool
99372     * @since PHP 5 >= 5.2.0, PECL xmlwriter >= 2.0.4
99373     **/
99374    function writeRaw($content){}
99375
99376}
99377class XPathContext {
99378    /**
99379     * The optional {@link contextnode} can be specified for doing relative
99380     * XPath queries.
99381     *
99382     * See also {@link xpath_new_context}.
99383     *
99384     * @param string $xpath_expression
99385     * @param domnode $contextnode
99386     * @return XPathObject
99387     **/
99388    function xpath_eval($xpath_expression, $contextnode){}
99389
99390    /**
99391     * {@link xpath_eval_expression} Example
99392     *
99393     * <?php
99394     *
99395     * include("example.inc");
99396     *
99397     * if (!$dom = domxml_open_mem($xmlstr)) { echo "Error while parsing the
99398     * document\n"; exit; }
99399     *
99400     * $xpath = xpath_new_context($dom);
99401     * var_dump(xpath_eval_expression($xpath, '/chapter/@language'));
99402     *
99403     * ?>
99404     *
99405     * object(XPathObject)(2) { ["type"]=> int(1) ["nodeset"]=> array(1) {
99406     * [0]=> object(domattribute)(5) { ["type"]=> int(2) ["name"]=> string(8)
99407     * "language" ["value"]=> string(2) "en" [0]=> int(7) [1]=>
99408     * int(138004256) } } }
99409     *
99410     * See also {@link xpath_eval}.
99411     *
99412     * @param string $expression
99413     * @param domnode $contextnode
99414     * @return XPathObject
99415     **/
99416    function xpath_eval_expression($expression, $contextnode){}
99417
99418    /**
99419     * @param string $eval_str
99420     * @param domnode $contextnode
99421     * @return int
99422     **/
99423    function xptr_eval($eval_str, $contextnode){}
99424
99425}
99426/**
99427 * Description of the class.
99428 **/
99429class XSLTProcessor {
99430    /**
99431     * Gets a parameter if previously set by {@link
99432     * XSLTProcessor::setParameter}.
99433     *
99434     * @param string $namespaceURI The namespace URI of the XSLT parameter.
99435     * @param string $localName The local name of the XSLT parameter.
99436     * @return string
99437     * @since PHP 5
99438     **/
99439    function getParameter($namespaceURI, $localName){}
99440
99441    /**
99442     * This method determine if PHP was built with the EXSLT library.
99443     *
99444     * @return bool
99445     * @since PHP 5 >= 5.0.4
99446     **/
99447    function hasExsltSupport(){}
99448
99449    /**
99450     * This method import the stylesheet into the XSLTProcessor for
99451     * transformations.
99452     *
99453     * @param object $stylesheet The imported style sheet as a DOMDocument
99454     *   or SimpleXMLElement object.
99455     * @return void
99456     * @since PHP 5
99457     **/
99458    function importStylesheet($stylesheet){}
99459
99460    /**
99461     * This method enables the ability to use PHP functions as XSLT functions
99462     * within XSL stylesheets.
99463     *
99464     * @param mixed $restrict Use this parameter to only allow certain
99465     *   functions to be called from XSLT. This parameter can be either a
99466     *   string (a function name) or an array of functions.
99467     * @return void
99468     * @since PHP 5 >= 5.0.4
99469     **/
99470    function registerPHPFunctions($restrict){}
99471
99472    /**
99473     * Removes a parameter, if set. This will make the processor use the
99474     * default value for the parameter as specified in the stylesheet.
99475     *
99476     * @param string $namespaceURI The namespace URI of the XSLT parameter.
99477     * @param string $localName The local name of the XSLT parameter.
99478     * @return bool
99479     * @since PHP 5
99480     **/
99481    function removeParameter($namespaceURI, $localName){}
99482
99483    /**
99484     * Sets the value of one or more parameters to be used in subsequent
99485     * transformations with XSLTProcessor. If the parameter doesn't exist in
99486     * the stylesheet it will be ignored.
99487     *
99488     * @param string $namespace The namespace URI of the XSLT parameter.
99489     * @param string $name The local name of the XSLT parameter.
99490     * @param string $value The new value of the XSLT parameter.
99491     * @return bool
99492     * @since PHP 5
99493     **/
99494    function setParameter($namespace, $name, $value){}
99495
99496    /**
99497     * Sets the file to output profiling information when processing a
99498     * stylesheet.
99499     *
99500     * @param string $filename Path to the file to dump profiling
99501     *   information.
99502     * @return bool
99503     * @since PHP >= 5.3.0
99504     **/
99505    function setProfiling($filename){}
99506
99507    /**
99508     * Transforms the source node to a DOMDocument applying the stylesheet
99509     * given by the {@link XSLTProcessor::importStylesheet} method.
99510     *
99511     * @param DOMNode $doc The node to be transformed.
99512     * @return DOMDocument
99513     * @since PHP 5
99514     **/
99515    function transformToDoc($doc){}
99516
99517    /**
99518     * Transforms the source node to an URI applying the stylesheet given by
99519     * the {@link XSLTProcessor::importStylesheet} method.
99520     *
99521     * @param DOMDocument $doc The transformed document.
99522     * @param string $uri
99523     * @return int
99524     * @since PHP 5
99525     **/
99526    function transformToURI($doc, $uri){}
99527
99528    /**
99529     * Transforms the source node to a string applying the stylesheet given
99530     * by the {@link xsltprocessor::importStylesheet} method.
99531     *
99532     * @param DOMDocument $doc The transformed document.
99533     * @return string
99534     * @since PHP 5
99535     **/
99536    function transformToXML($doc){}
99537
99538}
99539/**
99540 * A file archive, compressed with Zip.
99541 **/
99542interface ZIPARCHIVE {
99543    const CHECKCONS = 0;
99544    const CM_BZIP2 = 0;
99545    const CM_DEFAULT = 0;
99546    const CM_DEFLATE = 0;
99547    const CM_DEFLATE64 = 0;
99548    const CM_IMPLODE = 0;
99549    const CM_PKWARE_IMPLODE = 0;
99550    const CM_REDUCE_1 = 0;
99551    const CM_REDUCE_2 = 0;
99552    const CM_REDUCE_3 = 0;
99553    const CM_REDUCE_4 = 0;
99554    const CM_SHRINK = 0;
99555    const CM_STORE = 0;
99556    const CREATE = 0;
99557    const ER_CHANGED = '';
99558    const ER_CLOSE = 0;
99559    const ER_COMPNOTSUPP = 0;
99560    const ER_CRC = 0;
99561    const ER_DELETED = 0;
99562    const ER_EOF = 0;
99563    const ER_EXISTS = 0;
99564    const ER_INCONS = 0;
99565    const ER_INTERNAL = 0;
99566    const ER_INVAL = 0;
99567    const ER_MEMORY = 0;
99568    const ER_MULTIDISK = 0;
99569    const ER_NOENT = 0;
99570    const ER_NOZIP = 0;
99571    const ER_OK = 0;
99572    const ER_OPEN = 0;
99573    const ER_READ = 0;
99574    const ER_REMOVE = 0;
99575    const ER_RENAME = 0;
99576    const ER_SEEK = 0;
99577    const ER_TMPOPEN = 0;
99578    const ER_WRITE = 0;
99579    const ER_ZIPCLOSED = 0;
99580    const ER_ZLIB = 0;
99581    const EXCL = 0;
99582    const FL_COMPRESSED = 0;
99583    const FL_NOCASE = 0;
99584    const FL_NODIR = 0;
99585    const FL_UNCHANGED = 0;
99586    const OVERWRITE = 0;
99587    /**
99588     * Adds an empty directory in the archive.
99589     *
99590     * @param string $dirname The directory to add.
99591     * @return bool
99592     * @since PHP 5 >= 5.2.0, PECL zip >= 1.8.0
99593     **/
99594    function addEmptyDir($dirname);
99595
99596    /**
99597     * Adds a file to a ZIP archive from a given path.
99598     *
99599     * @param string $filename The path to the file to add.
99600     * @param string $localname local name inside ZIP archive.
99601     * @return bool
99602     * @since PHP 5 >= 5.2.0, PECL zip >= 1.1.0
99603     **/
99604    function addFile($filename, $localname);
99605
99606    /**
99607     * Add a file to a ZIP archive using its contents.
99608     *
99609     * @param string $localname The name of the entry to create.
99610     * @param string $contents The contents to use to create the entry. It
99611     *   is used in a binary safe mode.
99612     * @return bool
99613     * @since PHP 5 >= 5.2.0, PECL zip >= 1.1.0
99614     **/
99615    function addFromString($localname, $contents);
99616
99617    /**
99618     * Close opened or created archive and save changes. This method is
99619     * automatically called at the end of the script.
99620     *
99621     * @return bool
99622     * @since PHP 5 >= 5.2.0, PECL zip >= 1.1.0
99623     **/
99624    function close();
99625
99626    /**
99627     * Delete an entry in the archive using its index.
99628     *
99629     * @param int $index Index of the entry to delete.
99630     * @return bool
99631     * @since PHP 5 >= 5.2.0, PECL zip >= 1.5.0
99632     **/
99633    function deleteIndex($index);
99634
99635    /**
99636     * Delete an entry in the archive using its name.
99637     *
99638     * @param string $name Name of the entry to delete.
99639     * @return bool
99640     * @since PHP 5 >= 5.2.0, PECL zip >= 1.5.0
99641     **/
99642    function deleteName($name);
99643
99644    /**
99645     * Extract the complete archive or the given files to the specified
99646     * destination.
99647     *
99648     * @param string $destination Location where to extract the files.
99649     * @param mixed $entries The entries to extract. It accepts either a
99650     *   single entry name or an array of names.
99651     * @return bool
99652     * @since PHP 5 >= 5.2.0, PECL zip >= 1.1.0
99653     **/
99654    function extractTo($destination, $entries);
99655
99656    /**
99657     * Returns the Zip archive comment.
99658     *
99659     * @return string
99660     * @since PHP 5 >= 5.2.0, PECL zip >= 1.1.0
99661     **/
99662    function getArchiveComment();
99663
99664    /**
99665     * Returns the comment of an entry using the entry index.
99666     *
99667     * @param int $index Index of the entry
99668     * @param int $flags If flags is set to ZIPARCHIVE::FL_UNCHANGED, the
99669     *   original unchanged comment is returned.
99670     * @return string
99671     * @since PHP 5 >= 5.2.0, PECL zip >= 1.4.0
99672     **/
99673    function getCommentIndex($index, $flags);
99674
99675    /**
99676     * Returns the comment of an entry using the entry name.
99677     *
99678     * @param string $name Name of the entry
99679     * @param int $flags If flags is set to ZIPARCHIVE::FL_UNCHANGED, the
99680     *   original unchanged comment is returned.
99681     * @return string
99682     * @since PHP 5 >= 5.2.0, PECL zip >= 1.4.0
99683     **/
99684    function getCommentName($name, $flags);
99685
99686    /**
99687     * Returns the entry contents using its index.
99688     *
99689     * @param int $index Index of the entry
99690     * @param int $flags The flags to use to open the archive. the
99691     *   following values may be ORed to it. ZIPARCHIVE::FL_UNCHANGED
99692     *   ZIPARCHIVE::FL_COMPRESSED
99693     * @return mixed
99694     * @since PHP 5 >= 5.2.0, PECL zip >= 1.3.0
99695     **/
99696    function getFromIndex($index, $flags);
99697
99698    /**
99699     * Returns the entry contents using its name.
99700     *
99701     * @param string $name Name of the entry
99702     * @param int $flags The flags to use to open the archive. the
99703     *   following values may be ORed to it. ZIPARCHIVE::FL_UNCHANGED
99704     *   ZIPARCHIVE::FL_COMPRESSED
99705     * @return mixed
99706     * @since PHP 5 >= 5.2.0, PECL zip >= 1.1.0
99707     **/
99708    function getFromName($name, $flags);
99709
99710    /**
99711     * Returns the name of an entry using its index.
99712     *
99713     * @param int $index Index of the entry.
99714     * @return string
99715     * @since PHP 5 >= 5.2.0, PECL zip >= 1.5.0
99716     **/
99717    function getNameIndex($index);
99718
99719    /**
99720     * Returns the status error message, system and/or zip messages.
99721     *
99722     * @return string
99723     * @since PHP 5 >= 5.2.7
99724     **/
99725    function getStatusString();
99726
99727    /**
99728     * Get a file handler to the entry defined by its name. For now it only
99729     * supports read operations.
99730     *
99731     * @param string $name The name of the entry to use.
99732     * @return resource
99733     * @since PHP 5 >= 5.2.0, PECL zip >= 1.1.0
99734     **/
99735    function getStream($name);
99736
99737    /**
99738     * Locates an entry using its name.
99739     *
99740     * @param string $name The name of the entry to look up
99741     * @param int $flags The flags are specified by ORing the following
99742     *   values, or 0 for none of them. ZIPARCHIVE::FL_NOCASE
99743     *   ZIPARCHIVE::FL_NODIR
99744     * @return mixed
99745     * @since PHP 5 >= 5.2.0, PECL zip >= 1.5.0
99746     **/
99747    function locateName($name, $flags);
99748
99749    /**
99750     * Opens a new zip archive for reading, writing or modifying.
99751     *
99752     * @param string $filename The file name of the ZIP archive to open.
99753     * @param int $flags The mode to use to open the archive.
99754     *   ZIPARCHIVE::OVERWRITE ZIPARCHIVE::CREATE ZIPARCHIVE::EXCL
99755     *   ZIPARCHIVE::CHECKCONS
99756     * @return mixed
99757     * @since PHP 5 >= 5.2.0, PECL zip >= 1.1.0
99758     **/
99759    function open($filename, $flags);
99760
99761    /**
99762     * Renames an entry defined by its index.
99763     *
99764     * @param int $index Index of the entry to rename.
99765     * @param string $newname New name.
99766     * @return bool
99767     * @since PHP 5 >= 5.2.0, PECL zip >= 1.5.0
99768     **/
99769    function renameIndex($index, $newname);
99770
99771    /**
99772     * Renames an entry defined by its name.
99773     *
99774     * @param string $name Name of the entry to rename.
99775     * @param string $newname New name.
99776     * @return bool
99777     * @since PHP 5 >= 5.2.0, PECL zip >= 1.5.0
99778     **/
99779    function renameName($name, $newname);
99780
99781    /**
99782     * Set the comment of a ZIP archive.
99783     *
99784     * @param string $comment The contents of the comment.
99785     * @return mixed
99786     * @since PHP 5 >= 5.2.0, PECL zip >= 1.4.0
99787     **/
99788    function setArchiveComment($comment);
99789
99790    /**
99791     * Set the comment of an entry defined by its index.
99792     *
99793     * @param int $index Index of the entry.
99794     * @param string $comment The contents of the comment.
99795     * @return mixed
99796     * @since PHP 5 >= 5.2.0, PECL zip >= 1.4.0
99797     **/
99798    function setCommentIndex($index, $comment);
99799
99800    /**
99801     * Set the comment of an entry defined by its name.
99802     *
99803     * @param string $name Name of the entry.
99804     * @param string $comment The contents of the comment.
99805     * @return mixed
99806     * @since PHP 5 >= 5.2.0, PECL zip >= 1.4.0
99807     **/
99808    function setCommentName($name, $comment);
99809
99810    /**
99811     * The function obtains information about the entry defined by its index.
99812     *
99813     * @param int $index Index of the entry
99814     * @param int $flags ZIPARCHIVE::FL_UNCHANGED may be ORed to it to
99815     *   request information about the original file in the archive, ignoring
99816     *   any changes made.
99817     * @return mixed
99818     * @since PHP 5 >= 5.2.0, PECL zip >= 1.1.0
99819     **/
99820    function statIndex($index, $flags);
99821
99822    /**
99823     * The function obtains information about the entry defined by its name.
99824     *
99825     * @param name $name Name of the entry
99826     * @param int $flags The flags argument specifies how the name lookup
99827     *   should be done. Also, ZIPARCHIVE::FL_UNCHANGED may be ORed to it to
99828     *   request information about the original file in the archive, ignoring
99829     *   any changes made. ZIPARCHIVE::FL_NOCASE ZIPARCHIVE::FL_NODIR
99830     *   ZIPARCHIVE::FL_UNCHANGED
99831     * @return mixed
99832     * @since PHP 5 >= 5.2.0, PECL zip >= 1.5.0
99833     **/
99834    function statName($name, $flags);
99835
99836    /**
99837     * Undo all changes done in the archive.
99838     *
99839     * @return mixed
99840     * @since PHP 5 >= 5.2.0, PECL zip >= 1.1.0
99841     **/
99842    function unchangeAll();
99843
99844    /**
99845     * Revert all global changes to the archive archive. For now, this only
99846     * reverts archive comment changes.
99847     *
99848     * @return mixed
99849     * @since PHP 5 >= 5.2.0, PECL zip >= 1.1.0
99850     **/
99851    function unchangeArchive();
99852
99853    /**
99854     * Revert all changes done to an entry at the given index.
99855     *
99856     * @param int $index Index of the entry.
99857     * @return mixed
99858     * @since PHP 5 >= 5.2.0, PECL zip >= 1.1.0
99859     **/
99860    function unchangeIndex($index);
99861
99862    /**
99863     * Revert all changes done to an entry.
99864     *
99865     * @param string $name Name of the entry.
99866     * @return mixed
99867     * @since PHP 5 >= 5.2.0, PECL zip >= 1.5.0
99868     **/
99869    function unchangeName($name);
99870
99871}
99872define('ABDAY_1', 0);
99873define('ABDAY_2', 0);
99874define('ABDAY_3', 0);
99875define('ABDAY_4', 0);
99876define('ABDAY_5', 0);
99877define('ABDAY_6', 0);
99878define('ABDAY_7', 0);
99879define('ABMON_1', 0);
99880define('ABMON_2', 0);
99881define('ABMON_3', 0);
99882define('ABMON_4', 0);
99883define('ABMON_5', 0);
99884define('ABMON_6', 0);
99885define('ABMON_7', 0);
99886define('ABMON_8', 0);
99887define('ABMON_9', 0);
99888define('ABMON_10', 0);
99889define('ABMON_11', 0);
99890define('ABMON_12', 0);
99891define('AF_INET', 0);
99892define('AF_INET6', 0);
99893define('AF_UNIX', 0);
99894define('ALC_FREQUENCY', 0);
99895define('ALC_REFRESH', 0);
99896define('ALC_SYNC', 0);
99897define('ALT_DIGITS', 0);
99898define('AL_BITS', 0);
99899define('AL_BUFFER', 0);
99900define('AL_CHANNELS', 0);
99901define('AL_CONE_INNER_ANGLE', 0);
99902define('AL_CONE_OUTER_ANGLE', 0);
99903define('AL_CONE_OUTER_GAIN', 0);
99904define('AL_DIRECTION', 0);
99905define('AL_FALSE', 0);
99906define('AL_FORMAT_MONO8', 0);
99907define('AL_FORMAT_MONO16', 0);
99908define('AL_FORMAT_STEREO8', 0);
99909define('AL_FORMAT_STEREO16', 0);
99910define('AL_FREQUENCY', 0);
99911define('AL_GAIN', 0);
99912define('AL_INITIAL', 0);
99913define('AL_LOOPING', 0);
99914define('AL_MAX_DISTANCE', 0);
99915define('AL_MAX_GAIN', 0);
99916define('AL_MIN_GAIN', 0);
99917define('AL_ORIENTATION', 0);
99918define('AL_PAUSED', 0);
99919define('AL_PITCH', 0);
99920define('AL_PLAYING', 0);
99921define('AL_POSITION', 0);
99922define('AL_REFERENCE_DISTANCE', 0);
99923define('AL_ROLLOFF_FACTOR', 0);
99924define('AL_SIZE', 0);
99925define('AL_SOURCE_RELATIVE', 0);
99926define('AL_SOURCE_STATE', 0);
99927define('AL_STOPPED', 0);
99928define('AL_TRUE', 0);
99929define('AL_VELOCITY', 0);
99930define('AM_STR', 0);
99931define('APACHE_MAP', 0);
99932define('APD_VERSION', '');
99933define('ARGS_TRACE', 0);
99934define('ASSERT_ACTIVE', 0);
99935define('ASSERT_BAIL', 0);
99936define('ASSERT_CALLBACK', 0);
99937define('ASSERT_QUIET_EVAL', 0);
99938define('ASSERT_QUITE_EVAL', 0);
99939define('ASSERT_WARNING', 0);
99940define('ASSIGNMENT_TRACE', 0);
99941define('BBCODE_ARG_DOUBLE_QUOTE', 0);
99942define('BBCODE_ARG_HTML_QUOTE', 0);
99943define('BBCODE_ARG_QUOTE_ESCAPING', 0);
99944define('BBCODE_ARG_SINGLE_QUOTE', 0);
99945define('BBCODE_AUTO_CORRECT', 0);
99946define('BBCODE_CORRECT_REOPEN_TAGS', 0);
99947define('BBCODE_DEFAULT_SMILEYS_OFF', 0);
99948define('BBCODE_DEFAULT_SMILEYS_ON', 0);
99949define('BBCODE_DISABLE_TREE_BUILD', 0);
99950define('BBCODE_FLAGS_ARG_PARSING', 0);
99951define('BBCODE_FLAGS_CDATA_NOT_ALLOWED', 0);
99952define('BBCODE_FLAGS_DENY_REOPEN_CHILD', 0);
99953define('BBCODE_FLAGS_ONE_OPEN_PER_LEVEL', 0);
99954define('BBCODE_FLAGS_REMOVE_IF_EMPTY', 0);
99955define('BBCODE_FLAGS_SMILEYS_OFF', 0);
99956define('BBCODE_FLAGS_SMILEYS_ON', 0);
99957define('BBCODE_FORCE_SMILEYS_OFF', 0);
99958define('BBCODE_SET_FLAGS_ADD', 0);
99959define('BBCODE_SET_FLAGS_REMOVE', 0);
99960define('BBCODE_SET_FLAGS_SET', 0);
99961define('BBCODE_SMILEYS_CASE_INSENSITIVE', 0);
99962define('BBCODE_TYPE_ARG', 0);
99963define('BBCODE_TYPE_NOARG', 0);
99964define('BBCODE_TYPE_OPTARG', 0);
99965define('BBCODE_TYPE_ROOT', 0);
99966define('BBCODE_TYPE_SINGLE', 0);
99967define('BSDown', 0.0);
99968define('BSHitTest', 0.0);
99969define('BSOver', 0.0);
99970define('BSUp', 0.0);
99971define('BUS_ADRALN', 0);
99972define('BUS_ADRERR', 0);
99973define('BUS_OBJERR', 0);
99974define('ButtonEnter', 0);
99975define('ButtonExit', 0);
99976define('CAL_DOW_DAYNO', 0);
99977define('CAL_DOW_LONG', 0);
99978define('CAL_DOW_SHORT', 0);
99979define('CAL_FRENCH', 0);
99980define('CAL_GREGORIAN', 0);
99981define('CAL_JEWISH', 0);
99982define('CAL_JULIAN', 0);
99983define('CAL_MONTH_FRENCH', 0);
99984define('CAL_MONTH_GREGORIAN_LONG', 0);
99985define('CAL_MONTH_GREGORIAN_SHORT', 0);
99986define('CAL_MONTH_JEWISH', 0);
99987define('CAL_MONTH_JULIAN_LONG', 0);
99988define('CAL_MONTH_JULIAN_SHORT', 0);
99989define('CAL_NUM_CALS', 0);
99990define('CASE_LOWER', 0);
99991define('CASE_UPPER', 0);
99992define('CHAR_MAX', 0);
99993define('CLASSKIT_ACC_PRIVATE', 0);
99994define('CLASSKIT_ACC_PROTECTED', 0);
99995define('CLASSKIT_ACC_PUBLIC', 0);
99996define('CLASSKIT_AGGREGATE_OVERRIDE', 0);
99997define('CLASSKIT_VERSION', '');
99998define('CLD_CONTINUED', 0);
99999define('CLD_DUMPED', 0);
100000define('CLD_EXITED', 0);
100001define('CLD_KILLED', 0);
100002define('CLD_STOPPED', 0);
100003define('CLD_TRAPPED', 0);
100004define('CLSCTX_ALL', 0);
100005/**
100006 * The code that manages objects of this class is an in-process handler.
100007 * This is a DLL that runs in the client process and implements
100008 * client-side structures of this class when instances of the class are
100009 * accessed remotely.
100010 **/
100011define('CLSCTX_INPROC_HANDLER', 0);
100012/**
100013 * The code that creates and manages objects of this class is a DLL that
100014 * runs in the same process as the caller of the function specifying the
100015 * class context.
100016 **/
100017define('CLSCTX_INPROC_SERVER', 0);
100018/**
100019 * The EXE code that creates and manages objects of this class runs on
100020 * same machine but is loaded in a separate process space.
100021 **/
100022define('CLSCTX_LOCAL_SERVER', 0);
100023/**
100024 * A remote context. The code that creates and manages objects of this
100025 * class is run on a different computer.
100026 **/
100027define('CLSCTX_REMOTE_SERVER', 0);
100028define('CLSCTX_SERVER', 0);
100029define('CL_EXPUNGE', 0);
100030define('CODESET', 0);
100031define('CONNECTION_ABORTED', 0);
100032define('CONNECTION_NORMAL', 0);
100033define('CONNECTION_TIMEOUT', 0);
100034define('COUNT_NORMAL', 0);
100035define('COUNT_RECURSIVE', 0);
100036/**
100037 * Default to ANSI code page.
100038 **/
100039define('CP_ACP', 0);
100040/**
100041 * Macintosh code page.
100042 **/
100043define('CP_MACCP', 0);
100044define('CP_MOVE', 0);
100045/**
100046 * Default to OEM code page.
100047 **/
100048define('CP_OEMCP', 0);
100049define('CP_SYMBOL', 0);
100050/**
100051 * Current thread's ANSI code page
100052 **/
100053define('CP_THREAD_ACP', 0);
100054define('CP_UID', 0);
100055/**
100056 * Unicode (UTF-7).
100057 **/
100058define('CP_UTF7', 0);
100059/**
100060 * Unicode (UTF-8).
100061 **/
100062define('CP_UTF8', 0);
100063define('CREDITS_ALL', 0);
100064define('CREDITS_DOCS', 0);
100065define('CREDITS_FULLPAGE', 0);
100066define('CREDITS_GENERAL', 0);
100067define('CREDITS_GROUP', 0);
100068define('CREDITS_MODULES', 0);
100069define('CREDITS_QA', 0);
100070define('CREDITS_SAPI', 0);
100071define('CRNCYSTR', 0);
100072define('CRYPT_BLOWFISH', 0);
100073define('CRYPT_EXT_DES', 0);
100074define('CRYPT_MD5', 0);
100075define('CRYPT_SALT_LENGTH', 0);
100076define('CRYPT_STD_DES', 0);
100077define('CURLOPT_AUTOREFERER', 0);
100078define('CURLOPT_COOKIESESSION', 0);
100079define('CURLOPT_DNS_USE_GLOBAL_CACHE', 0);
100080define('CURRENCY_SYMBOL', 0);
100081define('CYRUS_CALLBACK_NOLITERAL', 0);
100082define('CYRUS_CALLBACK_NUMBERED', 0);
100083define('CYRUS_CONN_INITIALRESPONSE', 0);
100084define('CYRUS_CONN_NONSYNCLITERAL', 0);
100085define('DAY_1', 0);
100086define('DAY_2', 0);
100087define('DAY_3', 0);
100088define('DAY_4', 0);
100089define('DAY_5', 0);
100090define('DAY_6', 0);
100091define('DAY_7', 0);
100092define('DB2_AUTOCOMMIT_OFF', 0);
100093define('DB2_AUTOCOMMIT_ON', 0);
100094define('DB2_BINARY', 0);
100095define('DB2_CASE_LOWER', 0);
100096define('DB2_CASE_NATURAL', 0);
100097define('DB2_CASE_UPPER', 0);
100098define('DB2_CHAR', 0);
100099define('DB2_CONVERT', 0);
100100define('DB2_DEFERRED_PREPARE_OFF', 0);
100101define('DB2_DEFERRED_PREPARE_ON', 0);
100102define('DB2_DOUBLE', 0);
100103define('DB2_FORWARD_ONLY', 0);
100104define('DB2_LONG', 0);
100105define('DB2_PARAM_FILE', 0);
100106define('DB2_PARAM_IN', 0);
100107define('DB2_PARAM_INOUT', 0);
100108define('DB2_PARAM_OUT', 0);
100109define('DB2_PASSTHRU', 0);
100110define('DB2_SCROLLABLE', 0);
100111/**
100112 * The server can't close
100113 **/
100114define('DBPLUS_ERR_CLOSE', 0);
100115/**
100116 * A client sent a corrupt tuple
100117 **/
100118define('DBPLUS_ERR_CORRUPT_TUPLE', 0);
100119/**
100120 * Invalid crc in the superpage
100121 **/
100122define('DBPLUS_ERR_CRC', 0);
100123/**
100124 * Create() system call failed
100125 **/
100126define('DBPLUS_ERR_CREATE', 0);
100127/**
100128 * Error in the parser
100129 **/
100130define('DBPLUS_ERR_DBPARSE', 0);
100131/**
100132 * Exit condition caused by prexit() * procedure
100133 **/
100134define('DBPLUS_ERR_DBPREEXIT', 0);
100135/**
100136 * Run error in db
100137 **/
100138define('DBPLUS_ERR_DBRUNERR', 0);
100139/**
100140 * Tried to insert a duplicate tuple
100141 **/
100142define('DBPLUS_ERR_DUPLICATE', 0);
100143/**
100144 * Relation is empty (server)
100145 **/
100146define('DBPLUS_ERR_EMPTY', 0);
100147/**
100148 * End of scan from rget()
100149 **/
100150define('DBPLUS_ERR_EOSCAN', 0);
100151/**
100152 * Can't create a fifo
100153 **/
100154define('DBPLUS_ERR_FIFO', 0);
100155/**
100156 * Tuple exceeds maximum length
100157 **/
100158define('DBPLUS_ERR_LENGTH', 0);
100159/**
100160 * Relation was already locked
100161 **/
100162define('DBPLUS_ERR_LOCKED', 0);
100163/**
100164 * Lseek() system call failed
100165 **/
100166define('DBPLUS_ERR_LSEEK', 0);
100167/**
100168 * File is not a relation
100169 **/
100170define('DBPLUS_ERR_MAGIC', 0);
100171/**
100172 * Malloc() call failed
100173 **/
100174define('DBPLUS_ERR_MALLOC', 0);
100175/**
100176 * Too many secondary indices
100177 **/
100178define('DBPLUS_ERR_NIDX', 0);
100179/**
100180 * Null error condition
100181 **/
100182define('DBPLUS_ERR_NOERR', 0);
100183/**
100184 * Relation cannot be locked
100185 **/
100186define('DBPLUS_ERR_NOLOCK', 0);
100187/**
100188 * Error use of max users
100189 **/
100190define('DBPLUS_ERR_NUSERS', 0);
100191/**
100192 * Caused by a signal
100193 **/
100194define('DBPLUS_ERR_ONTRAP', 0);
100195/**
100196 * Open() system call failed
100197 **/
100198define('DBPLUS_ERR_OPEN', 0);
100199/**
100200 * The server should not really die but after a disaster send ERR_PANIC
100201 * to all its clients
100202 **/
100203define('DBPLUS_ERR_PANIC', 0);
100204/**
100205 * Permission denied
100206 **/
100207define('DBPLUS_ERR_PERM', 0);
100208/**
100209 * Relation uses a different page size
100210 **/
100211define('DBPLUS_ERR_PGSIZE', 0);
100212/**
100213 * Piped relation requires lseek()
100214 **/
100215define('DBPLUS_ERR_PIPE', 0);
100216/**
100217 * Caused by invalid usage
100218 **/
100219define('DBPLUS_ERR_PREEXIT', 0);
100220/**
100221 * Error in the preprocessor
100222 **/
100223define('DBPLUS_ERR_PREPROC', 0);
100224/**
100225 * Read error on relation
100226 **/
100227define('DBPLUS_ERR_READ', 0);
100228/**
100229 * Only two users
100230 **/
100231define('DBPLUS_ERR_RESTRICTED', 0);
100232/**
100233 * TCL_error
100234 **/
100235define('DBPLUS_ERR_TCL', 0);
100236define('DBPLUS_ERR_UNKNOWN', 0);
100237/**
100238 * An error in the use of the library by an application programmer
100239 **/
100240define('DBPLUS_ERR_USER', 0);
100241/**
100242 * File is a very old relation
100243 **/
100244define('DBPLUS_ERR_VERSION', 0);
100245/**
100246 * Wait a little (Simple only)
100247 **/
100248define('DBPLUS_ERR_WAIT', 0);
100249/**
100250 * The Simple routines encountered a non fatal error which was corrected
100251 **/
100252define('DBPLUS_ERR_WARNING0', 0);
100253/**
100254 * The record is write locked
100255 **/
100256define('DBPLUS_ERR_WLOCKED', 0);
100257/**
100258 * Relation already opened for writing
100259 **/
100260define('DBPLUS_ERR_WOPEN', 0);
100261/**
100262 * Write error on relation
100263 **/
100264define('DBPLUS_ERR_WRITE', 0);
100265define('DBX_CMP_ASC', 0);
100266define('DBX_CMP_DESC', 0);
100267define('DBX_CMP_NATIVE', 0);
100268define('DBX_CMP_NUMBER', 0);
100269define('DBX_CMP_TEXT', 0);
100270define('DBX_COLNAMES_LOWERCASE', 0);
100271define('DBX_COLNAMES_UNCHANGED', 0);
100272define('DBX_COLNAMES_UPPERCASE', 0);
100273define('DBX_FBSQL', 0);
100274define('DBX_MSSQL', 0);
100275define('DBX_MYSQL', 0);
100276define('DBX_OCI8', 0);
100277define('DBX_ODBC', 0);
100278define('DBX_PERSISTENT', 0);
100279define('DBX_PGSQL', 0);
100280define('DBX_RESULT_ASSOC', 0);
100281define('DBX_RESULT_INDEX', 0);
100282define('DBX_RESULT_INFO', 0);
100283define('DBX_RESULT_UNBUFFERED', 0);
100284define('DBX_SQLITE', 0);
100285define('DBX_SYBASECT', 0);
100286define('DC_BORLAND', 0);
100287define('DC_CALL_CDECL', 0);
100288define('DC_CALL_STD', 0);
100289define('DC_CALL_STD_BO', 0);
100290define('DC_CALL_STD_M8', 0);
100291define('DC_CALL_STD_MS', 0);
100292define('DC_FLAG_ARGPTR', 0);
100293define('DC_MICROSOFT', 0);
100294define('DC_RETVAL_MATH4', 0);
100295define('DC_RETVAL_MATH8', 0);
100296define('DECIMAL_POINT', 0);
100297define('DEFAULT_INCLUDE_PATH', '');
100298define('DIRECTORY_SEPARATOR', '');
100299/**
100300 * A return error that indicates a divide by zero error.
100301 **/
100302define('DISP_E_DIVBYZERO', 0);
100303/**
100304 * An error that indicates that a value could not be coerced to its
100305 * expected representation.
100306 **/
100307define('DISP_E_OVERFLOW', 0);
100308define('DNS_A', 0);
100309define('DNS_AAAA', 0);
100310define('DNS_ALL', 0);
100311define('DNS_ANY', 0);
100312define('DNS_CNAME', 0);
100313define('DNS_HINFO', 0);
100314define('DNS_MX', 0);
100315define('DNS_NS', 0);
100316define('DNS_PTR', 0);
100317define('DNS_SOA', 0);
100318define('DNS_TXT', 0);
100319define('DOMSTRING_SIZE_ERR', 0);
100320/**
100321 * If any node is inserted somewhere it doesn't belong
100322 **/
100323define('DOM_HIERARCHY_REQUEST_ERR', 0);
100324/**
100325 * If index or size is negative, or greater than the allowed value.
100326 **/
100327define('DOM_INDEX_SIZE_ERR', 0);
100328/**
100329 * If an attempt is made to add an attribute that is already in use
100330 * elsewhere.
100331 **/
100332define('DOM_INUSE_ATTRIBUTE_ERR', 0);
100333/**
100334 * If a parameter or an operation is not supported by the underlying
100335 * object.
100336 **/
100337define('DOM_INVALID_ACCESS_ERR', 0);
100338/**
100339 * If an invalid or illegal character is specified, such as in a name.
100340 **/
100341define('DOM_INVALID_CHARACTER_ERR', 0);
100342/**
100343 * If an attempt is made to modify the type of the underlying object.
100344 **/
100345define('DOM_INVALID_MODIFICATION_ERR', 0);
100346/**
100347 * If an attempt is made to use an object that is not, or is no longer,
100348 * usable.
100349 **/
100350define('DOM_INVALID_STATE_ERR', 0);
100351/**
100352 * If an attempt is made to create or change an object in a way which is
100353 * incorrect with regard to namespaces.
100354 **/
100355define('DOM_NAMESPACE_ERR', 0);
100356/**
100357 * If an attempt is made to reference a node in a context where it does
100358 * not exist.
100359 **/
100360define('DOM_NOT_FOUND_ERR', 0);
100361/**
100362 * If the implementation does not support the requested type of object or
100363 * operation.
100364 **/
100365define('DOM_NOT_SUPPORTED_ERR', 0);
100366/**
100367 * If data is specified for a node which does not support data.
100368 **/
100369define('DOM_NO_DATA_ALLOWED_ERR', 0);
100370/**
100371 * If an attempt is made to modify an object where modifications are not
100372 * allowed.
100373 **/
100374define('DOM_NO_MODIFICATION_ALLOWED_ERR', 0);
100375/**
100376 * Error code not part of the DOM specification. Meant for PHP errors.
100377 **/
100378define('DOM_PHP_ERR', 0);
100379/**
100380 * If an invalid or illegal string is specified.
100381 **/
100382define('DOM_SYNTAX_ERR', 0);
100383/**
100384 * If a call to a method such as insertBefore or removeChild would make
100385 * the Node invalid with respect to "partial validity", this exception
100386 * would be raised and the operation would not be done.
100387 **/
100388define('DOM_VALIDATION_ERR', 0);
100389/**
100390 * If a node is used in a different document than the one that created
100391 * it.
100392 **/
100393define('DOM_WRONG_DOCUMENT_ERR', 0);
100394define('D_FMT', 0);
100395define('D_T_FMT', 0);
100396define('ENC7BIT', 0);
100397define('ENC8BIT', 0);
100398define('ENCBASE64', 0);
100399define('ENCBINARY', 0);
100400define('ENCOTHER', 0);
100401define('ENCQUOTEDPRINTABLE', 0);
100402define('ENT_COMPAT', 0);
100403define('ENT_NOQUOTES', 0);
100404define('ENT_QUOTES', 0);
100405define('ERA', 0);
100406define('ERA_D_FMT', 0);
100407define('ERA_D_T_FMT', 0);
100408define('ERA_T_FMT', 0);
100409define('ERA_YEAR', 0);
100410define('ERROR_TRACE', 0);
100411define('EVLOOP_NONBLOCK', 0);
100412define('EVLOOP_ONCE', 0);
100413define('EV_PERSIST', 0);
100414define('EV_READ', 0);
100415define('EV_SIGNAL', 0);
100416define('EV_TIMEOUT', 0);
100417define('EV_WRITE', 0);
100418define('EXP_EOF', 0);
100419define('EXP_EXACT', 0);
100420define('EXP_FULLBUFFER', 0);
100421define('EXP_GLOB', 0);
100422define('EXP_REGEXP', 0);
100423define('EXP_TIMEOUT', 0);
100424define('EXTR_IF_EXISTS', 0);
100425define('EXTR_OVERWRITE', 0);
100426define('EXTR_PREFIX_ALL', 0);
100427define('EXTR_PREFIX_IF_EXISTS', 0);
100428define('EXTR_PREFIX_INVALID', 0);
100429define('EXTR_PREFIX_SAME', 0);
100430define('EXTR_REFS', 0);
100431define('EXTR_SKIP', 0);
100432/**
100433 * 30719 in PHP 5.3.x, 6143 in PHP 5.2.x, 2047 previously
100434 **/
100435define('E_ALL', 0);
100436/**
100437 * since PHP 4
100438 **/
100439define('E_COMPILE_ERROR', 0);
100440/**
100441 * since PHP 4
100442 **/
100443define('E_COMPILE_WARNING', 0);
100444/**
100445 * since PHP 4
100446 **/
100447define('E_CORE_ERROR', 0);
100448/**
100449 * since PHP 4
100450 **/
100451define('E_CORE_WARNING', 0);
100452/**
100453 * since PHP 5.3.0
100454 **/
100455define('E_DEPRECATED', 0);
100456define('E_ERROR', 0);
100457define('E_NOTICE', 0);
100458define('E_PARSE', 0);
100459/**
100460 * since PHP 5.2.0
100461 **/
100462define('E_RECOVERABLE_ERROR', 0);
100463/**
100464 * since PHP 5
100465 **/
100466define('E_STRICT', 0);
100467/**
100468 * since PHP 5.3.0
100469 **/
100470define('E_USER_DEPRECATED', 0);
100471/**
100472 * since PHP 4
100473 **/
100474define('E_USER_ERROR', 0);
100475/**
100476 * since PHP 4
100477 **/
100478define('E_USER_NOTICE', 0);
100479/**
100480 * since PHP 4
100481 **/
100482define('E_USER_WARNING', 0);
100483define('E_WARNING', 0);
100484define('FAMAcknowledge', 0);
100485define('FAMChanged', 0);
100486define('FAMCreated', 0);
100487define('FAMDeleted', 0);
100488define('FAMEndExist', 0);
100489define('FAMExists', 0);
100490define('FAMMoved', 0);
100491define('FAMStartExecuting', 0);
100492define('FAMStopExecuting', 0);
100493define('FBSQL_ASSOC', 0);
100494define('FBSQL_BOTH', 0);
100495define('FBSQL_ISO_READ_COMMITTED', 0);
100496define('FBSQL_ISO_READ_UNCOMMITTED', 0);
100497define('FBSQL_ISO_REPEATABLE_READ', 0);
100498define('FBSQL_ISO_SERIALIZABLE', 0);
100499define('FBSQL_ISO_VERSIONED', 0);
100500define('FBSQL_LOB_DIRECT', 0);
100501define('FBSQL_LOB_HANDLE', 0);
100502define('FBSQL_LOCK_DEFERRED', 0);
100503define('FBSQL_LOCK_OPTIMISTIC', 0);
100504define('FBSQL_LOCK_PESSIMISTIC', 0);
100505define('FBSQL_NOEXEC', 0);
100506define('FBSQL_NUM', 0);
100507define('FBSQL_RUNNING', 0);
100508define('FBSQL_STARTING', 0);
100509define('FBSQL_STOPPED', 0);
100510define('FBSQL_STOPPING', 0);
100511define('FBSQL_UNKNOWN', 0);
100512define('FDFAA', 0);
100513define('FDFAction', 0);
100514define('FDFAP', 0);
100515define('FDFAPRef', 0);
100516define('FDFAS', 0);
100517define('FDFCalculate', 0);
100518define('FDFClearFf', 0);
100519define('FDFClrF', 0);
100520define('FDFDown', 0);
100521define('FDFDownAP', 0);
100522define('FDFEnter', 0);
100523define('FDFExit', 0);
100524define('FDFFf', 0);
100525define('FDFFile', 0);
100526define('FDFFlags', 0);
100527define('FDFFormat', 0);
100528define('FDFID', 0);
100529define('FDFIF', 0);
100530define('FDFKeystroke', 0);
100531define('FDFNormalAP', 0);
100532define('FDFRolloverAP', 0);
100533define('FDFSetF', 0);
100534define('FDFSetFf', 0);
100535define('FDFStatus', 0);
100536define('FDFUp', 0);
100537define('FDFValidate', 0);
100538define('FDFValue', 0);
100539define('FILEINFO_COMPRESS', 0);
100540define('FILEINFO_CONTINUE', 0);
100541define('FILEINFO_DEVICES', 0);
100542define('FILEINFO_MIME', 0);
100543define('FILEINFO_MIME_ENCODING', 0);
100544define('FILEINFO_MIME_TYPE', 0);
100545define('FILEINFO_NONE', 0);
100546define('FILEINFO_PRESERVE_ATIME', 0);
100547define('FILEINFO_RAW', 0);
100548define('FILEINFO_SYMLINK', 0);
100549define('FILE_APPEND', 0);
100550define('FILE_BINARY', 0);
100551define('FILE_IGNORE_NEW_LINES', 0);
100552define('FILE_NO_DEFAULT_CONTEXT', 0);
100553define('FILE_SKIP_EMPTY_LINES', 0);
100554define('FILE_TEXT', 0);
100555define('FILE_USE_INCLUDE_PATH', 0);
100556define('FILTER_CALLBACK', 0);
100557define('FILTER_DEFAULT', 0);
100558define('FILTER_FLAG_ALLOW_FRACTION', 0);
100559define('FILTER_FLAG_ALLOW_HEX', 0);
100560define('FILTER_FLAG_ALLOW_OCTAL', 0);
100561define('FILTER_FLAG_ALLOW_SCIENTIFIC', 0);
100562define('FILTER_FLAG_ALLOW_THOUSAND', 0);
100563define('FILTER_FLAG_EMPTY_STRING_NULL', 0);
100564define('FILTER_FLAG_ENCODE_AMP', 0);
100565define('FILTER_FLAG_ENCODE_HIGH', 0);
100566define('FILTER_FLAG_ENCODE_LOW', 0);
100567define('FILTER_FLAG_HOST_REQUIRED', 0);
100568define('FILTER_FLAG_IPV4', 0);
100569define('FILTER_FLAG_IPV6', 0);
100570define('FILTER_FLAG_NONE', 0);
100571define('FILTER_FLAG_NO_ENCODE_QUOTES', 0);
100572define('FILTER_FLAG_NO_PRIV_RANGE', 0);
100573define('FILTER_FLAG_NO_RES_RANGE', 0);
100574define('FILTER_FLAG_PATH_REQUIRED', 0);
100575define('FILTER_FLAG_QUERY_REQUIRED', 0);
100576define('FILTER_FLAG_SCHEME_REQUIRED', 0);
100577define('FILTER_FLAG_STRIP_HIGH', 0);
100578define('FILTER_FLAG_STRIP_LOW', 0);
100579define('FILTER_FORCE_ARRAY', 0);
100580define('FILTER_NULL_ON_FAILURE', 0);
100581define('FILTER_REQUIRE_ARRAY', 0);
100582define('FILTER_REQUIRE_SCALAR', 0);
100583define('FILTER_SANITIZE_EMAIL', 0);
100584define('FILTER_SANITIZE_ENCODED', 0);
100585define('FILTER_SANITIZE_MAGIC_QUOTES', 0);
100586define('FILTER_SANITIZE_NUMBER_FLOAT', 0);
100587define('FILTER_SANITIZE_NUMBER_INT', 0);
100588define('FILTER_SANITIZE_SPECIAL_CHARS', 0);
100589define('FILTER_SANITIZE_STRING', 0);
100590define('FILTER_SANITIZE_STRIPPED', 0);
100591define('FILTER_SANITIZE_URL', 0);
100592define('FILTER_UNSAFE_RAW', 0);
100593define('FILTER_VALIDATE_BOOLEAN', 0);
100594define('FILTER_VALIDATE_EMAIL', 0);
100595define('FILTER_VALIDATE_FLOAT', 0);
100596define('FILTER_VALIDATE_INT', 0);
100597define('FILTER_VALIDATE_IP', 0);
100598define('FILTER_VALIDATE_REGEXP', 0);
100599define('FILTER_VALIDATE_URL', 0);
100600define('FNM_CASEFOLD', 0);
100601define('FNM_NOESCAPE', 0);
100602define('FNM_PATHNAME', 0);
100603define('FNM_PERIOD', 0);
100604define('FORCE_DEFLATE', 0);
100605define('FORCE_GZIP', 0);
100606define('FPE_FLTDIV', 0);
100607define('FPE_FLTINV', 0);
100608define('FPE_FLTOVF', 0);
100609define('FPE_FLTRES', 0);
100610define('FPE_FLTSUB', 0);
100611define('FPE_FLTUND', 0);
100612define('FPE_INTDIV', 0);
100613define('FPE_INTOVF', 0);
100614define('FRAC_DIGITS', 0);
100615define('FRIBIDI_AUTO', 0);
100616define('FRIBIDI_CHARSET_8859_6', 0);
100617define('FRIBIDI_CHARSET_8859_8', 0);
100618define('FRIBIDI_CHARSET_CAP_RTL', 0);
100619define('FRIBIDI_CHARSET_CP1255', 0);
100620define('FRIBIDI_CHARSET_CP1256', 0);
100621define('FRIBIDI_CHARSET_ISIRI_3342', 0);
100622define('FRIBIDI_CHARSET_UTF8', 0);
100623define('FRIBIDI_LTR', 0);
100624define('FRIBIDI_RTL', 0);
100625define('FTP_ASCII', 0);
100626define('FTP_BINARY', 0);
100627define('FTP_IMAGE', 0);
100628define('FTP_TEXT', 0);
100629define('FTP_TIMEOUT_SEC', 0);
100630define('FT_INTERNAL', 0);
100631define('FT_NOT', 0);
100632define('FT_PEEK', 0);
100633define('FT_PREFETCHTEXT', 0);
100634define('FT_UID', 0);
100635define('FUNCTION_TRACE', 0);
100636define('F_DUPFD', 0);
100637define('F_GETFD', 0);
100638define('F_GETFL', 0);
100639define('F_GETLK', 0);
100640define('F_GETOWN', 0);
100641define('F_RDLCK', 0);
100642define('F_SETFL', 0);
100643define('F_SETLK', 0);
100644define('F_SETLKW', 0);
100645define('F_SETOWN', 0);
100646define('F_UNLCK', 0);
100647define('F_WRLCK', 0);
100648define('GD_BUNDLED', 0);
100649define('GD_EXTRA_VERSION', '');
100650define('GD_MAJOR_VERSION', 0);
100651define('GD_MINOR_VERSION', 0);
100652define('GD_RELEASE_VERSION', 0);
100653define('GD_VERSION', '');
100654define('GEOIP_ASNUM_EDITION', 0);
100655define('GEOIP_CITY_EDITION_REV0', 0);
100656define('GEOIP_CITY_EDITION_REV1', 0);
100657define('GEOIP_COUNTRY_EDITION', 0);
100658define('GEOIP_DOMAIN_EDITION', 0);
100659define('GEOIP_ISP_EDITION', 0);
100660define('GEOIP_NETSPEED_EDITION', 0);
100661define('GEOIP_ORG_EDITION', 0);
100662define('GEOIP_PROXY_EDITION', 0);
100663define('GEOIP_REGION_EDITION_REV0', 0);
100664define('GEOIP_REGION_EDITION_REV1', 0);
100665define('GLOB_AVAILABLE_FLAGS', 0);
100666define('GLOB_BRACE', 0);
100667define('GLOB_MARK', 0);
100668define('GLOB_NOCHECK', 0);
100669define('GLOB_NOESCAPE', 0);
100670define('GLOB_NOSORT', 0);
100671define('GLOB_ONLYDIR', 0);
100672define('GMP_ROUND_MINUSINF', 0);
100673define('GMP_ROUND_PLUSINF', 0);
100674define('GMP_ROUND_ZERO', 0);
100675define('GMP_VERSION', '');
100676define('GNUPG_ERROR_EXCEPTION', 0);
100677define('GNUPG_ERROR_SILENT', 0);
100678define('GNUPG_ERROR_WARNING', 0);
100679define('GNUPG_PROTOCOL_CMS', 0);
100680define('GNUPG_PROTOCOL_OpenPGP', 0);
100681define('GNUPG_SIGSUM_BAD_POLICY', 0);
100682define('GNUPG_SIGSUM_CRL_MISSING', 0);
100683define('GNUPG_SIGSUM_CRL_TOO_OLD', 0);
100684define('GNUPG_SIGSUM_GREEN', 0);
100685define('GNUPG_SIGSUM_KEY_EXPIRED', 0);
100686define('GNUPG_SIGSUM_KEY_MISSING', 0);
100687define('GNUPG_SIGSUM_KEY_REVOKED', 0);
100688define('GNUPG_SIGSUM_RED', 0);
100689define('GNUPG_SIGSUM_SIG_EXPIRED', 0);
100690define('GNUPG_SIGSUM_SYS_ERROR', 0);
100691define('GNUPG_SIGSUM_VALID', 0);
100692define('GNUPG_SIG_MODE_CLEAR', 0);
100693define('GNUPG_SIG_MODE_DETACH', 0);
100694define('GNUPG_SIG_MODE_NORMAL', 0);
100695define('GNUPG_VALIDITY_FULL', 0);
100696define('GNUPG_VALIDITY_MARGINAL', 0);
100697define('GNUPG_VALIDITY_NEVER', 0);
100698define('GNUPG_VALIDITY_ULTIMATE', 0);
100699define('GNUPG_VALIDITY_UNDEFINED', 0);
100700define('GNUPG_VALIDITY_UNKNOWN', 0);
100701define('GOPHER_BINARY', 0);
100702define('GOPHER_BINHEX', 0);
100703define('GOPHER_DIRECTORY', 0);
100704define('GOPHER_DOCUMENT', 0);
100705define('GOPHER_DOSBINARY', 0);
100706define('GOPHER_HTTP', 0);
100707define('GOPHER_INFO', 0);
100708define('GOPHER_UNKNOWN', 0);
100709define('GOPHER_UUENCODED', 0);
100710define('GROUPING', 0);
100711define('GSLC_SSL_NO_AUTH', 0);
100712define('GSLC_SSL_ONEWAY_AUTH', 0);
100713define('GSLC_SSL_TWOWAY_AUTH', 0);
100714define('HASH_HMAC', 0);
100715define('HTML_ENTITIES', 0);
100716define('HTML_SPECIALCHARS', 0);
100717define('HTTP_SUPPORT', 0);
100718define('HTTP_SUPPORT_ENCODINGS', 0);
100719define('HTTP_SUPPORT_MAGICMIME', 0);
100720define('HTTP_SUPPORT_REQUESTS', 0);
100721define('HTTP_SUPPORT_SSLREQUESTS', 0);
100722define('HW_ATTR_LANG', 0);
100723define('HW_ATTR_NONE', 0);
100724define('HW_ATTR_NR', 0);
100725define('IBASE_REC_VERSION', 0);
100726define('IBASE_TEXT', 0);
100727define('ICONV_IMPL', 0);
100728define('ICONV_MIME_DECODE_CONTINUE_ON_ERROR', 0);
100729define('ICONV_MIME_DECODE_STRICT', 0);
100730define('ICONV_VERSION', 0);
100731define('IdletoOverDown', 0);
100732define('IdletoOverUp', 0);
100733define('IFX_HOLD', 0);
100734define('IFX_LO_APPEND', 0);
100735define('IFX_LO_BUFFER', 0);
100736define('IFX_LO_NOBUFFER', 0);
100737define('IFX_LO_RDONLY', 0);
100738define('IFX_LO_RDWR', 0);
100739define('IFX_LO_WRONLY', 0);
100740define('IFX_SCROLL', 0);
100741define('IIS_ANONYMOUS', 0);
100742define('IIS_BASIC', 0);
100743define('IIS_EXECUTE', 0);
100744define('IIS_NTLM', 0);
100745define('IIS_PAUSED', 0);
100746define('IIS_READ', 0);
100747define('IIS_RUNNING', 0);
100748define('IIS_SCRIPT', 0);
100749define('IIS_STARTING', 0);
100750define('IIS_STOPPED', 0);
100751define('IIS_WRITE', 0);
100752define('ILL_BADSTK', 0);
100753define('ILL_COPROC', 0);
100754define('ILL_ILLADR', 0);
100755define('ILL_ILLOPC', 0);
100756define('ILL_ILLOPN', 0);
100757define('ILL_ILLTRP', 0);
100758define('ILL_PRVOPC', 0);
100759define('ILL_PRVREG', 0);
100760define('IMAGETYPE_BMP', 0);
100761define('IMAGETYPE_GIF', 0);
100762define('IMAGETYPE_ICO', 0);
100763define('IMAGETYPE_IFF', 0);
100764define('IMAGETYPE_JB2', 0);
100765define('IMAGETYPE_JP2', 0);
100766define('IMAGETYPE_JPC', 0);
100767define('IMAGETYPE_JPEG', 0);
100768define('IMAGETYPE_JPEG2000', 0);
100769define('IMAGETYPE_JPX', 0);
100770define('IMAGETYPE_PNG', 0);
100771define('IMAGETYPE_PSD', 0);
100772define('IMAGETYPE_SWC', 0);
100773define('IMAGETYPE_SWF', 0);
100774define('IMAGETYPE_TIFF_II', 0);
100775define('IMAGETYPE_TIFF_MM', 0);
100776define('IMAGETYPE_WBMP', 0);
100777define('IMAGETYPE_XBM', 0);
100778define('IMAP_CLOSETIMEOUT', 0);
100779define('IMAP_GC_ELT', 0);
100780define('IMAP_GC_ENV', 0);
100781define('IMAP_GC_TEXTS', 0);
100782define('IMAP_OPENTIMEOUT', 0);
100783define('IMAP_READTIMEOUT', 0);
100784define('IMAP_WRITETIMEOUT', 0);
100785define('IMG_ARC_CHORD', 0);
100786define('IMG_ARC_EDGED', 0);
100787define('IMG_ARC_NOFILL', 0);
100788define('IMG_ARC_PIE', 0);
100789define('IMG_ARC_ROUNDED', 0);
100790define('IMG_COLOR_BRUSHED', 0);
100791define('IMG_COLOR_STYLED', 0);
100792define('IMG_COLOR_STYLEDBRUSHED', 0);
100793define('IMG_COLOR_TILED', 0);
100794define('IMG_COLOR_TRANSPARENT', 0);
100795define('IMG_EFFECT_ALPHABLEND', 0);
100796define('IMG_EFFECT_NORMAL', 0);
100797define('IMG_EFFECT_OVERLAY', 0);
100798define('IMG_EFFECT_REPLACE', 0);
100799define('IMG_FILTER_BRIGHTNESS', 0);
100800define('IMG_FILTER_COLORIZE', 0);
100801define('IMG_FILTER_CONTRAST', 0);
100802define('IMG_FILTER_EDGEDETECT', 0);
100803define('IMG_FILTER_EMBOSS', 0);
100804define('IMG_FILTER_GAUSSIAN_BLUR', 0);
100805define('IMG_FILTER_GRAYSCALE', 0);
100806define('IMG_FILTER_MEAN_REMOVAL', 0);
100807define('IMG_FILTER_NEGATE', 0);
100808define('IMG_FILTER_PIXELATE', 0);
100809define('IMG_FILTER_SELECTIVE_BLUR', 0);
100810define('IMG_FILTER_SMOOTH', 0);
100811define('IMG_GD2_COMPRESSED', 0);
100812define('IMG_GD2_RAW', 0);
100813define('IMG_GIF', 0);
100814define('IMG_JPEG', 0);
100815define('IMG_JPG', 0);
100816define('IMG_PNG', 0);
100817define('IMG_WBMP', 0);
100818define('IMG_XPM', 0);
100819define('INF', 0);
100820define('INFO_ALL', 0);
100821define('INFO_CONFIGURATION', 0);
100822define('INFO_CREDITS', 0);
100823define('INFO_ENVIRONMENT', 0);
100824define('INFO_GENERAL', 0);
100825define('INFO_LICENSE', 0);
100826define('INFO_MODULES', 0);
100827define('INFO_VARIABLES', 0);
100828define('INGRES_API_VERSION', 0);
100829define('INGRES_ASSOC', 0);
100830define('INGRES_BOTH', 0);
100831define('INGRES_CURSOR_READONLY', 0);
100832define('INGRES_CURSOR_UPDATE', 0);
100833define('INGRES_DATE_DMY', 0);
100834define('INGRES_DATE_FINNISH', 0);
100835define('INGRES_DATE_GERMAN', 0);
100836define('INGRES_DATE_ISO', 0);
100837define('INGRES_DATE_ISO4', 0);
100838define('INGRES_DATE_MDY', 0);
100839define('INGRES_DATE_MULTINATIONAL', 0);
100840define('INGRES_DATE_MULTINATIONAL4', 0);
100841define('INGRES_DATE_YMD', 0);
100842define('INGRES_EXT_VERSION', '');
100843define('INGRES_MONEY_LEADING', 0);
100844define('INGRES_MONEY_TRAILING', 0);
100845define('INGRES_NUM', 0);
100846define('INGRES_STRUCTURE_BTREE', 0);
100847define('INGRES_STRUCTURE_CBTREE', 0);
100848define('INGRES_STRUCTURE_CHASH', 0);
100849define('INGRES_STRUCTURE_CHEAP', 0);
100850define('INGRES_STRUCTURE_CISAM', 0);
100851define('INGRES_STRUCTURE_HASH', 0);
100852define('INGRES_STRUCTURE_HEAP', 0);
100853define('INGRES_STRUCTURE_ISAM', 0);
100854define('INI_ALL', 0);
100855define('INI_PERDIR', 0);
100856define('INI_SCANNER_NORMAL', 0);
100857define('INI_SCANNER_RAW', 0);
100858define('INI_SYSTEM', 0);
100859define('INI_USER', 0);
100860define('INPUT_COOKIE', 0);
100861define('INPUT_ENV', 0);
100862define('INPUT_GET', 0);
100863define('INPUT_POST', 0);
100864define('INPUT_REQUEST', 0);
100865define('INPUT_SERVER', 0);
100866define('INPUT_SESSION', 0);
100867define('INT_CURR_SYMBOL', 0);
100868define('INT_FRAC_DIGITS', 0);
100869define('IN_ACCESS', 0);
100870define('IN_ALL_EVENTS', 0);
100871define('IN_ATTRIB', 0);
100872define('IN_CLOSE', 0);
100873define('IN_CLOSE_NOWRITE', 0);
100874define('IN_CLOSE_WRITE', 0);
100875define('IN_CREATE', 0);
100876define('IN_DELETE', 0);
100877define('IN_DELETE_SELF', 0);
100878define('IN_DONT_FOLLOW', 0);
100879define('IN_IGNORED', 0);
100880define('IN_ISDIR', 0);
100881define('IN_MASK_ADD', 0);
100882define('IN_MODIFY', 0);
100883define('IN_MOVE', 0);
100884define('IN_MOVED_FROM', 0);
100885define('IN_MOVED_TO', 0);
100886define('IN_MOVE_SELF', 0);
100887define('IN_ONESHOT', 0);
100888define('IN_ONLYDIR', 0);
100889define('IN_OPEN', 0);
100890define('IN_Q_OVERFLOW', 0);
100891define('IN_UNMOUNT', 0);
100892define('JSON_ERROR_CTRL_CHAR', 0);
100893define('JSON_ERROR_DEPTH', 0);
100894define('JSON_ERROR_NONE', 0);
100895define('JSON_ERROR_SYNTAX', 0);
100896define('JSON_ERROR_UTF8', 0);
100897define('LATT_HASCHILDREN', 0);
100898define('LATT_HASNOCHILDREN', 0);
100899define('LATT_MARKED', 0);
100900define('LATT_NOINFERIORS', 0);
100901define('LATT_NOSELECT', 0);
100902define('LATT_REFERRAL', 0);
100903define('LATT_UNMARKED', 0);
100904define('LC_ALL', 0);
100905define('LC_COLLATE', 0);
100906define('LC_CTYPE', 0);
100907define('LC_MESSAGES', 0);
100908define('LC_MONETARY', 0);
100909define('LC_NUMERIC', 0);
100910define('LC_TIME', 0);
100911define('LDAP_DEREF_ALWAYS', 0);
100912define('LDAP_DEREF_FINDING', 0);
100913define('LDAP_DEREF_NEVER', 0);
100914define('LDAP_DEREF_SEARCHING', 0);
100915define('LDAP_OPT_CLIENT_CONTROLS', 0);
100916define('LDAP_OPT_DEBUG_LEVEL', 0);
100917define('LDAP_OPT_DEREF', 0);
100918define('LDAP_OPT_ERROR_NUMBER', 0);
100919define('LDAP_OPT_ERROR_STRING', 0);
100920define('LDAP_OPT_HOST_NAME', 0);
100921define('LDAP_OPT_MATCHED_DN', 0);
100922define('LDAP_OPT_NETWORK_TIMEOUT', 0);
100923define('LDAP_OPT_PROTOCOL_VERSION', 0);
100924define('LDAP_OPT_REFERRALS', 0);
100925define('LDAP_OPT_RESTART', 0);
100926define('LDAP_OPT_SERVER_CONTROLS', 0);
100927define('LDAP_OPT_SIZELIMIT', 0);
100928define('LDAP_OPT_TIMELIMIT', 0);
100929define('LIBEXSLT_DOTTED_VERSION', '');
100930define('LIBEXSLT_VERSION', 0);
100931define('LIBXML_COMPACT', 0);
100932define('LIBXML_DOTTED_VERSION', '');
100933define('LIBXML_DTDATTR', 0);
100934define('LIBXML_DTDLOAD', 0);
100935define('LIBXML_DTDVALID', 0);
100936define('LIBXML_ERR_ERROR', 0);
100937define('LIBXML_ERR_FATAL', 0);
100938define('LIBXML_ERR_NONE', 0);
100939define('LIBXML_ERR_WARNING', 0);
100940define('LIBXML_NOBLANKS', 0);
100941define('LIBXML_NOCDATA', 0);
100942define('LIBXML_NOEMPTYTAG', 0);
100943define('LIBXML_NOENT', 0);
100944define('LIBXML_NOERROR', 0);
100945define('LIBXML_NONET', 0);
100946define('LIBXML_NOWARNING', 0);
100947define('LIBXML_NOXMLDECL', 0);
100948define('LIBXML_NSCLEAN', 0);
100949define('LIBXML_VERSION', 0);
100950define('LIBXML_XINCLUDE', 0);
100951define('LIBXSLT_DOTTED_VERSION', '');
100952define('LIBXSLT_VERSION', 0);
100953define('LOCK_EX', 0);
100954define('LOCK_NB', 0);
100955define('LOCK_SH', 0);
100956define('LOCK_UN', 0);
100957define('LOG_ALERT', 0);
100958define('LOG_AUTH', 0);
100959define('LOG_AUTHPRIV', 0);
100960define('LOG_CONS', 0);
100961define('LOG_CRIT', 0);
100962define('LOG_CRON', 0);
100963define('LOG_DAEMON', 0);
100964define('LOG_DEBUG', 0);
100965define('LOG_EMERG', 0);
100966define('LOG_ERR', 0);
100967define('LOG_INFO', 0);
100968define('LOG_KERN', 0);
100969define('LOG_LOCAL0', 0);
100970define('LOG_LOCAL0 ... LOG_LOCAL7', 0);
100971define('LOG_LOCAL1', 0);
100972define('LOG_LOCAL2', 0);
100973define('LOG_LOCAL3', 0);
100974define('LOG_LOCAL4', 0);
100975define('LOG_LOCAL5', 0);
100976define('LOG_LOCAL6', 0);
100977define('LOG_LOCAL7', 0);
100978define('LOG_LPR', 0);
100979define('LOG_MAIL', 0);
100980define('LOG_NDELAY', 0);
100981define('LOG_NEWS', 0);
100982define('LOG_NOTICE', 0);
100983define('LOG_NOWAIT', 0);
100984define('LOG_ODELAY', 0);
100985define('LOG_PERROR', 0);
100986define('LOG_PID', 0);
100987define('LOG_SYSLOG', 0);
100988define('LOG_USER', 0);
100989define('LOG_UUCP', 0);
100990define('LOG_WARNING', 0);
100991define('MAILPARSE_EXTRACT_OUTPUT', 0);
100992define('MAILPARSE_EXTRACT_RETURN', 0);
100993define('MAILPARSE_EXTRACT_STREAM', 0);
100994define('MB_CASE_LOWER', 0);
100995define('MB_CASE_TITLE', 0);
100996define('MB_CASE_UPPER', 0);
100997define('MB_OVERLOAD_MAIL', 0);
100998define('MB_OVERLOAD_REGEX', 0);
100999define('MB_OVERLOAD_STRING', 0);
101000define('MEMCACHE_COMPRESSED', 0);
101001define('MEMCACHE_HAVE_SESSION', 0);
101002define('MEMORY_TRACE', 0);
101003define('MenuEnter', 0);
101004define('MenuExit', 0);
101005define('MING_NEW', 0);
101006define('MING_ZLIB', 0);
101007/**
101008 * iMoniker COM status code, return on errors where the function call
101009 * failed due to unavailability.
101010 **/
101011define('MK_E_UNAVAILABLE', 0);
101012define('MOD_COLOR', 0);
101013define('MOD_MATRIX', 0);
101014define('MON_1', 0);
101015define('MON_2', 0);
101016define('MON_3', 0);
101017define('MON_4', 0);
101018define('MON_5', 0);
101019define('MON_6', 0);
101020define('MON_7', 0);
101021define('MON_8', 0);
101022define('MON_9', 0);
101023define('MON_10', 0);
101024define('MON_11', 0);
101025define('MON_12', 0);
101026define('MON_DECIMAL_POINT', 0);
101027define('MON_GROUPING', 0);
101028define('MON_THOUSANDS_SEP', 0);
101029define('MSG_DONTROUTE', 0);
101030define('MSG_EOF', 0);
101031define('MSG_EOR', 0);
101032define('MSG_OOB', 0);
101033define('MSG_PEEK', 0);
101034define('MSG_WAITALL', 0);
101035define('MSQL_ASSOC', 0);
101036define('MSQL_BOTH', 0);
101037define('MSQL_NUM', 0);
101038define('MSSQL_ASSOC', 0);
101039define('MSSQL_BOTH', 0);
101040define('MSSQL_NUM', 0);
101041define('MYSQL_ASSOC', 0);
101042define('MYSQL_BOTH', 0);
101043define('MYSQL_CLIENT_COMPRESS', 0);
101044define('MYSQL_CLIENT_IGNORE_SPACE', 0);
101045define('MYSQL_CLIENT_INTERACTIVE', 0);
101046define('MYSQL_CLIENT_SSL', 0);
101047define('MYSQL_NUM', 0);
101048define('M_1_PI', 0);
101049define('M_2_PI', 0);
101050define('M_2_SQRTPI', 0);
101051define('M_DONE', 0);
101052define('M_E', 0);
101053define('M_ERROR', 0);
101054define('M_EULER', 0);
101055define('M_FAIL', 0);
101056define('M_LN2', 0);
101057define('M_LN10', 0);
101058define('M_LNPI', 0);
101059define('M_LOG2E', 0);
101060define('M_LOG10E', 0);
101061define('M_PENDING', 0);
101062define('M_PI', 0);
101063define('M_PI_2', 0);
101064define('M_PI_4', 0);
101065define('M_SQRT1_2', 0);
101066define('M_SQRT2', 0);
101067define('M_SQRT3', 0);
101068define('M_SQRTPI', 0);
101069define('M_SUCCESS', 0);
101070define('NAN', 0);
101071define('NCURSES_ALL_MOUSE_EVENTS', 0);
101072define('NCURSES_BUTTON1_CLICKED', 0);
101073define('NCURSES_BUTTON1_DOUBLE_CLICKED', 0);
101074define('NCURSES_BUTTON1_PRESSED', 0);
101075define('NCURSES_BUTTON1_RELEASED', 0);
101076define('NCURSES_BUTTON1_TRIPLE_CLICKED', 0);
101077define('NCURSES_BUTTON_ALT', 0);
101078define('NCURSES_BUTTON_CTRL', 0);
101079define('NCURSES_BUTTON_SHIFT', 0);
101080define('NCURSES_COLOR_BLACK', 0);
101081define('NCURSES_COLOR_BLUE', 0);
101082define('NCURSES_COLOR_CYAN', 0);
101083define('NCURSES_COLOR_GREEN', 0);
101084define('NCURSES_COLOR_MAGENTA', 0);
101085define('NCURSES_COLOR_RED', 0);
101086define('NCURSES_COLOR_WHITE', 0);
101087define('NCURSES_COLOR_YELLOW', 0);
101088define('NCURSES_KEY_A1', 0);
101089define('NCURSES_KEY_A3', 0);
101090define('NCURSES_KEY_B2', 0);
101091define('NCURSES_KEY_BACKSPACE', 0);
101092define('NCURSES_KEY_BEG', 0);
101093define('NCURSES_KEY_BTAB', 0);
101094define('NCURSES_KEY_C1', 0);
101095define('NCURSES_KEY_C3', 0);
101096define('NCURSES_KEY_CANCEL', 0);
101097define('NCURSES_KEY_CATAB', 0);
101098define('NCURSES_KEY_CLEAR', 0);
101099define('NCURSES_KEY_CLOSE', 0);
101100define('NCURSES_KEY_COMMAND', 0);
101101define('NCURSES_KEY_COPY', 0);
101102define('NCURSES_KEY_CREATE', 0);
101103define('NCURSES_KEY_CTAB', 0);
101104define('NCURSES_KEY_DC', 0);
101105define('NCURSES_KEY_DL', 0);
101106define('NCURSES_KEY_DOWN', 0);
101107define('NCURSES_KEY_EIC', 0);
101108define('NCURSES_KEY_END', 0);
101109define('NCURSES_KEY_EOL', 0);
101110define('NCURSES_KEY_EOS', 0);
101111define('NCURSES_KEY_EXIT', 0);
101112define('NCURSES_KEY_F0', 0);
101113define('NCURSES_KEY_FIND', 0);
101114define('NCURSES_KEY_HELP', 0);
101115define('NCURSES_KEY_HOME', 0);
101116define('NCURSES_KEY_IC', 0);
101117define('NCURSES_KEY_IL', 0);
101118define('NCURSES_KEY_LEFT', 0);
101119define('NCURSES_KEY_LL', 0);
101120define('NCURSES_KEY_MARK', 0);
101121define('NCURSES_KEY_MAX', 0);
101122define('NCURSES_KEY_MESSAGE', 0);
101123define('NCURSES_KEY_MOUSE', 0);
101124define('NCURSES_KEY_MOVE', 0);
101125define('NCURSES_KEY_NEXT', 0);
101126define('NCURSES_KEY_NPAGE', 0);
101127define('NCURSES_KEY_OPEN', 0);
101128define('NCURSES_KEY_OPTIONS', 0);
101129define('NCURSES_KEY_PPAGE', 0);
101130define('NCURSES_KEY_PREVIOUS', 0);
101131define('NCURSES_KEY_PRINT', 0);
101132define('NCURSES_KEY_REDO', 0);
101133define('NCURSES_KEY_REFERENCE', 0);
101134define('NCURSES_KEY_REFRESH', 0);
101135define('NCURSES_KEY_REPLACE', 0);
101136define('NCURSES_KEY_RESET', 0);
101137define('NCURSES_KEY_RESTART', 0);
101138define('NCURSES_KEY_RESUME', 0);
101139define('NCURSES_KEY_RIGHT', 0);
101140define('NCURSES_KEY_SAVE', 0);
101141define('NCURSES_KEY_SBEG', 0);
101142define('NCURSES_KEY_SCANCEL', 0);
101143define('NCURSES_KEY_SCOMMAND', 0);
101144define('NCURSES_KEY_SCOPY', 0);
101145define('NCURSES_KEY_SCREATE', 0);
101146define('NCURSES_KEY_SDC', 0);
101147define('NCURSES_KEY_SDL', 0);
101148define('NCURSES_KEY_SELECT', 0);
101149define('NCURSES_KEY_SEND', 0);
101150define('NCURSES_KEY_SEOL', 0);
101151define('NCURSES_KEY_SEXIT', 0);
101152define('NCURSES_KEY_SF', 0);
101153define('NCURSES_KEY_SFIND', 0);
101154define('NCURSES_KEY_SHELP', 0);
101155define('NCURSES_KEY_SHOME', 0);
101156define('NCURSES_KEY_SIC', 0);
101157define('NCURSES_KEY_SLEFT', 0);
101158define('NCURSES_KEY_SMESSAGE', 0);
101159define('NCURSES_KEY_SMOVE', 0);
101160define('NCURSES_KEY_SNEXT', 0);
101161define('NCURSES_KEY_SOPTIONS', 0);
101162define('NCURSES_KEY_SPREVIOUS', 0);
101163define('NCURSES_KEY_SPRINT', 0);
101164define('NCURSES_KEY_SR', 0);
101165define('NCURSES_KEY_SREDO', 0);
101166define('NCURSES_KEY_SREPLACE', 0);
101167define('NCURSES_KEY_SRESET', 0);
101168define('NCURSES_KEY_SRIGHT', 0);
101169define('NCURSES_KEY_SRSUME', 0);
101170define('NCURSES_KEY_SSAVE', 0);
101171define('NCURSES_KEY_SSUSPEND', 0);
101172define('NCURSES_KEY_STAB', 0);
101173define('NCURSES_KEY_UNDO', 0);
101174define('NCURSES_KEY_UP', 0);
101175define('NCURSES_REPORT_MOUSE_POSITION', 0);
101176define('NEGATIVE_SIGN', 0);
101177define('NEWT_ANCHOR_BOTTOM', 0);
101178define('NEWT_ANCHOR_LEFT', 0);
101179define('NEWT_ANCHOR_RIGHT', 0);
101180define('NEWT_ANCHOR_TOP', 0);
101181define('NEWT_ARG_APPEND', 0);
101182define('NEWT_ARG_LAST', 0);
101183define('NEWT_CHECKBOXTREE_COLLAPSED', 0);
101184define('NEWT_CHECKBOXTREE_EXPANDED', 0);
101185define('NEWT_CHECKBOXTREE_HIDE_BOX', 0);
101186define('NEWT_CHECKBOXTREE_SELECTED', 0);
101187define('NEWT_CHECKBOXTREE_UNSELECTABLE', 0);
101188define('NEWT_CHECKBOXTREE_UNSELECTED', 0);
101189define('NEWT_COLORSET_ACTBUTTON', 0);
101190define('NEWT_COLORSET_ACTCHECKBOX', 0);
101191define('NEWT_COLORSET_ACTLISTBOX', 0);
101192define('NEWT_COLORSET_ACTSELLISTBOX', 0);
101193define('NEWT_COLORSET_ACTTEXTBOX', 0);
101194define('NEWT_COLORSET_BORDER', 0);
101195define('NEWT_COLORSET_BUTTON', 0);
101196define('NEWT_COLORSET_CHECKBOX', 0);
101197define('NEWT_COLORSET_COMPACTBUTTON', 0);
101198define('NEWT_COLORSET_DISENTRY', 0);
101199define('NEWT_COLORSET_EMPTYSCALE', 0);
101200define('NEWT_COLORSET_ENTRY', 0);
101201define('NEWT_COLORSET_FULLSCALE', 0);
101202define('NEWT_COLORSET_HELPLINE', 0);
101203define('NEWT_COLORSET_LABEL', 0);
101204define('NEWT_COLORSET_LISTBOX', 0);
101205define('NEWT_COLORSET_ROOT', 0);
101206define('NEWT_COLORSET_ROOTTEXT', 0);
101207define('NEWT_COLORSET_SELLISTBOX', 0);
101208define('NEWT_COLORSET_SHADOW', 0);
101209define('NEWT_COLORSET_TEXTBOX', 0);
101210define('NEWT_COLORSET_TITLE', 0);
101211define('NEWT_COLORSET_WINDOW', 0);
101212define('NEWT_ENTRY_DISABLED', 0);
101213define('NEWT_ENTRY_HIDDEN', 0);
101214define('NEWT_ENTRY_RETURNEXIT', 0);
101215define('NEWT_ENTRY_SCROLL', 0);
101216define('NEWT_EXIT_COMPONENT', 0);
101217define('NEWT_EXIT_FDREADY', 0);
101218define('NEWT_EXIT_HOTKEY', 0);
101219define('NEWT_EXIT_TIMER', 0);
101220define('NEWT_FD_EXCEPT', 0);
101221define('NEWT_FD_READ', 0);
101222define('NEWT_FD_WRITE', 0);
101223define('NEWT_FLAGS_RESET', 0);
101224define('NEWT_FLAGS_SET', 0);
101225define('NEWT_FLAGS_TOGGLE', 0);
101226define('NEWT_FLAG_BORDER', 0);
101227define('NEWT_FLAG_CHECKBOX', 0);
101228define('NEWT_FLAG_DISABLED', 0);
101229define('NEWT_FLAG_HIDDEN', 0);
101230define('NEWT_FLAG_MULTIPLE', 0);
101231define('NEWT_FLAG_NOF12', 0);
101232define('NEWT_FLAG_PASSWORD', 0);
101233define('NEWT_FLAG_RETURNEXIT', 0);
101234define('NEWT_FLAG_SCROLL', 0);
101235define('NEWT_FLAG_SELECTED', 0);
101236define('NEWT_FLAG_SHOWCURSOR', 0);
101237define('NEWT_FLAG_WRAP', 0);
101238define('NEWT_FORM_NOF12', 0);
101239define('NEWT_GRID_COMPONENT', 0);
101240define('NEWT_GRID_EMPTY', 0);
101241define('NEWT_GRID_FLAG_GROWX', 0);
101242define('NEWT_GRID_FLAG_GROWY', 0);
101243define('NEWT_GRID_SUBGRID', 0);
101244define('NEWT_KEY_BKSPC', 0);
101245define('NEWT_KEY_DELETE', 0);
101246define('NEWT_KEY_DOWN', 0);
101247define('NEWT_KEY_END', 0);
101248define('NEWT_KEY_ENTER', 0);
101249define('NEWT_KEY_ESCAPE', 0);
101250define('NEWT_KEY_EXTRA_BASE', 0);
101251define('NEWT_KEY_F1', 0);
101252define('NEWT_KEY_F2', 0);
101253define('NEWT_KEY_F3', 0);
101254define('NEWT_KEY_F4', 0);
101255define('NEWT_KEY_F5', 0);
101256define('NEWT_KEY_F6', 0);
101257define('NEWT_KEY_F7', 0);
101258define('NEWT_KEY_F8', 0);
101259define('NEWT_KEY_F9', 0);
101260define('NEWT_KEY_F10', 0);
101261define('NEWT_KEY_F11', 0);
101262define('NEWT_KEY_F12', 0);
101263define('NEWT_KEY_HOME', 0);
101264define('NEWT_KEY_INSERT', 0);
101265define('NEWT_KEY_LEFT', 0);
101266define('NEWT_KEY_PGDN', 0);
101267define('NEWT_KEY_PGUP', 0);
101268define('NEWT_KEY_RESIZE', 0);
101269define('NEWT_KEY_RETURN', 0);
101270define('NEWT_KEY_RIGHT', 0);
101271define('NEWT_KEY_SUSPEND', 0);
101272define('NEWT_KEY_TAB', 0);
101273define('NEWT_KEY_UNTAB', 0);
101274define('NEWT_KEY_UP', 0);
101275define('NEWT_LISTBOX_RETURNEXIT', 0);
101276define('NEWT_TEXTBOX_SCROLL', 0);
101277define('NEWT_TEXTBOX_WRAP', 0);
101278define('NIL', 0);
101279define('NOEXPR', 0);
101280/**
101281 * Ignore case sensitivity.
101282 **/
101283define('NORM_IGNORECASE', 0);
101284/**
101285 * Ignore Kana type.
101286 **/
101287define('NORM_IGNOREKANATYPE', 0);
101288/**
101289 * Ignore Arabic kashida characters.
101290 **/
101291define('NORM_IGNOREKASHIDA', 0);
101292/**
101293 * Ignore nonspacing characters.
101294 **/
101295define('NORM_IGNORENONSPACE', 0);
101296/**
101297 * Ignore symbols.
101298 **/
101299define('NORM_IGNORESYMBOLS', 0);
101300/**
101301 * Ignore string width.
101302 **/
101303define('NORM_IGNOREWIDTH', 0);
101304define('NOSTR', 0);
101305define('N_CS_PRECEDES', 0);
101306define('N_SEP_BY_SPACE', 0);
101307define('N_SIGN_POSN', 0);
101308define('OCI_B_BFILE', 0);
101309define('OCI_B_BLOB', 0);
101310define('OCI_B_CFILEE', 0);
101311define('OCI_B_CLOB', 0);
101312define('OCI_B_CURSOR', 0);
101313define('OCI_B_INT', 0);
101314define('OCI_B_NTY', 0);
101315define('OCI_B_NUM', 0);
101316define('OCI_B_ROWID', 0);
101317define('OCI_B_SQLT_NTY', 0);
101318define('OCI_DEFAULT', 0);
101319define('OCI_DTYPE_FILE', 0);
101320define('OCI_DTYPE_LOB', 0);
101321define('OCI_DTYPE_ROWID', 0);
101322define('OCI_NO_AUTO_COMMIT', 0);
101323define('ODBC_BINMODE_CONVERT', 0);
101324define('ODBC_BINMODE_PASSTHRU', 0);
101325define('ODBC_BINMODE_RETURN', 0);
101326define('ODBC_TYPE', 0);
101327define('OGGVORBIS_PCM_S8', 0);
101328define('OGGVORBIS_PCM_S16_BE', 0);
101329define('OGGVORBIS_PCM_S16_LE', 0);
101330define('OGGVORBIS_PCM_U8', 0);
101331define('OGGVORBIS_PCM_U16_BE', 0);
101332define('OGGVORBIS_PCM_U16_LE', 0);
101333define('OP_ANONYMOUS', 0);
101334define('OP_DEBUG', 0);
101335define('OP_EXPUNGE', 0);
101336define('OP_HALFOPEN', 0);
101337define('OP_PROTOTYPE', 0);
101338define('OP_READONLY', 0);
101339define('OP_SECURE', 0);
101340define('OP_SHORTCACHE', 0);
101341define('OP_SILENT', 0);
101342define('OutDowntoIdle', 0);
101343define('OutDowntoOverDown', 0);
101344define('OverDowntoIdle', 0);
101345define('OverDowntoOutDown', 0);
101346define('OverUptoIdle', 0);
101347define('OverUptoOverDown', 0);
101348define('O_APPEND', 0);
101349define('O_ASYNC', 0);
101350define('O_CREAT', 0);
101351define('O_EXCL', 0);
101352define('O_NDELAY', 0);
101353define('O_NOCTTY', 0);
101354define('O_NONBLOCK', 0);
101355define('O_RDONLY', 0);
101356define('O_RDWR', 0);
101357define('O_SYNC', 0);
101358define('O_TRUNC', 0);
101359define('O_WRONLY', 0);
101360define('PATHINFO_BASENAME', 0);
101361define('PATHINFO_DIRNAME', 0);
101362define('PATHINFO_EXTENSION', 0);
101363define('PATHINFO_FILENAME', 0);
101364define('PATH_SEPARATOR', '');
101365define('PCRE_VERSION', 0);
101366define('PEAR_EXTENSION_DIR', '');
101367define('PEAR_INSTALL_DIR', '');
101368define('PGSQL_ASSOC', 0);
101369define('PGSQL_BAD_RESPONSE', 0);
101370define('PGSQL_BOTH', 0);
101371define('PGSQL_COMMAND_OK', 0);
101372define('PGSQL_CONNECTION_BAD', 0);
101373define('PGSQL_CONNECTION_OK', 0);
101374define('PGSQL_CONNECT_FORCE_NEW', 0);
101375define('PGSQL_CONV_FORCE_NULL', 0);
101376define('PGSQL_CONV_IGNORE_DEFAULT', 0);
101377define('PGSQL_COPY_IN', 0);
101378define('PGSQL_COPY_OUT', 0);
101379define('PGSQL_DIAG_CONTEXT', 0);
101380define('PGSQL_DIAG_INTERNAL_POSITION', 0);
101381define('PGSQL_DIAG_INTERNAL_QUERY', 0);
101382define('PGSQL_DIAG_MESSAGE_DETAIL', 0);
101383define('PGSQL_DIAG_MESSAGE_HINT', 0);
101384define('PGSQL_DIAG_MESSAGE_PRIMARY', 0);
101385define('PGSQL_DIAG_SEVERITY', 0);
101386define('PGSQL_DIAG_SOURCE_FILE', 0);
101387define('PGSQL_DIAG_SOURCE_FUNCTION', 0);
101388define('PGSQL_DIAG_SOURCE_LINE', 0);
101389define('PGSQL_DIAG_SQLSTATE', 0);
101390define('PGSQL_DIAG_STATEMENT_POSITION', 0);
101391define('PGSQL_EMPTY_QUERY', 0);
101392define('PGSQL_ERRORS_DEFAULT', 0);
101393define('PGSQL_ERRORS_TERSE', 0);
101394define('PGSQL_ERRORS_VERBOSE', 0);
101395define('PGSQL_FATAL_ERROR', 0);
101396define('PGSQL_NONFATAL_ERROR', 0);
101397define('PGSQL_NUM', 0);
101398define('PGSQL_SEEK_CUR', 0);
101399define('PGSQL_SEEK_END', 0);
101400define('PGSQL_SEEK_SET', 0);
101401define('PGSQL_STATUS_LONG', 0);
101402define('PGSQL_STATUS_STRING', 0);
101403define('PGSQL_TRANSACTION_ACTIVE', 0);
101404define('PGSQL_TRANSACTION_IDLE', 0);
101405define('PGSQL_TRANSACTION_INERROR', 0);
101406define('PGSQL_TRANSACTION_INTRANS', 0);
101407define('PGSQL_TRANSACTION_UNKNOWN', 0);
101408define('PGSQL_TUPLES_OK', 0);
101409define('PHP_BINARY_READ', 0);
101410define('PHP_BINDIR', '');
101411define('PHP_CONFIG_FILE_PATH', '');
101412define('PHP_CONFIG_FILE_SCAN_DIR', '');
101413define('PHP_DATADIR', '');
101414define('PHP_DEBUG', 0);
101415define('PHP_EOL', '');
101416define('PHP_EXTENSION_DIR', '');
101417define('PHP_EXTRA_VERSION', '');
101418define('PHP_INT_MAX', 0);
101419define('PHP_INT_SIZE', 0);
101420define('PHP_LIBDIR', '');
101421define('PHP_LOCALSTATEDIR', '');
101422define('PHP_MAJOR_VERSION', 0);
101423define('PHP_MAXPATHLEN', 0);
101424define('PHP_MINOR_VERSION', 0);
101425define('PHP_NORMAL_READ', 0);
101426define('PHP_OS', '');
101427define('PHP_OUTPUT_HANDLER_CONT', 0);
101428define('PHP_OUTPUT_HANDLER_END', 0);
101429define('PHP_OUTPUT_HANDLER_START', 0);
101430define('PHP_PREFIX', '');
101431define('PHP_RELEASE_VERSION', 0);
101432define('PHP_ROUND_HALF_DOWN', 0);
101433define('PHP_ROUND_HALF_EVEN', 0);
101434define('PHP_ROUND_HALF_ODD', 0);
101435define('PHP_ROUND_HALF_UP', 0);
101436define('PHP_SAPI', '');
101437define('PHP_SHLIB_SUFFIX', '');
101438define('PHP_SYSCONFDIR', '');
101439define('PHP_URL_FRAGMENT', 0);
101440define('PHP_URL_HOST', 0);
101441define('PHP_URL_PASS', 0);
101442define('PHP_URL_PATH', 0);
101443define('PHP_URL_PORT', 0);
101444define('PHP_URL_QUERY', 0);
101445define('PHP_URL_SCHEME', 0);
101446define('PHP_URL_USER', 0);
101447define('PHP_VERSION', '');
101448define('PHP_VERSION_ID', 0);
101449define('PHP_WINDOWS_NT_DOMAIN_CONTROLLER', 0);
101450define('PHP_WINDOWS_NT_SERVER', 0);
101451define('PHP_WINDOWS_NT_WORKSTATION', 0);
101452define('PHP_WINDOWS_VERSION_BUILD', 0);
101453define('PHP_WINDOWS_VERSION_MAJOR', 0);
101454define('PHP_WINDOWS_VERSION_MINOR', 0);
101455define('PHP_WINDOWS_VERSION_PLATFORM', 0);
101456define('PHP_WINDOWS_VERSION_PRODUCTTYPE', 0);
101457define('PHP_WINDOWS_VERSION_SP_MAJOR', 0);
101458define('PHP_WINDOWS_VERSION_SP_MINOR', 0);
101459define('PHP_WINDOWS_VERSION_SUITEMASK', 0);
101460define('PHP_ZTS', 0);
101461define('PKCS7_BINARY', 0);
101462define('PKCS7_DETACHED', 0);
101463define('PKCS7_NOATTR', 0);
101464define('PKCS7_NOCERTS', 0);
101465define('PKCS7_NOCHAIN', 0);
101466define('PKCS7_NOINTERN', 0);
101467define('PKCS7_NOSIGS', 0);
101468define('PKCS7_NOVERIFY', 0);
101469define('PKCS7_TEXT', 0);
101470define('PM_STR', 0);
101471define('PNG_ALL_FILTERS', 0);
101472define('PNG_FILTER_AVG', 0);
101473define('PNG_FILTER_NONE', 0);
101474define('PNG_FILTER_PAETH', 0);
101475define('PNG_FILTER_SUB', 0);
101476define('PNG_FILTER_UP', 0);
101477define('PNG_NO_FILTER', 0);
101478define('POLL_ERR', 0);
101479define('POLL_HUP', 0);
101480define('POLL_IN', 0);
101481define('POLL_MSG', 0);
101482define('POLL_OUT', 0);
101483define('POLL_PRI', 0);
101484define('POSITIVE_SIGN', 0);
101485define('POSIX_F_OK', 0);
101486define('POSIX_R_OK', 0);
101487define('POSIX_S_IFBLK', 0);
101488define('POSIX_S_IFCHR', 0);
101489define('POSIX_S_IFIFO', 0);
101490define('POSIX_S_IFREG', 0);
101491define('POSIX_S_IFSOCK', 0);
101492define('POSIX_W_OK', 0);
101493define('POSIX_X_OK', 0);
101494define('PREG_BACKTRACK_LIMIT_ERROR', 0);
101495define('PREG_BAD_UTF8_ERROR', 0);
101496define('PREG_BAD_UTF8_OFFSET_ERROR', 0);
101497define('PREG_INTERNAL_ERROR', 0);
101498define('PREG_NO_ERROR', 0);
101499define('PREG_OFFSET_CAPTURE', 0);
101500define('PREG_PATTERN_ORDER', 0);
101501define('PREG_RECURSION_LIMIT_ERROR', 0);
101502define('PREG_SET_ORDER', 0);
101503define('PREG_SPLIT_DELIM_CAPTURE', 0);
101504define('PREG_SPLIT_NO_EMPTY', 0);
101505define('PREG_SPLIT_OFFSET_CAPTURE', 0);
101506define('PRINTER_BACKGROUND_COLOR', 0);
101507define('PRINTER_BRUSH_CROSS', 0);
101508define('PRINTER_BRUSH_CUSTOM', 0);
101509define('PRINTER_BRUSH_DIAGCROSS', 0);
101510define('PRINTER_BRUSH_DIAGONAL', 0);
101511define('PRINTER_BRUSH_FDIAGONAL', 0);
101512define('PRINTER_BRUSH_HORIZONTAL', 0);
101513define('PRINTER_BRUSH_SOLID', 0);
101514define('PRINTER_BRUSH_VERTICAL', 0);
101515define('PRINTER_COPIES', 0);
101516define('PRINTER_DEVICENAME', 0);
101517define('PRINTER_DRIVERVERSION', 0);
101518define('PRINTER_ENUM_CONNECTIONS', 0);
101519define('PRINTER_ENUM_DEFAULT', 0);
101520define('PRINTER_ENUM_LOCAL', 0);
101521define('PRINTER_ENUM_NAME', 0);
101522define('PRINTER_ENUM_NETWORK', 0);
101523define('PRINTER_ENUM_REMOTE', 0);
101524define('PRINTER_ENUM_SHARED', 0);
101525define('PRINTER_FORMAT_A3', 0);
101526define('PRINTER_FORMAT_A4', 0);
101527define('PRINTER_FORMAT_A5', 0);
101528define('PRINTER_FORMAT_B4', 0);
101529define('PRINTER_FORMAT_B5', 0);
101530define('PRINTER_FORMAT_CUSTOM', 0);
101531define('PRINTER_FORMAT_FOLIO', 0);
101532define('PRINTER_FORMAT_LEGAL', 0);
101533define('PRINTER_FORMAT_LETTER', 0);
101534define('PRINTER_FW_BOLD', 0);
101535define('PRINTER_FW_HEAVY', 0);
101536define('PRINTER_FW_LIGHT', 0);
101537define('PRINTER_FW_MEDIUM', 0);
101538define('PRINTER_FW_NORMAL', 0);
101539define('PRINTER_FW_THIN', 0);
101540define('PRINTER_FW_ULTRABOLD', 0);
101541define('PRINTER_FW_ULTRALIGHT', 0);
101542define('PRINTER_MODE', 0);
101543define('PRINTER_ORIENTATION', 0);
101544define('PRINTER_ORIENTATION_LANDSCAPE', 0);
101545define('PRINTER_ORIENTATION_PORTRAIT', 0);
101546define('PRINTER_OUTPUT_FILE', 0);
101547define('PRINTER_PAPER_FORMAT', 0);
101548define('PRINTER_PAPER_LENGTH', 0);
101549define('PRINTER_PAPER_WIDTH', 0);
101550define('PRINTER_PEN_DASH', 0);
101551define('PRINTER_PEN_DASHDOT', 0);
101552define('PRINTER_PEN_DASHDOTDOT', 0);
101553define('PRINTER_PEN_DOT', 0);
101554define('PRINTER_PEN_INVISIBLE', 0);
101555define('PRINTER_PEN_SOLID', 0);
101556define('PRINTER_RESOLUTION_X', 0);
101557define('PRINTER_RESOLUTION_Y', 0);
101558define('PRINTER_SCALE', 0);
101559define('PRINTER_TA_BASELINE', 0);
101560define('PRINTER_TA_BOTTOM', 0);
101561define('PRINTER_TA_CENTER', 0);
101562define('PRINTER_TA_LEFT', 0);
101563define('PRINTER_TA_RIGHT', 0);
101564define('PRINTER_TA_TOP', 0);
101565define('PRINTER_TEXT_ALIGN', 0);
101566define('PRINTER_TEXT_COLOR', 0);
101567define('PRINTER_TITLE', 0);
101568define('PROF_TRACE', 0);
101569define('PSFS_ERR_FATAL', 0);
101570define('PSFS_FEED_ME', 0);
101571define('PSFS_FLAG_FLUSH_CLOSE', 0);
101572define('PSFS_FLAG_FLUSH_INC', 0);
101573define('PSFS_FLAG_NORMAL', 0);
101574define('PSFS_PASS_ON', 0);
101575define('PSPELL_BAD_SPELLERS', 0);
101576define('PSPELL_FAST', 0);
101577define('PSPELL_NORMAL', 0);
101578define('PSPELL_RUN_TOGETHER', 0);
101579define('P_CS_PRECEDES', 0);
101580define('P_SEP_BY_SPACE', 0);
101581define('P_SIGN_POSN', 0);
101582define('RADIXCHAR', 0);
101583define('RAR_HOST_BEOS', 0);
101584define('RAR_HOST_MSDOS', 0);
101585define('RAR_HOST_OS2', 0);
101586define('RAR_HOST_UNIX', 0);
101587define('RAR_HOST_WIN32', 0);
101588define('RUNKIT_ACC_PRIVATE', 0);
101589define('RUNKIT_ACC_PROTECTED', 0);
101590define('RUNKIT_ACC_PUBLIC', 0);
101591define('RUNKIT_IMPORT_CLASSES', 0);
101592define('RUNKIT_IMPORT_CLASS_CONSTS', 0);
101593define('RUNKIT_IMPORT_CLASS_METHODS', 0);
101594define('RUNKIT_IMPORT_CLASS_PROPS', 0);
101595define('RUNKIT_IMPORT_FUNCTIONS', 0);
101596define('RUNKIT_IMPORT_OVERRIDE', 0);
101597define('RUNKIT_VERSION', '');
101598define('SAM_AUTO', '');
101599define('SAM_BOOLEAN', '');
101600define('SAM_BUS', '');
101601define('SAM_BYTE', '');
101602define('SAM_BYTES', '');
101603define('SAM_CORRELID', '');
101604define('SAM_DELIVERYMODE', '');
101605define('SAM_DOUBLE', '');
101606define('SAM_ENDPOINTS', '');
101607define('SAM_FLOAT', '');
101608define('SAM_HOST', '');
101609define('SAM_INT', '');
101610define('SAM_LONG', '');
101611define('SAM_MANUAL', '');
101612define('SAM_MESSAGEID', '');
101613define('SAM_MQTT', '');
101614define('SAM_MQTT_CLEANSTART', false);
101615define('SAM_NON_PERSISTENT', '');
101616define('SAM_PASSWORD', '');
101617define('SAM_PERSISTENT', '');
101618define('SAM_PORT', '');
101619define('SAM_PRIORITY', '');
101620define('SAM_REPLY_TO', '');
101621define('SAM_RTT', '');
101622define('SAM_STRING', '');
101623define('SAM_TARGETCHAIN', '');
101624define('SAM_TEXT', '');
101625define('SAM_TIMETOLIVE', '');
101626define('SAM_TRANSACTIONS', '');
101627define('SAM_USERID', '');
101628define('SAM_WAIT', '');
101629define('SAM_WMQ', '');
101630define('SAM_WMQ_BINDINGS', '');
101631define('SAM_WMQ_CLIENT', '');
101632define('SAM_WMQ_TARGET_CLIENT', '');
101633define('SAM_WPM', '');
101634define('SA_ALL', 0);
101635define('SA_MESSAGES', 0);
101636define('SA_RECENT', 0);
101637define('SA_UIDNEXT', 0);
101638define('SA_UIDVALIDITY', 0);
101639define('SA_UNSEEN', 0);
101640define('SEEK_CUR', 0);
101641define('SEEK_END', 0);
101642define('SEEK_SET', 0);
101643define('SEGV_ACCERR', 0);
101644define('SEGV_MAPERR', 0);
101645define('SE_FREE', 0);
101646define('SE_NOPREFETCH', 0);
101647define('SE_UID', 0);
101648define('SID', '');
101649define('SIGABRT', 0);
101650define('SIGALRM', 0);
101651define('SIGBABY', 0);
101652define('SIGBUS', 0);
101653define('SIGCHLD', 0);
101654define('SIGCLD', 0);
101655define('SIGCONT', 0);
101656define('SIGFPE', 0);
101657define('SIGHUP', 0);
101658define('SIGILL', 0);
101659define('SIGINT', 0);
101660define('SIGIO', 0);
101661define('SIGIOT', 0);
101662define('SIGKILL', 0);
101663define('SIGPIPE', 0);
101664define('SIGPOLL', 0);
101665define('SIGPROF', 0);
101666define('SIGPWR', 0);
101667define('SIGQUIT', 0);
101668define('SIGSEGV', 0);
101669define('SIGSTKFLT', 0);
101670define('SIGSTOP', 0);
101671define('SIGSYS', 0);
101672define('SIGTERM', 0);
101673define('SIGTRAP', 0);
101674define('SIGTSTP', 0);
101675define('SIGTTIN', 0);
101676define('SIGTTOU', 0);
101677define('SIGURG', 0);
101678define('SIGUSR1', 0);
101679define('SIGUSR2', 0);
101680define('SIGVTALRM', 0);
101681define('SIGWINCH', 0);
101682define('SIGXCPU', 0);
101683define('SIGXFSZ', 0);
101684define('SIG_BLOCK', 0);
101685define('SIG_DFL', 0);
101686define('SIG_ERR', 0);
101687define('SIG_IGN', 0);
101688define('SIG_SETMASK', 0);
101689define('SIG_UNBLOCK', 0);
101690define('SI_ASYNCIO', 0);
101691define('SI_KERNEL', 0);
101692define('SI_MSGGQ', 0);
101693define('SI_NOINFO', 0);
101694define('SI_QUEUE', 0);
101695define('SI_SIGIO', 0);
101696define('SI_TIMER', 0);
101697define('SI_TKILL', 0);
101698define('SI_USER', 0);
101699define('SNMP_BIT_STR', 0);
101700define('SNMP_COUNTER', 0);
101701define('SNMP_COUNTER64', 0);
101702define('SNMP_INTEGER', 0);
101703define('SNMP_IPADDRESS', 0);
101704define('SNMP_NULL', 0);
101705define('SNMP_OBJECT_ID', 0);
101706define('SNMP_OCTET_STR', 0);
101707define('SNMP_OID_OUTPUT_FULL', 0);
101708define('SNMP_OID_OUTPUT_NUMERIC', 0);
101709define('SNMP_OPAQUE', 0);
101710define('SNMP_TIMETICKS', 0);
101711define('SNMP_UINTEGER', 0);
101712define('SNMP_UNSIGNED', 0);
101713define('SNMP_VALUE_LIBRARY', 0);
101714define('SNMP_VALUE_OBJECT', 0);
101715define('SNMP_VALUE_PLAIN', 0);
101716define('SOAP_1_1', 0);
101717define('SOAP_1_2', 0);
101718define('SOAP_ACTOR_NEXT', 0);
101719define('SOAP_ACTOR_NONE', 0);
101720define('SOAP_ACTOR_UNLIMATERECEIVER', 0);
101721define('SOAP_AUTHENTICATION_BASIC', 0);
101722define('SOAP_AUTHENTICATION_DIGEST', 0);
101723define('SOAP_COMPRESSION_ACCEPT', 0);
101724define('SOAP_COMPRESSION_DEFLATE', 0);
101725define('SOAP_COMPRESSION_GZIP', 0);
101726define('SOAP_DOCUMENT', 0);
101727define('SOAP_ENCODED', 0);
101728define('SOAP_ENC_ARRAY', 0);
101729define('SOAP_ENC_OBJECT', 0);
101730define('SOAP_FUNCTIONS_ALL', 0);
101731define('SOAP_LITERAL', 0);
101732define('SOAP_PERSISTENCE_REQUEST', 0);
101733define('SOAP_PERSISTENCE_SESSION', 0);
101734define('SOAP_RPC', 0);
101735define('SOAP_SINGLE_ELEMENT_ARRAYS', 0);
101736define('SOAP_USE_XSI_ARRAY_TYPE', 0);
101737define('SOAP_WAIT_ONE_WAY_CALLS', 0);
101738define('SOCK_DGRAM', 0);
101739define('SOCK_RAW', 0);
101740define('SOCK_RDM', 0);
101741define('SOCK_SEQPACKET', 0);
101742define('SOCK_STREAM', 0);
101743define('SOL_SOCKET', 0);
101744define('SOL_TCP', 0);
101745define('SOL_UDP', 0);
101746define('SORTARRIVAL', 0);
101747define('SORTCC', 0);
101748define('SORTDATE', 0);
101749define('SORTFROM', 0);
101750define('SORTSIZE', 0);
101751define('SORTSUBJECT', 0);
101752define('SORTTO', 0);
101753define('SORT_ASC', 0);
101754define('SORT_DESC', 0);
101755define('SORT_NUMERIC', 0);
101756define('SORT_REGULAR', 0);
101757define('SORT_STRING', 0);
101758define('SO_BROADCAST', 0);
101759define('SO_DEBUG', 0);
101760define('SO_DONTROUTE', 0);
101761define('SO_ERROR', 0);
101762define('SO_FREE', 0);
101763define('SO_KEEPALIVE', 0);
101764define('SO_LINGER', 0);
101765define('SO_NOSERVER', 0);
101766define('SO_OOBINLINE', 0);
101767define('SO_RCVBUF', 0);
101768define('SO_RCVLOWAT', 0);
101769define('SO_RCVTIMEO', 0);
101770define('SO_REUSEADDR', 0);
101771define('SO_SNDBUF', 0);
101772define('SO_SNDLOWAT', 0);
101773define('SO_SNDTIMEO', 0);
101774define('SO_TYPE', 0);
101775define('SQLBIT', 0);
101776define('SQLCHAR', 0);
101777define('SQLFLT4', 0);
101778define('SQLFLT8', 0);
101779define('SQLINT1', 0);
101780define('SQLINT2', 0);
101781define('SQLINT4', 0);
101782define('SQLITE_ASSOC', 0);
101783define('SQLITE_BOTH', 0);
101784define('SQLITE_NUM', 0);
101785define('SQLTEXT', 0);
101786define('SQLVARCHAR', 0);
101787define('SQL_BEST_ROWID', 0);
101788define('SQL_BIGINT', 0);
101789define('SQL_BINARY', 0);
101790define('SQL_BIT', 0);
101791define('SQL_CHAR', 0);
101792define('SQL_CONCURRENCY', 0);
101793define('SQL_CONCUR_LOCK', 0);
101794define('SQL_CONCUR_READ_ONLY', 0);
101795define('SQL_CONCUR_ROWVER', 0);
101796define('SQL_CONCUR_VALUES', 0);
101797define('SQL_CURSOR_DYNAMIC', 0);
101798define('SQL_CURSOR_FORWARD_ONLY', 0);
101799define('SQL_CURSOR_KEYSET_DRIVEN', 0);
101800define('SQL_CURSOR_STATIC', 0);
101801define('SQL_CURSOR_TYPE', 0);
101802define('SQL_CUR_USE_DRIVER', 0);
101803define('SQL_CUR_USE_IF_NEEDED', 0);
101804define('SQL_CUR_USE_ODBC', 0);
101805define('SQL_DATE', 0);
101806define('SQL_DECIMAL', 0);
101807define('SQL_DOUBLE', 0);
101808define('SQL_ENSURE', 0);
101809define('SQL_FLOAT', 0);
101810define('SQL_INDEX_ALL', 0);
101811define('SQL_INDEX_UNIQUE', 0);
101812define('SQL_INTEGER', 0);
101813define('SQL_KEYSET_SIZE', 0);
101814define('SQL_LONGVARBINARY', 0);
101815define('SQL_LONGVARCHAR', 0);
101816define('SQL_NO_NULLS', 0);
101817define('SQL_NULLABLE', 0);
101818define('SQL_NUMERIC', 0);
101819define('SQL_ODBC_CURSORS', 0);
101820define('SQL_QUICK', 0);
101821define('SQL_REAL', 0);
101822define('SQL_ROWVER', 0);
101823define('SQL_SCOPE_CURROW', 0);
101824define('SQL_SCOPE_SESSION', 0);
101825define('SQL_SCOPE_TRANSACTION', 0);
101826define('SQL_SMALLINT', 0);
101827define('SQL_TIME', 0);
101828define('SQL_TIMESTAMP', 0);
101829define('SQL_TINYINT', 0);
101830define('SQL_TYPE_DATE', 0);
101831define('SQL_TYPE_TIME', 0);
101832define('SQL_TYPE_TIMESTAMP', 0);
101833define('SQL_VARBINARY', 0);
101834define('SQL_VARCHAR', 0);
101835define('SSH2_DEFAULT_TERMINAL', '');
101836define('SSH2_DEFAULT_TERM_HEIGHT', 0);
101837define('SSH2_DEFAULT_TERM_UNIT', 0);
101838define('SSH2_DEFAULT_TERM_WIDTH', 0);
101839define('SSH2_FINGERPRINT_HEX', 0);
101840define('SSH2_FINGERPRINT_MD5', 0);
101841define('SSH2_FINGERPRINT_RAW', 0);
101842define('SSH2_FINGERPRINT_SHA1', 0);
101843define('SSH2_STREAM_STDERR', 0);
101844define('SSH2_STREAM_STDIO', 0);
101845define('SSH2_TERM_UNIT_CHARS', 0);
101846define('SSH2_TERM_UNIT_PIXELS', 0);
101847define('STATEMENT_TRACE', 0);
101848/**
101849 * An already opened stream to stderr. This saves opening it with
101850 *
101851 * <?php $stderr = fopen('php://stderr', 'w'); ?>
101852 **/
101853define('STDERR', 0);
101854/**
101855 * An already opened stream to stdin. This saves opening it with
101856 *
101857 * <?php $stdin = fopen('php://stdin', 'r'); ?>
101858 *
101859 * If you want to read single line from stdin, you can use
101860 *
101861 * <?php $line = trim(fgets(STDIN)); // reads one line from STDIN
101862 * fscanf(STDIN, "%d\n", $number); // reads number from STDIN ?>
101863 **/
101864define('STDIN', 0);
101865/**
101866 * An already opened stream to stdout. This saves opening it with
101867 *
101868 * <?php $stdout = fopen('php://stdout', 'w'); ?>
101869 **/
101870define('STDOUT', 0);
101871define('STREAM_CAST_AS_STREAM', 0);
101872define('STREAM_CAST_FOR_SELECT', 0);
101873define('STREAM_CLIENT_ASYNC_CONNECT', 0);
101874define('STREAM_CLIENT_CONNECT', 0);
101875define('STREAM_CLIENT_PERSISTENT', 0);
101876define('STREAM_FILTER_ALL', 0);
101877define('STREAM_FILTER_READ', 0);
101878define('STREAM_FILTER_WRITE', 0);
101879define('STREAM_IPPROTO_ICMP', 0);
101880define('STREAM_IPPROTO_IP', 0);
101881define('STREAM_IPPROTO_RAW', 0);
101882define('STREAM_IPPROTO_TCP', 0);
101883define('STREAM_IPPROTO_UDP', 0);
101884define('STREAM_NOTIFY_AUTH_REQUIRED', 0);
101885define('STREAM_NOTIFY_AUTH_RESULT', 0);
101886define('STREAM_NOTIFY_COMPLETED', 0);
101887define('STREAM_NOTIFY_CONNECT', 0);
101888define('STREAM_NOTIFY_FAILURE', 0);
101889define('STREAM_NOTIFY_FILE_SIZE_IS', 0);
101890define('STREAM_NOTIFY_MIME_TYPE_IS', 0);
101891define('STREAM_NOTIFY_PROGRESS', 0);
101892define('STREAM_NOTIFY_REDIRECTED', 0);
101893define('STREAM_NOTIFY_RESOLVE', 0);
101894define('STREAM_NOTIFY_SEVERITY_ERR', 0);
101895define('STREAM_NOTIFY_SEVERITY_INFO', 0);
101896define('STREAM_NOTIFY_SEVERITY_WARN', 0);
101897define('STREAM_PF_INET', 0);
101898define('STREAM_PF_INET6', 0);
101899define('STREAM_PF_UNIX', 0);
101900define('STREAM_REPORT_ERRORS', 0);
101901define('STREAM_SERVER_BIND', 0);
101902define('STREAM_SERVER_LISTEN', 0);
101903define('STREAM_SHUT_RD', 0);
101904define('STREAM_SHUT_RDWR', 0);
101905define('STREAM_SHUT_WR', 0);
101906define('STREAM_SOCK_DGRAM', 0);
101907define('STREAM_SOCK_RAW', 0);
101908define('STREAM_SOCK_RDM', 0);
101909define('STREAM_SOCK_SEQPACKET', 0);
101910define('STREAM_SOCK_STREAM', 0);
101911define('STREAM_USE_PATH', 0);
101912define('STR_PAD_BOTH', 0);
101913define('STR_PAD_LEFT', 0);
101914define('STR_PAD_RIGHT', 0);
101915define('ST_SET', 0);
101916define('ST_SILENT', 0);
101917define('ST_UID', 0);
101918define('SUMMARY_TRACE', 0);
101919define('SUNFUNCS_RET_DOUBLE', 0);
101920define('SUNFUNCS_RET_STRING', 0);
101921define('SUNFUNCS_RET_TIMESTAMP', 0);
101922define('SVN_REVISION_HEAD', 0);
101923define('SWFACTION_DATA', 0);
101924define('SWFACTION_ENTERFRAME', 0);
101925define('SWFACTION_KEYDOWN', 0);
101926define('SWFACTION_KEYUP', 0);
101927define('SWFACTION_MOUSEDOWN', 0);
101928define('SWFACTION_MOUSEMOVE', 0);
101929define('SWFACTION_MOUSEUP', 0);
101930define('SWFACTION_ONLOAD', 0);
101931define('SWFACTION_UNLOAD', 0);
101932define('SWFBUTTON_DOWN', 0);
101933define('SWFBUTTON_DRAGOUT', 0);
101934define('SWFBUTTON_DRAGOVER', 0);
101935define('SWFBUTTON_HIT', 0);
101936define('SWFBUTTON_MOUSEDOWN', 0);
101937define('SWFBUTTON_MOUSEOUT', 0);
101938define('SWFBUTTON_MOUSEOVER', 0);
101939define('SWFBUTTON_MOUSEUP', 0);
101940define('SWFBUTTON_MOUSEUPOUTSIDE', 0);
101941define('SWFBUTTON_OVER', 0);
101942define('SWFBUTTON_UP', 0);
101943define('SWFFILL_CLIPPED_BITMAP', 0);
101944define('SWFFILL_LINEAR_GRADIENT', 0);
101945define('SWFFILL_RADIAL_GRADIENT', 0);
101946define('SWFFILL_TILED_BITMAP', 0);
101947define('SWFTEXTFIELD_ALIGN_CENTER', 0);
101948define('SWFTEXTFIELD_ALIGN_JUSTIFY', 0);
101949define('SWFTEXTFIELD_ALIGN_LEFT', 0);
101950define('SWFTEXTFIELD_ALIGN_RIGHT', 0);
101951define('SWFTEXTFIELD_DRAWBOX', 0);
101952define('SWFTEXTFIELD_HASLENGTH', 0);
101953define('SWFTEXTFIELD_HTML', 0);
101954define('SWFTEXTFIELD_MULTILINE', 0);
101955define('SWFTEXTFIELD_NOEDIT', 0);
101956define('SWFTEXTFIELD_NOSELECT', 0);
101957define('SWFTEXTFIELD_PASSWORD', 0);
101958define('SWFTEXTFIELD_WORDWRAP', 0);
101959define('S_IRGRP', 0);
101960define('S_IROTH', 0);
101961define('S_IRUSR', 0);
101962define('S_IRWXG', 0);
101963define('S_IRWXO', 0);
101964define('S_IRWXU', 0);
101965define('S_IWGRP', 0);
101966define('S_IWOTH', 0);
101967define('S_IWUSR', 0);
101968define('S_IXGRP', 0);
101969define('S_IXOTH', 0);
101970define('S_IXUSR', 0);
101971define('TCP_NODELAY', 0);
101972define('THOUSANDS_SEP', 0);
101973define('THOUSEP', 0);
101974define('TIDY_ATTR_ABBR', 0);
101975define('TIDY_ATTR_ACCEPT', 0);
101976define('TIDY_ATTR_ACCEPT_CHARSET', 0);
101977define('TIDY_ATTR_ACCESSKEY', 0);
101978define('TIDY_ATTR_ACTION', 0);
101979define('TIDY_ATTR_ADD_DATE', 0);
101980define('TIDY_ATTR_ALIGN', 0);
101981define('TIDY_ATTR_ALINK', 0);
101982define('TIDY_ATTR_ALT', 0);
101983define('TIDY_ATTR_ARCHIVE', 0);
101984define('TIDY_ATTR_AXIS', 0);
101985define('TIDY_ATTR_BACKGROUND', 0);
101986define('TIDY_ATTR_BGCOLOR', 0);
101987define('TIDY_ATTR_BGPROPERTIES', 0);
101988define('TIDY_ATTR_BORDER', 0);
101989define('TIDY_ATTR_BORDERCOLOR', 0);
101990define('TIDY_ATTR_BOTTOMMARGIN', 0);
101991define('TIDY_ATTR_CELLPADDING', 0);
101992define('TIDY_ATTR_CELLSPACING', 0);
101993define('TIDY_ATTR_CHAR', 0);
101994define('TIDY_ATTR_CHAROFF', 0);
101995define('TIDY_ATTR_CHARSET', 0);
101996define('TIDY_ATTR_CHECKED', 0);
101997define('TIDY_ATTR_CITE', 0);
101998define('TIDY_ATTR_CLASS', 0);
101999define('TIDY_ATTR_CLASSID', 0);
102000define('TIDY_ATTR_CLEAR', 0);
102001define('TIDY_ATTR_CODE', 0);
102002define('TIDY_ATTR_CODEBASE', 0);
102003define('TIDY_ATTR_CODETYPE', 0);
102004define('TIDY_ATTR_COLOR', 0);
102005define('TIDY_ATTR_COLS', 0);
102006define('TIDY_ATTR_COLSPAN', 0);
102007define('TIDY_ATTR_COMPACT', 0);
102008define('TIDY_ATTR_CONTENT', 0);
102009define('TIDY_ATTR_COORDS', 0);
102010define('TIDY_ATTR_DATA', 0);
102011define('TIDY_ATTR_DATAFLD', 0);
102012define('TIDY_ATTR_DATAPAGESIZE', 0);
102013define('TIDY_ATTR_DATASRC', 0);
102014define('TIDY_ATTR_DATETIME', 0);
102015define('TIDY_ATTR_DECLARE', 0);
102016define('TIDY_ATTR_DEFER', 0);
102017define('TIDY_ATTR_DIR', 0);
102018define('TIDY_ATTR_DISABLED', 0);
102019define('TIDY_ATTR_ENCODING', 0);
102020define('TIDY_ATTR_ENCTYPE', 0);
102021define('TIDY_ATTR_FACE', 0);
102022define('TIDY_ATTR_FOR', 0);
102023define('TIDY_ATTR_FRAME', 0);
102024define('TIDY_ATTR_FRAMEBORDER', 0);
102025define('TIDY_ATTR_FRAMESPACING', 0);
102026define('TIDY_ATTR_GRIDX', 0);
102027define('TIDY_ATTR_GRIDY', 0);
102028define('TIDY_ATTR_HEADERS', 0);
102029define('TIDY_ATTR_HEIGHT', 0);
102030define('TIDY_ATTR_HREF', 0);
102031define('TIDY_ATTR_HREFLANG', 0);
102032define('TIDY_ATTR_HSPACE', 0);
102033define('TIDY_ATTR_HTTP_EQUIV', 0);
102034define('TIDY_ATTR_ID', 0);
102035define('TIDY_ATTR_ISMAP', 0);
102036define('TIDY_ATTR_LABEL', 0);
102037define('TIDY_ATTR_LANG', 0);
102038define('TIDY_ATTR_LANGUAGE', 0);
102039define('TIDY_ATTR_LAST_MODIFIED', 0);
102040define('TIDY_ATTR_LAST_VISIT', 0);
102041define('TIDY_ATTR_LEFTMARGIN', 0);
102042define('TIDY_ATTR_LINK', 0);
102043define('TIDY_ATTR_LONGDESC', 0);
102044define('TIDY_ATTR_LOWSRC', 0);
102045define('TIDY_ATTR_MARGINHEIGHT', 0);
102046define('TIDY_ATTR_MARGINWIDTH', 0);
102047define('TIDY_ATTR_MAXLENGTH', 0);
102048define('TIDY_ATTR_MEDIA', 0);
102049define('TIDY_ATTR_METHOD', 0);
102050define('TIDY_ATTR_MULTIPLE', 0);
102051define('TIDY_ATTR_NAME', 0);
102052define('TIDY_ATTR_NOHREF', 0);
102053define('TIDY_ATTR_NORESIZE', 0);
102054define('TIDY_ATTR_NOSHADE', 0);
102055define('TIDY_ATTR_NOWRAP', 0);
102056define('TIDY_ATTR_OBJECT', 0);
102057define('TIDY_ATTR_OnAFTERUPDATE', 0);
102058define('TIDY_ATTR_OnBEFOREUNLOAD', 0);
102059define('TIDY_ATTR_OnBEFOREUPDATE', 0);
102060define('TIDY_ATTR_OnBLUR', 0);
102061define('TIDY_ATTR_OnCHANGE', 0);
102062define('TIDY_ATTR_OnCLICK', 0);
102063define('TIDY_ATTR_OnDATAAVAILABLE', 0);
102064define('TIDY_ATTR_OnDATASETCHANGED', 0);
102065define('TIDY_ATTR_OnDATASETCOMPLETE', 0);
102066define('TIDY_ATTR_OnDBLCLICK', 0);
102067define('TIDY_ATTR_OnERRORUPDATE', 0);
102068define('TIDY_ATTR_OnFOCUS', 0);
102069define('TIDY_ATTR_OnKEYDOWN', 0);
102070define('TIDY_ATTR_OnKEYPRESS', 0);
102071define('TIDY_ATTR_OnKEYUP', 0);
102072define('TIDY_ATTR_OnLOAD', 0);
102073define('TIDY_ATTR_OnMOUSEDOWN', 0);
102074define('TIDY_ATTR_OnMOUSEMOVE', 0);
102075define('TIDY_ATTR_OnMOUSEOUT', 0);
102076define('TIDY_ATTR_OnMOUSEOVER', 0);
102077define('TIDY_ATTR_OnMOUSEUP', 0);
102078define('TIDY_ATTR_OnRESET', 0);
102079define('TIDY_ATTR_OnROWENTER', 0);
102080define('TIDY_ATTR_OnROWEXIT', 0);
102081define('TIDY_ATTR_OnSELECT', 0);
102082define('TIDY_ATTR_OnSUBMIT', 0);
102083define('TIDY_ATTR_OnUNLOAD', 0);
102084define('TIDY_ATTR_PROFILE', 0);
102085define('TIDY_ATTR_PROMPT', 0);
102086define('TIDY_ATTR_RBSPAN', 0);
102087define('TIDY_ATTR_READONLY', 0);
102088define('TIDY_ATTR_REL', 0);
102089define('TIDY_ATTR_REV', 0);
102090define('TIDY_ATTR_RIGHTMARGIN', 0);
102091define('TIDY_ATTR_ROWS', 0);
102092define('TIDY_ATTR_ROWSPAN', 0);
102093define('TIDY_ATTR_RULES', 0);
102094define('TIDY_ATTR_SCHEME', 0);
102095define('TIDY_ATTR_SCOPE', 0);
102096define('TIDY_ATTR_SCROLLING', 0);
102097define('TIDY_ATTR_SELECTED', 0);
102098define('TIDY_ATTR_SHAPE', 0);
102099define('TIDY_ATTR_SHOWGRID', 0);
102100define('TIDY_ATTR_SHOWGRIDX', 0);
102101define('TIDY_ATTR_SHOWGRIDY', 0);
102102define('TIDY_ATTR_SIZE', 0);
102103define('TIDY_ATTR_SPAN', 0);
102104define('TIDY_ATTR_SRC', 0);
102105define('TIDY_ATTR_STANDBY', 0);
102106define('TIDY_ATTR_START', 0);
102107define('TIDY_ATTR_STYLE', 0);
102108define('TIDY_ATTR_SUMMARY', 0);
102109define('TIDY_ATTR_TABINDEX', 0);
102110define('TIDY_ATTR_TARGET', 0);
102111define('TIDY_ATTR_TEXT', 0);
102112define('TIDY_ATTR_TITLE', 0);
102113define('TIDY_ATTR_TOPMARGIN', 0);
102114define('TIDY_ATTR_TYPE', 0);
102115define('TIDY_ATTR_UNKNOWN', 0);
102116define('TIDY_ATTR_USEMAP', 0);
102117define('TIDY_ATTR_VALIGN', 0);
102118define('TIDY_ATTR_VALUE', 0);
102119define('TIDY_ATTR_VALUETYPE', 0);
102120define('TIDY_ATTR_VERSION', 0);
102121define('TIDY_ATTR_VLINK', 0);
102122define('TIDY_ATTR_VSPACE', 0);
102123define('TIDY_ATTR_WIDTH', 0);
102124define('TIDY_ATTR_WRAP', 0);
102125define('TIDY_ATTR_XMLNS', 0);
102126define('TIDY_ATTR_XML_LANG', 0);
102127define('TIDY_ATTR_XML_SPACE', 0);
102128define('TIDY_NODETYPE_ASP', 0);
102129define('TIDY_NODETYPE_CDATA', 0);
102130define('TIDY_NODETYPE_COMMENT', 0);
102131define('TIDY_NODETYPE_DOCTYPE', 0);
102132define('TIDY_NODETYPE_END', 0);
102133define('TIDY_NODETYPE_JSTE', 0);
102134define('TIDY_NODETYPE_PHP', 0);
102135define('TIDY_NODETYPE_PROCINS', 0);
102136define('TIDY_NODETYPE_ROOT', 0);
102137define('TIDY_NODETYPE_SECTION', 0);
102138define('TIDY_NODETYPE_START', 0);
102139define('TIDY_NODETYPE_STARTEND', 0);
102140define('TIDY_NODETYPE_TEXT', 0);
102141define('TIDY_NODETYPE_XMLDECL', 0);
102142define('TIDY_TAG_A', 0);
102143define('TIDY_TAG_ABBR', 0);
102144define('TIDY_TAG_ACRONYM', 0);
102145define('TIDY_TAG_ALIGN', 0);
102146define('TIDY_TAG_APPLET', 0);
102147define('TIDY_TAG_AREA', 0);
102148define('TIDY_TAG_B', 0);
102149define('TIDY_TAG_BASE', 0);
102150define('TIDY_TAG_BASEFONT', 0);
102151define('TIDY_TAG_BDO', 0);
102152define('TIDY_TAG_BGSOUND', 0);
102153define('TIDY_TAG_BIG', 0);
102154define('TIDY_TAG_BLINK', 0);
102155define('TIDY_TAG_BLOCKQUOTE', 0);
102156define('TIDY_TAG_BODY', 0);
102157define('TIDY_TAG_BR', 0);
102158define('TIDY_TAG_BUTTON', 0);
102159define('TIDY_TAG_CAPTION', 0);
102160define('TIDY_TAG_CENTER', 0);
102161define('TIDY_TAG_CITE', 0);
102162define('TIDY_TAG_CODE', 0);
102163define('TIDY_TAG_COL', 0);
102164define('TIDY_TAG_COLGROUP', 0);
102165define('TIDY_TAG_COMMENT', 0);
102166define('TIDY_TAG_DD', 0);
102167define('TIDY_TAG_DEL', 0);
102168define('TIDY_TAG_DFN', 0);
102169define('TIDY_TAG_DIR', 0);
102170define('TIDY_TAG_DIV', 0);
102171define('TIDY_TAG_DL', 0);
102172define('TIDY_TAG_DT', 0);
102173define('TIDY_TAG_EM', 0);
102174define('TIDY_TAG_EMBED', 0);
102175define('TIDY_TAG_FIELDSET', 0);
102176define('TIDY_TAG_FONT', 0);
102177define('TIDY_TAG_FORM', 0);
102178define('TIDY_TAG_FRAME', 0);
102179define('TIDY_TAG_FRAMESET', 0);
102180define('TIDY_TAG_H1', 0);
102181define('TIDY_TAG_H2', 0);
102182define('TIDY_TAG_H3', 0);
102183define('TIDY_TAG_H4', 0);
102184define('TIDY_TAG_H5', 0);
102185define('TIDY_TAG_H6', 0);
102186define('TIDY_TAG_HEAD', 0);
102187define('TIDY_TAG_HR', 0);
102188define('TIDY_TAG_HTML', 0);
102189define('TIDY_TAG_I', 0);
102190define('TIDY_TAG_IFRAME', 0);
102191define('TIDY_TAG_ILAYER', 0);
102192define('TIDY_TAG_IMG', 0);
102193define('TIDY_TAG_INPUT', 0);
102194define('TIDY_TAG_INS', 0);
102195define('TIDY_TAG_ISINDEX', 0);
102196define('TIDY_TAG_KBD', 0);
102197define('TIDY_TAG_KEYGEN', 0);
102198define('TIDY_TAG_LABEL', 0);
102199define('TIDY_TAG_LAYER', 0);
102200define('TIDY_TAG_LEGEND', 0);
102201define('TIDY_TAG_LI', 0);
102202define('TIDY_TAG_LINK', 0);
102203define('TIDY_TAG_LISTING', 0);
102204define('TIDY_TAG_MAP', 0);
102205define('TIDY_TAG_MARQUEE', 0);
102206define('TIDY_TAG_MENU', 0);
102207define('TIDY_TAG_META', 0);
102208define('TIDY_TAG_MULTICOL', 0);
102209define('TIDY_TAG_NOBR', 0);
102210define('TIDY_TAG_NOEMBED', 0);
102211define('TIDY_TAG_NOFRAMES', 0);
102212define('TIDY_TAG_NOLAYER', 0);
102213define('TIDY_TAG_NOSAVE', 0);
102214define('TIDY_TAG_NOSCRIPT', 0);
102215define('TIDY_TAG_OBJECT', 0);
102216define('TIDY_TAG_OL', 0);
102217define('TIDY_TAG_OPTGROUP', 0);
102218define('TIDY_TAG_OPTION', 0);
102219define('TIDY_TAG_P', 0);
102220define('TIDY_TAG_PARAM', 0);
102221define('TIDY_TAG_PLAINTEXT', 0);
102222define('TIDY_TAG_PRE', 0);
102223define('TIDY_TAG_Q', 0);
102224define('TIDY_TAG_RP', 0);
102225define('TIDY_TAG_RT', 0);
102226define('TIDY_TAG_RTC', 0);
102227define('TIDY_TAG_RUBY', 0);
102228define('TIDY_TAG_S', 0);
102229define('TIDY_TAG_SAMP', 0);
102230define('TIDY_TAG_SCRIPT', 0);
102231define('TIDY_TAG_SELECT', 0);
102232define('TIDY_TAG_SERVER', 0);
102233define('TIDY_TAG_SERVLET', 0);
102234define('TIDY_TAG_SMALL', 0);
102235define('TIDY_TAG_SPACER', 0);
102236define('TIDY_TAG_SPAN', 0);
102237define('TIDY_TAG_STRIKE', 0);
102238define('TIDY_TAG_STRONG', 0);
102239define('TIDY_TAG_STYLE', 0);
102240define('TIDY_TAG_SUB', 0);
102241define('TIDY_TAG_TABLE', 0);
102242define('TIDY_TAG_TBODY', 0);
102243define('TIDY_TAG_TD', 0);
102244define('TIDY_TAG_TEXTAREA', 0);
102245define('TIDY_TAG_TFOOT', 0);
102246define('TIDY_TAG_TH', 0);
102247define('TIDY_TAG_THEAD', 0);
102248define('TIDY_TAG_TITLE', 0);
102249define('TIDY_TAG_TR', 0);
102250define('TIDY_TAG_TT', 0);
102251define('TIDY_TAG_U', 0);
102252define('TIDY_TAG_UL', 0);
102253define('TIDY_TAG_UNKNOWN', 0);
102254define('TIDY_TAG_VAR', 0);
102255define('TIDY_TAG_WBR', 0);
102256define('TIDY_TAG_XMP', 0);
102257define('TIMING_TRACE', 0);
102258define('TRAP_BRKPT', 0);
102259define('TRAP_TRACE', 0);
102260define('TYPEAPPLICATION', 0);
102261define('TYPEAUDIO', 0);
102262define('TYPEIMAGE', 0);
102263define('TYPEMESSAGE', 0);
102264define('TYPEMODEL', 0);
102265define('TYPEMULTIPART', 0);
102266define('TYPEOTHER', 0);
102267define('TYPETEXT', 0);
102268define('TYPEVIDEO', 0);
102269define('TYPE_MENUBUTTON', 0);
102270define('TYPE_PUSHBUTTON', 0);
102271define('T_FMT', 0);
102272define('T_FMT_AMPM', 0);
102273define('UDM_CACHE_DISABLED', 0);
102274define('UDM_CACHE_ENABLED', 0);
102275define('UDM_CROSSWORDS_DISABLED', 0);
102276define('UDM_CROSSWORDS_ENABLED', 0);
102277define('UDM_CROSS_WORDS_DISABLED', 0);
102278define('UDM_CROSS_WORDS_ENABLED', 0);
102279define('UDM_FIELD_CATEGORY', 0);
102280define('UDM_FIELD_CHARSET', 0);
102281define('UDM_FIELD_CONTENT', 0);
102282define('UDM_FIELD_CRC', 0);
102283define('UDM_FIELD_DESC', 0);
102284define('UDM_FIELD_DESCRIPTION', 0);
102285define('UDM_FIELD_KEYWORDS', 0);
102286define('UDM_FIELD_LANG', 0);
102287define('UDM_FIELD_MODIFIED', 0);
102288define('UDM_FIELD_ORDER', 0);
102289define('UDM_FIELD_RATING', 0);
102290define('UDM_FIELD_SCORE', 0);
102291define('UDM_FIELD_SIZE', 0);
102292define('UDM_FIELD_TEXT', 0);
102293define('UDM_FIELD_TITLE', 0);
102294define('UDM_FIELD_URL', 0);
102295define('UDM_FIELD_URLID', 0);
102296define('UDM_ISPELL_PREFIXES_DISABLED', 0);
102297define('UDM_ISPELL_PREFIXES_ENABLED', 0);
102298define('UDM_ISPELL_PREFIX_DISABLED', 0);
102299define('UDM_ISPELL_PREFIX_ENABLED', 0);
102300define('UDM_ISPELL_TYPE_AFFIX', 0);
102301define('UDM_ISPELL_TYPE_DB', 0);
102302define('UDM_ISPELL_TYPE_SERVER', 0);
102303define('UDM_ISPELL_TYPE_SPELL', 0);
102304define('UDM_LIMIT_CAT', 0);
102305define('UDM_LIMIT_DATE', 0);
102306define('UDM_LIMIT_LANG', 0);
102307define('UDM_LIMIT_TAG', 0);
102308define('UDM_LIMIT_URL', 0);
102309define('UDM_MATCH_BEGIN', 0);
102310define('UDM_MATCH_END', 0);
102311define('UDM_MATCH_SUBSTR', 0);
102312define('UDM_MATCH_WORD', 0);
102313define('UDM_MODE_ALL', 0);
102314define('UDM_MODE_ANY', 0);
102315define('UDM_MODE_BOOL', 0);
102316define('UDM_MODE_PHRASE', 0);
102317define('UDM_PARAM_BROWSER_CHARSET', 0);
102318define('UDM_PARAM_CACHE_MODE', 0);
102319define('UDM_PARAM_CHARSET', 0);
102320define('UDM_PARAM_CROSSWORDS', 0);
102321define('UDM_PARAM_CROSS_WORDS', 0);
102322define('UDM_PARAM_DATADIR', 0);
102323define('UDM_PARAM_FIRST_DOC', 0);
102324define('UDM_PARAM_FOUND', 0);
102325define('UDM_PARAM_HLBEG', 0);
102326define('UDM_PARAM_HLEND', 0);
102327define('UDM_PARAM_ISPELL_PREFIX', 0);
102328define('UDM_PARAM_ISPELL_PREFIXES', 0);
102329define('UDM_PARAM_LAST_DOC', 0);
102330define('UDM_PARAM_LOCAL_CHARSET', 0);
102331define('UDM_PARAM_MAX_WORDLEN', 0);
102332define('UDM_PARAM_MAX_WORD_LEN', 0);
102333define('UDM_PARAM_MIN_WORDLEN', 0);
102334define('UDM_PARAM_MIN_WORD_LEN', 0);
102335define('UDM_PARAM_NUM_ROWS', 0);
102336define('UDM_PARAM_PAGE_NUM', 0);
102337define('UDM_PARAM_PAGE_SIZE', 0);
102338define('UDM_PARAM_PHRASE_MODE', 0);
102339define('UDM_PARAM_PREFIX', 0);
102340define('UDM_PARAM_PREFIXES', 0);
102341define('UDM_PARAM_QSTRING', 0);
102342define('UDM_PARAM_REMOTE_ADDR', 0);
102343define('UDM_PARAM_SEARCHD', 0);
102344define('UDM_PARAM_SEARCHTIME', 0);
102345define('UDM_PARAM_SEARCH_MODE', 0);
102346define('UDM_PARAM_SEARCH_TIME', 0);
102347define('UDM_PARAM_STOPFILE', 0);
102348define('UDM_PARAM_STOPTABLE', 0);
102349define('UDM_PARAM_STOP_FILE', 0);
102350define('UDM_PARAM_STOP_TABLE', 0);
102351define('UDM_PARAM_SYNONYM', 0);
102352define('UDM_PARAM_TRACK_MODE', 0);
102353define('UDM_PARAM_VARDIR', 0);
102354define('UDM_PARAM_WEIGHT_FACTOR', 0);
102355define('UDM_PARAM_WORDINFO', 0);
102356define('UDM_PARAM_WORD_INFO', 0);
102357define('UDM_PARAM_WORD_MATCH', 0);
102358define('UDM_PHRASE_DISABLED', 0);
102359define('UDM_PHRASE_ENABLED', 0);
102360define('UDM_PREFIXES_DISABLED', 0);
102361define('UDM_PREFIXES_ENABLED', 0);
102362define('UDM_PREFIX_DISABLED', 0);
102363define('UDM_PREFIX_ENABLED', 0);
102364define('UDM_TRACK_DISABLED', 0);
102365define('UDM_TRACK_ENABLED', 0);
102366define('UNKNOWN_TYPE', 0);
102367/**
102368 * The two parameters are equal.
102369 **/
102370define('VARCMP_EQ', 0);
102371define('VARCMP_GT', 0);
102372define('VARCMP_LT', 0);
102373/**
102374 * Either expression is NULL.
102375 **/
102376define('VARCMP_NULL', 0);
102377define('VT_ARRAY', 0);
102378/**
102379 * Boolean value.
102380 **/
102381define('VT_BOOL', 0);
102382/**
102383 * Pointer to a null-terminated Unicode string.
102384 **/
102385define('VT_BSTR', 0);
102386define('VT_BYREF', 0);
102387/**
102388 * 8-byte two's complement integer (scaled by 10,000).
102389 **/
102390define('VT_CY', 0);
102391define('VT_DATE', 0);
102392/**
102393 * A decimal structure.
102394 **/
102395define('VT_DECIMAL', 0);
102396/**
102397 * A pointer to a pointer to an object was specified.
102398 **/
102399define('VT_DISPATCH', 0);
102400define('VT_EMPTY', 0);
102401/**
102402 * Error code; containing the status code associated with the error.
102403 **/
102404define('VT_ERROR', 0);
102405/**
102406 * 1-byte signed integer.
102407 **/
102408define('VT_I1', 0);
102409/**
102410 * Two bytes representing a 2-byte signed integer value.
102411 **/
102412define('VT_I2', 0);
102413/**
102414 * 4-byte signed integer value.
102415 **/
102416define('VT_I4', 0);
102417define('VT_INT', 0);
102418/**
102419 * NULL pointer reference.
102420 **/
102421define('VT_NULL', 0);
102422/**
102423 * 32-bit IEEE floating point value.
102424 **/
102425define('VT_R4', 0);
102426/**
102427 * 64-bit IEEE floating point value.
102428 **/
102429define('VT_R8', 0);
102430/**
102431 * 1-byte unsigned integer.
102432 **/
102433define('VT_UI1', 0);
102434/**
102435 * 2-byte unsigned integer.
102436 **/
102437define('VT_UI2', 0);
102438/**
102439 * 4-byte unsigned integer.
102440 **/
102441define('VT_UI4', 0);
102442define('VT_UINT', 0);
102443/**
102444 * A pointer to an object that implements the IUnknown interface.
102445 **/
102446define('VT_UNKNOWN', 0);
102447define('VT_VARIANT', 0);
102448define('WIN32_ERROR_CALL_NOT_IMPLEMENTED', 0);
102449define('WIN32_NO_ERROR', 0);
102450define('WIN32_SERVICE_ACCEPT_HARDWAREPROFILECHANGE', 0);
102451define('WIN32_SERVICE_ACCEPT_NETBINDCHANGE', 0);
102452define('WIN32_SERVICE_ACCEPT_PARAMCHANGE', 0);
102453define('WIN32_SERVICE_ACCEPT_PAUSE_CONTINUE', 0);
102454define('WIN32_SERVICE_ACCEPT_POWEREVENT', 0);
102455define('WIN32_SERVICE_ACCEPT_SESSIONCHANGE', 0);
102456define('WIN32_SERVICE_ACCEPT_SHUTDOWN', 0);
102457define('WIN32_SERVICE_ACCEPT_STOP', 0);
102458define('WIN32_SERVICE_CONTINUE_PENDING', 0);
102459define('WIN32_SERVICE_CONTROL_CONTINUE', 0);
102460define('WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE', 0);
102461define('WIN32_SERVICE_CONTROL_INTERROGATE', 0);
102462define('WIN32_SERVICE_CONTROL_PAUSE', 0);
102463define('WIN32_SERVICE_CONTROL_POWEREVENT', 0);
102464define('WIN32_SERVICE_CONTROL_SESSIONCHANGE', 0);
102465define('WIN32_SERVICE_CONTROL_STOP', 0);
102466define('WIN32_SERVICE_FILE_SYSTEM_DRIVER', 0);
102467define('WIN32_SERVICE_INTERACTIVE_PROCESS', 0);
102468define('WIN32_SERVICE_KERNEL_DRIVER', 0);
102469define('WIN32_SERVICE_PAUSED', 0);
102470define('WIN32_SERVICE_PAUSE_PENDING', 0);
102471define('WIN32_SERVICE_RUNNING', 0);
102472define('WIN32_SERVICE_RUNS_IN_SYSTEM_PROCESS', 0);
102473define('WIN32_SERVICE_START_PENDING', 0);
102474define('WIN32_SERVICE_STOPPED', 0);
102475define('WIN32_SERVICE_STOP_PENDING', 0);
102476define('WIN32_SERVICE_WIN32_OWN_PROCESS', 0);
102477define('WIN32_SERVICE_WIN32_SHARE_PROCESS', 0);
102478define('WNOHANG', 0);
102479define('WSDL_CACHE_BOTH', 0);
102480define('WSDL_CACHE_DISK', 0);
102481define('WSDL_CACHE_MEMORY', 0);
102482define('WSDL_CACHE_NONE', 0);
102483define('WUNTRACED', 0);
102484define('XATTR_CREATE', 0);
102485define('XATTR_DONTFOLLOW', 0);
102486define('XATTR_REPLACE', 0);
102487define('XATTR_ROOT', 0);
102488define('XDIFF_PATCH_NORMAL', 0);
102489define('XDIFF_PATCH_REVERSE', 0);
102490define('XML_ATTRIBUTE_CDATA', 0);
102491define('XML_ATTRIBUTE_DECL_NODE', 0);
102492define('XML_ATTRIBUTE_ENTITY', 0);
102493define('XML_ATTRIBUTE_ENUMERATION', 0);
102494define('XML_ATTRIBUTE_ID', 0);
102495define('XML_ATTRIBUTE_IDREF', 0);
102496define('XML_ATTRIBUTE_IDREFS', 0);
102497define('XML_ATTRIBUTE_NMTOKEN', 0);
102498define('XML_ATTRIBUTE_NMTOKENS', 0);
102499/**
102500 * Node is an attribute
102501 **/
102502define('XML_ATTRIBUTE_NODE', 0);
102503define('XML_ATTRIBUTE_NOTATION', 0);
102504define('XML_CDATA_SECTION_NODE', 0);
102505/**
102506 * Node is a comment
102507 **/
102508define('XML_COMMENT_NODE', 0);
102509define('XML_DOCUMENT_FRAG_NODE', 0);
102510/**
102511 * Node is a document
102512 **/
102513define('XML_DOCUMENT_NODE', 0);
102514define('XML_DOCUMENT_TYPE_NODE', 0);
102515define('XML_DTD_NODE', 0);
102516define('XML_ELEMENT_DECL_NODE', 0);
102517/**
102518 * Node is an element
102519 **/
102520define('XML_ELEMENT_NODE', 0);
102521define('XML_ENTITY_DECL_NODE', 0);
102522/**
102523 * Node is an entity like &nbsp;
102524 **/
102525define('XML_ENTITY_NODE', 0);
102526define('XML_ENTITY_REF_NODE', 0);
102527define('XML_ERROR_ASYNC_ENTITY', 0);
102528define('XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF', 0);
102529define('XML_ERROR_BAD_CHAR_REF', 0);
102530define('XML_ERROR_BINARY_ENTITY_REF', 0);
102531define('XML_ERROR_DUPLICATE_ATTRIBUTE', 0);
102532define('XML_ERROR_EXTERNAL_ENTITY_HANDLING', 0);
102533define('XML_ERROR_INCORRECT_ENCODING', 0);
102534define('XML_ERROR_INVALID_TOKEN', 0);
102535define('XML_ERROR_JUNK_AFTER_DOC_ELEMENT', 0);
102536define('XML_ERROR_MISPLACED_XML_PI', 0);
102537define('XML_ERROR_NONE', 0);
102538define('XML_ERROR_NO_ELEMENTS', 0);
102539define('XML_ERROR_NO_MEMORY', 0);
102540define('XML_ERROR_PARAM_ENTITY_REF', 0);
102541define('XML_ERROR_PARTIAL_CHAR', 0);
102542define('XML_ERROR_RECURSIVE_ENTITY_REF', 0);
102543define('XML_ERROR_SYNTAX', 0);
102544define('XML_ERROR_TAG_MISMATCH', 0);
102545define('XML_ERROR_UNCLOSED_CDATA_SECTION', 0);
102546define('XML_ERROR_UNCLOSED_TOKEN', 0);
102547define('XML_ERROR_UNDEFINED_ENTITY', 0);
102548define('XML_ERROR_UNKNOWN_ENCODING', 0);
102549define('XML_GLOBAL_NAMESPACE', 0);
102550define('XML_HTML_DOCUMENT_NODE', 0);
102551define('XML_LOCAL_NAMESPACE', 0);
102552define('XML_NAMESPACE_DECL_NODE', 0);
102553define('XML_NOTATION_NODE', 0);
102554define('XML_OPTION_CASE_FOLDING', 0);
102555define('XML_OPTION_SKIP_TAGSTART', 0);
102556define('XML_OPTION_SKIP_WHITE', 0);
102557define('XML_OPTION_TARGET_ENCODING', 0);
102558/**
102559 * Node is a processing instruction
102560 **/
102561define('XML_PI_NODE', 0);
102562define('XML_SAX_IMPL', '');
102563/**
102564 * Node is a piece of text
102565 **/
102566define('XML_TEXT_NODE', 0);
102567define('XPATH_BOOLEAN', 0);
102568define('XPATH_LOCATIONSET', 0);
102569define('XPATH_NODESET', 0);
102570define('XPATH_NUMBER', 0);
102571define('XPATH_POINT', 0);
102572define('XPATH_RANGE', 0);
102573define('XPATH_STRING', 0);
102574define('XPATH_UNDEFINED', 0);
102575define('XPATH_USERS', 0);
102576define('XSD_1999_NAMESPACE', 0);
102577define('XSD_1999_TIMEINSTANT', 0);
102578define('XSD_ANYTYPE', 0);
102579define('XSD_ANYURI', 0);
102580define('XSD_ANYXML', 0);
102581define('XSD_BASE64BINARY', 0);
102582define('XSD_BOOLEAN', 0);
102583define('XSD_BYTE', 0);
102584define('XSD_DATE', 0);
102585define('XSD_DATETIME', 0);
102586define('XSD_DECIMAL', 0);
102587define('XSD_DOUBLE', 0);
102588define('XSD_DURATION', 0);
102589define('XSD_ENTITIES', 0);
102590define('XSD_ENTITY', 0);
102591define('XSD_FLOAT', 0);
102592define('XSD_GDAY', 0);
102593define('XSD_GMONTH', 0);
102594define('XSD_GMONTHDAY', 0);
102595define('XSD_GYEAR', 0);
102596define('XSD_GYEARMONTH', 0);
102597define('XSD_HEXBINARY', 0);
102598define('XSD_ID', 0);
102599define('XSD_IDREF', 0);
102600define('XSD_IDREFS', 0);
102601define('XSD_INT', 0);
102602define('XSD_INTEGER', 0);
102603define('XSD_LANGUAGE', 0);
102604define('XSD_LONG', 0);
102605define('XSD_NAME', 0);
102606define('XSD_NAMESPACE', 0);
102607define('XSD_NCNAME', 0);
102608define('XSD_NEGATIVEINTEGER', 0);
102609define('XSD_NMTOKEN', 0);
102610define('XSD_NMTOKENS', 0);
102611define('XSD_NONNEGATIVEINTEGER', 0);
102612define('XSD_NONPOSITIVEINTEGER', 0);
102613define('XSD_NORMALIZEDSTRING', 0);
102614define('XSD_NOTATION', 0);
102615define('XSD_POSITIVEINTEGER', 0);
102616define('XSD_QNAME', 0);
102617define('XSD_SHORT', 0);
102618define('XSD_STRING', 0);
102619define('XSD_TIME', 0);
102620define('XSD_TOKEN', 0);
102621define('XSD_UNSIGNEDBYTE', 0);
102622define('XSD_UNSIGNEDINT', 0);
102623define('XSD_UNSIGNEDLONG', 0);
102624define('XSD_UNSIGNEDSHORT', 0);
102625define('XSLT_ERR_UNSUPPORTED_SCHEME', 0);
102626define('XSLT_OPT_SILENT', 0);
102627define('XSLT_SABOPT_DISABLE_ADDING_META', 0);
102628define('XSLT_SABOPT_DISABLE_STRIPPING', 0);
102629define('XSLT_SABOPT_FILES_TO_HANDLER', 0);
102630define('XSLT_SABOPT_IGNORE_DOC_NOT_FOUND', 0);
102631define('XSLT_SABOPT_PARSE_PUBLIC_ENTITIES', 0);
102632define('XSL_CLONE_ALWAYS', 0);
102633define('XSL_CLONE_AUTO', 0);
102634define('XSL_CLONE_NEVER', 0);
102635define('YAML_ANY_SCALAR_STYLE', 0);
102636define('YAML_DOUBLE_QUOTED_SCALAR_STYLE', 0);
102637define('YAML_FOLDED_SCALAR_STYLE', 0);
102638define('YAML_LITERAL_SCALAR_STYLE', 0);
102639define('YAML_PLAIN_SCALAR_STYLE', 0);
102640define('YAML_SINGLE_QUOTED_SCALAR_STYLE', 0);
102641define('YESEXPR', 0);
102642define('YESSTR', 0);
102643define('YPERR_ACCESS', 0);
102644define('YPERR_BADARGS', 0);
102645define('YPERR_BADDB', 0);
102646define('YPERR_BUSY', 0);
102647define('YPERR_DOMAIN', 0);
102648define('YPERR_KEY', 0);
102649define('YPERR_MAP', 0);
102650define('YPERR_NODOM', 0);
102651define('YPERR_NOMORE', 0);
102652define('YPERR_PMAP', 0);
102653define('YPERR_RESRC', 0);
102654define('YPERR_RPC', 0);
102655define('YPERR_VERS', 0);
102656define('YPERR_YPBIND', 0);
102657define('YPERR_YPERR', 0);
102658define('YPERR_YPSERV', 0);
102659define('__COMPILER_HALT_OFFSET__', 0);
102660