code
stringlengths 17
247k
| docstring
stringlengths 30
30.3k
| func_name
stringlengths 1
89
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
153
| url
stringlengths 51
209
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
public function getCACert() {} | Get path to the CA cert file in PEM format
@return string|null | getCACert | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setCACert($cacert) {} | Set path to the CA cert file in PEM format
@param string $cacert
@return void | setCACert | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getCert() {} | Get path to the client certificate in PEM format
@return string|null | getCert | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setCert($cert) {} | Set path to the client certificate in PEM format
@param string $cert
@return void | setCert | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getKey() {} | Get path to the client key in PEM format
@return string|null | getKey | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setKey($key) {} | Set path to the client key in PEM format
@param string|null $key
@return void | setKey | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getVerify() {} | Get whether peer verification enabled or disabled
@return bool | getVerify | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setVerify($verify) {} | Enable or disable peer verification
@param bool $verify
@return void | setVerify | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getSaslMethod() {} | Get authentication mechanism configuration
@return int AMQP_SASL_METHOD_PLAIN | AMQP_SASL_METHOD_EXTERNAL | getSaslMethod | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getRoutingKey() {} | Get the routing key of the message.
@return string The message routing key. | getRoutingKey | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getConsumerTag() {} | Get the consumer tag of the message.
@return string|null The consumer tag of the message. | getConsumerTag | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getDeliveryTag() {} | Get the delivery tag of the message.
@return int|null The delivery tag of the message. | getDeliveryTag | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getExchangeName() {} | Get the exchange name on which the message was published.
@return string|null The exchange name on which the message was published. | getExchangeName | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function isRedelivery() {} | Whether this is a redelivery of the message.
Whether this is a redelivery of a message. If this message has been
delivered and AMQPEnvelope::nack() was called, the message will be put
back on the queue to be redelivered, at which point the message will
always return TRUE when this method is called.
@return bool TRUE if this is a redelivery, FALSE otherwise. | isRedelivery | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getHeader($headerName) {} | Get a specific message header.
@param string $headerName Name of the header to get the value from.
@return mixed The contents of the specified header or null if not set. | getHeader | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function hasHeader($headerName) {} | Check whether specific message header exists.
@param string $headerName Name of the header to check.
@return bool | hasHeader | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function __construct(AMQPChannel $channel) {} | Create an instance of AMQPExchange.
Returns a new instance of an AMQPExchange object, associated with the
given AMQPChannel object.
@param AMQPChannel $channel A valid AMQPChannel object, connected
to a broker.
@throws AMQPExchangeException When amqp_channel is not connected to
a broker.
@throws AMQPConnectionException If the connection to the broker was
lost. | __construct | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function bind($exchangeName, $routingKey = '', array $arguments = []) {} | Bind to another exchange.
Bind an exchange to another exchange using the specified routing key.
@param string $exchangeName Name of the exchange to bind.
@param string $routingKey The routing key to use for binding.
@param array $arguments Additional binding arguments.
@throws AMQPExchangeException On failure.
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@return void | bind | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function unbind($exchangeName, $routingKey = '', array $arguments = []) {} | Remove binding to another exchange.
Remove a routing key binding on an another exchange from the given exchange.
@param string $exchangeName Name of the exchange to bind.
@param string $routingKey The routing key to use for binding.
@param array $arguments Additional binding arguments.
@throws AMQPExchangeException On failure.
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@return void | unbind | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function declareExchange() {} | Declare a new exchange on the broker.
@throws AMQPExchangeException On failure.
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@return void | declareExchange | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function delete($exchangeName = null, $flags = AMQP_NOPARAM) {} | Delete the exchange from the broker.
@param string $exchangeName Optional name of exchange to delete.
@param int $flags Optionally AMQP_IFUNUSED can be specified
to indicate the exchange should not be
deleted until no clients are connected to
it.
@throws AMQPExchangeException On failure.
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@return void | delete | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getArgument($argumentName) {} | Get the argument associated with the given key.
Get the argument associated with the given key.
@param string $argumentName The key to look up.
@throws AMQPExchangeException If key does not exist
@return bool|int|float|string|null | getArgument | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function hasArgument($argumentName) {} | Check whether argument associated with the given key exists.
@param string $argumentName The key to look up.
@return bool | hasArgument | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getArguments() {} | Get all arguments set on the given exchange.
@return array An array containing all of the set key/value pairs. | getArguments | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getFlags() {} | Get all the flags currently set on the given exchange.
@return int An integer bitmask of all the flags currently set on this
exchange object. | getFlags | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function publish(
$message,
$routingKey = null,
$flags = null,
array $headers = []
) {} | Publish a message to an exchange.
Publish a message to the exchange represented by the AMQPExchange object.
@param string $message The message to publish.
@param string|null $routingKey The optional routing key to which to
publish to.
@param int|null $flags One or more of AMQP_MANDATORY and
AMQP_IMMEDIATE.
@param array $headers One of content_type, content_encoding,
message_id, user_id, app_id, delivery_mode,
priority, timestamp, expiration, type
or reply_to, headers.
@throws AMQPExchangeException On failure.
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@return void | publish | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setArgument($argumentName, $argumentValue) {} | Set the value for the given key.
@param string $argumentName Name of the argument to set.
@param string|int $argumentValue Value of the argument to set.
@return void | setArgument | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setArguments(array $arguments) {} | Set all arguments on the exchange.
@param array $arguments An array of key/value pairs of arguments.
@return bool TRUE on success or FALSE on failure. | setArguments | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setFlags($flags) {} | Set the flags on an exchange.
@param int|null $flags A bitmask of flags. This call currently only
considers the following flags:
AMQP_DURABLE, AMQP_PASSIVE
(and AMQP_DURABLE, if librabbitmq version >= 0.5.3)
@return void | setFlags | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setType($exchangeType) {} | Set the type of the exchange.
Set the type of the exchange. This can be any of AMQP_EX_TYPE_DIRECT,
AMQP_EX_TYPE_FANOUT, AMQP_EX_TYPE_HEADERS or AMQP_EX_TYPE_TOPIC.
@param string $exchangeType The type of exchange as a string.
@return void | setType | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getChannel() {} | Get the AMQPChannel object in use
@return AMQPChannel | getChannel | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function ack($deliveryTag, $flags = null) {} | Acknowledge the receipt of a message.
This method allows the acknowledgement of a message that is retrieved
without the AMQP_AUTOACK flag through AMQPQueue::get() or
AMQPQueue::consume()
@param int $deliveryTag The message delivery tag of which to
acknowledge receipt.
@param int|null $flags The only valid flag that can be passed is
AMQP_MULTIPLE.
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@return void | ack | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function bind($exchangeName, $routingKey = null, array $arguments = []) {} | Bind the given queue to a routing key on an exchange.
@param string $exchangeName Name of the exchange to bind to.
@param string|null $routingKey Pattern or routing key to bind with.
@param array $arguments Additional binding arguments.
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@return bool | bind | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function cancel($consumer_tag = '') {} | Cancel a queue that is already bound to an exchange and routing key.
@param string $consumer_tag The consumer tag cancel. If no tag provided,
or it is empty string, the latest consumer
tag on this queue will be used and after
successful request it will set to null.
If it also empty, no `basic.cancel`
request will be sent. When consumer_tag give
and it equals to latest consumer_tag on queue,
it will be interpreted as latest consumer_tag usage.
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@return bool | cancel | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function consume(
callable $callback = null,
$flags = null,
$consumerTag = null
) {} | Consume messages from a queue.
Blocking function that will retrieve the next message from the queue as
it becomes available and will pass it off to the callback.
@param callable|null $callback A callback function to which the
consumed message will be passed. The
function must accept at a minimum
one parameter, an AMQPEnvelope object,
and an optional second parameter
the AMQPQueue object from which callback
was invoked. The AMQPQueue::consume() will
not return the processing thread back to
the PHP script until the callback
function returns FALSE.
If the callback is omitted or null is passed,
then the messages delivered to this client will
be made available to the first real callback
registered. That allows one to have a single
callback consuming from multiple queues.
@param int|null $flags A bitmask of any of the flags: AMQP_AUTOACK,
AMQP_JUST_CONSUME. Note: when AMQP_JUST_CONSUME
flag used all other flags are ignored and
$consumerTag parameter has no sense.
AMQP_JUST_CONSUME flag prevent from sending
`basic.consume` request and just run $callback
if it provided. Calling method with empty $callback
and AMQP_JUST_CONSUME makes no sense.
@param string|null $consumerTag A string describing this consumer. Used
for canceling subscriptions with cancel().
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@throws AMQPEnvelopeException When no queue found for envelope.
@throws AMQPQueueException If timeout occurs or queue is not exists.
@return void | consume | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function declareQueue() {} | Declare a new queue on the broker.
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@throws AMQPQueueException On failure.
@return int the message count. | declareQueue | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function delete($flags = AMQP_NOPARAM) {} | Delete a queue from the broker.
This includes its entire contents of unread or unacknowledged messages.
@param int $flags Optionally AMQP_IFUNUSED can be specified
to indicate the queue should not be
deleted until no clients are connected to
it.
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@return int The number of deleted messages. | delete | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function get($flags = null) {} | Retrieve the next message from the queue.
Retrieve the next available message from the queue. If no messages are
present in the queue, this function will return NULL immediately. This
is a non blocking alternative to the AMQPQueue::consume() method.
Currently, the only supported flag for the flags parameter is
AMQP_AUTOACK. If this flag is passed in, then the message returned will
automatically be marked as acknowledged by the broker as soon as the
frames are sent to the client.
@param int $flags A bitmask of supported flags for the
method call. Currently, the only the
supported flag is AMQP_AUTOACK. If this
value is not provided, it will use the
value of ini-setting amqp.auto_ack.
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@throws AMQPQueueException If queue is not exist.
@return AMQPEnvelope|null | get | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function nack($deliveryTag, $flags = AMQP_NOPARAM) {} | Mark a message as explicitly not acknowledged.
Mark the message identified by delivery_tag as explicitly not
acknowledged. This method can only be called on messages that have not
yet been acknowledged, meaning that messages retrieved with by
AMQPQueue::consume() and AMQPQueue::get() and using the AMQP_AUTOACK
flag are not eligible. When called, the broker will immediately put the
message back onto the queue, instead of waiting until the connection is
closed. This method is only supported by the RabbitMQ broker. The
behavior of calling this method while connected to any other broker is
undefined.
@param int $deliveryTag Delivery tag of last message to reject.
@param int $flags AMQP_REQUEUE to requeue the message(s),
AMQP_MULTIPLE to nack all previous
unacked messages as well.
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@return bool | nack | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function reject($deliveryTag, $flags = null) {} | Mark one message as explicitly not acknowledged.
Mark the message identified by delivery_tag as explicitly not
acknowledged. This method can only be called on messages that have not
yet been acknowledged, meaning that messages retrieved with by
AMQPQueue::consume() and AMQPQueue::get() and using the AMQP_AUTOACK
flag are not eligible.
@param int $deliveryTag Delivery tag of the message to reject.
@param int|null $flags AMQP_REQUEUE to requeue the message(s).
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@return bool | reject | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function purge() {} | Purge the contents of a queue.
Returns the number of purged messages
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@return int | purge | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setFlags($flags = null) {} | Set the flags on the queue.
@param int|null $flags A bitmask of flags:
AMQP_DURABLE, AMQP_PASSIVE,
AMQP_EXCLUSIVE, AMQP_AUTODELETE.
@return bool | setFlags | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function unbind($exchangeName, $routingKey = null, array $arguments = []) {} | Remove a routing key binding on an exchange from the given queue.
@param string $exchangeName The name of the exchange on which the
queue is bound.
@param string|null $routingKey The binding routing key used by the
queue.
@param array $arguments Additional binding arguments.
@throws AMQPChannelException If the channel is not open.
@throws AMQPConnectionException If the connection to the broker was lost.
@return bool | unbind | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function __construct($host = '', $watcher_cb = null, $recv_timeout = 10000) {} | Create a handle to used communicate with zookeeper.
If the host is provided, attempt to connect.
@param string $host
@param callable $watcher_cb
@param int $recv_timeout
@throws ZookeeperException
@throws ZookeeperConnectionException when host is provided and when failed to connect to the host
@link https://www.php.net/manual/en/zookeeper.construct.php | __construct | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public function connect($host, $watcher_cb = null, $recv_timeout = 10000) {} | Create a handle to used communicate with zookeeper.
@param string $host
@param callable $watcher_cb
@param int $recv_timeout
@throws ZookeeperException
@throws ZookeeperConnectionException when failed to connect to Zookeeper
@link https://www.php.net/manual/en/zookeeper.connect.php | connect | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public function delete($path, $version = -1) {} | Delete a node in zookeeper synchronously.
@param string $path
@param int $version
@return bool
@throws ZookeeperException
@throws ZookeeperNoNodeException when path does not exist
@link https://www.php.net/manual/en/zookeeper.delete.php | delete | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public function set($path, $data, $version = -1, &$stat = null) {} | Sets the data associated with a node.
@param string $path
@param string $data
@param int $version
@param array &$stat
@return bool
@throws ZookeeperException
@throws ZookeeperNoNodeException when path does not exist
@link https://www.php.net/manual/en/zookeeper.set.php | set | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public function get($path, $watcher_cb = null, &$stat = null, $max_size = 0) {} | Gets the data associated with a node synchronously.
@param string $path
@param callable $watcher_cb
@param array &$stat
@param int $max_size
@return string
@throws ZookeeperException
@throws ZookeeperNoNodeException when path does not exist
@link https://www.php.net/manual/en/zookeeper.get.php | get | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public function exists($path, $watcher_cb = null) {} | Checks the existence of a node in zookeeper synchronously.
@param string $path
@param callable $watcher_cb
@return bool
@throws ZookeeperException
@link https://www.php.net/manual/en/zookeeper.exists.php | exists | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public function getAcl($path) {} | Gets the acl associated with a node synchronously.
@param string $path
@return array
@throws ZookeeperException when connection not in connected status
@link https://www.php.net/manual/en/zookeeper.getacl.php | getAcl | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public function setAcl($path, $version, $acls) {} | Sets the acl associated with a node synchronously.
@param string $path
@param int $version
@param array $acls
@return bool
@throws ZookeeperException when connection not in connected status
@link https://www.php.net/manual/en/zookeeper.setacl.php | setAcl | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public function getClientId() {} | return the client session id, only valid if the connections is currently connected
(ie. last watcher state is ZOO_CONNECTED_STATE).
@return int
@throws ZookeeperException
@throws ZookeeperConnectionException when connection not in connected status
@link https://www.php.net/manual/en/zookeeper.getclientid.php | getClientId | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public function getState() {} | Get the state of the zookeeper connection.
@return int
@throws ZookeeperException
@throws ZookeeperConnectionException when connection not in connected status
@link https://www.php.net/manual/en/zookeeper.getstate.php | getState | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public function getRecvTimeout() {} | Return the timeout for this session, only valid if the connections is currently connected
(ie. last watcher state is ZOO_CONNECTED_STATE). This value may change after a server reconnect.
@return int
@throws ZookeeperException
@throws ZookeeperConnectionException when connection not in connected status
@link https://www.php.net/manual/en/zookeeper.getrecvtimeout.php | getRecvTimeout | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public function addAuth($scheme, $cert, $completion_cb = null) {} | Specify application credentials.
@param string $scheme
@param string $cert
@param callable $completion_cb
@return bool
@throws ZookeeperException
@throws ZookeeperConnectionException when connection not in connected status
@link https://www.php.net/manual/en/zookeeper.addauth.php | addAuth | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public function isRecoverable() {} | Checks if the current zookeeper connection state can be recovered.
@return bool
@throws ZookeeperException
@throws ZookeeperConnectionException when connection not in connected status
@link https://www.php.net/manual/en/zookeeper.isrecoverable.php | isRecoverable | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public function setLogStream($file) {} | Sets the stream to be used by the library for logging.
TODO: might be able to set a stream like php://stderr or something
@param resource $file
@return bool
@link https://www.php.net/manual/en/zookeeper.setlogstream.php | setLogStream | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public static function setDebugLevel($level) {} | Sets the debugging level for the library.
@param int $level
@return bool
@link https://www.php.net/manual/en/zookeeper.setdebuglevel.php | setDebugLevel | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public static function setDeterministicConnOrder($trueOrFalse) {} | Enable/disable quorum endpoint order randomization.
@param bool $trueOrFalse
@return bool
@link https://www.php.net/manual/en/zookeeper.setdeterministicconnorder.php | setDeterministicConnOrder | php | JetBrains/phpstorm-stubs | zookeeper/zookeeper.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/zookeeper/zookeeper.php | Apache-2.0 |
public function end(string $error = null) {} | End the COPY operation to the server during pq\Result::COPY_IN state.
@param string $error If set, the COPY operation will abort with provided message.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | end | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function get(string &$data) {} | Receive data from the server during pq\Result::COPY_OUT state.
@param string &$data Data read from the server.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException
@return bool success. | get | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function put(string $data) {} | Send data to the server during pq\Result::COPY_IN state.
@param string $data Data to send to the server.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | put | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function __construct(Connection $conn) {} | Create a new cancellation request for an [asynchronous](pq/Connection/: Asynchronous Usage) query.
@param \pq\Connection $conn The connection to request cancellation on.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | __construct | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function cancel() {} | Perform the cancellation request.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | cancel | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function __construct(string $dsn = "", int $flags = 0) {} | Create a new PostgreSQL connection.
See also [General Usage](pq/Connection/: General Usage).
@param string $dsn A ***connection string*** as described [in the PostgreSQL documentation](http://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING).
@param int $flags See [connection flag constants](pq/Connection#Connection.Flags:).
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | __construct | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function declareAsync(string $name, int $flags, string $query) {} | [Asynchronously](pq/Connection/: Asynchronous Usage) declare a cursor for a query.
> ***NOTE***:
If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row.
@param string $name The identifying name of the cursor.
@param int $flags Any combination of pq\Cursor constants.
@param string $query The query for which to open a cursor.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\RuntimeException
@throws \pq\Exception\BadMethodCallException
@return \pq\Cursor an open cursor instance. | declareAsync | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function escapeBytea(string $binary) {} | Escape binary data for use within a query with the type bytea.
***NOTE:***
The result is not wrapped in single quotes.
@param string $binary The binary data to escape.
@throws \pq\Exception\BadMethodCallException
@return string|false string the escaped binary data.
or FALSE if escaping fails. | escapeBytea | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function exec(string $query) {} | [Execute one or multiple SQL queries](pq/Connection/: Executing Queries) on the connection.
***NOTE:***
Only the last result will be returned, if the query string contains more than one SQL query.
@param string $query The queries to send to the server, separated by semi-colon.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException
@throws \pq\Exception\DomainException
@return \pq\Result | exec | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function execAsync(string $query, callable $callback = null) {} | [Asynchronously](pq/Connection/: Asynchronous Usage) [execute an SQL query](pq/Connection: Executing Queries) on the connection.
> ***NOTE***:
If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row.
@param string $query The query to send to the server.
@param callable $callback as function(pq\Result $res)
The callback to execute when the query finishes.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | execAsync | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function execParams(string $query, array $params, array $types = null) {} | [Execute an SQL query](pq/Connection: Executing Queries) with properly escaped parameters substituted.
@param string $query The query to execute.
@param array $params The parameter list to substitute.
@param array $types Corresponding list of type OIDs for the parameters.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\RuntimeException
@throws \pq\Exception\DomainException
@return \pq\Result | execParams | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function execParamsAsync(string $query, array $params, array $types = null, callable $cb = null) {} | [Asynchronously](pq/Connection/: Asynchronous Usage) [execute an SQL query](pq/Connection: Executing Queries) with properly escaped parameters substituted.
> ***NOTE***:
If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row.
@param string $query The query to execute.
@param array $params The parameter list to substitute.
@param array $types Corresponding list of type OIDs for the parameters.
@param callable $cb as function(\pq\Result $res) : void
Result handler callback.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\RuntimeException
@throws \pq\Exception\BadMethodCallException | execParamsAsync | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function flush() {} | Flush pending writes on the connection.
Call after sending any command or data on a nonblocking connection.
If it returns FALSE, wait for the socket to become read or write-ready.
If it becomes write-ready, call pq\Connection::flush() again.
If it becomes read-ready, call pq\Connection::poll(), then call pq\Connection::flush() again.
Repeat until pq\Connection::flush() returns TRUE.
***NOTE:***
This method was added in v1.1.0, resp. v2.1.0.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\RuntimeException
@return bool whether everything has been flushed. | flush | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function getResult() {} | Fetch the result of an [asynchronous](pq/Connection/: Asynchronous Usage) query.
If the query hasn't finished yet, the call will block until the result is available.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@return \pq\Result|null NULL if there has not been a query
or \pq\Result when the query has finished | getResult | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function listen(string $channel, callable $listener) {} | Listen on $channel for notifications.
See pq\Connection::unlisten().
@param string $channel The channel to listen on.
@param callable $listener as function(string $channel, string $message, int $pid)
A callback automatically called whenever a notification on $channel arrives.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | listen | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function listenAsync(string $channel, callable $listener) {} | [Asynchronously](pq/Connection/: Asynchronous Usage) start listening on $channel for notifications.
See pq\Connection::listen().
@param string $channel The channel to listen on.
@param callable $listener as function(string $channel, string $message, int $pid)
A callback automatically called whenever a notification on $channel arrives.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | listenAsync | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function notify(string $channel, string $message) {} | Notify all listeners on $channel with $message.
@param string $channel The channel to notify.
@param string $message The message to send.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | notify | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function notifyAsync(string $channel, string $message) {} | [Asynchronously](pq/Connection/: Asynchronous Usage) start notifying all listeners on $channel with $message.
@param string $channel The channel to notify.
@param string $message The message to send.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | notifyAsync | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function off(string $event) {} | Stops listening for an event type.
@param string $event Any pq\Connection::EVENT_*.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@return bool success. | off | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function on(string $event, callable $callback) {} | Listen for an event.
@param string $event Any pq\Connection::EVENT_*.
@param callable $callback as function(pq\Connection $c[, pq\Result $r)
The callback to invoke on event.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@return int number of previously attached event listeners. | on | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function poll() {} | Poll an [asynchronously](pq/Connection/: Asynchronous Usage) operating connection.
See pq\Connection::resetAsync() for an usage example.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\RuntimeException
@throws \pq\Exception\BadMethodCallException
@return int pq\Connection::POLLING_* constant | poll | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function prepare(string $name, string $query, array $types = null) {} | Prepare a named statement for later execution with pq\Statement::execute().
@param string $name The identifying name of the prepared statement.
@param string $query The query to prepare.
@param array $types An array of type OIDs for the substitution parameters.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException
@return \pq\Statement a prepared statement instance. | prepare | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function prepareAsync(string $name, string $query, array $types = null) {} | [Asynchronously](pq/Connection/: Asynchronous Usage) prepare a named statement for later execution with pq\Statement::exec().
> ***NOTE***:
If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row.
@param string $name The identifying name of the prepared statement.
@param string $query The query to prepare.
@param array $types An array of type OIDs for the substitution parameters.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException
@return \pq\Statement a prepared statement instance. | prepareAsync | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function quote(string $payload) {} | Quote a string for safe use in a query.
The result is truncated at any zero byte and wrapped in single quotes.
***NOTE:***
Beware of matching character encodings.
@param string $payload The payload to quote for use in a query.
@throws \pq\Exception\BadMethodCallException
@return string|false string a single-quote wrapped string safe for literal use in a query.
or FALSE if quoting fails. | quote | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function quoteName(string $name) {} | Quote an identifier for safe usage as name.
***NOTE:***
Beware of case-sensitivity.
@param string $name The name to quote.
@throws \pq\Exception\BadMethodCallException
@return string|false string the quoted identifier.
or FALSE if quoting fails. | quoteName | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function resetAsync() {} | [Asynchronously](pq/Connection/: Asynchronous Usage) reset a possibly broken connection to a working state.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | resetAsync | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function startTransaction(int $isolation = \pq\Transaction::READ_COMMITTED, bool $readonly = false, bool $deferrable = false) {} | Begin a transaction.
@param int $isolation Any pq\Transaction isolation level constant
(defaults to pq\Connection::$defaultTransactionIsolation).
@param bool $readonly Whether the transaction executes only reads
(defaults to pq\Connection::$defaultTransactionReadonly).
@param bool $deferrable Whether the transaction is deferrable
(defaults to pq\Connection::$defaultTransactionDeferrable).
***NOTE:***
A transaction can only be deferrable if it also is readonly and serializable.
See the official [PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-set-transaction.html) for further information.
@return \pq\Transaction a begun transaction instance.
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException
@throws \pq\Exception\InvalidArgumentException | startTransaction | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function startTransactionAsync(int $isolation = \pq\Transaction::READ_COMMITTED, bool $readonly = false, bool $deferrable = false) {} | [Asynchronously](pq/Connection/: Asynchronous Usage) begin a transaction.
@param int $isolation Any pq\Transaction isolation level constant
(defaults to pq\Connection::$defaultTransactionIsolation).
@param bool $readonly Whether the transaction executes only reads
(defaults to pq\Connection::$defaultTransactionReadonly).
@param bool $deferrable Whether the transaction is deferrable
(defaults to pq\Connection::$defaultTransactionDeferrable).
***NOTE:***
A transaction can only be deferrable if it also is readonly and serializable.
See the official [PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-set-transaction.html) for further information.
@return \pq\Transaction an asynchronously begun transaction instance.
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException
@throws \pq\Exception\InvalidArgumentException | startTransactionAsync | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function trace($stream = null) {} | Trace protocol communication with the server.
***NOTE:***
Calling pq\Connection::trace() without argument or NULL stops tracing.
@param resource $stream The resource to which the protocol trace will be output.
(The stream must be castable to STDIO).
@throws \pq\Exception\BadMethodCallException
@return bool success. | trace | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function unescapeBytea(string $bytea) {} | Unescape bytea data retrieved from the server.
@param string $bytea Bytea data retrieved from the server.
@throws \pq\Exception\BadMethodCallException
@return string|false string unescaped binary data.
or FALSE if unescaping fails. | unescapeBytea | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function unlisten(string $channel) {} | Stop listening for notifications on channel $channel.
See pq\Connection::listen().
@param string $channel The name of a channel which is currently listened on.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | unlisten | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function unlistenAsync(string $channel) {} | [Asynchronously](pq/Connection/: Asynchronous Usage) stop listening for notifications on channel $channel.
See pq\Connection::unlisten() and pq\Connection::listenAsync().
@param string $channel The name of a channel which is currently listened on.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | unlistenAsync | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function unsetConverter(Converter $converter) {} | Stop applying a data type converter.
@param \pq\Converter $converter A converter previously set with pq\Connection::setConverter().
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException | unsetConverter | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function __construct(Connection $connection, string $name, int $flags, string $query, bool $async) {} | Declare a cursor.
See pq\Connection::declare().
@param \pq\Connection $connection The connection on which the cursor should be declared.
@param string $name The name of the cursor.
@param int $flags See pq\Cursor constants.
@param string $query The query for which the cursor should be opened.
@param bool $async Whether to declare the cursor [asynchronously](pq/Connection/: Asynchronous Usage).
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | __construct | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function closeAsync() {} | [Asynchronously](pq/Connection/: Asynchronous Usage) close an open cursor.
See pq\Cursor::close().
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | closeAsync | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function fetch(string $spec = "1") {} | Fetch rows from the cursor.
See pq\Cursor::move().
@param string $spec What to fetch.
### Fetch argument:
FETCH and MOVE usually accepts arguments like the following, where `count` is the number of rows:
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException
@return \pq\Result the fetched row(s). | fetch | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function fetchAsync(string $spec = "1", callable $callback = null) {} | [Asynchronously](pq/Connection/: Asynchronous Usage) fetch rows from the cursor.
See pq\Cursor::fetch().
@param string $spec What to fetch.
@param callable $callback as function(pq\Result $res)
A callback to execute when the result is ready.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | fetchAsync | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function move(string $spec = "1") {} | Move the cursor.
See pq\Cursor::fetch().
@param string $spec What to fetch.
### Fetch argument:
FETCH and MOVE usually accepts arguments like the following, where `count` is the number of rows:
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException
@return \pq\Result command status. | move | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function moveAsync(string $spec = "1", callable $callback = null) {} | [Asynchronously](pq/Connection/: Asynchronous Usage) move the cursor.
See pq\Cursor::move().
@param string $spec What to fetch.
@param callable $callback as function(pq\Result $res)
A callback to execute when the command completed.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | moveAsync | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function open() {} | Reopen a cursor.
This is a no-op on already open cursors.
***NOTE:***
Only cursors closed by pq\Cursor::close() will be reopened.
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | open | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
public function openAsync() {} | [Asynchronously](pq/Connection/: Asynchronous Usage) reopen a cursor.
See pq\Cursor::open().
@throws \pq\Exception\InvalidArgumentException
@throws \pq\Exception\BadMethodCallException
@throws \pq\Exception\RuntimeException | openAsync | php | JetBrains/phpstorm-stubs | pq/pq.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pq/pq.php | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.