# php_manual

id: pcntl_sigwaitinfo
type: function
doc:
<comment>Description:</comment>
  Waits for signals
  
  The <strong>pcntl_sigwaitinfo()</strong> function suspends execution of the calling script until one of the signals
  given in <strong>$signals</strong> are delivered. If one of the signal is already pending (e.g. blocked by
  <strong>pcntl_sigprocmask()</strong>), <strong>pcntl_sigwaitinfo()</strong> will return immediately.

<comment>Param:</comment>
  <info>array</info>  <strong>$signals</strong>  Array of signals to wait for.
  <info>array</info>  <strong>$info</strong>     The <strong>$info</strong> parameter is set to an array containing information about the signal.
                   
                   The following elements are set for all signals: signo: Signal numbererrno: An
                   error numbercode: Signal code
                   
                   The following elements may be set for the <info>SIGCHLD</info> signal: status: Exit value or
                   signalutime: User time consumedstime: System time consumedpid: Sending process
                   IDuid: Real user ID of sending process
                   
                   The following elements may be set for the <info>SIGILL</info>, <info>SIGFPE</info>, <info>SIGSEGV</info> and <info>SIGBUS</info>
                   signals: addr: Memory location which caused fault
                   
                   The following element may be set for the <info>SIGPOLL</info> signal: band: Band eventfd: File
                   descriptor number

<comment>Return:</comment>
  <info>int|false</info>  Returns a signal number on success, ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pcntl_sigprocmask()</strong>
   * <strong>pcntl_sigtimedwait()</strong>


id: pcntl_strerror
type: function
doc:
<comment>Description:</comment>
  Retrieve the system error message associated with the given errno
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>  <strong>$error_code</strong>  

<comment>Return:</comment>
  <info>string</info>  Returns error description.

<comment>See Also:</comment>
   * <strong>pcntl_get_last_error()</strong>


id: pcntl_unshare
type: function
doc:
<comment>Description:</comment>
  Dissociates parts of the process execution context
  
  <strong>pcntl_unshare()</strong> allows a process to disassociate parts of its execution context that are currently
  being shared with other processes. The main use of <strong>pcntl_unshare()</strong> is to allow a process to
  control its shared execution context without creating a new process.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  The <strong>$flags</strong> parameter is a bitmask that specifies which parts of the execution context
               should be unshared. This parameter is specified by ORing together zero or more of the
               <return>CLONE_*</return> constants:
               <info>CLONE_NEWNS</info><info>CLONE_NEWIPC</info><info>CLONE_NEWUTS</info><info>CLONE_NEWNET</info><info>CLONE_NEWPID</info><info>CLONE_NEWUSER</info><info>CLONE_NEWCGROUP</info>

<comment>Return:</comment>
  <info>bool</info>  Returns <return>0</return> on success, <return>-1</return> otherwise. On failure it sets an error code, that can be retrieved
        with <strong>pcntl_get_last_error()</strong>.

<comment>See Also:</comment>
   * PCNTL Constants
   * <strong>pcntl_get_last_error()</strong>


id: pcntl_wait
type: function
doc:
<comment>Description:</comment>
  Waits on or returns the status of a forked child
  
  The wait function suspends execution of the current process until a child has exited, or until a
  signal is delivered whose action is to terminate the current process or to call a signal handling
  function.  If a child has already exited by the time of the call (a so-called "zombie" process),
  the function returns immediately.  Any system resources used by the child are freed.  Please see
  your system's wait(2) man page for specific details as to how wait works on your system.
  
  This function is equivalent to calling <strong>pcntl_waitpid()</strong> with a <return>-1</return> <strong>$process_id</strong> and no <strong>$flags</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>  <strong>pcntl_wait()</strong> will store status information in the <strong>$status</strong> parameter which can be
                evaluated using the following functions: <strong>pcntl_wifexited()</strong>, <strong>pcntl_wifstopped()</strong>,
                <strong>pcntl_wifsignaled()</strong>, <strong>pcntl_wexitstatus()</strong>, <strong>pcntl_wtermsig()</strong> and <strong>pcntl_wstopsig()</strong>.
  <info>int</info>  <strong>$flags</strong>   If wait3 is available on your system (mostly BSD-style systems), you can provide the
                optional <strong>$flags</strong> parameter.  If this parameter is not provided, wait will be used for
                the system call.  If wait3 is not available, providing a value for <strong>$flags</strong> will have
                no effect. The value of <strong>$flags</strong> is the value of zero or more of the following two
                constants <return>OR</return>'ed together: Possible values for <strong>$flags</strong><return>WNOHANG</return> Return immediately if no
                child has exited. <return>WUNTRACED</return> Return for children which are stopped, and whose status
                has not been reported.

<comment>Return:</comment>
  <info>int</info>  <strong>pcntl_wait()</strong> returns the process ID of the child which exited, -1 on error or zero if WNOHANG
       was provided as an option (on wait3-available systems) and no child was available.

<comment>See Also:</comment>
   * <strong>pcntl_fork()</strong>
   * <strong>pcntl_signal()</strong>
   * <strong>pcntl_wifexited()</strong>
   * <strong>pcntl_wifstopped()</strong>
   * <strong>pcntl_wifsignaled()</strong>
   * <strong>pcntl_wexitstatus()</strong>
   * <strong>pcntl_wtermsig()</strong>
   * <strong>pcntl_wstopsig()</strong>
   * <strong>pcntl_waitpid()</strong>


id: pcntl_waitpid
type: function
doc:
<comment>Description:</comment>
  Waits on or returns the status of a forked child
  
  Suspends execution of the current process until a child as specified by the <strong>$process_id</strong> argument
  has exited, or until a signal is delivered whose action is to terminate the current process or to
  call a signal handling function.
  
  If a child as requested by <strong>$process_id</strong> has already exited by the time of the call (a so-called
  "zombie" process), the function returns immediately.  Any system resources used by the child are
  freed. Please see your system's waitpid(2) man page for specific details as to how waitpid works
  on your system.

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>  The value of <strong>$process_id</strong> can be one of the following: possible values for
                    <strong>$process_id</strong><return>\< -1</return> wait for any child process whose process group ID is equal to
                    the absolute value of <strong>$process_id</strong>. <return>-1</return> wait for any child process; this is the
                    same behaviour that the wait function exhibits. <return>0</return> wait for any child process
                    whose process group ID is equal to that of the calling process. <return>&gt; 0</return> wait for
                    the child whose process ID is equal to the value of <strong>$process_id</strong>.
                    
                    Specifying <return>-1</return> as the <strong>$process_id</strong> is equivalent to the functionality <strong>pcntl_wait()</strong>
                    provides (minus <strong>$flags</strong>).
  <info>int</info>  <strong>$status</strong>      <strong>pcntl_waitpid()</strong> will store status information in the <strong>$status</strong> parameter which can
                    be evaluated using the following functions: <strong>pcntl_wifexited()</strong>,
                    <strong>pcntl_wifstopped()</strong>, <strong>pcntl_wifsignaled()</strong>, <strong>pcntl_wexitstatus()</strong>, <strong>pcntl_wtermsig()</strong>
                    and <strong>pcntl_wstopsig()</strong>.
  <info>int</info>  <strong>$flags</strong>       The value of <strong>$flags</strong> is the value of zero or more of the following two global
                    constants <return>OR</return>'ed together: possible values for <strong>$flags</strong><return>WNOHANG</return> return immediately
                    if no child has exited. <return>WUNTRACED</return> return for children which are stopped, and
                    whose status has not been reported.

<comment>Return:</comment>
  <info>int</info>  <strong>pcntl_waitpid()</strong> returns the process ID of the child which exited, -1 on error or zero if
       <info>WNOHANG</info> was used and no child was available

<comment>See Also:</comment>
   * <strong>pcntl_fork()</strong>
   * <strong>pcntl_signal()</strong>
   * <strong>pcntl_wifexited()</strong>
   * <strong>pcntl_wifstopped()</strong>
   * <strong>pcntl_wifsignaled()</strong>
   * <strong>pcntl_wexitstatus()</strong>
   * <strong>pcntl_wtermsig()</strong>
   * <strong>pcntl_wstopsig()</strong>


id: pcntl_wexitstatus
type: function
doc:
<comment>Description:</comment>
  Returns the return code of a terminated child
  
  Returns the return code of a terminated child.  This function is only useful if <strong>pcntl_wifexited()</strong>
  returned <info>true</info>.

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>  O parâmetro <strong>$status</strong>
                é o parâmetro de status fornecido a uma chamada
                bem sucedida a <strong>pcntl_waitpid()</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Returns the return code. If the functionality is not supported by the OS, <info>false</info> is
             returned.

<comment>See Also:</comment>
   * <strong>pcntl_waitpid()</strong>
   * <strong>pcntl_wifexited()</strong>


id: pcntl_wifexited
type: function
doc:
<comment>Description:</comment>
  Checks if status code represents a normal exit
  
  Checks whether the child status code represents a normal exit.

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>  O parâmetro <strong>$status</strong>
                é o parâmetro de status fornecido a uma chamada
                bem sucedida a <strong>pcntl_waitpid()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the child status code represents a normal exit, <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>pcntl_waitpid()</strong>
   * <strong>pcntl_wexitstatus()</strong>


id: pcntl_wifsignaled
type: function
doc:
<comment>Description:</comment>
  Checks whether the status code represents a termination due to a signal
  
  Checks whether the child process exited because of a signal which was not caught.

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>  O parâmetro <strong>$status</strong>
                é o parâmetro de status fornecido a uma chamada
                bem sucedida a <strong>pcntl_waitpid()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the child process exited because of a signal which was not caught, <info>false</info>
        otherwise.

<comment>See Also:</comment>
   * <strong>pcntl_waitpid()</strong>
   * <strong>pcntl_signal()</strong>


id: pcntl_wifstopped
type: function
doc:
<comment>Description:</comment>
  Checks whether the child process is currently stopped
  
  Checks whether the child process which caused the return is currently stopped; this is only
  possible if the call to <strong>pcntl_waitpid()</strong> was done using the option <return>WUNTRACED</return>.

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>  O parâmetro <strong>$status</strong>
                é o parâmetro de status fornecido a uma chamada
                bem sucedida a <strong>pcntl_waitpid()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the child process which caused the return is currently stopped, <info>false</info>
        otherwise.

<comment>See Also:</comment>
   * <strong>pcntl_waitpid()</strong>


id: pcntl_wstopsig
type: function
doc:
<comment>Description:</comment>
  Returns the signal which caused the child to stop
  
  Returns the number of the signal which caused the child to stop. This function is only useful if
  <strong>pcntl_wifstopped()</strong> returned <info>true</info>.

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>  O parâmetro <strong>$status</strong>
                é o parâmetro de status fornecido a uma chamada
                bem sucedida a <strong>pcntl_waitpid()</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Returns the signal number. If the functionality is not supported by the OS, <info>false</info> is
             returned.

<comment>See Also:</comment>
   * <strong>pcntl_waitpid()</strong>
   * <strong>pcntl_wifstopped()</strong>


id: pcntl_wtermsig
type: function
doc:
<comment>Description:</comment>
  Returns the signal which caused the child to terminate
  
  Returns the number of the signal that caused the child process to terminate. This function is only
  useful if <strong>pcntl_wifsignaled()</strong> returned <info>true</info>.

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>  O parâmetro <strong>$status</strong>
                é o parâmetro de status fornecido a uma chamada
                bem sucedida a <strong>pcntl_waitpid()</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Returns the signal number. If the functionality is not supported by the OS, <info>false</info> is
             returned.

<comment>See Also:</comment>
   * <strong>pcntl_waitpid()</strong>
   * <strong>pcntl_signal()</strong>
   * <strong>pcntl_wifsignaled()</strong>


id: pfsockopen
type: function
doc:
<comment>Description:</comment>
  Open persistent Internet or Unix domain socket connection
  
  This function behaves exactly as <strong>fsockopen()</strong> with the difference that the connection is not closed
  after the script finishes. It is the persistent version of <strong>fsockopen()</strong>.

<comment>Return:</comment>
  <info>resource|false</info>  <strong>pfsockopen()</strong> returns a file pointer which may be used together with the other file
                  functions (such as <strong>fgets()</strong>, <strong>fgetss()</strong>, <strong>fwrite()</strong>, <strong>fclose()</strong>, and <strong>feof()</strong>), ou <info>false</info> em
                  caso de falha.

<comment>See Also:</comment>
   * <strong>fsockopen()</strong>


id: pg_affected_rows
type: function
doc:
<comment>Description:</comment>
  Returns number of affected records (tuples)
  
  <strong>pg_affected_rows()</strong> returns the number of tuples (instances/records/rows) affected by <return>INSERT</return>,
  <return>UPDATE</return>, and <return>DELETE</return> queries.
  
  Since PostgreSQL 9.0 and above, the server returns the number of  SELECTed rows. Older PostgreSQL
  return 0 for SELECT.
  
  This function used to be called <strong>pg_cmdtuples()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).

<comment>Return:</comment>
  <info>int</info>  The number of rows affected by the query. If no tuple is affected, it will return <return>0</return>.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_query_params()</strong>
   * <strong>pg_execute()</strong>
   * <strong>pg_num_rows()</strong>


id: pg_cancel_query
type: function
doc:
<comment>Description:</comment>
  Cancel an asynchronous query
    
  
  <strong>pg_cancel_query()</strong> cancels an asynchronous query sent with  <strong>pg_send_query()</strong>, <strong>pg_send_query_params()</strong>
  or <strong>pg_send_execute()</strong>. You cannot cancel a query executed using  <strong>pg_query()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_send_query()</strong>
   * <strong>pg_connection_busy()</strong>


id: pg_client_encoding
type: function
doc:
<comment>Description:</comment>
  Gets the client encoding
    
  
  PostgreSQL supports automatic character set conversion between  server and client for certain
  character sets. <strong>pg_client_encoding()</strong> returns the client encoding as a string. The returned string
  will be one of the standard PostgreSQL encoding identifiers.
  
  This function requires PostgreSQL 7.0 or higher. If libpq is compiled without multibyte encoding
  support, <strong>pg_client_encoding()</strong> always returns <return>SQL_ASCII</return>. Supported encoding depends on PostgreSQL
  version.  Refer to the PostgreSQL Documentation supported encodings.
  
  The function used to be called <strong>pg_clientencoding()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                      Quando o parâmetro <strong>$connection</strong> for <info>null</info>, a conexão padrão será
                                      usada.
                                      A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                      ou <strong>pg_pconnect()</strong>.
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.
                                      
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.

<comment>Return:</comment>
  <info>string</info>  The client encoding.

<comment>See Also:</comment>
   * <strong>pg_set_client_encoding()</strong>


id: pg_close
type: function
doc:
<comment>Description:</comment>
  Closes a PostgreSQL connection
  
  <strong>pg_close()</strong> closes the non-persistent connection to a PostgreSQL database associated with the given
  <strong>$connection</strong> instance.
  
  Using <strong>pg_close()</strong> is not usually necessary, as non-persistent open connections are automatically
  closed at the end of the script.
  
  If there is open <class>PgSql\Lob</class> instance on the connection, do not close the connection before closing
  all <class>PgSql\Lob</class> instances.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                      Quando o parâmetro <strong>$connection</strong> for <info>null</info>, a conexão padrão será
                                      usada.
                                      A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                      ou <strong>pg_pconnect()</strong>.
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.
                                      
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.

<comment>Return:</comment>
  <info>true</info>  Sempre retorna <info>true</info>.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>


id: pg_connect
type: function
doc:
<comment>Description:</comment>
  Open a PostgreSQL connection
  
  <strong>pg_connect()</strong> opens a connection to a PostgreSQL database specified by the <strong>$connection_string</strong>.
  
  If a second call is made to <strong>pg_connect()</strong> with the same <strong>$connection_string</strong> as an existing
  connection, the existing connection will be returned unless you pass <info>PGSQL_CONNECT_FORCE_NEW</info> as
  <strong>$flags</strong>.
  
  The old syntax with multiple parameters $conn = pg_connect("host", "port", "options", "tty",
  "dbname")  has been deprecated.

<comment>Param:</comment>
  <info>string</info>  <strong>$connection_string</strong>  The <strong>$connection_string</strong> can be empty to use all default parameters, or
                              it  can contain one or more parameter settings separated by
                              whitespace.  Each parameter setting is in the form <return>keyword = value</return>.
                              Spaces around  the equal sign are optional. To write an empty value or
                              a value  containing spaces, surround it with single quotes, e.g.,
                              <return>keyword =  'a value'</return>. Single quotes and backslashes within the value
                              must be  escaped with a backslash, i.e., \' and \\.
                              
                              The currently recognized parameter keywords are: <strong>$host</strong>, <strong>$hostaddr</strong>,
                              <strong>$port</strong>, <strong>$dbname</strong> (defaults to value of <strong>$user</strong>), <strong>$user</strong>, <strong>$password</strong>,
                              <strong>$connect_timeout</strong>, <strong>$options</strong>, <strong>$tty</strong> (ignored), <strong>$sslmode</strong>, <strong>$requiressl</strong>
                              (deprecated in favor of <strong>$sslmode</strong>), and <strong>$service</strong>.  Which of these
                              arguments exist depends on your PostgreSQL version.
                              
                              The <strong>$options</strong> parameter can be used to set command line parameters  to
                              be invoked by the server.
  <info>int</info>     <strong>$flags</strong>              If <info>PGSQL_CONNECT_FORCE_NEW</info> is passed, then a new connection is
                              created, even if the <strong>$connection_string</strong> is identical to an existing
                              connection.
                              
                              If <info>PGSQL_CONNECT_ASYNC</info> is given, then the connection is established
                              asynchronously. The state of the connection can then be checked via
                              <strong>pg_connect_poll()</strong> or <strong>pg_connection_status()</strong>.

<comment>Return:</comment>
  <info>PgSql\Connection|false</info>  Returns an <class>PgSql\Connection</class> instance on success,  ou <info>false</info> em caso de
                          falha.

<comment>See Also:</comment>
   * <strong>pg_pconnect()</strong>
   * <strong>pg_close()</strong>
   * <strong>pg_host()</strong>
   * <strong>pg_port()</strong>
   * <strong>pg_tty()</strong>
   * <strong>pg_options()</strong>
   * <strong>pg_dbname()</strong>


id: pg_connect_poll
type: function
doc:
<comment>Description:</comment>
  Poll the status of an in-progress asynchronous PostgreSQL connection
     attempt
    
  
  <strong>pg_connect_poll()</strong> polls the status of a PostgreSQL connection created by calling <strong>pg_connect()</strong> with
  the <info>PGSQL_CONNECT_ASYNC</info> option.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>int</info>  Returns <info>PGSQL_POLLING_FAILED</info>, <info>PGSQL_POLLING_READING</info>, <info>PGSQL_POLLING_WRITING</info>, <info>PGSQL_POLLING_OK</info>,
       or <info>PGSQL_POLLING_ACTIVE</info>.


id: pg_connection_busy
type: function
doc:
<comment>Description:</comment>
  Get connection is busy or not
    
  
  <strong>pg_connection_busy()</strong> determines whether or not a connection is busy.  If it is busy, a previous
  query is still executing. If <strong>pg_get_result()</strong> is used on the connection, it will be blocked.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the connection is busy, <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>pg_connection_status()</strong>
   * <strong>pg_get_result()</strong>


id: pg_connection_reset
type: function
doc:
<comment>Description:</comment>
  Reset connection (reconnect)
    
  
  <strong>pg_connection_reset()</strong> resets the connection. It is useful for error recovery.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * <strong>pg_pconnect()</strong>
   * <strong>pg_connection_status()</strong>


id: pg_connection_status
type: function
doc:
<comment>Description:</comment>
  Get connection status
    
  
  <strong>pg_connection_status()</strong> returns the status of the specified <strong>$connection</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>int</info>  <info>PGSQL_CONNECTION_OK</info> or  <info>PGSQL_CONNECTION_BAD</info>.

<comment>See Also:</comment>
   * <strong>pg_connection_busy()</strong>


id: pg_consume_input
type: function
doc:
<comment>Description:</comment>
  Reads input on the connection
  
  <strong>pg_consume_input()</strong> consumes any input waiting to be read from the database server.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if no error occurred, or <info>false</info> if there was an error. Note that <info>true</info> does not
        necessarily indicate that input was waiting to be read.


id: pg_convert
type: function
doc:
<comment>Description:</comment>
  Convert associative array values into forms suitable for SQL statements
    
  
  <strong>pg_convert()</strong> checks and converts the values in <strong>$values</strong> into suitable values for use in an SQL
  statement. Precondition for <strong>pg_convert()</strong> is the  existence of a table <strong>$table_name</strong> which has at
  least as many columns as <strong>$values</strong> has elements. The fieldnames in <strong>$table_name</strong> must match the
  indices in <strong>$values</strong> and the corresponding datatypes must be compatible. Returns an array with the
  converted values on success, <info>false</info> otherwise.
  
  Boolean values are accepted and converted to PostgreSQL booleans. String representations of
  boolean values are also supported. <info>null</info> is converted to PostgreSQL NULL.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  Name of the table against which to convert types.
  <info>array</info>             <strong>$values</strong>      Data to be converted.
  <info>int</info>               <strong>$flags</strong>       Any number of <info>PGSQL_CONV_IGNORE_DEFAULT</info>, <info>PGSQL_CONV_FORCE_NULL</info> or
                                 <info>PGSQL_CONV_IGNORE_NOT_NULL</info>, combined.

<comment>Return:</comment>
  <info>array|false</info>  An <info>array</info> of converted values,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_meta_data()</strong>
   * <strong>pg_insert()</strong>
   * <strong>pg_select()</strong>
   * <strong>pg_update()</strong>
   * <strong>pg_delete()</strong>


id: pg_copy_from
type: function
doc:
<comment>Description:</comment>
  Insert records into a table from an array
    
  
  <strong>pg_copy_from()</strong> inserts records into a table from  <strong>$rows</strong>. It issues a <return>COPY FROM</return> SQL command
  internally to insert records.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  Name of the table into which to copy the <strong>$rows</strong>.
  <info>array</info>             <strong>$rows</strong>        An <info>array</info> of data to be copied into <strong>$table_name</strong>. Each value in <strong>$rows</strong>
                                 becomes a row in <strong>$table_name</strong>. Each value in <strong>$rows</strong> should be a
                                 delimited string of the values to insert into each field.  Values
                                 should be linefeed terminated.
  <info>string</info>            <strong>$separator</strong>   The token that separates values for each field in each element of
                                 <strong>$rows</strong>.  Default is <return>\t</return>.
  <info>string</info>            <strong>$null_as</strong>     How SQL <return>NULL</return> values are represented in the <strong>$rows</strong>.  Default is <return>\\N</return>
                                 (<return>"\\\\N"</return>).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_copy_to()</strong>


id: pg_copy_to
type: function
doc:
<comment>Description:</comment>
  Copy a table to an array
    
  
  <strong>pg_copy_to()</strong> copies a table to an array. It issues <return>COPY TO</return> SQL command internally to retrieve
  records.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  Name of the table from which to copy the data into <strong>$rows</strong>.
  <info>string</info>            <strong>$separator</strong>   The token that separates values for each field in each element of
                                 <strong>$rows</strong>.  Default is <return>\t</return>.
  <info>string</info>            <strong>$null_as</strong>     How SQL <return>NULL</return> values are represented in the <strong>$rows</strong>.  Default is <return>\\N</return>
                                 (<return>"\\\\N"</return>).

<comment>Return:</comment>
  <info>array|false</info>  An <info>array</info> with one element for each line of <return>COPY</return> data,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_copy_from()</strong>


id: pg_dbname
type: function
doc:
<comment>Description:</comment>
  Get the database name
  
  <strong>pg_dbname()</strong> returns the name of the database that the given PostgreSQL <strong>$connection</strong> instance.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                      Quando o parâmetro <strong>$connection</strong> for <info>null</info>, a conexão padrão será
                                      usada.
                                      A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                      ou <strong>pg_pconnect()</strong>.
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.
                                      
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> containing the name of the database the  <strong>$connection</strong> is to.


id: pg_delete
type: function
doc:
<comment>Description:</comment>
  Deletes records
    
  
  <strong>pg_delete()</strong> deletes records from a table specified by the keys and values in <strong>$conditions</strong>.
  
  If <strong>$flags</strong> is specified, <strong>pg_convert()</strong> is applied to <strong>$conditions</strong> with the specified flags.
  
  By default <strong>pg_delete()</strong> passes raw values. Values must be escaped or the <info>PGSQL_DML_ESCAPE</info> flag must
  be specified in <strong>$flags</strong>. <info>PGSQL_DML_ESCAPE</info> quotes and escapes parameters/identifiers. Therefore,
  table/column names become case sensitive.
  
  Note that neither escape nor prepared query can protect LIKE query, JSON, Array, Regex, etc. These
  parameters should be handled according to their contexts. i.e. Escape/validate values.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  Name of the table from which to delete rows.
  <info>array</info>             <strong>$conditions</strong>  An <info>array</info> whose keys are field names in the table <strong>$table_name</strong>, and
                                 whose values are the values of those fields that are to be deleted.
  <info>int</info>               <strong>$flags</strong>       Any number of <info>PGSQL_CONV_FORCE_NULL</info>, <info>PGSQL_DML_NO_CONV</info>,
                                 <info>PGSQL_DML_ESCAPE</info>, <info>PGSQL_DML_EXEC</info>, <info>PGSQL_DML_ASYNC</info> or
                                 <info>PGSQL_DML_STRING</info> combined. If <info>PGSQL_DML_STRING</info> is part of the
                                 <strong>$flags</strong> then query string is returned. When <info>PGSQL_DML_NO_CONV</info> or
                                 <info>PGSQL_DML_ESCAPE</info> is set, it does not call <strong>pg_convert()</strong> internally.

<comment>Return:</comment>
  <info>string|bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.  Returns <info>string</info> if
               <info>PGSQL_DML_STRING</info> is passed via <strong>$flags</strong>.

<comment>See Also:</comment>
   * <strong>pg_convert()</strong>


id: pg_end_copy
type: function
doc:
<comment>Description:</comment>
  Sync with PostgreSQL backend
  
  <strong>pg_end_copy()</strong> syncs the PostgreSQL frontend (usually a web server process) with the PostgreSQL
  server after doing a copy operation performed by <strong>pg_put_line()</strong>. <strong>pg_end_copy()</strong> must be issued,
  otherwise the PostgreSQL server may get out of sync with the frontend and will report an error.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                      Quando o parâmetro <strong>$connection</strong> for <info>null</info>, a conexão padrão será
                                      usada.
                                      A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                      ou <strong>pg_pconnect()</strong>.
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.
                                      
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_put_line()</strong>


id: pg_escape_bytea
type: function
doc:
<comment>Description:</comment>
  Escape a string for insertion into a bytea field
    
  
  <strong>pg_escape_bytea()</strong> escapes string for bytea datatype.  It returns escaped string.
  
  When you <return>SELECT</return> a bytea type, PostgreSQL returns octal byte values prefixed with '\' (e.g. \032).
  Users are supposed to convert back to binary format manually.
  
  This function requires PostgreSQL 7.2 or later. With PostgreSQL 7.2.0 and 7.2.1, bytea values must
  be cast when you enable multi-byte support. i.e. <return>INSERT INTO test_table (image) VALUES
  ('$image_escaped'::bytea);</return> PostgreSQL 7.2.2 or later does not need a cast. The exception is when
  the client and backend character encoding does not match, and there may be multi-byte stream
  error. User must then cast to bytea to avoid this error.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>string</info>            <strong>$data</strong>        A <info>string</info> containing text or binary data to be inserted into a bytea
                                 column.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> containing the escaped data.

<comment>See Also:</comment>
   * <strong>pg_unescape_bytea()</strong>
   * <strong>pg_escape_string()</strong>


id: pg_escape_identifier
type: function
doc:
<comment>Description:</comment>
  Escape a identifier for insertion into a text field
    
  
  <strong>pg_escape_identifier()</strong> escapes a identifier (e.g. table, field names) for querying the database.
  It returns an escaped identifier string for PostgreSQL server. <strong>pg_escape_identifier()</strong> adds double
  quotes before and after data. Users should not add double quotes. Use of this function is
  recommended for identifier parameters in query. For SQL literals (i.e. parameters except bytea),
  <strong>pg_escape_literal()</strong> or <strong>pg_escape_string()</strong> must be used. For bytea type fields, <strong>pg_escape_bytea()</strong>
  must be used instead.
  
  This function has internal escape code and can also be used with PostgreSQL 8.4 or less.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>string</info>            <strong>$data</strong>        A <info>string</info> containing text to be escaped.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> containing the escaped data.

<comment>See Also:</comment>
   * <strong>pg_escape_literal()</strong>
   * <strong>pg_escape_bytea()</strong>
   * <strong>pg_escape_string()</strong>


id: pg_escape_literal
type: function
doc:
<comment>Description:</comment>
  Escape a literal for insertion into a text field
    
  
  <strong>pg_escape_literal()</strong> escapes a literal for querying the PostgreSQL database. It returns an escaped
  literal in the PostgreSQL format. <strong>pg_escape_literal()</strong> adds quotes before and after data. Users
  should not add quotes. Use of this function is recommended instead of <strong>pg_escape_string()</strong>.  If the
  type of the column is bytea, <strong>pg_escape_bytea()</strong> must be used instead. For escaping identifiers
  (e.g. table, field names), <strong>pg_escape_identifier()</strong> must be used.
  
  This function has internal escape code and can also be used with PostgreSQL 8.4 or less.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>string</info>            <strong>$data</strong>        A <info>string</info> containing text to be escaped.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> containing the escaped data.

<comment>See Also:</comment>
   * <strong>pg_escape_identifier()</strong>
   * <strong>pg_escape_bytea()</strong>
   * <strong>pg_escape_string()</strong>


id: pg_escape_string
type: function
doc:
<comment>Description:</comment>
  Escape a string for query
    
  
  <strong>pg_escape_string()</strong> escapes a string for querying the database.  It returns an escaped string in
  the PostgreSQL format without quotes. <strong>pg_escape_literal()</strong> is more preferred way to escape SQL
  parameters for PostgreSQL. <strong>addslashes()</strong> must not be used with PostgreSQL. If the type of the
  column is bytea, <strong>pg_escape_bytea()</strong> must be used instead. <strong>pg_escape_identifier()</strong> must be used to
  escape identifiers (e.g. table names, field names)
  
  This function requires PostgreSQL 7.2 or later.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>string</info>            <strong>$data</strong>        A <info>string</info> containing text to be escaped.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> containing the escaped data.

<comment>See Also:</comment>
   * <strong>pg_escape_bytea()</strong>


id: pg_execute
type: function
doc:
<comment>Description:</comment>
  Sends a request to execute a prepared statement with given parameters, and waits for the result
  
  Sends a request to execute a prepared statement with given parameters, and  waits for the result.
  
  <strong>pg_execute()</strong> is like <strong>pg_query_params()</strong>,  but the command to be executed is  specified by naming a
  previously-prepared statement, instead of giving a  query string. This feature allows commands
  that will be used repeatedly to  be parsed and planned just once, rather than each time they are
  executed.  The statement must have been prepared previously in the current session.  <strong>pg_execute()</strong>
  is supported only against PostgreSQL 7.4 or higher connections; it will fail when using earlier
  versions.
  
  The parameters are identical to <strong>pg_query_params()</strong>, except that the name of a  prepared statement
  is given instead of a query string.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>string</info>            <strong>$stmtname</strong>    The name of the prepared statement to execute.  if "" is specified,
                                 then the unnamed statement is executed.  The name must have been
                                 previously prepared using <strong>pg_prepare()</strong>,  <strong>pg_send_prepare()</strong> or a
                                 <return>PREPARE</return> SQL command.
  <info>array</info>             <strong>$params</strong>      An array of parameter values to substitute for the $1, $2, etc.
                                 placeholders in the original prepared query string.  The number of
                                 elements in the array must match the number of placeholders.
                                 
                                 Elements are converted to strings by calling this function.

<comment>Return:</comment>
  <info>PgSql\Result|false</info>  An <class>PgSql\Result</class> instance on success,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_prepare()</strong>
   * <strong>pg_send_prepare()</strong>
   * <strong>pg_query_params()</strong>


id: pg_fetch_all
type: function
doc:
<comment>Description:</comment>
  Fetches all rows from a result as an array
  
  <strong>pg_fetch_all()</strong> returns an array that contains all rows (records) in the <class>PgSql\Result</class> instance.
  
  Esta função define campos NULL como o
  valor <info>null</info> do PHP.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int</info>           <strong>$mode</strong>    Um parâmetro opcional que controla como o <info>array</info> retornado será indexado.
                         <strong>$mode</strong> é uma constante e pode assumir os seguintes valores:
                         <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info> e <info>PGSQL_BOTH</info>.
                         Usando <info>PGSQL_NUM</info>, a função retornará um array com índices numéricos,
                         usando <info>PGSQL_ASSOC</info> ela retornará apenas índices associativos
                         enquanto <info>PGSQL_BOTH</info> retornará índices numéricos e associativos.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> with all rows in the result.  Each row is an array of field values indexed by
         field name.

<comment>See Also:</comment>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_fetch_all_columns
type: function
doc:
<comment>Description:</comment>
  Fetches all rows in a particular result column as an array
  
  <strong>pg_fetch_all_columns()</strong> returns an array that contains all rows (records) in a particular column of
  the <class>PgSql\Result</class> instance.
  
  Esta função define campos NULL como o
  valor <info>null</info> do PHP.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int</info>           <strong>$field</strong>   Column number. Defaults to the first column if not specified.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> with all values in the result column.

<comment>See Also:</comment>
   * <strong>pg_fetch_all()</strong>


id: pg_fetch_array
type: function
doc:
<comment>Description:</comment>
  Fetch a row as an array
  
  <strong>pg_fetch_array()</strong> returns an array that corresponds to the fetched row (record).
  
  <strong>pg_fetch_array()</strong> is an extended version of <strong>pg_fetch_row()</strong>.  In addition to storing the data in the
  numeric indices (field number) to the result array, it can also store the data using associative
  indices (field name). It stores both indices by default.
  
  Esta função define campos NULL como o
  valor <info>null</info> do PHP.
  
  <strong>pg_fetch_array()</strong> is NOT significantly slower than using <strong>pg_fetch_row()</strong>, and is significantly
  easier to use.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int|null</info>      <strong>$row</strong>     Row number in result to fetch. Rows are numbered from 0 upwards. If omitted
                         or <info>null</info>, the next row is fetched.
  <info>int</info>           <strong>$mode</strong>    Um parâmetro opcional que controla como o <info>array</info> retornado será indexado.
                         <strong>$mode</strong> é uma constante e pode assumir os seguintes valores:
                         <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info> e <info>PGSQL_BOTH</info>.
                         Usando <info>PGSQL_NUM</info>, a função retornará um array com índices numéricos,
                         usando <info>PGSQL_ASSOC</info> ela retornará apenas índices associativos
                         enquanto <info>PGSQL_BOTH</info> retornará índices numéricos e associativos.

<comment>Return:</comment>
  <info>array|false</info>  An <info>array</info> indexed numerically (beginning with 0) or associatively (indexed by field
               name), or both. Each value in the <info>array</info> is represented as a  <info>string</info>.  Database <return>NULL</return>
               values are returned as <info>null</info>.
               
               <info>false</info> is returned if <strong>$row</strong> exceeds the number of rows in the set, there are no more
               rows, or on any other error. Fetching from the result of a query other than SELECT
               will also return <info>false</info>.

<comment>See Also:</comment>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_fetch_assoc
type: function
doc:
<comment>Description:</comment>
  Fetch a row as an associative array
  
  <strong>pg_fetch_assoc()</strong> returns an associative array that corresponds to the fetched row (records).
  
  <strong>pg_fetch_assoc()</strong> is equivalent to calling <strong>pg_fetch_array()</strong> with <info>PGSQL_ASSOC</info> as the optional third
  parameter. It only returns an associative array. If you need the numeric indices, use
  <strong>pg_fetch_row()</strong>.
  
  Esta função define campos NULL como o
  valor <info>null</info> do PHP.
  
  <strong>pg_fetch_assoc()</strong> is NOT significantly slower than using <strong>pg_fetch_row()</strong>, and is significantly
  easier to use.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int|null</info>      <strong>$row</strong>     Row number in result to fetch. Rows are numbered from 0 upwards. If omitted
                         or <info>null</info>, the next row is fetched.

<comment>Return:</comment>
  <info>array|false</info>  An <info>array</info> indexed associatively (by field name). Each value in the <info>array</info> is
               represented as a  <info>string</info>.  Database <return>NULL</return> values are returned as <info>null</info>.
               
               <info>false</info> is returned if <strong>$row</strong> exceeds the number of rows in the set, there are no more
               rows, or on any other error.

<comment>See Also:</comment>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_fetch_object
type: function
doc:
<comment>Description:</comment>
  Fetch a row as an object
  
  <strong>pg_fetch_object()</strong> returns an object with properties that correspond to the fetched row's field
  names.  It can optionally instantiate an object of a specific class, and pass parameters to that
  class's constructor.
  
  Esta função define campos NULL como o
  valor <info>null</info> do PHP.
  
  Speed-wise, the function is identical to <strong>pg_fetch_array()</strong>, and almost as fast as <strong>pg_fetch_row()</strong>
  (the difference is insignificant).

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>            Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                                   <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int|null</info>      <strong>$row</strong>               Row number in result to fetch. Rows are numbered from 0 upwards.
                                   If omitted or <info>null</info>, the next row is fetched.
  <info>string</info>        <strong>$class</strong>             The name of the class to instantiate, set the properties of and
                                   return. If not specified, a <class>stdClass</class> object is returned.
  <info>array</info>         <strong>$constructor_args</strong>  An optional <info>array</info> of parameters to pass to the constructor for
                                   <strong>$class</strong> objects.

<comment>Return:</comment>
  <info>object|false</info>  An <info>object</info> with one attribute for each field name in the result.  Database <return>NULL</return>
                values are returned as <info>null</info>.
                
                <info>false</info> is returned if <strong>$row</strong> exceeds the number of rows in the set, there are no more
                rows, or on any other error.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_assoc()</strong>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_fetch_result
type: function
doc:
<comment>Description:</comment>
  Returns values from a result instance
  
  <strong>pg_fetch_result()</strong> returns the value of a particular row and field (column) in an <class>PgSql\Result</class>
  instance.
  
  This function used to be called <strong>pg_result()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int</info>           <strong>$row</strong>     Row number in result to fetch.  Rows are numbered from 0 upwards.  If
                         omitted, next row is fetched.
  <info>mixed</info>         <strong>$field</strong>   A <info>string</info> representing the name of the field (column) to fetch, otherwise an
                         <info>int</info> representing the field number to fetch.  Fields are numbered from 0
                         upwards.

<comment>Return:</comment>
  <info>string|false|null</info>  Boolean is returned as "t" or "f".  All other types, including arrays are
                     returned as strings formatted in the same default PostgreSQL manner that you
                     would see in the psql program.  Database <return>NULL</return> values are returned as <info>null</info>.
                     
                     <info>false</info> is returned if <strong>$row</strong> exceeds the number of rows in the set, or on any
                     other error.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_fetch_array()</strong>


id: pg_fetch_row
type: function
doc:
<comment>Description:</comment>
  Get a row as an enumerated array
  
  <strong>pg_fetch_row()</strong> fetches one row of data from the result associated with the specified <strong>$result</strong>
  instance.
  
  Esta função define campos NULL como o
  valor <info>null</info> do PHP.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int|null</info>      <strong>$row</strong>     Row number in result to fetch. Rows are numbered from 0 upwards. If omitted
                         or <info>null</info>, the next row is fetched.
  <info>int</info>           <strong>$mode</strong>    Um parâmetro opcional que controla como o <info>array</info> retornado será indexado.
                         <strong>$mode</strong> é uma constante e pode assumir os seguintes valores:
                         <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info> e <info>PGSQL_BOTH</info>.
                         Usando <info>PGSQL_NUM</info>, a função retornará um array com índices numéricos,
                         usando <info>PGSQL_ASSOC</info> ela retornará apenas índices associativos
                         enquanto <info>PGSQL_BOTH</info> retornará índices numéricos e associativos.

<comment>Return:</comment>
  <info>array|false</info>  An <info>array</info>, indexed from 0 upwards, with each value represented as a <info>string</info>.  Database
               <return>NULL</return> values are returned as <info>null</info>.
               
               <info>false</info> is returned if <strong>$row</strong> exceeds the number of rows in the set, there are no more
               rows, or on any other error.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_field_is_null
type: function
doc:
<comment>Description:</comment>
  Test if a field is SQL NULL
  
  <strong>pg_field_is_null()</strong> tests if a field in an <class>PgSql\Result</class> instance is SQL <return>NULL</return> or not.
  
  This function used to be called <strong>pg_fieldisnull()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int</info>           <strong>$row</strong>     Row number in result to fetch.  Rows are numbered from 0 upwards.  If
                         omitted, current row is fetched.
  <info>mixed</info>         <strong>$field</strong>   Field number (starting from 0) as an <info>int</info> or  the field name as a <info>string</info>.

<comment>Return:</comment>
  <info>int</info>  Returns <return>1</return> if the field in the given row is SQL <return>NULL</return>, <return>0</return> if not.  <info>false</info> is returned if the row
       is out of range, or upon any other error.


id: pg_field_name
type: function
doc:
<comment>Description:</comment>
  Returns the name of a field
  
  <strong>pg_field_name()</strong> returns the name of the field occupying the given <strong>$field</strong> in the given <strong>$result</strong>
  instance.  Field numbering starts from 0.
  
  This function used to be called <strong>pg_fieldname()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int</info>           <strong>$field</strong>   Field number, starting from 0.

<comment>Return:</comment>
  <info>string</info>  The field name.

<comment>See Also:</comment>
   * <strong>pg_field_num()</strong>


id: pg_field_num
type: function
doc:
<comment>Description:</comment>
  Returns the field number of the named field
  
  <strong>pg_field_num()</strong> will return the number of the field number that corresponds to the <strong>$field</strong> in the
  given <strong>$result</strong> instance.
  
  This function used to be called <strong>pg_fieldnum()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>string</info>        <strong>$field</strong>   The name of the field. The given name is treated like an identifier in an
                         SQL command, that is, it is downcased unless double-quoted.

<comment>Return:</comment>
  <info>int</info>  The field number (numbered from 0), or -1 on error.

<comment>See Also:</comment>
   * <strong>pg_field_name()</strong>


id: pg_field_prtlen
type: function
doc:
<comment>Description:</comment>
  Returns the printed length
  
  <strong>pg_field_prtlen()</strong> returns the actual printed length (number of characters) of a specific value in
  a PostgreSQL <strong>$result</strong>.  Row numbering starts at 0.  This function will return <info>false</info> on an error.
  
  <strong>$field_name_or_number</strong> can be passed either as an <info>int</info> or as a <info>string</info>. If it is passed as an <info>int</info>,
  PHP recognises it as the field number, otherwise as field name.
  
  See the example given at the <strong>pg_field_name()</strong> page.
  
  This function used to be called <strong>pg_fieldprtlen()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info></info>              <strong>$row</strong>     Row number in result.  Rows are numbered from 0 upwards.  If omitted,
                         current row is fetched.

<comment>Return:</comment>
  <info>int</info>  The field printed length.

<comment>See Also:</comment>
   * <strong>pg_field_size()</strong>


id: pg_field_size
type: function
doc:
<comment>Description:</comment>
  Returns the internal storage size of the named field
    
  
  <strong>pg_field_size()</strong> returns the internal storage size (in bytes) of the field number in the given
  PostgreSQL <strong>$result</strong>.
  
  This function used to be called <strong>pg_fieldsize()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int</info>           <strong>$field</strong>   Field number, starting from 0.

<comment>Return:</comment>
  <info>int</info>  The internal field storage size (in bytes).  -1 indicates a variable length field.

<comment>See Also:</comment>
   * <strong>pg_field_prtlen()</strong>
   * <strong>pg_field_type()</strong>


id: pg_field_table
type: function
doc:
<comment>Description:</comment>
  Returns the name or oid of the tables field
  
  <strong>pg_field_table()</strong> returns the name of the table that field  belongs to, or the table's oid if
  <strong>$oid_only</strong> is <info>true</info>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>    Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                           <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int</info>           <strong>$field</strong>     Field number, starting from 0.
  <info>bool</info>          <strong>$oid_only</strong>  By default the tables name that field belongs to is returned but if
                           <strong>$oid_only</strong> is set to <info>true</info>, then the oid will instead be returned.

<comment>Return:</comment>
  <info>string|int|false</info>  On success either the fields table name or oid,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_field_name()</strong>
   * <strong>pg_field_type()</strong>


id: pg_field_type
type: function
doc:
<comment>Description:</comment>
  Returns the type name for the corresponding field number
    
  
  <strong>pg_field_type()</strong> returns a string containing the base type name of the given <strong>$field</strong> in the given
  <strong>$result</strong> instance.
  
  If the field uses a PostgreSQL domain (rather than a basic type), it is the name of the domain's
  underlying type that is returned, rather than the  name of the domain itself.
  
  This function used to be called <strong>pg_fieldtype()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int</info>           <strong>$field</strong>   Field number, starting from 0.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> containing the base name of the field's type.

<comment>See Also:</comment>
   * <strong>pg_field_prtlen()</strong>
   * <strong>pg_field_name()</strong>
   * <strong>pg_field_type_oid()</strong>


id: pg_field_type_oid
type: function
doc:
<comment>Description:</comment>
  Returns the type ID (OID) for the corresponding field number
    
  
  <strong>pg_field_type_oid()</strong> returns an integer containing the OID of the base type of the given <strong>$field</strong> in
  the given <strong>$result</strong> instance.
  
  You can get more information about the field type by querying PostgreSQL's <return>pg_type</return> system table
  using the OID obtained with this function. The PostgreSQL <strong>format_type()</strong> function will convert a
  type OID into an SQL standard type name.
  
  If the field uses a PostgreSQL domain (rather than a basic type), it is the OID of the domain's
  underlying type that is returned, rather than the OID of the domain itself.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int</info>           <strong>$field</strong>   Field number, starting from 0.

<comment>Return:</comment>
  <info>string|int</info>  The OID of the field's base type.

<comment>See Also:</comment>
   * <strong>pg_field_type()</strong>
   * <strong>pg_field_prtlen()</strong>
   * <strong>pg_field_name()</strong>


id: pg_flush
type: function
doc:
<comment>Description:</comment>
  Flush outbound query data on the connection
  
  <strong>pg_flush()</strong> flushes any outbound query data waiting to be sent on the connection.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>int|bool</info>  Returns <info>true</info> if the flush was successful or no data was waiting to be flushed, <return>0</return> if part
            of the pending data was flushed but more remains ou <info>false</info> em caso de falha.


id: pg_free_result
type: function
doc:
<comment>Description:</comment>
  Free result memory
  
  <strong>pg_free_result()</strong> frees the memory and data associated with the specified <class>PgSql\Result</class> instance.
  
  This function need only be called if memory consumption during script execution is a problem.
  Otherwise, all result memory will  be automatically freed when the script ends.
  
  This function used to be called <strong>pg_freeresult()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_query_params()</strong>
   * <strong>pg_execute()</strong>


id: pg_get_notify
type: function
doc:
<comment>Description:</comment>
  Gets SQL NOTIFY message
  
  <strong>pg_get_notify()</strong> gets notifications generated by a <return>NOTIFY</return> SQL command. To receive notifications,
  the <return>LISTEN</return> SQL command must be issued.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
  <info>int</info>               <strong>$mode</strong>        Um parâmetro opcional que controla como o <info>array</info> retornado será
                                 indexado.
                                 <strong>$mode</strong> é uma constante e pode assumir os seguintes valores:
                                 <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info> e <info>PGSQL_BOTH</info>.
                                 Usando <info>PGSQL_NUM</info>, a função retornará um array com índices
                                 numéricos,
                                 usando <info>PGSQL_ASSOC</info> ela retornará apenas índices associativos
                                 enquanto <info>PGSQL_BOTH</info> retornará índices numéricos e associativos.

<comment>Return:</comment>
  <info>array|false</info>  An <info>array</info> containing the <return>NOTIFY</return> message name and backend PID. If supported by the
               server, the array also contains the server version and the payload. Otherwise if no
               <return>NOTIFY</return> is waiting, then <info>false</info> is returned.

<comment>See Also:</comment>
   * <strong>pg_get_pid()</strong>


id: pg_get_pid
type: function
doc:
<comment>Description:</comment>
  Gets the backend's process ID
  
  <strong>pg_get_pid()</strong> gets the backend's (database server process) PID. The PID is useful to determine
  whether or not a <return>NOTIFY</return> message received via <strong>pg_get_notify()</strong> is sent from another process or not.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>int</info>  The backend database process ID.

<comment>See Also:</comment>
   * <strong>pg_get_notify()</strong>


id: pg_get_result
type: function
doc:
<comment>Description:</comment>
  Get asynchronous query result
    
  
  <strong>pg_get_result()</strong> gets an <class>PgSql\Result</class> instance from an asynchronous query executed by
  <strong>pg_send_query()</strong>, <strong>pg_send_query_params()</strong> or <strong>pg_send_execute()</strong>.
  
  <strong>pg_send_query()</strong> and the other asynchronous query functions can send multiple queries to a
  PostgreSQL server and <strong>pg_get_result()</strong> is used to get each query's results, one by one.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>PgSql\Result|false</info>  An <class>PgSql\Result</class> instance, or <info>false</info> if no more results are available.

<comment>See Also:</comment>
   * <strong>pg_send_query()</strong>


id: pg_host
type: function
doc:
<comment>Description:</comment>
  Returns the host name associated with the connection
    
  
  <strong>pg_host()</strong> returns the host name of the given PostgreSQL <strong>$connection</strong> instance is connected to.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                      Quando o parâmetro <strong>$connection</strong> for <info>null</info>, a conexão padrão será
                                      usada.
                                      A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                      ou <strong>pg_pconnect()</strong>.
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.
                                      
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> containing the name of the host the <strong>$connection</strong> is to, or an empty string on
          error.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * <strong>pg_pconnect()</strong>


id: pg_insert
type: function
doc:
<comment>Description:</comment>
  Insert array into table
    
  
  <strong>pg_insert()</strong> inserts the values of <strong>$values</strong> into the table specified by <strong>$table_name</strong>.
  
  If <strong>$flags</strong> is specified, <strong>pg_convert()</strong> is applied to <strong>$values</strong> with the specified flags.
  
  By default <strong>pg_insert()</strong> passes raw values. Values must be escaped or the <info>PGSQL_DML_ESCAPE</info> flag must
  be specified in <strong>$flags</strong>. <info>PGSQL_DML_ESCAPE</info> quotes and escapes parameters/identifiers. Therefore,
  table/column names become case sensitive.
  
  Note that neither escape nor prepared query can protect LIKE query, JSON, Array, Regex, etc. These
  parameters should be handled according to their contexts. i.e. Escape/validate values.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  Name of the table into which to insert rows.  The table <strong>$table_name</strong>
                                 must at least have as many columns as <strong>$values</strong> has elements.
  <info>array</info>             <strong>$values</strong>      An <info>array</info> whose keys are field names in the table <strong>$table_name</strong>, and
                                 whose values are the values of those fields that are to be
                                 inserted.
  <info>int</info>               <strong>$flags</strong>       Any number of <info>PGSQL_CONV_OPTS</info>, <info>PGSQL_DML_NO_CONV</info>, <info>PGSQL_DML_ESCAPE</info>,
                                 <info>PGSQL_DML_EXEC</info>, <info>PGSQL_DML_ASYNC</info> or <info>PGSQL_DML_STRING</info> combined. If
                                 <info>PGSQL_DML_STRING</info> is part of the <strong>$flags</strong> then query string is
                                 returned. When <info>PGSQL_DML_NO_CONV</info> or <info>PGSQL_DML_ESCAPE</info> is set, it
                                 does not call <strong>pg_convert()</strong> internally.

<comment>Return:</comment>
  <info>PgSql\Result|string|bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.. Or returns a
                            <info>string</info> on success if <info>PGSQL_DML_STRING</info> is passed via <strong>$flags</strong>.

<comment>See Also:</comment>
   * <strong>pg_convert()</strong>


id: pg_last_error
type: function
doc:
<comment>Description:</comment>
  Get the last error message string of a connection
  
  <strong>pg_last_error()</strong> returns the last error message for a given <strong>$connection</strong>.
  
  Error messages may be overwritten by internal PostgreSQL (libpq) function calls. It may not return
  an appropriate error message if multiple errors occur inside a PostgreSQL module function.
  
  Use <strong>pg_result_error()</strong>, <strong>pg_result_error_field()</strong>, <strong>pg_result_status()</strong> and <strong>pg_connection_status()</strong> for
  better error handling.
  
  This function used to be called <strong>pg_errormessage()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                      Quando o parâmetro <strong>$connection</strong> for <info>null</info>, a conexão padrão será
                                      usada.
                                      A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                      ou <strong>pg_pconnect()</strong>.
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.
                                      
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> containing the last error message on the  given <strong>$connection</strong>.

<comment>See Also:</comment>
   * <strong>pg_result_error()</strong>
   * <strong>pg_result_error_field()</strong>


id: pg_last_notice
type: function
doc:
<comment>Description:</comment>
  Returns the last notice message from PostgreSQL server
    
  
  <strong>pg_last_notice()</strong> returns the last notice message from the PostgreSQL server on the specified
  <strong>$connection</strong>. The PostgreSQL server sends notice messages in several cases, for instance when
  creating a <return>SERIAL</return> column in a table.
  
  With <strong>pg_last_notice()</strong>, you can avoid issuing useless queries by checking whether or not the notice
  is related to your transaction.
  
  Notice message tracking can be set to optional by setting 1 for <return>pgsql.ignore_notice</return> in php.ini.
  
  Notice message logging can be set to optional by setting 0 for <return>pgsql.log_notice</return> in php.ini. Unless
  <return>pgsql.ignore_notice</return> is set to 0, notice message cannot be logged.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
  <info>int</info>               <strong>$mode</strong>        One of <info>PGSQL_NOTICE_LAST</info> (to return last notice), <info>PGSQL_NOTICE_ALL</info>
                                 (to return all notices), or <info>PGSQL_NOTICE_CLEAR</info> (to clear notices).

<comment>Return:</comment>
  <info>array|string|bool</info>  A <info>string</info> containing the last notice on the  given <strong>$connection</strong> with
                     <info>PGSQL_NOTICE_LAST</info>, an <info>array</info> with <info>PGSQL_NOTICE_ALL</info>, a <info>bool</info> with
                     <info>PGSQL_NOTICE_CLEAR</info>.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_last_error()</strong>


id: pg_last_oid
type: function
doc:
<comment>Description:</comment>
  Returns the last row's OID
  
  <strong>pg_last_oid()</strong> is used to retrieve the OID assigned to an inserted row.
  
  OID field became an optional field from PostgreSQL 7.2 and will not be present by default in
  PostgreSQL 8.1. When the OID field is not present in a table, the programmer must use
  <strong>pg_result_status()</strong> to check for successful insertion.
  
  To get the value of a <return>SERIAL</return> field in an inserted row, it is necessary to use the PostgreSQL
  <return>CURRVAL</return> function, naming the sequence whose last value is required.  If the name of the sequence
  is unknown, the <return>pg_get_serial_sequence</return> PostgreSQL 8.0 function is necessary.
  
  PostgreSQL 8.1 has a function <return>LASTVAL</return> that returns the value of the most recently used sequence in
  the session.  This avoids the need for naming the sequence, table or column altogether.
  
  This function used to be called <strong>pg_getlastoid()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).

<comment>Return:</comment>
  <info>string|int|false</info>  An <info>int</info> or <info>string</info> containing the OID assigned to the most recently inserted row
                    in the specified <strong>$connection</strong>, or <info>false</info> on error or no available OID.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_result_status()</strong>


id: pg_lo_close
type: function
doc:
<comment>Description:</comment>
  Close a large object
  
  <strong>pg_lo_close()</strong> closes a large object.
  
  To use the large object interface, it is necessary to enclose it within a transaction block.
  
  This function used to be called <strong>pg_loclose()</strong>.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>  Uma instância de <class>PgSql\Lob</class>, retornada por <strong>pg_lo_open()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_lo_open()</strong>
   * <strong>pg_lo_create()</strong>
   * <strong>pg_lo_import()</strong>


id: pg_lo_create
type: function
doc:
<comment>Description:</comment>
  Create a large object
  
  <strong>pg_lo_create()</strong> creates a large object and returns the OID of the large object.  PostgreSQL access
  modes <info>INV_READ</info>, <info>INV_WRITE</info>, and  <info>INV_ARCHIVE</info> are not supported, the object is created always with
  both read and write access. <info>INV_ARCHIVE</info> has been removed from PostgreSQL itself (version 6.3 and
  above).
  
  To use the large object interface, it is necessary to enclose it within a transaction block.
  
  Instead of using the large object interface (which has no access controls and is cumbersome to
  use), try PostgreSQL's bytea column type and <strong>pg_escape_bytea()</strong>.
  
  This function used to be called <strong>pg_locreate()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>mixed</info>             <strong>$object_id</strong>   If an <strong>$object_id</strong> is given the function will try to create a large
                                 object with this id, else a free object id is assigned by the
                                 server. The parameter relies on functionality that first appeared
                                 in PostgreSQL 8.1.

<comment>Return:</comment>
  <info>int</info>  A large object OID,  ou <info>false</info> em caso de falha.


id: pg_lo_export
type: function
doc:
<comment>Description:</comment>
  Export a large object to file
  
  <strong>pg_lo_export()</strong> takes a large object in a PostgreSQL database and saves its contents to a file on
  the local filesystem.
  
  To use the large object interface, it is necessary to enclose it within a transaction block.
  
  This function used to be called <strong>pg_loexport()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>int</info>               <strong>$oid</strong>         The OID of the large object in the database.
  <info>string</info>            <strong>$pathname</strong>    The full path and file name of the file in which to write the large
                                 object on the client filesystem.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_lo_import()</strong>


id: pg_lo_import
type: function
doc:
<comment>Description:</comment>
  Import a large object from file
  
  <strong>pg_lo_import()</strong> creates a new large object in the database using a file on the filesystem as its
  data source.
  
  To use the large object interface, it is necessary to enclose it within a transaction block.
  
  This function used to be called <strong>pg_loimport()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>string</info>            <strong>$pathname</strong>    The full path and file name of the file on the client filesystem
                                 from which to read the large object data.
  <info>mixed</info>             <strong>$object_id</strong>   If an <strong>$object_id</strong> is given the function will try to create a large
                                 object with this id, else a free object id is assigned by the
                                 server. The parameter relies on functionality that first appeared
                                 in PostgreSQL 8.1.

<comment>Return:</comment>
  <info>int</info>  The OID of the newly created large object,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_lo_export()</strong>
   * <strong>pg_lo_open()</strong>


id: pg_lo_open
type: function
doc:
<comment>Description:</comment>
  Open a large object
  
  <strong>pg_lo_open()</strong> opens a large object in the database and returns an <class>PgSql\Lob</class> instance so that it can
  be manipulated.
  
  Do not close the database connection before closing the <class>PgSql\Lob</class> instance.
  
  To use the large object interface, it is necessary to enclose it within a transaction block.
  
  This function used to be called <strong>pg_loopen()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>int</info>               <strong>$oid</strong>         The OID of the large object in the database.
  <info>string</info>            <strong>$mode</strong>        Can be either "r" for read-only, "w" for write only or "rw" for
                                 read and  write.

<comment>Return:</comment>
  <info>PgSql\Lob|false</info>  An <class>PgSql\Lob</class> instance,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_lo_close()</strong>
   * <strong>pg_lo_create()</strong>


id: pg_lo_read
type: function
doc:
<comment>Description:</comment>
  Read a large object
  
  <strong>pg_lo_read()</strong> reads at most <strong>$length</strong> bytes from a large object and returns it as a <info>string</info>.
  
  To use the large object interface, it is necessary to enclose it within a transaction block.
  
  This function used to be called <strong>pg_loread()</strong>.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>     Uma instância de <class>PgSql\Lob</class>, retornada por <strong>pg_lo_open()</strong>.
  <info>int</info>        <strong>$length</strong>  An optional maximum number of bytes to return.

<comment>Return:</comment>
  <info>string|false</info>  A <info>string</info> containing <strong>$length</strong> bytes from the large object, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>pg_lo_read_all()</strong>


id: pg_lo_read_all
type: function
doc:
<comment>Description:</comment>
  Reads an entire large object and send straight to browser
    
  
  <strong>pg_lo_read_all()</strong> reads a large object and passes it straight through to the browser after sending
  all pending headers. Mainly intended for sending binary data like images or sound.
  
  To use the large object interface, it is necessary to enclose it within a transaction block.
  
  This function used to be called <strong>pg_loreadall()</strong>.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>  Uma instância de <class>PgSql\Lob</class>, retornada por <strong>pg_lo_open()</strong>.

<comment>Return:</comment>
  <info>int</info>  Number of bytes read.

<comment>See Also:</comment>
   * <strong>pg_lo_read()</strong>


id: pg_lo_seek
type: function
doc:
<comment>Description:</comment>
  Seeks position within a large object
    
  
  <strong>pg_lo_seek()</strong> seeks a position within an <class>PgSql\Lob</class> instance.
  
  To use the large object interface, it is necessary to enclose it within a transaction block.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>     Uma instância de <class>PgSql\Lob</class>, retornada por <strong>pg_lo_open()</strong>.
  <info>int</info>        <strong>$offset</strong>  The number of bytes to seek.
  <info>int</info>        <strong>$whence</strong>  One of the constants <info>PGSQL_SEEK_SET</info> (seek from object start),  <info>PGSQL_SEEK_CUR</info>
                      (seek from current position) or <info>PGSQL_SEEK_END</info> (seek from object end) .

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_lo_tell()</strong>


id: pg_lo_tell
type: function
doc:
<comment>Description:</comment>
  Returns current seek position a of large object
    
  
  <strong>pg_lo_tell()</strong> returns the current position (offset from the beginning) of a large object.
  
  To use the large object interface, it is necessary to enclose it within a transaction block.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>  Uma instância de <class>PgSql\Lob</class>, retornada por <strong>pg_lo_open()</strong>.

<comment>Return:</comment>
  <info>int</info>  The current seek offset (in number of bytes) from the beginning of the large object.  If
       there is an error, the return value is negative.

<comment>See Also:</comment>
   * <strong>pg_lo_seek()</strong>


id: pg_lo_truncate
type: function
doc:
<comment>Description:</comment>
  Truncates a large object
    
  
  <strong>pg_lo_truncate()</strong> truncates an <class>PgSql\Lob</class> instance.
  
  To use the large object interface, it is necessary to enclose it within a transaction block.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>   Uma instância de <class>PgSql\Lob</class>, retornada por <strong>pg_lo_open()</strong>.
  <info>int</info>        <strong>$size</strong>  The number of bytes to truncate.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_lo_tell()</strong>


id: pg_lo_unlink
type: function
doc:
<comment>Description:</comment>
  Delete a large object
  
  <strong>pg_lo_unlink()</strong> deletes a large object with the <strong>$oid</strong>. Retorna <info>true</info> em caso de sucesso ou <info>false</info> em
  caso de falha.
  
  To use the large object interface, it is necessary to enclose it within a transaction block.
  
  This function used to be called <strong>pg_lounlink()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>int</info>               <strong>$oid</strong>         The OID of the large object in the database.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_lo_create()</strong>
   * <strong>pg_lo_import()</strong>


id: pg_lo_write
type: function
doc:
<comment>Description:</comment>
  Write to a large object
  
  <strong>pg_lo_write()</strong> writes data into a large object at the current seek position.
  
  To use the large object interface, it is necessary to enclose it within a transaction block.
  
  This function used to be called <strong>pg_lowrite()</strong>.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>     Uma instância de <class>PgSql\Lob</class>, retornada por <strong>pg_lo_open()</strong>.
  <info>string</info>     <strong>$data</strong>    The data to be written to the large object.  If <strong>$length</strong> is an <info>int</info> and is less
                      than the length of <strong>$data</strong>, only <strong>$length</strong> bytes will be written.
  <info>int|null</info>   <strong>$length</strong>  An optional maximum number of bytes to write.  Must be greater than zero and
                      no greater than the length of <strong>$data</strong>.  Defaults to the length of <strong>$data</strong>.

<comment>Return:</comment>
  <info>int|false</info>  The number of bytes written to the large object, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>pg_lo_create()</strong>
   * <strong>pg_lo_open()</strong>


id: pg_meta_data
type: function
doc:
<comment>Description:</comment>
  Get meta data for table
    
  
  <strong>pg_meta_data()</strong> returns table definition for <return>table_name</return> as an array.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  The name of the table.
  <info>bool</info>              <strong>$extended</strong>    Flag for returning extended meta data. Default to <info>false</info>.

<comment>Return:</comment>
  <info>array|false</info>  An <info>array</info> of the table definition,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_convert()</strong>


id: pg_num_fields
type: function
doc:
<comment>Description:</comment>
  Returns the number of fields in a result
  
  <strong>pg_num_fields()</strong> returns the number of fields (columns) in the <class>PgSql\Result</class> instance.
  
  This function used to be called <strong>pg_numfields()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).

<comment>Return:</comment>
  <info>int</info>  The number of fields (columns) in the result. On error, -1 is returned.

<comment>See Also:</comment>
   * <strong>pg_num_rows()</strong>
   * <strong>pg_affected_rows()</strong>


id: pg_num_rows
type: function
doc:
<comment>Description:</comment>
  Returns the number of rows in a result
  
  <strong>pg_num_rows()</strong> will return the number of rows in an <class>PgSql\Result</class> instance.
  
  This function used to be called <strong>pg_numrows()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).

<comment>Return:</comment>
  <info>int</info>  The number of rows in the result. On error, <return>-1</return> is returned.

<comment>See Also:</comment>
   * <strong>pg_num_fields()</strong>
   * <strong>pg_affected_rows()</strong>


id: pg_options
type: function
doc:
<comment>Description:</comment>
  Get the options associated with the connection
  
  <strong>pg_options()</strong> will return a string containing the options specified on the given PostgreSQL
  <strong>$connection</strong> instance.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                      Quando o parâmetro <strong>$connection</strong> for <info>null</info>, a conexão padrão será
                                      usada.
                                      A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                      ou <strong>pg_pconnect()</strong>.
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.
                                      
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> containing the <strong>$connection</strong> options.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>


id: pg_parameter_status
type: function
doc:
<comment>Description:</comment>
  Looks up a current parameter setting of the server
  
  Looks up a current parameter setting of the server.
  
  Certain parameter values are reported by the server automatically at  connection startup or
  whenever their values change. <strong>pg_parameter_status()</strong> can be  used to interrogate these settings. It
  returns the current value of a  parameter if known, or <info>false</info> if the parameter is not known.
  
  Parameters reported as of PostgreSQL 8.0 include <return>server_version</return>,  <return>server_encoding</return>,
  <return>client_encoding</return>,  <return>is_superuser</return>, <return>session_authorization</return>,  <return>DateStyle</return>, <return>TimeZone</return>, and
  <return>integer_datetimes</return>. (<return>server_encoding</return>, <return>TimeZone</return>, and  <return>integer_datetimes</return> were not reported by
  releases before 8.0.) Note that  <return>server_version</return>, <return>server_encoding</return> and <return>integer_datetimes</return>  cannot
  change after PostgreSQL startup.
  
  PostgreSQL 7.3 or lower servers do not report parameter settings, <strong>pg_parameter_status()</strong> includes
  logic to obtain values for <return>server_version</return> and  <return>client_encoding</return> anyway. Applications are encouraged
  to use <strong>pg_parameter_status()</strong> rather than ad  hoc code to determine these values.
  
  On a pre-7.4 PostgreSQL server, changing <return>client_encoding</return> via <return>SET</return> after connection startup will
  not be reflected by <strong>pg_parameter_status()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>string</info>            <strong>$param_name</strong>  Possible <strong>$param_name</strong> values include <return>server_version</return>,
                                 <return>server_encoding</return>, <return>client_encoding</return>,  <return>is_superuser</return>,
                                 <return>session_authorization</return>,  <return>DateStyle</return>, <return>TimeZone</return>, and
                                 <return>integer_datetimes</return>.  Note that this value is case-sensitive.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> containing the value of the parameter, <info>false</info> on failure or invalid <strong>$param_name</strong>.


id: pg_pconnect
type: function
doc:
<comment>Description:</comment>
  Open a persistent PostgreSQL connection
  
  <strong>pg_pconnect()</strong> opens a connection to a PostgreSQL database. It returns an <class>PgSql\Connection</class> instance
  that is needed by other PostgreSQL functions.
  
  If a second call is made to <strong>pg_pconnect()</strong> with the same <strong>$connection_string</strong> as an existing
  connection, the existing connection will be returned unless you pass <info>PGSQL_CONNECT_FORCE_NEW</info> as
  <strong>$flags</strong>.
  
  To enable persistent connection, the pgsql.allow_persistent php.ini directive must be set to "On"
  (which is the default). The maximum number of persistent connection can be defined with the
  pgsql.max_persistent php.ini directive (defaults to -1 for no limit). The total number of
  connections can be set with the pgsql.max_links  php.ini directive.
  
  <strong>pg_close()</strong> will not close persistent links generated by <strong>pg_pconnect()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$connection_string</strong>  The <strong>$connection_string</strong> can be empty to use all default parameters, or
                              it  can contain one or more parameter settings separated by
                              whitespace.  Each parameter setting is in the form <return>keyword = value</return>.
                              Spaces around  the equal sign are optional. To write an empty value or
                              a value  containing spaces, surround it with single quotes, e.g.,
                              <return>keyword =  'a value'</return>. Single quotes and backslashes within the value
                              must be  escaped with a backslash, i.e., \' and \\.
                              
                              The currently recognized parameter keywords are: <strong>$host</strong>, <strong>$hostaddr</strong>,
                              <strong>$port</strong>, <strong>$dbname</strong>, <strong>$user</strong>, <strong>$password</strong>, <strong>$connect_timeout</strong>, <strong>$options</strong>, <strong>$tty</strong>
                              (ignored), <strong>$sslmode</strong>, <strong>$requiressl</strong> (deprecated in favor of <strong>$sslmode</strong>),
                              and <strong>$service</strong>.  Which of these arguments exist depends on your
                              PostgreSQL version.
  <info>int</info>     <strong>$flags</strong>              If <info>PGSQL_CONNECT_FORCE_NEW</info> is passed, then a new connection is
                              created, even if the <strong>$connection_string</strong> is identical to an existing
                              connection.

<comment>Return:</comment>
  <info>PgSql\Connection|false</info>  Returns an <class>PgSql\Connection</class> instance on success,  ou <info>false</info> em caso de
                          falha.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * 
     Persistent Database Connections


id: pg_ping
type: function
doc:
<comment>Description:</comment>
  Ping database connection
  
  <strong>pg_ping()</strong> pings a database connection and tries to reconnect it if it is broken.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                      Quando o parâmetro <strong>$connection</strong> for <info>null</info>, a conexão padrão será
                                      usada.
                                      A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                      ou <strong>pg_pconnect()</strong>.
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.
                                      
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_connection_status()</strong>
   * <strong>pg_connection_reset()</strong>


id: pg_port
type: function
doc:
<comment>Description:</comment>
  Return the port number associated with the connection
    
  
  <strong>pg_port()</strong> returns the port number that the given PostgreSQL <strong>$connection</strong> instance is connected to.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                      Quando o parâmetro <strong>$connection</strong> for <info>null</info>, a conexão padrão será
                                      usada.
                                      A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                      ou <strong>pg_pconnect()</strong>.
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.
                                      
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> containing the port number of the database server the <strong>$connection</strong> is to,  or
          empty string on error.


id: pg_prepare
type: function
doc:
<comment>Description:</comment>
  Submits a request to create a prepared statement with the 
    given parameters, and waits for completion
  
  <strong>pg_prepare()</strong> creates a prepared statement for later execution with  <strong>pg_execute()</strong> or
  <strong>pg_send_execute()</strong>.  This feature allows commands that will be used repeatedly to  be parsed and
  planned just once, rather than each time they are executed.  <strong>pg_prepare()</strong> is supported only
  against PostgreSQL 7.4 or higher connections; it will fail when using earlier versions.
  
  The function creates a prepared statement named <strong>$stmtname</strong> from the <strong>$query</strong>  string, which must
  contain a single SQL command. <strong>$stmtname</strong> may be "" to  create an unnamed statement, in which case
  any pre-existing unnamed  statement is automatically replaced; otherwise it is an error if the
  statement name is already defined in the current session. If any parameters  are used, they are
  referred to in the <strong>$query</strong> as $1, $2, etc.
  
  Prepared statements for use with <strong>pg_prepare()</strong> can also be created by  executing SQL <return>PREPARE</return>
  statements. (But <strong>pg_prepare()</strong> is more flexible since it  does not require parameter types to be
  pre-specified.) Also, although there  is no PHP function for deleting a prepared statement, the
  SQL <return>DEALLOCATE</return> statement can be used for that purpose.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>string</info>            <strong>$stmtname</strong>    The name to give the prepared statement.  Must be unique
                                 per-connection.  If "" is specified, then an unnamed statement is
                                 created, overwriting any previously defined unnamed statement.
  <info>string</info>            <strong>$query</strong>       The parameterized SQL statement.  Must contain only a single
                                 statement. (multiple statements separated by semi-colons are not
                                 allowed.)  If any parameters  are used, they are referred to as $1,
                                 $2, etc.

<comment>Return:</comment>
  <info>PgSql\Result|false</info>  An <class>PgSql\Result</class> instance on success,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_execute()</strong>
   * <strong>pg_send_execute()</strong>


id: pg_put_line
type: function
doc:
<comment>Description:</comment>
  Send a NULL-terminated string to PostgreSQL backend
  
  <strong>pg_put_line()</strong> sends a NULL-terminated string to the PostgreSQL backend server.  This is needed in
  conjunction with PostgreSQL's <return>COPY FROM</return> command.
  
  <return>COPY</return> is a high-speed data loading interface supported by PostgreSQL.  Data is passed in without
  being parsed,  and in a single transaction.
  
  An alternative to using raw <strong>pg_put_line()</strong> commands is to use <strong>pg_copy_from()</strong>.  This is a far
  simpler  interface.
  
  The application must explicitly send the two characters "\." on the last line to indicate to the
  backend that it has finished sending its data, before issuing <strong>pg_end_copy()</strong>.
  
  Use of the <strong>pg_put_line()</strong> causes most large object operations, including <strong>pg_lo_read()</strong> and
  <strong>pg_lo_tell()</strong>, to subsequently fail. You can use <strong>pg_copy_from()</strong> and <strong>pg_copy_to()</strong> instead.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>string</info>            <strong>$data</strong>        A line of text to be sent directly to the PostgreSQL backend.  A
                                 <return>NULL</return> terminator is added automatically.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_end_copy()</strong>


id: pg_query
type: function
doc:
<comment>Description:</comment>
  Execute a query
  
  <strong>pg_query()</strong> executes the <strong>$query</strong> on the specified database <strong>$connection</strong>. <strong>pg_query_params()</strong> should be
  preferred in most cases.
  
  If an error occurs, and <info>false</info> is returned, details of the error can be retrieved using the
  <strong>pg_last_error()</strong> function if the connection is valid.
  
   Although <strong>$connection</strong> can be omitted, it is not recommended, since it can be the cause of hard to
  find bugs in scripts.
  
  Although <strong>$connection</strong> can be omitted, it is not recommended, since it can be the cause of hard to
  find bugs in scripts.
  
  This function used to be called <strong>pg_exec()</strong>. <strong>pg_exec()</strong> is still available for compatibility reasons,
  but users are encouraged to use the newer name.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>string</info>            <strong>$query</strong>       The SQL statement or statements to be executed. When multiple
                                 statements are passed to the function, they are automatically
                                 executed as one transaction, unless there are explicit BEGIN/COMMIT
                                 commands included in the query string. However, using multiple
                                 transactions in one function call is not recommended.
                                 
                                 String interpolation of user-supplied data is extremely dangerous
                                 and is likely to lead to SQL injection vulnerabilities. In most
                                 cases <strong>pg_query_params()</strong> should be preferred, passing user-supplied
                                 values as parameters rather than substituting them into the query
                                 string.
                                 
                                 Any user-supplied data substituted directly into a query string
                                 should be properly escaped.

<comment>Return:</comment>
  <info>PgSql\Result|false</info>  An <class>PgSql\Result</class> instance on success,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * <strong>pg_pconnect()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_num_rows()</strong>
   * <strong>pg_affected_rows()</strong>


id: pg_query_params
type: function
doc:
<comment>Description:</comment>
  Submits a command to the server and waits for the result, with the ability to pass parameters
  separately from the SQL command text
  
  Submits a command to the server and waits for the result, with the ability  to pass parameters
  separately from the SQL command text.
  
  <strong>pg_query_params()</strong> is like <strong>pg_query()</strong>,  but offers additional functionality: parameter  values can
  be specified separately from the command string proper.  <strong>pg_query_params()</strong> is supported only
  against PostgreSQL 7.4 or higher connections; it will fail when using earlier versions.
  
  If parameters are used, they are referred to in the <strong>$query</strong> string as $1, $2, etc. The same
  parameter may appear more than once in the <strong>$query</strong>; the same value will be used in that case.
  <strong>$params</strong> specifies the actual values of the parameters. A <info>null</info> value in this array means the
  corresponding parameter is SQL <return>NULL</return>.
  
  The primary advantage of <strong>pg_query_params()</strong> over <strong>pg_query()</strong>  is that parameter values  may be
  separated from the <strong>$query</strong> string, thus avoiding the need for tedious  and error-prone quoting and
  escaping. Unlike <strong>pg_query()</strong>,  <strong>pg_query_params()</strong> allows at  most one SQL command in the given
  string. (There can be semicolons in it,  but not more than one nonempty command.)

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>string</info>            <strong>$query</strong>       The parameterized SQL statement.  Must contain only a single
                                 statement. (multiple statements separated by semi-colons are not
                                 allowed.)  If any parameters  are used, they are referred to as $1,
                                 $2, etc.
                                 
                                 User-supplied values should always be passed as parameters, not
                                 interpolated into the query string, where they form possible  SQL
                                 injection attack vectors and introduce bugs when handling data
                                 containing quotes. If for some reason you cannot use a parameter,
                                 ensure that interpolated values are properly escaped.
  <info>array</info>             <strong>$params</strong>      An array of parameter values to substitute for the $1, $2, etc.
                                 placeholders in the original prepared query string.  The number of
                                 elements in the array must match the number of placeholders.
                                 
                                 Values intended for <return>bytea</return> fields are not supported as parameters.
                                 Use <strong>pg_escape_bytea()</strong> instead, or use the large object functions.

<comment>Return:</comment>
  <info>PgSql\Result|false</info>  An <class>PgSql\Result</class> instance on success,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>


id: pg_result_error
type: function
doc:
<comment>Description:</comment>
  Get error message associated with result
    
  
  <strong>pg_result_error()</strong> returns any error message associated with the <strong>$result</strong> instance. Therefore, the
  user has a better chance of getting the correct error message than with <strong>pg_last_error()</strong>.
  
  The function <strong>pg_result_error_field()</strong> can give much greater detail on result errors than
  <strong>pg_result_error()</strong>.
  
  Because <strong>pg_query()</strong> returns <info>false</info> if the query fails, you must use <strong>pg_send_query()</strong> and
  <strong>pg_get_result()</strong> to get the result handle.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).

<comment>Return:</comment>
  <info>string|false</info>  Returns a <info>string</info>. Returns empty string if there is no error. If there is an error
                associated with the <strong>$result</strong> parameter, returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>pg_result_error_field()</strong>
   * <strong>pg_query()</strong>
   * <strong>pg_send_query()</strong>
   * <strong>pg_get_result()</strong>
   * <strong>pg_last_error()</strong>
   * <strong>pg_last_notice()</strong>


id: pg_result_error_field
type: function
doc:
<comment>Description:</comment>
  Returns an individual field of an error report
  
  <strong>pg_result_error_field()</strong> returns one of the detailed error message fields associated with <strong>$result</strong>
  instance. It is only available against a PostgreSQL 7.4 or above server.  The error field is
  specified by the <strong>$field_code</strong>.
  
  Because <strong>pg_query()</strong> and <strong>pg_query_params()</strong> return <info>false</info> if the query fails, you must use
  <strong>pg_send_query()</strong> and <strong>pg_get_result()</strong> to get the result handle.
  
  If you need to get additional error information from failed <strong>pg_query()</strong> queries,   use
  <strong>pg_set_error_verbosity()</strong> and <strong>pg_last_error()</strong> and then parse the result.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>      Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                             <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int</info>           <strong>$field_code</strong>  Possible <strong>$field_code</strong> values are: <info>PGSQL_DIAG_SEVERITY</info>,
                             <info>PGSQL_DIAG_SQLSTATE</info>, <info>PGSQL_DIAG_MESSAGE_PRIMARY</info>,
                             <info>PGSQL_DIAG_MESSAGE_DETAIL</info>, <info>PGSQL_DIAG_MESSAGE_HINT</info>,
                             <info>PGSQL_DIAG_STATEMENT_POSITION</info>, <info>PGSQL_DIAG_INTERNAL_POSITION</info> (PostgreSQL
                             8.0+ only), <info>PGSQL_DIAG_INTERNAL_QUERY</info> (PostgreSQL 8.0+ only),
                             <info>PGSQL_DIAG_CONTEXT</info>, <info>PGSQL_DIAG_SOURCE_FILE</info>, <info>PGSQL_DIAG_SOURCE_LINE</info> or
                             <info>PGSQL_DIAG_SOURCE_FUNCTION</info>.

<comment>Return:</comment>
  <info>string|false|null</info>  A <info>string</info> containing the contents of the error field, <info>null</info> if the field does not
                     exist or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>pg_result_error()</strong>


id: pg_result_seek
type: function
doc:
<comment>Description:</comment>
  Set internal row offset in result instance
  
  <strong>pg_result_seek()</strong> sets the internal row offset in the <strong>$result</strong> instance.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int</info>           <strong>$row</strong>     Row to move the internal offset to in the <class>PgSql\Result</class> instance. Rows are
                         numbered starting from zero.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_assoc()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_result_status
type: function
doc:
<comment>Description:</comment>
  Get status of query result
    
  
  <strong>pg_result_status()</strong> returns the status of the <class>PgSql\Result</class> instance, or the PostgreSQL command
  completion tag associated with the result

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Uma instância de <class>PgSql\Result</class>, retornada por <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> ou <strong>pg_execute()</strong> (entre outras).
  <info>int</info>           <strong>$mode</strong>    Either <info>PGSQL_STATUS_LONG</info> to return the numeric status  of the <strong>$result</strong>, or
                         <info>PGSQL_STATUS_STRING</info>  to return the command tag of the <strong>$result</strong>. If not
                         specified, <info>PGSQL_STATUS_LONG</info> is the default.

<comment>Return:</comment>
  <info>string|int</info>  Possible return values are <info>PGSQL_EMPTY_QUERY</info>, <info>PGSQL_COMMAND_OK</info>, <info>PGSQL_TUPLES_OK</info>,
              <info>PGSQL_COPY_OUT</info>, <info>PGSQL_COPY_IN</info>, <info>PGSQL_BAD_RESPONSE</info>, <info>PGSQL_NONFATAL_ERROR</info> and
              <info>PGSQL_FATAL_ERROR</info> if <info>PGSQL_STATUS_LONG</info> is specified.  Otherwise, a <info>string</info> containing
              the PostgreSQL command tag is returned.

<comment>See Also:</comment>
   * <strong>pg_connection_status()</strong>


id: pg_select
type: function
doc:
<comment>Description:</comment>
  Select records
    
  
  <strong>pg_select()</strong> selects records specified by <strong>$conditions</strong> which has <return>field=&gt;value</return>. For a successful
  query, it returns an array containing all records and fields that match the condition specified by
  <strong>$conditions</strong>.
  
  If <strong>$flags</strong> is set, <strong>pg_convert()</strong> is applied to <strong>$conditions</strong> with the specified flags.
  
  If <strong>$mode</strong> is set, the return value will be in the form of an array with <info>PGSQL_NUM</info>, an associative
  array with <info>PGSQL_ASSOC</info> (default) or both with <info>PGSQL_BOTH</info>.
  
  By default <strong>pg_select()</strong> passes raw values. Values must be escaped or PGSQL_DML_ESCAPE option must
  be specified. PGSQL_DML_ESCAPE quotes and escapes parameters/identifiers. Therefore, table/column
  names became case sensitive.
  
  Note that neither escape nor prepared query can protect LIKE query, JSON, Array, Regex, etc. These
  parameters should be handled according to their contexts. i.e. Escape/validate values.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  Name of the table from which to select rows.
  <info>array</info>             <strong>$conditions</strong>  An <info>array</info> whose keys are field names in the table <strong>$table_name</strong>, and
                                 whose values are the conditions that a row must meet to be
                                 retrieved.
  <info>int</info>               <strong>$flags</strong>       Any number of <info>PGSQL_CONV_FORCE_NULL</info>, <info>PGSQL_DML_NO_CONV</info>,
                                 <info>PGSQL_DML_ESCAPE</info>, <info>PGSQL_DML_EXEC</info>, <info>PGSQL_DML_ASYNC</info> or
                                 <info>PGSQL_DML_STRING</info> combined. If <info>PGSQL_DML_STRING</info> is part of the
                                 <strong>$flags</strong> then the query string is returned. When <info>PGSQL_DML_NO_CONV</info> or
                                 <info>PGSQL_DML_ESCAPE</info> is set, it does not call <strong>pg_convert()</strong> internally.
  <info>int</info>               <strong>$mode</strong>        Any number of <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info> or <info>PGSQL_BOTH</info> If <info>PGSQL_ASSOC</info>
                                 is set the return value will be an associative <info>array</info>, with
                                 <info>PGSQL_NUM</info> the return value will be an <info>array</info>, and with <info>PGSQL_BOTH</info>
                                 the return value will be both an associative and numerically
                                 indexed <info>array</info>.

<comment>Return:</comment>
  <info>array|string|false</info>  Returns <info>string</info> if <info>PGSQL_DML_STRING</info> is passed via <strong>$flags</strong>, otherwise it returns
                      an <info>array</info> on success,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pg_convert()</strong>


id: pg_send_execute
type: function
doc:
<comment>Description:</comment>
  Sends a request to execute a prepared statement with given parameters, without waiting for the
  result(s)
  
  Sends a request to execute a prepared statement with given parameters,  without waiting for the
  result(s).
  
  This is similar to <strong>pg_send_query_params()</strong>, but the command to be executed is specified  by naming
  a previously-prepared statement, instead of giving a query string. The  function's parameters are
  handled identically to <strong>pg_execute()</strong>.  Like <strong>pg_execute()</strong>, it will not work on pre-7.4 versions of
  PostgreSQL.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>      Uma instância de <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$statement_name</strong>  The name of the prepared statement to execute.  If "" is
                                     specified, then the unnamed statement is executed.  The name
                                     must have been previously prepared using <strong>pg_prepare()</strong>,
                                     <strong>pg_send_prepare()</strong> or a <return>PREPARE</return> SQL command.
  <info>array</info>             <strong>$params</strong>          An array of parameter values to substitute for the $1, $2, etc.
                                     placeholders in the original prepared query string.  The number
                                     of elements in the array must match the number of placeholders.

<comment>Return:</comment>
  <info>int|bool</info>  Returns <info>true</info> on success, <info>false</info> or <return>0</return> on failure.  Use <strong>pg_get_result()</strong> to determine the
            query result.

<comment>See Also:</comment>
   * <strong>pg_prepare()</strong>
   * <strong>pg_send_prepare()</strong>
   * <strong>pg_execute()</strong>


id: pg_send_prepare
type: function
doc:
<comment>Description:</comment>
  Sends a request to create a prepared statement with the given parameters, without waiting for
  completion
  
  Sends a request to create a prepared statement with the given parameters,  without waiting for
  completion.
  
  This is an asynchronous version of <strong>pg_prepare()</strong>: it returns <info>true</info> if it was able to  dispatch the
  request, and <info>false</info> if not. After a successful call, call  <strong>pg_get_result()</strong> to determine whether the
  server successfully created the  prepared statement. The function's parameters are handled
  identically to  <strong>pg_prepare()</strong>. Like <strong>pg_prepare()</strong>, it will not work  on pre-7.4 versions of
  PostgreSQL.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>      Uma instância de <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$statement_name</strong>  The name to give the prepared statement.  Must be unique
                                     per-connection.  If "" is specified, then an unnamed statement
                                     is created, overwriting any previously defined unnamed
                                     statement.
  <info>string</info>            <strong>$query</strong>           The parameterized SQL statement.  Must contain only a single
                                     statement. (multiple statements separated by semi-colons are
                                     not allowed.)  If any parameters  are used, they are referred
                                     to as $1, $2, etc.

<comment>Return:</comment>
  <info>int|bool</info>  Returns <info>true</info> on success, <info>false</info> or <return>0</return> on failure.  Use <strong>pg_get_result()</strong> to determine the
            query result.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * <strong>pg_pconnect()</strong>
   * <strong>pg_execute()</strong>
   * <strong>pg_send_execute()</strong>
   * <strong>pg_send_query_params()</strong>


id: pg_send_query
type: function
doc:
<comment>Description:</comment>
  Sends asynchronous query
    
  
  <strong>pg_send_query()</strong> sends a query or queries asynchronously to the <strong>$connection</strong>. Unlike <strong>pg_query()</strong>, it
  can send multiple queries at once to PostgreSQL and get the results one by one using
  <strong>pg_get_result()</strong>.
  
  Script execution is not blocked while the queries are executing. Use <strong>pg_connection_busy()</strong> to check
  if the connection is busy (i.e. the query is executing). Queries may be cancelled using
  <strong>pg_cancel_query()</strong>.
  
  Although the user can send multiple queries at once, multiple queries cannot be sent over a busy
  connection. If a query is sent while the connection is busy, it waits until the last query is
  finished and discards all its results.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$query</strong>       The SQL statement or statements to be executed.
                                 
                                 Data inside the query should be properly escaped.

<comment>Return:</comment>
  <info>int|bool</info>  Returns <info>true</info> on success, <info>false</info> or <return>0</return> on failure.  Use <strong>pg_get_result()</strong> to determine the
            query result.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_cancel_query()</strong>
   * <strong>pg_get_result()</strong>
   * <strong>pg_connection_busy()</strong>


id: pg_send_query_params
type: function
doc:
<comment>Description:</comment>
  Submits a command and separate parameters to the server without waiting for the result(s)
  
  Submits a command and separate parameters to the server without  waiting for the result(s).
  
  This is equivalent to <strong>pg_send_query()</strong> except that query  parameters can be specified separately
  from the  <strong>$query</strong> string. The function's parameters are  handled identically to <strong>pg_query_params()</strong>.
  Like  <strong>pg_query_params()</strong>, it will not work on pre-7.4 PostgreSQL  connections, and it allows only
  one command in the query string.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$query</strong>       The parameterized SQL statement.  Must contain only a single
                                 statement. (multiple statements separated by semi-colons are not
                                 allowed.)  If any parameters  are used, they are referred to as $1,
                                 $2, etc.
  <info>array</info>             <strong>$params</strong>      An array of parameter values to substitute for the $1, $2, etc.
                                 placeholders in the original prepared query string.  The number of
                                 elements in the array must match the number of placeholders.

<comment>Return:</comment>
  <info>int|bool</info>  Returns <info>true</info> on success, <info>false</info> or <return>0</return> on failure.  Use <strong>pg_get_result()</strong> to determine the
            query result.

<comment>See Also:</comment>
   * <strong>pg_send_query()</strong>


id: pg_set_client_encoding
type: function
doc:
<comment>Description:</comment>
  Set the client encoding
    
  
  <strong>pg_set_client_encoding()</strong> sets the client encoding and returns 0 if success or -1 if error.
  
  PostgreSQL will automatically convert data in the backend database encoding into the frontend
  encoding.
  
  The function used to be called <strong>pg_setclientencoding()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>string</info>            <strong>$encoding</strong>    The required client encoding.  One of <return>SQL_ASCII</return>, <return>EUC_JP</return>,  <return>EUC_CN</return>,
                                 <return>EUC_KR</return>, <return>EUC_TW</return>,  <return>UNICODE</return>, <return>MULE_INTERNAL</return>, <return>LATINX</return> (X=1...9),  <return>KOI8</return>,
                                 <return>WIN</return>, <return>ALT</return>, <return>SJIS</return>,  <return>BIG5</return> or <return>WIN1250</return>.
                                 
                                 The exact list of available encodings depends on your PostgreSQL
                                 version, so check your PostgreSQL manual for a more specific list.

<comment>Return:</comment>
  <info>int</info>  Returns <return>0</return> on success or <return>-1</return> on error.

<comment>See Also:</comment>
   * <strong>pg_client_encoding()</strong>


id: pg_set_error_context_visibility
type: function
doc:
<comment>Description:</comment>
  Determines the visibility of the context's error messages returned by pg_last_error
     and pg_result_error
    
  
  Determines the visibility of the context's error messages returned by <strong>pg_last_error()</strong> and
  <strong>pg_result_error()</strong>

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
  <info>int</info>               <strong>$visibility</strong>  The required visibility: <info>PGSQL_SHOW_CONTEXT_NEVER</info>,
                                 <info>PGSQL_SHOW_CONTEXT_ERRORS</info> or <info>PGSQL_SHOW_CONTEXT_ALWAYS</info>.

<comment>Return:</comment>
  <info>int</info>  The previous visibility level: <info>PGSQL_SHOW_CONTEXT_NEVER</info>, <info>PGSQL_SHOW_CONTEXT_ERRORS</info> or
       <info>PGSQL_SHOW_CONTEXT_ALWAYS</info>.

<comment>See Also:</comment>
   * <strong>pg_last_error()</strong>
   * <strong>pg_result_error()</strong>


id: pg_set_error_verbosity
type: function
doc:
<comment>Description:</comment>
  Determines the verbosity of messages returned by pg_last_error 
     and pg_result_error
    
  
  Determines the verbosity of messages returned by <strong>pg_last_error()</strong>  and <strong>pg_result_error()</strong>.
  
  <strong>pg_set_error_verbosity()</strong> sets the verbosity mode, returning the connection's previous  setting. In
  <info>PGSQL_ERRORS_TERSE</info> mode, returned messages include severity, primary text, and  position only;
  this will normally fit on a single line. The default mode (<info>PGSQL_ERRORS_DEFAULT</info>) produces messages
  that include the above plus any detail, hint, or context  fields (these may span multiple lines).
  The <info>PGSQL_ERRORS_VERBOSE</info> mode includes all available  fields. Changing the verbosity does not
  affect the messages available from  already-existing result objects, only subsequently-created
  ones.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                 Quando o parâmetro <strong>$connection</strong> não for especificado, a conexão
                                 padrão será usada.
                                 A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                 ou <strong>pg_pconnect()</strong>.
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
                                 
                                 A partir do PHP 8.1.0, usar a conexão padrão tornou-se obsoleto.
  <info>int</info>               <strong>$verbosity</strong>   The required verbosity: <info>PGSQL_ERRORS_TERSE</info>, <info>PGSQL_ERRORS_DEFAULT</info> or
                                 <info>PGSQL_ERRORS_VERBOSE</info>.

<comment>Return:</comment>
  <info>int</info>  The previous verbosity level: <info>PGSQL_ERRORS_TERSE</info>, <info>PGSQL_ERRORS_DEFAULT</info> or
       <info>PGSQL_ERRORS_VERBOSE</info>.

<comment>See Also:</comment>
   * <strong>pg_last_error()</strong>
   * <strong>pg_result_error()</strong>


id: pg_socket
type: function
doc:
<comment>Description:</comment>
  Get a read only handle to the socket underlying a PostgreSQL connection
    
  
  <strong>pg_socket()</strong> returns a read only <info>resource</info> corresponding to the socket underlying the given
  PostgreSQL connection.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>resource|false</info>  A socket resource on success ou <info>false</info> em caso de falha.


id: pg_trace
type: function
doc:
<comment>Description:</comment>
  Enable tracing a PostgreSQL connection
  
  <strong>pg_trace()</strong> enables tracing of the PostgreSQL frontend/backend communication to a file. To fully
  understand the results, one needs to be familiar with the internals of PostgreSQL communication
  protocol.
  
  For those who are not, it can still be useful for tracing errors in queries sent to the server,
  you could do for example grep '^To backend' trace.log and see what queries actually were sent to
  the PostgreSQL server. For more information, refer to the PostgreSQL Documentation.

<comment>Param:</comment>
  <info>string</info>                 <strong>$filename</strong>    The full path and file name of the file in which to write the
                                      trace log.  Same as in <strong>fopen()</strong>.
  <info>string</info>                 <strong>$mode</strong>        An optional file access mode, same as for <strong>fopen()</strong>.
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                      Quando o parâmetro <strong>$connection</strong> for <info>null</info>, a conexão padrão será
                                      usada.
                                      A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                      ou <strong>pg_pconnect()</strong>.
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.
                                      
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.
  <info>int</info>                    <strong>$trace_mode</strong>  An optional trace mode with the following constants
                                      <info>PGSQL_TRACE_SUPPRESS_TIMESTAMPS</info> and <info>PGSQL_TRACE_REGRESS_MODE</info>

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>fopen()</strong>
   * <strong>pg_untrace()</strong>


id: pg_transaction_status
type: function
doc:
<comment>Description:</comment>
  Returns the current in-transaction status of the server
  
  Returns the current in-transaction status of the server.
  
  <strong>pg_transaction_status()</strong> will give incorrect results when using a PostgreSQL 7.3 server that has
  the parameter <return>autocommit</return> set to off.  The server-side autocommit feature has been deprecated and
  does not exist in later server versions.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>int</info>  The status can be <info>PGSQL_TRANSACTION_IDLE</info> (currently idle), <info>PGSQL_TRANSACTION_ACTIVE</info> (a
       command is in progress), <info>PGSQL_TRANSACTION_INTRANS</info> (idle, in a valid transaction block), or
       <info>PGSQL_TRANSACTION_INERROR</info> (idle, in a failed transaction block). <info>PGSQL_TRANSACTION_UNKNOWN</info> is
       reported if the connection is bad. <info>PGSQL_TRANSACTION_ACTIVE</info> is reported only when a query has
       been sent to the server and not yet completed.


id: pg_tty
type: function
doc:
<comment>Description:</comment>
  Return the TTY name associated with the connection
    
  
  <strong>pg_tty()</strong> returns the TTY name that server side debugging output is sent to on the given PostgreSQL
  <strong>$connection</strong> instance.
  
  <strong>pg_tty()</strong> is obsolete, since the server no longer pays attention to the TTY setting, but the
  function remains for backwards compatibility.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                      Quando o parâmetro <strong>$connection</strong> for <info>null</info>, a conexão padrão será
                                      usada.
                                      A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                      ou <strong>pg_pconnect()</strong>.
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.
                                      
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> containing the debug TTY of the <strong>$connection</strong>.


id: pg_unescape_bytea
type: function
doc:
<comment>Description:</comment>
  Unescape binary for bytea type
    
  
  <strong>pg_unescape_bytea()</strong> unescapes PostgreSQL bytea data values.  It returns the unescaped string,
  possibly containing binary data.
  
  When you <return>SELECT</return> a bytea type, PostgreSQL returns octal byte values prefixed with '\' (e.g. \032).
  Users are supposed to convert back to binary format manually.
  
  This function requires PostgreSQL 7.2 or later. With PostgreSQL 7.2.0 and 7.2.1, bytea values must
  be cast when you enable multi-byte support. i.e. <return>INSERT INTO test_table (image) VALUES
  ('$image_escaped'::bytea);</return> PostgreSQL 7.2.2 or later does not need a cast. The exception is when
  the client and backend character encoding does not match, and there may be multi-byte stream
  error. User must then cast to bytea to avoid this error.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A <info>string</info> containing PostgreSQL bytea data to be converted into a PHP binary
                   string.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> containing the unescaped data.

<comment>See Also:</comment>
   * <strong>pg_escape_bytea()</strong>
   * <strong>pg_escape_string()</strong>


id: pg_untrace
type: function
doc:
<comment>Description:</comment>
  Disable tracing of a PostgreSQL connection
  
  Stop tracing started by <strong>pg_trace()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                      Quando o parâmetro <strong>$connection</strong> for <info>null</info>, a conexão padrão será
                                      usada.
                                      A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                      ou <strong>pg_pconnect()</strong>.
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.
                                      
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.

<comment>Return:</comment>
  <info>true</info>  Sempre retorna <info>true</info>.

<comment>See Also:</comment>
   * <strong>pg_trace()</strong>


id: pg_update
type: function
doc:
<comment>Description:</comment>
  Update table
    
  
  <strong>pg_update()</strong> updates records that matches <strong>$conditions</strong> with <strong>$values</strong>.
  
  If <strong>$flags</strong> is specified, <strong>pg_convert()</strong> is applied to <strong>$values</strong> with the specified flags.
  
  By default <strong>pg_update()</strong> passes raw values. Values must be escaped or the <info>PGSQL_DML_ESCAPE</info> flag must
  be specified in <strong>$flags</strong>. <info>PGSQL_DML_ESCAPE</info> quotes and escapes parameters/identifiers. Therefore,
  table/column names become case sensitive.
  
  Note that neither escape nor prepared query can protect LIKE query, JSON, Array, Regex, etc. These
  parameters should be handled according to their contexts. i.e. Escape/validate values.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  Name of the table into which to update rows.
  <info>array</info>             <strong>$values</strong>      An <info>array</info> whose keys are field names in the table <strong>$table_name</strong>, and
                                 whose values are what matched rows are to be updated to.
  <info>array</info>             <strong>$conditions</strong>  An <info>array</info> whose keys are field names in the table <strong>$table_name</strong>, and
                                 whose values are the conditions that a row must meet to be updated.
  <info>int</info>               <strong>$flags</strong>       Any number of <info>PGSQL_CONV_FORCE_NULL</info>, <info>PGSQL_DML_NO_CONV</info>,
                                 <info>PGSQL_DML_ESCAPE</info>, <info>PGSQL_DML_EXEC</info>, <info>PGSQL_DML_ASYNC</info> or
                                 <info>PGSQL_DML_STRING</info> combined. If <info>PGSQL_DML_STRING</info> is part of the
                                 <strong>$flags</strong> then query string is returned. When <info>PGSQL_DML_NO_CONV</info> or
                                 <info>PGSQL_DML_ESCAPE</info> is set, it does not call <strong>pg_convert()</strong> internally.

<comment>Return:</comment>
  <info>string|bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.  Returns <info>string</info> if
               <info>PGSQL_DML_STRING</info> is passed via <strong>$flags</strong>.

<comment>See Also:</comment>
   * <strong>pg_convert()</strong>


id: pg_version
type: function
doc:
<comment>Description:</comment>
  Returns an array with client, protocol and server version (when available)
    
  
  <strong>pg_version()</strong> returns an array with the client, protocol and server version. Protocol and server
  versions are only available if PHP was compiled with PostgreSQL 7.4 or later.
  
  For more detailed server information, use <strong>pg_parameter_status()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Uma instância de <class>PgSql\Connection</class>.
                                      Quando o parâmetro <strong>$connection</strong> for <info>null</info>, a conexão padrão será
                                      usada.
                                      A conexão padrão é a última conexão feita por <strong>pg_connect()</strong>
                                      ou <strong>pg_pconnect()</strong>.
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.
                                      
                                      A partir do PHP 8.1.0, usar a conexão padrão tornou-se
                                      obsoleto.

<comment>Return:</comment>
  <info>array</info>  Returns an array with <return>client</return>, <return>protocol</return>  and <return>server</return> keys and values (if available).

<comment>See Also:</comment>
   * <strong>pg_parameter_status()</strong>


id: php_ini_loaded_file
type: function
doc:
<comment>Description:</comment>
  Retrieve a path to the loaded php.ini file
  
  Check if a php.ini file is loaded, and retrieve its path.

<comment>Return:</comment>
  <info>string|false</info>  The loaded php.ini path, or <info>false</info> if one is not loaded.

<comment>See Also:</comment>
   * <strong>php_ini_scanned_files()</strong>
   * <strong>phpinfo()</strong>
   * The configuration file


id: php_ini_scanned_files
type: function
doc:
<comment>Description:</comment>
  Return a list of .ini files parsed from the additional ini dir
  
  <strong>php_ini_scanned_files()</strong> returns a comma-separated list of configuration files parsed after
  php.ini. The directories searched are set by a compile time option and, optionally, by an
  environment variable at run time: more information can be found in the installation guide.
  
  The returned configuration files include the full path.

<comment>Return:</comment>
  <info>string|false</info>  Returns a comma-separated string of .ini files on success. Each comma is followed by
                a newline. If the configure directive --with-config-file-scan-dir wasn't set and the
                PHP_INI_SCAN_DIR environment variable isn't set, <info>false</info> is returned.  If it was set
                and the directory was empty, an empty string is returned.  If a file is
                unrecognizable, the file will still make it into the returned string but a PHP error
                will also result.  This PHP error will be seen both at compile time and while using
                <strong>php_ini_scanned_files()</strong>.

<comment>See Also:</comment>
   * <strong>ini_set()</strong>
   * <strong>phpinfo()</strong>
   * <strong>php_ini_loaded_file()</strong>


id: php_sapi_name
type: function
doc:
<comment>Description:</comment>
  Returns the type of interface between web server and PHP
  
  Returns a lowercase string that describes the type of interface (the Server API, SAPI) that PHP is
  using. For example, in CLI PHP this string will be "cli" whereas with Apache it may have several
  different values depending on the exact SAPI used. Possible values are listed below.

<comment>Return:</comment>
  <info>string|false</info>  Returns the interface type, as a lowercase string,  ou <info>false</info> em caso de falha.
                
                Although not exhaustive, the possible return values include  <return>apache</return>,
                <return>apache2handler</return>,  <return>cgi</return> (until PHP 5.3),  <return>cgi-fcgi</return>, <return>cli</return>, <return>cli-server</return>, <return>embed</return>, <return>fpm-fcgi</return>,
                <return>litespeed</return>,  <return>phpdbg</return>.

<comment>See Also:</comment>
   * PHP_SAPI


id: php_strip_whitespace
type: function
doc:
<comment>Description:</comment>
  Retorna o código com comentários e espaços em branco removidos
  
  Retorna o código-fonte do PHP do arquivo <strong>$filename</strong> com comentários PHP e espaços em branco
  removidos. Isto pode ser útil para determina a quantidade atual de códigos em seu script comparado
  com a quantidade de comentários. Similar ao uso de php -w pela linha de comando.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Caminho para o arquivo PHP.

<comment>Return:</comment>
  <info>string</info>  O código-fonte filtrado será retornado em caso de sucesso, ou uma string vazia em falha.
          
          Esta função respeita o valor da diretiva ini short_open_tag.


id: php_uname
type: function
doc:
<comment>Description:</comment>
  Returns information about the operating system PHP is running on
  
  <strong>php_uname()</strong> returns a description of the operating system PHP is running on.  This is the same
  string you see at the very top of the <strong>phpinfo()</strong> output.  For the name of just the operating
  system, consider using the <info>PHP_OS</info> constant, but keep in mind this constant will contain the
  operating system PHP was built on.
  
  On some older UNIX platforms, it may not be able to determine the current OS information in which
  case it will revert to displaying the OS PHP was built on.  This will only happen if your uname()
  library call either doesn't exist or doesn't work.

<comment>Param:</comment>
  <info>string</info>  <strong>$mode</strong>  <strong>$mode</strong> is a single character that defines what information is returned: <return>'a'</return>: This is
                 the default. Contains all modes in the sequence <return>"s n r v m"</return>. <return>'s'</return>: Operating system
                 name. eg. <return>FreeBSD</return>. <return>'n'</return>: Host name. eg.  <return>localhost.example.com</return>. <return>'r'</return>: Release name.
                 eg.  <return>5.1.2-RELEASE</return>. <return>'v'</return>: Version information. Varies a lot between operating
                 systems. <return>'m'</return>: Machine type. eg. <return>i386</return>.
                 
                 <return>'a'</return>: This is the default. Contains all modes in the sequence <return>"s n r v m"</return>.
                 
                 <return>'s'</return>: Operating system name. eg. <return>FreeBSD</return>.
                 
                 <return>'n'</return>: Host name. eg.  <return>localhost.example.com</return>.
                 
                 <return>'r'</return>: Release name. eg.  <return>5.1.2-RELEASE</return>.
                 
                 <return>'v'</return>: Version information. Varies a lot between operating systems.
                 
                 <return>'m'</return>: Machine type. eg. <return>i386</return>.

<comment>Return:</comment>
  <info>string</info>  Returns the description, as a string.

<comment>See Also:</comment>
   * <strong>phpversion()</strong>
   * <strong>php_sapi_name()</strong>
   * <strong>phpinfo()</strong>


id: php_user_filter
type: class
doc:
<comment>Description:</comment>
  Filhas desta classe são passadas à função <strong>stream_filter_register()</strong>. Note que o método __construct
  não é chamado; em vez disso, php_user_filter::onCreate deve ser usado para inicialização.


id: php_user_filter::filter
type: function
doc:
<comment>Description:</comment>
  Chamada na aplicação do filtro
  
  Este método é chamado toda vez que dados são lidos ou escritos no fluxo anexado (como em <strong>fread()</strong>
  ou <strong>fwrite()</strong>).

<comment>Param:</comment>
  <info>resource</info>  <strong>$in</strong>        O parâmetro <strong>$in</strong> é um recurso que aponta para uma <return>brigada de bucket</return> que contém
                       um ou mais objetos <return>bucket</return> contendo os dados a serem filtrados.
  <info>resource</info>  <strong>$out</strong>       O parâmetro <strong>$out</strong> é um recurso que aponta para uma segunda <return>brigada de bucket</return>
                       na qual os buckets modificados devem ser colocados.
  <info>int</info>       <strong>$consumed</strong>  O parâmetro <strong>$consumed</strong>, que deve ser sempre declarado por referência, deve ser
                       incrementado com o comprimento dos dados que o filtro lê e altera. Na maior
                       parte dos casos isto significa que <strong>$consumed</strong> será incrementado em
                       <return>$bucket-&gt;datalen</return> para cada <return>$bucket</return>.
  <info>bool</info>      <strong>$closing</strong>   Se o fluxo está no processo de fechamento (e portanto este é a última
                       passagem pela cadeia de filtros), o parâmetro <strong>$closing</strong> será definido para
                       <info>true</info>.

<comment>Return:</comment>
  <info>int</info>  O método filter deve retornar um dos três valores quando concluído. Valor de
       RetornoSignificado<info>PSFS_PASS_ON</info> Filtro processado com sucesso com dados disponíveis na <return>brigada
       de bucket</return><strong>$out</strong>. <info>PSFS_FEED_ME</info> Filtro processado com sucesso, porém nenhum dado estava
       disponível para retorno Mais dados são requeridos do fluxo ou do filtro anterior.
       <info>PSFS_ERR_FATAL</info> (padrão) O filtro encontrou um erro irrecuperável e não pode continuar.


id: php_user_filter::onClose
type: function
doc:
<comment>Description:</comment>
  Chamado no fechamento do filtro
  
  Este método é chamado no fechamento do filtro (tipicamente, também é o fechamento do fluxo), e é
  executado depois que o médoto de <return>flush</return> é chamado. Se quaisquer recursos foram alocados ou
  inicializados durante <return>onCreate()</return> este seria o momento para destrui-los ou descartá-los.

<comment>Return:</comment>
  <info>void</info>  O valor de retorno é ignorado.


id: php_user_filter::onCreate
type: function
doc:
<comment>Description:</comment>
  Chamado na criação do filtro
  
  Este método é chamado durante a instanciação do objeto da classe do filtro. Se o filtro aloca ou
  inicializa quaisquer outros recursos (como em um buffer), este é o local a se fazê-lo.
  
  Quando o filtro é instanciado pela primeira vez, e <return>filtro-&gt;onCreate()</return> é chamado, um número de
  propriedades estará disponível como mostrado na tabela abaixo.
  
  PropriedadeConteúdo<return>filtro-&gt;filtername</return> Uma string contendo o nome com o qual o filtro foi
  instanciado. Filtros podem ser registrados sob múltiplos nomes ou com caracteres coringas. Use
  esta propriedade para deverminar que nome foi usado. <return>filtro-&gt;params</return> O conteúdo de <strong>$params</strong>
  parameter passado para <strong>stream_filter_append()</strong> ou <strong>stream_filter_prepend()</strong>. <return>filtro-&gt;stream</return> O
  recurso de fluxo sendo filtrado. Possivelmente disponível apenas durante chamadas a filter quando
  o parâmetro <return>closing</return> estiver definido para <info>false</info>.

<comment>Return:</comment>
  <info>bool</info>  A implementação deste método deve retornar <info>false</info> em caso de falha, ou <info>true</info> em caso de
        sucesso.


id: phpcredits
type: function
doc:
<comment>Description:</comment>
  Prints out the credits for PHP
  
  This function prints out the credits listing the PHP developers, modules, etc. It generates the
  appropriate HTML codes to insert the information in a page.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  To generate a custom credits page, you may want to use the <strong>$flags</strong> parameter.
               
               Pre-defined <strong>phpcredits()</strong> flagsnamedescriptionCREDITS_ALL All the credits, equivalent
               to using: <info>CREDITS_DOCS</info> + <info>CREDITS_GENERAL</info> + <info>CREDITS_GROUP</info> + <info>CREDITS_MODULES</info> +
               <info>CREDITS_FULLPAGE</info>. It generates a complete stand-alone HTML page with the appropriate
               tags. CREDITS_DOCSThe credits for the documentation teamCREDITS_FULLPAGE Usually used
               in combination with the other flags.  Indicates that a complete stand-alone HTML page
               needs to be printed including the information indicated by the other flags.
               CREDITS_GENERAL General credits: Language design and concept, PHP authors  and SAPI
               module. CREDITS_GROUPA list of the core developersCREDITS_MODULES A list of the
               extension modules for PHP, and their authors CREDITS_SAPI A list of the server API
               modules for PHP, and their authors

<comment>Return:</comment>
  <info>true</info>  Sempre retorna <info>true</info>.

<comment>See Also:</comment>
   * <strong>phpversion()</strong>
   * <strong>phpinfo()</strong>


id: phpdbg_break_file
type: function
doc:
<comment>Description:</comment>
  Insere um ponto de interrupção em uma linha de um arquivo
  
  Insere um ponto de interrupção na <strong>$line</strong> fornecida no <strong>$file</strong> fornecido.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>  O nome do arquivo.
  <info>int</info>     <strong>$line</strong>  O número da linha.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_break_next()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_break_function
type: function
doc:
<comment>Description:</comment>
  Insere um ponto de interrupção na entrada de uma função
  
  Insere um ponto de interrupção na entrada da <strong>$function</strong> fornecida.

<comment>Param:</comment>
  <info>string</info>  <strong>$function</strong>  O nome da função.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_break_next()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_break_method
type: function
doc:
<comment>Description:</comment>
  Insere um ponto de interrupção na entrada de um método
  
  Insere um ponto de interrupção na entrada do <strong>$method</strong> fornecido da <strong>$class</strong> especificada.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>   O nome da classe.
  <info>string</info>  <strong>$method</strong>  O nome do método.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_next()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_break_next
type: function
doc:
<comment>Description:</comment>
  Insere um ponto de interrupção no próximo opcode
  
  Insere um ponto de interrupção no próximo opcode.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_clear
type: function
doc:
<comment>Description:</comment>
  Limpa todos os pontos de interrupção
  
  Limpa todos os pontos de interrupção que foram definidos, por meio de uma das funções
  <strong>phpdbg_break_*()</strong> ou interativamente no console.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_break_next()</strong>


id: phpdbg_color
type: function
doc:
<comment>Description:</comment>
  Define a cor de certos elementos
  
  Define a <strong>$color</strong> do <strong>$element</strong> fornecido.

<comment>Param:</comment>
  <info>int</info>     <strong>$element</strong>  Uma das constantes <info>PHPDBG_COLOR_*</info>.
  <info>string</info>  <strong>$color</strong>    O nome da cor. Um de <return>white</return>, <return>red</return>, <return>green</return>, <return>yellow</return>, <return>blue</return>, <return>purple</return>, <return>cyan</return> ou <return>black</return>,
                    opcionalmente com um traço <return>-bold</return> ou <return>-underline</return>, por exemplo, <return>white-bold</return> ou
                    <return>green-underline</return>.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>phpdbg_prompt()</strong>


id: phpdbg_end_oplog
type: function
doc:
<comment>Description:</comment>
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  

<comment>Return:</comment>
  <info>array|null</info>  


id: phpdbg_exec
type: function
doc:
<comment>Description:</comment>
  Tenta definir o contexto de execução
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$context</strong>  

<comment>Return:</comment>
  <info>string|bool</info>  Se o contexto de execução foi definido anteriormente, ele é retornado. Se o contexto
               de execução não foi definido anteriormente, <info>true</info> é retornado. Se a solicitação para
               definir o contexto falhar, <info>false</info> será retornado e um <info>E_WARNING</info> será gerado.


id: phpdbg_get_executable
type: function
doc:
<comment>Description:</comment>
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  

<comment>Return:</comment>
  <info>array</info>  


id: phpdbg_prompt
type: function
doc:
<comment>Description:</comment>
  Define o prompt de comando
  
  Define o prompt de comando para a <strong>$string</strong> fornecida.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string a ser usada como prompt de comando.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>phpdbg_color()</strong>


id: phpdbg_start_oplog
type: function
doc:
<comment>Description:</comment>
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: phpinfo
type: function
doc:
<comment>Description:</comment>
  Outputs information about PHP's configuration
  
  Outputs a large amount of information about the current state of  PHP.  This includes information
  about PHP compilation options and extensions, the PHP version, server information and environment
  (if compiled as a module), the PHP environment, OS version information, paths, master and local
  values of configuration options, HTTP headers, and the PHP License.
  
  Because every system is setup differently, <strong>phpinfo()</strong> is commonly used to check configuration
  settings and for available predefined variables on a given system.
  
  <strong>phpinfo()</strong> is also a valuable debugging tool as it contains all EGPCS (Environment, GET, POST,
  Cookie, Server) data.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  The output may be customized by passing one or more of the following constants
               bitwise values summed together in the optional <strong>$flags</strong> parameter. One can also combine
               the respective constants or bitwise values together with the bitwise or operator.
               
               <strong>phpinfo()</strong> optionsName (constant)ValueDescriptionINFO_GENERAL1 The configuration line,
               php.ini location, build date, Web Server, System and more. INFO_CREDITS2 PHP Credits.
               See also <strong>phpcredits()</strong>. INFO_CONFIGURATION4 Current Local and Master values for PHP
               directives.  See also <strong>ini_get()</strong>. INFO_MODULES8 Loaded modules and their respective
               settings.  See also <strong>get_loaded_extensions()</strong>. INFO_ENVIRONMENT16 Environment Variable
               information that's also available in $_ENV. INFO_VARIABLES32 Shows all  predefined
               variables from EGPCS (Environment, GET, POST, Cookie, Server). INFO_LICENSE64 PHP
               License information.  See also the license FAQ. INFO_ALL-1 Shows all of the above.

<comment>Return:</comment>
  <info>true</info>  Sempre retorna <info>true</info>.

<comment>See Also:</comment>
   * <strong>phpversion()</strong>
   * <strong>phpcredits()</strong>
   * <strong>ini_get()</strong>
   * <strong>ini_set()</strong>
   * <strong>get_loaded_extensions()</strong>
   * Predefined Variables


id: phpversion
type: function
doc:
<comment>Description:</comment>
  Gets the current PHP version
  
  Returns a string containing the version of the currently running PHP parser or extension.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$extension</strong>  An optional extension name.

<comment>Return:</comment>
  <info>string|false</info>  Returns the current PHP version as a <info>string</info>. If a <info>string</info> argument is provided for
                <strong>$extension</strong> parameter, <strong>phpversion()</strong> returns the version of that extension, or <info>false</info>
                if there is no version information associated or the extension isn't enabled.

<comment>See Also:</comment>
   * PHP_VERSION constants
   * <strong>version_compare()</strong>
   * <strong>phpinfo()</strong>
   * <strong>phpcredits()</strong>
   * <strong>zend_version()</strong>


id: pi
type: function
doc:
<comment>Description:</comment>
  Obtém o valor de pi
  
  Retorna uma aproximação de pi. Alternativamente, pode-se usar a constante <info>M_PI</info> que fornece
  resultado idêntico a <strong>pi()</strong>.

<comment>Return:</comment>
  <info>float</info>  O valor de pi como float.


id: png2wbmp
type: function
doc:
<comment>Description:</comment>
  Convert PNG image file to WBMP image file
  
  Converts a PNG file into a WBMP file.

<comment>Param:</comment>
  <info>string</info>  <strong>$pngname</strong>      Path to PNG file.
  <info>string</info>  <strong>$wbmpname</strong>     Path to destination WBMP file.
  <info>int</info>     <strong>$dest_height</strong>  Destination image height.
  <info>int</info>     <strong>$dest_width</strong>   Destination image width.
  <info>int</info>     <strong>$threshold</strong>    Threshold value, between 0 and 8 (inclusive).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
        
        Entretanto, se a biblioteca libgd falhar ao gerar a imagem, esta função retornará <info>true</info>.

<comment>See Also:</comment>
   * <strong>jpeg2wbmp()</strong>


id: popen
type: function
doc:
<comment>Description:</comment>
  Abre um processo como ponteiro de arquivo
  
  Abre uma pipe para um processo executado ao se dar um fork para o comando dado por <strong>$command</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  O comando
  <info>string</info>  <strong>$mode</strong>     O modo. Pode ser <return>'r'</return> para leitura ou <return>'w'</return> para escrita.
                    
                    No Windows, o padrão de <strong>popen()</strong> é modo texto, isto é, qualquer caractere <return>\n</return>
                    escrito ou lido do tubo será traduzido para <return>\r\n</return>. Se isto não for desejado, o
                    modo binário pode ser forçado definindo-se o <strong>$mode</strong> para <return>'rb'</return> e <return>'wb'</return>,
                    respectivamente.

<comment>Return:</comment>
  <info>resource|false</info>  Retorna um ponteiro de arquivo idêntico ao retornado por <strong>fopen()</strong>, exceto que ele é
                  unidirecional (pode ser usado somente para leitura ou gravação) e tem que ser
                  fechado com <strong>pclose()</strong>. Este ponteiro pode ser usado com <strong>fgets()</strong>, <strong>fgetss()</strong> e
                  <strong>fwrite()</strong>. Quando o modo é 'r', o ponteiro de arquivo retornado é igual ao STDOUT
                  do comando; quando o modo é 'w', o ponteiro de arquivo é igual ao STDIN do
                  comando.
                  
                  Se um erro ocorrer, retorna <info>false</info>.

<comment>See Also:</comment>
   * <strong>pclose()</strong>
   * <strong>fopen()</strong>
   * <strong>proc_open()</strong>


id: pos
type: function
doc:
<comment>Description:</comment>
  Sinônimo de current
  
  Esta função é um apelido para:  <strong>current()</strong>


id: posix_access
type: function
doc:
<comment>Description:</comment>
  Determine accessibility of a file
    
  
  <strong>posix_access()</strong> checks the user's permission of a file.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The name of the file to be tested.
  <info>int</info>     <strong>$flags</strong>     A mask consisting of one or more of <info>POSIX_F_OK</info>, <info>POSIX_R_OK</info>, <info>POSIX_W_OK</info> and
                     <info>POSIX_X_OK</info>.
                     
                     <info>POSIX_R_OK</info>, <info>POSIX_W_OK</info> and <info>POSIX_X_OK</info> request checking whether the file exists
                     and has read, write and execute permissions, respectively. <info>POSIX_F_OK</info> just
                     requests checking for the existence of the file.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>posix_get_last_error()</strong>
   * <strong>posix_strerror()</strong>


id: posix_ctermid
type: function
doc:
<comment>Description:</comment>
  Get path name of controlling terminal
  
  Generates a <info>string</info> which is the pathname for the current  controlling terminal for the process.
  On error this will set errno,  which can be checked using <strong>posix_get_last_error()</strong>

<comment>Return:</comment>
  <info>string|false</info>  Upon successful completion, returns <info>string</info> of the pathname to  the current
                controlling terminal.  Otherwise <info>false</info> is returned and errno is set, which can be
                checked with <strong>posix_get_last_error()</strong>.

<comment>See Also:</comment>
   * <strong>posix_ttyname()</strong>
   * <strong>posix_get_last_error()</strong>


id: posix_eaccess
type: function
doc:
<comment>Description:</comment>
  Determine accessibility of a file
    
  
  <strong>posix_eaccess()</strong> checks the effective user's permission of a file

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The name of a file to be tested.
  <info>int</info>     <strong>$flags</strong>     A mask consisting of one or more of <info>POSIX_F_OK</info>, <info>POSIX_R_OK</info>, <info>POSIX_W_OK</info> and
                     <info>POSIX_X_OK</info>.
                     
                     <info>POSIX_R_OK</info>, <info>POSIX_W_OK</info> and <info>POSIX_X_OK</info> request checking whether the file exists
                     and has read, write and execute permissions, respectively. <info>POSIX_F_OK</info> just
                     requests checking for the existence of the file.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>posix_get_last_error()</strong>
   * <strong>posix_strerror()</strong>
   * <strong>posix_access()</strong>


id: posix_errno
type: function
doc:
<comment>Description:</comment>
  Sinônimo de posix_get_last_error
  
  Esta função é um apelido para:  <strong>posix_get_last_error()</strong>.


id: posix_fpathconf
type: function
doc:
<comment>Description:</comment>
  Returns the value of a configurable limit
  
  Returns the value of a configurable limit from <strong>$name</strong> for a file descriptor <strong>$resource</strong>

<comment>Param:</comment>
  <info>resource|int</info>  <strong>$file_descriptor</strong>  O descritor de arquivo, que deve ser um <info>resource</info> de arquivo ou um
                                  <info>int</info>. Um <info>int</info> será interpretado como um descritor de arquivo que
                                  pode ser passado diretamente para a chamada de sistema subjacente.
  <info>int</info>           <strong>$name</strong>             The name of the configurable limit, one of the following.
                                  <info>POSIX_PC_LINK_MAX</info>, <info>POSIX_PC_MAX_CANON</info> <info>POSIX_PC_MAX_INPUT</info>,
                                  <info>POSIX_PC_NAME_MAX</info> <info>POSIX_PC_PATH_MAX</info>, <info>POSIX_PC_PIPE_BUF</info>
                                  <info>POSIX_PC_CHOWN_RESTRICTED</info>, <info>POSIX_PC_NO_TRUNC</info>
                                  <info>POSIX_PC_ALLOC_SIZE_MIN</info>, <info>POSIX_PC_SYMLINK_MAX</info>

<comment>Return:</comment>
  <info>int|false</info>  Returns the configurable limit or <info>false</info>.

<comment>See Also:</comment>
   * <strong>posix_pathconf()</strong>


id: posix_get_last_error
type: function
doc:
<comment>Description:</comment>
  Retrieve the error number set by the last posix function that failed
  
  Retrieve the error number set by the last posix function that failed. The system error message
  associated with the errno may be checked with <strong>posix_strerror()</strong>.

<comment>Return:</comment>
  <info>int</info>  Returns the errno (error number) set by the last posix function that failed.  If no errors
       exist, 0 is returned.

<comment>See Also:</comment>
   * <strong>posix_strerror()</strong>


id: posix_getcwd
type: function
doc:
<comment>Description:</comment>
  Pathname of current directory
  
  Gets the absolute pathname of the script's current working directory. On error, it sets errno
  which can be checked using <strong>posix_get_last_error()</strong>

<comment>Return:</comment>
  <info>string|false</info>  Returns a <info>string</info> of the absolute pathname on success.   On error, returns <info>false</info> and
                sets errno which can be checked with <strong>posix_get_last_error()</strong>.


id: posix_getegid
type: function
doc:
<comment>Description:</comment>
  Return the effective group ID of the current process
  
  Return the numeric effective group ID of the current process.

<comment>Return:</comment>
  <info>int</info>  Returns an <info>int</info> of the effective group ID.

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getgid()</strong>
   * <strong>posix_setgid()</strong>


id: posix_geteuid
type: function
doc:
<comment>Description:</comment>
  Return the effective user ID of the current process
  
  Return the numeric effective user ID of the current process. See also <strong>posix_getpwuid()</strong> for
  information on how to convert this into a useable username.

<comment>Return:</comment>
  <info>int</info>  Returns the user id, as an <info>int</info>

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * <strong>posix_getuid()</strong>
   * <strong>posix_setuid()</strong>
   * POSIX man page GETEUID(2)


id: posix_getgid
type: function
doc:
<comment>Description:</comment>
  Return the real group ID of the current process
  
  Return the numeric real group ID of the current process.

<comment>Return:</comment>
  <info>int</info>  Returns the real group id, as an <info>int</info>.

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getegid()</strong>
   * <strong>posix_setgid()</strong>
   * POSIX man page GETGID(2)


id: posix_getgrgid
type: function
doc:
<comment>Description:</comment>
  Return info about a group by group id
  
  Gets information about a group provided its id.

<comment>Param:</comment>
  <info>int</info>  <strong>$group_id</strong>  The group id.

<comment>Return:</comment>
  <info>array|false</info>  The array elements returned are: The group information arrayElementDescriptionname
               The name element contains the name of the group. This is a short, usually less than
               16 character "handle" of the group, not the real, full name. passwd The passwd
               element contains the group's password in an encrypted format. Often, for example on a
               system employing "shadow" passwords, an asterisk is returned instead. gid Group ID,
               should be the same as the <strong>$group_id</strong> parameter used when calling the function, and
               hence redundant. members This consists of an <info>array</info> of <info>string</info>'s for all the members in
               the group.  The function returns <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>posix_getegid()</strong>
   * <strong>posix_getgrnam()</strong>
   * <strong>filegroup()</strong>
   * <strong>stat()</strong>
   * POSIX man page GETGRNAM(3)


id: posix_getgrnam
type: function
doc:
<comment>Description:</comment>
  Return info about a group by name
  
  Gets information about a group provided its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the group

<comment>Return:</comment>
  <info>array|false</info>  Returns an <info>array</info> on success,  ou <info>false</info> em caso de falha. The array elements returned
               are: The group information arrayElementDescriptionname The name element contains the
               name of the group. This is a short, usually less than 16 character "handle" of the
               group, not the real, full name.  This should be the same as the <strong>$name</strong> parameter used
               when calling the function, and hence redundant. passwd The passwd element contains
               the group's password in an encrypted format. Often, for example on a system employing
               "shadow" passwords, an asterisk is returned instead. gid Group ID of the group in
               numeric form. members This consists of an <info>array</info> of <info>string</info>'s for all the members in
               the group.

<comment>See Also:</comment>
   * <strong>posix_getegid()</strong>
   * <strong>posix_getgrgid()</strong>
   * <strong>filegroup()</strong>
   * <strong>stat()</strong>
   * POSIX man page GETGRNAM(3)


id: posix_getgroups
type: function
doc:
<comment>Description:</comment>
  Return the group set of the current process
  
  Gets the group set of the current process.

<comment>Return:</comment>
  <info>array|false</info>  Returns an array of integers containing the numeric group ids of the group set of the
               current process,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>


id: posix_getlogin
type: function
doc:
<comment>Description:</comment>
  Return login name
  
  Returns the login name of the user owning the current process.

<comment>Return:</comment>
  <info>string|false</info>  Returns the login name of the user, as a <info>string</info>,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>posix_getpwnam()</strong>
   * POSIX man page GETLOGIN(3)


id: posix_getpgid
type: function
doc:
<comment>Description:</comment>
  Get process group id for job control
  
  Returns the process group identifier of the process <strong>$process_id</strong> ou <info>false</info> em caso de falha.

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>  The process id.

<comment>Return:</comment>
  <info>int|false</info>  Returns the identifier, as an <info>int</info>.

<comment>See Also:</comment>
   * <strong>posix_getppid()</strong>
   * man page SETPGID(2)


id: posix_getpgrp
type: function
doc:
<comment>Description:</comment>
  Return the current process group identifier
  
  Return the process group identifier of the current process.

<comment>Return:</comment>
  <info>int</info>  Returns the identifier, as an <info>int</info>.

<comment>See Also:</comment>
   * POSIX.1 and the getpgrp(2) manual page on the POSIX system for
     more information on process groups.


id: posix_getpid
type: function
doc:
<comment>Description:</comment>
  Return the current process identifier
  
  Return the process identifier of the current process.

<comment>Return:</comment>
  <info>int</info>  Returns the identifier, as an <info>int</info>.

<comment>See Also:</comment>
   * <strong>posix_kill()</strong>
   * POSIX man page GETPID(2)


id: posix_getppid
type: function
doc:
<comment>Description:</comment>
  Return the parent process identifier
  
  Return the process identifier of the parent process of the current process.

<comment>Return:</comment>
  <info>int</info>  Returns the identifier, as an <info>int</info>.


id: posix_getpwnam
type: function
doc:
<comment>Description:</comment>
  Return info about a user by username
  
  Returns an <info>array</info> of information about the given user.

<comment>Param:</comment>
  <info>string</info>  <strong>$username</strong>  An alphanumeric username.

<comment>Return:</comment>
  <info>array|false</info>  On success an array with the following elements is returned, else  <info>false</info> is returned:
               The user information arrayElementDescriptionname The name element contains the
               username of the user. This is a short, usually less than 16 character "handle" of the
               user, not the real, full name. This should be the same as the <strong>$username</strong> parameter
               used when calling the function, and hence redundant. passwd The passwd element
               contains the user's password in an encrypted format. Often, for example on a system
               employing "shadow" passwords, an asterisk is returned instead. uid User ID of the
               user in numeric form. gid The group ID of the user. Use the function <strong>posix_getgrgid()</strong>
               to resolve the group name and a list of its members. gecos GECOS is an obsolete term
               that refers to the finger information field on a Honeywell batch processing system.
               The field, however, lives on, and its contents have been formalized by POSIX. The
               field contains a comma separated list containing the user's full name, office phone,
               office number, and home phone number. On most systems, only the user's full name is
               available. dir This element contains the absolute path to the home directory of the
               user. shell The shell element contains the absolute path to the executable of the
               user's default shell.

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * POSIX man page GETPWNAM(3)


id: posix_getpwuid
type: function
doc:
<comment>Description:</comment>
  Return info about a user by user id
  
  Returns an <info>array</info> of information about the user  referenced by the given user ID.

<comment>Param:</comment>
  <info>int</info>  <strong>$user_id</strong>  The user identifier.

<comment>Return:</comment>
  <info>array|false</info>  Returns an associative array with the following elements: The user information
               arrayElementDescriptionname The name element contains the username of the user. This
               is a short, usually less than 16 character "handle" of the user, not the real, full
               name. passwd The passwd element contains the user's password in an encrypted format.
               Often, for example on a system employing "shadow" passwords, an asterisk is returned
               instead. uid User ID, should be the same as the <strong>$user_id</strong> parameter used when calling
               the function, and hence redundant. gid The group ID of the user. Use the function
               <strong>posix_getgrgid()</strong> to resolve the group name and a list of its members. gecos GECOS is
               an obsolete term that refers to the finger information field on a Honeywell batch
               processing system. The field, however, lives on, and its contents have been
               formalized by POSIX. The field contains a comma separated list containing the user's
               full name, office phone, office number, and home phone number. On most systems, only
               the user's full name is available. dir This element contains the absolute path to the
               home directory of the user. shell The shell element contains the absolute path to the
               executable of the user's default shell.  The function returns <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>posix_getpwnam()</strong>
   * POSIX man page GETPWNAM(3)


id: posix_getrlimit
type: function
doc:
<comment>Description:</comment>
  Return info about system resource limits
  
  <strong>posix_getrlimit()</strong> returns an <info>array</info> of information about the current resource's soft and hard
  limits.
  
  Cada recurso tem um limite flexível e um limite rígido associado. O limite flexível é o valor que
  o kernel impõe ao recurso correspondente. O limite rígido funciona com um teto máximo para o
  limite flexível. Um processo sem privilégios pode apenas definir seu limite flexível para um valor
  entre 0 e o limite rígido e reduzir irreversivelmente seu limite rígido.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$resource</strong>  If <info>null</info> all resource limits will be fetched. Otherwise, the only limits of
                       the resource type provided will be returned.

<comment>Return:</comment>
  <info>array|false</info>  Returns an associative <info>array</info> of elements for each limit that is defined. Each limit
               has a soft and a hard limit. List of possible limits returnedLimit nameLimit
               descriptioncore The maximum size of the core file.  When 0, not core files are
               created.  When core files are larger than this size, they will be truncated at this
               size. totalmem The maximum size of the memory of the process, in bytes. virtualmem
               The maximum size of the virtual memory for the process, in bytes. data The maximum
               size of the data segment for the process, in bytes. stack The maximum size of the
               process stack, in bytes. rss The maximum number of virtual pages resident in RAM
               maxproc The maximum number of processes that can be created for the real user ID of
               the calling process. memlock The maximum number of bytes of memory that may be locked
               into RAM. cpu The amount of time the process is allowed to use the CPU. filesize The
               maximum size of the data segment for the process, in bytes. openfiles One more than
               the maximum number of open file descriptors.  The function returns <info>false</info> on failure.

<comment>See Also:</comment>
   * man page GETRLIMIT(2)
   * <strong>posix_setrlimit()</strong>


id: posix_getsid
type: function
doc:
<comment>Description:</comment>
  Get the current sid of the process
  
  Return the session id of the process <strong>$process_id</strong>. The session id of a process is the process group
  id of the session leader.

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>  The process identifier. If set to 0, the current process is assumed.  If an
                    invalid <strong>$process_id</strong> is specified, then <info>false</info> is returned and an error is set
                    which can be checked with <strong>posix_get_last_error()</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Returns the identifier, as an <info>int</info>,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>posix_getpgid()</strong>
   * <strong>posix_setsid()</strong>
   * POSIX man page GETSID(2)


id: posix_getuid
type: function
doc:
<comment>Description:</comment>
  Return the real user ID of the current process
  
  Return the numeric real user ID of the current process.

<comment>Return:</comment>
  <info>int</info>  Returns the user id, as an <info>int</info>

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * POSIX man page GETUID(2)


id: posix_initgroups
type: function
doc:
<comment>Description:</comment>
  Calculate the group access list
  
  Calculates the group access list for the user specified in name.

<comment>Param:</comment>
  <info>string</info>  <strong>$username</strong>  The user to calculate the list for.
  <info>int</info>     <strong>$group_id</strong>  Typically the group number from the password file.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * The Unix manual page for initgroups(3).


id: posix_isatty
type: function
doc:
<comment>Description:</comment>
  Determine if a file descriptor is an interactive terminal
  
  Determines if the file descriptor <strong>$file_descriptor</strong> refers to a valid terminal type device.

<comment>Param:</comment>
  <info>resource|int</info>  <strong>$file_descriptor</strong>  O descritor de arquivo, que deve ser um <info>resource</info> de arquivo ou um
                                  <info>int</info>. Um <info>int</info> será interpretado como um descritor de arquivo que
                                  pode ser passado diretamente para a chamada de sistema subjacente.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$file_descriptor</strong> is an open descriptor connected to a terminal and <info>false</info>
        otherwise.

<comment>See Also:</comment>
   * <strong>posix_ttyname()</strong>
   * <strong>stream_isatty()</strong>


id: posix_kill
type: function
doc:
<comment>Description:</comment>
  Send a signal to a process
  
  Send the signal <strong>$signal</strong> to the process with the process identifier <strong>$process_id</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>  The process identifier.
  <info>int</info>  <strong>$signal</strong>      One of the PCNTL signals constants.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * 
     The kill(2) manual page of the POSIX system, which contains additional
     information about negative process identifiers, the special pid 0, the
     special pid -1, and the signal number 0.
    


id: posix_mkfifo
type: function
doc:
<comment>Description:</comment>
  Create a fifo special file (a named pipe)
  
  <strong>posix_mkfifo()</strong> creates a special <return>FIFO</return> file which exists in the file system and acts as a
  bidirectional communication endpoint for processes.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>     Path to the <return>FIFO</return> file.
  <info>int</info>     <strong>$permissions</strong>  The second parameter <strong>$permissions</strong> has to be given in octal notation (e.g.
                        0644). The permission of the newly created <return>FIFO</return> also depends on the setting
                        of the current <strong>umask()</strong>. The permissions of the created file are (mode &
                        ~umask).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: posix_mknod
type: function
doc:
<comment>Description:</comment>
  Create a special or ordinary file (POSIX.1)
    
  
  Creates a special or ordinary file.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The file to create
  <info>int</info>     <strong>$flags</strong>     This parameter is constructed by a bitwise OR between file type (one of the
                     following constants: <info>POSIX_S_IFREG</info>, <info>POSIX_S_IFCHR</info>, <info>POSIX_S_IFBLK</info>, <info>POSIX_S_IFIFO</info>
                     or <info>POSIX_S_IFSOCK</info>) and permissions.
  <info>int</info>     <strong>$major</strong>     The major device kernel identifier (required to pass when using <info>S_IFCHR</info> or
                     <info>S_IFBLK</info>).
  <info>int</info>     <strong>$minor</strong>     The minor device kernel identifier.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>posix_mkfifo()</strong>


id: posix_pathconf
type: function
doc:
<comment>Description:</comment>
  Returns the value of a configurable limit
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Returns the value of a configurable limit from <strong>$name</strong> for a <strong>$file</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  The name of the file whose limit you want to get.
  <info>int</info>     <strong>$name</strong>  The name of the configurable limit, one of the following. <info>POSIX_PC_LINK_MAX</info>,
                 <info>POSIX_PC_MAX_CANON</info> <info>POSIX_PC_MAX_INPUT</info>, <info>POSIX_PC_NAME_MAX</info> <info>POSIX_PC_PATH_MAX</info>,
                 <info>POSIX_PC_PIPE_BUF</info> <info>POSIX_PC_CHOWN_RESTRICTED</info>, <info>POSIX_PC_NO_TRUNC</info>
                 <info>POSIX_PC_ALLOC_SIZE_MIN</info>, <info>POSIX_PC_SYMLINK_MAX</info>

<comment>Return:</comment>
  <info>int|false</info>  Returns the configurable limit or <info>false</info>.

<comment>See Also:</comment>
   * <strong>posix_fpathconf()</strong>


id: posix_setegid
type: function
doc:
<comment>Description:</comment>
  Set the effective GID of the current process
  
  Set the effective group ID of the current process. This is a privileged function and needs
  appropriate privileges (usually root) on the system to be able to perform this function.

<comment>Param:</comment>
  <info>int</info>  <strong>$group_id</strong>  The group id.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getgid()</strong>
   * <strong>posix_setgid()</strong>


id: posix_seteuid
type: function
doc:
<comment>Description:</comment>
  Set the effective UID of the current process
  
  Set the effective user ID of the current process. This is a privileged function and needs
  appropriate privileges (usually root) on the system to be able to perform this function.

<comment>Param:</comment>
  <info>int</info>  <strong>$user_id</strong>  The user id.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>posix_geteuid()</strong>
   * <strong>posix_setuid()</strong>
   * <strong>posix_getuid()</strong>


id: posix_setgid
type: function
doc:
<comment>Description:</comment>
  Set the GID of the current process
  
  Set the real group ID of the current process. This is a privileged function and needs appropriate
  privileges (usually root) on the system to be able to perform this function. The appropriate order
  of function calls is <strong>posix_setgid()</strong> first, <strong>posix_setuid()</strong> last.
  
  If the caller is a super user, this will also set the effective group id.

<comment>Param:</comment>
  <info>int</info>  <strong>$group_id</strong>  The group id.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getgid()</strong>


id: posix_setpgid
type: function
doc:
<comment>Description:</comment>
  Set process group id for job control
  
  Let the process <strong>$process_id</strong> join the process group <strong>$process_group_id</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>        The process id.
  <info>int</info>  <strong>$process_group_id</strong>  The process group id.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * 
     See POSIX.1 and the setsid(2) manual page on the POSIX system for more
     information on process groups and job control.
    


id: posix_setrlimit
type: function
doc:
<comment>Description:</comment>
  Set system resource limits
  
  <strong>posix_setrlimit()</strong> sets the soft and hard limits for a given system resource.
  
  Cada recurso tem um limite flexível e um limite rígido associado. O limite flexível é o valor que
  o kernel impõe ao recurso correspondente. O limite rígido funciona com um teto máximo para o
  limite flexível. Um processo sem privilégios pode apenas definir seu limite flexível para um valor
  entre 0 e o limite rígido e reduzir irreversivelmente seu limite rígido.

<comment>Param:</comment>
  <info>int</info>  <strong>$resource</strong>    The resource limit constant corresponding to the limit that is being set.
  <info>int</info>  <strong>$soft_limit</strong>  The soft limit, in whatever unit the resource limit requires, or
                    <info>POSIX_RLIMIT_INFINITY</info>.
  <info>int</info>  <strong>$hard_limit</strong>  The hard limit, in whatever unit the resource limit requires, or
                    <info>POSIX_RLIMIT_INFINITY</info>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * man page SETRLIMIT(2)
   * <strong>posix_getrlimit()</strong>


id: posix_setsid
type: function
doc:
<comment>Description:</comment>
  Make the current process a session leader
  
  Make the current process a session leader.

<comment>Return:</comment>
  <info>int</info>  Returns the session id, or -1 on errors.

<comment>See Also:</comment>
   * 
     The POSIX.1 and the setsid(2) manual page on the POSIX system for more
     information on process groups and job control.
    


id: posix_setuid
type: function
doc:
<comment>Description:</comment>
  Set the UID of the current process
  
  Set the real user ID of the current process. This is a privileged function that needs appropriate
  privileges (usually root) on the system to be able to perform this function.

<comment>Param:</comment>
  <info>int</info>  <strong>$user_id</strong>  The user id.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>posix_setgid()</strong>
   * <strong>posix_seteuid()</strong>
   * <strong>posix_getuid()</strong>
   * <strong>posix_geteuid()</strong>


id: posix_strerror
type: function
doc:
<comment>Description:</comment>
  Retrieve the system error message associated with the given errno
  
  Returns the POSIX system error message associated with the given <strong>$error_code</strong>.  You may get the
  <strong>$error_code</strong> parameter by calling <strong>posix_get_last_error()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$error_code</strong>  A POSIX error number, returned by  <strong>posix_get_last_error()</strong>. If set to 0, then the
                    string "Success" is returned.

<comment>Return:</comment>
  <info>string</info>  Returns the error message, as a string.

<comment>See Also:</comment>
   * <strong>posix_get_last_error()</strong>


id: posix_sysconf
type: function
doc:
<comment>Description:</comment>
  Returns system runtime information
  
  Returns system runtime information.

<comment>Param:</comment>
  <info>int</info>  <strong>$conf_id</strong>  Identifier of the variable with the following constants <info>POSIX_SC_ARG_MAX</info>,
                 <info>POSIX_SC_PAGESIZE</info> <info>POSIX_SC_NPROCESSORS_CONF</info>, <info>POSIX_SC_NPROCESSORS_ONLN</info>

<comment>Return:</comment>
  <info>int</info>  Returns the numeric value related to <strong>$conf_id</strong>


id: posix_times
type: function
doc:
<comment>Description:</comment>
  Get process times
  
  Gets information about the current CPU usage.

<comment>Return:</comment>
  <info>array|false</info>  Returns a hash of strings with information about the current process CPU usage. The
               indices of the hash are:  ticks - the number of clock ticks that have elapsed since
               reboot.  utime - user time used by the current process.  stime - system time used by
               the current process.  cutime - user time used by current process and children.
               cstime - system time used by current process and children.  The function returns
               <info>false</info> on failure.
               
               ticks - the number of clock ticks that have elapsed since reboot.
               
               utime - user time used by the current process.
               
               stime - system time used by the current process.
               
               cutime - user time used by current process and children.
               
               cstime - system time used by current process and children.


id: posix_ttyname
type: function
doc:
<comment>Description:</comment>
  Determine terminal device name
  
  Returns a <info>string</info> for the absolute path to the current terminal device that is open on the file
  descriptor <strong>$file_descriptor</strong>.

<comment>Param:</comment>
  <info>resource|int</info>  <strong>$file_descriptor</strong>  O descritor de arquivo, que deve ser um <info>resource</info> de arquivo ou um
                                  <info>int</info>. Um <info>int</info> será interpretado como um descritor de arquivo que
                                  pode ser passado diretamente para a chamada de sistema subjacente.

<comment>Return:</comment>
  <info>string|false</info>  On success, returns a <info>string</info> of the absolute path of the <strong>$file_descriptor</strong>. On
                failure, returns <info>false</info>

<comment>See Also:</comment>
   * <strong>posix_isatty()</strong>
   * <strong>stream_isatty()</strong>


id: posix_uname
type: function
doc:
<comment>Description:</comment>
  Get system name
  
  Gets information about the system.
  
  Posix requires that assumptions must not be made about the format of the values, e.g. the
  assumption that a release may contain three digits or anything else returned by this function.

<comment>Return:</comment>
  <info>array|false</info>  Returns a hash of strings with information about the system. The indices of the hash
               are  sysname - operating system name (e.g. Linux)  nodename - system name (e.g.
               valiant)  release - operating system release (e.g. 2.2.10)  version - operating
               system version (e.g. #4 Tue Jul 20 17:01:36 MEST 1999)  machine - system architecture
               (e.g. i586)  domainname - DNS domainname (e.g. example.com)
               
               sysname - operating system name (e.g. Linux)
               
               nodename - system name (e.g. valiant)
               
               release - operating system release (e.g. 2.2.10)
               
               version - operating system version (e.g. #4 Tue Jul 20 17:01:36 MEST 1999)
               
               machine - system architecture (e.g. i586)
               
               domainname - DNS domainname (e.g. example.com)
               
               domainname is a GNU extension and not part of POSIX.1, so this field is only
               available on GNU systems or when using the GNU libc.
               
               The function returns <info>false</info> on failure.


id: pow
type: function
doc:
<comment>Description:</comment>
  Expressão exponencial
  
  Retorna <strong>$num</strong> elevado à porência de <strong>$exponent</strong>.
  
  É possível usar o operador ** no lugar desta função.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$num</strong>       A base a ser usada
  <info>mixed</info>  <strong>$exponent</strong>  O expoente

<comment>Return:</comment>
  <info>int|float|object</info>  <strong>$num</strong> elevado à potência de <strong>$exponent</strong>. Se ambos os valores forem inteiros não
                    negativos e o resultado puder ser representado como um inteiro, o resultado será
                    retornado com o tipo <info>int</info>, caso contrário será retornado como um <info>float</info>.

<comment>See Also:</comment>
   * <strong>exp()</strong>
   * <strong>sqrt()</strong>
   * <strong>bcpow()</strong>
   * <strong>gmp_pow()</strong>


id: preg_filter
type: function
doc:
<comment>Description:</comment>
  Perform a regular expression search and replace
  
  <strong>preg_filter()</strong> is identical to <strong>preg_replace()</strong> except it only returns the (possibly transformed)
  subjects where there was a match. For details about how this function works, read the
  <strong>preg_replace()</strong> documentation.

<comment>Return:</comment>
  <info>string|array|null</info>  Returns an <info>array</info> if the <strong>$subject</strong> parameter is an <info>array</info>, or a <info>string</info> otherwise.
                     
                     If no matches are found or an error occurred, an empty <info>array</info>  is returned when
                     <strong>$subject</strong> is an <info>array</info> or <info>null</info> otherwise.

<comment>See Also:</comment>
   * PCRE Patterns
   * <strong>preg_quote()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_replace_callback()</strong>
   * <strong>preg_grep()</strong>
   * <strong>preg_last_error()</strong>


id: preg_grep
type: function
doc:
<comment>Description:</comment>
  Return array entries that match the pattern
  
  Returns the array consisting of the elements of the  <strong>$array</strong> array that match the given <strong>$pattern</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  The pattern to search for, as a string.
  <info>array</info>   <strong>$array</strong>    The input array.
  <info>int</info>     <strong>$flags</strong>    If set to <info>PREG_GREP_INVERT</info>, this function returns the elements of the input
                    array that do not match the given <strong>$pattern</strong>.

<comment>Return:</comment>
  <info>array|false</info>  Returns an array indexed using the keys from the <strong>$array</strong> array,  ou <info>false</info> em caso de
               falha.

<comment>See Also:</comment>
   * PCRE Patterns
   * <strong>preg_quote()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_filter()</strong>
   * <strong>preg_last_error()</strong>


id: preg_last_error
type: function
doc:
<comment>Description:</comment>
  Retorna o código de erro da última expressão regular PCRE executada
  
  Retorna o código de erro da última expressão regular PCRE executada.
  
  Exemplo de <strong>preg_last_error()</strong>
  ]]>O exemplo acima produzirá:
  
  O exemplo acima produzirá:

<comment>Return:</comment>
  <info>int</info>  Retorna uma das seguintes constantes (explicadas em sua própria página):
       <info>PREG_NO_ERROR</info><info>PREG_INTERNAL_ERROR</info><info>PREG_BACKTRACK_LIMIT_ERROR</info> (veja também
       pcre.backtrack_limit)<info>PREG_RECURSION_LIMIT_ERROR</info> (veja também
       pcre.recursion_limit)<info>PREG_BAD_UTF8_ERROR</info><info>PREG_BAD_UTF8_OFFSET_ERROR</info><info>PREG_JIT_STACKLIMIT_ERROR</info>

<comment>See Also:</comment>
   * <strong>preg_last_error_msg()</strong>


id: preg_last_error_msg
type: function
doc:
<comment>Description:</comment>
  Returns the error message of the last PCRE regex execution
  
  Returns the error message of the last PCRE regex execution.

<comment>Return:</comment>
  <info>string</info>  Returns the error message on success, or <return>"No error"</return> if no error has occurred.

<comment>See Also:</comment>
   * <strong>preg_last_error()</strong>


id: preg_match
type: function
doc:
<comment>Description:</comment>
  Perform a regular expression match
  
  Searches <strong>$subject</strong> for a match to the regular expression given in <strong>$pattern</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  The pattern to search for, as a string.
  <info>string</info>  <strong>$subject</strong>  The input string.
  <info>array</info>   <strong>$matches</strong>  If <strong>$matches</strong> is provided, then it is filled with the results of search.
                    $matches[0] will contain the text that matched the full pattern, $matches[1]
                    will have the text that matched the first captured parenthesized subpattern, and
                    so on.
  <info>int</info>     <strong>$flags</strong>    <strong>$flags</strong> can be a combination of the following flags: <info>PREG_OFFSET_CAPTURE</info> If this
                    flag is passed, for every occurring match the appendant string offset (in bytes)
                    will also be returned. Note that this changes the value of <strong>$matches</strong> into an
                    array where every element is an array consisting of the matched string at offset
                    <return>0</return> and its string offset into <strong>$subject</strong> at offset <return>1</return>.
                    ]]>O exemplo acima produzirá: Array ( [0] => foobarbaz [1] => 0 )
                     [1] => Array ( [0] => foo [1] => 0 )
                     [2] => Array ( [0] => bar [1] => 3 )
                     [3] => Array ( [0] => baz [1] => 6 )
                    
                    )
                    ]]> <info>PREG_UNMATCHED_AS_NULL</info> If this flag is passed, unmatched subpatterns are
                    reported as <info>null</info>; otherwise they are reported as an empty <info>string</info>.
                    ]]>O exemplo acima produzirá: string(2) "ac" [1]=> string(1) "a" [2]=> string(0)
                    "" [3]=> string(1) "c"
                    }
                    array(4) { [0]=> string(2) "ac" [1]=> string(1) "a" [2]=> NULL [3]=> string(1)
                    "c"
                    }
                    ]]> 
                    
                    If this flag is passed, for every occurring match the appendant string offset
                    (in bytes) will also be returned. Note that this changes the value of <strong>$matches</strong>
                    into an array where every element is an array consisting of the matched string
                    at offset <return>0</return> and its string offset into <strong>$subject</strong> at offset <return>1</return>.
                    ]]>O exemplo acima produzirá: Array ( [0] => foobarbaz [1] => 0 )
                     [1] => Array ( [0] => foo [1] => 0 )
                     [2] => Array ( [0] => bar [1] => 3 )
                     [3] => Array ( [0] => baz [1] => 6 )
                    
                    )
                    ]]>
                    
                    O exemplo acima produzirá:
                    
                    If this flag is passed, unmatched subpatterns are reported as <info>null</info>; otherwise
                    they are reported as an empty <info>string</info>.
                    ]]>O exemplo acima produzirá: string(2) "ac" [1]=> string(1) "a" [2]=> string(0)
                    "" [3]=> string(1) "c"
                    }
                    array(4) { [0]=> string(2) "ac" [1]=> string(1) "a" [2]=> NULL [3]=> string(1)
                    "c"
                    }
                    ]]>
                    
                    O exemplo acima produzirá:
  <info>array</info>   <strong>$matches</strong>  If this flag is passed, for every occurring match the appendant string offset
                    (in bytes) will also be returned. Note that this changes the value of <strong>$matches</strong>
                    into an array where every element is an array consisting of the matched string
                    at offset <return>0</return> and its string offset into <strong>$subject</strong> at offset <return>1</return>.
                    ]]>O exemplo acima produzirá: Array ( [0] => foobarbaz [1] => 0 )
                     [1] => Array ( [0] => foo [1] => 0 )
                     [2] => Array ( [0] => bar [1] => 3 )
                     [3] => Array ( [0] => baz [1] => 6 )
                    
                    )
                    ]]>
                    
                    O exemplo acima produzirá:
  <info>int</info>     <strong>$offset</strong>   Normally, the search starts from the beginning of the subject string. The
                    optional parameter <strong>$offset</strong> can be used to specify the alternate place from which
                    to start the search (in bytes).
                    
                    Using <strong>$offset</strong> is not equivalent to passing substr($subject, $offset) to
                    <strong>preg_match()</strong> in place of the subject string, because <strong>$pattern</strong> can contain
                    assertions such as ^, $ or (?\<=x). Compare:
                    ]]>O exemplo acima produzirá: while this example 
                    ]]> will produce  Array ( [0] => def [1] => 0 )
                    
                    )
                    ]]> Alternatively, to avoid using <strong>substr()</strong>, use the <return>\G</return> assertion rather than the
                    <return>^</return> anchor, or the <return>A</return> modifier instead, both of which work with the <strong>$offset</strong>
                    parameter.
                    
                    O exemplo acima produzirá:
                    
                    while this example
                    
                    will produce
                    
                    Alternatively, to avoid using <strong>substr()</strong>, use the <return>\G</return> assertion rather than the <return>^</return>
                    anchor, or the <return>A</return> modifier instead, both of which work with the <strong>$offset</strong>
                    parameter.

<comment>Return:</comment>
  <info>int|false</info>  <strong>preg_match()</strong> returns 1 if the <strong>$pattern</strong> matches given <strong>$subject</strong>, 0 if it does not, ou
             <info>false</info> em caso de falha.
             
             Esta função pode
             retornar o valor booleano <info>false</info>, mas também pode retornar um valor não booleano que
             pode ser
             avaliado como <info>false</info>. Leia a seção sobre Booleanos para mais
             informações. Use o operador
             === para testar o valor retornado por esta
             função.

<comment>See Also:</comment>
   * PCRE Patterns
   * <strong>preg_quote()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_split()</strong>
   * <strong>preg_last_error()</strong>
   * <strong>preg_last_error_msg()</strong>


id: preg_match_all
type: function
doc:
<comment>Description:</comment>
  Perform a global regular expression match
  
  Searches <strong>$subject</strong> for all matches to the regular expression given in <strong>$pattern</strong> and puts them in
  <strong>$matches</strong> in the order specified by <strong>$flags</strong>.
  
  After the first match is found, the subsequent searches  are continued on from end of the last
  match.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  The pattern to search for, as a string.
  <info>string</info>  <strong>$subject</strong>  The input string.
  <info>array</info>   <strong>$matches</strong>  Array of all matches in multi-dimensional array ordered according to <strong>$flags</strong>.
  <info>int</info>     <strong>$flags</strong>    Can be a combination of the following flags (note that it doesn't make sense to
                    use <info>PREG_PATTERN_ORDER</info> together with <info>PREG_SET_ORDER</info>): <info>PREG_PATTERN_ORDER</info> Orders
                    results so that $matches[0] is an array of full pattern matches, $matches[1] is
                    an array of strings matched by the first parenthesized subpattern, and so on.
                    ]]>O exemplo acima produzirá:example: , this is a test
                    example: , this is a test
                    ]]> So, $out[0] contains an array of strings that matched the full pattern, and
                    $out[1] contains an array of strings enclosed by tags.  If the pattern contains
                    named subpatterns, $matches additionally contains entries for keys with the
                    subpattern name.  If the pattern contains duplicate named subpatterns, only the
                    rightmost subpattern is stored in $matches[NAME].
                    ]]>O exemplo acima produzirá:  [1] => bar
                    )
                    ]]> <info>PREG_SET_ORDER</info> Orders results so that $matches[0] is an array of first set
                    of matches, $matches[1] is an array of second set of matches, and so on.
                    ]]>O exemplo acima produzirá:example: , example:
                    this is a test, this is a test
                    ]]> <info>PREG_OFFSET_CAPTURE</info> If this flag is passed, for every occurring match the
                    appendant string offset (in bytes) will also be returned. Note that this changes
                    the value of <strong>$matches</strong> into an array of arrays where every element is an array
                    consisting of the matched string at offset <return>0</return> and its string offset into <strong>$subject</strong>
                    at offset <return>1</return>.
                    ]]>O exemplo acima produzirá: Array ( [0] => Array ( [0] => foobarbaz [1] => 0 )
                     )
                     [1] => Array ( [0] => Array ( [0] => foo [1] => 0 )
                     )
                     [2] => Array ( [0] => Array ( [0] => bar [1] => 3 )
                     )
                     [3] => Array ( [0] => Array ( [0] => baz [1] => 6 )
                     )
                    
                    )
                    ]]> <info>PREG_UNMATCHED_AS_NULL</info> If this flag is passed, unmatched subpatterns are
                    reported as <info>null</info>; otherwise they are reported as an empty <info>string</info>.
                    
                    Orders results so that $matches[0] is an array of full pattern matches,
                    $matches[1] is an array of strings matched by the first parenthesized
                    subpattern, and so on.
                    
                    
                    ]]>O exemplo acima produzirá:example: , this is a test
                    example: , this is a test
                    ]]> So, $out[0] contains an array of strings that matched the full pattern, and
                    $out[1] contains an array of strings enclosed by tags.
                    
                    O exemplo acima produzirá:
                    
                    So, $out[0] contains an array of strings that matched the full pattern, and
                    $out[1] contains an array of strings enclosed by tags.
                    
                    If the pattern contains named subpatterns, $matches additionally contains
                    entries for keys with the subpattern name.
                    
                    If the pattern contains duplicate named subpatterns, only the rightmost
                    subpattern is stored in $matches[NAME].
                    ]]>O exemplo acima produzirá:  [1] => bar
                    )
                    ]]>
                    
                    O exemplo acima produzirá:
                    
                    Orders results so that $matches[0] is an array of first set of matches,
                    $matches[1] is an array of second set of matches, and so on.
                    ]]>O exemplo acima produzirá:example: , example:
                    this is a test, this is a test
                    ]]>
                    
                    O exemplo acima produzirá:
                    
                    If this flag is passed, for every occurring match the appendant string offset
                    (in bytes) will also be returned. Note that this changes the value of <strong>$matches</strong>
                    into an array of arrays where every element is an array consisting of the
                    matched string at offset <return>0</return> and its string offset into <strong>$subject</strong> at offset <return>1</return>.
                    ]]>O exemplo acima produzirá: Array ( [0] => Array ( [0] => foobarbaz [1] => 0 )
                     )
                     [1] => Array ( [0] => Array ( [0] => foo [1] => 0 )
                     )
                     [2] => Array ( [0] => Array ( [0] => bar [1] => 3 )
                     )
                     [3] => Array ( [0] => Array ( [0] => baz [1] => 6 )
                     )
                    
                    )
                    ]]>
                    
                    O exemplo acima produzirá:
                    
                    If this flag is passed, unmatched subpatterns are reported as <info>null</info>; otherwise
                    they are reported as an empty <info>string</info>.
                    
                    If no order flag is given, <info>PREG_PATTERN_ORDER</info> is assumed.
  <info>array</info>   <strong>$matches</strong>  If this flag is passed, for every occurring match the appendant string offset
                    (in bytes) will also be returned. Note that this changes the value of <strong>$matches</strong>
                    into an array of arrays where every element is an array consisting of the
                    matched string at offset <return>0</return> and its string offset into <strong>$subject</strong> at offset <return>1</return>.
                    ]]>O exemplo acima produzirá: Array ( [0] => Array ( [0] => foobarbaz [1] => 0 )
                     )
                     [1] => Array ( [0] => Array ( [0] => foo [1] => 0 )
                     )
                     [2] => Array ( [0] => Array ( [0] => bar [1] => 3 )
                     )
                     [3] => Array ( [0] => Array ( [0] => baz [1] => 6 )
                     )
                    
                    )
                    ]]>
                    
                    O exemplo acima produzirá:
  <info>int</info>     <strong>$offset</strong>   Normally, the search starts from the beginning of the subject string. The
                    optional parameter <strong>$offset</strong> can be used to specify the alternate place from which
                    to start the search (in bytes).
                    
                    Using <strong>$offset</strong> is not equivalent to passing substr($subject, $offset) to
                    <strong>preg_match_all()</strong> in place of the subject string, because <strong>$pattern</strong> can contain
                    assertions such as ^, $ or (?\<=x). See <strong>preg_match()</strong> for examples.

<comment>Return:</comment>
  <info>int|false</info>  Returns the number of full pattern matches (which might be zero), ou <info>false</info> em caso de
             falha.

<comment>See Also:</comment>
   * PCRE Patterns
   * <strong>preg_quote()</strong>
   * <strong>preg_match()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_split()</strong>
   * <strong>preg_last_error()</strong>


id: preg_quote
type: function
doc:
<comment>Description:</comment>
  Quote regular expression characters
  
  <strong>preg_quote()</strong> takes <strong>$str</strong> and puts a backslash in front of every character that is part of the
  regular expression syntax.  This is useful if you have a run-time string that you need to match in
  some text and the string may contain special regex characters.
  
  The special regular expression characters are: <return>. \ + * ? [ ^ ] $ ( ) { } = ! \< &gt; | : - #</return>
  
  Note that <return>/</return> is not a special regular expression character.
  
  Note that <strong>preg_quote()</strong> is not meant to be applied to the $replacement string(s) of <strong>preg_replace()</strong>
  etc.

<comment>Param:</comment>
  <info>string</info>       <strong>$str</strong>        The input string.
  <info>string|null</info>  <strong>$delimiter</strong>  If the optional <strong>$delimiter</strong> is specified, it will also be escaped.  This
                           is useful for escaping the delimiter that is required by the PCRE
                           functions. The <return>/</return> is the most commonly used delimiter.

<comment>Return:</comment>
  <info>string</info>  Returns the quoted (escaped) string.

<comment>See Also:</comment>
   * PCRE Patterns
   * <strong>escapeshellcmd()</strong>


id: preg_replace
type: function
doc:
<comment>Description:</comment>
  Realiza uma pesquisa por uma expressão regular e substitui
  
  Pesquisa <strong>$subject</strong> por correspondências a <strong>$pattern</strong> e substitui-as por <strong>$replacement</strong>.
  
  Para procurar correspondência por uma string exata, e não por um padrão, considere usar
  <strong>str_replace()</strong> ou <strong>str_ireplace()</strong> no lugar desta função.

<comment>Param:</comment>
  <info>string|array</info>  <strong>$pattern</strong>      O padrão a ser pesquisado. Pode ser uma string ou um array com
                              strings.
                              
                              Diversos modificadores PCRE também estão disponíveis.
  <info>string|array</info>  <strong>$replacement</strong>  A string ou array com strings para substituir. Se este parâmetro é uma
                              string e o parâmetro <strong>$pattern</strong> é um array, todos patterns vão ser
                              substituídos por esta string. Se ambos <strong>$pattern</strong> e <strong>$replacement</strong>
                              parâmetros são arrays, cada <strong>$pattern</strong> vai ser substituído pelo
                              seu<strong>$replacement</strong> correspondente. Se houver menos elementos no
                              <strong>$replacement</strong> array do que no <strong>$pattern</strong> array, qualquer <strong>$pattern</strong> extra
                              será substituído por uma string vazia.
                              
                              <strong>$replacement</strong> pode conter referências na forma <return>\n</return> ou <return>$n</return>, com a última
                              forma sendo a preferível. Cada referência desse tipo será substituída
                              pelo texto capturado pelo n-ésimo padrão entre parentêses. n pode ser
                              de 0 to 99, e <return>\0</return> ou <return>$0</return> referem-se ao texto correspondente ao padrão
                              inteiro. Parênteses de abertura são contados da esquerda para direita
                              (iniciando em 1) para obter o número do sub-padrão de captura. Note
                              que barra invertida em <info>string</info>s literais podem precisar ser escapados.
                              
                              Quando se trabalha com uma padrão de substituição, onde a referência
                              passada é imediatamente seguida por outro número (isto é, inserido um
                              número literal imediatamente após um padrão correspondente), não se
                              pode usar a habitual notação <return>\1</return> para a referência passada. <return>\11</return>, por
                              exemplo, iria confundir a função <strong>preg_replace()</strong> pois ela não saberá se
                              o desejado é a referência <return>\1</return> seguida por um literal <return>1</return>, ou a referência
                              <return>\11</return> seguida por nada. Neste caso, a solução é usar <return>${1}1</return>. Isto cria
                              uma referência <return>$1</return> isolada, deixando o <return>1</return> como um literal.
                              
                              Ao usar o modificador <return>e</return> que está defasado, esta função escapa alguns
                              caracteres (nomeadamente <return>'</return>, <return>"</return>, <return>\</return> e NULL) nas strings que substituem as
                              referências passadas. Isto é feito para garantir que nenhum erro de
                              sintaxe surja de uso de referência passada com aspas simples ou duplas
                              (por exemplo, <return>'strlen(\'$1\')+strlen("$2")'</return>). Certifique-se de estar
                              ciente da sintaxe string do PHP para ter uma visão exata de como será
                              a string interpretada.
  <info>string|array</info>  <strong>$subject</strong>      String ou um array com strings para pesquisar e substituir.
                              
                              Se <strong>$subject</strong> é um array, então a pesquisa e a substituição são
                              executadas em cada entrada do <strong>$subject</strong>, e o valor de retorno é um
                              array também.
                              
                              Se o array <strong>$subject</strong> for associativo, as chaves são preservadas no
                              valor de retorno.
  <info>int</info>           <strong>$limit</strong>        O máximo possível de substituições para cada padrão em cada string de
                              <strong>$subject</strong>. O padrão é <return>-1</return> (sem limite).
  <info>int</info>           <strong>$count</strong>        Se especificada, essa variável será preenchida com o número de
                              substiuições realizadas.

<comment>Return:</comment>
  <info>string|array|null</info>  <strong>preg_replace()</strong> retorna um array se o parâmetro <strong>$subject</strong> é um array, caso
                     contrário retorna uma string.
                     
                     Se correspondências forem encontradas, o novo <strong>$subject</strong> será devolvido, caso
                     contrário <strong>$subject</strong> será devolvido inalterado ou <info>null</info> se um erro ocorreu.

<comment>See Also:</comment>
   * Padrões PCRE
   * <strong>preg_quote()</strong>
   * <strong>preg_filter()</strong>
   * <strong>preg_match()</strong>
   * <strong>preg_replace_callback()</strong>
   * <strong>preg_split()</strong>
   * <strong>preg_last_error()</strong>
   * <strong>str_replace()</strong>


id: preg_replace_callback
type: function
doc:
<comment>Description:</comment>
  Executa uma busca por expressão regular e substitui usando uma chamada de retorno
  
  O comportamento desta função é quase idêntico ao da <strong>preg_replace()</strong>, exceto pelo fato que ao invés
  do parâmetro <strong>$replacement</strong>, deve-se especificar o parâmetro <strong>$callback</strong>.

<comment>Param:</comment>
  <info>string|array</info>  <strong>$pattern</strong>   A padrão usado para busca. Pode ser tanto uma string como um array de
                           strings.
  <info>callable</info>      <strong>$callback</strong>  Uma função de retorno que será chamada e passado um array dos elementos
                           correspondentes na string <strong>$subject</strong>. A função deve retornar a string
                           substituta. Esta é a assinatura da função de retorno:
                           
                           <info>string</info>handler<info>array</info><strong>$matches</strong>
                           
                           Normalmente será necessária uma função <strong>$callback</strong> para
                           <strong>preg_replace_callback()</strong> em apenas um lugar. Neste caso você pode-se usar
                           uma função anônima para declarar a função de retorno dentro da chamada a
                           <strong>preg_replace_callback()</strong>. Desta forma, todas as informações para a chamada
                           estarão no mesmo lugar e não polui o espaço de nomes com um nome de
                           função que não é usado em nenhum outro lugar.
                           
                           <strong>preg_replace_callback()</strong> e função anônima
                           ]]>
  <info>string|array</info>  <strong>$subject</strong>   A string ou array com strings para procurar e modificar.
  <info>int</info>           <strong>$limit</strong>     O máximo de possíveis substituições para cada padrão em cada string de
                           <strong>$subject</strong>. O padrão é <return>-1</return> (sem limite).
  <info>int</info>           <strong>$count</strong>     Se especificado, esta variável irá ser preenchida com o número de
                           substituições feitas.
  <info>int</info>           <strong>$flags</strong>     <strong>$flags</strong> pode ser uma combinação das opções <info>PREG_OFFSET_CAPTURE</info> e
                           <info>PREG_UNMATCHED_AS_NULL</info>, que influenciam o formato do array de
                           correspondências. Veja a descrição em <strong>preg_match()</strong> para mais detalhes.

<comment>Return:</comment>
  <info>string|array|null</info>  <strong>preg_replace_callback()</strong> retorna um array se o parâmetro <strong>$subject</strong> for um array,
                     ou uma string caso contrário. Em erros o valor de retorno é <info>null</info>.
                     
                     Se ocorrer correspondência, a nova string será retornada, caso contrário
                     <strong>$subject</strong> será retornada inalterada.

<comment>See Also:</comment>
   * PCRE Patterns
   * <strong>preg_replace_callback_array()</strong>
   * <strong>preg_quote()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_last_error()</strong>
   * Funções Anônimas


id: preg_replace_callback_array
type: function
doc:
<comment>Description:</comment>
  Perform a regular expression search and replace using callbacks
  
  The behavior of this function is similar to <strong>preg_replace_callback()</strong>, except that callbacks are
  executed on a per-pattern basis.

<comment>Param:</comment>
  <info>array</info>         <strong>$pattern</strong>  An associative array mapping patterns (keys) to <info>callable</info>s (values).
  <info>string|array</info>  <strong>$subject</strong>  The string or an array with strings to search and replace.
  <info>int</info>           <strong>$limit</strong>    The maximum possible replacements for each pattern in each <strong>$subject</strong>
                          string. Defaults to <return>-1</return> (no limit).
  <info>int</info>           <strong>$count</strong>    If specified, this variable will be filled with the number of replacements
                          done.
  <info>int</info>           <strong>$flags</strong>    <strong>$flags</strong> can be a combination of the <info>PREG_OFFSET_CAPTURE</info> and
                          <info>PREG_UNMATCHED_AS_NULL</info> flags, which influence the format of the matches
                          array. See the description in <strong>preg_match()</strong> for more details.

<comment>Return:</comment>
  <info>string|array|null</info>  <strong>preg_replace_callback_array()</strong> returns an array if the <strong>$subject</strong> parameter is an
                     array, or a string otherwise. On errors the return value is <info>null</info>
                     
                     If matches are found, the new subject will be returned, otherwise <strong>$subject</strong> will
                     be returned unchanged.

<comment>See Also:</comment>
   * PCRE Patterns
   * <strong>preg_replace_callback()</strong>
   * <strong>preg_quote()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_last_error()</strong>
   * Anonymous functions


id: preg_split
type: function
doc:
<comment>Description:</comment>
  Split string by a regular expression
  
  Split the given string by a regular expression.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  The pattern to search for, as a string.
  <info>string</info>  <strong>$subject</strong>  The input string.
  <info>int</info>     <strong>$limit</strong>    If specified, then only substrings up to <strong>$limit</strong> are returned with the rest of
                    the string being placed in the last substring.  A <strong>$limit</strong> of -1 or 0 means "no
                    limit".
  <info>int</info>     <strong>$flags</strong>    <strong>$flags</strong> can be any combination of the following flags (combined with the <return>|</return>
                    bitwise operator): <info>PREG_SPLIT_NO_EMPTY</info> If this flag is set, only non-empty
                    pieces will be returned by <strong>preg_split()</strong>. <info>PREG_SPLIT_DELIM_CAPTURE</info> If this flag
                    is set, parenthesized expression in the delimiter pattern will be captured and
                    returned as well. <info>PREG_SPLIT_OFFSET_CAPTURE</info> If this flag is set, for every
                    occurring match the appendant string offset will also be returned. Note that
                    this changes the return value in an array where every element is an array
                    consisting of the matched string at offset <return>0</return> and its string offset into <strong>$subject</strong>
                    at offset <return>1</return>.
                    
                    If this flag is set, only non-empty pieces will be returned by <strong>preg_split()</strong>.
                    
                    If this flag is set, parenthesized expression in the delimiter pattern will be
                    captured and returned as well.
                    
                    If this flag is set, for every occurring match the appendant string offset will
                    also be returned. Note that this changes the return value in an array where
                    every element is an array consisting of the matched string at offset <return>0</return> and its
                    string offset into <strong>$subject</strong> at offset <return>1</return>.
  <info>string</info>  <strong>$subject</strong>  If this flag is set, for every occurring match the appendant string offset will
                    also be returned. Note that this changes the return value in an array where
                    every element is an array consisting of the matched string at offset <return>0</return> and its
                    string offset into <strong>$subject</strong> at offset <return>1</return>.

<comment>Return:</comment>
  <info>array|false</info>  Returns an array containing substrings of <strong>$subject</strong> split along boundaries matched by
               <strong>$pattern</strong>,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * PCRE Patterns
   * <strong>preg_quote()</strong>
   * <strong>implode()</strong>
   * <strong>preg_match()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_last_error()</strong>


id: prev
type: function
doc:
<comment>Description:</comment>
  Retrocede o ponteiro interno de um array
  
  Retrocede o ponteiro interno do array.
  
  <strong>prev()</strong> funciona como <strong>next()</strong>, exceto que ela retrocede o ponteiro interno do array ao invés de
  avançá-lo.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  O array de entrada.

<comment>Return:</comment>
  <info>mixed</info>  Retorna o valor do array que está na posição anterior à posição apontada pelo ponteiro
         interno, ou <info>false</info> se não houver mais elementos.
         
         Esta função pode
         retornar o valor booleano <info>false</info>, mas também pode retornar um valor não booleano que pode
         ser
         avaliado como <info>false</info>. Leia a seção sobre Booleanos para mais
         informações. Use o operador
         === para testar o valor retornado por esta
         função.

<comment>See Also:</comment>
   * <strong>current()</strong>
   * <strong>end()</strong>
   * <strong>next()</strong>
   * <strong>reset()</strong>
   * <strong>each()</strong>


id: print
type: function
doc:
<comment>Description:</comment>
  Mostra uma string
  
  Mostra o conteúdo de <strong>$expression</strong>.
  
  <return>print</return> não é uma função, é uma construção de linguagem. Seu argumento é a expressão logo após da
  palavra-chave <return>print</return>, e não é delimitada por parênteses.
  
  As principais diferenças para <strong>echo()</strong> são que <return>print</return> aceita apenas um único argumento e sempre
  retorna <return>1</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$expression</strong>  A expressão a ser mostrada. Valores não-string serão convertidos
                       coercitivamente para strings, mesmo quando a diretiva <return>strict_types</return> estiver
                       habilitada.

<comment>Return:</comment>
  <info>int</info>  Retorna <return>1</return>, sempre.

<comment>See Also:</comment>
   * <strong>echo()</strong>
   * <strong>printf()</strong>
   * <strong>flush()</strong>
   * Maneiras de especificar strings literais


id: print_r
type: function
doc:
<comment>Description:</comment>
  Exibe informação legível sobre uma variável
    
  
  <strong>print_r()</strong> exibe informação sobre uma variável de uma forma legível para humanos.
  
  <strong>print_r()</strong>, <strong>var_dump()</strong> e <strong>var_export()</strong> mostrarão também propriedades protegidas e privadas de
  objetos. Membros de classes estáticas não serão mostrados.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>   A expressão a ser exibida.
  <info>bool</info>   <strong>$return</strong>  Se for desejado capturar a saída de <strong>print_r()</strong>, utilize o parâmetro <strong>$return</strong>. Quando
                  esse parâmetro for definido para <info>true</info>, <strong>print_r()</strong> retornará a informação, ao invés
                  de exibi-la.

<comment>Return:</comment>
  <info>string|bool</info>  Se for fornecido uma <info>string</info>, um <info>int</info> ou um <info>float</info>, o próprio valor será impresso. Se
               for fornecido um <info>array</info>, valores serão apresentados em um formato que mostra chaves e
               elementos. Notação similar é utilizada para objetos (<info>object</info>s).
               
               Quando o parâmetro <strong>$return</strong> for <info>true</info>, esta função retornará uma <info>string</info>. Caso
               contrário, o valor retornado será <info>true</info>.

<comment>See Also:</comment>
   * <strong>ob_start()</strong>
   * <strong>var_dump()</strong>
   * <strong>var_export()</strong>


id: printf
type: function
doc:
<comment>Description:</comment>
  Output a formatted string
  
  Produces output according to <strong>$format</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  A string de formato é composta de zero ou mais diretivas: caracteres comuns
                   (excluindo <return>%</return>) que são copiados diretamente para o resultado e especificações de
                   conversão, cada uma das quais resulta na busca de seu próprio parâmetro.
                   
                   Uma especificação de conversão segue este protótipo:
                   <return>%[argnum$][flags][width][.precision]especificador</return>.
                   
                   Um número inteiro seguido por um cifrão <return>$</return>, para especificar qual o número de
                   argumento a tratar na conversão.
                   
                   FlagsFlagDescrição<return>-</return> Justificar à esquerda dentro da largura de campo
                   especificada; A justificação à direita é o padrão. <return>+</return> Prefixa números positivos
                   com um sinal de mais <return>+</return>; Por padrão, apenas números negativos são prefixados com
                   um sinal negativo. <return> </return>(espaço) Preenche o resultado com espaços. Este é o padrão. <return>0</return>
                   Preenche números com zeros apenas à esquerda. Com os especificadores <return>s</return>, também
                   pode preencher com zeros à direita. <return>'</return>(char) Preenche o resultado com o caractere
                   (char).
                   
                   Um número inteiro que define em quantos caracteres (mínimo) esta conversão deve
                   resultar, ou <return>*</return>. Se <return>*</return> for usado, a largura será fornecida como um valor inteiro
                   adicional precedendo aquele formatado pelo especificador.
                   
                   Um ponto <return>.</return> opcionalmente seguido por um número inteiro ou <return>*</return>, cujo significado
                   depende do especificador:  Para os especificadores <return>e</return>, <return>E</return>, <return>f</return> e <return>F</return>: este é o número
                   de dígitos a serem impressos após o ponto decimal (por padrão, é 6).  Para os
                   especificadores <return>g</return>, <return>G</return>, <return>h</return> e <return>H</return>: este é o número máximo de dígitos significativos a
                   serem impressos.  Para o especificador <return>s</return>: atua como um ponto de corte, definindo
                   um limite máximo de caracteres para a string.   Se o ponto for especificado sem
                   um valor explícito para precisão, 0 é assumido. Se <return>*</return> for usado, a precisão é
                   fornecida como um valor inteiro adicional precedendo aquele formatado pelo
                   especificador.
                   
                   Para os especificadores <return>e</return>, <return>E</return>, <return>f</return> e <return>F</return>: este é o número de dígitos a serem impressos
                   após o ponto decimal (por padrão, é 6).
                   
                   Para os especificadores <return>g</return>, <return>G</return>, <return>h</return> e <return>H</return>: este é o número máximo de dígitos
                   significativos a serem impressos.
                   
                   Para o especificador <return>s</return>: atua como um ponto de corte, definindo um limite máximo
                   de caracteres para a string.
                   
                   Se o ponto for especificado sem um valor explícito para precisão, 0 é assumido.
                   Se <return>*</return> for usado, a precisão é fornecida como um valor inteiro adicional precedendo
                   aquele formatado pelo especificador.
                   
                   EspecificadoresEspecificadorDescrição<return>%</return> Um caractere literal de porcentagem.
                   Nenhum argumento é necessário. <return>b</return> O argumento é tratado como um número inteiro e
                   apresentado como um número binário. <return>c</return> O argumento é tratado como um número
                   inteiro e apresentado como o caractere com aquele código ASCII. <return>d</return> O argumento é
                   tratado como um número inteiro e apresentado como um número decimal (com sinal).
                   <return>e</return> O argumento é tratado como notação científica (por exemplo, 1.2e+2). <return>E</return> Como o
                   especificador <return>e</return>, mas usa letra maiúscula (por exemplo, 1.2E+2). <return>f</return> O argumento é
                   tratado como um float e apresentado como um número de ponto flutuante (com
                   reconhecimento da localidade). <return>F</return> O argumento é tratado como um float e
                   apresentado como um número de ponto flutuante (sem reconhecimento da localidade).
                   <return>g</return> Formato geral.  Deixa P igual à precisão se for diferente de zero, 6 se a
                   precisão for omitida, ou 1 se a precisão for zero. Então, se uma conversão com
                   estilo E tivesse um expoente de X:  Se P &gt; X ≥ −4, a conversão é com estilo f
                   e precisão P − (X + 1). Caso contrário, a conversão é com estilo e e precisão P −
                   1. <return>G</return> Como o especificador <return>g</return>, mas usa <return>E</return> e <return>f</return>. <return>h</return> Como o especificador <return>g</return>, mas usa <return>F</return>.
                   Disponível a partir do PHP 8.0.0. <return>H</return> Como o especificador <return>g</return>, mas usa <return>E</return> e <return>F</return>.
                   Disponível a partir do PHP 8.0.0. <return>o</return> O argumento é tratado como um número inteiro
                   e apresentado como um número octal. <return>s</return> O argumento é tratado e apresentado como
                   uma string. <return>u</return> O argumento é tratado como um número inteiro e apresentado como um
                   número decimal sem sinal. <return>x</return> O argumento é tratado como um número inteiro e
                   apresentado como um número hexadecimal (com letras minúsculas). <return>X</return> O argumento é
                   tratado como um número inteiro e apresentado como um número hexadecimal (com
                   letras maiúsculas).
                   
                   Formato geral.
                   
                   Deixa P igual à precisão se for diferente de zero, 6 se a precisão for omitida,
                   ou 1 se a precisão for zero. Então, se uma conversão com estilo E tivesse um
                   expoente de X:
                   
                   Se P &gt; X ≥ −4, a conversão é com estilo f e precisão P − (X + 1). Caso
                   contrário, a conversão é com estilo e e precisão P − 1.
                   
                   O especificador de tipo <return>c</return> ignora preenchimento e largura.
                   
                   Tentar usar uma combinação dos especificadores de string e largura com conjuntos
                   de caracteres que requerem mais de um byte por caractere pode resultar em
                   resultados inesperados.
                   
                   As variáveis serão forçadas a um tipo adequado para o especificador: Tratamento
                   de TiposTipoEspecificadores<info>string</info><return>s</return><info>int</info><return>d</return>, <return>u</return>, <return>c</return>, <return>o</return>, <return>x</return>, <return>X</return>, <return>b</return><info>float</info><return>e</return>, <return>E</return>, <return>f</return>, <return>F</return>, <return>g</return>, <return>G</return>, <return>h</return>,
                   <return>H</return>
  <info>mixed</info>   <strong>$values</strong>  

<comment>Return:</comment>
  <info>int</info>  Returns the length of the outputted string.

<comment>See Also:</comment>
   * <strong>print()</strong>
   * <strong>sprintf()</strong>
   * <strong>fprintf()</strong>
   * <strong>vprintf()</strong>
   * <strong>vsprintf()</strong>
   * <strong>vfprintf()</strong>
   * <strong>sscanf()</strong>
   * <strong>fscanf()</strong>
   * <strong>number_format()</strong>
   * <strong>date()</strong>
   * <strong>flush()</strong>


id: proc_close
type: function
doc:
<comment>Description:</comment>
  Close a process opened by proc_open and return the exit code of that process
  
  <strong>proc_close()</strong> is similar to <strong>pclose()</strong> except that it only works on processes opened by <strong>proc_open()</strong>.
  <strong>proc_close()</strong> waits for the process to terminate, and returns its exit code.  Open pipes to that
  process are closed when this function is called, in order to avoid a deadlock - the child process
  may not be able to exit while the pipes are open.

<comment>Param:</comment>
  <info>resource</info>  <strong>$process</strong>  The <strong>proc_open()</strong> <info>resource</info> that will be closed.

<comment>Return:</comment>
  <info>int</info>  Returns the termination status of the process that was run. In case of  an error then <return>-1</return> is
       returned.
       
       Se o PHP foi compilado com --enable-sigchild, o valor retornado por esta função é indefinido.


id: proc_get_status
type: function
doc:
<comment>Description:</comment>
  Obtem informação sobre um processo aberto por proc_open
  
  <strong>proc_get_status()</strong> obtém dados sobre um processo aberto usando <strong>proc_open()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$process</strong>  O recurso to tipo <info>resource</info> gerado por <strong>proc_open()</strong> que será avaliado.

<comment>Return:</comment>
  <info>array</info>  Um <info>array</info> com a informação coletada. O array retornado contém os seguintes elementos:
         
         elementotypedescriçãocommand<info>string</info> A string de comando que foi passada para <strong>proc_open()</strong>.
         pid<info>int</info>Id do processorunning<info>bool</info><info>true</info> se o processo ainda está sendo executado, <info>false</info> se ele
         terminou. signaled<info>bool</info><info>true</info> se o processo filho terminou por um sinal não capturado. Sempre
         definido como <info>false</info> no Windows. stopped<info>bool</info><info>true</info> se o processo filho foi parado por um
         sinal. Sempre definido como <info>false</info> no Windows. exitcode<info>int</info> O código de saída retornado pelo
         processo (que é significativo somente se <return>running</return> for <info>false</info>). Apenas a primeira chamada a
         esta função retorna valor real, a chamada seguinte retorna <return>-1</return>. termsig<info>int</info> O número do sinal
         que fez o processo filho terminar a sua execução (somente significativo se <return>signaled</return> for
         <info>true</info>) stopsig<info>int</info> O número do sinal que fez o processo filho terminar a sua execução
         (somente significativo se <return>stopped</return> for <info>true</info>)

<comment>See Also:</comment>
   * <strong>proc_open()</strong>


id: proc_nice
type: function
doc:
<comment>Description:</comment>
  Muda a prioridade do processo atual
  
  <strong>proc_nice()</strong> muda a prioridade do processo atual para o valor especificado em <strong>$priority</strong>. Um
  <strong>$priority</strong> positivo irá diminuir a prioridade do processo atual, enquanto que um <strong>$priority</strong> negativo
  irá aumentar a prioridade.
  
  <strong>proc_nice()</strong> não é relacionada com <strong>proc_open()</strong> e suas funções associadas de qualquer maneira.

<comment>Param:</comment>
  <info>int</info>  <strong>$priority</strong>  O novo valor de prioridade, pode ser diferente dependendo da plataforma.
                  
                  No Unix, um valor baixo, como <return>-20</return> significa alta prioridade enquanto que valores
                  positivos têm uma prioridade menor.
                  
                  Para Windows, o argumento <strong>$priority</strong> tem o seguinte significado:

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. Se ocorrer um erro, como o
        usuário não ter permissões suficientes para mudar a prioridade, um erro de nível <info>E_WARNING</info>
        também é gerado.

<comment>See Also:</comment>
   * <strong>pcntl_setpriority()</strong>


id: proc_open
type: function
doc:
<comment>Description:</comment>
  Execute a command and open file pointers for input/output
      
  
  <strong>proc_open()</strong> is similar to <strong>popen()</strong> but provides a much greater degree of control over the program
  execution.

<comment>Param:</comment>
  <info>array|string</info>  <strong>$command</strong>          The commandline to execute as <info>string</info>. Special characters have to
                                  be properly escaped, and proper quoting has to be applied.
                                  
                                  On Windows, unless <return>bypass_shell</return> is set to <info>true</info> in <strong>$options</strong>, the
                                  <strong>$command</strong> is passed to cmd.exe (actually, <return>%ComSpec%</return>) with the <return>/c</return>
                                  flag as unquoted string (i.e. exactly as has been given to
                                  <strong>proc_open()</strong>). This can cause cmd.exe to remove enclosing quotes
                                  from <strong>$command</strong> (for details see the cmd.exe documentation),
                                  resulting in unexpected, and potentially even dangerous behavior,
                                  because cmd.exe error messages may contain (parts of) the passed
                                  <strong>$command</strong> (see example below).
                                  
                                  As of PHP 7.4.0, <strong>$command</strong> may be passed as <info>array</info> of command
                                  parameters. In this case the process will be opened directly
                                  (without going through a shell) and PHP will take care of any
                                  necessary argument escaping.
                                  
                                  On Windows, the argument escaping of the <info>array</info> elements assumes
                                  that the command line parsing of the executed command is
                                  compatible with the parsing of command line arguments done by the
                                  VC runtime.
  <info>array</info>         <strong>$descriptor_spec</strong>  An indexed array where the key represents the descriptor number
                                  and the value represents how PHP will pass that descriptor to the
                                  child process. 0 is stdin, 1 is stdout, while 2 is stderr.
                                  
                                  Each element can be: An array describing the pipe to pass to the
                                  process. The first element is the descriptor type and the second
                                  element is an option for the given type. Valid types are <return>pipe</return> (the
                                  second element is either <return>r</return> to pass the read end of the pipe to the
                                  process, or <return>w</return> to pass the write end) and <return>file</return> (the second element
                                  is a filename). Note that anything else than <return>w</return> is treated like <return>r</return>.
                                  A stream resource representing a real file descriptor (e.g. opened
                                  file, a socket, <info>STDIN</info>).
                                  
                                  The file descriptor numbers are not limited to 0, 1 and 2 - you
                                  may specify any valid file descriptor number and it will be passed
                                  to the child process. This allows your script to interoperate with
                                  other scripts that run as "co-processes". In particular, this is
                                  useful for passing passphrases to programs like PGP, GPG and
                                  openssl in a more secure manner. It is also useful for reading
                                  status information provided by those programs on auxiliary file
                                  descriptors.
  <info>array</info>         <strong>$pipes</strong>            Will be set to an indexed array of file pointers that correspond
                                  to PHP's end of any pipes that are created.
  <info>string|null</info>   <strong>$cwd</strong>              The initial working dir for the command. This must be an absolute
                                  directory path, or <info>null</info> if you want to use the default value (the
                                  working dir of the current PHP process)
  <info>array|null</info>    <strong>$env_vars</strong>         An array with the environment variables for the command that will
                                  be run, or <info>null</info> to use the same environment as the current PHP
                                  process
  <info>array|null</info>    <strong>$options</strong>          Allows you to specify additional options. Currently supported
                                  options include: <return>suppress_errors</return> (windows only): suppresses errors
                                  generated by this function when it's set to <info>true</info> <return>bypass_shell</return>
                                  (windows only): bypass <return>cmd.exe</return> shell when set to <info>true</info>
                                  <return>blocking_pipes</return> (windows only): force blocking pipes when set to
                                  <info>true</info> <return>create_process_group</return> (windows only): allow the child process
                                  to handle <return>CTRL</return> events when set to <info>true</info> <return>create_new_console</return> (windows
                                  only): the new process has a new console, instead of inheriting
                                  its parent's console

<comment>Return:</comment>
  <info>resource|false</info>  Returns a resource representing the process, which should be freed using
                  <strong>proc_close()</strong> when you are finished with it. On failure returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>popen()</strong>
   * <strong>exec()</strong>
   * <strong>system()</strong>
   * <strong>passthru()</strong>
   * <strong>stream_select()</strong>
   * The backtick operator


id: proc_terminate
type: function
doc:
<comment>Description:</comment>
  Kills a process opened by proc_open
  
  Signals a <strong>$process</strong> (created using <strong>proc_open()</strong>) that it should terminate. <strong>proc_terminate()</strong> returns
  immediately and does not wait for the process to terminate.
  
  <strong>proc_terminate()</strong> allows you terminate the process and continue with other tasks.  You may poll the
  process (to see if it has stopped yet) by using the <strong>proc_get_status()</strong> function.

<comment>Param:</comment>
  <info>resource</info>  <strong>$process</strong>  The <strong>proc_open()</strong> <info>resource</info> that will be closed.
  <info>int</info>       <strong>$signal</strong>   This optional parameter is only useful on POSIX operating systems; you may
                      specify a signal to send to the process using the <return>kill(2)</return> system call.  The
                      default is <return>SIGTERM</return>.

<comment>Return:</comment>
  <info>bool</info>  Returns the termination status of the process that was run.

<comment>See Also:</comment>
   * <strong>proc_open()</strong>
   * <strong>proc_close()</strong>
   * <strong>proc_get_status()</strong>


id: property_exists
type: function
doc:
<comment>Description:</comment>
  Verifica se o objeto ou a classe tem uma propriedade
    
  
  Essa função verifica se a propriedade informada em <strong>$property</strong> existe na classe especificada.
  
  Ao contrário de <strong>isset()</strong>, <strong>property_exists()</strong> retorna <info>true</info> mesmo se a propriedade tiver o valor <info>null</info>.

<comment>Param:</comment>
  <info>object|string</info>  <strong>$object_or_class</strong>  O nome da classe ou um objeto da classe a ser testada
  <info>string</info>         <strong>$property</strong>         O nome da propriedade

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se a propriedade existe, <info>false</info> se ela não existir ou <info>null</info> em caso de erro.

<comment>See Also:</comment>
   * <strong>method_exists()</strong>


id: ps_add_bookmark
type: function
doc:
<comment>Description:</comment>
  Add bookmark to current page
  
  Adds a bookmark for the current page. Bookmarks usually appear in PDF-Viewers left of the page in
  a hierarchical tree. Clicking on a bookmark will jump to the given page.
  
  A nota não ficará visível se o documento
  for impresso ou visualizado, mas aparecerá se o documento for convertido para
  PDF pelo Acrobat Distiller™ ou Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>    The text used for displaying the bookmark.
  <info>int</info>       <strong>$parent</strong>  A bookmark previously created by this function which is used as the parent of
                     the new bookmark.
  <info>int</info>       <strong>$open</strong>    If <strong>$open</strong> is unequal to zero the bookmark will be shown open by the pdf viewer.

<comment>Return:</comment>
  <info>int</info>  The returned value is a reference for the bookmark. It is only used if the bookmark shall be
       used as a parent. The value is greater zero if the function succeeds. In case of an error
       zero will be returned.

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_launchlink
type: function
doc:
<comment>Description:</comment>
  Adds link which launches file
  
  Places a hyperlink at the given position pointing to a file program which is being started when
  clicked on. The hyperlink's source position is a rectangle with its lower left corner at (llx,
  lly) and its upper right corner at (urx, ury). The rectangle has by default a thin blue border.
  
  A nota não ficará visível se o documento
  for impresso ou visualizado, mas aparecerá se o documento for convertido para
  PDF pelo Acrobat Distiller™ ou Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>       The x-coordinate of the lower left corner.
  <info>float</info>     <strong>$lly</strong>       The y-coordinate of the lower left corner.
  <info>float</info>     <strong>$urx</strong>       The x-coordinate of the upper right corner.
  <info>float</info>     <strong>$ury</strong>       The y-coordinate of the upper right corner.
  <info>string</info>    <strong>$filename</strong>  The path of the program to be started, when the link is clicked on.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_locallink
type: function
doc:
<comment>Description:</comment>
  Adds link to a page in the same document
  
  Places a hyperlink at the given position pointing to a page in the same document. Clicking on the
  link will jump to the given page. The first page in a document has number 1.
  
  The hyperlink's source position is a rectangle with its lower left corner at (<strong>$llx</strong>, <strong>$lly</strong>) and its
  upper right corner at (<strong>$urx</strong>, <strong>$ury</strong>). The rectangle has by default a thin blue border.
  
  A nota não ficará visível se o documento
  for impresso ou visualizado, mas aparecerá se o documento for convertido para
  PDF pelo Acrobat Distiller™ ou Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>    The x-coordinate of the lower left corner.
  <info>float</info>     <strong>$lly</strong>    The y-coordinate of the lower left corner.
  <info>float</info>     <strong>$urx</strong>    The x-coordinate of the upper right corner.
  <info>float</info>     <strong>$ury</strong>    The y-coordinate of the upper right corner.
  <info>int</info>       <strong>$page</strong>   The number of the page displayed when clicking on the link.
  <info>string</info>    <strong>$dest</strong>   The parameter <strong>$dest</strong> determines how the document is being viewed. It can be
                    <return>fitpage</return>, <return>fitwidth</return>, <return>fitheight</return>, or <return>fitbbox</return>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_note
type: function
doc:
<comment>Description:</comment>
  Adds note to current page
  
  Adds a note at a certain position on the page. Notes are like little rectangular sheets with text
  on it, which can be placed anywhere on a page. They are shown either folded or unfolded. If
  folded, the specified icon is used as a placeholder.
  
  A nota não ficará visível se o documento
  for impresso ou visualizado, mas aparecerá se o documento for convertido para
  PDF pelo Acrobat Distiller™ ou Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>       The x-coordinate of the lower left corner.
  <info>float</info>     <strong>$lly</strong>       The y-coordinate of the lower left corner.
  <info>float</info>     <strong>$urx</strong>       The x-coordinate of the upper right corner.
  <info>float</info>     <strong>$ury</strong>       The y-coordinate of the upper right corner.
  <info>string</info>    <strong>$contents</strong>  The text of the note.
  <info>string</info>    <strong>$title</strong>     The title of the note as displayed in the header of the note.
  <info>string</info>    <strong>$icon</strong>      The icon shown if the note is folded. This parameter can be set to <return>comment</return>,
                       <return>insert</return>, <return>note</return>, <return>paragraph</return>, <return>newparagraph</return>, <return>key</return>, or <return>help</return>.
  <info>int</info>       <strong>$open</strong>      If <strong>$open</strong> is unequal to zero the note will be shown unfolded after opening the
                       document with a pdf viewer.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_pdflink
type: function
doc:
<comment>Description:</comment>
  Adds link to a page in a second pdf document
  
  Places a hyperlink at the given position pointing to a second pdf document. Clicking on the link
  will branch to the document at the given page. The first page in a document has number 1.
  
  The hyperlink's source position is a rectangle with its lower left corner at (<strong>$llx</strong>, <strong>$lly</strong>) and its
  upper right corner at (<strong>$urx</strong>, <strong>$ury</strong>). The rectangle has by default a thin blue border.
  
  A nota não ficará visível se o documento
  for impresso ou visualizado, mas aparecerá se o documento for convertido para
  PDF pelo Acrobat Distiller™ ou Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>       The x-coordinate of the lower left corner.
  <info>float</info>     <strong>$lly</strong>       The y-coordinate of the lower left corner.
  <info>float</info>     <strong>$urx</strong>       The x-coordinate of the upper right corner.
  <info>float</info>     <strong>$ury</strong>       The y-coordinate of the upper right corner.
  <info>string</info>    <strong>$filename</strong>  The name of the pdf document to be opened when clicking on this link.
  <info>int</info>       <strong>$page</strong>      The page number of the destination pdf document
  <info>string</info>    <strong>$dest</strong>      The parameter <strong>$dest</strong> determines how the document is being viewed. It can be
                       <return>fitpage</return>, <return>fitwidth</return>, <return>fitheight</return>, or <return>fitbbox</return>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_weblink
type: function
doc:
<comment>Description:</comment>
  Adds link to a web location
  
  Places a hyperlink at the given position pointing to a web page. The  hyperlink's source position
  is a rectangle with its lower left corner at (<strong>$llx</strong>, <strong>$lly</strong>) and its upper right corner at (<strong>$urx</strong>,
  <strong>$ury</strong>). The rectangle has by default a thin blue border.
  
  A nota não ficará visível se o documento
  for impresso ou visualizado, mas aparecerá se o documento for convertido para
  PDF pelo Acrobat Distiller™ ou Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>    The x-coordinate of the lower left corner.
  <info>float</info>     <strong>$lly</strong>    The y-coordinate of the lower left corner.
  <info>float</info>     <strong>$urx</strong>    The x-coordinate of the upper right corner.
  <info>float</info>     <strong>$ury</strong>    The y-coordinate of the upper right corner.
  <info>string</info>    <strong>$url</strong>    The url of the hyperlink to be opened when clicking on this link, e.g.
                    <return>http://www.php.net</return>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_pdflink()</strong>


id: ps_arc
type: function
doc:
<comment>Description:</comment>
  Draws an arc counterclockwise
  
  Draws a portion of a circle with at middle point at (<strong>$x</strong>, <strong>$y</strong>). The arc starts at an angle of <strong>$alpha</strong>
  and ends at an angle of <strong>$beta</strong>. It is drawn counterclockwise (use <strong>ps_arcn()</strong> to draw clockwise). The
  subpath added to the current path starts on the arc at angle <strong>$alpha</strong> and ends on the arc at angle
  <strong>$beta</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       The x-coordinate of the circle's middle point.
  <info>float</info>     <strong>$y</strong>       The y-coordinate of the circle's middle point.
  <info>float</info>     <strong>$radius</strong>  The radius of the circle
  <info>float</info>     <strong>$alpha</strong>   The start angle given in degrees.
  <info>float</info>     <strong>$beta</strong>    The end angle given in degrees.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_arcn()</strong>


id: ps_arcn
type: function
doc:
<comment>Description:</comment>
  Draws an arc clockwise
  
  Draws a portion of a circle with at middle point at (<strong>$x</strong>, <strong>$y</strong>). The arc starts at an angle of <strong>$alpha</strong>
  and ends at an angle of <strong>$beta</strong>. It is drawn clockwise (use <strong>ps_arc()</strong> to draw counterclockwise). The
  subpath added to the current path starts on the arc at angle <strong>$beta</strong> and ends on the arc at angle
  <strong>$alpha</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       The x-coordinate of the circle's middle point.
  <info>float</info>     <strong>$y</strong>       The y-coordinate of the circle's middle point.
  <info>float</info>     <strong>$radius</strong>  The radius of the circle
  <info>float</info>     <strong>$alpha</strong>   The starting angle given in degrees.
  <info>float</info>     <strong>$beta</strong>    The end angle given in degrees.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_arc()</strong>


id: ps_begin_page
type: function
doc:
<comment>Description:</comment>
  Start a new page
  
  Starts a new page. Although the parameters <strong>$width</strong> and <strong>$height</strong> imply a different page size for each
  page, this is not possible in PostScript. The first call of <strong>ps_begin_page()</strong> will set the page size
  for the whole document. Consecutive calls will have no effect, except for creating a new page. The
  situation is different if you intent to convert the PostScript document into PDF. This function
  places pdfmarks into the document which can set the size for each page indiviually. The resulting
  PDF document will have different page sizes.
  
  Though PostScript does not know different page sizes, pslib places a bounding box for each page
  into the document. This size is evaluated by some PostScript viewers and will have precedence over
  the BoundingBox in the Header of the document. This can lead to unexpected results when you set a
  BoundingBox whose lower left corner is not (0, 0), because the bounding box of the page will
  always have a lower left corner (0, 0) and overwrites the global setting.
  
  Each page is encapsulated into save/restore. This means, that most of the settings made on one
  page will not be retained on the next page.
  
  If there is up to the first call of <strong>ps_begin_page()</strong> no call of <strong>ps_findfont()</strong>, then the header of
  the PostScript document will be output and the bounding box will be set to the size of the first
  page. The lower left corner of the bounding box is set to (0, 0). If <strong>ps_findfont()</strong> was called
  before, then the header has been output already, and the document will not have a valid bounding
  box. In order to prevent this, one should call <strong>ps_set_info()</strong> to set the info field <return>BoundingBox</return> and
  possibly <return>Orientation</return> before any <strong>ps_findfont()</strong> or <strong>ps_begin_page()</strong> calls.
  
  Up to version 0.2.6 of pslib, this function will always overwrite the BoundingBox and Orientation,
  if it has been set before with <strong>ps_set_info()</strong> and <strong>ps_findfont()</strong> has not been called before.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>   The width of the page in pixel, e.g. 596 for A4 format.
  <info>float</info>     <strong>$height</strong>  The height of the page in pixel, e.g. 842 for A4 format.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_end_page()</strong>
   * <strong>ps_findfont()</strong>
   * <strong>ps_set_info()</strong>


id: ps_begin_pattern
type: function
doc:
<comment>Description:</comment>
  Start a new pattern
  
  Starts a new pattern. A pattern is like a page containing e.g. a drawing which can be used for
  filling areas. It is used like a color by calling <strong>ps_setcolor()</strong> and setting the color space to
  <return>pattern</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>      Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>      The width of the pattern in pixel.
  <info>float</info>     <strong>$height</strong>     The height of the pattern in pixel.
  <info></info>          <strong>$x-step</strong>     The distance in pixel of placements of the pattern in horizontal direction.
  <info></info>          <strong>$y-step</strong>     The distance in pixel of placements of the pattern in vertical direction.
  <info>int</info>       <strong>$painttype</strong>  Must be 1 or 2.

<comment>Return:</comment>
  <info>int|false</info>  The identifier of the pattern  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_end_pattern()</strong>
   * <strong>ps_setcolor()</strong>
   * <strong>ps_shading_pattern()</strong>


id: ps_begin_template
type: function
doc:
<comment>Description:</comment>
  Start a new template
  
  Starts a new template. A template is called a form in the postscript language. It is created
  similar to a pattern but used like an image. Templates are often used for drawings which are
  placed several times through out the document, e.g. like a company logo. All drawing functions may
  be used within a template. The template will not be drawn until it is placed by <strong>ps_place_image()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>   The width of the template in pixel.
  <info>float</info>     <strong>$height</strong>  The height of the template in pixel.

<comment>Return:</comment>
  <info>int</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_end_template()</strong>


id: ps_circle
type: function
doc:
<comment>Description:</comment>
  Draws a circle
  
  Draws a circle with its middle point at (<strong>$x</strong>, <strong>$y</strong>). The circle starts and ends at position
  (<strong>$x</strong>+<strong>$radius</strong>, <strong>$y</strong>). If this function is called outside a path it will start a new path. If it is
  called within a path it will add the circle as a subpath. If the last drawing operation does not
  end in point (<strong>$x</strong>+<strong>$radius</strong>, <strong>$y</strong>) then there will be a gap in the path.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       The x-coordinate of the circle's middle point.
  <info>float</info>     <strong>$y</strong>       The y-coordinate of the circle's middle point.
  <info>float</info>     <strong>$radius</strong>  The radius of the circle

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_arc()</strong>
   * <strong>ps_arcn()</strong>


id: ps_clip
type: function
doc:
<comment>Description:</comment>
  Clips drawing to current path
  
  Takes the current path and uses it to define the border of a clipping area. Everything drawn
  outside of that area will not be visible.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_closepath()</strong>


id: ps_close
type: function
doc:
<comment>Description:</comment>
  Closes a PostScript document
  
  Closes the PostScript document.
  
  This function writes the trailer of the PostScript document. It also writes the bookmark tree.
  <strong>ps_close()</strong> does not free any resources, which is done by <strong>ps_delete()</strong>.
  
  This function is also called by <strong>ps_delete()</strong> if it has not been called before.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_open_file()</strong>
   * <strong>ps_delete()</strong>


id: ps_close_image
type: function
doc:
<comment>Description:</comment>
  Closes image and frees memory
  
  Closes an image and frees its resources. Once an image is closed it cannot be used anymore.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>    Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$imageid</strong>  Resource identifier of the image as returned by <strong>ps_open_image()</strong> or
                      <strong>ps_open_image_file()</strong>.

<comment>Return:</comment>
  <info>void|false</info>  Returns <info>null</info> on success ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_open_image()</strong>
   * <strong>ps_open_image_file()</strong>


id: ps_closepath
type: function
doc:
<comment>Description:</comment>
  Closes path
  
  Connects the last point with the first point of a path. The resulting path can be used for
  stroking, filling, clipping, etc..

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_clip()</strong>
   * <strong>ps_closepath_stroke()</strong>


id: ps_closepath_stroke
type: function
doc:
<comment>Description:</comment>
  Closes and strokes path
  
  Connects the last point with first point of a path and draws the resulting closed line.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_closepath()</strong>


id: ps_continue_text
type: function
doc:
<comment>Description:</comment>
  Continue text in next line
  
  Output a text one line below the last line. The line spacing is taken from the value "leading"
  which must be set with <strong>ps_set_value()</strong>. The actual position of the text is determined by the values
  "textx" and "texty" which can be requested with <strong>ps_get_value()</strong>

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   The text to output.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_show()</strong>
   * <strong>ps_show_xy()</strong>
   * <strong>ps_show_boxed()</strong>


id: ps_curveto
type: function
doc:
<comment>Description:</comment>
  Draws a curve
  
  Add a section of a cubic Bézier curve described by the three given control points to the current
  path.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x1</strong>     x-coordinate of first control point.
  <info>float</info>     <strong>$y1</strong>     y-coordinate of first control point.
  <info>float</info>     <strong>$x2</strong>     x-coordinate of second control point.
  <info>float</info>     <strong>$y2</strong>     y-coordinate of second control point.
  <info>float</info>     <strong>$x3</strong>     x-coordinate of third control point.
  <info>float</info>     <strong>$y3</strong>     y-coordinate of third control point.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_lineto()</strong>


id: ps_delete
type: function
doc:
<comment>Description:</comment>
  Deletes all resources of a PostScript document
  
  Mainly frees memory used by the document. Also closes a file, if it was not closed before with
  <strong>ps_close()</strong>. You should in any case close the file with <strong>ps_close()</strong> before, because <strong>ps_close()</strong> not
  just closes the file but also outputs a trailor containing PostScript comments like the number of
  pages in the document and adding the bookmark hierarchy.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_close()</strong>


id: ps_end_page
type: function
doc:
<comment>Description:</comment>
  End a page
  
  Ends a page which was started with <strong>ps_begin_page()</strong>. Ending a page will leave the current drawing
  context, which e.g. requires to reload fonts if they were loading within the page, and to set many
  other drawing parameters like the line width, or color.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_begin_page()</strong>


id: ps_end_pattern
type: function
doc:
<comment>Description:</comment>
  End a pattern
  
  Ends a pattern which was started with <strong>ps_begin_pattern()</strong>. Once a pattern has been ended, it can be
  used like a color to fill areas.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_begin_pattern()</strong>


id: ps_end_template
type: function
doc:
<comment>Description:</comment>
  End a template
  
  Ends a template which was started with <strong>ps_begin_template()</strong>. Once a template has been ended, it can
  be used like an image.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_begin_template()</strong>


id: ps_fill
type: function
doc:
<comment>Description:</comment>
  Fills the current path
  
  Fills the path constructed with previously called drawing functions like <strong>ps_lineto()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_fill_stroke()</strong>
   * <strong>ps_stroke()</strong>


id: ps_fill_stroke
type: function
doc:
<comment>Description:</comment>
  Fills and strokes the current path
  
  Fills and draws the path constructed with previously called drawing functions like <strong>ps_lineto()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_fill()</strong>
   * <strong>ps_stroke()</strong>


id: ps_findfont
type: function
doc:
<comment>Description:</comment>
  Loads a font
  
  Loads a font for later use. Before text is output with a loaded font it must be set with
  <strong>ps_setfont()</strong>. This function needs the adobe font metric file in order to calculate the space used
  up by the characters. A font which is loaded within a page will only be available on that page.
  Fonts which are to be used in the complete document have to be loaded before the first call of
  <strong>ps_begin_page()</strong>. Calling <strong>ps_findfont()</strong> between pages will make that font available for all
  following pages.
  
  The name of the afm file must be <strong>$fontname</strong><return>.afm</return>. If the font shall be embedded the file
  <strong>$fontname</strong><return>.pfb</return> containing the font outline must be present as well.
  
  Calling <strong>ps_findfont()</strong> before the first page requires to output the postscript header which
  includes the BoundingBox for the whole document. Usually the BoundingBox is set with the first
  call of <strong>ps_begin_page()</strong> which now comes after <strong>ps_findfont()</strong>. Consequently the BoundingBox has not
  been set and a warning will be issued when <strong>ps_findfont()</strong> is called. In order to prevent this
  situation, one should call <strong>ps_set_parameter()</strong> to set the BoundingBox before <strong>ps_findfont()</strong> is
  called.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$fontname</strong>  The name of the font.
  <info>string</info>    <strong>$encoding</strong>  <strong>ps_findfont()</strong> will try to load the file passed in the parameter <strong>$encoding</strong>.
                       Encoding files are of the same syntax as those used by dvips(1). They contain
                       a font encoding vector (which is currently not used but must be present) and
                       a list of extra ligatures to extend the list of ligatures derived from the
                       afm file.
                       
                       <strong>$encoding</strong> can be <info>null</info> or the empty string if the default encoding (TeXBase1)
                       shall be used.
                       
                       If the encoding is set to <return>builtin</return> then there will be no reencoding and the
                       font specific encoding will be used. This is very useful with symbol fonts.
  <info>bool</info>      <strong>$embed</strong>     If set to a value &gt;0 the font will be embedded into the document. This
                       requires the font outline (.pfb file) to be present.

<comment>Return:</comment>
  <info>int</info>  Returns the identifier of the font or zero in case of an error. The identifier is a positive
       number.

<comment>See Also:</comment>
   * <strong>ps_begin_page()</strong>
   * <strong>ps_setfont()</strong>


id: ps_get_buffer
type: function
doc:
<comment>Description:</comment>
  Fetches the full buffer containig the generated PS data
  
  This function is not implemented yet. It will always return an empty string. The idea for a later
  implementation is to write the contents of the postscript file into an internal buffer if in
  memory creation is requested, and retrieve the buffer content with this function. Currently,
  documents created in memory are send to the browser without buffering.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>string</info>  

<comment>See Also:</comment>
   * <strong>ps_open_file()</strong>


id: ps_get_parameter
type: function
doc:
<comment>Description:</comment>
  Gets certain parameters
  
  Gets several parameters which were directly set by <strong>ps_set_parameter()</strong> or indirectly by one of the
  other functions. Parameters are by definition string values. This function cannot be used to
  retrieve resources which were also set by <strong>ps_set_parameter()</strong>.
  
  The parameter <strong>$name</strong> can have the following values.
  
  <return>fontname</return> The name of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>. <return>fontencoding</return> The encoding of the currently active font. <return>dottedversion</return> The version of
  the underlying pslib library in the format \<major&gt;.\<minor&gt;.\<subminor&gt; <return>scope</return> The current drawing scope. Can be object, document, null, page, pattern, path, template, prolog, font, glyph. <return>ligaturedisolvechar</return> The character which dissolves a ligature. If your are using a font which contains the ligature `ff' and `|' is the char to dissolve the ligature, then `f|f' will result in two `f' instead of the ligature `ff'. <return>imageencoding</return> The encoding used for encoding images. Can be either <return>hex</return> or <return>85</return>. hex encoding uses two bytes in the postscript file each byte in the image. 85 stand for Ascii85 encoding. <return>linenumbermode</return> Set to <return>paragraph</return> if lines are numbered within a paragraph or <return>box</return> if they are numbered within the surrounding box. <return>linebreak</return> Only used if text is output with <strong>ps_show_boxed()</strong>. If set to <info>true</info> a carriage return will add a line break. <return>parbreak</return> Only used if text is output with <strong>ps_show_boxed()</strong>. If set to <info>true</info> a carriage return will start a new paragraph. <return>hyphenation</return> Only used if text is output with <strong>ps_show_boxed()</strong>. If set to <info>true</info> the paragraph will be hyphenated if a hypen dictionary is set and exists. <return>hyphendict</return> Filename of the dictionary used for hyphenation pattern.
  
  The name of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>.
  
  The encoding of the currently active font.
  
  The version of the underlying pslib library in the format \<major&gt;.\<minor&gt;.\<subminor&gt;
  
  The current drawing scope. Can be object, document, null, page, pattern, path, template, prolog,
  font, glyph.
  
  The character which dissolves a ligature. If your are using a font which contains the ligature
  `ff' and `|' is the char to dissolve the ligature, then `f|f' will result in two `f' instead of
  the ligature `ff'.
  
  The encoding used for encoding images. Can be either <return>hex</return> or <return>85</return>. hex encoding uses two bytes in the
  postscript file each byte in the image. 85 stand for Ascii85 encoding.
  
  Set to <return>paragraph</return> if lines are numbered within a paragraph or <return>box</return> if they are numbered within the
  surrounding box.
  
  Only used if text is output with <strong>ps_show_boxed()</strong>. If set to <info>true</info> a carriage return will add a line
  break.
  
  Only used if text is output with <strong>ps_show_boxed()</strong>. If set to <info>true</info> a carriage return will start a
  new paragraph.
  
  Only used if text is output with <strong>ps_show_boxed()</strong>. If set to <info>true</info> the paragraph will be hyphenated
  if a hypen dictionary is set and exists.
  
  Filename of the dictionary used for hyphenation pattern.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>      Name of the parameter.
  <info>float</info>     <strong>$modifier</strong>  An identifier needed if a parameter of a resource is requested, e.g. the size
                       of an image. In such a case the resource id is passed.

<comment>Return:</comment>
  <info>string|false</info>  Returns the value of the parameter  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_set_parameter()</strong>


id: ps_get_value
type: function
doc:
<comment>Description:</comment>
  Gets certain values
  
  Gets several values which were set by <strong>ps_set_value()</strong>. Values are by definition float values.
  
  The parameter <strong>$name</strong> can have the following values.
  
  <return>fontsize</return> The size of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>. <return>font</return> The currently active font itself. <return>imagewidth</return> The width of the image whose id is
  passed in the parameter <strong>$modifier</strong>. <return>imageheight</return> The height of the image whose id is passed in the
  parameter <strong>$modifier</strong>. <return>capheight</return> The height of a capital M in the currently active font or the font
  whose identifier is passed in parameter <strong>$modifier</strong>. <return>ascender</return> The ascender of the currently active
  font or the font whose identifier is passed in parameter <strong>$modifier</strong>. <return>descender</return> The descender of the
  currently active font or the font whose identifier is passed in parameter <strong>$modifier</strong>. <return>italicangle</return>
  The italicangle of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>. <return>underlineposition</return> The underlineposition of the currently active font or the font whose
  identifier is passed in parameter <strong>$modifier</strong>. <return>underlinethickness</return> The underlinethickness of the
  currently active font or the font whose identifier is passed in parameter <strong>$modifier</strong>. <return>textx</return> The
  current x-position for text output. <return>texty</return> The current y-position for text output. <return>textrendering</return>
  The current mode for text rendering. <return>textrise</return> The space by which text is risen above the base
  line. <return>leading</return> The distance between text lines in points. <return>wordspacing</return> The space between words as a
  multiple of the width of a space char. <return>charspacing</return> The space between chars. If charspacing is !=
  0.0 ligatures will always be dissolved. <return>hyphenminchars</return> Minimum number of chars hyphenated at the
  end of a word. <return>parindent</return> Indention of the first n line in a paragraph. <return>numindentlines</return> Number of
  line in a paragraph to indent if parindent != 0.0. <return>parskip</return> Distance between paragraphs.
  <return>linenumberspace</return> Overall space in front of each line for the line number. <return>linenumbersep</return> Space
  between the line and the line number. <return>major</return> The major version number of pslib. <return>minor</return> The minor
  version number of pslib. <return>subminor</return>, <return>revision</return> The subminor version number of pslib.
  
  The size of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>.
  
  The currently active font itself.
  
  The width of the image whose id is passed in the parameter <strong>$modifier</strong>.
  
  The height of the image whose id is passed in the parameter <strong>$modifier</strong>.
  
  The height of a capital M in the currently active font or the font whose identifier is passed in
  parameter <strong>$modifier</strong>.
  
  The ascender of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>.
  
  The descender of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>.
  
  The italicangle of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>.
  
  The underlineposition of the currently active font or the font whose identifier is passed in
  parameter <strong>$modifier</strong>.
  
  The underlinethickness of the currently active font or the font whose identifier is passed in
  parameter <strong>$modifier</strong>.
  
  The current x-position for text output.
  
  The current y-position for text output.
  
  The current mode for text rendering.
  
  The space by which text is risen above the base line.
  
  The distance between text lines in points.
  
  The space between words as a multiple of the width of a space char.
  
  The space between chars. If charspacing is != 0.0 ligatures will always be dissolved.
  
  Minimum number of chars hyphenated at the end of a word.
  
  Indention of the first n line in a paragraph.
  
  Number of line in a paragraph to indent if parindent != 0.0.
  
  Distance between paragraphs.
  
  Overall space in front of each line for the line number.
  
  Space between the line and the line number.
  
  The major version number of pslib.
  
  The minor version number of pslib.
  
  The subminor version number of pslib.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>      Name of the value.
  <info>float</info>     <strong>$modifier</strong>  The parameter <strong>$modifier</strong> specifies the resource for which the value is to be
                       retrieved. This can be the id of a font or an image.

<comment>Return:</comment>
  <info>float</info>  Returns the value of the parameter or <info>false</info>.

<comment>See Also:</comment>
   * <strong>ps_set_value()</strong>


id: ps_hyphenate
type: function
doc:
<comment>Description:</comment>
  Hyphenates a word
  
  Hyphenates the passed word. <strong>ps_hyphenate()</strong> evaluates the value hyphenminchars (set by
  <strong>ps_set_value()</strong>) and the parameter hyphendict (set by <strong>ps_set_parameter()</strong>). hyphendict must be set
  before calling this function.
  
  This function requires the locale category LC_CTYPE to be set properly. This is done when the
  extension is initialized by using the environment variables. On Unix systems read the man page of
  locale for more information.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   <strong>$text</strong> should not contain any non alpha characters. Possible positions for breaks
                    are returned in an array of interger numbers. Each number is the position of the
                    char in  <strong>$text</strong> after which a hyphenation can take place.

<comment>Return:</comment>
  <info>array|false</info>  An array of integers indicating the position of possible breaks in the text  ou <info>false</info>
               em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_show_boxed()</strong>
   * locale(1)


id: ps_include_file
type: function
doc:
<comment>Description:</comment>
  Reads an external file with raw PostScript code
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$file</strong>   

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ps_lineto
type: function
doc:
<comment>Description:</comment>
  Draws a line
  
  Adds a straight line from the current point to the given coordinates to the current path. Use
  <strong>ps_moveto()</strong> to set the starting point of the line.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      x-coordinate of the end point of the line.
  <info>float</info>     <strong>$y</strong>      y-coordinate of the end point of the line.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_moveto()</strong>


id: ps_makespotcolor
type: function
doc:
<comment>Description:</comment>
  Create spot color
  
  Creates a spot color from the current fill color. The fill color must be defined in rgb, cmyk or
  gray colorspace. The spot color name can be an arbitrary name. A spot color can be set as any
  color with <strong>ps_setcolor()</strong>. When the document is not printed but displayed by an postscript viewer
  the given color in the specified color space is use.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>   Name of the spot color, e.g. Pantone 5565.

<comment>Return:</comment>
  <info>int</info>  The id of the new spot color or 0 in case of an error.

<comment>See Also:</comment>
   * <strong>ps_setcolor()</strong>


id: ps_moveto
type: function
doc:
<comment>Description:</comment>
  Sets current point
  
  Sets the current point to new coordinates. If this is the first call of <strong>ps_moveto()</strong> after a
  previous path has been ended then it will start a new path. If this function is called in the
  middle of a path it will just set the current point and start a subpath.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      x-coordinate of the point to move to.
  <info>float</info>     <strong>$y</strong>      y-coordinate of the point to move to.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_lineto()</strong>


id: ps_new
type: function
doc:
<comment>Description:</comment>
  Creates a new PostScript document object
  
  Creates a new document instance. It does not create the file on disk or in memory, it just sets up
  everything. <strong>ps_new()</strong> is usually followed by a call of <strong>ps_open_file()</strong> to actually create the
  postscript document.

<comment>Return:</comment>
  <info>resource|false</info>  Resource of PostScript document ou <info>false</info> em caso de falha. The return value is
                  passed to all other functions as the first argument.

<comment>See Also:</comment>
   * <strong>ps_delete()</strong>


id: ps_open_file
type: function
doc:
<comment>Description:</comment>
  Opens a file for output
  
  Creates a new file on disk and writes the PostScript document into it. The file will be closed
  when <strong>ps_close()</strong> is called.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$filename</strong>  The name of the postscript file. If <strong>$filename</strong> is not passed the document will
                       be created in memory and all output will go straight to the browser.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_close()</strong>


id: ps_open_image
type: function
doc:
<comment>Description:</comment>
  Reads an image for later placement
  
  Reads an image which is already available in memory. The parameter <strong>$source</strong> is currently not
  evaluated and assumed to be <return>memory</return>. The image data is a sequence of pixels starting in th upper
  left corner and ending in the lower right corner. Each pixel consists of <strong>$components</strong> color
  components, and each component has <strong>$bpc</strong> bits.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>       Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>        The type of the image. Possible values are <return>png</return>, <return>jpeg</return>, or <return>eps</return>.
  <info>string</info>    <strong>$source</strong>      Not used.
  <info>string</info>    <strong>$data</strong>        The image data.
  <info></info>          <strong>$length</strong>      The length of the image data.
  <info>int</info>       <strong>$width</strong>       The width of the image.
  <info>int</info>       <strong>$height</strong>      The height of the image.
  <info>int</info>       <strong>$components</strong>  The number of components for each pixel. This can be 1 (gray scale images),
                         3 (rgb images), or 4 (cmyk, rgba images).
  <info>int</info>       <strong>$bpc</strong>         Number of bits per component (quite often 8).
  <info>string</info>    <strong>$params</strong>      

<comment>Return:</comment>
  <info>int</info>  Returns identifier of image or zero in case of an error. The identifier is a positive number
       greater than 0.

<comment>See Also:</comment>
   * <strong>ps_open_image_file()</strong>
   * <strong>ps_place_image()</strong>
   * <strong>ps_close_image()</strong>


id: ps_open_image_file
type: function
doc:
<comment>Description:</comment>
  Opens image from file
  
  Loads an image for later use.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>        Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>         The type of the image. Possible values are <return>png</return>, <return>jpeg</return>, or <return>eps</return>.
  <info>string</info>    <strong>$filename</strong>     The name of the file containing the image data.
  <info>string</info>    <strong>$stringparam</strong>  Not used.
  <info>int</info>       <strong>$intparam</strong>     Not used.

<comment>Return:</comment>
  <info>int</info>  Returns identifier of image or zero in case of an error. The identifier is a positive number
       greater than 0.

<comment>See Also:</comment>
   * <strong>ps_open_image()</strong>
   * <strong>ps_place_image()</strong>
   * <strong>ps_close_image()</strong>


id: ps_open_memory_image
type: function
doc:
<comment>Description:</comment>
  Takes an GD image and returns an image for placement in a PS document
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$gd</strong>     

<comment>Return:</comment>
  <info>int</info>  


id: ps_place_image
type: function
doc:
<comment>Description:</comment>
  Places image on the page
  
  Places a formerly loaded image on the page. The image can be scaled. If the image shall be rotated
  as well, you will have to rotate the coordinate system before with <strong>ps_rotate()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>    Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$imageid</strong>  The resource identifier of the image as returned by  <strong>ps_open_image()</strong> or
                      <strong>ps_open_image_file()</strong>.
  <info>float</info>     <strong>$x</strong>        x-coordinate of the lower left corner of the image.
  <info>float</info>     <strong>$y</strong>        y-coordinate of the lower left corner of the image.
  <info>float</info>     <strong>$scale</strong>    The scaling factor for the image. A scale of 1.0 will result in a resolution
                      of 72 dpi, because each pixel is equivalent to 1 point.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_open_image()</strong>
   * <strong>ps_open_image_file()</strong>


id: ps_rect
type: function
doc:
<comment>Description:</comment>
  Draws a rectangle
  
  Draws a rectangle with its lower left corner at (<strong>$x</strong>, <strong>$y</strong>). The rectangle starts and ends in its
  lower left corner. If this function is called outside a path it will start a new path. If it is
  called within a path it will add the rectangle as a subpath. If the last drawing operation does
  not end in the lower left corner then there will be a gap in the path.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       x-coordinate of the lower left corner of the rectangle.
  <info>float</info>     <strong>$y</strong>       y-coordinate of the lower left corner of the rectangle.
  <info>float</info>     <strong>$width</strong>   The width of the image.
  <info>float</info>     <strong>$height</strong>  The height of the image.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_arc()</strong>
   * <strong>ps_cirle()</strong>
   * <strong>ps_lineto()</strong>


id: ps_restore
type: function
doc:
<comment>Description:</comment>
  Restore previously save context
  
  Restores a previously saved graphics context. Any call of <strong>ps_save()</strong> must be accompanied by a call
  to <strong>ps_restore()</strong>. All coordinate transformations, line style settings, color settings, etc. are
  being restored to the state before the call of <strong>ps_save()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_save()</strong>


id: ps_rotate
type: function
doc:
<comment>Description:</comment>
  Sets rotation factor
  
  Sets the rotation of the coordinate system.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$rot</strong>    Angle of rotation in degree.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_scale()</strong>
   * <strong>ps_translate()</strong>


id: ps_save
type: function
doc:
<comment>Description:</comment>
  Save current context
  
  Saves the current graphics context, containing colors, translation and rotation settings and some
  more. A saved context can be restored with <strong>ps_restore()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_restore()</strong>


id: ps_scale
type: function
doc:
<comment>Description:</comment>
  Sets scaling factor
  
  Sets horizontal and vertical scaling of the coordinate system.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      Scaling factor in horizontal direction.
  <info>float</info>     <strong>$y</strong>      Scaling factor in vertical direction.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_rotate()</strong>
   * <strong>ps_translate()</strong>


id: ps_set_border_color
type: function
doc:
<comment>Description:</comment>
  Sets color of border for annotations
  
  Links added with one of the functions <strong>ps_add_weblink()</strong>, <strong>ps_add_pdflink()</strong>, etc. will be displayed
  with a surounded rectangle when the postscript document is converted to pdf and viewed in a pdf
  viewer. This rectangle is not visible in the postscript document. This function sets the color of
  the rectangle's border line.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$red</strong>    The red component of the border color.
  <info>float</info>     <strong>$green</strong>  The green component of the border color.
  <info>float</info>     <strong>$blue</strong>   The blue component of the border color.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_set_border_dash()</strong>
   * <strong>ps_set_border_style()</strong>


id: ps_set_border_dash
type: function
doc:
<comment>Description:</comment>
  Sets length of dashes for border of annotations
  
  Links added with one of the functions <strong>ps_add_weblink()</strong>, <strong>ps_add_pdflink()</strong>, etc. will be displayed
  with a surounded rectangle when the postscript document is converted to pdf and viewed in a pdf
  viewer. This rectangle is not visible in the postscript document. This function sets the length of
  the black and white portion of a dashed border line.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$black</strong>  The length of the dash.
  <info>float</info>     <strong>$white</strong>  The length of the gap between dashes.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_set_border_color()</strong>
   * <strong>ps_set_border_style()</strong>


id: ps_set_border_style
type: function
doc:
<comment>Description:</comment>
  Sets border style of annotations
  
  Links added with one of the functions <strong>ps_add_weblink()</strong>, <strong>ps_add_pdflink()</strong>, etc. will be displayed
  with a surounded rectangle when the postscript document is converted to pdf and viewed in a pdf
  viewer. This rectangle is not visible in the postscript document. This function sets the
  appearance and width of the border line.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$style</strong>  <strong>$style</strong> can be <return>solid</return> or <return>dashed</return>.
  <info>float</info>     <strong>$width</strong>  The line width of the border.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_set_border_color()</strong>
   * <strong>ps_set_border_dash()</strong>


id: ps_set_info
type: function
doc:
<comment>Description:</comment>
  Sets information fields of document
  
  Sets certain information fields of the document. This fields will be shown as a comment in the
  header of the PostScript file. If the document is converted to pdf this fields will also be used
  for the document information.
  
  The <return>BoundingBox</return> is usually set to the value given to the first page. This only works if
  <strong>ps_findfont()</strong> has not been called before. In such cases the BoundingBox would be left unset unless
  you set it explicitly with this function.
  
  This function will have no effect anymore when the header of the postscript file has been already
  written. It must be called before the first page or the first call of <strong>ps_findfont()</strong>.

<comment>Param:</comment>
  <info></info>        <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>  <strong>$key</strong>    The name of the information field to set. The values which can be set are
                  <return>Keywords</return>, <return>Subject</return>, <return>Title</return>, <return>Creator</return>, <return>Author</return>, <return>BoundingBox</return>, and <return>Orientation</return>. Be aware
                  that some of them has a meaning to PostScript viewers.
  <info></info>        <strong>$value</strong>  The value of the information field. The field <return>Orientation</return> can be set to either
                  <return>Portrait</return> or <return>Landscape</return>. The <return>BoundingBox</return> is a string consisting of four numbers. The
                  first two numbers are the coordinates of the lower left corner of the page. The
                  last two numbers are the coordinates of the upper right corner.
                  
                  Up to version 0.2.6 of pslib, the BoundingBox and Orientation will be overwritten
                  by <strong>ps_begin_page()</strong>, unless <strong>ps_findfont()</strong> has been called before.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_findfont()</strong>
   * <strong>ps_begin_page()</strong>


id: ps_set_parameter
type: function
doc:
<comment>Description:</comment>
  Sets certain parameters
  
  Sets several parameters which are used by many functions. Parameters are by definition string
  values.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>   For a list of possible names see <strong>ps_get_parameter()</strong>.
  <info>string</info>    <strong>$value</strong>  The value of the parameter.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_get_parameters()</strong>
   * <strong>ps_set_value()</strong>


id: ps_set_text_pos
type: function
doc:
<comment>Description:</comment>
  Sets position for text output
  
  Set the position for the next text output. You may alternatively set the x and y value separately
  by calling <strong>ps_set_value()</strong> and choosing <return>textx</return> respectively <return>texty</return> as the value name.
  
  If you want to output text at a certain position it is more convenient to use <strong>ps_show_xy()</strong> instead
  of setting the text position and calling <strong>ps_show()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      x-coordinate of the new text position.
  <info>float</info>     <strong>$y</strong>      y-coordinate of the new text position.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_set_value()</strong>
   * <strong>ps_show()</strong>


id: ps_set_value
type: function
doc:
<comment>Description:</comment>
  Sets certain values
  
  Sets several values which are used by many functions. Parameters are by definition float values.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>   The <strong>$name</strong> can be one of the following: textrendering The way how text is shown.
                    textx The x coordinate for text output. texty The y coordinate for text output.
                    wordspacing The distance between words relative to the width of a space. leading
                    The distance between lines in pixels.
                    
                    The way how text is shown.
                    
                    The x coordinate for text output.
                    
                    The y coordinate for text output.
                    
                    The distance between words relative to the width of a space.
                    
                    The distance between lines in pixels.
  <info>float</info>     <strong>$value</strong>  The value of the parameter.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_get_value()</strong>
   * <strong>ps_set_parameter()</strong>


id: ps_setcolor
type: function
doc:
<comment>Description:</comment>
  Sets current color
  
  Sets the color for drawing, filling, or both.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>       Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>        The parameter <strong>$type</strong> can be  <return>both</return>, <return>fill</return>, or <return>fillstroke</return>.
  <info>string</info>    <strong>$colorspace</strong>  The colorspace should be one of <return>gray</return>, <return>rgb</return>, <return>cmyk</return>,  <return>spot</return>, <return>pattern</return>. Depending
                         on the colorspace either only the first, the first three or all parameters
                         will be used.
  <info>float</info>     <strong>$c1</strong>          Depending on the colorspace this is either the red component (rgb), the
                         cyan component (cmyk), the gray value (gray), the identifier of the spot
                         color or the identifier of the pattern.
  <info>float</info>     <strong>$c2</strong>          Depending on the colorspace this is either the green component (rgb), the
                         magenta component (cmyk).
  <info>float</info>     <strong>$c3</strong>          Depending on the colorspace this is either the blue component (rgb), the
                         yellow component (cmyk).
  <info>float</info>     <strong>$c4</strong>          This must only be set in cmyk colorspace and specifies the black component.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ps_setdash
type: function
doc:
<comment>Description:</comment>
  Sets appearance of a dashed line
  
  Sets the length of the black and white portions of a dashed line.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$on</strong>     The length of the dash.
  <info>float</info>     <strong>$off</strong>    The length of the gap between dashes.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_setpolydash()</strong>


id: ps_setflat
type: function
doc:
<comment>Description:</comment>
  Sets flatness
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$value</strong>  The <strong>$value</strong> must be between 0.2 and 1.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ps_setfont
type: function
doc:
<comment>Description:</comment>
  Sets font to use for following output
  
  Sets a font, which has to be loaded before with <strong>ps_findfont()</strong>. Outputting text without setting a
  font results in an error.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$fontid</strong>  The font identifier as returned by <strong>ps_findfont()</strong>.
  <info>float</info>     <strong>$size</strong>    The size of the font.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_findfont()</strong>
   * <strong>ps_set_text_pos()</strong> for an example.


id: ps_setgray
type: function
doc:
<comment>Description:</comment>
  Sets gray value
  
  Sets the gray value for all following drawing operations.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$gray</strong>   The value must be between 0 (white) and 1 (black).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_setcolor()</strong>


id: ps_setlinecap
type: function
doc:
<comment>Description:</comment>
  Sets appearance of line ends
  
  Sets how line ends look like.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$type</strong>   The type of line ends. Possible values are <return>PS_LINECAP_BUTT</return>, <return>PS_LINECAP_ROUND</return>, or
                    <return>PS_LINECAP_SQUARED</return>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_setlinejoin()</strong>
   * <strong>ps_setlinewidth()</strong>
   * <strong>ps_setmiterlimit()</strong>


id: ps_setlinejoin
type: function
doc:
<comment>Description:</comment>
  Sets how contected lines are joined
  
  Sets how lines are joined.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$type</strong>   The way lines are joined. Possible values are <return>PS_LINEJOIN_MITER</return>,
                    <return>PS_LINEJOIN_ROUND</return>, or <return>PS_LINEJOIN_BEVEL</return>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_setlinecap()</strong>
   * <strong>ps_setlinewidth()</strong>
   * <strong>ps_setmiterlimit()</strong>


id: ps_setlinewidth
type: function
doc:
<comment>Description:</comment>
  Sets width of a line
  
  Sets the line width for all following drawing operations.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>  The width of lines in points.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_setlinecap()</strong>
   * <strong>ps_setlinejoin()</strong>
   * <strong>ps_setmiterlimit()</strong>


id: ps_setmiterlimit
type: function
doc:
<comment>Description:</comment>
  Sets the miter limit
  
  If two lines join in a small angle and the line join is set to <return>PS_LINEJOIN_MITER</return>, then the
  resulting spike will be very long. The miter limit is the maximum ratio of the miter length (the
  length of the spike) and the line width.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$value</strong>  The maximum ratio between the miter length and the line width. Larger values
                    (&gt; 10) will result in very long spikes when two lines meet in a small angle.
                    Keep the default unless you know what you are doing.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_setlinecap()</strong>
   * <strong>ps_setlinejoin()</strong>
   * <strong>ps_setlinewidth()</strong>


id: ps_setoverprintmode
type: function
doc:
<comment>Description:</comment>
  Sets overprint mode
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$mode</strong>   

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ps_setpolydash
type: function
doc:
<comment>Description:</comment>
  Sets appearance of a dashed line
  
  Sets the length of the black and white portions of a dashed line. <strong>ps_setpolydash()</strong> is used to set
  more complicated dash patterns.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$arr</strong>    <strong>$arr</strong> is a list of length elements alternately for the black and white portion.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_setdash()</strong>


id: ps_shading
type: function
doc:
<comment>Description:</comment>
  Creates a shading for later use
  
  Creates a shading, which can be used by <strong>ps_shfill()</strong> or <strong>ps_shading_pattern()</strong>.
  
  The color of the shading can be in any color space except for <return>pattern</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>           Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>            The type of shading can be either <return>radial</return> or <return>axial</return>. Each shading starts
                             with the current fill color and ends with the given color values passed
                             in the parameters <strong>$c1</strong> to <strong>$c4</strong> (see <strong>ps_setcolor()</strong> for their meaning).
  <info></info>          <strong>$x0, x1, y0, y1</strong>  The coordinates <strong>$x0</strong>, <strong>$y0</strong>, <strong>$x1</strong>, <strong>$y1</strong> are the start and end point of the
                             shading. If the type of shading is <return>radial</return> the two points are the middle
                             points of a starting and ending circle.
  <info></info>          <strong>$c1, c2, c3, c4</strong>  See <strong>ps_setcolor()</strong> for their meaning.
  <info>string</info>    <strong>$optlist</strong>         If the shading is of type <return>radial</return> the <strong>$optlist</strong> must also contain the
                             parameters <return>r0</return> and <return>r1</return> with the radius of the start and end circle.

<comment>Return:</comment>
  <info>int|false</info>  Returns the identifier of the pattern  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_shading_pattern()</strong>
   * <strong>ps_shfill()</strong>


id: ps_shading_pattern
type: function
doc:
<comment>Description:</comment>
  Creates a pattern based on a shading
  
  Creates a pattern based on a shading, which has to be created before with <strong>ps_shading()</strong>. Shading
  patterns can be used like regular patterns.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>      Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$shadingid</strong>  The identifier of a shading previously created with <strong>ps_shading()</strong>.
  <info>string</info>    <strong>$optlist</strong>    This argument is not currently used.

<comment>Return:</comment>
  <info>int|false</info>  The identifier of the pattern  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_shading()</strong>
   * <strong>ps_shfill()</strong>


id: ps_shfill
type: function
doc:
<comment>Description:</comment>
  Fills an area with a shading
  
  Fills an area with a shading, which has to be created before with <strong>ps_shading()</strong>. This is an
  alternative way to creating a pattern from a shading <strong>ps_shading_pattern()</strong> and using the pattern as
  the filling color.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>      Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$shadingid</strong>  The identifier of a shading previously created with <strong>ps_shading()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_shading()</strong>
   * <strong>ps_shading_pattern()</strong>


id: ps_show
type: function
doc:
<comment>Description:</comment>
  Output text
  
  Output a text at the current text position. The text position can be set by storing the x and y
  coordinates into the values <return>textx</return> and <return>texty</return> with the function <strong>ps_set_value()</strong>. The function will
  issue an error if a font was not set before with <strong>ps_setfont()</strong>.
  
  <strong>ps_show()</strong> evaluates the following parameters and values as set by <strong>ps_set_parameter()</strong> and
  <strong>ps_set_value()</strong>.
  
  Distance between two consecutive glyphs. If this value is unequal to zero then all ligatures will
  be resolved. Values less than zero are allowed.
  
  Setting this parameter to "false" will turn off kerning. Kerning is turned on by default.
  
  Setting this parameter to "false" will turn off the use of ligatures.  Ligatures are turned on by
  default.
  
  Setting this parameter to "true" will turn on underlining. Underlining is turned off by default.
  
  Setting this parameter to "true" will turn on overlining. Overlining is turned off by default.
  
  Setting this parameter to "true" will turn on striking out. Striking out is turned off by default.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   The text to be output.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_continue_text()</strong>
   * <strong>ps_show_xy()</strong>
   * <strong>ps_setfont()</strong>


id: ps_show2
type: function
doc:
<comment>Description:</comment>
  Output a text at current position
  
  Output text at the current position. Do not print more than <strong>$len</strong> characters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   The text to be output.
  <info>int</info>       <strong>$len</strong>    The maximum number of characters to print.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ps_show_boxed
type: function
doc:
<comment>Description:</comment>
  Output text in a box
  
  Outputs a text in a given box. The lower left corner of the box is at (<strong>$left</strong>, <strong>$bottom</strong>). Line
  breaks will be inserted where needed. Multiple spaces are treated as one. Tabulators are treated
  as spaces.
  
  The text will be hyphenated if the parameter <strong>$hyphenation</strong> is set to <info>true</info> and the parameter
  <strong>$hyphendict</strong> contains a valid filename for a hyphenation file. The line spacing is taken from the
  value <return>leading</return>. Paragraphs can be separated by an empty line just like in TeX. If the value
  <return>parindent</return> is set to value &gt; 0.0 then the first n lines will be indented. The number n of lines
  is set by the parameter <return>numindentlines</return>. In order to prevent indenting of the first m paragraphs
  set the value <return>parindentskip</return> to a positive number.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>       Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>        The text to be output into the given box.
  <info>float</info>     <strong>$left</strong>        x-coordinate of the lower left corner of the box.
  <info>float</info>     <strong>$bottom</strong>      y-coordinate of the lower left corner of the box.
  <info>float</info>     <strong>$width</strong>       Width of the box.
  <info>float</info>     <strong>$height</strong>      Height of the box.
  <info>string</info>    <strong>$hmode</strong>       The parameter <strong>$hmode</strong> can be <return>justify</return>, <return>fulljustify</return>, <return>right</return>, <return>left</return>, or <return>center</return>.
                         The difference of <return>justify</return> and <return>fulljustify</return> just affects the last line of the
                         box. In <return>fulljustify</return> mode the last line will be left and right justified
                         unless this is also the last line of paragraph. In <return>justify</return> mode it will
                         always be left justified.
  <info>string</info>    <strong>$feature</strong>     
  <info></info>          <strong>$hyphendict</strong>  Set to <info>true</info> in order to turn hyphenation on. This requires a dictionary to
                         be set with the parameter <strong>$hyphendict</strong>. Defaults to <info>false</info>.

<comment>Return:</comment>
  <info>int</info>  Number of characters that could not be written.

<comment>See Also:</comment>
   * <strong>ps_continue_text()</strong>


id: ps_show_xy
type: function
doc:
<comment>Description:</comment>
  Output text at given position
  
  Output a text at the given text position.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   The text to be output.
  <info>float</info>     <strong>$x</strong>      x-coordinate of the lower left corner of the box surrounding the text.
  <info>float</info>     <strong>$y</strong>      y-coordinate of the lower left corner of the box surrounding the text.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_continue_text()</strong>
   * <strong>ps_show()</strong>


id: ps_show_xy2
type: function
doc:
<comment>Description:</comment>
  Output text at position
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ps_string_geometry
type: function
doc:
<comment>Description:</comment>
  Gets geometry of a string
  
  This function is similar to <strong>ps_stringwidth()</strong> but returns an array of dimensions containing the
  width, ascender, and descender of the text.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>    The text for which the geometry is to be calculated.
  <info>int</info>       <strong>$fontid</strong>  The identifier of the font to be used. If not font is specified the current
                     font will be used.
  <info>float</info>     <strong>$size</strong>    The size of the font. If no size is specified the current size is used.

<comment>Return:</comment>
  <info>array</info>  An array of the dimensions of a string. The element 'width' contains the width of the
         string as returned by <strong>ps_stringwidth()</strong>. The element 'descender' contains the maximum
         descender and 'ascender' the maximum ascender of the string.

<comment>See Also:</comment>
   * <strong>ps_continue_text()</strong>
   * <strong>ps_stringwidth()</strong>


id: ps_stringwidth
type: function
doc:
<comment>Description:</comment>
  Gets width of a string
  
  Calculates the width of a string in points if it was output in the given font and font size. This
  function needs an Adobe font metrics file to calculate the precise width. If kerning is turned on,
  it will be taken into account.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>    The text for which the width is to be calculated.
  <info>int</info>       <strong>$fontid</strong>  The identifier of the font to be used. If not font is specified the current
                     font will be used.
  <info>float</info>     <strong>$size</strong>    The size of the font. If no size is specified the current size is used.

<comment>Return:</comment>
  <info>float</info>  Width of a string in points.

<comment>See Also:</comment>
   * <strong>ps_string_geometry()</strong>


id: ps_stroke
type: function
doc:
<comment>Description:</comment>
  Draws the current path
  
  Draws the path constructed with previously called drawing functions like <strong>ps_lineto()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_closepath_stroke()</strong>
   * <strong>ps_fill()</strong>
   * <strong>ps_fill_stroke()</strong>


id: ps_symbol
type: function
doc:
<comment>Description:</comment>
  Output a glyph
  
  Output the glyph at position <strong>$ord</strong> in the font encoding vector of the current font. The font
  encoding for a font can be set when loading the font with <strong>ps_findfont()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$ord</strong>    The position of the glyph in the font encoding vector.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_symbol_name()</strong>
   * <strong>ps_symbol_width()</strong>


id: ps_symbol_name
type: function
doc:
<comment>Description:</comment>
  Gets name of a glyph
  
  This function needs an Adobe font metrics file to know which glyphs are available.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$ord</strong>     The parameter <strong>$ord</strong> is the position of the glyph in the font encoding vector.
  <info>int</info>       <strong>$fontid</strong>  The identifier of the font to be used. If not font is specified the current
                     font will be used.

<comment>Return:</comment>
  <info>string</info>  The name of a glyph in the given font.

<comment>See Also:</comment>
   * <strong>ps_symbol()</strong>
   * <strong>ps_symbol_width()</strong>


id: ps_symbol_width
type: function
doc:
<comment>Description:</comment>
  Gets width of a glyph
  
  Calculates the width of a glyph in points if it was output in the given font and font size.  This
  function needs an Adobe font metrics file to calculate the precise width.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$ord</strong>     The position of the glyph in the font encoding vector.
  <info>int</info>       <strong>$fontid</strong>  The identifier of the font to be used. If not font is specified the current
                     font will be used.
  <info>float</info>     <strong>$size</strong>    The size of the font. If no size is specified the current size is used.

<comment>Return:</comment>
  <info>float</info>  The width of a glyph in points.

<comment>See Also:</comment>
   * <strong>ps_symbol()</strong>
   * <strong>ps_symbol_name()</strong>


id: ps_translate
type: function
doc:
<comment>Description:</comment>
  Sets translation
  
  Sets a new initial point of the coordinate system.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      x-coordinate of the origin of the translated coordinate system.
  <info>float</info>     <strong>$y</strong>      y-coordinate of the origin of the translated coordinate system.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ps_scale()</strong>
   * <strong>ps_rotate()</strong>


id: pspell_add_to_personal
type: function
doc:
<comment>Description:</comment>
  Add the word to a personal wordlist
  
  <strong>pspell_add_to_personal()</strong> adds a word to the personal wordlist. If you used <strong>pspell_new_config()</strong>
  with <strong>pspell_config_personal()</strong> to open the dictionary, you can save the wordlist later with
  <strong>pspell_save_wordlist()</strong>.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Uma instância de <class>PSpell\Dictionary</class>.
  <info>string</info>             <strong>$word</strong>        The added word.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: pspell_add_to_session
type: function
doc:
<comment>Description:</comment>
  Add the word to the wordlist in the current session
  
  <strong>pspell_add_to_session()</strong> adds a word to the wordlist associated with the current session. It is
  very similar to <strong>pspell_add_to_personal()</strong>

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Uma instância de <class>PSpell\Dictionary</class>.
  <info>string</info>             <strong>$word</strong>        The added word.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: pspell_check
type: function
doc:
<comment>Description:</comment>
  Check a word
  
  <strong>pspell_check()</strong> checks the spelling of a word.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Uma instância de <class>PSpell\Dictionary</class>.
  <info>string</info>             <strong>$word</strong>        The tested word.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the spelling is correct, <info>false</info> if not.


id: pspell_clear_session
type: function
doc:
<comment>Description:</comment>
  Clear the current session
  
  <strong>pspell_clear_session()</strong> clears the current session. The current wordlist becomes blank, and, for
  example, if you try to save it with <strong>pspell_save_wordlist()</strong>, nothing happens.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Uma instância de <class>PSpell\Dictionary</class>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: pspell_config_create
type: function
doc:
<comment>Description:</comment>
  Create a config used to open a dictionary
  
  Create a config used to open a dictionary.
  
  <strong>pspell_config_create()</strong> has a very similar syntax to <strong>pspell_new()</strong>. In fact, using
  <strong>pspell_config_create()</strong> immediately followed by <strong>pspell_new_config()</strong> will produce the exact same
  result. However, after creating a new config, you can also use <strong>pspell_config_*()</strong> functions before
  calling <strong>pspell_new_config()</strong> to take advantage of some advanced functionality.
  
  For more information and examples, check out inline manual pspell website:http://aspell.net/.

<comment>Param:</comment>
  <info>string</info>  <strong>$language</strong>  The language parameter is the language code which consists of the two letter
                     ISO 639 language code and an optional two letter ISO 3166 country code after a
                     dash or underscore.
  <info>string</info>  <strong>$spelling</strong>  The spelling parameter is the requested spelling for languages with more than
                     one spelling such as English. Known values are 'american', 'british', and
                     'canadian'.
  <info>string</info>  <strong>$jargon</strong>    The jargon parameter contains extra information to distinguish two different
                     words lists that have the same language and spelling parameters.
  <info>string</info>  <strong>$encoding</strong>  The encoding parameter is the encoding that words are expected to be in.  Valid
                     values are 'utf-8', 'iso8859-*', 'koi8-r', 'viscii', 'cp1252', 'machine
                     unsigned 16', 'machine unsigned 32'. This parameter is largely untested, so be
                     careful when using.

<comment>Return:</comment>
  <info>PSpell\Config</info>  Returns an <class>PSpell\Config</class> instance.


id: pspell_config_data_dir
type: function
doc:
<comment>Description:</comment>
  Location of language data files
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: pspell_config_dict_dir
type: function
doc:
<comment>Description:</comment>
  Location of the main word list
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: pspell_config_ignore
type: function
doc:
<comment>Description:</comment>
  Ignore words less than N characters long
  
  <strong>pspell_config_ignore()</strong> should be used on a config before calling <strong>pspell_new_config()</strong>. This
  function allows short words to be skipped by the spell checker.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>      Uma instância de <class>PSpell\Config</class>.
  <info>int</info>            <strong>$min_length</strong>  Words less than <strong>$min_length</strong> characters will be skipped.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: pspell_config_mode
type: function
doc:
<comment>Description:</comment>
  Change the mode number of suggestions returned
  
  <strong>pspell_config_mode()</strong> should be used on a config before calling <strong>pspell_new_config()</strong>. This function
  determines how many suggestions will be returned by <strong>pspell_suggest()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  Uma instância de <class>PSpell\Config</class>.
  <info>int</info>            <strong>$mode</strong>    The mode parameter is the mode in which spellchecker will work. There are
                          several modes available: <info>PSPELL_FAST</info> - Fast mode (least number of
                          suggestions) <info>PSPELL_NORMAL</info> - Normal mode (more suggestions)
                          <info>PSPELL_BAD_SPELLERS</info> - Slow mode (a lot of suggestions)
                          
                          <info>PSPELL_FAST</info> - Fast mode (least number of suggestions)
                          
                          <info>PSPELL_NORMAL</info> - Normal mode (more suggestions)
                          
                          <info>PSPELL_BAD_SPELLERS</info> - Slow mode (a lot of suggestions)

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: pspell_config_personal
type: function
doc:
<comment>Description:</comment>
  Set a file that contains personal wordlist
  
  Set a file that contains personal wordlist. The personal wordlist will be loaded and used in
  addition to the standard one after you call <strong>pspell_new_config()</strong>. The file is also the file where
  <strong>pspell_save_wordlist()</strong> will save personal wordlist to.
  
  <strong>pspell_config_personal()</strong> should be used on a config before calling <strong>pspell_new_config()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>    Uma instância de <class>PSpell\Config</class>.
  <info>string</info>         <strong>$filename</strong>  The personal wordlist. If the file does not exist, it will be created.
                            The file should be writable by whoever PHP runs as (e.g. nobody).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: pspell_config_repl
type: function
doc:
<comment>Description:</comment>
  Set a file that contains replacement pairs
  
  Set a file that contains replacement pairs.
  
  The replacement pairs improve the quality of the spellchecker. When a word is misspelled, and a
  proper suggestion was not found in the list, <strong>pspell_store_replacement()</strong> can be used to store a
  replacement pair and then <strong>pspell_save_wordlist()</strong> to save the wordlist along with the replacement
  pairs.
  
  <strong>pspell_config_repl()</strong> should be used on a config before calling <strong>pspell_new_config()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>    Uma instância de <class>PSpell\Config</class>.
  <info>string</info>         <strong>$filename</strong>  The file should be writable by whoever PHP runs as (e.g. nobody).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: pspell_config_runtogether
type: function
doc:
<comment>Description:</comment>
  Consider run-together words as valid compounds
  
  This function determines whether run-together words will be treated as legal compounds.  That is,
  "thecat" will be a legal compound, although there should be a space between the two words.
  Changing this setting only affects the results returned by <strong>pspell_check()</strong>; <strong>pspell_suggest()</strong> will
  still return suggestions.
  
  <strong>pspell_config_runtogether()</strong> should be used on a config before calling <strong>pspell_new_config()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  Uma instância de <class>PSpell\Config</class>.
  <info>bool</info>           <strong>$allow</strong>   <info>true</info> if run-together words should be treated as legal compounds, <info>false</info>
                          otherwise.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: pspell_config_save_repl
type: function
doc:
<comment>Description:</comment>
  Determine whether to save a replacement pairs list
    along with the wordlist
  
  <strong>pspell_config_save_repl()</strong> determines whether <strong>pspell_save_wordlist()</strong> will save the replacement
  pairs along with the wordlist. Usually there is no need to use this function because if
  <strong>pspell_config_repl()</strong> is used, the replacement pairs will be saved by <strong>pspell_save_wordlist()</strong>
  anyway, and if it is not, the replacement pairs will not be saved.
  
  <strong>pspell_config_save_repl()</strong> should be used on a config before calling <strong>pspell_new_config()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  Uma instância de <class>PSpell\Config</class>.
  <info>bool</info>           <strong>$save</strong>    <info>true</info> if replacement pairs should be saved, <info>false</info> otherwise.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: pspell_new
type: function
doc:
<comment>Description:</comment>
  Load a new dictionary
  
  <strong>pspell_new()</strong> opens up a new dictionary and returns an <class>PSpell\Dictionary</class> instance for use in other
  pspell functions.
  
  For more information and examples, check out inline manual pspell website:http://aspell.net/.

<comment>Param:</comment>
  <info>string</info>  <strong>$language</strong>  The language parameter is the language code which consists of the two letter
                     ISO 639 language code and an optional two letter ISO 3166 country code after a
                     dash or underscore.
  <info>string</info>  <strong>$spelling</strong>  The spelling parameter is the requested spelling for languages with more than
                     one spelling such as English. Known values are 'american', 'british', and
                     'canadian'.
  <info>string</info>  <strong>$jargon</strong>    The jargon parameter contains extra information to distinguish two different
                     words lists that have the same language and spelling parameters.
  <info>string</info>  <strong>$encoding</strong>  The encoding parameter is the encoding that words are expected to be in.  Valid
                     values are 'utf-8', 'iso8859-*', 'koi8-r', 'viscii', 'cp1252', 'machine
                     unsigned 16', 'machine unsigned 32'. This parameter is largely untested, so be
                     careful when using.
  <info>int</info>     <strong>$mode</strong>      The mode parameter is the mode in which spellchecker will work. There are
                     several modes available: <info>PSPELL_FAST</info> - Fast mode (least number of suggestions)
                     <info>PSPELL_NORMAL</info> - Normal mode (more suggestions) <info>PSPELL_BAD_SPELLERS</info> - Slow mode
                     (a lot of suggestions) <info>PSPELL_RUN_TOGETHER</info> - Consider run-together words as
                     legal compounds.  That is, "thecat" will be a legal compound, although there
                     should be a space between the two words. Changing this setting only affects the
                     results returned by <strong>pspell_check()</strong>; <strong>pspell_suggest()</strong> will still return
                     suggestions.  Mode is a bitmask constructed from different constants listed
                     above. However, <info>PSPELL_FAST</info>, <info>PSPELL_NORMAL</info> and <info>PSPELL_BAD_SPELLERS</info> are mutually
                     exclusive, so you should select only one of them.
                     
                     <info>PSPELL_FAST</info> - Fast mode (least number of suggestions)
                     
                     <info>PSPELL_NORMAL</info> - Normal mode (more suggestions)
                     
                     <info>PSPELL_BAD_SPELLERS</info> - Slow mode (a lot of suggestions)
                     
                     <info>PSPELL_RUN_TOGETHER</info> - Consider run-together words as legal compounds.  That is,
                     "thecat" will be a legal compound, although there should be a space between the
                     two words. Changing this setting only affects the results returned by
                     <strong>pspell_check()</strong>; <strong>pspell_suggest()</strong> will still return suggestions.

<comment>Return:</comment>
  <info>PSpell\Dictionary|false</info>  Returns an <class>PSpell\Dictionary</class> instance on success, ou <info>false</info> em caso de
                           falha.


id: pspell_new_config
type: function
doc:
<comment>Description:</comment>
  Load a new dictionary with settings based on a given config
    
  
  <strong>pspell_new_config()</strong> opens up a new dictionary with settings specified in a <strong>$config</strong>, created with
  <strong>pspell_config_create()</strong> and modified with <strong>pspell_config_*()</strong> functions. This method provides you
  with the most flexibility and has all the functionality provided by <strong>pspell_new()</strong> and
  <strong>pspell_new_personal()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  The <strong>$config</strong> parameter is the one returned by <strong>pspell_config_create()</strong> when
                          the config was created.

<comment>Return:</comment>
  <info>PSpell\Dictionary|false</info>  Returns an <class>PSpell\Dictionary</class> instance on success,  ou <info>false</info> em caso de
                           falha


id: pspell_new_personal
type: function
doc:
<comment>Description:</comment>
  Load a new dictionary with personal wordlist
  
  <strong>pspell_new_personal()</strong> opens up a new dictionary with a personal wordlist. The wordlist can be
  modified and saved with <strong>pspell_save_wordlist()</strong>, if desired. However, the replacement pairs are not
  saved. In order to save replacement pairs, you should create a config using
  <strong>pspell_config_create()</strong>, set the personal wordlist file with <strong>pspell_config_personal()</strong>, set the file
  for replacement pairs with <strong>pspell_config_repl()</strong>, and open a new dictionary with
  <strong>pspell_new_config()</strong>.
  
  For more information and examples, check out inline manual pspell website:http://aspell.net/.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The file where words added to the personal list will be stored. It should be an
                     absolute filename beginning with '/' because otherwise it will be relative to
                     $HOME, which is "/root" for most systems, and is probably not what you want.
  <info>string</info>  <strong>$language</strong>  The language code which consists of the two letter ISO 639 language code and an
                     optional two letter ISO 3166 country code after a dash or underscore.
  <info>string</info>  <strong>$spelling</strong>  The requested spelling for languages with more than one spelling such as
                     English. Known values are 'american', 'british', and 'canadian'.
  <info>string</info>  <strong>$jargon</strong>    Extra information to distinguish two different words lists that have the same
                     language and spelling parameters.
  <info>string</info>  <strong>$encoding</strong>  The encoding that words are expected to be in.  Valid values are <return>utf-8</return>,
                     <return>iso8859-*</return>,  <return>koi8-r</return>, <return>viscii</return>,  <return>cp1252</return>, <return>machine unsigned 16</return>,  <return>machine unsigned 32</return>.
  <info>int</info>     <strong>$mode</strong>      The mode in which spellchecker will work. There are several modes available:
                     <info>PSPELL_FAST</info> - Fast mode (least number of suggestions) <info>PSPELL_NORMAL</info> - Normal
                     mode (more suggestions) <info>PSPELL_BAD_SPELLERS</info> - Slow mode (a lot of suggestions)
                     <info>PSPELL_RUN_TOGETHER</info> - Consider run-together words as legal compounds.  That is,
                     "thecat" will be a legal compound, although there should be a space between the
                     two words. Changing this setting only affects the results returned by
                     <strong>pspell_check()</strong>; <strong>pspell_suggest()</strong> will still return suggestions.  Mode is a
                     bitmask constructed from different constants listed above. However,
                     <info>PSPELL_FAST</info>, <info>PSPELL_NORMAL</info> and <info>PSPELL_BAD_SPELLERS</info> are mutually exclusive, so
                     you should select only one of them.
                     
                     <info>PSPELL_FAST</info> - Fast mode (least number of suggestions)
                     
                     <info>PSPELL_NORMAL</info> - Normal mode (more suggestions)
                     
                     <info>PSPELL_BAD_SPELLERS</info> - Slow mode (a lot of suggestions)
                     
                     <info>PSPELL_RUN_TOGETHER</info> - Consider run-together words as legal compounds.  That is,
                     "thecat" will be a legal compound, although there should be a space between the
                     two words. Changing this setting only affects the results returned by
                     <strong>pspell_check()</strong>; <strong>pspell_suggest()</strong> will still return suggestions.

<comment>Return:</comment>
  <info>PSpell\Dictionary|false</info>  Returns an <class>PSpell\Dictionary</class> instance on success, ou <info>false</info> em caso de
                           falha.


id: pspell_save_wordlist
type: function
doc:
<comment>Description:</comment>
  Save the personal wordlist to a file
  
  <strong>pspell_save_wordlist()</strong> saves the personal wordlist from the current session. The location of files
  to be saved specified with <strong>pspell_config_personal()</strong> and (optionally) <strong>pspell_config_repl()</strong>.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Uma instância de <class>PSpell\Dictionary</class>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: pspell_store_replacement
type: function
doc:
<comment>Description:</comment>
  Store a replacement pair for a word
  
  <strong>pspell_store_replacement()</strong> stores a replacement pair for a word, so that replacement can be
  returned by <strong>pspell_suggest()</strong> later. In order to be able to take advantage of this function, you
  have to use <strong>pspell_new_personal()</strong> to open the dictionary. In order to permanently save the
  replacement pair, you have to use <strong>pspell_config_personal()</strong> and <strong>pspell_config_repl()</strong> to set the
  path where to save your custom wordlists, and then use <strong>pspell_save_wordlist()</strong> for the changes to
  be written to disk.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Uma instância de <class>PSpell\Dictionary</class>.
  <info>string</info>             <strong>$misspelled</strong>  The misspelled word.
  <info>string</info>             <strong>$correct</strong>     The fixed spelling for the <strong>$misspelled</strong> word.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: pspell_suggest
type: function
doc:
<comment>Description:</comment>
  Suggest spellings of a word
  
  <strong>pspell_suggest()</strong> returns an array of possible spellings for the given word.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Uma instância de <class>PSpell\Dictionary</class>.
  <info>string</info>             <strong>$word</strong>        The tested word.

<comment>Return:</comment>
  <info>array|false</info>  Returns an array of possible spellings.


id: putenv
type: function
doc:
<comment>Description:</comment>
  Define o valor de uma variável de ambiente
  
  Adiciona <strong>$assignment</strong> no ambiente do servidor. A variável de ambiente irá existir somente durante a
  requisição atual. Ao final da requisição o ambiente é restaurado ao seu estado original.

<comment>Param:</comment>
  <info>string</info>  <strong>$assignment</strong>  A definição, como <return>"FOO=BAR"</return>

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>getenv()</strong>
   * <strong>apache_setenv()</strong>


id: quoted_printable_decode
type: function
doc:
<comment>Description:</comment>
  Converte uma string Quoted-Printable para uma string de 8 bits
  
  Esta função retorna uma string binária de 8 bits correspondendo à string Quoted-Printable
  decodificada (de acordo com a RFC2045 seção 6.7, e não à RFC2821 seção 4.5.2, de forma que pontos
  adicionais não são removidos do início da linha).
  
  Esta função é similar à <strong>imap_qprint()</strong>, exceto que essa não requer o módulo IMAP para funcionar.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string de entrada.

<comment>Return:</comment>
  <info>string</info>  Retorna uma string binária de 8 bits.

<comment>See Also:</comment>
   * <strong>quoted_printable_encode()</strong>


id: quoted_printable_encode
type: function
doc:
<comment>Description:</comment>
  Converte uma string de 8 bits para uma string Quoted-Printable
  
  Retorna uma string Quoted-Printable de acordo com a RFC2045 seção 6.7.
  
  Esta função é similar à <strong>imap_8bit()</strong>, exceto que essa não requer o módulo IMAP para funcionar.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string de entrada.

<comment>Return:</comment>
  <info>string</info>  Retorna a string codificada.

<comment>See Also:</comment>
   * <strong>quoted_printable_decode()</strong>
   * <strong>iconv_mime_encode()</strong>


id: quotemeta
type: function
doc:
<comment>Description:</comment>
  Quote meta characters
  
  Returns a version of str with a backslash character (<return>\</return>) before every character that is among
  these:  . \ + * ? [ ^ ] ( $ )

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The input string.

<comment>Return:</comment>
  <info>string</info>  Returns the string with meta characters quoted, or <info>false</info> if an empty string is given as
          <strong>$string</strong>.

<comment>See Also:</comment>
   * <strong>addslashes()</strong>
   * <strong>addcslashes()</strong>
   * <strong>htmlentities()</strong>
   * <strong>htmlspecialchars()</strong>
   * <strong>nl2br()</strong>
   * <strong>stripslashes()</strong>
   * <strong>stripcslashes()</strong>
   * <strong>preg_quote()</strong>


id: rad2deg
type: function
doc:
<comment>Description:</comment>
  Converte o número em radianos para o equivalente em graus
    
  
  Esta função converte <strong>$num</strong> de radianos para graus.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  Um valor em radianos

<comment>Return:</comment>
  <info>float</info>  O equivalente de <strong>$num</strong> em graus

<comment>See Also:</comment>
   * <strong>deg2rad()</strong>


id: radius_acct_open
type: function
doc:
<comment>Description:</comment>
  Creates a Radius handle for accounting

<comment>Return:</comment>
  <info>resource</info>  Returns a handle on success, <info>false</info> on error. This function only fails if insufficient
            memory is available.


id: radius_add_server
type: function
doc:
<comment>Description:</comment>
  Adds a server
  
  <strong>radius_add_server()</strong> may be called multiple times, and it may be used together with
  <strong>radius_config()</strong>. At most 10 servers may be specified. When multiple servers are given, they are
  tried in round-robin fashion until a valid response is received, or until each server's <strong>$max_tries</strong>
  limit has been reached.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  
  <info>string</info>    <strong>$hostname</strong>       The <strong>$hostname</strong> parameter specifies the server host, either as a fully
                            qualified domain name or as a dotted-quad IP address in text form.
  <info>int</info>       <strong>$port</strong>           The <strong>$port</strong> specifies the UDP port to contact on the server. If port is
                            given as 0, the library looks up the radius/udp or radacct/udp service
                            in the network services database, and uses the port found there.  If no
                            entry is found, the library uses the standard Radius ports, 1812 for
                            authentication and 1813 for accounting.
  <info>string</info>    <strong>$secret</strong>         The shared secret for the server host is passed to the <strong>$secret</strong>
                            parameter. The Radius protocol ignores all but the leading 128 bytes of
                            the shared secret.
  <info>int</info>       <strong>$timeout</strong>        The timeout for receiving replies from the server is passed to the
                            <strong>$timeout</strong> parameter, in units of seconds.
  <info>int</info>       <strong>$max_tries</strong>      The maximum number of repeated requests to make before giving up is
                            passed into the <strong>$max_tries</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>radius_config()</strong>


