No OneTemporary

File Metadata

Created
Mon, Aug 19, 9:27 PM
This file is larger than 256 KB, so syntax highlighting was skipped.
diff --git a/phpfunctions.php b/phpfunctions.php
index 0ac7924..2c5c95b 100644
--- a/phpfunctions.php
+++ b/phpfunctions.php
@@ -1,133506 +1,174221 @@
<?php
// THIS FILE IS GENERATED
// WARNING! All changes made in this file will be lost!
/**
* The number of arguments passed to script
**/
$argc = array();
/**
* Array of arguments passed to script
**/
$argv = array();
/**
* References all variables available in global scope
- *
+ *
* @superglobal
**/
$GLOBALS = array();
/**
* HTTP Cookies
- *
+ *
* @deprecated
**/
$HTTP_COOKIE_VARS = array();
/**
* Environment variables
- *
+ *
* @deprecated
**/
$HTTP_ENV_VARS = array();
/**
* HTTP GET variables
- *
+ *
* @deprecated
**/
$HTTP_GET_VARS = array();
/**
* HTTP File Upload variables
- *
+ *
* @deprecated
**/
$HTTP_POST_FILES = array();
/**
* HTTP POST variables
- *
+ *
* @deprecated
**/
$HTTP_POST_VARS = array();
/**
* Raw POST data
**/
$HTTP_RAW_POST_DATA = array();
/**
* HTTP response headers
**/
$http_response_header = array();
/**
* Session variables
- *
+ *
* @deprecated
**/
$HTTP_SESSION_VARS = array();
/**
* The previous error message
**/
$php_errormsg = array();
/**
* HTTP Cookies
- *
+ *
* @superglobal
**/
$_COOKIE = array();
/**
* Environment variables
- *
+ *
* @superglobal
**/
$_ENV = array();
/**
* HTTP File Upload variables
- *
+ *
* @superglobal
**/
$_FILES = array();
/**
* HTTP GET variables
- *
+ *
* @superglobal
**/
$_GET = array();
/**
* HTTP POST variables
- *
+ *
* @superglobal
**/
$_POST = array();
/**
* HTTP Request variables
- *
+ *
* @superglobal
**/
$_REQUEST = array();
/**
* Server and execution environment information
- *
+ *
* @superglobal
**/
$_SERVER = array();
/**
* Session variables
- *
+ *
* @superglobal
**/
$_SESSION = array();
/**
- * is the base class for all Exceptions in PHP 5, and the base class for
- * all user exceptions in PHP 7.
- *
- * In PHP 7, implements the interface.
+ * Interface to detect if a class is traversable using . Abstract base
+ * interface that cannot be implemented alone. Instead it must be
+ * implemented by either IteratorAggregate or Iterator. This interface
+ * has no methods, its only purpose is to be the base interface for all
+ * traversable classes.
**/
-class Exception {
+interface Traversable {
+}
+/**
+ * Interface for external iterators or objects that can be iterated
+ * themselves internally. PHP already provides a number of iterators for
+ * many day to day tasks. See SPL iterators for a list.
+ **/
+interface Iterator extends Traversable {
+ /**
+ * Return the current element
+ *
+ * Returns the current element.
+ *
+ * @return mixed Can return any type.
+ * @since PHP 5, PHP 7
+ **/
+ public function current();
+
+ /**
+ * Return the key of the current element
+ *
+ * Returns the key of the current element.
+ *
+ * @return scalar Returns scalar on success, or NULL on failure.
+ * @since PHP 5, PHP 7
+ **/
+ public function key();
+
+ /**
+ * Move forward to next element
+ *
+ * Moves the current position to the next element.
+ *
+ * @return void Any returned value is ignored.
+ * @since PHP 5, PHP 7
+ **/
+ public function next();
+
+ /**
+ * Rewind the Iterator to the first element
+ *
+ * Rewinds back to the first element of the Iterator.
+ *
+ * @return void Any returned value is ignored.
+ * @since PHP 5, PHP 7
+ **/
+ public function rewind();
+
+ /**
+ * Checks if current position is valid
+ *
+ * This method is called after Iterator::rewind and Iterator::next to
+ * check if the current position is valid.
+ *
+ * @return bool The return value will be casted to boolean and then
+ * evaluated.
+ * @since PHP 5, PHP 7
+ **/
+ public function valid();
+
+}
+/**
+ * Throwable is the base interface for any object that can be thrown via
+ * a statement in PHP 7, including Error and Exception.
+ **/
+interface Throwable {
+ /**
+ * Gets the exception code
+ *
+ * Returns the error code associated with the thrown object.
+ *
+ * @return int Returns the exception code as integer in Exception but
+ * possibly as other type in Exception descendants (for example as
+ * string in PDOException).
+ * @since PHP 7
+ **/
+ public function getCode();
+
+ /**
+ * Gets the file in which the exception was created
+ *
+ * Get the name of the file in which the exception was created.
+ *
+ * @return string Returns the filename in which the exception was
+ * created.
+ * @since PHP 7
+ **/
+ public function getFile();
+
+ /**
+ * Gets the line on which the object was instantiated
+ *
+ * Returns the line number where the thrown object was instantiated.
+ *
+ * @return int Returns the line number where the thrown object was
+ * instantiated.
+ * @since PHP 7
+ **/
+ public function getLine();
+
+ /**
+ * Gets the message
+ *
+ * Returns the message associated with the thrown object.
+ *
+ * @return string Returns the message associated with the thrown
+ * object.
+ * @since PHP 7
+ **/
+ public function getMessage();
+
+ /**
+ * Returns the previous Throwable
+ *
+ * Returns any previous Throwable (for example, one provided as the third
+ * parameter to Exception::__construct).
+ *
+ * @return Throwable Returns the previous Throwable if available, or
+ * NULL otherwise.
+ * @since PHP 7
+ **/
+ public function getPrevious();
+
+ /**
+ * Gets the stack trace
+ *
+ * Returns the stack trace as an array.
+ *
+ * @return array Returns the stack trace as an array in the same format
+ * as {@link debug_backtrace}.
+ * @since PHP 7
+ **/
+ public function getTrace();
+
+ /**
+ * Gets the stack trace as a string
+ *
+ * @return string Returns the stack trace as a string.
+ * @since PHP 7
+ **/
+ public function getTraceAsString();
+
+ /**
+ * Gets a string representation of the thrown object
+ *
+ * @return string Returns the string representation of the thrown
+ * object.
+ * @since PHP 7
+ **/
+ public function __toString();
+
+}
+/**
+ * Error is the base class for all internal PHP errors.
+ **/
+class Error implements Throwable {
+ /**
+ * The error code
+ *
+ * @var int
+ **/
+ protected $code;
+
+ /**
+ * The filename where the error happened
+ *
+ * @var string
+ **/
+ protected $file;
+
+ /**
+ * The line where the error happened
+ *
+ * @var int
+ **/
+ protected $line;
+
+ /**
+ * The error message
+ *
+ * @var string
+ **/
+ protected $message;
+
+ /**
+ * Gets the error code
+ *
+ * Returns the error code.
+ *
+ * @return mixed Returns the error code as integer
+ **/
+ final public function getCode(){}
+
+ /**
+ * Gets the file in which the error occurred
+ *
+ * Get the name of the file the error occurred.
+ *
+ * @return string Returns the filename in which the error occurred.
+ **/
+ final public function getFile(){}
+
+ /**
+ * Gets the line in which the error occurred
+ *
+ * Get line number where the error occurred.
+ *
+ * @return int Returns the line number where the error occurred.
+ **/
+ final public function getLine(){}
+
+ /**
+ * Gets the error message
+ *
+ * Returns the error message.
+ *
+ * @return string Returns the error message as a string.
+ **/
+ final public function getMessage(){}
+
/**
+ * Returns previous Throwable
+ *
+ * Returns previous Throwable (the third parameter of
+ * Error::__construct).
+ *
+ * @return Throwable Returns the previous Throwable if available or
+ * NULL otherwise.
+ **/
+ final public function getPrevious(){}
+
+ /**
+ * Gets the stack trace
+ *
+ * Returns the stack trace.
+ *
+ * @return array Returns the stack trace as an array.
+ **/
+ final public function getTrace(){}
+
+ /**
+ * Gets the stack trace as a string
+ *
+ * Returns the stack trace as a string.
+ *
+ * @return string Returns the stack trace as a string.
+ **/
+ final public function getTraceAsString(){}
+
+ /**
+ * Clone the error
+ *
+ * Error can not be clone, so this method results in fatal error.
+ *
+ * @return void
+ **/
+ final private function __clone(){}
+
+ /**
+ * String representation of the error
+ *
+ * Returns the string representation of the error.
+ *
+ * @return string Returns the string representation of the error.
+ **/
+ public function __toString(){}
+
+}
+/**
+ * Exception is the base class for all Exceptions in PHP 5, and the base
+ * class for all user exceptions in PHP 7. Before PHP 7, Exception did
+ * not implement the Throwable interface.
+ **/
+class Exception implements Throwable {
+ /**
+ * The exception code
+ *
+ * @var int
+ **/
+ protected $code;
+
+ /**
+ * The filename where the exception was created
+ *
+ * @var string
+ **/
+ protected $file;
+
+ /**
+ * The line where the exception was created
+ *
+ * @var int
+ **/
+ protected $line;
+
+ /**
+ * The exception message
+ *
+ * @var string
+ **/
+ protected $message;
+
+ /**
+ * Gets the Exception code
+ *
* Returns the Exception code.
- *
- * @return mixed
- * @since PHP 5 >= 5.1.0, PHP 7
+ *
+ * @return mixed Returns the exception code as integer in Exception but
+ * possibly as other type in Exception descendants (for example as
+ * string in PDOException).
+ * @since PHP 5, PHP 7
**/
- function getCode(){}
+ final public function getCode(){}
/**
+ * Gets the file in which the exception was created
+ *
* Get the name of the file in which the exception was created.
- *
- * @return string
- * @since PHP 5 >= 5.1.0, PHP 7
+ *
+ * @return string Returns the filename in which the exception was
+ * created.
+ * @since PHP 5, PHP 7
**/
- function getFile(){}
+ final public function getFile(){}
/**
+ * Gets the line in which the exception was created
+ *
* Get line number where the exception was created.
- *
- * @return int
- * @since PHP 5 >= 5.1.0, PHP 7
+ *
+ * @return int Returns the line number where the exception was created.
+ * @since PHP 5, PHP 7
**/
- function getLine(){}
+ final public function getLine(){}
/**
+ * Gets the Exception message
+ *
* Returns the Exception message.
- *
- * @return string
- * @since PHP 5 >= 5.1.0, PHP 7
+ *
+ * @return string Returns the Exception message as a string.
+ * @since PHP 5, PHP 7
**/
- function getMessage(){}
+ final public function getMessage(){}
/**
+ * Returns previous Exception
+ *
* Returns previous exception (the third parameter of
* Exception::__construct).
- *
- * @return Throwable
+ *
+ * @return Throwable Returns the previous Throwable if available or
+ * NULL otherwise.
* @since PHP 5 >= 5.3.0, PHP 7
**/
- function getPrevious(){}
+ final public function getPrevious(){}
/**
+ * Gets the stack trace
+ *
* Returns the Exception stack trace.
- *
- * @return array
- * @since PHP 5 >= 5.1.0, PHP 7
+ *
+ * @return array Returns the Exception stack trace as an array.
+ * @since PHP 5, PHP 7
**/
- function getTrace(){}
+ final public function getTrace(){}
/**
+ * Gets the stack trace as a string
+ *
* Returns the Exception stack trace as a string.
- *
- * @return string
- * @since PHP 5 >= 5.1.0, PHP 7
+ *
+ * @return string Returns the Exception stack trace as a string.
+ * @since PHP 5, PHP 7
**/
- function getTraceAsString(){}
+ final public function getTraceAsString(){}
/**
+ * Clone the exception
+ *
* Tries to clone the Exception, which results in Fatal error.
- *
+ *
* @return void
- * @since PHP 5 >= 5.1.0, PHP 7
+ * @since PHP 5, PHP 7
**/
- function __clone(){}
+ final private function __clone(){}
/**
+ * String representation of the exception
+ *
* Returns the string representation of the exception.
- *
- * @return string
- * @since PHP 5 >= 5.1.0, PHP 7
+ *
+ * @return string Returns the string representation of the exception.
+ * @since PHP 5, PHP 7
**/
- function __toString(){}
+ public function __toString(){}
}
/**
- * The class makes it easier to iterate over large APC caches. This is
- * helpful as it allows iterating over large caches in steps, while
- * grabbing a defined number of entries per lock instance, so it frees
- * the cache locks for other activities rather than hold up the entire
- * cache to grab 100 (the default) entries. Also, using regular
- * expression matching is more efficient as it's been moved to the C
- * level.
+ * The APCIterator class makes it easier to iterate over large APC
+ * caches. This is helpful as it allows iterating over large caches in
+ * steps, while grabbing a defined number of entries per lock instance,
+ * so it frees the cache locks for other activities rather than hold up
+ * the entire cache to grab 100 (the default) entries. Also, using
+ * regular expression matching is more efficient as it's been moved to
+ * the C level.
**/
class APCIterator implements Iterator {
/**
+ * Get current item
+ *
* Gets the current item from the APCIterator stack.
- *
- * @return mixed
+ *
+ * @return mixed Returns the current item on success, or FALSE if no
+ * more items or exist, or on failure.
* @since PECL apc >= 3.1.1
**/
- function current(){}
+ public function current(){}
/**
+ * Get total count
+ *
* Get the total count.
- *
- * @return int
+ *
+ * @return int The total count.
* @since PECL apc >= 3.1.1
**/
- function getTotalCount(){}
+ public function getTotalCount(){}
/**
+ * Get total cache hits
+ *
* Gets the total number of cache hits.
- *
- * @return int
+ *
+ * @return int The number of hits on success, or FALSE on failure.
* @since PECL apc >= 3.1.1
**/
- function getTotalHits(){}
+ public function getTotalHits(){}
/**
+ * Get total cache size
+ *
* Gets the total cache size.
- *
- * @return int
+ *
+ * @return int The total cache size.
* @since PECL apc >= 3.1.1
**/
- function getTotalSize(){}
+ public function getTotalSize(){}
/**
+ * Get iterator key
+ *
* Gets the current iterator key.
- *
- * @return string
+ *
+ * @return string Returns the key on success, or FALSE upon failure.
* @since PECL apc >= 3.1.1
**/
- function key(){}
+ public function key(){}
/**
+ * Move pointer to next item
+ *
* Moves the iterator pointer to the next element.
- *
+ *
* @return void
* @since PECL apc >= 3.1.1
**/
- function next(){}
+ public function next(){}
/**
+ * Rewinds iterator
+ *
* Rewinds back the iterator to the first element.
- *
+ *
* @return void
* @since PECL apc >= 3.1.1
**/
- function rewind(){}
+ public function rewind(){}
/**
+ * Checks if current position is valid
+ *
* Checks if the current iterator position is valid.
- *
- * @return void
+ *
+ * @return void Returns TRUE if the current iterator position is valid,
+ * otherwise FALSE.
* @since PECL apc >= 3.1.1
**/
- function valid(){}
+ public function valid(){}
/**
+ * Constructs an APCIterator iterator object
+ *
* Constructs an APCIterator object.
- *
+ *
* @param string $cache The cache type, which will be user or file.
* @param mixed $search A PCRE regular expression that matches against
* APC key names, either as a string for a single regular expression,
- * or as an array of regular expressions. Or, optionally pass in to
- * skip the search.
+ * or as an array of regular expressions. Or, optionally pass in NULL
+ * to skip the search.
* @param int $format The desired format, as configured with one or
* more of the APC_ITER_* constants.
* @param int $chunk_size The chunk size. Must be a value greater than
* 0. The default value is 100.
* @param int $list The type to list. Either pass in APC_LIST_ACTIVE or
* APC_LIST_DELETED.
* @since PECL apc >= 3.1.1
**/
- function __construct($cache, $search, $format, $chunk_size, $list){}
+ public function __construct($cache, $search, $format, $chunk_size, $list){}
}
/**
- * The class makes it easier to iterate over large APCu caches. This is
- * helpful as it allows iterating over large caches in steps, while
- * grabbing a defined number of entries per lock instance, so it frees
- * the cache locks for other activities rather than hold up the entire
- * cache to grab 100 (the default) entries. Also, using regular
- * expression matching is more efficient as it's been moved to the C
- * level.
+ * The APCUIterator class makes it easier to iterate over large APCu
+ * caches. This is helpful as it allows iterating over large caches in
+ * steps, while grabbing a defined number of entries per lock instance,
+ * so it frees the cache locks for other activities rather than hold up
+ * the entire cache to grab 100 (the default) entries. Also, using
+ * regular expression matching is more efficient as it's been moved to
+ * the C level.
**/
class APCUIterator implements Iterator {
/**
+ * Get current item
+ *
* Gets the current item from the APCUIterator stack.
- *
- * @return mixed
+ *
+ * @return mixed Returns the current item on success, or FALSE if no
+ * more items or exist, or on failure.
* @since PECL apcu >= 5.0.0
**/
- function current(){}
+ public function current(){}
/**
+ * Get total count
+ *
* Get the total count.
- *
- * @return int
+ *
+ * @return int The total count.
* @since PECL apcu >= 5.0.0
**/
- function getTotalCount(){}
+ public function getTotalCount(){}
/**
+ * Get total cache hits
+ *
* Gets the total number of cache hits.
- *
- * @return int
+ *
+ * @return int The number of hits on success, or FALSE on failure.
* @since PECL apcu >= 5.0.0
**/
- function getTotalHits(){}
+ public function getTotalHits(){}
/**
+ * Get total cache size
+ *
* Gets the total cache size.
- *
- * @return int
+ *
+ * @return int The total cache size.
* @since PECL apcu >= 5.0.0
**/
- function getTotalSize(){}
+ public function getTotalSize(){}
/**
+ * Get iterator key
+ *
* Gets the current iterator key.
- *
- * @return string
+ *
+ * @return string Returns the key on success, or FALSE upon failure.
* @since PECL apcu >= 5.0.0
**/
- function key(){}
+ public function key(){}
/**
+ * Move pointer to next item
+ *
* Moves the iterator pointer to the next element.
- *
+ *
* @return void
* @since PECL apcu >= 5.0.0
**/
- function next(){}
+ public function next(){}
/**
+ * Rewinds iterator
+ *
* Rewinds back the iterator to the first element.
- *
+ *
* @return void
* @since PECL apcu >= 5.0.0
**/
- function rewind(){}
+ public function rewind(){}
/**
+ * Checks if current position is valid
+ *
* Checks if the current iterator position is valid.
- *
- * @return void
+ *
+ * @return void Returns TRUE if the current iterator position is valid,
+ * otherwise FALSE.
* @since PECL apcu >= 5.0.0
**/
- function valid(){}
+ public function valid(){}
/**
+ * Constructs an APCUIterator iterator object
+ *
* Constructs an APCUIterator object.
- *
+ *
* @param mixed $search A PCRE regular expression that matches against
* APCu key names, either as a string for a single regular expression,
- * or as an array of regular expressions. Or, optionally pass in to
- * skip the search.
+ * or as an array of regular expressions. Or, optionally pass in NULL
+ * to skip the search.
* @param int $format The desired format, as configured with one or
* more of the APC_ITER_* constants.
* @param int $chunk_size The chunk size. Must be a value greater than
* 0. The default value is 100.
* @param int $list The type to list. Either pass in APC_LIST_ACTIVE or
* APC_LIST_DELETED.
* @since PECL apcu >= 5.0.0
**/
- function __construct($search, $format, $chunk_size, $list){}
+ public function __construct($search, $format, $chunk_size, $list){}
}
/**
* An Iterator that iterates over several iterators one after the other.
**/
class AppendIterator extends IteratorIterator implements OuterIterator {
/**
- * Appends an iterator.
- *
+ * Appends an iterator
+ *
* @param Iterator $iterator The iterator to append.
* @return void
* @since PHP 5 >= 5.1.0, PHP 7
**/
- function append($iterator){}
+ public function append($iterator){}
/**
- * Gets the current value.
- *
- * @return mixed
+ * Gets the current value
+ *
+ * @return mixed The current value if it is valid or NULL otherwise.
* @since PHP 5 >= 5.1.0, PHP 7
**/
- function current(){}
+ public function current(){}
/**
+ * Gets the ArrayIterator
+ *
* This method gets the ArrayIterator that is used to store the iterators
* added with AppendIterator::append.
- *
- * @return ArrayIterator
- * @since PHP 5 >= 5.1.0, PHP 7
+ *
+ * @return ArrayIterator Returns an ArrayIterator containing the
+ * appended iterators.
+ * @since PHP 5 >= 5.2.0, PHP 7
**/
- function getArrayIterator(){}
+ public function getArrayIterator(){}
/**
+ * Gets the inner iterator
+ *
* This method returns the current inner iterator.
- *
- * @return Iterator
+ *
+ * @return Iterator The current inner iterator, or NULL if there is not
+ * one.
* @since PHP 5 >= 5.1.0, PHP 7
**/
- function getInnerIterator(){}
+ public function getInnerIterator(){}
/**
+ * Gets an index of iterators
+ *
* Gets the index of the current inner iterator.
- *
- * @return int
- * @since PHP 5 >= 5.1.0, PHP 7
+ *
+ * @return int Returns an integer, which is the zero-based index of the
+ * current inner iterator.
+ * @since PHP 5 >= 5.2.0, PHP 7
**/
- function getIteratorIndex(){}
+ public function getIteratorIndex(){}
/**
+ * Gets the current key
+ *
* Get the current key.
- *
- * @return scalar
+ *
+ * @return scalar The current key if it is valid or NULL otherwise.
* @since PHP 5 >= 5.1.0, PHP 7
**/
- function key(){}
+ public function key(){}
/**
+ * Moves to the next element
+ *
* Moves to the next element. If this means to another Iterator then it
* rewinds that Iterator.
- *
+ *
* @return void
* @since PHP 5 >= 5.1.0, PHP 7
**/
- function next(){}
+ public function next(){}
/**
+ * Rewinds the Iterator
+ *
* Rewind to the first element of the first inner Iterator.
- *
+ *
* @return void
* @since PHP 5 >= 5.1.0, PHP 7
**/
- function rewind(){}
+ public function rewind(){}
/**
- * Checks validity of the current element.
- *
- * @return bool
+ * Checks validity of the current element
+ *
+ * @return bool Returns TRUE if the current iteration is valid, FALSE
+ * otherwise.
* @since PHP 5 >= 5.1.0, PHP 7
**/
- function valid(){}
+ public function valid(){}
}
/**
- * is thrown when too few arguments are passed to a user-defined function
- * or method.
+ * ArgumentCountError is thrown when too few arguments are passed to a
+ * user-defined function or method.
**/
class ArgumentCountError extends TypeError {
}
/**
- * is thrown when an error occurs while performing mathematical
- * operations. In PHP 7.0, these errors include attempting to perform a
- * bitshift by a negative amount, and any call to that would result in a
- * value outside the possible bounds of an .
+ * ArithmeticError is thrown when an error occurs while performing
+ * mathematical operations. In PHP 7.0, these errors include attempting
+ * to perform a bitshift by a negative amount, and any call to {@link
+ * intdiv} that would result in a value outside the possible bounds of an
+ * integer.
**/
class ArithmeticError extends Error {
}
/**
* Interface to provide accessing objects as arrays.
**/
interface ArrayAccess {
/**
+ * Whether an offset exists
+ *
* Whether or not an offset exists.
- *
+ *
* This method is executed when using {@link isset} or {@link empty} on
* objects implementing ArrayAccess.
- *
+ *
* @param mixed $offset An offset to check for.
- * @return boolean
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @return bool
+ * @since PHP 5, PHP 7
**/
- function offsetExists($offset);
+ public function offsetExists($offset);
/**
+ * Offset to retrieve
+ *
* Returns the value at specified offset.
- *
+ *
* This method is executed when checking if offset is {@link empty}.
- *
+ *
* @param mixed $offset The offset to retrieve.
- * @return mixed
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @return mixed Can return all value types.
+ * @since PHP 5, PHP 7
**/
- function offsetGet($offset);
+ public function offsetGet($offset);
/**
+ * Assign a value to the specified offset
+ *
* Assigns a value to the specified offset.
- *
+ *
* @param mixed $offset The offset to assign the value to.
* @param mixed $value The value to set.
* @return void
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @since PHP 5, PHP 7
**/
- function offsetSet($offset, $value);
+ public function offsetSet($offset, $value);
/**
+ * Unset an offset
+ *
* Unsets an offset.
- *
+ *
* @param mixed $offset The offset to unset.
* @return void
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @since PHP 5, PHP 7
**/
- function offsetUnset($offset);
+ public function offsetUnset($offset);
}
/**
* This iterator allows to unset and modify values and keys while
- * iterating over Arrays and Objects.
- *
- * When you want to iterate over the same array multiple times you need
- * to instantiate ArrayObject and let it create ArrayIterator instances
- * that refer to it either by using or by calling its getIterator()
- * method manually.
+ * iterating over Arrays and Objects. When you want to iterate over the
+ * same array multiple times you need to instantiate ArrayObject and let
+ * it create ArrayIterator instances that refer to it either by using or
+ * by calling its getIterator() method manually.
**/
class ArrayIterator implements ArrayAccess, SeekableIterator, Countable, Serializable {
/**
+ * Append an element
+ *
* Appends value as the last element.
- *
+ *
* @param mixed $value The value to append.
* @return void
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @since PHP 5, PHP 7
**/
- function append($value){}
+ public function append($value){}
/**
+ * Sort array by values
+ *
* Sorts an array by values.
- *
+ *
* @return void
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function asort(){}
+ public function asort(){}
/**
+ * Count elements
+ *
* Gets the number of elements in the array, or the number of public
* properties in the object.
- *
- * @return int
- * @since PHP 5 >= 5.0.0, PHP 7
+ *
+ * @return int The number of elements or public properties in the
+ * associated array or object, respectively.
+ * @since PHP 5, PHP 7
**/
- function count(){}
+ public function count(){}
/**
+ * Return current array entry
+ *
* Get the current array entry.
- *
- * @return mixed
- * @since PHP 5 >= 5.0.0, PHP 7
+ *
+ * @return mixed The current array entry.
+ * @since PHP 5, PHP 7
**/
- function current(){}
+ public function current(){}
/**
+ * Get array copy
+ *
* Get a copy of an array.
- *
- * @return array
- * @since PHP 5 >= 5.0.0, PHP 7
+ *
+ * @return array A copy of the array, or array of public properties if
+ * ArrayIterator refers to an object.
+ * @since PHP 5, PHP 7
**/
- function getArrayCopy(){}
+ public function getArrayCopy(){}
/**
+ * Get flags
+ *
* Get the current flags.
- *
- * @return void
+ *
+ * @return void The current flags.
* @since PHP 5 >= 5.1.0, PHP 7
**/
- function getFlags(){}
+ public function getFlags(){}
/**
+ * Return current array key
+ *
* This function returns the current array key
- *
- * @return mixed
- * @since PHP 5 >= 5.0.0, PHP 7
+ *
+ * @return mixed The current array key.
+ * @since PHP 5, PHP 7
**/
- function key(){}
+ public function key(){}
/**
+ * Sort array by keys
+ *
* Sorts an array by the keys.
- *
+ *
* @return void
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function ksort(){}
+ public function ksort(){}
/**
+ * Sort an array naturally, case insensitive
+ *
* Sort the entries by values using a case insensitive "natural order"
* algorithm.
- *
+ *
* @return void
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function natcasesort(){}
+ public function natcasesort(){}
/**
+ * Sort an array naturally
+ *
* Sort the entries by values using "natural order" algorithm.
- *
+ *
* @return void
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function natsort(){}
+ public function natsort(){}
/**
+ * Move to next entry
+ *
* The iterator to the next entry.
- *
+ *
* @return void
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @since PHP 5, PHP 7
**/
- function next(){}
+ public function next(){}
/**
+ * Check if offset exists
+ *
* Checks if the offset exists.
- *
+ *
* @param string $index The offset being checked.
- * @return void
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @return void TRUE if the offset exists, otherwise FALSE
+ * @since PHP 5, PHP 7
**/
- function offsetExists($index){}
+ public function offsetExists($index){}
/**
+ * Get value for an offset
+ *
* Gets the value from the provided offset.
- *
+ *
* @param string $index The offset to get the value from.
- * @return mixed
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @return mixed The value at offset {@link index}.
+ * @since PHP 5, PHP 7
**/
- function offsetGet($index){}
+ public function offsetGet($index){}
/**
+ * Set value for an offset
+ *
* Sets a value for a given offset.
- *
+ *
* @param string $index The index to set for.
* @param string $newval The new value to store at the index.
* @return void
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @since PHP 5, PHP 7
**/
- function offsetSet($index, $newval){}
+ public function offsetSet($index, $newval){}
/**
+ * Unset value for an offset
+ *
* Unsets a value for an offset.
- *
+ *
* @param string $index The offset to unset.
* @return void
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @since PHP 5, PHP 7
**/
- function offsetUnset($index){}
+ public function offsetUnset($index){}
/**
+ * Rewind array back to the start
+ *
* This rewinds the iterator to the beginning.
- *
+ *
* @return void
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @since PHP 5, PHP 7
**/
- function rewind(){}
+ public function rewind(){}
/**
+ * Seek to position
+ *
* @param int $position The position to seek to.
* @return void
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @since PHP 5, PHP 7
**/
- function seek($position){}
+ public function seek($position){}
/**
- * Serialize.
- *
- * @return string
+ * Serialize
+ *
+ * @return string The serialized ArrayIterator.
* @since PHP 5 >= 5.3.0, PHP 7
**/
- function serialize(){}
+ public function serialize(){}
/**
+ * Set behaviour flags
+ *
* Sets behaviour flags.
- *
+ *
* @param string $flags A bitmask as follows: 0 = Properties of the
* object have their normal functionality when accessed as list
* (var_dump, foreach, etc.). 1 = Array indices can be accessed as
* properties in read/write.
* @return void
* @since PHP 5 >= 5.1.0, PHP 7
**/
- function setFlags($flags){}
+ public function setFlags($flags){}
/**
+ * Sort with a user-defined comparison function and maintain index
+ * association
+ *
* This method sorts the elements such that indices maintain their
* correlation with the values they are associated with, using a
* user-defined comparison function.
- *
+ *
* @param callable $cmp_function
* @return void
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function uasort($cmp_function){}
+ public function uasort($cmp_function){}
/**
+ * Sort by keys using a user-defined comparison function
+ *
* This method sorts the elements by keys using a user-supplied
* comparison function.
- *
+ *
* @param callable $cmp_function
* @return void
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function uksort($cmp_function){}
+ public function uksort($cmp_function){}
/**
- * Unserialize.
- *
+ * Unserialize
+ *
* @param string $serialized The serialized ArrayIterator object to be
* unserialized.
- * @return string
+ * @return string The ArrayIterator.
* @since PHP 5 >= 5.3.0, PHP 7
**/
- function unserialize($serialized){}
+ public function unserialize($serialized){}
/**
+ * Check whether array contains more entries
+ *
* Checks if the array contains any more entries.
- *
- * @return bool
- * @since PHP 5 >= 5.0.0, PHP 7
+ *
+ * @return bool Returns TRUE if the iterator is valid, otherwise FALSE
+ * @since PHP 5, PHP 7
**/
- function valid(){}
+ public function valid(){}
/**
+ * Construct an ArrayIterator
+ *
* Constructs an ArrayIterator object.
- *
+ *
* @param mixed $array The array or object to be iterated on.
* @param int $flags Flags to control the behaviour of the
* ArrayIterator object. See ArrayIterator::setFlags.
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @since PHP 5, PHP 7
**/
- function __construct($array, $flags){}
+ public function __construct($array, $flags){}
}
/**
* This class allows objects to work as arrays.
**/
class ArrayObject implements IteratorAggregate, ArrayAccess, Serializable, Countable {
/**
+ * Appends the value
+ *
* Appends a new value as the last element.
- *
+ *
* @param mixed $value The value being appended.
* @return void
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @since PHP 5, PHP 7
**/
- function append($value){}
+ public function append($value){}
/**
+ * Sort the entries by value
+ *
* Sorts the entries such that the keys maintain their correlation with
* the entries they are associated with. This is used mainly when sorting
* associative arrays where the actual element order is significant.
- *
+ *
* @return void
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function asort(){}
+ public function asort(){}
/**
+ * Get the number of public properties in the ArrayObject
+ *
* Get the number of public properties in the ArrayObject.
- *
- * @return int
- * @since PHP 5 >= 5.0.0, PHP 7
+ *
+ * @return int The number of public properties in the ArrayObject.
+ * @since PHP 5, PHP 7
**/
- function count(){}
+ public function count(){}
/**
+ * Exchange the array for another one
+ *
* Exchange the current array with another array or object.
- *
+ *
* @param mixed $input The new array or object to exchange with the
* current array.
- * @return array
+ * @return array Returns the old array.
* @since PHP 5 >= 5.1.0, PHP 7
**/
- function exchangeArray($input){}
+ public function exchangeArray($input){}
/**
+ * Creates a copy of the ArrayObject
+ *
* Exports the ArrayObject to an array.
- *
- * @return array
- * @since PHP 5 >= 5.0.0, PHP 7
+ *
+ * @return array Returns a copy of the array. When the ArrayObject
+ * refers to an object, an array of the public properties of that
+ * object will be returned.
+ * @since PHP 5, PHP 7
**/
- function getArrayCopy(){}
+ public function getArrayCopy(){}
/**
+ * Gets the behavior flags
+ *
* Gets the behavior flags of the ArrayObject. See the
* ArrayObject::setFlags method for a list of the available flags.
- *
- * @return int
+ *
+ * @return int Returns the behavior flags of the ArrayObject.
* @since PHP 5 >= 5.1.0, PHP 7
**/
- function getFlags(){}
+ public function getFlags(){}
/**
+ * Create a new iterator from an ArrayObject instance
+ *
* Create a new iterator from an ArrayObject instance.
- *
- * @return ArrayIterator
- * @since PHP 5 >= 5.0.0, PHP 7
+ *
+ * @return ArrayIterator An iterator from an ArrayObject.
+ * @since PHP 5, PHP 7
**/
- function getIterator(){}
+ public function getIterator(){}
/**
+ * Gets the iterator classname for the ArrayObject
+ *
* Gets the class name of the array iterator that is used by
* ArrayObject::getIterator().
- *
- * @return string
+ *
+ * @return string Returns the iterator class name that is used to
+ * iterate over this object.
* @since PHP 5 >= 5.1.0, PHP 7
**/
- function getIteratorClass(){}
+ public function getIteratorClass(){}
/**
+ * Sort the entries by key
+ *
* Sorts the entries by key, maintaining key to entry correlations. This
* is useful mainly for associative arrays.
- *
+ *
* @return void
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function ksort(){}
+ public function ksort(){}
/**
+ * Sort an array using a case insensitive "natural order" algorithm
+ *
* This method is a case insensitive version of ArrayObject::natsort.
- *
+ *
* This method implements a sort algorithm that orders alphanumeric
* strings in the way a human being would while maintaining key/value
* associations. This is described as a "natural ordering".
- *
+ *
* @return void
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function natcasesort(){}
+ public function natcasesort(){}
/**
+ * Sort entries using a "natural order" algorithm
+ *
* This method implements a sort algorithm that orders alphanumeric
* strings in the way a human being would while maintaining key/value
* associations. This is described as a "natural ordering". An example of
* the difference between this algorithm and the regular computer string
* sorting algorithms (used in ArrayObject::asort) method can be seen in
* the example below.
- *
+ *
* @return void
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function natsort(){}
+ public function natsort(){}
/**
+ * Returns whether the requested index exists
+ *
* @param mixed $index The index being checked.
- * @return bool
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @return bool TRUE if the requested index exists, otherwise FALSE
+ * @since PHP 5, PHP 7
**/
- function offsetExists($index){}
+ public function offsetExists($index){}
/**
+ * Returns the value at the specified index
+ *
* @param mixed $index The index with the value.
- * @return mixed
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @return mixed The value at the specified index or NULL.
+ * @since PHP 5, PHP 7
**/
- function offsetGet($index){}
+ public function offsetGet($index){}
/**
- * Sets the value at the specified index to newval.
- *
+ * Sets the value at the specified index to newval
+ *
* @param mixed $index The index being set.
* @param mixed $newval The new value for the {@link index}.
* @return void
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @since PHP 5, PHP 7
**/
- function offsetSet($index, $newval){}
+ public function offsetSet($index, $newval){}
/**
- * Unsets the value at the specified index.
- *
+ * Unsets the value at the specified index
+ *
* @param mixed $index The index being unset.
* @return void
- * @since PHP 5 >= 5.0.0, PHP 7
+ * @since PHP 5, PHP 7
**/
- function offsetUnset($index){}
+ public function offsetUnset($index){}
/**
+ * Serialize an ArrayObject
+ *
* Serializes an ArrayObject.
- *
- * @return string
+ *
+ * @return string The serialized representation of the ArrayObject.
* @since PHP 5 >= 5.3.0, PHP 7
**/
- function serialize(){}
+ public function serialize(){}
/**
+ * Sets the behavior flags
+ *
* Set the flags that change the behavior of the ArrayObject.
- *
+ *
* @param int $flags The new ArrayObject behavior. It takes on either a
* bitmask, or named constants. Using named constants is strongly
* encouraged to ensure compatibility for future versions. The
* available behavior flags are listed below. The actual meanings of
* these flags are described in the predefined constants. ArrayObject
* behavior flags value constant 1 ArrayObject::STD_PROP_LIST 2
* ArrayObject::ARRAY_AS_PROPS
* @return void
* @since PHP 5 >= 5.1.0, PHP 7
**/
- function setFlags($flags){}
+ public function setFlags($flags){}
/**
+ * Sets the iterator classname for the ArrayObject
+ *
* Sets the classname of the array iterator that is used by
* ArrayObject::getIterator().
- *
+ *
* @param string $iterator_class The classname of the array iterator to
* use when iterating over this object.
* @return void
* @since PHP 5 >= 5.1.0, PHP 7
**/
- function setIteratorClass($iterator_class){}
+ public function setIteratorClass($iterator_class){}
/**
+ * Sort the entries with a user-defined comparison function and maintain
+ * key association
+ *
* This function sorts the entries such that keys maintain their
* correlation with the entry that they are associated with, using a
* user-defined comparison function.
- *
+ *
* This is used mainly when sorting associative arrays where the actual
* element order is significant.
- *
+ *
* @param callable $cmp_function Function {@link cmp_function} should
* accept two parameters which will be filled by pairs of entries. The
* comparison function must return an integer less than, equal to, or
* greater than zero if the first argument is considered to be
* respectively less than, equal to, or greater than the second.
* @return void
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function uasort($cmp_function){}
+ public function uasort($cmp_function){}
/**
+ * Sort the entries by keys using a user-defined comparison function
+ *
* This function sorts the keys of the entries using a user-supplied
* comparison function. The key to entry correlations will be maintained.
- *
+ *
* @param callable $cmp_function The callback comparison function.
* Function {@link cmp_function} should accept two parameters which
* will be filled by pairs of entry keys. The comparison function must
* return an integer less than, equal to, or greater than zero if the
* first argument is considered to be respectively less than, equal to,
* or greater than the second.
* @return void
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function uksort($cmp_function){}
+ public function uksort($cmp_function){}
/**
+ * Unserialize an ArrayObject
+ *
* Unserializes a serialized ArrayObject.
- *
+ *
* @param string $serialized The serialized ArrayObject.
- * @return void
+ * @return void The unserialized ArrayObject.
* @since PHP 5 >= 5.3.0, PHP 7
**/
- function unserialize($serialized){}
+ public function unserialize($serialized){}
}
/**
- * is thrown when an assertion made via fails.
+ * AssertionError is thrown when an assertion made via {@link assert}
+ * fails.
**/
class AssertionError extends Error {
}
/**
* Exception thrown if a callback refers to an undefined function or if
* some arguments are missing.
**/
class BadFunctionCallException extends LogicException {
}
/**
* Exception thrown if a callback refers to an undefined method or if
* some arguments are missing.
**/
class BadMethodCallException extends BadFunctionCallException {
}
/**
* This object supports cached iteration over another iterator.
**/
class CachingIterator extends IteratorIterator implements OuterIterator, ArrayAccess, Countable {
/**
+ * @var integer
+ **/
+ const CALL_TOSTRING = 0;
+
+ /**
+ * @var integer
+ **/
+ const CATCH_GET_CHILD = 0;
+
+ /**
+ * @var integer
+ **/
+ const FULL_CACHE = 0;
+
+ /**
+ * @var integer
+ **/
+ const TOSTRING_USE_CURRENT = 0;
+
+ /**
+ * @var integer
+ **/
+ const TOSTRING_USE_INNER = 0;
+
+ /**
+ * @var integer
+ **/
+ const TOSTRING_USE_KEY = 0;
+
+ /**
+ * The number of elements in the iterator
+ *
* May return the number of elements in the iterator.
- *
- * @return int
+ *
+ * @return int The count of the elements iterated over.
* @since PHP 5 >= 5.2.2, PHP 7
**/
- function count(){}
+ public function count(){}
/**
+ * Return the current element
+ *
* May return the current element in the iteration.
- *
- * @return void
+ *
+ * @return void Mixed
* @since PHP 5, PHP 7
**/
- function current(){}
+ public function current(){}
/**
- * Retrieve the contents of the cache.
- *
- * @return array
+ * Retrieve the contents of the cache
+ *
+ * @return array An array containing the cache items.
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function getCache(){}
+ public function getCache(){}
/**
+ * Get flags used
+ *
* Get the bitmask of the flags used for this CachingIterator instance.
- *
- * @return int
+ *
+ * @return int Description...
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function getFlags(){}
+ public function getFlags(){}
/**
+ * Returns the inner iterator
+ *
* Returns the iterator sent to the constructor.
- *
- * @return Iterator
+ *
+ * @return Iterator Returns an object implementing the Iterator
+ * interface.
* @since PHP 5, PHP 7
**/
- function getInnerIterator(){}
+ public function getInnerIterator(){}
/**
+ * Check whether the inner iterator has a valid next element
+ *
* @return void
* @since PHP 5, PHP 7
**/
- function hasNext(){}
+ public function hasNext(){}
/**
+ * Return the key for the current element
+ *
* This method may return a key for the current element.
- *
+ *
* @return scalar
* @since PHP 5, PHP 7
**/
- function key(){}
+ public function key(){}
/**
- * Move the iterator forward.
- *
+ * Move the iterator forward
+ *
* @return void
* @since PHP 5, PHP 7
**/
- function next(){}
+ public function next(){}
/**
+ * The offsetExists purpose
+ *
* @param string $index The index being checked.
- * @return void
+ * @return void Returns TRUE if an entry referenced by the offset
+ * exists, FALSE otherwise.
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function offsetExists($index){}
+ public function offsetExists($index){}
/**
+ * The offsetGet purpose
+ *
* @param string $index Description...
- * @return void
+ * @return void Description...
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function offsetGet($index){}
+ public function offsetGet($index){}
/**
+ * The offsetSet purpose
+ *
* @param string $index The index of the element to be set.
* @param string $newval The new value for the {@link index}.
* @return void
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function offsetSet($index, $newval){}
+ public function offsetSet($index, $newval){}
/**
+ * The offsetUnset purpose
+ *
* @param string $index The index of the element to be unset.
* @return void
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function offsetUnset($index){}
+ public function offsetUnset($index){}
/**
- * Rewind the iterator.
- *
+ * Rewind the iterator
+ *
* @return void
* @since PHP 5, PHP 7
**/
- function rewind(){}
+ public function rewind(){}
/**
+ * The setFlags purpose
+ *
* Set the flags for the CachingIterator object.
- *
+ *
* @param int $flags Bitmask of the flags to set.
* @return void
* @since PHP 5 >= 5.2.0, PHP 7
**/
- function setFlags($flags){}
+ public function setFlags($flags){}
/**
- * Check whether the current element is valid.
- *
+ * Check whether the current element is valid
+ *
* @return void
* @since PHP 5, PHP 7
**/
- function valid(){}
+ public function valid(){}
/**
+ * Construct a new CachingIterator object for the iterator
+ *
* @param Iterator $iterator Iterator to cache
* @param int $flags Bitmask of flags.
* @since PHP 5, PHP 7
**/
- function __construct($iterator, $flags){}
+ public function __construct($iterator, $flags){}
/**
+ * Return the string representation of the current element
+ *
* Get the string representation of the current element.
- *
- * @return void
+ *
+ * @return void The string representation of the current element.
* @since PHP 5, PHP 7
**/
- function __toString(){}
+ public function __toString(){}
}
/**
* Simple class with some static helper methods.
**/
class Cairo {
/**
- * :
- *
- * :
- *
+ * Retrieves the availables font types
+ *
* Returns an array with the available font backends
- *
- * @return array
+ *
+ * @return array A list-type array with all available font backends.
* @since PECL cairo >= 0.1.0
**/
- function availableFonts(){}
+ public static function availableFonts(){}
/**
- * (method):
- *
- * :
- *
+ * Retrieves all available surfaces
+ *
* Returns an array with the available surface backends
- *
- * @return array
+ *
+ * @return array A list-type array with all available surface backends.
* @since PECL cairo >= 0.1.0
**/
- function availableSurfaces(){}
+ public static function availableSurfaces(){}
/**
- * (method):
- *
- * :
- *
+ * Retrieves the current status as string
+ *
* Retrieves the current status as a readable string
- *
+ *
* @param int $status A valid status code given by {@link cairo_status}
* or CairoContext::status
- * @return string
+ * @return string A string containing the current status of a
+ * CairoContext object
* @since PECL cairo >= 0.1.0
**/
- function statusToString($status){}
+ public static function statusToString($status){}
/**
- * (method):
- *
- * :
- *
+ * Retrives cairo's library version
+ *
* Retrieves the current version of the cairo library as an integer value
- *
- * @return int
+ *
+ * @return int Current Cairo library version integer
* @since PECL cairo >= 0.1.0
**/
- function version(){}
+ public static function version(){}
/**
- * (method):
- *
- * :
- *
+ * Retrieves cairo version as string
+ *
* Retrieves the current cairo library version as a string.
- *
- * @return string
+ *
+ * @return string Current Cairo library version string
* @since PECL cairo >= 0.1.0
**/
- function versionString(){}
+ public static function versionString(){}
}
/**
* Enum class that specifies the type of antialiasing to do when
* rendering text or shapes.
**/
class CairoAntialias {
+ /**
+ * @var integer
+ **/
+ const MODE_DEFAULT = 0;
+
+ /**
+ * @var integer
+ **/
+ const MODE_GRAY = 0;
+
+ /**
+ * @var integer
+ **/
+ const MODE_NONE = 0;
+
+ /**
+ * @var integer
+ **/
+ const MODE_SUBPIXEL = 0;
+
}
/**
- * is used to describe the content that a surface will contain, whether
- * color information, alpha information (translucence vs. opacity), or
- * both.
- *
- * Note: The large values here are designed to keep values distinct from
- * values so that the implementation can detect the error if users
- * confuse the two types.
+ * CairoContent is used to describe the content that a surface will
+ * contain, whether color information, alpha information (translucence
+ * vs. opacity), or both. Note: The large values here are designed to
+ * keep CairoContent values distinct from CairoContent values so that the
+ * implementation can detect the error if users confuse the two types.
**/
class CairoContent {
+ /**
+ * The surface will hold alpha content only.
+ *
+ * @var integer
+ **/
+ const ALPHA = 0;
+
+ /**
+ * The surface will hold color content only.
+ *
+ * @var integer
+ **/
+ const COLOR = 0;
+
+ /**
+ * @var integer
+ **/
+ const COLOR_ALPHA = 0;
+
}
/**
* Context is the main object used when drawing with cairo. To draw with
- * cairo, you create a , set the target , and drawing options for the ,
- * create shapes with functions . like and , and then draw shapes with or
- * .
- *
- * Contexts can be pushed to a stack via . They may then safely be
- * changed, without loosing the current state. Use to restore to the
- * saved state.
+ * cairo, you create a CairoContext, set the target CairoSurface, and
+ * drawing options for the CairoContext, create shapes with functions .
+ * like CairoContext::moveTo and CairoContext::lineTo, and then draw
+ * shapes with CairoContext::stroke or CairoContext::fill.
+ *
+ * Contexts can be pushed to a stack via CairoContext::save. They may
+ * then safely be changed, without loosing the current state. Use
+ * CairoContext::restore to restore to the saved state.
**/
class CairoContext {
/**
- * (method):
- *
- * :
- *
+ * Appends a path to current path
+ *
* Appends the {@link path} onto the current path. The {@link path} may
* be either the return value from one of CairoContext::copyPath or
* CairoContext::copyPathFlat;
- *
+ *
* if {@link path} is not a valid CairoPath instance a CairoException
* will be thrown
- *
+ *
* @param CairoPath $path CairoContext object
* @return void
* @since PECL cairo >= 0.1.0
**/
- function appendPath($path){}
+ public function appendPath($path){}
/**
- * (method):
- *
- * :
- *
+ * Adds a circular arc
+ *
* Adds a circular arc of the given radius to the current path. The arc
* is centered at ({@link x}, {@link y}), begins at {@link angle1} and
* proceeds in the direction of increasing angles to end at {@link
* angle2}. If {@link angle2} is less than {@link angle1} it will be
* progressively increased by 2*M_PI until it is greater than {@link
* angle1}. If there is a current point, an initial line segment will be
* added to the path to connect the current point to the beginning of the
* arc. If this initial line is undesired, it can be avoided by calling
* CairoContext::newSubPath or procedural {@link cairo_new_sub_path}
* before calling CairoContext::arc or {@link cairo_arc}.
- *
+ *
* Angles are measured in radians. An angle of 0.0 is in the direction of
* the positive X axis (in user space). An angle of M_PI/2.0 radians (90
* degrees) is in the direction of the positive Y axis (in user space).
* Angles increase in the direction from the positive X axis toward the
* positive Y axis. So with the default transformation matrix, angles
* increase in a clockwise direction.
- *
+ *
* (To convert from degrees to radians, use degrees * (M_PI / 180.).)
* This function gives the arc in the direction of increasing angles; see
* CairoContext::arcNegative or {@link cairo_arc_negative} to get the arc
* in the direction of decreasing angles.
- *
+ *
* @param float $x A valid CairoContext object
* @param float $y x position
* @param float $radius y position
* @param float $angle1 Radius of the arc
* @param float $angle2 start angle
* @return void
* @since PECL cairo >= 0.1.0
**/
- function arc($x, $y, $radius, $angle1, $angle2){}
+ public function arc($x, $y, $radius, $angle1, $angle2){}
/**
- * (method):
- *
- * :
- *
+ * Adds a negative arc
+ *
* Adds a circular arc of the given {@link radius} to the current path.
* The arc is centered at ({@link x}, {@link y}), begins at {@link
* angle1} and proceeds in the direction of decreasing angles to end at
* {@link angle2}. If {@link angle2} is greater than {@link angle1} it
* will be progressively decreased by 2*M_PI until it is less than {@link
* angle1}.
- *
+ *
* See CairoContext::arc or {@link cairo_arc} for more details. This
* function differs only in the direction of the arc between the two
* angles.
- *
+ *
* @param float $x A valid CairoContext object
* @param float $y double x position
* @param float $radius double y position
* @param float $angle1 The radius of the desired negative arc
* @param float $angle2 Start angle of the arc
* @return void
* @since PECL cairo >= 0.1.0
**/
- function arcNegative($x, $y, $radius, $angle1, $angle2){}
+ public function arcNegative($x, $y, $radius, $angle1, $angle2){}
/**
- * (method):
- *
- * :
- *
+ * Establishes a new clip region
+ *
* Establishes a new clip region by intersecting the current clip region
* with the current path as it would be filled by CairoContext::fill or
* {@link cairo_fill} and according to the current fill rule (see
* CairoContext::setFillRule or {@link cairo_set_fill_rule}).
- *
+ *
* After CairoContext::clip or {@link cairo_clip}, the current path will
* be cleared from the cairo context.
- *
+ *
* The current clip region affects all drawing operations by effectively
* masking out any changes to the surface that are outside the current
* clip region.
- *
+ *
* Calling CairoContext::clip or {@link cairo_clip} can only make the
* clip region smaller, never larger. But the current clip is part of the
* graphics state, so a temporary restriction of the clip region can be
* achieved by calling CairoContext::clip or {@link cairo_clip} within a
* CairoContext::save/CairoContext::restore or {@link cairo_save}/{@link
* cairo_restore} pair. The only other means of increasing the size of
* the clip region is CairoContext::resetClip or procedural {@link
* cairo_reset_clip}.
- *
+ *
* @return void
* @since PECL cairo >= 0.1.0
**/
- function clip(){}
+ public function clip(){}
/**
- * (method):
- *
- * :
- *
+ * Computes the area inside the current clip
+ *
* Computes a bounding box in user coordinates covering the area inside
* the current clip.
- *
- * @return array
+ *
+ * @return array An array containing the (float)x1, (float)y1,
+ * (float)x2, (float)y2, coordinates covering the area inside the
+ * current clip
* @since PECL cairo >= 0.1.0
**/
- function clipExtents(){}
+ public function clipExtents(){}
/**
- * (method):
- *
- * :
- *
+ * Establishes a new clip region from the current clip
+ *
* Establishes a new clip region by intersecting the current clip region
* with the current path as it would be filled by Context.fill and
* according to the current FILL RULE (see CairoContext::setFillRule or
* {@link cairo_set_fill_rule}).
- *
+ *
* Unlike CairoContext::clip, CairoContext::clipPreserve preserves the
* path within the Context. The current clip region affects all drawing
* operations by effectively masking out any changes to the surface that
* are outside the current clip region.
- *
+ *
* Calling CairoContext::clipPreserve can only make the clip region
* smaller, never larger. But the current clip is part of the graphics
* state, so a temporary restriction of the clip region can be achieved
* by calling CairoContext::clipPreserve within a
* CairoContext::save/CairoContext::restore pair. The only other means of
* increasing the size of the clip region is CairoContext::resetClip.
- *
+ *
* @return void
* @since PECL cairo >= 0.1.0
**/
- function clipPreserve(){}
+ public function clipPreserve(){}
/**
- * (method):
- *
- * :
- *
+ * Retrieves the current clip as a list of rectangles
+ *
* Returns a list-type array with the current clip region as a list of
* rectangles in user coordinates
- *
- * @return array
+ *
+ * @return array An array of user-space represented rectangles for the
+ * current clip
* @since PECL cairo >= 0.1.0
**/
- function clipRectangleList(){}
+ public function clipRectangleList(){}
/**
- * (method):
- *
- * :
- *
+ * Closes the current path
+ *
* Adds a line segment to the path from the current point to the
* beginning of the current sub-path, (the most recent point passed to
* CairoContext::moveTo), and closes this sub-path. After this call the
* current point will be at the joined endpoint of the sub-path.
- *
+ *
* The behavior of close_path() is distinct from simply calling
* CairoContext::lineTo with the equivalent coordinate in the case of
* stroking. When a closed sub-path is stroked, there are no caps on the
* ends of the sub-path. Instead, there is a line join connecting the
* final and initial segments of the sub-path.
- *
+ *
* If there is no current point before the call to
* CairoContext::closePath, this function will have no effect.
- *
+ *
* @return void
* @since PECL cairo >= 0.1.0
**/
- function closePath(){}
+ public function closePath(){}
/**
- * (method):
- *
- * :
- *
+ * Emits the current page
+ *
* Emits the current page for backends that support multiple pages, but
* doesn’t clear it, so, the contents of the current page will be
* retained for the next page too. Use CairoContext::showPage if you want
* to get an empty page after the emission.
- *
+ *
* This is a convenience function that simply calls
* CairoSurface::copyPage on CairoContext’s target.
- *
+ *
* @return void
* @since PECL cairo >= 0.1.0
**/
- function copyPage(){}
+ public function copyPage(){}
/**
- * (method):
- *
- * :
- *
+ * Creates a copy of the current path
+ *
* Creates a copy of the current path and returns it to the user as a
* CairoPath. See CairoPath for hints on how to iterate over the returned
* data structure.
- *
+ *
* This function will always return a valid CairoPath object, but the
* result will have no data, if either of the following conditions hold:
* 1. If there is insufficient memory to copy the path. In this case
* CairoPath->status will be set to CAIRO_STATUS_NO_MEMORY. 2. If {@link
* context} is already in an error state. In this case CairoPath->status
* will contain the same status that would be returned by {@link
* cairo_status}.
- *
+ *
* In either case, CairoPath->status will be set to
* CAIRO_STATUS_NO_MEMORY (regardless of what the error status in cr
* might have been).
- *
- * @return CairoPath
+ *
+ * @return CairoPath A copy of the current CairoPath in the context
* @since PECL cairo >= 0.1.0
**/
- function copyPath(){}
+ public function copyPath(){}
/**
- * (method):
- *
- * :
- *
+ * Gets a flattened copy of the current path
+ *
* Gets a flattened copy of the current path and returns it to the user
* as a CairoPath.
- *
+ *
* This function is like CairoContext::copyPath except that any curves in
* the path will be approximated with piecewise-linear approximations,
* (accurate to within the current tolerance value). That is, the result
* is guaranteed to not have any elements of type CAIRO_PATH_CURVE_TO
* which will instead be replaced by a series of CAIRO_PATH_LINE_TO
* elements.
- *
- * @return CairoPath
+ *
+ * @return CairoPath A copy of the current path
* @since PECL cairo >= 0.1.0
**/
- function copyPathFlat(){}
+ public function copyPathFlat(){}
/**
- * (method):
- *
- * :
- *
+ * Adds a curve
+ *
* Adds a cubic Bezier spline to the path from the current point to
* position {@link x3} ,{@link y3} in user-space coordinates, using
* {@link x1}, {@link y1} and {@link x2}, {@link y2} as the control
* points. After this call the current point will be {@link x3}, {@link
* y3}.
- *
+ *
* If there is no current point before the call to CairoContext::curveTo
* this function will behave as if preceded by a call to
* CairoContext::moveTo ({@link x1}, {@link y1}).
- *
+ *
* @param float $x1 A valid CairoContext object created with
* CairoContext::__construct or {@link cairo_create}
* @param float $y1 First control point in the x axis for the curve
* @param float $x2 First control point in the y axis for the curve
* @param float $y2 Second control point in x axis for the curve
* @param float $x3 Second control point in y axis for the curve
* @param float $y3 Final point in the x axis for the curve
* @return void
* @since PECL cairo >= 0.1.0
**/
- function curveTo($x1, $y1, $x2, $y2, $x3, $y3){}
+ public function curveTo($x1, $y1, $x2, $y2, $x3, $y3){}
/**
- * (method):
- *
- * :
- *
+ * Transform a coordinate
+ *
* Transform a coordinate from device space to user space by multiplying
* the given point by the inverse of the current transformation matrix
* (CTM).
- *
+ *
* @param float $x A valid CairoContext object created with
* CairoContext::__construct or {@link cairo_create}
* @param float $y x value of the coordinate
- * @return array
+ * @return array An array containing the x and y coordinates in the
+ * user-space
* @since PECL cairo >= 0.1.0
**/
- function deviceToUser($x, $y){}
+ public function deviceToUser($x, $y){}
/**
- * (method):
- *
- * :
- *
+ * Transform a distance
+ *
* Transform a distance vector from device space to user space. This
* function is similar to CairoContext::deviceToUser or {@link
* cairo_device_to_user} except that the translation components of the
* inverse Cairo Transformation Matrix will be ignored when transforming
* ({@link x},{@link y}).
- *
+ *
* @param float $x A valid CairoContext object created with
* CairoContext::__construct or {@link cairo_create}
* @param float $y X component of a distance vector
- * @return array
+ * @return array Returns an array with the x and y values of a distance
+ * vector in the user-space
* @since PECL cairo >= 0.1.0
**/
- function deviceToUserDistance($x, $y){}
+ public function deviceToUserDistance($x, $y){}
/**
- * (method):
- *
- * :
- *
+ * Fills the current path
+ *
* A drawing operator that fills the current path according to the
* current CairoFillRule, (each sub-path is implicitly closed before
* being filled). After CairoContext::fill or {@link cairo_fill}, the
* current path will be cleared from the CairoContext.
- *
+ *
* @return void
* @since PECL cairo >= 0.1.0
**/
- function fill(){}
+ public function fill(){}
/**
- * (method):
- *
- * :
- *
+ * Computes the filled area
+ *
* Computes a bounding box in user coordinates covering the area that
* would be affected, (the “inked” area), by a CairoContext::fill
* operation given the current path and fill parameters. If the current
* path is empty, returns an empty rectangle (0,0,0,0). Surface
* dimensions and clipping are not taken into account.
- *
+ *
* Contrast with CairoContext::pathExtents, which is similar, but returns
* non-zero extents for some paths with no inked area, (such as a simple
* line segment).
- *
+ *
* Note that CairoContext::fillExtents must necessarily do more work to
* compute the precise inked areas in light of the fill rule, so
* CairoContext::pathExtents may be more desirable for sake of
* performance if the non-inked path extents are desired.
- *
- * @return array
+ *
+ * @return array An array with the coordinates of the afected area
* @since PECL cairo >= 0.1.0
**/
- function fillExtents(){}
+ public function fillExtents(){}
/**
- * (method):
- *
- * :
- *
+ * Fills and preserve the current path
+ *
* A drawing operator that fills the current path according to the
* current CairoFillRule, (each sub-path is implicitly closed before
* being filled). Unlike CairoContext::fill, CairoContext::fillPreserve
* (Procedural {@link cairo_fill}, {@link cairo_fill_preserve},
* respectively) preserves the path within the Context.
- *
+ *
* @return void
* @since PECL cairo >= 0.1.0
**/
- function fillPreserve(){}
+ public function fillPreserve(){}
/**
- * (method):
- *
- * :
- *
+ * Get the font extents
+ *
* Gets the font extents for the currently selected font.
- *
- * @return array
+ *
+ * @return array An array containing the font extents for the current
+ * font.
* @since PECL cairo >= 0.1.0
**/
- function fontExtents(){}
+ public function fontExtents(){}
/**
- * (method):
- *
- * :
- *
+ * Retrives the current antialias mode
+ *
* Returns the current CairoAntialias mode, as set by
* CairoContext::setAntialias.
- *
- * @return int
+ *
+ * @return int The current CairoAntialias mode.
* @since PECL cairo >= 0.1.0
**/
- function getAntialias(){}
+ public function getAntialias(){}
/**
+ * The getCurrentPoint purpose
+ *
* Gets the current point of the current path, which is conceptually the
* final point reached by the path so far.
- *
+ *
* The current point is returned in the user-space coordinate system. If
* there is no defined current point or if cr is in an error status, x
* and y will both be set to 0.0. It is possible to check this in advance
* with CairoContext::hasCurrentPoint.
- *
+ *
* Most path construction functions alter the current point. See the
* following for details on how they affect the current point:
* CairoContext::newPath, CairoContext::newSubPath,
* CairoContext::appendPath, CairoContext::closePath,
* CairoContext::moveTo, CairoContext::lineTo, CairoContext::curveTo,
* CairoContext::relMoveTo, CairoContext::relLineTo,
* CairoContext::relCurveTo, CairoContext::arc,
* CairoContext::arcNegative, CairoContext::rectangle,
* CairoContext::textPath, CairoContext::glyphPath.
- *
+ *
* Some functions use and alter the current point but do not otherwise
* change current path: CairoContext::showText.
- *
+ *
* Some functions unset the current path and as a result, current point:
* CairoContext::fill, CairoContext::stroke.
- *
- * @return array
+ *
+ * @return array An array containing the x (index 0) and y (index 1)
+ * coordinates of the current point.
* @since PECL cairo >= 0.1.0
**/
- function getCurrentPoint(){}
+ public function getCurrentPoint(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return array
+ * The getDash purpose
+ *
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function getDash(){}
+ public function getDash(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return int
+ * The getDashCount purpose
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getDashCount(){}
+ public function getDashCount(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return int
+ * The getFillRule purpose
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getFillRule(){}
+ public function getFillRule(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The getFontFace purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function getFontFace(){}
+ public function getFontFace(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The getFontMatrix purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function getFontMatrix(){}
+ public function getFontMatrix(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The getFontOptions purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function getFontOptions(){}
+ public function getFontOptions(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The getGroupTarget purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function getGroupTarget(){}
+ public function getGroupTarget(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return int
+ * The getLineCap purpose
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getLineCap(){}
+ public function getLineCap(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return int
+ * The getLineJoin purpose
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getLineJoin(){}
+ public function getLineJoin(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return float
+ * The getLineWidth purpose
+ *
+ * @return float Description...
* @since PECL cairo >= 0.1.0
**/
- function getLineWidth(){}
+ public function getLineWidth(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The getMatrix purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function getMatrix(){}
+ public function getMatrix(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return float
+ * The getMiterLimit purpose
+ *
+ * @return float Description...
* @since PECL cairo >= 0.1.0
**/
- function getMiterLimit(){}
+ public function getMiterLimit(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return int
+ * The getOperator purpose
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getOperator(){}
+ public function getOperator(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The getScaledFont purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function getScaledFont(){}
+ public function getScaledFont(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The getSource purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function getSource(){}
+ public function getSource(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The getTarget purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function getTarget(){}
+ public function getTarget(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return float
+ * The getTolerance purpose
+ *
+ * @return float Description...
* @since PECL cairo >= 0.1.0
**/
- function getTolerance(){}
+ public function getTolerance(){}
/**
+ * The glyphPath purpose
+ *
* Adds closed paths for the glyphs to the current path. The generated
* path if filled, achieves an effect similar to that of
* CairoContext::showGlyphs.
- *
+ *
* @param array $glyphs A CairoContext object
* @return void
* @since PECL cairo >= 0.1.0
**/
- function glyphPath($glyphs){}
+ public function glyphPath($glyphs){}
/**
- * (method):
- *
- * :
- *
+ * The hasCurrentPoint purpose
+ *
* Returns whether a current point is defined on the current path. See
* CairoContext::getCurrentPoint for details on the current point.
- *
- * @return bool
+ *
+ * @return bool Whether a current point is defined
* @since PECL cairo >= 0.1.0
**/
- function hasCurrentPoint(){}
+ public function hasCurrentPoint(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The identityMatrix purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function identityMatrix(){}
+ public function identityMatrix(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $x Description...
- * @param string $y Description...
- * @return bool
+ * The inFill purpose
+ *
+ * @param float $x Description...
+ * @param float $y Description...
+ * @return bool Description...
* @since PECL cairo >= 0.1.0
**/
- function inFill($x, $y){}
+ public function inFill($x, $y){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $x Description...
- * @param string $y Description...
- * @return bool
+ * The inStroke purpose
+ *
+ * @param float $x Description...
+ * @param float $y Description...
+ * @return bool Description...
* @since PECL cairo >= 0.1.0
**/
- function inStroke($x, $y){}
+ public function inStroke($x, $y){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $x Description...
- * @param string $y Description...
- * @return void
+ * The lineTo purpose
+ *
+ * @param float $x Description...
+ * @param float $y Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function lineTo($x, $y){}
+ public function lineTo($x, $y){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $pattern Description...
- * @return void
+ * The mask purpose
+ *
+ * @param CairoPattern $pattern Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function mask($pattern){}
+ public function mask($pattern){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $surface Description...
- * @param string $x Description...
- * @param string $y Description...
- * @return void
+ * The maskSurface purpose
+ *
+ * @param CairoSurface $surface Description...
+ * @param float $x Description...
+ * @param float $y Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function maskSurface($surface, $x, $y){}
+ public function maskSurface($surface, $x, $y){}
/**
- * (method):
- *
- * :
- *
+ * The moveTo purpose
+ *
* Begin a new sub-path. After this call the current point will be (x,
* y).
- *
- * @param string $x A valid CairoContext object.
- * @param string $y The x coordinate of the new position.
+ *
+ * @param float $x A valid CairoContext object.
+ * @param float $y The x coordinate of the new position.
* @return void
* @since PECL cairo >= 0.1.0
**/
- function moveTo($x, $y){}
+ public function moveTo($x, $y){}
/**
- * (method):
- *
- * :
- *
+ * The newPath purpose
+ *
* Clears the current path. After this call there will be no path and no
* current point.
- *
+ *
* @return void
* @since PECL cairo >= 0.1.0
**/
- function newPath(){}
+ public function newPath(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The newSubPath purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function newSubPath(){}
+ public function newSubPath(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The paint purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function paint(){}
+ public function paint(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $alpha Description...
- * @return void
+ * The paintWithAlpha purpose
+ *
+ * @param float $alpha Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function paintWithAlpha($alpha){}
+ public function paintWithAlpha($alpha){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return array
+ * The pathExtents purpose
+ *
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function pathExtents(){}
+ public function pathExtents(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The popGroup purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function popGroup(){}
+ public function popGroup(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The popGroupToSource purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function popGroupToSource(){}
+ public function popGroupToSource(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The pushGroup purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function pushGroup(){}
+ public function pushGroup(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $content Description...
- * @return void
+ * The pushGroupWithContent purpose
+ *
+ * @param int $content Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function pushGroupWithContent($content){}
+ public function pushGroupWithContent($content){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $x Description...
- * @param string $y Description...
- * @param string $width Description...
- * @param string $height Description...
- * @return void
+ * The rectangle purpose
+ *
+ * @param float $x Description...
+ * @param float $y Description...
+ * @param float $width Description...
+ * @param float $height Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function rectangle($x, $y, $width, $height){}
+ public function rectangle($x, $y, $width, $height){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $x1 Description...
- * @param string $y1 Description...
- * @param string $x2 Description...
- * @param string $y2 Description...
- * @param string $x3 Description...
- * @param string $y3 Description...
- * @return void
+ * The relCurveTo purpose
+ *
+ * @param float $x1 Description...
+ * @param float $y1 Description...
+ * @param float $x2 Description...
+ * @param float $y2 Description...
+ * @param float $x3 Description...
+ * @param float $y3 Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function relCurveTo($x1, $y1, $x2, $y2, $x3, $y3){}
+ public function relCurveTo($x1, $y1, $x2, $y2, $x3, $y3){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $x Description...
- * @param string $y Description...
- * @return void
+ * The relLineTo purpose
+ *
+ * @param float $x Description...
+ * @param float $y Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function relLineTo($x, $y){}
+ public function relLineTo($x, $y){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $x Description...
- * @param string $y Description...
- * @return void
+ * The relMoveTo purpose
+ *
+ * @param float $x Description...
+ * @param float $y Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function relMoveTo($x, $y){}
+ public function relMoveTo($x, $y){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The resetClip purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function resetClip(){}
+ public function resetClip(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The restore purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function restore(){}
+ public function restore(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $angle Description...
- * @return void
+ * The rotate purpose
+ *
+ * @param float $angle Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function rotate($angle){}
+ public function rotate($angle){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The save purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function save(){}
+ public function save(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $x Description...
- * @param string $y Description...
- * @return void
+ * The scale purpose
+ *
+ * @param float $x Description...
+ * @param float $y Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function scale($x, $y){}
+ public function scale($x, $y){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
+ * The selectFontFace purpose
+ *
* @param string $family Description...
- * @param string $slant Description...
- * @param string $weight Description...
- * @return void
+ * @param int $slant Description...
+ * @param int $weight Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function selectFontFace($family, $slant, $weight){}
+ public function selectFontFace($family, $slant, $weight){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $antialias Description...
- * @return void
+ * The setAntialias purpose
+ *
+ * @param int $antialias Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setAntialias($antialias){}
+ public function setAntialias($antialias){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $dashes Description...
- * @param string $offset Description...
- * @return void
+ * The setDash purpose
+ *
+ * @param array $dashes Description...
+ * @param float $offset Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setDash($dashes, $offset){}
+ public function setDash($dashes, $offset){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $setting Description...
- * @return void
+ * The setFillRule purpose
+ *
+ * @param int $setting Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setFillRule($setting){}
+ public function setFillRule($setting){}
/**
- * (method):
- *
- * :
- *
+ * The setFontFace purpose
+ *
* Sets the font-face for a given context.
- *
+ *
* @param CairoFontFace $fontface A CairoContext object to change the
* font-face for.
- * @return void
+ * @return void No value is returned
* @since PECL cairo >= 0.1.0
**/
- function setFontFace($fontface){}
+ public function setFontFace($fontface){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $matrix Description...
- * @return void
+ * The setFontMatrix purpose
+ *
+ * @param CairoMatrix $matrix Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setFontMatrix($matrix){}
+ public function setFontMatrix($matrix){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $fontoptions Description...
- * @return void
+ * The setFontOptions purpose
+ *
+ * @param CairoFontOptions $fontoptions Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setFontOptions($fontoptions){}
+ public function setFontOptions($fontoptions){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $size Description...
- * @return void
+ * The setFontSize purpose
+ *
+ * @param float $size Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setFontSize($size){}
+ public function setFontSize($size){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $setting Description...
- * @return void
+ * The setLineCap purpose
+ *
+ * @param int $setting Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setLineCap($setting){}
+ public function setLineCap($setting){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $setting Description...
- * @return void
+ * The setLineJoin purpose
+ *
+ * @param int $setting Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setLineJoin($setting){}
+ public function setLineJoin($setting){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $width Description...
- * @return void
+ * The setLineWidth purpose
+ *
+ * @param float $width Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setLineWidth($width){}
+ public function setLineWidth($width){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $matrix Description...
- * @return void
+ * The setMatrix purpose
+ *
+ * @param CairoMatrix $matrix Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setMatrix($matrix){}
+ public function setMatrix($matrix){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $limit Description...
- * @return void
+ * The setMiterLimit purpose
+ *
+ * @param float $limit Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setMiterLimit($limit){}
+ public function setMiterLimit($limit){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $setting Description...
- * @return void
+ * The setOperator purpose
+ *
+ * @param int $setting Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setOperator($setting){}
+ public function setOperator($setting){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $scaledfont Description...
- * @return void
+ * The setScaledFont purpose
+ *
+ * @param CairoScaledFont $scaledfont Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setScaledFont($scaledfont){}
+ public function setScaledFont($scaledfont){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $pattern Description...
- * @return void
+ * The setSource purpose
+ *
+ * @param CairoPattern $pattern Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setSource($pattern){}
+ public function setSource($pattern){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $red Description...
- * @param string $green Description...
- * @param string $blue Description...
- * @return void
+ * The setSourceRGB purpose
+ *
+ * @param float $red Description...
+ * @param float $green Description...
+ * @param float $blue Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setSourceRGB($red, $green, $blue){}
+ public function setSourceRGB($red, $green, $blue){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $red Description...
- * @param string $green Description...
- * @param string $blue Description...
- * @param string $alpha Description...
- * @return void
+ * The setSourceRGBA purpose
+ *
+ * @param float $red Description...
+ * @param float $green Description...
+ * @param float $blue Description...
+ * @param float $alpha Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setSourceRGBA($red, $green, $blue, $alpha){}
+ public function setSourceRGBA($red, $green, $blue, $alpha){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $surface Description...
- * @param string $x Description...
- * @param string $y Description...
- * @return void
+ * The setSourceSurface purpose
+ *
+ * @param CairoSurface $surface Description...
+ * @param float $x Description...
+ * @param float $y Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setSourceSurface($surface, $x, $y){}
+ public function setSourceSurface($surface, $x, $y){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $tolerance Description...
- * @return void
+ * The setTolerance purpose
+ *
+ * @param float $tolerance Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setTolerance($tolerance){}
+ public function setTolerance($tolerance){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The showPage purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function showPage(){}
+ public function showPage(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
+ * The showText purpose
+ *
* @param string $text Description...
- * @return void
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function showText($text){}
+ public function showText($text){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return int
+ * The status purpose
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function status(){}
+ public function status(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The stroke purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function stroke(){}
+ public function stroke(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return array
+ * The strokeExtents purpose
+ *
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function strokeExtents(){}
+ public function strokeExtents(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The strokePreserve purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function strokePreserve(){}
+ public function strokePreserve(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
+ * The textExtents purpose
+ *
* @param string $text Description...
- * @return array
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function textExtents($text){}
+ public function textExtents($text){}
/**
+ * The textPath purpose
+ *
* Adds closed paths for text to the current path. The generated path, if
* filled, achieves an effect similar to that of CairoContext::showText.
- *
+ *
* Text conversion and positioning is done similar to
* CairoContext::showText.
- *
+ *
* Like CairoContext::showText, after this call the current point is
* moved to the origin of where the next glyph would be placed in this
* same progression. That is, the current point will be at the origin of
* the final glyph offset by its advance values. This allows for chaining
* multiple calls to CairoContext::showText without having to set current
* point in between.
- *
+ *
* Note: The CairoContext::textPath function call is part of what the
* cairo designers call the "toy" text API. It is convenient for short
* demos and simple programs, but it is not expected to be adequate for
* serious text-using applications. See CairoContext::glyphPath for the
* "real" text path API in cairo.
- *
+ *
* @param string $string A CairoContext object
- * @return void
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function textPath($string){}
+ public function textPath($string){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $matrix Description...
- * @return void
+ * The transform purpose
+ *
+ * @param CairoMatrix $matrix Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function transform($matrix){}
+ public function transform($matrix){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $x Description...
- * @param string $y Description...
- * @return void
+ * The translate purpose
+ *
+ * @param float $x Description...
+ * @param float $y Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function translate($x, $y){}
+ public function translate($x, $y){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $x Description...
- * @param string $y Description...
- * @return array
+ * The userToDevice purpose
+ *
+ * @param float $x Description...
+ * @param float $y Description...
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function userToDevice($x, $y){}
+ public function userToDevice($x, $y){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $x Description...
- * @param string $y Description...
- * @return array
+ * The userToDeviceDistance purpose
+ *
+ * @param float $x Description...
+ * @param float $y Description...
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function userToDeviceDistance($x, $y){}
+ public function userToDeviceDistance($x, $y){}
/**
+ * Creates a new CairoContext
+ *
* Creates a new CairoContext object to draw
- *
+ *
* @param CairoSurface $surface A valid CairoSurface like
* CairoImageSurface or CairoPdfSurface
* @since PECL cairo >= 0.1.0
**/
- function __construct($surface){}
+ public function __construct($surface){}
}
/**
- * class throwed by functions and methods
+ * Exception class thrown by Cairo functions and methods
**/
class CairoException extends Exception {
}
class CairoExtend {
+ /**
+ * @var integer
+ **/
+ const NONE = 0;
+
+ /**
+ * @var integer
+ **/
+ const PAD = 0;
+
+ /**
+ * @var integer
+ **/
+ const REFLECT = 0;
+
+ /**
+ * @var integer
+ **/
+ const REPEAT = 0;
+
}
/**
- * A is used to select how paths are filled. For both fill rules, whether
- * or not a point is included in the fill is determined by taking a ray
- * from that point to infinity and looking at intersections with the
- * path. The ray can be in any direction, as long as it doesn't pass
- * through the end point of a segment or have a tricky intersection such
- * as intersecting tangent to the path. (Note that filling is not
+ * A CairoFillRule is used to select how paths are filled. For both fill
+ * rules, whether or not a point is included in the fill is determined by
+ * taking a ray from that point to infinity and looking at intersections
+ * with the path. The ray can be in any direction, as long as it doesn't
+ * pass through the end point of a segment or have a tricky intersection
+ * such as intersecting tangent to the path. (Note that filling is not
* actually implemented in this way. This is just a description of the
- * rule that is applied.)
- *
- * The default fill rule is .
+ * rule that is applied.) The default fill rule is
+ * CairoFillRule::WINDING.
**/
class CairoFillRule {
+ /**
+ * @var integer
+ **/
+ const EVEN_ODD = 0;
+
+ /**
+ * If the path crosses the ray from left-to-right, counts +1. If the path
+ * crosses the ray from right to left, counts -1. (Left and right are
+ * determined from the perspective of looking along the ray from the
+ * starting point.) If the total count is non-zero, the point will be
+ * filled.
+ *
+ * @var integer
+ **/
+ const WINDING = 0;
+
}
/**
- * A is used to indicate what filtering should be applied when reading
- * pixel values from patterns. See or for indicating the desired filter
+ * A CairoFilter is used to indicate what filtering should be applied
+ * when reading pixel values from patterns. See CairoPattern::setSource
+ * or {@link cairo_pattern_set_source} for indicating the desired filter
* to be used with a particular pattern.
**/
class CairoFilter {
+ /**
+ * The highest-quality available, performance may not be suitable for
+ * interactive use.
+ *
+ * @var integer
+ **/
+ const BEST = 0;
+
+ /**
+ * Linear interpolation in two dimensions
+ *
+ * @var integer
+ **/
+ const BILINEAR = 0;
+
+ /**
+ * A high-performance filter, with quality similar to
+ * CairoFilter::NEAREST
+ *
+ * @var integer
+ **/
+ const FAST = 0;
+
+ /**
+ * This filter value is currently unimplemented, and should not be used
+ * in current code.
+ *
+ * @var integer
+ **/
+ const GAUSSIAN = 0;
+
+ /**
+ * A reasonable-performance filter, with quality similar to
+ * CairoFilter::BILINEAR
+ *
+ * @var integer
+ **/
+ const GOOD = 0;
+
+ /**
+ * Nearest-neighbor filtering
+ *
+ * @var integer
+ **/
+ const NEAREST = 0;
+
}
/**
* CairoFontFace abstract class represents a particular font at a
* particular weight, slant, and other characteristic but no
- * transformation or size.
- *
- * Note: This class can not be instantiated directly, it is created by or
- * .
+ * transformation or size. Note: This class can not be instantiated
+ * directly, it is created by CairoContext::getFontFace or {@link
+ * cairo_scaled_font_get_font_face}.
**/
class CairoFontFace {
/**
+ * Retrieves the font face type
+ *
* This function returns the type of the backend used to create a font
* face. See CairoFontType class constants for available types.
- *
- * @return int
+ *
+ * @return int A font type that can be any one defined in CairoFontType
* @since PECL cairo >= 0.1.0
**/
- function getType(){}
+ public function getType(){}
/**
- * (method):
- *
- * :
- *
+ * Check for CairoFontFace errors
+ *
* Checks whether an error has previously occurred for this font face
- *
- * @return int
+ *
+ * @return int CAIRO_STATUS_SUCCESS or another error such as
+ * CAIRO_STATUS_NO_MEMORY.
* @since PECL cairo >= 0.1.0
**/
- function status(){}
+ public function status(){}
/**
+ * Creates a new CairoFontFace object
+ *
* CairoFontFace class represents a particular font at a particular
* weight, slant, and other characteristic but no transformation or size.
- *
+ *
* Note: This class can't be instantiated directly it is created by
* CairoContext::getFontFace or {@link cairo_scaled_font_get_font_face}
- *
+ *
* @since PECL cairo >= 0.1.0
**/
- function __construct(){}
+ public function __construct(){}
}
/**
* An opaque structure holding all options that are used when rendering
- * fonts.
- *
- * Individual features of a cairo_font_options_t can be set or accessed
- * using functions named cairo_font_options_set_feature_name and
+ * fonts. Individual features of a cairo_font_options_t can be set or
+ * accessed using functions named cairo_font_options_set_feature_name and
* cairo_font_options_get_feature_name, like
* cairo_font_options_set_antialias() and
- * cairo_font_options_get_antialias().
- *
- * New features may be added to in the future. For this reason , , ,
+ * cairo_font_options_get_antialias(). New features may be added to
+ * CairoFontOptions in the future. For this reason
+ * CairoFontOptions::copy, CairoFontOptions::equal,
+ * CairoFontOptions::merge, CairoFontOptions::hash
* (cairo_font_options_copy(), cairo_font_options_equal(),
* cairo_font_options_merge(), and cairo_font_options_hash() in
* procedural way) should be used to copy, check for equality, merge, or
- * compute a hash value of objects.
+ * compute a hash value of CairoFontOptions objects.
**/
class CairoFontOptions {
/**
+ * The equal purpose
+ *
* The method description goes here.
- *
- * @param string $other Description...
- * @return bool
+ *
+ * @param CairoFontOptions $other Description...
+ * @return bool Description...
* @since PECL cairo >= 0.1.0
**/
- function equal($other){}
+ public function equal($other){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return int
+ * The getAntialias purpose
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getAntialias(){}
+ public function getAntialias(){}
/**
+ * The getHintMetrics purpose
+ *
* The method description goes here.
- *
- * @return int
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getHintMetrics(){}
+ public function getHintMetrics(){}
/**
+ * The getHintStyle purpose
+ *
* The method description goes here.
- *
- * @return int
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getHintStyle(){}
+ public function getHintStyle(){}
/**
+ * The getSubpixelOrder purpose
+ *
* The method description goes here.
- *
- * @return int
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getSubpixelOrder(){}
+ public function getSubpixelOrder(){}
/**
+ * The hash purpose
+ *
* The method description goes here.
- *
- * @return int
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function hash(){}
+ public function hash(){}
/**
+ * The merge purpose
+ *
* The method description goes here.
- *
- * @param string $other Description...
- * @return void
+ *
+ * @param CairoFontOptions $other Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function merge($other){}
+ public function merge($other){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $antialias Description...
- * @return void
+ * The setAntialias purpose
+ *
+ * @param int $antialias Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setAntialias($antialias){}
+ public function setAntialias($antialias){}
/**
+ * The setHintMetrics purpose
+ *
* The method description goes here.
- *
- * @param string $hint_metrics Description...
- * @return void
+ *
+ * @param int $hint_metrics Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setHintMetrics($hint_metrics){}
+ public function setHintMetrics($hint_metrics){}
/**
+ * The setHintStyle purpose
+ *
* The method description goes here.
- *
- * @param string $hint_style Description...
- * @return void
+ *
+ * @param int $hint_style Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setHintStyle($hint_style){}
+ public function setHintStyle($hint_style){}
/**
+ * The setSubpixelOrder purpose
+ *
* The method description goes here.
- *
- * @param string $subpixel_order Description...
- * @return void
+ *
+ * @param int $subpixel_order Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setSubpixelOrder($subpixel_order){}
+ public function setSubpixelOrder($subpixel_order){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return int
+ * The status purpose
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function status(){}
+ public function status(){}
/**
+ * The __construct purpose
+ *
* The method description goes here.
- *
+ *
* @since PECL cairo >= 0.1.0
**/
- function __construct(){}
+ public function __construct(){}
}
/**
* Specifies variants of a font face based on their slant.
**/
class CairoFontSlant {
+ /**
+ * Italic font style
+ *
+ * @var integer
+ **/
+ const ITALIC = 0;
+
+ /**
+ * Upright font style
+ *
+ * @var integer
+ **/
+ const NORMAL = 0;
+
+ /**
+ * Oblique font style
+ *
+ * @var integer
+ **/
+ const OBLIQUE = 0;
+
}
/**
* CairoFontType class is an abstract final class that contains constants
- * used to describe the type of a given or . The font types are also
- * known as "font backends" within cairo.
- *
- * The type of a CairoFontFace is determined by the how it is created, an
- * example would be the . The type can be queried with or
- *
- * The various functions can be used with a font face of any type.
- *
- * The type of a is determined by the type of the passed to or . The
- * scaled font type can be queried with or .
+ * used to describe the type of a given CairoFontFace or CairoScaledFont.
+ * The font types are also known as "font backends" within cairo. The
+ * type of a CairoFontFace is determined by the how it is created, an
+ * example would be the CairoToyFontFace::__construct. The CairoFontFace
+ * type can be queried with CairoFontFace::getType or {@link
+ * cairo_font_face_get_type} The various CairoFontFace functions can be
+ * used with a font face of any type. The type of a CairoScaledFont is
+ * determined by the type of the CairoFontFace passed to
+ * CairoScaledFont::__construct or {@link cairo_scaled_font_create}. The
+ * scaled font type can be queried with CairoScaledFont::getType or
+ * {@link cairo_scaled_font_get_type}.
**/
class CairoFontType {
+ /**
+ * The font is of type CairoFreeType
+ *
+ * @var integer
+ **/
+ const FT = 0;
+
+ /**
+ * The font is of type Quartz
+ *
+ * @var integer
+ **/
+ const QUARTZ = 0;
+
+ /**
+ * The font was created using CairoToyFont api
+ *
+ * @var integer
+ **/
+ const TOY = 0;
+
+ /**
+ * The font is of type Win32
+ *
+ * @var integer
+ **/
+ const WIN32 = 0;
+
}
/**
* Specifies variants of a font face based on their weight.
**/
class CairoFontWeight {
+ /**
+ * Bold font weight
+ *
+ * @var integer
+ **/
+ const BOLD = 0;
+
+ /**
+ * Normal font weight
+ *
+ * @var integer
+ **/
+ const NORMAL = 0;
+
}
/**
* CairoFormat enums are used to identify the memory format of the image
* data.
**/
class CairoFormat {
/**
+ * Each pixel is a 1-bit quantity holding an alpha value. Pixels are
+ * packed together into 32-bit quantities. The ordering of the bits
+ * matches the endianess of the platform. On a big-endian machine, the
+ * first pixel is in the uppermost bit, on a little-endian machine the
+ * first pixel is in the least-significant bit.
+ *
+ * @var integer
+ **/
+ const A1 = 0;
+
+ /**
+ * Each pixel is a 8-bit quantity holding an alpha value.
+ *
+ * @var integer
+ **/
+ const A8 = 0;
+
+ /**
+ * Each pixel is a 32-bit quantity, with alpha in the upper 8 bits, then
+ * red, then green, then blue. The 32-bit quantities are stored
+ * native-endian. Pre-multiplied alpha is used. (That is, 50% transparent
+ * red is 0x80800000, not 0x80ff0000.)
+ *
+ * @var integer
+ **/
+ const ARGB32 = 0;
+
+ /**
+ * Each pixel is a 32-bit quantity, with the upper 8 bits unused. Red,
+ * Green, and Blue are stored in the remaining 24 bits in that order.
+ *
+ * @var integer
+ **/
+ const RGB24 = 0;
+
+ /**
+ * Provides an appropiate stride to use
+ *
* This method provides a stride value that will respect all alignment
* requirements of the accelerated image-rendering code within cairo.
- *
+ *
* @param int $format The desired CairoFormat to use
* @param int $width The width of the image
- * @return int
+ * @return int The appropriate stride to use given the desired format
+ * and width, or -1 if either the format is invalid or the width too
+ * large.
* @since PECL cairo >= 0.1.0
**/
- function strideForWidth($format, $width){}
+ public static function strideForWidth($format, $width){}
}
/**
- * is an abstract base class from which other Pattern classes derive. It
- * cannot be instantiated directly.
+ * CairoGradientPattern is an abstract base class from which other
+ * Pattern classes derive. It cannot be instantiated directly.
**/
class CairoGradientPattern extends CairoPattern {
/**
+ * The addColorStopRgb purpose
+ *
* The method description goes here.
- *
- * @param string $offset Description...
- * @param string $red Description...
- * @param string $green Description...
- * @param string $blue Description...
- * @return void
+ *
+ * @param float $offset Description...
+ * @param float $red Description...
+ * @param float $green Description...
+ * @param float $blue Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function addColorStopRgb($offset, $red, $green, $blue){}
+ public function addColorStopRgb($offset, $red, $green, $blue){}
/**
+ * The addColorStopRgba purpose
+ *
* The method description goes here.
- *
- * @param string $offset Description...
- * @param string $red Description...
- * @param string $green Description...
- * @param string $blue Description...
- * @param string $alpha Description...
- * @return void
+ *
+ * @param float $offset Description...
+ * @param float $red Description...
+ * @param float $green Description...
+ * @param float $blue Description...
+ * @param float $alpha Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function addColorStopRgba($offset, $red, $green, $blue, $alpha){}
+ public function addColorStopRgba($offset, $red, $green, $blue, $alpha){}
/**
+ * The getColorStopCount purpose
+ *
* The method description goes here.
- *
- * @return int
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getColorStopCount(){}
+ public function getColorStopCount(){}
/**
+ * The getColorStopRgba purpose
+ *
* The method description goes here.
- *
- * @param string $index Description...
- * @return array
+ *
+ * @param int $index Description...
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function getColorStopRgba($index){}
+ public function getColorStopRgba($index){}
/**
+ * The getExtend purpose
+ *
* The method description goes here.
- *
- * @return int
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getExtend(){}
+ public function getExtend(){}
/**
+ * The setExtend purpose
+ *
* The method description goes here.
- *
+ *
* @param int $extend Description...
- * @return void
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setExtend($extend){}
+ public function setExtend($extend){}
}
/**
* Specifies whether to hint font metrics; hinting font metrics means
* quantizing them so that they are integer values in device space. Doing
* this improves the consistency of letter and line spacing, however it
* also means that text will be laid out differently at different zoom
* factors.
**/
class CairoHintMetrics {
+ /**
+ * @var integer
+ **/
+ const METRICS_DEFAULT = 0;
+
+ /**
+ * @var integer
+ **/
+ const METRICS_OFF = 0;
+
+ /**
+ * @var integer
+ **/
+ const METRICS_ON = 0;
+
}
/**
* Specifies the type of hinting to do on font outlines. Hinting is the
* process of fitting outlines to the pixel grid in order to improve the
* appearance of the result. Since hinting outlines involves distorting
* them, it also reduces the faithfulness to the original outline shapes.
* Not all of the outline hinting styles are supported by all font
* backends.
**/
class CairoHintStyle {
+ /**
+ * @var integer
+ **/
+ const STYLE_DEFAULT = 0;
+
+ /**
+ * @var integer
+ **/
+ const STYLE_FULL = 0;
+
+ /**
+ * @var integer
+ **/
+ const STYLE_MEDIUM = 0;
+
+ /**
+ * @var integer
+ **/
+ const STYLE_NONE = 0;
+
+ /**
+ * @var integer
+ **/
+ const STYLE_SLIGHT = 0;
+
}
/**
* CairoImageSurface provide the ability to render to memory buffers
* either allocated by cairo or by the calling code. The supported image
- * formats are those defined in .
+ * formats are those defined in CairoFormat.
**/
class CairoImageSurface extends CairoSurface {
/**
+ * The createForData purpose
+ *
* The method description goes here.
- *
+ *
* @param string $data Description...
* @param int $format Description...
* @param int $width Description...
* @param int $height Description...
- * @param int $stride Description...
- * @return void
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function createForData($data, $format, $width, $height, $stride){}
+ public static function createForData($data, $format, $width, $height){}
/**
* Creates a new CairoImageSurface form a png image file
- *
+ *
* This method should be called static
- *
+ *
* @param string $file Path to PNG image file
- * @return CairoImageSurface
+ * @return CairoImageSurface CairoImageSurface object
* @since PECL cairo >= 0.1.0
**/
- function createFromPng($file){}
+ public static function createFromPng($file){}
/**
+ * Gets the image data as string
+ *
* Returns the image data of this surface or NULL if surface is not an
* image surface, or if CairoContext::finish, procedural : {@link
* cairo_surface_finish}, has been called.
- *
- * @return string
+ *
+ * @return string The image data as string
* @since PECL cairo >= 0.1.0
**/
- function getData(){}
+ public function getData(){}
/**
+ * Get the image format
+ *
* Retrieves the image format, as one of the CairoFormat defined
- *
- * @return int
+ *
+ * @return int One of the CairoFormat enums
* @since PECL cairo >= 0.1.0
**/
- function getFormat(){}
+ public function getFormat(){}
/**
+ * Retrieves the height of the CairoImageSurface
+ *
* This methods returns the CairoImageSurface height.
- *
- * @return int
+ *
+ * @return int CairoImageSurface object height
* @since PECL cairo >= 0.1.0
**/
- function getHeight(){}
+ public function getHeight(){}
/**
+ * The getStride purpose
+ *
* The method description goes here.
- *
- * @return int
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getStride(){}
+ public function getStride(){}
/**
+ * Retrieves the width of the CairoImageSurface
+ *
* Gets the width of the CairoImageSurface
- *
- * @return int
+ *
+ * @return int Returns the width of the CairoImageSurface object
* @since PECL cairo >= 0.1.0
**/
- function getWidth(){}
+ public function getWidth(){}
/**
+ * Creates a new CairoImageSurface
+ *
* Creates a new CairoImageSuface object of type {@link format}
- *
+ *
* @param int $format Can be any defined in CairoFormat
* @param int $width The width of the image surface
* @param int $height The height of the image surface
* @since PECL cairo >= 0.1.0
**/
- function __construct($format, $width, $height){}
+ public function __construct($format, $width, $height){}
}
/**
* Create a new CairoLinearGradient along the line defined
**/
class CairoLinearGradient extends CairoGradientPattern {
/**
+ * The getPoints purpose
+ *
* The method description goes here.
- *
- * @return array
+ *
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function getPoints(){}
+ public function getPoints(){}
/**
+ * The __construct purpose
+ *
* The method description goes here.
- *
+ *
* @param float $x0 Description...
* @param float $y0 Description...
* @param float $x1 Description...
* @param float $y1 Description...
* @since PECL cairo >= 0.1.0
**/
- function __construct($x0, $y0, $x1, $y1){}
+ public function __construct($x0, $y0, $x1, $y1){}
}
/**
- * Specifies how to render the endpoints of the path when stroking.
- *
- * The default line cap style is .
+ * Specifies how to render the endpoints of the path when stroking. The
+ * default line cap style is CairoLineCap::BUTT.
**/
class CairoLineCap {
+ /**
+ * Start(stop) the line exactly at the start(end) point
+ *
+ * @var integer
+ **/
+ const BUTT = 0;
+
+ /**
+ * Use a round ending, the center of the circle is the end point
+ *
+ * @var integer
+ **/
+ const ROUND = 0;
+
+ /**
+ * Use squared ending, the center of the square is the end point
+ *
+ * @var integer
+ **/
+ const SQUARE = 0;
+
}
class CairoLineJoin {
+ /**
+ * @var integer
+ **/
+ const BEVEL = 0;
+
+ /**
+ * @var integer
+ **/
+ const MITER = 0;
+
+ /**
+ * @var integer
+ **/
+ const ROUND = 0;
+
}
/**
* Matrices are used throughout cairo to convert between different
* coordinate spaces.
**/
class CairoMatrix {
/**
- * (method):
- *
- * :
- *
+ * Creates a new identity matrix
+ *
* Creates a new matrix that is an identity transformation. An identity
* transformation means the source data is copied into the destination
* data without change
- *
- * @return void
+ *
+ * @return void Returns a new CairoMatrix object that can be used with
+ * surfaces, contexts, and patterns.
* @since PECL cairo >= 0.1.0
**/
- function initIdentity(){}
+ public static function initIdentity(){}
/**
- * (method):
- *
- * :
- *
+ * Creates a new rotated matrix
+ *
* Creats a new matrix to a transformation that rotates by radians
* provided
- *
+ *
* @param float $radians angle of rotation, in radians. The direction
* of rotation is defined such that positive angles rotate in the
* direction from the positive X axis toward the positive Y axis. With
* the default axis orientation of cairo, positive angles rotate in a
* clockwise direction.
- * @return void
+ * @return void Returns a new CairoMatrix object that can be used with
+ * surfaces, contexts, and patterns.
* @since PECL cairo >= 0.1.0
**/
- function initRotate($radians){}
+ public static function initRotate($radians){}
/**
- * (method):
- *
- * :
- *
+ * Creates a new scaling matrix
+ *
* Creates a new matrix to a transformation that scales by sx and sy in
* the X and Y dimensions, respectively.
- *
+ *
* @param float $sx scale factor in the X direction
* @param float $sy scale factor in the Y direction
- * @return void
+ * @return void Returns a new CairoMatrix object that can be used with
+ * surfaces, contexts, and patterns.
* @since PECL cairo >= 0.1.0
**/
- function initScale($sx, $sy){}
+ public static function initScale($sx, $sy){}
/**
- * (method):
- *
- * :
- *
+ * Creates a new translation matrix
+ *
* Creates a new matrix to a transformation that translates by tx and ty
* in the X and Y dimensions, respectively.
- *
+ *
* @param float $tx amount to translate in the X direction
* @param float $ty amount to translate in the Y direction
- * @return void
+ * @return void Returns a new CairoMatrix object that can be used with
+ * surfaces, contexts, and patterns.
* @since PECL cairo >= 0.1.0
**/
- function initTranslate($tx, $ty){}
+ public static function initTranslate($tx, $ty){}
/**
+ * The invert purpose
+ *
* The method description goes here.
- *
- * @return void
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function invert(){}
+ public function invert(){}
/**
+ * The multiply purpose
+ *
* The method description goes here.
- *
+ *
* @param CairoMatrix $matrix1 Description...
* @param CairoMatrix $matrix2 Description...
- * @return CairoMatrix
+ * @return CairoMatrix Description...
* @since PECL cairo >= 0.1.0
**/
- function multiply($matrix1, $matrix2){}
+ public static function multiply($matrix1, $matrix2){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $sx Description...
- * @param string $sy Description...
- * @return void
+ * The rotate purpose
+ *
+ * @param float $radians Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function rotate($sx, $sy){}
+ public function rotate($radians){}
/**
- * (method):
- *
- * :
- *
+ * Applies scaling to a matrix
+ *
* Applies scaling by sx, sy to the transformation in the matrix. The
* effect of the new transformation is to first scale the coordinates by
* sx and sy, then apply the original transformation to the coordinates.
- *
+ *
* @param float $sx Procedural only - CairoMatrix instance
* @param float $sy scale factor in the X direction
* @return void
* @since PECL cairo >= 0.1.0
**/
- function scale($sx, $sy){}
+ public function scale($sx, $sy){}
/**
+ * The transformDistance purpose
+ *
* The method description goes here.
- *
- * @param string $dx Description...
- * @param string $dy Description...
- * @return array
+ *
+ * @param float $dx Description...
+ * @param float $dy Description...
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function transformDistance($dx, $dy){}
+ public function transformDistance($dx, $dy){}
/**
+ * The transformPoint purpose
+ *
* The method description goes here.
- *
- * @param string $dx Description...
- * @param string $dy Description...
- * @return array
+ *
+ * @param float $dx Description...
+ * @param float $dy Description...
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function transformPoint($dx, $dy){}
+ public function transformPoint($dx, $dy){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $tx Description...
- * @param string $ty Description...
- * @return void
+ * The translate purpose
+ *
+ * @param float $tx Description...
+ * @param float $ty Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function translate($tx, $ty){}
+ public function translate($tx, $ty){}
/**
- * (method):
- *
- * :
- *
+ * Creates a new CairoMatrix object
+ *
* Returns new CairoMatrix object. Matrices are used throughout cairo to
* convert between different coordinate spaces. Sets matrix to be the
* affine transformation given by xx, yx, xy, yy, x0, y0. The
* transformation is given by: x_new = xx * x + xy * y + x0; and y_new =
* yx * x + yy * y + y0;
- *
+ *
* @param float $xx xx component of the affine transformation
* @param float $yx yx component of the affine transformation
* @param float $xy xy component of the affine transformation
* @param float $yy yy component of the affine transformation
* @param float $x0 X translation component of the affine
* transformation
* @param float $y0 Y translation component of the affine
* transformation
* @since PECL cairo >= 0.1.0
**/
- function __construct($xx, $yx, $xy, $yy, $x0, $y0){}
+ public function __construct($xx, $yx, $xy, $yy, $x0, $y0){}
}
/**
* This is used to set the compositing operator for all cairo drawing
- * operations.
- *
- * The default operator is
- *
- * The operators marked as unbounded modify their destination even
- * outside of the mask layer (that is, their effect is not bound by the
- * mask layer). However, their effect can still be limited by way of
- * clipping.
- *
- * To keep things simple, the operator descriptions here document the
- * behavior for when both source and destination are either fully
- * transparent or fully opaque. The actual implementation works for
- * translucent layers too. For a more detailed explanation of the effects
- * of each operator, including the mathematical definitions, see
+ * operations. The default operator is CairoOperator::OVER The operators
+ * marked as unbounded modify their destination even outside of the mask
+ * layer (that is, their effect is not bound by the mask layer). However,
+ * their effect can still be limited by way of clipping. To keep things
+ * simple, the operator descriptions here document the behavior for when
+ * both source and destination are either fully transparent or fully
+ * opaque. The actual implementation works for translucent layers too.
+ * For a more detailed explanation of the effects of each operator,
+ * including the mathematical definitions, see
* http://cairographics.org/operators/.
**/
class CairoOperator {
+ /**
+ * Source and destination layers are accumulated
+ *
+ * @var integer
+ **/
+ const ADD = 0;
+
+ /**
+ * Draw source on top of destination content and only there
+ *
+ * @var integer
+ **/
+ const ATOP = 0;
+
+ /**
+ * Clear destination layer (bounded)
+ *
+ * @var integer
+ **/
+ const CLEAR = 0;
+
+ /**
+ * Ignore the source
+ *
+ * @var integer
+ **/
+ const DEST = 0;
+
+ /**
+ * @var integer
+ **/
+ const DEST_ATOP = 0;
+
+ /**
+ * @var integer
+ **/
+ const DEST_IN = 0;
+
+ /**
+ * @var integer
+ **/
+ const DEST_OUT = 0;
+
+ /**
+ * @var integer
+ **/
+ const DEST_OVER = 0;
+
+ /**
+ * Draw source where there was destination content (unbounded)
+ *
+ * @var integer
+ **/
+ const IN = 0;
+
+ /**
+ * Draw source where there was no destination content (unbounded)
+ *
+ * @var integer
+ **/
+ const OUT = 0;
+
+ /**
+ * Draw source layer on top of destination layer (bounded)
+ *
+ * @var integer
+ **/
+ const OVER = 0;
+
+ /**
+ * Like CairoOperator::OVER, but assuming source and dest are disjoint
+ * geometries
+ *
+ * @var integer
+ **/
+ const SATURATE = 0;
+
+ /**
+ * Replace destination layer (bounded)
+ *
+ * @var integer
+ **/
+ const SOURCE = 0;
+
+ /**
+ * Source and destination are shown where there is only one of them
+ *
+ * @var integer
+ **/
+ const XOR = 0;
+
}
/**
* Note: CairoPath class cannot be instantiated directly, doing so will
* result in Fatal Error if used or passed
**/
class CairoPath {
}
/**
- * is the abstract base class from which all the other pattern classes
- * derive. It cannot be instantiated directly
+ * CairoPattern is the abstract base class from which all the other
+ * pattern classes derive. It cannot be instantiated directly
**/
class CairoPattern {
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The getMatrix purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function getMatrix(){}
+ public function getMatrix(){}
/**
+ * The getType purpose
+ *
* The method description goes here.
- *
- * @return int
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getType(){}
+ public function getType(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @param string $matrix Description...
- * @return void
+ * The setMatrix purpose
+ *
+ * @param CairoMatrix $matrix Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setMatrix($matrix){}
+ public function setMatrix($matrix){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return int
+ * The status purpose
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function status(){}
+ public function status(){}
/**
+ * The __construct purpose
+ *
* The method description goes here.
- *
+ *
* @since PECL cairo >= 0.1.0
**/
- function __construct(){}
+ public function __construct(){}
}
/**
- * is used to describe the type of a given pattern.
- *
- * The type of a pattern is determined by the function used to create it.
- * The and functions create patterns. The remaining
+ * CairoPatternType is used to describe the type of a given pattern. The
+ * type of a pattern is determined by the function used to create it. The
+ * {@link cairo_pattern_create_rgb} and {@link cairo_pattern_create_rgba}
+ * functions create CairoPatternType::SOLID patterns. The remaining
* cairo_pattern_create_* functions map to pattern types in obvious ways.
**/
class CairoPatternType {
+ /**
+ * The pattern is a linear gradient.
+ *
+ * @var integer
+ **/
+ const LINEAR = 0;
+
+ /**
+ * The pattern is a radial gradient.
+ *
+ * @var integer
+ **/
+ const RADIAL = 0;
+
+ /**
+ * The pattern is a solid (uniform) color. It may be opaque or
+ * translucent.
+ *
+ * @var integer
+ **/
+ const SOLID = 0;
+
+ /**
+ * The pattern is a based on a surface (an image).
+ *
+ * @var integer
+ **/
+ const SURFACE = 0;
+
}
class CairoPdfSurface extends CairoSurface {
/**
+ * The setSize purpose
+ *
* The method description goes here.
- *
- * @param string $width Description...
- * @param string $height Description...
- * @return void
+ *
+ * @param float $width Description...
+ * @param float $height Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setSize($width, $height){}
+ public function setSize($width, $height){}
/**
+ * The __construct purpose
+ *
* The method description goes here.
- *
+ *
* @param string $file Description...
* @param float $width Description...
* @param float $height Description...
* @since PECL cairo >= 0.1.0
**/
- function __construct($file, $width, $height){}
+ public function __construct($file, $width, $height){}
}
class CairoPsLevel {
+ /**
+ * @var integer
+ **/
+ const LEVEL_2 = 0;
+
+ /**
+ * @var integer
+ **/
+ const LEVEL_3 = 0;
+
}
class CairoPsSurface extends CairoSurface {
/**
+ * The dscBeginPageSetup purpose
+ *
* The method description goes here.
- *
- * @return void
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function dscBeginPageSetup(){}
+ public function dscBeginPageSetup(){}
/**
+ * The dscBeginSetup purpose
+ *
* The method description goes here.
- *
- * @return void
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function dscBeginSetup(){}
+ public function dscBeginSetup(){}
/**
+ * The dscComment purpose
+ *
* The method description goes here.
- *
+ *
* @param string $comment Description...
- * @return void
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function dscComment($comment){}
+ public function dscComment($comment){}
/**
+ * The getEps purpose
+ *
* The method description goes here.
- *
- * @return bool
+ *
+ * @return bool Description...
* @since PECL cairo >= 0.1.0
**/
- function getEps(){}
+ public function getEps(){}
/**
+ * The getLevels purpose
+ *
* The method description goes here.
- *
- * @return array
+ *
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function getLevels(){}
+ public static function getLevels(){}
/**
+ * The levelToString purpose
+ *
* The method description goes here.
- *
+ *
* @param int $level Description...
- * @return string
+ * @return string Description...
* @since PECL cairo >= 0.1.0
**/
- function levelToString($level){}
+ public static function levelToString($level){}
/**
+ * The restrictToLevel purpose
+ *
* The method description goes here.
- *
- * @param string $level Description...
- * @return void
+ *
+ * @param int $level Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function restrictToLevel($level){}
+ public function restrictToLevel($level){}
/**
+ * The setEps purpose
+ *
* The method description goes here.
- *
- * @param string $level Description...
- * @return void
+ *
+ * @param bool $level Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setEps($level){}
+ public function setEps($level){}
/**
+ * The setSize purpose
+ *
* The method description goes here.
- *
- * @param string $width Description...
- * @param string $height Description...
- * @return void
+ *
+ * @param float $width Description...
+ * @param float $height Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setSize($width, $height){}
+ public function setSize($width, $height){}
/**
+ * The __construct purpose
+ *
* The method description goes here.
- *
+ *
* @param string $file Description...
* @param float $width Description...
* @param float $height Description...
* @since PECL cairo >= 0.1.0
**/
- function __construct($file, $width, $height){}
+ public function __construct($file, $width, $height){}
}
class CairoRadialGradient extends CairoGradientPattern {
/**
+ * The getCircles purpose
+ *
* The method description goes here.
- *
- * @return array
+ *
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function getCircles(){}
+ public function getCircles(){}
/**
- * :
- *
- * :
- *
+ * The __construct purpose
+ *
* Creates a new radial gradient CairoPattern between the two circles
* defined by (x0, y0, r0) and (x1, y1, r1). Before using the gradient
* pattern, a number of color stops should be defined using
* CairoRadialGradient::addColorStopRgb or
* CairoRadialGradient::addColorStopRgba.
- *
+ *
* Note: The coordinates here are in pattern space. For a new pattern,
* pattern space is identical to user space, but the relationship between
* the spaces can be changed with CairoRadialGradient::setMatrix.
- *
+ *
* @param float $x0 x coordinate for the center of the start circle.
* @param float $y0 y coordinate for the center of the start circle.
* @param float $r0 radius of the start circle.
* @param float $x1 x coordinate for the center of the end circle.
* @param float $y1 y coordinate for the center of the end circle.
* @param float $r1 radius of the end circle.
* @since PECL cairo >= 0.1.0
**/
- function __construct($x0, $y0, $r0, $x1, $y1, $r1){}
+ public function __construct($x0, $y0, $r0, $x1, $y1, $r1){}
}
class CairoScaledFont {
/**
+ * The extents purpose
+ *
* The method description goes here.
- *
- * @return array
+ *
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function extents(){}
+ public function extents(){}
/**
+ * The getCtm purpose
+ *
* The method description goes here.
- *
- * @return CairoMatrix
+ *
+ * @return CairoMatrix Description...
* @since PECL cairo >= 0.1.0
**/
- function getCtm(){}
+ public function getCtm(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The getFontFace purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function getFontFace(){}
+ public function getFontFace(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The getFontMatrix purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function getFontMatrix(){}
+ public function getFontMatrix(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The getFontOptions purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function getFontOptions(){}
+ public function getFontOptions(){}
/**
+ * The getScaleMatrix purpose
+ *
* The method description goes here.
- *
- * @return void
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function getScaleMatrix(){}
+ public function getScaleMatrix(){}
/**
+ * The getType purpose
+ *
* The method description goes here.
- *
- * @return int
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getType(){}
+ public function getType(){}
/**
+ * The glyphExtents purpose
+ *
* The method description goes here.
- *
- * @param string $glyphs Description...
- * @return array
+ *
+ * @param array $glyphs Description...
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function glyphExtents($glyphs){}
+ public function glyphExtents($glyphs){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return int
+ * The status purpose
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function status(){}
+ public function status(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
+ * The textExtents purpose
+ *
* @param string $text Description...
- * @return array
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function textExtents($text){}
+ public function textExtents($text){}
/**
+ * The __construct purpose
+ *
* The method description goes here.
- *
+ *
* @param CairoFontFace $font_face Description...
* @param CairoMatrix $matrix Description...
* @param CairoMatrix $ctm Description...
* @param CairoFontOptions $options Description...
* @since PECL cairo >= 0.1.0
**/
- function __construct($font_face, $matrix, $ctm, $options){}
+ public function __construct($font_face, $matrix, $ctm, $options){}
}
class CairoSolidPattern extends CairoPattern {
/**
+ * The getRgba purpose
+ *
* The method description goes here.
- *
- * @return array
+ *
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function getRgba(){}
+ public function getRgba(){}
/**
+ * The __construct purpose
+ *
* The method description goes here.
- *
+ *
* @param float $red Description...
* @param float $green Description...
* @param float $blue Description...
* @param float $alpha Description...
* @since PECL cairo >= 0.1.0
**/
- function __construct($red, $green, $blue, $alpha){}
+ public function __construct($red, $green, $blue, $alpha){}
}
/**
- * is used to indicate errors that can occur when using Cairo. In some
- * cases it is returned directly by functions. but when using , the last
- * error, if any, is stored in the object and can be retrieved with or .
- * New entries may be added in future versions. Use or to get a
+ * CairoStatus is used to indicate errors that can occur when using
+ * Cairo. In some cases it is returned directly by functions. but when
+ * using CairoContext, the last error, if any, is stored in the object
+ * and can be retrieved with CairoContext::status or {@link
+ * cairo_status}. New entries may be added in future versions. Use
+ * Cairo::statusToString or {@link cairo_status_to_string} to get a
* human-readable representation of an error message.
**/
class CairoStatus {
+ /**
+ * @var integer
+ **/
+ const CLIP_NOT_REPRESENTABLE = 0;
+
+ /**
+ * @var integer
+ **/
+ const FILE_NOT_FOUND = 0;
+
+ /**
+ * @var integer
+ **/
+ const INVALID_CONTENT = 0;
+
+ /**
+ * @var integer
+ **/
+ const INVALID_DASH = 0;
+
+ /**
+ * @var integer
+ **/
+ const INVALID_DSC_COMMENT = 0;
+
+ /**
+ * @var integer
+ **/
+ const INVALID_FORMAT = 0;
+
+ /**
+ * @var integer
+ **/
+ const INVALID_INDEX = 0;
+
+ /**
+ * @var integer
+ **/
+ const INVALID_MATRIX = 0;
+
+ /**
+ * @var integer
+ **/
+ const INVALID_PATH_DATA = 0;
+
+ /**
+ * @var integer
+ **/
+ const INVALID_POP_GROUP = 0;
+
+ /**
+ * @var integer
+ **/
+ const INVALID_RESTORE = 0;
+
+ /**
+ * @var integer
+ **/
+ const INVALID_STATUS = 0;
+
+ /**
+ * @var integer
+ **/
+ const INVALID_STRIDE = 0;
+
+ /**
+ * @var integer
+ **/
+ const INVALID_STRING = 0;
+
+ /**
+ * @var integer
+ **/
+ const INVALID_VISUAL = 0;
+
+ /**
+ * @var integer
+ **/
+ const NO_CURRENT_POINT = 0;
+
+ /**
+ * @var integer
+ **/
+ const NO_MEMORY = 0;
+
+ /**
+ * @var integer
+ **/
+ const NULL_POINTER = 0;
+
+ /**
+ * @var integer
+ **/
+ const PATTERN_TYPE_MISMATCH = 0;
+
+ /**
+ * @var integer
+ **/
+ const READ_ERROR = 0;
+
+ /**
+ * No error has occurred
+ *
+ * @var integer
+ **/
+ const SUCCESS = 0;
+
+ /**
+ * @var integer
+ **/
+ const SURFACE_FINISHED = 0;
+
+ /**
+ * @var integer
+ **/
+ const SURFACE_TYPE_MISMATCH = 0;
+
+ /**
+ * @var integer
+ **/
+ const TEMP_FILE_ERROR = 0;
+
+ /**
+ * @var integer
+ **/
+ const WRITE_ERROR = 0;
+
}
class CairoSubpixelOrder {
+ /**
+ * @var integer
+ **/
+ const ORDER_BGR = 0;
+
+ /**
+ * @var integer
+ **/
+ const ORDER_DEFAULT = 0;
+
+ /**
+ * @var integer
+ **/
+ const ORDER_RGB = 0;
+
+ /**
+ * @var integer
+ **/
+ const ORDER_VBGR = 0;
+
+ /**
+ * @var integer
+ **/
+ const ORDER_VRGB = 0;
+
}
/**
* This is the base-class for all other Surface types. CairoSurface is
* the abstract type representing all different drawing targets that
* cairo can render to. The actual drawings are performed using a
* CairoContext.
**/
class CairoSurface {
/**
- * (method):
- *
- * :
- *
+ * The copyPage purpose
+ *
* Emits the current page for backends that support multiple pages, but
* doesn't clear it, so that the contents of the current page will be
* retained for the next page. Use CairoSurface::showPage() if you want
* to get an empty page after the emission.
- *
- * @return void
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function copyPage(){}
+ public function copyPage(){}
/**
+ * The createSimilar purpose
+ *
* Create a new surface that is as compatible as possible with an
* existing surface. For example the new surface will have the same
* fallback resolution and font options as other. Generally, the new
* surface will also use the same backend as other, unless that is not
* possible for some reason. The type of the returned surface may be
* examined with CairoSurface::getType(). Initially the surface contents
* are all 0 (transparent if contents have transparency, black
* otherwise.)
- *
+ *
* @param CairoSurface $other An existing surface used to select the
* backend of the new surface
* @param int $content The content for the new surface. See the
* CairoContent class for possible values.
* @param string $width Width of the new surface, (in device-space
* units).
* @param string $height Height of the new surface, (in device-space
* units).
- * @return void
+ * @return void A new CairoSurface
* @since PECL cairo >= 0.1.0
**/
- function createSimilar($other, $content, $width, $height){}
+ public function createSimilar($other, $content, $width, $height){}
/**
+ * The finish purpose
+ *
* The method description goes here.
- *
- * @return void
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function finish(){}
+ public function finish(){}
/**
+ * The flush purpose
+ *
* The method description goes here.
- *
- * @return void
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function flush(){}
+ public function flush(){}
/**
+ * The getContent purpose
+ *
* The method description goes here.
- *
- * @return int
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getContent(){}
+ public function getContent(){}
/**
+ * The getDeviceOffset purpose
+ *
* The method description goes here.
- *
- * @return array
+ *
+ * @return array Description...
* @since PECL cairo >= 0.1.0
**/
- function getDeviceOffset(){}
+ public function getDeviceOffset(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The getFontOptions purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function getFontOptions(){}
+ public function getFontOptions(){}
/**
+ * The getType purpose
+ *
* The method description goes here.
- *
- * @return int
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getType(){}
+ public function getType(){}
/**
+ * The markDirty purpose
+ *
* The method description goes here.
- *
- * @return void
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function markDirty(){}
+ public function markDirty(){}
/**
+ * The markDirtyRectangle purpose
+ *
* The method description goes here.
- *
- * @param string $x Description...
- * @param string $y Description...
- * @param string $width Description...
- * @param string $height Description...
- * @return void
+ *
+ * @param float $x Description...
+ * @param float $y Description...
+ * @param float $width Description...
+ * @param float $height Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function markDirtyRectangle($x, $y, $width, $height){}
+ public function markDirtyRectangle($x, $y, $width, $height){}
/**
+ * The setDeviceOffset purpose
+ *
* The method description goes here.
- *
- * @param string $x Description...
- * @param string $y Description...
- * @return void
+ *
+ * @param float $x Description...
+ * @param float $y Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setDeviceOffset($x, $y){}
+ public function setDeviceOffset($x, $y){}
/**
+ * The setFallbackResolution purpose
+ *
* The method description goes here.
- *
- * @param string $x Description...
- * @param string $y Description...
- * @return void
+ *
+ * @param float $x Description...
+ * @param float $y Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setFallbackResolution($x, $y){}
+ public function setFallbackResolution($x, $y){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return void
+ * The showPage purpose
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function showPage(){}
+ public function showPage(){}
/**
- * (method):
- *
- * :
- *
- * Description here.
- *
- * @return int
+ * The status purpose
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function status(){}
+ public function status(){}
/**
+ * The writeToPng purpose
+ *
* The method description goes here.
- *
+ *
* @param string $file Description...
- * @return void
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function writeToPng($file){}
+ public function writeToPng($file){}
/**
+ * The __construct purpose
+ *
* CairoSurface is an abstract type and, as such, should not be
* instantiated in your PHP scripts.
- *
+ *
* @since PECL cairo >= 0.1.0
**/
- function __construct(){}
+ public function __construct(){}
}
class CairoSurfacePattern extends CairoPattern {
/**
+ * The getExtend purpose
+ *
* The method description goes here.
- *
- * @return int
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getExtend(){}
+ public function getExtend(){}
/**
+ * The getFilter purpose
+ *
* The method description goes here.
- *
- * @return int
+ *
+ * @return int Description...
* @since PECL cairo >= 0.1.0
**/
- function getFilter(){}
+ public function getFilter(){}
/**
+ * The getSurface purpose
+ *
* The method description goes here.
- *
- * @return void
+ *
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function getSurface(){}
+ public function getSurface(){}
/**
+ * The setExtend purpose
+ *
* The method description goes here.
- *
+ *
* @param int $extend Description...
- * @return void
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setExtend($extend){}
+ public function setExtend($extend){}
/**
+ * The setFilter purpose
+ *
* The method description goes here.
- *
- * @param string $filter Description...
- * @return void
+ *
+ * @param int $filter Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function setFilter($filter){}
+ public function setFilter($filter){}
/**
+ * The __construct purpose
+ *
* The method description goes here.
- *
+ *
* @param CairoSurface $surface Description...
* @since PECL cairo >= 0.1.0
**/
- function __construct($surface){}
+ public function __construct($surface){}
}
class CairoSurfaceType {
+ /**
+ * @var integer
+ **/
+ const BEOS = 0;
+
+ /**
+ * @var integer
+ **/
+ const DIRECTFB = 0;
+
+ /**
+ * @var integer
+ **/
+ const GLITZ = 0;
+
+ /**
+ * @var integer
+ **/
+ const IMAGE = 0;
+
+ /**
+ * @var integer
+ **/
+ const OS2 = 0;
+
+ /**
+ * @var integer
+ **/
+ const PDF = 0;
+
+ /**
+ * @var integer
+ **/
+ const PS = 0;
+
+ /**
+ * @var integer
+ **/
+ const QUARTZ = 0;
+
+ /**
+ * @var integer
+ **/
+ const QUARTZ_IMAGE = 0;
+
+ /**
+ * @var integer
+ **/
+ const SVG = 0;
+
+ /**
+ * @var integer
+ **/
+ const WIN32 = 0;
+
+ /**
+ * @var integer
+ **/
+ const WIN32_PRINTING = 0;
+
+ /**
+ * @var integer
+ **/
+ const XCB = 0;
+
+ /**
+ * @var integer
+ **/
+ const XLIB = 0;
+
}
/**
* Svg specific surface class, uses the SVG (standard vector graphics)
* surface backend.
**/
class CairoSvgSurface extends CairoSurface {
/**
- * (method):
- *
- * :
- *
+ * Used to retrieve a list of supported SVG versions
+ *
* Returns a numerically indexed array of currently available
* CairoSvgVersion constants. In order to retreive the string values for
* each item, use CairoSvgSurface::versionToString.
- *
- * @return array
+ *
+ * @return array Returns a numerically indexed array of integer values.
* @since PECL cairo >= 0.1.0
**/
- function getVersions(){}
+ public static function getVersions(){}
/**
+ * The restrictToVersion purpose
+ *
* The method description goes here.
- *
- * @param string $version Description...
- * @return void
+ *
+ * @param int $version Description...
+ * @return void Description...
* @since PECL cairo >= 0.1.0
**/
- function restrictToVersion($version){}
+ public function restrictToVersion($version){}
/**
+ * The versionToString purpose
+ *
* The method description goes here.
- *
+ *
* @param int $version Description...
- * @return string
+ * @return string Description...
* @since PECL cairo >= 0.1.0
**/
- function versionToString($version){}
+ public static function versionToString($version){}
/**
+ * The __construct purpose
+ *
* The method description goes here.
- *
+ *
* @param string $file Description...
* @param float $width Description...
* @param float $height Description...
* @since PECL cairo >= 0.1.0
**/
- function __construct($file, $width, $height){}
+ public function __construct($file, $width, $height){}
}
class CairoSvgVersion {
+ /**
+ * @var integer
+ **/
+ const VERSION_1_1 = 0;
+
+ /**
+ * @var integer
+ **/
+ const VERSION_1_2 = 0;
+
}
/**
- * The class can be used instead of to create a toy font independently of
- * a context.
+ * The CairoToyFontFace class can be used instead of
+ * CairoContext::selectFontFace to create a toy font independently of a
+ * context.
**/
class CairoToyFontFace extends CairoFontFace {
}
/**
* The callback should accept up to three arguments: the current item,
- * the current key and the iterator, respectively.
- *
- * Any may be used; such as a string containing a function name, an array
- * for a method, or an anonymous function.
+ * the current key and the iterator, respectively. Any callable may be
+ * used; such as a string containing a function name, an array for a
+ * method, or an anonymous function.
**/
class CallbackFilterIterator extends FilterIterator implements OuterIterator {
/**
+ * Calls the callback with the current value, the current key and the
+ * inner iterator as arguments
+ *
* This method calls the callback with the current value, current key and
* the inner iterator.
- *
- * The callback is expected to return if the current item is to be
- * accepted, or otherwise.
- *
- * @return string
+ *
+ * The callback is expected to return TRUE if the current item is to be
+ * accepted, or FALSE otherwise.
+ *
+ * @return string Returns TRUE to accept the current item, or FALSE
+ * otherwise.
* @since PHP 5 >= 5.4.0, PHP 7
**/
- function accept(){}
+ public function accept(){}
}
/**
* Represents a loaded chdb file.
**/
class chdb {
/**
+ * Gets the value associated with a key
+ *
* Gets the value associated with a key from a chdb database.
- *
+ *
* @param string $key The key for which to get the value.
- * @return string
+ * @return string Returns a string containing the value associated with
+ * the given {@link key}, or NULL if not found.
* @since PECL chdb >= 0.1.0
**/
- function get($key){}
+ public function get($key){}
/**
+ * Creates a instance
+ *
* Loads a chdb file, by mapping it into memory. While some validity
* checks are performed on the specified file, they are mostly there to
* avoid the possibility of common mistakes (for example, loading a file
* which is not a chdb database, or that is somehow incompatible with the
* current system). A maliciously crafted chdb file can thus be dangerous
* if loaded, so chdb files should be trusted and treated with the same
* security protections used for PHP shared libraries.
- *
+ *
* @param string $pathname The name of the file to load.
* @since PECL chdb >= 0.1.0
**/
- function __construct($pathname){}
+ public function __construct($pathname){}
}
/**
- * Class used to represent .
- *
- * Anonymous functions, implemented in PHP 5.3, yield objects of this
- * type. This fact used to be considered an implementation detail, but it
- * can now be relied upon. Starting with PHP 5.4, this class has methods
- * that allow further control of the anonymous function after it has been
- * created.
- *
- * Besides the methods listed here, this class also has an method. This
- * is for consistency with other classes that implement , as this method
- * is not used for calling the function.
+ * Class used to represent anonymous functions. Anonymous functions,
+ * implemented in PHP 5.3, yield objects of this type. This fact used to
+ * be considered an implementation detail, but it can now be relied upon.
+ * Starting with PHP 5.4, this class has methods that allow further
+ * control of the anonymous function after it has been created. Besides
+ * the methods listed here, this class also has an __invoke method. This
+ * is for consistency with other classes that implement calling magic, as
+ * this method is not used for calling the function.
**/
class Closure {
/**
+ * Duplicates a closure with a specific bound object and class scope
+ *
* This method is a static version of Closure::bindTo. See the
* documentation of that method for more information.
- *
+ *
* @param Closure $closure The anonymous functions to bind.
* @param object $newthis The object to which the given anonymous
- * function should be bound, or for the closure to be unbound.
+ * function should be bound, or NULL for the closure to be unbound.
* @param mixed $newscope The class scope to which associate the
* closure is to be associated, or 'static' to keep the current one. If
* an object is given, the type of the object will be used instead.
* This determines the visibility of protected and private methods of
* the bound object. It is not allowed to pass (an object of) an
* internal class as this parameter.
- * @return Closure
+ * @return Closure Returns a new Closure object
* @since PHP 5 >= 5.4.0, PHP 7
**/
- function bind($closure, $newthis, $newscope){}
+ public static function bind($closure, $newthis, $newscope){}
/**
+ * Duplicates the closure with a new bound object and class scope
+ *
* Create and return a new anonymous function with the same body and
* bound variables as this one, but possibly with a different bound
* object and a new class scope.
- *
+ *
* The “bound object” determines the value $this will have in the
* function body and the “class scope” represents a class which
* determines which private and protected members the anonymous function
* will be able to access. Namely, the members that will be visible are
* the same as if the anonymous function were a method of the class given
* as value of the {@link newscope} parameter.
- *
+ *
* Static closures cannot have any bound object (the value of the
- * parameter {@link newthis} should be ), but this function can
+ * parameter {@link newthis} should be NULL), but this function can
* nevertheless be used to change their class scope.
- *
+ *
* This function will ensure that for a non-static closure, having a
* bound instance will imply being scoped and vice-versa. To this end,
- * non-static closures that are given a scope but a instance are made
- * static and non-static non-scoped closures that are given a non-null
- * instance are scoped to an unspecified class.
- *
+ * non-static closures that are given a scope but a NULL instance are
+ * made static and non-static non-scoped closures that are given a
+ * non-null instance are scoped to an unspecified class.
+ *
* @param object $newthis The object to which the given anonymous
- * function should be bound, or for the closure to be unbound.
+ * function should be bound, or NULL for the closure to be unbound.
* @param mixed $newscope The class scope to which associate the
* closure is to be associated, or 'static' to keep the current one. If
* an object is given, the type of the object will be used instead.
* This determines the visibility of protected and private methods of
* the bound object. It is not allowed to pass (an object of) an
* internal class as this parameter.
- * @return Closure
+ * @return Closure Returns the newly created Closure object
* @since PHP 5 >= 5.4.0, PHP 7
**/
- function bindTo($newthis, $newscope){}
+ public function bindTo($newthis, $newscope){}
/**
+ * Binds and calls the closure
+ *
* Temporarily binds the closure to {@link newthis}, and calls it with
* any given parameters.
- *
+ *
* @param object $newthis The object to bind the closure to for the
* duration of the call.
- * @return mixed
+ * @return mixed Returns the return value of the closure.
* @since PHP 7
**/
- function call($newthis){}
+ public function call($newthis){}
/**
+ * Converts a callable into a closure
+ *
* Create and return a new anonymous function from given {@link callable}
* using the current scope. This method checks if the {@link callable} is
* callable in the current scope and throws a TypeError if it is not.
- *
+ *
* @param callable $callable The callable to convert.
- * @return Closure
+ * @return Closure Returns the newly created Closure or throws a
+ * TypeError if the {@link callable} is not callable in the current
+ * scope.
* @since PHP 7 >= 7.1.0
**/
- function fromCallable($callable){}
+ public static function fromCallable($callable){}
/**
+ * Constructor that disallows instantiation
+ *
* This method exists only to disallow instantiation of the Closure
* class. Objects of this class are created in the fashion described on
* the anonymous functions page.
- *
+ *
* @since PHP 5 >= 5.3.0, PHP 7
**/
- function __construct(){}
+ private function __construct(){}
}
/**
* Provides string comparison capability with support for appropriate
* locale-sensitive sort orderings.
**/
class Collator {
/**
+ * Sort array maintaining index association
+ *
* This function sorts an array such that array indices maintain their
* correlation with the array elements they are associated with. This is
* used mainly when sorting associative arrays where the actual element
* order is significant. Array elements will have sort order according to
* current locale rules.
- *
+ *
* Equivalent to standard PHP {@link asort}.
- *
+ *
* @param array $arr Collator object.
* @param int $sort_flag Array of strings to sort.
* @return bool
* @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
**/
- function asort(&$arr, $sort_flag){}
+ public function asort(&$arr, $sort_flag){}
/**
+ * Compare two Unicode strings
+ *
* Compare two Unicode strings according to collation rules.
- *
+ *
* @param string $str1 Collator object.
* @param string $str2 The first string to compare.
- * @return int
+ * @return int Return comparison result:
* @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
**/
- function compare($str1, $str2){}
+ public function compare($str1, $str2){}
/**
+ * Create a collator
+ *
* The strings will be compared using the options already specified.
- *
+ *
* @param string $locale The locale containing the required collation
* rules. Special values for locales can be passed in - if null is
* passed for the locale, the default locale collation rules will be
* used. If empty string ("") or "root" are passed, UCA rules will be
* used.
- * @return Collator
+ * @return Collator Return new instance of Collator object, or NULL on
+ * error.
* @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
**/
- function create($locale){}
+ public static function create($locale){}
/**
+ * Get collation attribute value
+ *
* Get a value of an integer collator attribute.
- *
+ *
* @param int $attr Collator object.
- * @return int
+ * @return int Attribute value, or boolean FALSE on error.
* @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
**/
- function getAttribute($attr){}
+ public function getAttribute($attr){}
/**
- * @return int
+ * Get collator's last error code
+ *
+ * @return int Error code returned by the last Collator API function
+ * call.
* @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
**/
- function getErrorCode(){}
+ public function getErrorCode(){}
/**
+ * Get text for collator's last error code
+ *
* Retrieves the message for the last error.
- *
- * @return string
+ *
+ * @return string Description of an error occurred in the last Collator
+ * API function call.
* @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
**/
- function getErrorMessage(){}
+ public function getErrorMessage(){}
/**
+ * Get the locale name of the collator
+ *
* Get collector locale name.
- *
+ *
* @param int $type Collator object.
- * @return string
+ * @return string Real locale name from which the collation data comes.
+ * If the collator was instantiated from rules or an error occurred,
+ * returns boolean FALSE.
* @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
**/
- function getLocale($type){}
+ public function getLocale($type){}
/**
+ * Get sorting key for a string
+ *
* Return collation key for a string.
- *
+ *
* @param string $str Collator object.
- * @return string
+ * @return string Returns the collation key for the string. Collation
+ * keys can be compared directly instead of strings.
* @since PHP 5 >= 5.3.11, PHP 7, PECL intl >= 1.0.3
**/
- function getSortKey($str){}
+ public function getSortKey($str){}
/**
- * @return int
+ * Get current collation strength
+ *
+ * @return int Returns current collation strength, or boolean FALSE on
+ * error.
* @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
**/
- function getStrength(){}
+ public function getStrength(){}
/**
+ * Set collation attribute
+ *
* @param int $attr Collator object.
* @param int $val Attribute.
* @return bool
* @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
**/
- function setAttribute($attr, $val){}
+ public function setAttribute($attr, $val){}
/**
+ * Set collation strength
+ *
* The ICU Collation Service supports many levels of comparison (named
* "Levels", but also known as "Strengths"). Having these categories
* enables ICU to sort strings precisely according to local conventions.
* However, by allowing the levels to be selectively employed, searching
* for a string in text can be performed with various matching
* conditions.
- *
+ *
* Primary Level: Typically, this is used to denote differences between
* base characters (for example, "a" < "b"). It is the strongest
* difference. For example, dictionaries are divided into different
* sections by base character. This is also called the level1 strength.
* Secondary Level: Accents in the characters are considered secondary
* differences (for example, "as" < "às" < "at"). Other differences
* between letters can also be considered secondary differences,
* depending on the language. A secondary difference is ignored when
* there is a primary difference anywhere in the strings. This is also
* called the level2 strength. Note: In some languages (such as Danish),
* certain accented letters are considered to be separate base
* characters. In most languages, however, an accented letter only has a
* secondary difference from the unaccented version of that letter.
* Tertiary Level: Upper and lower case differences in characters are
* distinguished at the tertiary level (for example, "ao" < "Ao" <
* "aò"). In addition, a variant of a letter differs from the base form
* on the tertiary level (such as "A" and " "). Another example is the
* difference between large and small Kana. A tertiary difference is
* ignored when there is a primary or secondary difference anywhere in
* the strings. This is also called the level3 strength. Quaternary
* Level: When punctuation is ignored (see Ignoring Punctuations ) at
* level 13, an additional level can be used to distinguish words with
* and without punctuation (for example, "ab" < "a-b" < "aB"). This
* difference is ignored when there is a primary, secondary or tertiary
* difference. This is also known as the level4 strength. The quaternary
* level should only be used if ignoring punctuation is required or when
* processing Japanese text (see Hiragana processing). Identical Level:
* When all other levels are equal, the identical level is used as a
* tiebreaker. The Unicode code point values of the NFD form of each
* string are compared at this level, just in case there is no difference
* at levels 14. For example, Hebrew cantillation marks are only
* distinguished at this level. This level should be used sparingly, as
* only code point values differences between two strings is an extremely
* rare occurrence. Using this level substantially decreases the
* performance for both incremental comparison and sort key generation
* (as well as increasing the sort key length). It is also known as level
* 5 strength.
- *
+ *
* For example, people may choose to ignore accents or ignore accents and
* case when searching for text. Almost all characters are distinguished
* by the first three levels, and in most locales the default value is
* thus Tertiary. However, if Alternate is set to be Shifted, then the
* Quaternary strength can be used to break ties among whitespace,
* punctuation, and symbols that would otherwise be ignored. If very fine
* distinctions among characters are required, then the Identical
* strength can be used (for example, Identical Strength distinguishes
* between the Mathematical Bold Small A and the Mathematical Italic
* Small A.). However, using levels higher than Tertiary the Identical
* strength result in significantly longer sort keys, and slower string
* comparison performance for equal strings.
- *
+ *
* @param int $strength Collator object.
* @return bool
* @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
**/
- function setStrength($strength){}
+ public function setStrength($strength){}
/**
+ * Sort array using specified collator
+ *
* This function sorts an array according to current locale rules.
- *
+ *
* Equivalent to standard PHP {@link sort} .
- *
+ *
* @param array $arr Collator object.
* @param int $sort_flag Array of strings to sort.
* @return bool
* @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
**/
- function sort(&$arr, $sort_flag){}
+ public function sort(&$arr, $sort_flag){}
/**
+ * Sort array using specified collator and sort keys
+ *
* Similar to {@link collator_sort} but uses ICU sorting keys produced by
* ucol_getSortKey() to gain more speed on large arrays.
- *
+ *
* @param array $arr Collator object.
* @return bool
* @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
**/
- function sortWithSortKeys(&$arr){}
+ public function sortWithSortKeys(&$arr){}
}
/**
* Represents a garbage-collectable object.
**/
interface Collectable {
/**
+ * Determine whether an object has been marked as garbage
+ *
* Can be called in Pool::collect to determine if this object is garbage.
- *
+ *
* @return bool
* @since PECL pthreads >= 2.0.8
**/
- function isGarbage();
+ public function isGarbage();
/**
+ * Mark an object as garbage
+ *
* Should be called once per object when the object is finished being
* executed or referenced.
- *
+ *
* @return void
* @since PECL pthreads < 3.0.0
**/
- function setGarbage();
+ public function setGarbage();
+
+}
+namespace CommonMark {
+class CQL {
+ /**
+ * CQL Execution
+ *
+ * Shall invoke the current CQL function on the given {@link root},
+ * executing the given {@link handler} on entry to a \CommonMark\Node
+ *
+ * @param \CommonMark\Node $root the root node of a tree
+ * @param callable $handler should have the prototype: ?boolhandler
+ * \CommonMark\Node{@link root} \CommonMark\Node{@link entering} Should
+ * {@link handler} fail to return (void), or return null, CQL will
+ * continue executing Should the handler return a truthy value, CQL
+ * will continue executing. Should the handler return a falsy value,
+ * CQL will stop executing
+ **/
+ public function __invoke($root, $handler){}
+
+}
+}
+namespace CommonMark\Interfaces {
+interface IVisitable {
+ /**
+ * Visitation
+ *
+ * @param CommonMark\Interfaces\IVisitor $visitor An object
+ * implementing CommonMark\Interfaces\IVisitor
+ * @return void
+ **/
+ public function accept($visitor);
+
+}
+}
+namespace CommonMark\Interfaces {
+interface IVisitor {
+ /**
+ * Visitation
+ *
+ * @param IVisitable $visitable The current
+ * CommonMark\Interfaces\IVisitable being entered
+ * @return ?int|IVisitable Returning
+ * CommonMark\Interfaces\IVisitor::Done will cause the backing iterator
+ * to exit.
+ **/
+ public function enter($visitable);
+
+ /**
+ * Visitation
+ *
+ * @param IVisitable $visitable The current
+ * CommonMark\Interfaces\IVisitable being exited
+ * @return ?int|IVisitable Returning
+ * CommonMark\Interfaces\IVisitor::Done will cause the backing iterator
+ * to exit.
+ **/
+ public function leave($visitable);
+
+}
+}
+namespace CommonMark {
+final class Node implements CommonMark\Interfaces\IVisitable, Traversable {
+ /**
+ * @var int
+ **/
+ public $endColumn;
+
+ /**
+ * @var int
+ **/
+ public $endLine;
+
+ /**
+ * @var ?Node
+ **/
+ public $firstChild;
+
+ /**
+ * @var ?Node
+ **/
+ public $lastChild;
+
+ /**
+ * @var ?Node
+ **/
+ public $next;
+
+ /**
+ * @var ?Node
+ **/
+ public $parent;
+
+ /**
+ * @var ?Node
+ **/
+ public $previous;
+
+ /**
+ * @var int
+ **/
+ public $startColumn;
+
+ /**
+ * @var int
+ **/
+ public $startLine;
+
+ /**
+ * Visitation
+ *
+ * @param CommonMark\Interfaces\IVisitor $visitor An object
+ * implementing CommonMark\Interfaces\IVisitor
+ * @return void
+ **/
+ public function accept($visitor){}
+
+ /**
+ * AST Manipulation
+ *
+ * @param CommonMark\Node $child
+ * @return CommonMark\Node
+ **/
+ public function appendChild($child){}
+
+ /**
+ * AST Manipulation
+ *
+ * @param CommonMark\Node $sibling
+ * @return CommonMark\Node
+ **/
+ public function insertAfter($sibling){}
+
+ /**
+ * AST Manipulation
+ *
+ * @param CommonMark\Node $sibling
+ * @return CommonMark\Node
+ **/
+ public function insertBefore($sibling){}
+
+ /**
+ * AST Manipulation
+ *
+ * @param CommonMark\Node $child
+ * @return CommonMark\Node
+ **/
+ public function prependChild($child){}
+
+ /**
+ * AST Manipulation
+ *
+ * @param CommonMark\Node $target
+ * @return CommonMark\Node
+ **/
+ public function replace($target){}
+
+ /**
+ * AST Manipulation
+ *
+ * @return void
+ **/
+ public function unlink(){}
+
+}
+}
+namespace CommonMark\Node {
+final class BlockQuote extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class BulletList extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class Code extends CommonMark\Node\Text implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class CodeBlock extends CommonMark\Node\Text implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class CustomBlock extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class CustomInline extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class Document extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class Heading extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class HTMLBlock extends CommonMark\Node\Text implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class HTMLInline extends CommonMark\Node\Text implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class Image extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class Item extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class LineBreak extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class Link extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class OrderedList extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class Paragraph extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class SoftBreak extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class Text extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node\Text {
+final class Emphasis extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node\Text {
+final class Strong extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark\Node {
+final class ThematicBreak extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
+}
+}
+namespace CommonMark {
+final class Parser {
+ /**
+ * Parsing
+ *
+ * @return CommonMark\Node
+ **/
+ public function finish(){}
+
+ /**
+ * Parsing
+ *
+ * @param string $buffer
+ * @return void
+ **/
+ public function parse($buffer){}
+
+}
+}
+namespace Componere {
+final class Definition {
+ /**
+ * Add Constant
+ *
+ * Shall declare a class constant on the current Definition
+ *
+ * @param string $name The case sensitive name for the constant
+ * @param \Componere\Value $value The Value for the constant, must not
+ * be undefined or static
+ * @return Definition The current Definition
+ **/
+ public function addConstant($name, $value){}
+
+ /**
+ * Add Interface
+ *
+ * Shall implement the given interface on the current definition
+ *
+ * @param string $interface The case insensitive name of an interface
+ * @return Definition The current Definition
+ **/
+ public function addInterface($interface){}
+
+ /**
+ * Add Method
+ *
+ * Shall create or override a method on the current definition.
+ *
+ * @param string $name The case insensitive name for method
+ * @param \Componere\Method $method \Componere\Method not previously
+ * added to another Definition
+ * @return Definition The current Definition