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 __construct($cache, $search = null, $format = APC_ITER_ALL, $chunk_size = 100, $list = APC_LIST_ACTIVE) {} | Constructs an APCIterator iterator object
@link https://php.net/manual/en/apciterator.construct.php
@param string $cache The cache type, which will be 'user' or 'file'.
@param string|string[]|null $search A PCRE regular expression that matches against APC key names,
either as a string for a single regular expression, or as an array of regular expressions.
Or, optionally pass in NULL to skip the search.
@param int $format The desired format, as configured with one ore more of the APC_ITER_* constants.
@param int $chunk_size The chunk size. Must be a value greater than 0. The default value is 100.
@param int $list The type to list. Either pass in APC_LIST_ACTIVE or APC_LIST_INACTIVE. | __construct | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
public function getTotalHits() {} | Gets the total number of cache hits
@link https://php.net/manual/en/apciterator.gettotalhits.php
@return int|false The number of hits on success, or FALSE on failure. | getTotalHits | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apcu_sma_info($limited = false) {} | Retrieves APCu Shared Memory Allocation information
@link https://php.net/manual/en/function.apcu-sma-info.php
@param bool $limited When set to FALSE (default) apcu_sma_info() will
return a detailed information about each segment.
@return array|false Array of Shared Memory Allocation data; FALSE on failure. | apcu_sma_info | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apcu_store($key, $var, $ttl = 0) {} | Cache a variable in the data store
@link https://php.net/manual/en/function.apcu-store.php
@param string|string[] $key String: Store the variable using this name. Keys are cache-unique,
so storing a second value with the same key will overwrite the original value.
Array: Names in key, variables in value.
@param mixed $var [optional] The variable to store
@param int $ttl [optional] Time To Live; store var in the cache for ttl seconds. After the ttl has passed,
the stored variable will be expunged from the cache (on the next request). If no ttl is supplied
(or if the ttl is 0), the value will persist until it is removed from the cache manually,
or otherwise fails to exist in the cache (clear, restart, etc.).
@return bool|array Returns TRUE on success or FALSE on failure | array with error keys. | apcu_store | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apcu_fetch($key, &$success = null) {} | Fetch a stored variable from the cache
@link https://php.net/manual/en/function.apcu-fetch.php
@param string|string[] $key The key used to store the value (with apcu_store()).
If an array is passed then each element is fetched and returned.
@param bool|null &$success Set to TRUE in success and FALSE in failure.
@return mixed|false The stored variable or array of variables on success; FALSE on failure. | apcu_fetch | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apcu_delete($key) {} | Removes a stored variable from the cache
@link https://php.net/manual/en/function.apcu-delete.php
@param string|string[]|APCUIterator $key The key used to store the value (with apcu_store()).
@return bool|string[] Returns TRUE on success or FALSE on failure. For array of keys returns list of failed keys. | apcu_delete | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apcu_add($key, $var, $ttl = 0) {} | Caches a variable in the data store, only if it's not already stored
@link https://php.net/manual/en/function.apcu-add.php
@param string|array $key Store the variable using this name. Keys are cache-unique,
so attempting to use apcu_add() to store data with a key that already exists will not
overwrite the existing data, and will instead return FALSE. (This is the only difference
between apcu_add() and apcu_store().)
Array: Names in key, variables in value.
@param mixed $var The variable to store
@param int $ttl Time To Live; store var in the cache for ttl seconds. After the ttl has passed,
the stored variable will be expunged from the cache (on the next request). If no ttl is supplied
(or if the ttl is 0), the value will persist until it is removed from the cache manually,
or otherwise fails to exist in the cache (clear, restart, etc.).
@return bool|array Returns TRUE if something has effectively been added into the cache, FALSE otherwise.
Second syntax returns array with error keys. | apcu_add | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apcu_exists($keys) {} | Checks if APCu key exists
@link https://php.net/manual/en/function.apcu-exists.php
@param string|string[] $keys A string, or an array of strings, that contain keys.
@return bool|string[] Returns TRUE if the key exists, otherwise FALSE
Or if an array was passed to keys, then an array is returned that
contains all existing keys, or an empty array if none exist. | apcu_exists | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apcu_inc($key, $step = 1, &$success = null, $ttl = 0) {} | Increase a stored number
@link https://php.net/manual/en/function.apcu-inc.php
@param string $key The key of the value being increased.
@param int $step The step, or value to increase.
@param int $ttl Time To Live; store var in the cache for ttl seconds. After the ttl has passed,
the stored variable will be expunged from the cache (on the next request). If no ttl is supplied
(or if the ttl is 0), the value will persist until it is removed from the cache manually,
or otherwise fails to exist in the cache (clear, restart, etc.).
@param bool|null &$success Optionally pass the success or fail boolean value to this referenced variable.
@return int|false Returns the current value of key's value on success, or FALSE on failure. | apcu_inc | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apcu_dec($key, $step = 1, &$success = null, $ttl = 0) {} | Decrease a stored number
@link https://php.net/manual/en/function.apcu-dec.php
@param string $key The key of the value being decreased.
@param int $step The step, or value to decrease.
@param int $ttl Time To Live; store var in the cache for ttl seconds. After the ttl has passed,
the stored variable will be expunged from the cache (on the next request). If no ttl is supplied
(or if the ttl is 0), the value will persist until it is removed from the cache manually,
or otherwise fails to exist in the cache (clear, restart, etc.).
@param bool|null &$success Optionally pass the success or fail boolean value to this referenced variable.
@return int|false Returns the current value of key's value on success, or FALSE on failure. | apcu_dec | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apcu_cas($key, $old, $new) {} | Updates an old value with a new value
apcu_cas() updates an already existing integer value if the old parameter matches the currently stored value
with the value of the new parameter.
@link https://php.net/manual/en/function.apcu-cas.php
@param string $key The key of the value being updated.
@param int $old The old value (the value currently stored).
@param int $new The new value to update to.
@return bool Returns TRUE on success or FALSE on failure. | apcu_cas | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apcu_entry($key, callable $generator, $ttl = 0) {} | Atomically fetch or generate a cache entry
<p>Atomically attempts to find key in the cache, if it cannot be found generator is called,
passing key as the only argument. The return value of the call is then cached with the optionally
specified ttl, and returned.
</p>
<p>Note: When control enters <i>apcu_entry()</i> the lock for the cache is acquired exclusively, it is released when
control leaves apcu_entry(): In effect, this turns the body of generator into a critical section,
disallowing two processes from executing the same code paths concurrently.
In addition, it prohibits the concurrent execution of any other APCu functions,
since they will acquire the same lock.
</p>
@link https://php.net/manual/en/function.apcu-entry.php
@param string $key Identity of cache entry
@param callable $generator A callable that accepts key as the only argument and returns the value to cache.
<p>Warning
The only APCu function that can be called safely by generator is apcu_entry().</p>
@param int $ttl [optional] Time To Live; store var in the cache for ttl seconds.
After the ttl has passed, the stored variable will be expunged from the cache (on the next request).
If no ttl is supplied (or if the ttl is 0), the value will persist until it is removed from the cache manually,
or otherwise fails to exist in the cache (clear, restart, etc.).
@return mixed Returns the cached value
@since APCu 5.1.0 | apcu_entry | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apcu_cache_info($limited = false) {} | Retrieves cached information from APCu's data store
@link https://php.net/manual/en/function.apcu-cache-info.php
@param bool $limited If limited is TRUE, the return value will exclude the individual list of cache entries.
This is useful when trying to optimize calls for statistics gathering.
@return array|false Array of cached data (and meta-data) or FALSE on failure | apcu_cache_info | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apcu_enabled() {} | Whether APCu is usable in the current environment
@link https://www.php.net/manual/en/function.apcu-enabled.php
@return bool | apcu_enabled | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
public function __construct($search = null, $format = APC_ITER_ALL, $chunk_size = 100, $list = APC_LIST_ACTIVE) {} | Constructs an APCUIterator iterator object
@link https://php.net/manual/en/apcuiterator.construct.php
@param string|string[]|null $search A PCRE regular expression that matches against APCu key names,
either as a string for a single regular expression, or as an array of regular expressions.
Or, optionally pass in NULL to skip the search.
@param int $format The desired format, as configured with one ore more of the APC_ITER_* constants.
@param int $chunk_size The chunk size. Must be a value greater than 0. The default value is 100.
@param int $list The type to list. Either pass in APC_LIST_ACTIVE or APC_LIST_DELETED. | __construct | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function ereg($pattern, $string, ?array &$regs = null) {} | Regular expression match
@link https://php.net/manual/en/function.ereg.php
@param string $pattern <p>
Case sensitive regular expression.
</p>
@param string $string <p>
The input string.
</p>
@param null|array &$regs [optional] <p>
If matches are found for parenthesized substrings of
<i>pattern</i> and the function is called with the
third argument <i>regs</i>, the matches will be stored
in the elements of the array <i>regs</i>.
</p>
<p>
$regs[1] will contain the substring which starts at
the first left parenthesis; $regs[2] will contain
the substring starting at the second, and so on.
$regs[0] will contain a copy of the complete string
matched.
</p>
@return int the length of the matched string if a match for
<i>pattern</i> was found in <i>string</i>,
or <b>FALSE</b> if no matches were found or an error occurred.
</p>
<p>
If the optional parameter <i>regs</i> was not passed or
the length of the matched string is 0, this function returns 1.
@removed 7.0
@see preg_match() | ereg | php | JetBrains/phpstorm-stubs | regex/ereg.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/regex/ereg.php | Apache-2.0 |
function eregi($pattern, $string, array &$regs = null) {} | Case insensitive regular expression match
@link https://php.net/manual/en/function.eregi.php
@param string $pattern <p>
Case insensitive regular expression.
</p>
@param string $string <p>
The input string.
</p>
@param null|array &$regs [optional] <p>
If matches are found for parenthesized substrings of
<i>pattern</i> and the function is called with the
third argument <i>regs</i>, the matches will be stored
in the elements of the array <i>regs</i>.
</p>
<p>
$regs[1] will contain the substring which starts at the first left
parenthesis; $regs[2] will contain the substring starting at the
second, and so on. $regs[0] will contain a copy of the complete string
matched.
</p>
@return int the length of the matched string if a match for
<i>pattern</i> was found in <i>string</i>,
or <b>FALSE</b> if no matches were found or an error occurred.
</p>
<p>
If the optional parameter <i>regs</i> was not passed or
the length of the matched string is 0, this function returns 1.
@removed 7.0
@see preg_match() | eregi | php | JetBrains/phpstorm-stubs | regex/ereg.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/regex/ereg.php | Apache-2.0 |
function split($pattern, $string, $limit = -1) {} | Split string into array by regular expression
@link https://php.net/manual/en/function.split.php
@param string $pattern <p>
Case sensitive regular expression.
</p>
<p>
If you want to split on any of the characters which are considered
special by regular expressions, you'll need to escape them first. If
you think <b>split</b> (or any other regex function, for
that matter) is doing something weird, please read the file
regex.7, included in the
regex/ subdirectory of the PHP distribution. It's
in manpage format, so you'll want to do something along the lines of
man /usr/local/src/regex/regex.7 in order to read it.
</p>
@param string $string <p>
The input string.
</p>
@param int $limit [optional] <p>
If <i>limit</i> is set, the returned array will
contain a maximum of <i>limit</i> elements with the
last element containing the whole rest of
<i>string</i>.
</p>
@return array an array of strings, each of which is a substring of
<i>string</i> formed by splitting it on boundaries formed
by the case-sensitive regular expression <i>pattern</i>.
</p>
<p>
If there are n occurrences of
<i>pattern</i>, the returned array will contain
n+1 items. For example, if
there is no occurrence of <i>pattern</i>, an array with
only one element will be returned. Of course, this is also true if
<i>string</i> is empty. If an error occurs,
<b>split</b> returns <b>FALSE</b>.
@removed 7.0
@see preg_split() | split | php | JetBrains/phpstorm-stubs | regex/ereg.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/regex/ereg.php | Apache-2.0 |
function spliti($pattern, $string, $limit = -1) {} | Split string into array by regular expression case insensitive
@link https://php.net/manual/en/function.spliti.php
@param string $pattern <p>
Case insensitive regular expression.
</p>
<p>
If you want to split on any of the characters which are considered
special by regular expressions, you'll need to escape them first. If
you think <b>spliti</b> (or any other regex function, for
that matter) is doing something weird, please read the file
regex.7, included in the
regex/ subdirectory of the PHP distribution. It's
in manpage format, so you'll want to do something along the lines of
man /usr/local/src/regex/regex.7 in order to read it.
</p>
@param string $string <p>
The input string.
</p>
@param int $limit [optional] <p>
If <i>limit</i> is set, the returned array will
contain a maximum of <i>limit</i> elements with the
last element containing the whole rest of
<i>string</i>.
</p>
@return array an array of strings, each of which is a substring of
<i>string</i> formed by splitting it on boundaries formed
by the case insensitive regular expression <i>pattern</i>.
</p>
<p>
If there are n occurrences of
<i>pattern</i>, the returned array will contain
n+1 items. For example, if
there is no occurrence of <i>pattern</i>, an array with
only one element will be returned. Of course, this is also true if
<i>string</i> is empty. If an error occurs,
<b>spliti</b> returns <b>FALSE</b>.
@removed 7.0
@see preg_split() | spliti | php | JetBrains/phpstorm-stubs | regex/ereg.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/regex/ereg.php | Apache-2.0 |
function sql_regcase($string) {} | Make regular expression for case insensitive match
@link https://php.net/manual/en/function.sql-regcase.php
@param string $string <p>
The input string.
</p>
@return string a valid regular expression which will match
<i>string</i>, ignoring case. This expression is
<i>string</i> with each alphabetic character converted to
a bracket expression; this bracket expression contains that character's
uppercase and lowercase form. Other characters remain unchanged.
@removed 7.0 | sql_regcase | php | JetBrains/phpstorm-stubs | regex/ereg.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/regex/ereg.php | Apache-2.0 |
public function __construct($name) {} | Constructs a new SyncMutex object
Constructs a named or unnamed countable mutex.
@param string $name [optional] The name of the mutex if this is a named mutex object. If the name already exists, it must be able to be opened by the current user that the process is running as or an exception will be thrown with a meaningless error message.
@throws Exception if the mutex cannot be created or opened
@link https://php.net/manual/en/syncmutex.construct.php | __construct | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
public function lock($wait = -1) {} | Waits for an exclusive lock
Obtains an exclusive lock on a SyncMutex object. If the lock is already acquired, then this increments an internal counter.
@param int $wait [optional] The number of milliseconds to wait for the exclusive lock. A value of -1 is infinite.
@return bool TRUE if the lock was obtained, FALSE otherwise.
@see SyncMutex::unlock()
@link https://php.net/manual/en/syncmutex.lock.php | lock | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
public function unlock($all = false) {} | Unlocks the mutex
Decreases the internal counter of a SyncMutex object. When the internal counter reaches zero, the actual lock on the object is released.
@param bool $all [optional] Specifies whether or not to set the internal counter to zero and therefore release the lock.
@return bool TRUE if the unlock operation was successful, FALSE otherwise.
@see SyncMutex::lock()
@link https://php.net/manual/en/syncmutex.unlock.php | unlock | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
public function __construct($name, $initialval = 1, $autounlock = true) {} | Constructs a new SyncSemaphore object
Constructs a named or unnamed semaphore.
@param string $name [optional] The name of the semaphore if this is a named semaphore object. Note: If the name already exists, it must be able to be opened by the current user that the process is running as or an exception will be thrown with a meaningless error message.
@param int $initialval [optional] The initial value of the semaphore. This is the number of locks that may be obtained.
@param bool $autounlock [optional] Specifies whether or not to automatically unlock the semaphore at the conclusion of the PHP script. Warning: If an object is: A named semaphore with an autounlock of FALSE, the object is locked, and the PHP script concludes before the object is unlocked, then the underlying semaphore will end up in an inconsistent state.
@throws Exception if the semaphore cannot be created or opened
@link https://php.net/manual/en/syncsemaphore.construct.php | __construct | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
public function unlock(&$prevcount = 0) {} | Increases the count of the semaphore
Increases the count of a SyncSemaphore object.
@param int &$prevcount Returns the previous count of the semaphore.
@return bool TRUE if the unlock operation was successful, FALSE otherwise.
@see SyncSemaphore::lock()
@link https://php.net/manual/en/syncsemaphore.unlock.php | unlock | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
public function fire() {} | Fires/sets the event
Fires/sets a SyncEvent object. Lets multiple threads through that are waiting if the event object was created with a manual value of TRUE.
@return bool TRUE if the event was fired, FALSE otherwise.
@see SyncEvent::wait()
@link https://php.net/manual/en/syncevent.fire.php | fire | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
public function wait($wait = -1) {} | Waits for the event to be fired/set
Waits for the SyncEvent object to be fired.
@param int $wait The number of milliseconds to wait for the event to be fired. A value of -1 is infinite.
@return bool TRUE if the event was fired, FALSE otherwise.
@see SyncEvent::fire()
@link https://php.net/manual/en/syncevent.wait.php | wait | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
public function __construct($name, $autounlock = true) {} | Constructs a new SyncReaderWriter object
Constructs a named or unnamed reader-writer object.
@param string $name [optional] The name of the reader-writer if this is a named reader-writer object. Note: If the name already exists, it must be able to be opened by the current user that the process is running as or an exception will be thrown with a meaningless error message.
@param bool $autounlock [optional] Specifies whether or not to automatically unlock the reader-writer at the conclusion of the PHP script. Warning: If an object is: A named reader-writer with an autounlock of FALSE, the object is locked for either reading or writing, and the PHP script concludes before the object is unlocked, then the underlying objects will end up in an inconsistent state.
@throws Exception if the reader-writer cannot be created or opened.
@link https://php.net/manual/en/syncreaderwriter.construct.php | __construct | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
public function readlock($wait = -1) {} | Waits for a read lock
Obtains a read lock on a SyncReaderWriter object.
@param int $wait [optional] The number of milliseconds to wait for a lock. A value of -1 is infinite.
@return bool TRUE if the lock was obtained, FALSE otherwise.
@see SyncReaderWriter::readunlock()
@link https://php.net/manual/en/syncreaderwriter.readlock.php | readlock | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
public function readunlock() {} | Releases a read lock
Releases a read lock on a SyncReaderWriter object.
@return bool TRUE if the unlock operation was successful, FALSE otherwise.
@see SyncReaderWriter::readlock()
@link https://php.net/manual/en/syncreaderwriter.readunlock.php | readunlock | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
public function writelock($wait = -1) {} | Waits for an exclusive write lock
Obtains an exclusive write lock on a SyncReaderWriter object.
@param int $wait [optional] The number of milliseconds to wait for a lock. A value of -1 is infinite.
@return bool TRUE if the lock was obtained, FALSE otherwise.
@see SyncReaderWriter::writeunlock()
@link https://php.net/manual/en/syncreaderwriter.writelock.php | writelock | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
public function writeunlock() {} | Releases a write lock
Releases a write lock on a SyncReaderWriter object.
@return bool TRUE if the unlock operation was successful, FALSE otherwise.
@see SyncReaderWriter::writelock()
@link https://php.net/manual/en/syncreaderwriter.writeunlock.php | writeunlock | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
public function __construct($name, $size) {} | Constructs a new SyncSharedMemory object
Constructs a named shared memory object.
@param string $name The name of the shared memory object. Note: If the name already exists, it must be able to be opened by the current user that the process is running as or an exception will be thrown with a meaningless error message.
@param int $size The size, in bytes, of shared memory to reserve. Note: The amount of memory cannot be resized later. Request sufficient storage up front.
@throws Exception if the shared memory object cannot be created or opened.
@link https://php.net/manual/en/syncsharedmemory.construct.php | __construct | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
public function read($start = 0, $length) {} | Copy data from named shared memory
Copies data from named shared memory.
@param int $start [optional] The start/offset, in bytes, to begin reading. Note: If the value is negative, the starting position will begin at the specified number of bytes from the end of the shared memory segment.
@param int $length [optional] The number of bytes to read. Note: If unspecified, reading will stop at the end of the shared memory segment. If the value is negative, reading will stop the specified number of bytes from the end of the shared memory segment.
@return string containing the data read from shared memory.
@see SyncSharedMemory::write()
@link https://php.net/manual/en/syncsharedmemory.read.php | read | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
public function size() {} | Returns the size of the named shared memory
Retrieves the shared memory size of a SyncSharedMemory object.
@return int containing the size of the shared memory. This will be the same size that was passed to the constructor.
@link https://php.net/manual/en/syncsharedmemory.size.php | size | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
public function write($string, $start = 0) {} | Copy data to named shared memory
Copies data to named shared memory.
@param string $string The data to write to shared memoy. Note: If the size of the data exceeds the size of the shared memory, the number of bytes written returned will be less than the length of the input.
@param int $start The start/offset, in bytes, to begin writing. Note: If the value is negative, the starting position will begin at the specified number of bytes from the end of the shared memory segment.
@return int containing the number of bytes written to shared memory.
@link https://php.net/manual/en/syncsharedmemory.write.php | write | php | JetBrains/phpstorm-stubs | sync/sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/sync/sync.php | Apache-2.0 |
function pg_connect(
string $connection_string,
int $flags = 0,
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] string $host = '',
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] string $port = '',
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] string $options = '',
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] string $tty = '',
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] string $dbname = '',
) {} | Open a PostgreSQL connection
@link https://php.net/manual/en/function.pg-connect.php
@param string $connection_string <p>
The <i>connection_string</i> 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 keyword = value. Spaces around
the equal sign are optional. To write an empty value or a value
containing spaces, surround it with single quotes, e.g., keyword =
'a value'. Single quotes and backslashes within the value must be
escaped with a backslash, i.e., \' and \\.
</p>
<p>
The currently recognized parameter keywords are:
<i>host</i>, <i>hostaddr</i>, <i>port</i>,
<i>dbname</i> (defaults to value of <i>user</i>),
<i>user</i>,
<i>password</i>, <i>connect_timeout</i>,
<i>options</i>, <i>tty</i> (ignored), <i>sslmode</i>,
<i>requiressl</i> (deprecated in favor of <i>sslmode</i>), and
<i>service</i>. Which of these arguments exist depends
on your PostgreSQL version.
</p>
<p>
The <i>options</i> parameter can be used to set command line parameters
to be invoked by the server.
</p>
@param int $flags <p>
If <b>PGSQL_CONNECT_FORCE_NEW</b> is passed, then a new connection
is created, even if the <i>connection_string</i> is identical to
an existing connection.
</p>
@return resource|false PostgreSQL connection resource on success, <b>FALSE</b> on failure. | pg_connect | php | JetBrains/phpstorm-stubs | pgsql/pgsql.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pgsql/pgsql.php | Apache-2.0 |
function pg_pconnect(
string $connection_string,
#[PhpStormStubsElementAvailable(from: '8.0')] int $flags = 0,
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] string $host = '',
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] string $port = '',
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] string $options = '',
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] string $tty = '',
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] string $dbname = '',
) {} | Open a persistent PostgreSQL connection
@link https://php.net/manual/en/function.pg-pconnect.php
@param string $connection_string <p>
The <i>connection_string</i> 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 keyword = value. Spaces around
the equal sign are optional. To write an empty value or a value
containing spaces, surround it with single quotes, e.g., keyword =
'a value'. Single quotes and backslashes within the value must be
escaped with a backslash, i.e., \' and \\.
</p>
<p>
The currently recognized parameter keywords are:
<i>host</i>, <i>hostaddr</i>, <i>port</i>,
<i>dbname</i>, <i>user</i>,
<i>password</i>, <i>connect_timeout</i>,
<i>options</i>, <i>tty</i> (ignored), <i>sslmode</i>,
<i>requiressl</i> (deprecated in favor of <i>sslmode</i>), and
<i>service</i>. Which of these arguments exist depends
on your PostgreSQL version.
</p>
@param int $flags <p>
If <b>PGSQL_CONNECT_FORCE_NEW</b> is passed, then a new connection
is created, even if the <i>connection_string</i> is identical to
an existing connection.
</p>
@return resource|false PostgreSQL connection resource on success, <b>FALSE</b> on failure. | pg_pconnect | php | JetBrains/phpstorm-stubs | pgsql/pgsql.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pgsql/pgsql.php | Apache-2.0 |
function pg_connection_status(#[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection'], default: 'resource')] $connection): int {}
/**
* Get connection is busy or not
* @link https://php.net/manual/en/function.pg-connection-busy.php
* @param resource $connection <p>
* PostgreSQL database connection resource.
* </p>
* @return bool <b>TRUE</b> if the connection is busy, <b>FALSE</b> otherwise.
*/
function pg_connection_busy(#[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection'], default: 'resource')] $connection): bool {}
/**
* Reset connection (reconnect)
* @link https://php.net/manual/en/function.pg-connection-reset.php
* @param resource $connection <p>
* PostgreSQL database connection resource.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
function pg_connection_reset(#[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection'], default: 'resource')] $connection): bool {}
/**
* Get a read only handle to the socket underlying a PostgreSQL connection
* @link https://php.net/manual/en/function.pg-socket.php
* @param resource $connection <p>
* PostgreSQL database connection resource.
* </p>
* @return resource|false A socket resource on success or <b>FALSE</b> on failure.
* @since 5.6
*/
function pg_socket(#[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection'], default: 'resource')] $connection) {}
/**
* Returns the host name associated with the connection
* @link https://php.net/manual/en/function.pg-host.php
* @param resource $connection [optional] <p>
* PostgreSQL database connection resource. When
* <i>connection</i> is not present, the default connection
* is used. The default connection is the last connection made by
* <b>pg_connect</b> or <b>pg_pconnect</b>.
* </p>
* @return string|false A string containing the name of the host the
* <i>connection</i> is to, or <b>FALSE</b> on error.
*/
function pg_host(#[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection|null'], default: 'resource')] $connection = null): string {}
/**
* Get the database name
* @link https://php.net/manual/en/function.pg-dbname.php
* @param resource $connection [optional] <p>
* PostgreSQL database connection resource. When
* <i>connection</i> is not present, the default connection
* is used. The default connection is the last connection made by
* <b>pg_connect</b> or <b>pg_pconnect</b>.
* </p>
* @return string|false A string containing the name of the database the
* <i>connection</i> is to, or <b>FALSE</b> on error.
*/
function pg_dbname(#[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection|null'], default: 'resource')] $connection = null): string {}
/**
* Return the port number associated with the connection
* @link https://php.net/manual/en/function.pg-port.php
* @param resource $connection [optional] <p>
* PostgreSQL database connection resource. When
* <i>connection</i> is not present, the default connection
* is used. The default connection is the last connection made by
* <b>pg_connect</b> or <b>pg_pconnect</b>.
* </p>
* @return string A string containing the port number of the database server the connection is to, or empty string on error.
*/
function pg_port(#[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection|null'], default: 'resource')] $connection = null): string {}
/**
* Return the TTY name associated with the connection
* @link https://php.net/manual/en/function.pg-tty.php
* @param resource $connection [optional] <p>
* PostgreSQL database connection resource. When
* <i>connection</i> is not present, the default connection
* is used. The default connection is the last connection made by
* <b>pg_connect</b> or <b>pg_pconnect</b>.
* </p>
* @return string A string containing the debug TTY of
* the <i>connection</i>, or <b>FALSE</b> on error.
*/
function pg_tty(#[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection|null'], default: 'resource')] $connection = null): string {}
/**
* Get the options associated with the connection
* @link https://php.net/manual/en/function.pg-options.php
* @param resource $connection [optional] <p>
* PostgreSQL database connection resource. When
* <i>connection</i> is not present, the default connection
* is used. The default connection is the last connection made by
* <b>pg_connect</b> or <b>pg_pconnect</b>.
* </p>
* @return string A string containing the <i>connection</i>
* options, or <b>FALSE</b> on error.
*/
function pg_options(#[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection|null'], default: 'resource')] $connection = null): string {}
/**
* Returns an array with client, protocol and server version (when available)
* @link https://php.net/manual/en/function.pg-version.php
* @param resource $connection [optional] <p>
* PostgreSQL database connection resource. When
* <i>connection</i> is not present, the default connection
* is used. The default connection is the last connection made by
* <b>pg_connect</b> or <b>pg_pconnect</b>.
* </p>
* @return array an array with client, protocol
* and server keys and values (if available). Returns
* <b>FALSE</b> on error or invalid connection.
*/
#[ArrayShape(["client" => "string", "protocol" => "int", "server" => "string"])]
function pg_version(#[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection|null'], default: 'resource')] $connection = null): array {}
/**
* Ping database connection
* @link https://php.net/manual/en/function.pg-ping.php
* @param resource $connection [optional] <p>
* PostgreSQL database connection resource. When
* <i>connection</i> is not present, the default connection
* is used. The default connection is the last connection made by
* <b>pg_connect</b> or <b>pg_pconnect</b>.
* </p>
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
function pg_ping(#[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection|null'], default: 'resource')] $connection = null): bool {}
/**
* Looks up a current parameter setting of the server.
* @link https://php.net/manual/en/function.pg-parameter-status.php
* @param resource $connection <p>
* PostgreSQL database connection resource. When
* <i>connection</i> is not present, the default connection
* is used. The default connection is the last connection made by
* <b>pg_connect</b> or <b>pg_pconnect</b>.
* </p>
* @param string $name [optional] <p>
* Possible <i>param_name</i> values include server_version,
* server_encoding, client_encoding,
* is_superuser, session_authorization,
* DateStyle, TimeZone, and
* integer_datetimes.
* </p>
* @return string|false A string containing the value of the parameter, <b>FALSE</b> on failure or invalid
* <i>param_name</i>.
*/
function pg_parameter_status(#[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection'], default: 'resource')] $connection, string $name): string|false {}
/**
* Returns the current in-transaction status of the server.
* @link https://php.net/manual/en/function.pg-transaction-status.php
* @param resource $connection <p>
* PostgreSQL database connection resource.
* </p>
* @return int The status can be <b>PGSQL_TRANSACTION_IDLE</b> (currently idle),
* <b>PGSQL_TRANSACTION_ACTIVE</b> (a command is in progress),
* <b>PGSQL_TRANSACTION_INTRANS</b> (idle, in a valid transaction block),
* or <b>PGSQL_TRANSACTION_INERROR</b> (idle, in a failed transaction block).
* <b>PGSQL_TRANSACTION_UNKNOWN</b> is reported if the connection is bad.
* <b>PGSQL_TRANSACTION_ACTIVE</b> is reported only when a query
* has been sent to the server and not yet completed.
*/
function pg_transaction_status(#[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection'], default: 'resource')] $connection): int {}
/**
* Execute a query
* @link https://php.net/manual/en/function.pg-query.php
* @param resource $connection <p>
* PostgreSQL database connection resource. When
* <i>connection</i> is not present, the default connection
* is used. The default connection is the last connection made by
* <b>pg_connect</b> or <b>pg_pconnect</b>.
* </p>
* @param string $query [optional] <p>
* 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.
* </p>
* <p>
* String interpolation of user-supplied data is extremely dangerous and is
* likely to lead to SQL
* injection vulnerabilities. In most cases
* <b>pg_query_params</b> should be preferred, passing
* user-supplied values as parameters rather than substituting them into
* the query string.
* </p>
* <p>
* Any user-supplied data substituted directly into a query string should
* be properly escaped.
* </p>
* @return resource|false A query result resource on success or <b>FALSE</b> on failure.
*/
#[LanguageLevelTypeAware(['8.1' => 'PgSql\Result|false'], default: 'resource|false')]
function pg_query(
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] $connection = null,
#[PhpStormStubsElementAvailable(from: '8.0')] #[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection'], default: 'resource')] $connection,
string $query
) {} | Get connection status
@link https://php.net/manual/en/function.pg-connection-status.php
@param resource $connection <p>
PostgreSQL database connection resource.
</p>
@return int <b>PGSQL_CONNECTION_OK</b> or
<b>PGSQL_CONNECTION_BAD</b>. | pg_connection_status | php | JetBrains/phpstorm-stubs | pgsql/pgsql.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pgsql/pgsql.php | Apache-2.0 |
function pg_query_params(
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] $connection = null,
#[PhpStormStubsElementAvailable(from: '8.0')] #[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection'], default: 'resource')] $connection,
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] $query = '',
#[PhpStormStubsElementAvailable(from: '8.0')] $query,
array $params
) {} | Submits a command to the server and waits for the result, with the ability to pass parameters separately from the SQL command text.
@link https://php.net/manual/en/function.pg-query-params.php
@param resource $connection <p>
PostgreSQL database connection resource. When
<i>connection</i> is not present, the default connection
is used. The default connection is the last connection made by
<b>pg_connect</b> or <b>pg_pconnect</b>.
</p>
@param string $query <p>
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.
</p>
<p>
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.
</p>
@param array $params [optional] <p>
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.
</p>
<p>
Values intended for bytea fields are not supported as
parameters. Use <b>pg_escape_bytea</b> instead, or use the
large object functions.
</p>
@return resource|false A query result resource on success or <b>FALSE</b> on failure. | pg_query_params | php | JetBrains/phpstorm-stubs | pgsql/pgsql.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pgsql/pgsql.php | Apache-2.0 |
function pg_prepare(
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] $connection = null,
#[PhpStormStubsElementAvailable(from: '8.0')] #[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection'], default: 'resource')] $connection,
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] string $statement_name = '',
#[PhpStormStubsElementAvailable(from: '8.0')] string $statement_name,
string $query
) {} | Submits a request to create a prepared statement with the
given parameters, and waits for completion.
@link https://php.net/manual/en/function.pg-prepare.php
@param resource $connection <p>
PostgreSQL database connection resource. When
<i>connection</i> is not present, the default connection
is used. The default connection is the last connection made by
<b>pg_connect</b> or <b>pg_pconnect</b>.
</p>
@param string $statement_name <p>
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.
</p>
@param string $query [optional] <p>
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.
</p>
@return resource|false A query result resource on success or <b>FALSE</b> on failure. | pg_prepare | php | JetBrains/phpstorm-stubs | pgsql/pgsql.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pgsql/pgsql.php | Apache-2.0 |
function pg_execute(
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] $connection = null,
#[PhpStormStubsElementAvailable(from: '8.0')] #[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection'], default: 'resource')] $connection,
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] string $statement_name = '',
#[PhpStormStubsElementAvailable(from: '8.0')] $statement_name,
array $params
) {} | Sends a request to execute a prepared statement with given parameters, and waits for the result.
@link https://php.net/manual/en/function.pg-execute.php
@param resource $connection <p>
PostgreSQL database connection resource. When
<i>connection</i> is not present, the default connection
is used. The default connection is the last connection made by
<b>pg_connect</b> or <b>pg_pconnect</b>.
</p>
@param string $statement_name <p>
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 <b>pg_prepare</b>,
<b>pg_send_prepare</b> or a PREPARE SQL
command.
</p>
@param array $params [optional] <p>
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.
</p>
<p>
Elements are converted to strings by calling this function.
</p>
@return resource|false A query result resource on success or <b>FALSE</b> on failure. | pg_execute | php | JetBrains/phpstorm-stubs | pgsql/pgsql.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pgsql/pgsql.php | Apache-2.0 |
function pg_lo_open(
#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] $connection = null,
#[PhpStormStubsElementAvailable(from: '8.0')] #[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection'], default: 'resource')] $connection,
$oid,
string $mode
) {} | Open a large object
@link https://php.net/manual/en/function.pg-lo-open.php
@param resource $connection <p>
PostgreSQL database connection resource. When
<i>connection</i> is not present, the default connection
is used. The default connection is the last connection made by
<b>pg_connect</b> or <b>pg_pconnect</b>.
</p>
@param int $oid [optional] <p>
The OID of the large object in the database.
</p>
@param string $mode [optional] <p>
Can be either "r" for read-only, "w" for write only or "rw" for read and
write.
</p>
@return resource|false A large object resource or <b>FALSE</b> on error. | pg_lo_open | php | JetBrains/phpstorm-stubs | pgsql/pgsql.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pgsql/pgsql.php | Apache-2.0 |
function pg_insert(
#[LanguageLevelTypeAware(['8.1' => 'PgSql\Connection'], default: 'resource')] $connection,
string $table_name,
array $values,
int $flags = PGSQL_DML_EXEC
) {} | Insert array into table
@link https://php.net/manual/en/function.pg-insert.php
@param resource $connection <p>
PostgreSQL database connection resource.
</p>
@param string $table_name <p>
Name of the table into which to insert rows. The table <i>table_name</i> must at least
have as many columns as <i>assoc_array</i> has elements.
</p>
@param array $values <p>
An array whose keys are field names in the table <i>table_name</i>,
and whose values are the values of those fields that are to be inserted.
</p>
@param int $flags [optional] <p>
Any number of <b>PGSQL_CONV_OPTS</b>,
<b>PGSQL_DML_NO_CONV</b>,
<b>PGSQL_DML_EXEC</b>,
<b>PGSQL_DML_ASYNC</b> or
<b>PGSQL_DML_STRING</b> combined. If <b>PGSQL_DML_STRING</b> is part of the
<i>options</i> then query string is returned.
</p>
@return mixed <b>TRUE</b> on success or <b>FALSE</b> on failure. Returns string if <b>PGSQL_DML_STRING</b> is passed
via <i>options</i>. | pg_insert | php | JetBrains/phpstorm-stubs | pgsql/pgsql.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/pgsql/pgsql.php | Apache-2.0 |
public function getContentEncoding() {} | Get the content encoding of the message.
@return string|null The content encoding of the message. | getContentEncoding | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getHeaders() {} | Get the headers of the message.
@return array An array of key value pairs associated with the message. | getHeaders | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getDeliveryMode() {} | Get the delivery mode of the message.
@return int The delivery mode of the message. | getDeliveryMode | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getPriority() {} | Get the priority of the message.
@return int The message priority. | getPriority | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getCorrelationId() {} | Get the message correlation id.
@return string|null The correlation id of the message. | getCorrelationId | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getReplyTo() {} | Get the reply-to address of the message.
@return string|null The contents of the reply to field. | getReplyTo | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getExpiration() {} | Get the expiration of the message.
@return string|null The message expiration. | getExpiration | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getMessageId() {} | Get the message id of the message.
@return string|null The message id | getMessageId | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getTimestamp() {} | Get the timestamp of the message.
@return int|null The message timestamp. | getTimestamp | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getAppId() {} | Get the application id of the message.
@return string|null The application id of the message. | getAppId | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getClusterId() {} | Get the cluster id of the message.
@return string|null The cluster id of the message. | getClusterId | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function commitTransaction() {} | Commit a pending transaction.
@throws AMQPChannelException If no transaction was started prior to
calling this method.
@throws AMQPConnectionException If the connection to the broker was lost.
@return void | commitTransaction | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function __construct(AMQPConnection $amqp_connection) {} | Create an instance of an AMQPChannel object.
@param AMQPConnection $amqp_connection An instance of AMQPConnection
with an active connection 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 qos($size, $count, $global = false) {} | Set the Quality Of Service settings for the given channel.
Specify the amount of data to prefetch in terms of window size (octets)
or number of messages from a queue during a AMQPQueue::consume() or
AMQPQueue::get() method call. The client will prefetch data up to size
octets or count messages from the server, whichever limit is hit first.
Setting either value to 0 will instruct the client to ignore that
particular setting. A call to AMQPChannel::qos() will overwrite any
values set by calling AMQPChannel::setPrefetchSize() and
AMQPChannel::setPrefetchCount(). If the call to either
AMQPQueue::consume() or AMQPQueue::get() is done with the AMQP_AUTOACK
flag set, the client will not do any prefetching of data, regardless of
the QOS settings.
@param int $size The window size, in octets, to prefetch.
@param int $count The number of messages to prefetch.
@param bool $global TRUE for global, FALSE for consumer. FALSE by default.
@throws AMQPConnectionException If the connection to the broker was lost.
@return void | qos | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function rollbackTransaction() {} | Rollback a transaction.
Rollback an existing transaction. AMQPChannel::startTransaction() must
be called prior to this.
@throws AMQPChannelException If no transaction was started prior to
calling this method.
@throws AMQPConnectionException If the connection to the broker was lost.
@return void | rollbackTransaction | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setPrefetchCount($count) {} | Set the number of messages to prefetch from the broker for each consumer.
Set the number of messages to prefetch from the broker during a call to
AMQPQueue::consume() or AMQPQueue::get().
@param int $count The number of messages to prefetch.
@throws AMQPConnectionException If the connection to the broker was lost.
@return void | setPrefetchCount | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getPrefetchCount() {} | Get the number of messages to prefetch from the broker for each consumer.
@return int | getPrefetchCount | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setPrefetchSize($size) {} | Set the window size to prefetch from the broker for each consumer.
Set the prefetch window size, in octets, during a call to
AMQPQueue::consume() or AMQPQueue::get(). Any call to this method will
automatically set the prefetch message count to 0, meaning that the
prefetch message count setting will be ignored. If the call to either
AMQPQueue::consume() or AMQPQueue::get() is done with the AMQP_AUTOACK
flag set, this setting will be ignored.
@param int $size The window size, in octets, to prefetch.
@throws AMQPConnectionException If the connection to the broker was lost.
@return void | setPrefetchSize | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getPrefetchSize() {} | Get the window size to prefetch from the broker for each consumer.
@return int | getPrefetchSize | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setGlobalPrefetchCount($count) {} | Set the number of messages to prefetch from the broker across all consumers.
Set the number of messages to prefetch from the broker during a call to
AMQPQueue::consume() or AMQPQueue::get().
@param int $count The number of messages to prefetch.
@throws AMQPConnectionException If the connection to the broker was lost.
@return void | setGlobalPrefetchCount | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getGlobalPrefetchCount() {} | Get the number of messages to prefetch from the broker across all consumers.
@return int | getGlobalPrefetchCount | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setGlobalPrefetchSize($size) {} | Set the window size to prefetch from the broker for all consumers.
Set the prefetch window size, in octets, during a call to
AMQPQueue::consume() or AMQPQueue::get(). Any call to this method will
automatically set the prefetch message count to 0, meaning that the
prefetch message count setting will be ignored. If the call to either
AMQPQueue::consume() or AMQPQueue::get() is done with the AMQP_AUTOACK
flag set, this setting will be ignored.
@param int $size The window size, in octets, to prefetch.
@throws AMQPConnectionException If the connection to the broker was lost.
@return void | setGlobalPrefetchSize | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getGlobalPrefetchSize() {} | Get the window size to prefetch from the broker for all consumers.
@return int | getGlobalPrefetchSize | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function startTransaction() {} | Start a transaction.
This method must be called on the given channel prior to calling
AMQPChannel::commitTransaction() or AMQPChannel::rollbackTransaction().
@throws AMQPConnectionException If the connection to the broker was lost.
@return void | startTransaction | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getConnection() {} | Get the AMQPConnection object in use
@return AMQPConnection | getConnection | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function basicRecover($requeue = true) {} | Redeliver unacknowledged messages.
@param bool $requeue
@return void | basicRecover | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function confirmSelect() {} | Set the channel to use publisher acknowledgements. This can only used on a non-transactional channel.
@return void | confirmSelect | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function waitForConfirm($timeout = 0.0) {} | Wait until all messages published since the last call have been either ack'd or nack'd by the broker.
Note, this method also catch all basic.return message from server.
@param float $timeout Timeout in seconds. May be fractional.
@throws AMQPQueueException If timeout occurs.
@return void | waitForConfirm | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function waitForBasicReturn($timeout = 0.0) {} | Start wait loop for basic.return AMQP server methods
@param float $timeout Timeout in seconds. May be fractional.
@throws AMQPQueueException If timeout occurs.
@return void | waitForBasicReturn | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getConsumers() {} | Return array of current consumers where key is consumer and value is AMQPQueue consumer is running on
@return AMQPQueue[] | getConsumers | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function __construct(array $credentials = []) {} | Create an instance of AMQPConnection.
Creates an AMQPConnection instance representing a connection to an AMQP
broker. A connection will not be established until
AMQPConnection::connect() is called.
$credentials = array(
'host' => amqp.host The host to connect too. Note: Max 1024 characters.
'port' => amqp.port Port on the host.
'vhost' => amqp.vhost The virtual host on the host. Note: Max 128 characters.
'login' => amqp.login The login name to use. Note: Max 128 characters.
'password' => amqp.password Password. Note: Max 128 characters.
'read_timeout' => Timeout in for income activity. Note: 0 or greater seconds. May be fractional.
'write_timeout' => Timeout in for outcome activity. Note: 0 or greater seconds. May be fractional.
'connect_timeout' => Connection timeout. Note: 0 or greater seconds. May be fractional.
'rpc_timeout' => RPC timeout. Note: 0 or greater seconds. May be fractional.
Connection tuning options (see http://www.rabbitmq.com/amqp-0-9-1-reference.html#connection.tune for details):
'channel_max' => Specifies highest channel number that the server permits. 0 means standard extension limit
(see PHP_AMQP_MAX_CHANNELS constant)
'frame_max' => The largest frame size that the server proposes for the connection, including frame header
and end-byte. 0 means standard extension limit (depends on librabbimq default frame size limit)
'heartbeat' => The delay, in seconds, of the connection heartbeat that the server wants.
0 means the server does not want a heartbeat. Note, librabbitmq has limited heartbeat support,
which means heartbeats checked only during blocking calls.
TLS support (see https://www.rabbitmq.com/ssl.html for details):
'cacert' => Path to the CA cert file in PEM format..
'cert' => Path to the client certificate in PEM foramt.
'key' => Path to the client key in PEM format.
'verify' => Enable or disable peer verification. If peer verification is enabled then the common name in the
server certificate must match the server name. Peer verification is enabled by default.
'connection_name' => A user determined name for the connection
)
@param array $credentials Optional array of credential information for
connecting to the AMQP broker. | __construct | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function isConnected() {} | Check whether the connection to the AMQP broker is still valid.
Cannot reliably detect dropped connections or unusual socket errors, as it does not actively
engage the socket.
@return bool TRUE if connected, FALSE otherwise. | isConnected | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function isPersistent() {} | Whether connection persistent.
When no connection is established, it will always return FALSE. The same disclaimer as for
{@see AMQPConnection::isConnected()} applies.
@return bool TRUE if persistently connected, FALSE otherwise. | isPersistent | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function connect() {} | Establish a transient connection with the AMQP broker.
This method will initiate a connection with the AMQP broker.
@throws AMQPConnectionException
@return void | connect | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function disconnect() {} | Closes the transient connection with the AMQP broker.
This method will close an open connection with the AMQP broker.
@throws AMQPConnectionException When attempting to disconnect a persistent connection
@return void | disconnect | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function reconnect() {} | Close any open transient connections and initiate a new one with the AMQP broker.
@return void | reconnect | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function pconnect() {} | Establish a persistent connection with the AMQP broker.
This method will initiate a connection with the AMQP broker
or reuse an existing one if present.
@throws AMQPConnectionException
@return void | pconnect | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function pdisconnect() {} | Closes a persistent connection with the AMQP broker.
This method will close an open persistent connection with the AMQP
broker.
@throws AMQPConnectionException When attempting to disconnect a transient connection
@return void | pdisconnect | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function preconnect() {} | Close any open persistent connections and initiate a new one with the AMQP broker.
@throws AMQPConnectionException
@return void | preconnect | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setHost($host) {} | Set the hostname used to connect to the AMQP broker.
@param string $host The hostname of the AMQP broker.
@throws AMQPConnectionException If host is longer then 1024 characters.
@return void | setHost | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setLogin($login) {} | Set the login string used to connect to the AMQP broker.
@param string $login The login string used to authenticate
with the AMQP broker.
@throws AMQPConnectionException If login is longer then 32 characters.
@return void | setLogin | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setPassword($password) {} | Set the password string used to connect to the AMQP broker.
@param string $password The password string used to authenticate
with the AMQP broker.
@throws AMQPConnectionException If password is longer then 32characters.
@return void | setPassword | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setPort($port) {} | Set the port used to connect to the AMQP broker.
@param int $port The port used to connect to the AMQP broker.
@throws AMQPConnectionException If port is longer not between
1 and 65535.
@return void | setPort | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setVhost($vhost) {} | Sets the virtual host to which to connect on the AMQP broker.
@param string $vhost The virtual host to use on the AMQP
broker.
@throws AMQPConnectionException If host is longer then 32 characters.
@return void | setVhost | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setTimeout($timeout) {} | Sets the interval of time to wait for income activity from AMQP broker
@deprecated use AMQPConnection::setReadTimeout($timeout) instead
@param float $timeout
@throws AMQPConnectionException If timeout is less than 0.
@return void | setTimeout | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getTimeout() {} | Get the configured interval of time to wait for income activity
from AMQP broker
@deprecated use AMQPConnection::getReadTimeout() instead
@return float | getTimeout | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setReadTimeout($timeout) {} | Sets the interval of time to wait for income activity from AMQP broker
@param float $timeout
@throws AMQPConnectionException If timeout is less than 0.
@return void | setReadTimeout | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getReadTimeout() {} | Get the configured interval of time to wait for income activity
from AMQP broker
@return float | getReadTimeout | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setWriteTimeout($timeout) {} | Sets the interval of time to wait for outcome activity to AMQP broker
@param float $timeout
@throws AMQPConnectionException If timeout is less than 0.
@return void | setWriteTimeout | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getWriteTimeout() {} | Get the configured interval of time to wait for outcome activity
to AMQP broker
@return float | getWriteTimeout | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function setRpcTimeout($timeout) {} | Sets the interval of time to wait for RPC activity to AMQP broker
@param float $timeout
@throws AMQPConnectionException If timeout is less than 0.
@return void | setRpcTimeout | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getRpcTimeout() {} | Get the configured interval of time to wait for RPC activity
to AMQP broker
@return float | getRpcTimeout | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getUsedChannels() {} | Return last used channel id during current connection session.
@return int | getUsedChannels | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getMaxChannels() {} | Get the maximum number of channels the connection can handle.
When connection is connected, effective connection value returned, which is normally the same as original
correspondent value passed to constructor, otherwise original value passed to constructor returned.
@return int | getMaxChannels | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getMaxFrameSize() {} | Get max supported frame size per connection in bytes.
When connection is connected, effective connection value returned, which is normally the same as original
correspondent value passed to constructor, otherwise original value passed to constructor returned.
@return int | getMaxFrameSize | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
public function getHeartbeatInterval() {} | Get number of seconds between heartbeats of the connection in seconds.
When connection is connected, effective connection value returned, which is normally the same as original
correspondent value passed to constructor, otherwise original value passed to constructor returned.
@return int | getHeartbeatInterval | php | JetBrains/phpstorm-stubs | amqp/amqp.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/amqp/amqp.php | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.