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 getChildDocumentsCount() {} | (PECL solr >= 2.3.0)<br/>
Returns the number of child documents
@link https://php.net/manual/en/solrinputdocument.getchilddocumentscount.php
@return int | getChildDocumentsCount | php | JetBrains/phpstorm-stubs | solr/Documents/SolrInputDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrInputDocument.php | Apache-2.0 |
public function getField($fieldName) {} | (PECL solr >= 0.9.2)<br/>
Retrieves a field by name
@link https://php.net/manual/en/solrinputdocument.getfield.php
@param string $fieldName <p>
The name of the field.
</p>
@return SolrDocumentField|false Returns a SolrDocumentField object on success and <b>FALSE</b> on failure. | getField | php | JetBrains/phpstorm-stubs | solr/Documents/SolrInputDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrInputDocument.php | Apache-2.0 |
public function getFieldBoost($fieldName) {} | (PECL solr >= 0.9.2)<br/>
Retrieves the boost value for a particular field
@link https://php.net/manual/en/solrinputdocument.getfieldboost.php
@param string $fieldName <p>
The name of the field.
</p>
@return float|false <p>
Returns the boost value for the field or <b>FALSE</b> if there was an error.
</p> | getFieldBoost | php | JetBrains/phpstorm-stubs | solr/Documents/SolrInputDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrInputDocument.php | Apache-2.0 |
public function getFieldCount() {} | (PECL solr >= 0.9.2)<br/>
Returns the number of fields in the document
@link https://php.net/manual/en/solrinputdocument.getfieldcount.php
@return int|false <p>
Returns an integer on success or <b>FALSE</b> on failure.
</p> | getFieldCount | php | JetBrains/phpstorm-stubs | solr/Documents/SolrInputDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrInputDocument.php | Apache-2.0 |
public function getFieldNames() {} | (PECL solr >= 0.9.2)<br/>
Returns an array containing all the fields in the document
@link https://php.net/manual/en/solrinputdocument.getfieldnames.php
@return array|false <p>
Returns an array on success and <b>FALSE</b> on failure.
</p> | getFieldNames | php | JetBrains/phpstorm-stubs | solr/Documents/SolrInputDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrInputDocument.php | Apache-2.0 |
public function hasChildDocuments() {} | (PECL solr >= 2.3.0)<br/>
Checks whether the document has any child documents
@link https://php.net/manual/en/solrinputdocument.haschilddocuments.php
@return bool <p>
Returns <b>TRUE</b> if the document has any child documents
</p> | hasChildDocuments | php | JetBrains/phpstorm-stubs | solr/Documents/SolrInputDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrInputDocument.php | Apache-2.0 |
public function merge(SolrInputDocument $sourceDoc, $overwrite = true) {} | (PECL solr >= 0.9.2)<br/>
Merges one input document into another
@link https://php.net/manual/en/solrinputdocument.merge.php
@param SolrInputDocument $sourceDoc <p>
The source document.
</p>
@param bool $overwrite [optional] <p>
If this is <b>TRUE</b> it will replace matching fields in the destination document.
</p>
@return bool <p>
Returns <b>TRUE</b> on success or <b>FALSE</b> on failure. In the future, this will be modified to return the
number of fields in the new document.
</p> | merge | php | JetBrains/phpstorm-stubs | solr/Documents/SolrInputDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrInputDocument.php | Apache-2.0 |
public function reset() {} | (PECL solr >= 0.9.2)<br/>
This is an alias of SolrInputDocument::clear
@link https://php.net/manual/en/solrinputdocument.reset.php
@return bool <p>
Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
</p> | reset | php | JetBrains/phpstorm-stubs | solr/Documents/SolrInputDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrInputDocument.php | Apache-2.0 |
public function setBoost($documentBoostValue) {} | (PECL solr >= 0.9.2)<br/>
Sets the boost value for this document
@link https://php.net/manual/en/solrinputdocument.setboost.php
@param float $documentBoostValue <p>
The index-time boost value for this document.
</p>
@return bool <p>
Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
</p> | setBoost | php | JetBrains/phpstorm-stubs | solr/Documents/SolrInputDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrInputDocument.php | Apache-2.0 |
public function setFieldBoost($fieldName, $fieldBoostValue) {} | (PECL solr >= 0.9.2)<br/>
Sets the index-time boost value for a field
https://php.net/manual/en/solrinputdocument.setfieldboost.php
@param string $fieldName <p>
The name of the field.
</p>
@param float $fieldBoostValue <p>
The index time boost value.
</p> | setFieldBoost | php | JetBrains/phpstorm-stubs | solr/Documents/SolrInputDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrInputDocument.php | Apache-2.0 |
public function sort($sortOrderBy, $sortDirection = SolrInputDocument::SORT_ASC) {} | (PECL solr >= 0.9.2)<br/>
Sorts the fields within the document
@link https://php.net/manual/en/solrinputdocument.sort.php
@param int $sortOrderBy <p>
The sort criteria, must be one of :
<ul>
<li>SolrInputDocument::SORT_FIELD_NAME</li>
<li>SolrInputDocument::SORT_FIELD_BOOST_VALUE</li>
<li>SolrInputDocument::SORT_FIELD_VALUE_COUNT</li>
</ul>
</p>
@param int $sortDirection [optional] <p>
The sort direction, can be one of :
<ul>
<li>SolrInputDocument::SORT_DEFAULT</li>
<li>SolrInputDocument::SORT_ASC</li>
<li>SolrInputDocument::SORT_DESC</li>
</ul>
</p>
@return bool <p>
Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
</p> | sort | php | JetBrains/phpstorm-stubs | solr/Documents/SolrInputDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrInputDocument.php | Apache-2.0 |
public function toArray() {} | (PECL solr >= 0.9.2)<br/>
Returns an array representation of the input document
@link https://php.net/manual/en/solrinputdocument.toarray.php
@return array|false <p>
Returns an array containing the fields. It returns FALSE on failure.
</p> | toArray | php | JetBrains/phpstorm-stubs | solr/Documents/SolrInputDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrInputDocument.php | Apache-2.0 |
public function addField($fieldName, $fieldValue) {} | (PECL solr >= 0.9.2)<br/>
Adds a field to the document
@link https://php.net/manual/en/solrdocument.addfield.php
@param string $fieldName <p>
The name of the field
</p>
@param string $fieldValue <p>
The value for the field.
</p>
@return bool <p>
Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
</p> | addField | php | JetBrains/phpstorm-stubs | solr/Documents/SolrDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrDocument.php | Apache-2.0 |
public function __get($fieldName) {} | (PECL solr >= 0.9.2)<br/>
Access the field as a property
@link https://php.net/manual/en/solrdocument.get.php
@param string $fieldName <p>
The name of the field.
</p>
@return SolrDocumentField <p>
Returns a SolrDocumentField instance.
</p> | __get | php | JetBrains/phpstorm-stubs | solr/Documents/SolrDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrDocument.php | Apache-2.0 |
public function getInputDocument() {} | (PECL solr >= 0.9.2)<br/>
Returns a SolrInputDocument equivalent of the object
@link https://php.net/manual/en/solrdocument.getinputdocument.php
@return SolrInputDocument <p>
Returns a SolrInputDocument on success and <b>NULL</b> on failure.
</p> | getInputDocument | php | JetBrains/phpstorm-stubs | solr/Documents/SolrDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrDocument.php | Apache-2.0 |
public function __isset($fieldName) {} | (PECL solr >= 0.9.2)<br/>
Checks if a field exists
@link https://php.net/manual/en/solrdocument.isset.php
@param string $fieldName <p>
Name of the field.
</p>
@return bool <p>
Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
</p> | __isset | php | JetBrains/phpstorm-stubs | solr/Documents/SolrDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrDocument.php | Apache-2.0 |
public function key() {} | (PECL solr >= 0.9.2)<br/>
Retrieves the current key
@link https://php.net/manual/en/solrdocument.key.php
@return string <p>
Returns the current key.
</p> | key | php | JetBrains/phpstorm-stubs | solr/Documents/SolrDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrDocument.php | Apache-2.0 |
public function next() {} | (PECL solr >= 0.9.2)<br/>
Moves the internal pointer to the next field
@link https://php.net/manual/en/solrdocument.next.php | next | php | JetBrains/phpstorm-stubs | solr/Documents/SolrDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrDocument.php | Apache-2.0 |
public function offsetExists($fieldName) {} | (PECL solr >= 0.9.2)<br/>
Checks if a particular field exists
@link https://php.net/manual/en/solrdocument.offsetexists.php
@param string $fieldName <p>
The name of the field.
</p>
@return bool <p>
Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
</p> | offsetExists | php | JetBrains/phpstorm-stubs | solr/Documents/SolrDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrDocument.php | Apache-2.0 |
public function offsetGet($fieldName) {} | (PECL solr >= 0.9.2)<br/>
Retrieves a field
@link https://php.net/manual/en/solrdocument.offsetget.php
@param string $fieldName <p>
The name of the field.
</p>
@return SolrDocumentField <p>
Returns a SolrDocumentField object.
</p> | offsetGet | php | JetBrains/phpstorm-stubs | solr/Documents/SolrDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrDocument.php | Apache-2.0 |
public function offsetSet($fieldName, $fieldValue) {} | (PECL solr >= 0.9.2)<br/>
Adds a field to the document
@link https://php.net/manual/en/solrdocument.offsetset.php
@param string $fieldName <p>
The name of the field.
</p>
@param string $fieldValue <p>
The value for this field.
</p>
@return bool | offsetSet | php | JetBrains/phpstorm-stubs | solr/Documents/SolrDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrDocument.php | Apache-2.0 |
public function offsetUnset($fieldName) {} | (PECL solr >= 0.9.2)<br/>
Removes a field
@link https://php.net/manual/en/solrdocument.offsetunset.php
@param string $fieldName <p>
The name of the field.
</p> | offsetUnset | php | JetBrains/phpstorm-stubs | solr/Documents/SolrDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrDocument.php | Apache-2.0 |
public function rewind() {} | (PECL solr >= 0.9.2)<br/>
Resets the internal pointer to the beginning
@link https://php.net/manual/en/solrdocument.rewind.php | rewind | php | JetBrains/phpstorm-stubs | solr/Documents/SolrDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrDocument.php | Apache-2.0 |
public function serialize() {} | (PECL solr >= 0.9.2)<br/>
Used for custom serialization
@link https://php.net/manual/en/solrdocument.serialize.php
@return string <p>
Returns a string representing the serialized Solr document.
</p> | serialize | php | JetBrains/phpstorm-stubs | solr/Documents/SolrDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrDocument.php | Apache-2.0 |
public function __set($fieldName, $fieldValue) {} | (PECL solr >= 0.9.2)<br/>
Adds another field to the document
@link https://php.net/manual/en/solrdocument.set.php
@param string $fieldName <p>
Name of the field.
</p>
@param string $fieldValue <p>
Field value.
</p>
@return bool <p>
Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
</p> | __set | php | JetBrains/phpstorm-stubs | solr/Documents/SolrDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrDocument.php | Apache-2.0 |
public function unserialize($serialized) {} | (PECL solr >= 0.9.2)<br/>
Custom serialization of SolrDocument objects
@link https://php.net/manual/en/solrdocument.unserialize.php
@param string $serialized <p>
An XML representation of the document.
</p> | unserialize | php | JetBrains/phpstorm-stubs | solr/Documents/SolrDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrDocument.php | Apache-2.0 |
public function __unset($fieldName) {} | (PECL solr >= 0.9.2)<br/>
Removes a field from the document
@link https://php.net/manual/en/solrdocument.unset.php
@param string $fieldName <p>
The name of the field.
</p>
@return bool <p>
Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
</p> | __unset | php | JetBrains/phpstorm-stubs | solr/Documents/SolrDocument.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Documents/SolrDocument.php | Apache-2.0 |
function mcrypt_ecb($cipher, $key, $data, $mode) {} | Encrypt/decrypt data in ECB mode
@link https://php.net/manual/en/function.mcrypt-ecb.php
@param string|int $cipher
@param string $key
@param string $data
@param int $mode
@return string
@removed 7.0 | mcrypt_ecb | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_cbc($cipher, $key, $data, $mode, $iv = null) {} | Encrypt/decrypt data in CBC mode
@link https://php.net/manual/en/function.mcrypt-cbc.php
@param int|string $cipher
@param string $key
@param string $data
@param int $mode
@param string $iv [optional]
@return string
@removed 7.0 | mcrypt_cbc | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_cfb($cipher, $key, $data, $mode, $iv = null) {} | Encrypt/decrypt data in CFB mode
@link https://php.net/manual/en/function.mcrypt-cfb.php
@param int|string $cipher
@param string $key
@param string $data
@param int $mode
@param string $iv [optional]
@return string
@removed 7.0 | mcrypt_cfb | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_ofb($cipher, $key, $data, $mode, $iv = null) {} | Encrypt/decrypt data in OFB mode
@link https://php.net/manual/en/function.mcrypt-ofb.php
@param int|string $cipher
@param string $key
@param string $data
@param int $mode
@param string $iv [optional]
@return string
@removed 7.0 | mcrypt_ofb | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_get_key_size($cipher, $module) {} | Get the key size of the specified cipher
@link https://php.net/manual/en/function.mcrypt-get-key-size.php
@param int|string $cipher
@param string $module
@return int
@removed 7.2 | mcrypt_get_key_size | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_get_block_size($cipher, $module) {} | Get the block size of the specified cipher
@link https://php.net/manual/en/function.mcrypt-get-block-size.php
@param string|int $cipher <p>
One of the MCRYPT_ciphername constants or the name
of the algorithm as string.
</p>
@param string $module <p>
One of the <b>MCRYPT_MODE_modename</b> constants, or one of the following strings: "ecb", "cbc", "cfb", "ofb", "nofb" or "stream".</p>
@return int Gets the block size, as an integer.
@removed 7.2 | mcrypt_get_block_size | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_get_cipher_name($cipher) {} | Get the name of the specified cipher
@link https://php.net/manual/en/function.mcrypt-get-cipher-name.php
@param int|string $cipher <p>
One of the MCRYPT_ciphername constants or the name
of the algorithm as string.
</p>
@return string|false This function returns the name of the cipher or false, if the cipher does
not exist.
@removed 7.2 | mcrypt_get_cipher_name | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_create_iv($size, $source = MCRYPT_DEV_URANDOM) {} | Creates an initialization vector (IV) from a random source
@link https://php.net/manual/en/function.mcrypt-create-iv.php
@param int $size <p>
Determines the size of the IV, parameter source
(defaults to random value) specifies the source of the IV.
</p>
@param int $source [optional] <p>
The source can be MCRYPT_RAND (system random
number generator), MCRYPT_DEV_RANDOM (read
data from /dev/random) and
MCRYPT_DEV_URANDOM (read data from
/dev/urandom). MCRYPT_RAND
is the only one supported on Windows because Windows (of course)
doesn't have /dev/random or
/dev/urandom.
</p>
<p>
When using MCRYPT_RAND, remember to call
srand before
mcrypt_create_iv to initialize the random
number generator; it is not seeded automatically like
rand is.
</p>
@return string|false the initialization vector, or false on error.
@removed 7.2 | mcrypt_create_iv | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_list_algorithms($lib_dir = null) {} | Gets an array of all supported ciphers
@link https://php.net/manual/en/function.mcrypt-list-algorithms.php
@param string $lib_dir [optional] <p>
Specifies the directory where all algorithms are located. If not
specifies, the value of the mcrypt.algorithms_dir (php.ini) directive
is used.
</p>
@return array an array with all the supported algorithms.
@removed 7.2 | mcrypt_list_algorithms | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_list_modes($lib_dir = null) {} | Gets an array of all supported modes
@link https://php.net/manual/en/function.mcrypt-list-modes.php
@param string $lib_dir [optional] <p>
Specifies the directory where all modes are located. If not
specifies, the value of the mcrypt.modes_dir
(php.ini) directive is used.
</p>
@return array an array with all the supported modes.
@removed 7.2 | mcrypt_list_modes | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_get_iv_size($cipher, $module) {} | Returns the size of the IV belonging to a specific cipher/mode combination
@link https://php.net/manual/en/function.mcrypt-get-iv-size.php
@param string $cipher <p>
One of the MCRYPT_ciphername constants of the name
of the algorithm as string.
</p>
@param string $module <p>
mode is one of the MCRYPT_MODE_modename constants
or one of "ecb", "cbc", "cfb", "ofb", "nofb" or "stream". The IV is
ignored in ECB mode as this mode does not require it. You will need to
have the same IV (think: starting point) both at encryption and
decryption stages, otherwise your encryption will fail.
</p>
@return int|false the size of the Initialisation Vector (IV) in bytes. On error the
function returns false. If the IV is ignored in the specified cipher/mode
combination zero is returned.
@removed 7.2 | mcrypt_get_iv_size | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_encrypt($cipher, $key, $data, $mode, $iv = null) {} | Encrypts plaintext with given parameters
@link https://php.net/manual/en/function.mcrypt-encrypt.php
@param string $cipher <p>
One of the MCRYPT_ciphername
constants of the name of the algorithm as string.
</p>
@param string $key <p>
The key with which the data will be encrypted. If it's smaller that
the required keysize, it is padded with '\0'. It is
better not to use ASCII strings for keys.
</p>
<p>
It is recommended to use the mhash functions to create a key from a
string.
</p>
@param string $data <p>
The data that will be encrypted with the given cipher and mode. If the
size of the data is not n * blocksize, the data will be padded with
'\0'.
</p>
<p>
The returned crypttext can be larger that the size of the data that is
given by data.
</p>
@param string $mode <p>
One of the MCRYPT_MODE_modename
constants of one of "ecb", "cbc", "cfb", "ofb", "nofb" or
"stream".
</p>
@param string $iv [optional] <p>
Used for the initialisation in CBC, CFB, OFB modes, and in some
algorithms in STREAM mode. If you do not supply an IV, while it is
needed for an algorithm, the function issues a warning and uses an
IV with all bytes set to '\0'.
</p>
@return string the encrypted data, as a string.
@removed 7.2 | mcrypt_encrypt | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_decrypt($cipher, $key, $data, $mode, $iv = null) {} | Decrypts crypttext with given parameters
@link https://php.net/manual/en/function.mcrypt-decrypt.php
@param string $cipher <p>
cipher is one of the MCRYPT_ciphername constants
of the name of the algorithm as string.
</p>
@param string $key <p>
key is the key with which the data is encrypted.
If it's smaller that the required keysize, it is padded with
'\0'.
</p>
@param string $data <p>
data is the data that will be decrypted with
the given cipher and mode. If the size of the data is not n * blocksize,
the data will be padded with '\0'.
</p>
@param string $mode <p>
mode is one of the MCRYPT_MODE_modename
constants of one of "ecb", "cbc", "cfb", "ofb", "nofb" or "stream".
</p>
@param string $iv [optional] <p>
The iv parameter is used for the initialisation
in CBC, CFB, OFB modes, and in some algorithms in STREAM mode. If you
do not supply an IV, while it is needed for an algorithm, the function
issues a warning and uses an IV with all bytes set to
'\0'.
</p>
@return string the decrypted data as a string.
@removed 7.2 | mcrypt_decrypt | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_module_open($cipher, $cipher_directory, $mode, $mode_directory) {} | Opens the module of the algorithm and the mode to be used
@link https://php.net/manual/en/function.mcrypt-module-open.php
@param string $cipher <p>
The algorithm to be used.
</p>
@param string $cipher_directory <p>
The algorithm_directory and
mode_directory are used to locate the encryption
modules. When you supply a directory name, it is used. When you set one
of these to the empty string (""), the value set by
the mcrypt.algorithms_dir or
mcrypt.modes_dir ini-directive is used. When
these are not set, the default directories that are used are the ones
that were compiled in into libmcrypt (usually
/usr/local/lib/libmcrypt).
</p>
@param string $mode <p>
The mode to be used.
</p>
@param string $mode_directory <p>
</p>
@return resource|false Normally it returns an encryption descriptor, or false on error.
@removed 7.2 | mcrypt_module_open | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_generic_init($td, $key, $iv) {} | This function initializes all buffers needed for encryption
@link https://php.net/manual/en/function.mcrypt-generic-init.php
@param resource $td <p>
The encryption descriptor.
</p>
@param string $key <p>
The maximum length of the key should be the one obtained by calling
mcrypt_enc_get_key_size and every value smaller
than this is legal.
</p>
@param string $iv <p>
The IV should normally have the size of the algorithms block size, but
you must obtain the size by calling
mcrypt_enc_get_iv_size. IV is ignored in ECB. IV
MUST exist in CFB, CBC, STREAM, nOFB and OFB modes. It needs to be
random and unique (but not secret). The same IV must be used for
encryption/decryption. If you do not want to use it you should set it
to zeros, but this is not recommended.
</p>
@return int|false The function returns a negative value on error, -3 when the key length
was incorrect, -4 when there was a memory allocation problem and any
other return value is an unknown error. If an error occurs a warning will
be displayed accordingly. false is returned if incorrect parameters
were passed.
@removed 7.2 | mcrypt_generic_init | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_generic($td, $data) {} | This function encrypts data
@link https://php.net/manual/en/function.mcrypt-generic.php
@param resource $td <p>
The encryption descriptor.
</p>
<p>
The encryption handle should always be initialized with
mcrypt_generic_init with a key and an IV before
calling this function. Where the encryption is done, you should free the
encryption buffers by calling mcrypt_generic_deinit.
See mcrypt_module_open for an example.
</p>
@param string $data <p>
The data to encrypt.
</p>
@return string the encrypted data.
@removed 7.2 | mcrypt_generic | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mdecrypt_generic($td, $data) {} | Decrypts data
@link https://php.net/manual/en/function.mdecrypt-generic.php
@param resource $td <p>
An encryption descriptor returned by
mcrypt_module_open
</p>
@param string $data <p>
Encrypted data.
</p>
@return string
@removed 7.2 | mdecrypt_generic | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_generic_end($td) {} | This function terminates encryption
@link https://php.net/manual/en/function.mcrypt-generic-end.php
@param resource $td
@return bool
@removed 7.0 | mcrypt_generic_end | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_generic_deinit($td) {} | This function deinitializes an encryption module
@link https://php.net/manual/en/function.mcrypt-generic-deinit.php
@param resource $td <p>
The encryption descriptor.
</p>
@return bool true on success or false on failure.
@removed 7.2 | mcrypt_generic_deinit | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_enc_self_test($td) {} | Runs a self test on the opened module
@link https://php.net/manual/en/function.mcrypt-enc-self-test.php
@param resource $td <p>
The encryption descriptor.
</p>
@return int Returns 0 on success and a negative integer on failure
@removed 7.2 | mcrypt_enc_self_test | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_enc_is_block_algorithm_mode($td) {} | Checks whether the encryption of the opened mode works on blocks
@link https://php.net/manual/en/function.mcrypt-enc-is-block-algorithm-mode.php
@param resource $td <p>
The encryption descriptor.
</p>
@return bool true if the mode is for use with block algorithms, otherwise it
returns false.
@removed 7.2 | mcrypt_enc_is_block_algorithm_mode | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_enc_is_block_algorithm($td) {} | Checks whether the algorithm of the opened mode is a block algorithm
@link https://php.net/manual/en/function.mcrypt-enc-is-block-algorithm.php
@param resource $td <p>
The encryption descriptor.
</p>
@return bool true if the algorithm is a block algorithm or false if it is
a stream one.
@removed 7.2 | mcrypt_enc_is_block_algorithm | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_enc_is_block_mode($td) {} | Checks whether the opened mode outputs blocks
@link https://php.net/manual/en/function.mcrypt-enc-is-block-mode.php
@param resource $td <p>
The encryption descriptor.
</p>
@return bool true if the mode outputs blocks of bytes or false if it outputs bytes.
@removed 7.2 | mcrypt_enc_is_block_mode | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_enc_get_block_size($td) {} | Returns the blocksize of the opened algorithm
@link https://php.net/manual/en/function.mcrypt-enc-get-block-size.php
@param resource $td <p>
The encryption descriptor.
</p>
@return int the block size of the specified algorithm in bytes.
@removed 7.2 | mcrypt_enc_get_block_size | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_enc_get_key_size($td) {} | Returns the maximum supported keysize of the opened mode
@link https://php.net/manual/en/function.mcrypt-enc-get-key-size.php
@param resource $td <p>
The encryption descriptor.
</p>
@return int the maximum supported key size of the algorithm in bytes.
@removed 7.2 | mcrypt_enc_get_key_size | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_enc_get_supported_key_sizes($td) {} | Returns an array with the supported keysizes of the opened algorithm
@link https://php.net/manual/en/function.mcrypt-enc-get-supported-key-sizes.php
@param resource $td <p>
The encryption descriptor.
</p>
@return array an array with the key sizes supported by the algorithm
specified by the encryption descriptor. If it returns an empty
array then all key sizes between 1 and
mcrypt_enc_get_key_size are supported by the
algorithm.
@removed 7.2 | mcrypt_enc_get_supported_key_sizes | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_enc_get_iv_size($td) {} | Returns the size of the IV of the opened algorithm
@link https://php.net/manual/en/function.mcrypt-enc-get-iv-size.php
@param resource $td <p>
The encryption descriptor.
</p>
@return int the size of the IV, or 0 if the IV is ignored in the algorithm.
@removed 7.2 | mcrypt_enc_get_iv_size | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_enc_get_algorithms_name($td) {} | Returns the name of the opened algorithm
@link https://php.net/manual/en/function.mcrypt-enc-get-algorithms-name.php
@param resource $td <p>
The encryption descriptor.
</p>
@return string the name of the opened algorithm as a string.
@removed 7.2 | mcrypt_enc_get_algorithms_name | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_enc_get_modes_name($td) {} | Returns the name of the opened mode
@link https://php.net/manual/en/function.mcrypt-enc-get-modes-name.php
@param resource $td <p>
The encryption descriptor.
</p>
@return string the name as a string.
@removed 7.2 | mcrypt_enc_get_modes_name | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_module_self_test($algorithm, $lib_dir = null) {} | This function runs a self test on the specified module
@link https://php.net/manual/en/function.mcrypt-module-self-test.php
@param string $algorithm <p>
One of the <b>MCRYPT_ciphername</b> constants, or the name of the algorithm as string.
</p>
@param string $lib_dir [optional] <p>
The optional lib_dir parameter can contain the
location of where the algorithm module is on the system.
</p>
@return bool The function returns true if the self test succeeds, or false when if
fails.
@removed 7.2 | mcrypt_module_self_test | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_module_is_block_algorithm_mode($mode, $lib_dir = null) {} | Returns if the specified module is a block algorithm or not
@link https://php.net/manual/en/function.mcrypt-module-is-block-algorithm-mode.php
@param string $mode <p>
The mode to check.
</p>
@param string $lib_dir [optional] <p>
The optional lib_dir parameter can contain the
location of where the algorithm module is on the system.
</p>
@return bool This function returns true if the mode is for use with block
algorithms, otherwise it returns false. (e.g. false for stream, and
true for cbc, cfb, ofb).
@removed 7.2 | mcrypt_module_is_block_algorithm_mode | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_module_is_block_algorithm($algorithm, $lib_dir = null) {} | This function checks whether the specified algorithm is a block algorithm
@link https://php.net/manual/en/function.mcrypt-module-is-block-algorithm.php
@param string $algorithm <p>
The algorithm to check.
</p>
@param string $lib_dir [optional] <p>
The optional lib_dir parameter can contain the
location of where the algorithm module is on the system.
</p>
@return bool This function returns true if the specified algorithm is a block
algorithm, or false is it is a stream algorithm.
@removed 7.2 | mcrypt_module_is_block_algorithm | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_module_is_block_mode($mode, $lib_dir = null) {} | Returns if the specified mode outputs blocks or not
@link https://php.net/manual/en/function.mcrypt-module-is-block-mode.php
@param string $mode <p>
The mode to check.
</p>
@param string $lib_dir [optional] <p>
The optional lib_dir parameter can contain the
location of where the algorithm module is on the system.
</p>
@return bool This function returns true if the mode outputs blocks of bytes or
false if it outputs just bytes. (e.g. true for cbc and ecb, and
false for cfb and stream).
@removed 7.2 | mcrypt_module_is_block_mode | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_module_get_algo_block_size($algorithm, $lib_dir = null) {} | Returns the blocksize of the specified algorithm
@link https://php.net/manual/en/function.mcrypt-module-get-algo-block-size.php
@param string $algorithm <p>
The algorithm name.
</p>
@param string $lib_dir [optional] <p>
This optional parameter can contain the location where the mode module
is on the system.
</p>
@return int the block size of the algorithm specified in bytes.
@removed 7.2 | mcrypt_module_get_algo_block_size | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_module_get_algo_key_size($algorithm, $lib_dir = null) {} | Returns the maximum supported keysize of the opened mode
@link https://php.net/manual/en/function.mcrypt-module-get-algo-key-size.php
@param string $algorithm <p>
The algorithm name.
</p>
@param string $lib_dir [optional] <p>
This optional parameter can contain the location where the mode module
is on the system.
</p>
@return int This function returns the maximum supported key size of the
algorithm specified in bytes.
@removed 7.2 | mcrypt_module_get_algo_key_size | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_module_get_supported_key_sizes($algorithm, $lib_dir = null) {} | Returns an array with the supported keysizes of the opened algorithm
@link https://php.net/manual/en/function.mcrypt-module-get-supported-key-sizes.php
@param string $algorithm <p>
The algorithm to used.
</p>
@param string $lib_dir [optional] <p>
The optional lib_dir parameter can contain the
location of where the algorithm module is on the system.
</p>
@return array an array with the key sizes supported by the specified algorithm.
If it returns an empty array then all key sizes between 1 and
mcrypt_module_get_algo_key_size are supported by the
algorithm.
@removed 7.2 | mcrypt_module_get_supported_key_sizes | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function mcrypt_module_close($td) {} | Closes the mcrypt module
@link https://php.net/manual/en/function.mcrypt-module-close.php
@param resource $td <p>
The encryption descriptor.
</p>
@return bool true on success or false on failure.
@removed 7.2 | mcrypt_module_close | php | JetBrains/phpstorm-stubs | mcrypt/mcrypt.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mcrypt/mcrypt.php | Apache-2.0 |
function igbinary_serialize($value) {} | Generates a storable representation of a value.
This is useful for storing or passing PHP values around without losing their type and structure.
To make the serialized string into a PHP value again, use {@link igbinary_unserialize}.
igbinary_serialize() handles all types, except the resource-type.
You can even serialize() arrays that contain references to itself.
Circular references inside the array/object you are serialize()ing will also be stored.
If object implements {@link https://secure.php.net/~helly/php/ext/spl/interfaceSerializable.html Serializable} -interface,
PHP will call the member function serialize to get serialized representation of object.
When serializing objects, PHP will attempt to call the member function __sleep prior to serialization.
This is to allow the object to do any last minute clean-up, etc. prior to being serialized.
Likewise, when the object is restored using unserialize() the __wakeup member function is called.
@param mixed $value The value to be serialized.
@return string|null Returns a string containing a byte-stream representation of value that can be stored anywhere or <b>NULL</b> on error.
@link https://secure.php.net/serialize PHP default serialize | igbinary_serialize | php | JetBrains/phpstorm-stubs | igbinary/igbinary.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/igbinary/igbinary.php | Apache-2.0 |
function igbinary_unserialize($str) {} | Creates a PHP value from a stored representation.
igbinary_unserialize() takes a single serialized variable and converts it back into a PHP value.
If the variable being unserialized is an object, after successfully reconstructing the object
PHP will automatically attempt to call the __wakeup() member function (if it exists).
In case the passed string is not unserializeable, NULL is returned and E_WARNING is issued.
@param string $str The serialized string.
@return mixed|false The converted value is returned, and can be a boolean, integer, float, string, array, object or <b>false</b> by empty string input.
@link https://secure.php.net/manual/en/function.unserialize.php PHP default unserialize
@link https://secure.php.net/~helly/php/ext/spl/interfaceSerializable.html Serializable | igbinary_unserialize | php | JetBrains/phpstorm-stubs | igbinary/igbinary.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/igbinary/igbinary.php | Apache-2.0 |
public function __construct($value = null) {} | Shall construct a new synchronization object with no value
Shall construct a new synchronization object containing the given scalar value
@param string|int|float|bool $value
@throws Sync\Error\IllegalValue if value is non-scalar. | __construct | php | JetBrains/phpstorm-stubs | parallel/parallel/Sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/parallel/parallel/Sync.php | Apache-2.0 |
public function get() {} | Shall atomically return the synchronization objects value
@return string|int|float|bool | get | php | JetBrains/phpstorm-stubs | parallel/parallel/Sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/parallel/parallel/Sync.php | Apache-2.0 |
public function set($value) {} | Shall atomically set the value of the synchronization object
@param string|int|float|bool $value
@throws Sync\Error\IllegalValue if value is non-scalar. | set | php | JetBrains/phpstorm-stubs | parallel/parallel/Sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/parallel/parallel/Sync.php | Apache-2.0 |
public function __invoke(callable $block) {} | Shall exclusively enter into the critical code
@param callable $block | __invoke | php | JetBrains/phpstorm-stubs | parallel/parallel/Sync.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/parallel/parallel/Sync.php | Apache-2.0 |
public function value() {} | Shall return (and if necessary wait for) return from task
@return mixed
@throws Future\Error if waiting failed (internal error).
@throws Future\Error\Killed if \parallel\Runtime executing task was killed.
@throws Future\Error\Cancelled if task was cancelled.
@throws Future\Error\Foreign if task raised an unrecognized uncaught exception.
@throws Throwable Shall rethrow \Throwable uncaught in task | value | php | JetBrains/phpstorm-stubs | parallel/parallel/Future.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/parallel/parallel/Future.php | Apache-2.0 |
public function __construct(?int $capacity = null) {} | Shall make an anonymous unbuffered channel
Shall make an anonymous buffered channel with the given capacity
@param null|int $capacity May be Channel::Infinite or a positive integer | __construct | php | JetBrains/phpstorm-stubs | parallel/parallel/Channel.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/parallel/parallel/Channel.php | Apache-2.0 |
public function recv() {} | Shall recv a value from this channel
@return mixed
@throws Channel\Error\Closed if channel is closed. | recv | php | JetBrains/phpstorm-stubs | parallel/parallel/Channel.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/parallel/parallel/Channel.php | Apache-2.0 |
public function __construct(?string $bootstrap = null) {} | Shall construct a new runtime without bootstrapping.
Shall construct a bootstrapped runtime.
@param null|string $bootstrap The location of a bootstrap file, generally an autoloader.
@throws Runtime\Error if thread could not be created
@throws Runtime\Error\Bootstrap if bootstrapping failed | __construct | php | JetBrains/phpstorm-stubs | parallel/parallel/Runtime.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/parallel/parallel/Runtime.php | Apache-2.0 |
function ms_GetVersion() {} | Returns the MapServer version and options in a string. This
string can be parsed to find out which modules were compiled in,
etc.
@return string | ms_GetVersion | php | JetBrains/phpstorm-stubs | mapscript/mapscript.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mapscript/mapscript.php | Apache-2.0 |
function ms_GetVersionInt() {} | Returns the MapServer version number (x.y.z) as an integer
(x*10000 + y*100 + z). (New in v5.0) e.g. V5.4.3 would return
50403.
@return int | ms_GetVersionInt | php | JetBrains/phpstorm-stubs | mapscript/mapscript.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mapscript/mapscript.php | Apache-2.0 |
function ms_iogetStdoutBufferBytes() {} | Writes the current buffer to stdout. The PHP header() function
should be used to set the documents's content-type prior to
calling the function. Returns the number of bytes written if
output is sent to stdout. See :ref:`mapscript_ows` for more info.
@return int | ms_iogetStdoutBufferBytes | php | JetBrains/phpstorm-stubs | mapscript/mapscript.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mapscript/mapscript.php | Apache-2.0 |
function ms_iogetstdoutbufferstring() {} | Fetch the current stdout buffer contents as a string. This method
does not clear the buffer.
@return void | ms_iogetstdoutbufferstring | php | JetBrains/phpstorm-stubs | mapscript/mapscript.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mapscript/mapscript.php | Apache-2.0 |
function ms_ioinstallstdinfrombuffer() {} | Installs a mapserver IO handler directing future stdin reading
(ie. post request capture) to come from a buffer.
@return void | ms_ioinstallstdinfrombuffer | php | JetBrains/phpstorm-stubs | mapscript/mapscript.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mapscript/mapscript.php | Apache-2.0 |
function ms_ioinstallstdouttobuffer() {} | Installs a mapserver IO handler directing future stdout output
to a memory buffer.
@return void | ms_ioinstallstdouttobuffer | php | JetBrains/phpstorm-stubs | mapscript/mapscript.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mapscript/mapscript.php | Apache-2.0 |
function ms_ioresethandlers() {} | Resets the default stdin and stdout handlers in place of "buffer"
based handlers.
@return void | ms_ioresethandlers | php | JetBrains/phpstorm-stubs | mapscript/mapscript.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mapscript/mapscript.php | Apache-2.0 |
function ms_iostripstdoutbuffercontenttype() {} | Strip the Content-type header off the stdout buffer if it has one,
and if a content type is found it is return. Otherwise return
false.
@return string | ms_iostripstdoutbuffercontenttype | php | JetBrains/phpstorm-stubs | mapscript/mapscript.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mapscript/mapscript.php | Apache-2.0 |
function ms_iostripstdoutbuffercontentheaders() {} | Strip all the Content-* headers off the stdout buffer if it has
some.
@return void | ms_iostripstdoutbuffercontentheaders | php | JetBrains/phpstorm-stubs | mapscript/mapscript.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mapscript/mapscript.php | Apache-2.0 |
function ms_TokenizeMap($map_file_name) {} | Preparses a mapfile through the MapServer parser and return an
array with one item for each token from the mapfile. Strings,
logical expressions, regex expressions and comments are returned
as individual tokens.
@param string $map_file_name
@return array | ms_TokenizeMap | php | JetBrains/phpstorm-stubs | mapscript/mapscript.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mapscript/mapscript.php | Apache-2.0 |
function ms_GetErrorObj() {} | Returns a reference to the head of the list of errorObj.
@return errorObj | ms_GetErrorObj | php | JetBrains/phpstorm-stubs | mapscript/mapscript.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mapscript/mapscript.php | Apache-2.0 |
function ms_ResetErrorList() {} | Clear the current error list.
Note that clearing the list invalidates any errorObj handles obtained
via the $error->next() method.
@return void | ms_ResetErrorList | php | JetBrains/phpstorm-stubs | mapscript/mapscript.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/mapscript/mapscript.php | Apache-2.0 |
function apc_cache_info($type = '', $limited = false) {} | Retrieves cached information and meta-data from APC's data store
@link https://php.net/manual/en/function.apc-cache-info.php
@param string $type If cache_type is "user", information about the user cache will be returned.
If cache_type is "filehits", information about which files have been served from the bytecode
cache for the current request will be returned. This feature must be enabled at compile time
using --enable-filehits. If an invalid or no cache_type is specified, information about the
system cache (cached files) will be returned.
@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. | apc_cache_info | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apc_sma_info($limited = false) {} | Retrieves APC's Shared Memory Allocation information
@link https://php.net/manual/en/function.apc-sma-info.php
@param bool $limited When set to FALSE (default) apc_sma_info() will
return a detailed information about each segment.
@return array|false Array of Shared Memory Allocation data; FALSE on failure. | apc_sma_info | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apc_store($key, $var, $ttl = 0) {} | Cache a variable in the data store
@link https://php.net/manual/en/function.apc-store.php
@param string|array $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. | apc_store | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apc_fetch($key, &$success = null) {} | Fetch a stored variable from the cache
@link https://php.net/manual/en/function.apc-fetch.php
@param string|string[] $key The key used to store the value (with apc_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. | apc_fetch | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apc_delete($key) {} | Removes a stored variable from the cache
@link https://php.net/manual/en/function.apc-delete.php
@param string|string[]|APCIterator $key The key used to store the value (with apc_store()).
@return bool|string[] Returns TRUE on success or FALSE on failure. For array of keys returns list of failed keys. | apc_delete | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apc_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.apc-add.php
@param string $key Store the variable using this name. Keys are cache-unique,
so attempting to use apc_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 apc_add() and apc_store().)
@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 | apc_add | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apc_compile_file($filename, $atomic = true) {} | Stores a file in the bytecode cache, bypassing all filters
@link https://php.net/manual/en/function.apc-compile-file.php
@param string|string[] $filename Full or relative path to a PHP file that will be
compiled and stored in the bytecode cache.
@param bool $atomic
@return bool Returns TRUE on success or FALSE on failure. | apc_compile_file | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apc_exists($keys) {} | Checks if APC key exists
@link https://php.net/manual/en/function.apc-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. | apc_exists | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apc_delete_file($keys) {} | Deletes the given files from the opcode cache
Accepts a string, array of strings, or APCIterator object.
Returns True/False, or for an Array an Array of failed files.
@link https://php.net/manual/en/function.apc-delete-file.php
@param string|string[]|APCIterator $keys
@return bool|string[] | apc_delete_file | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apc_cas($key, $old, $new) {} | Updates an old value with a new value
@link https://php.net/manual/en/function.apc-cas.php
@param string $key
@param int $old
@param int $new
@return bool | apc_cas | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apc_bin_dump($files = null, $user_vars = null) {} | Returns a binary dump of the given files and user variables from the APC cache
A NULL for files or user_vars signals a dump of every entry, while array() will dump nothing.
@link https://php.net/manual/en/function.apc-bin-dump.php
@param string[]|null $files The files. Passing in NULL signals a dump of every entry, while passing in array() will dump nothing.
@param string[]|null $user_vars The user vars. Passing in NULL signals a dump of every entry, while passing in array() will dump nothing.
@return string|false|null Returns a binary dump of the given files and user variables from the APC cache, FALSE if APC is not enabled, or NULL if an unknown error is encountered. | apc_bin_dump | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apc_bin_dumpfile($files, $user_vars, $filename, $flags = 0, $context = null) {} | Output a binary dump of the given files and user variables from the APC cache to the named file
@link https://php.net/manual/en/function.apc-bin-dumpfile.php
@param string[]|null $files The file names being dumped.
@param string[]|null $user_vars The user variables being dumped.
@param string $filename The filename where the dump is being saved.
@param int $flags Flags passed to the filename stream. See the file_put_contents() documentation for details.
@param resource $context The context passed to the filename stream. See the file_put_contents() documentation for details.
@return int|false The number of bytes written to the file, otherwise FALSE if APC
is not enabled, filename is an invalid file name, filename can't be opened,
the file dump can't be completed (e.g., the hard drive is out of disk space),
or an unknown error was encountered. | apc_bin_dumpfile | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apc_bin_load($data, $flags = 0) {} | Load the given binary dump into the APC file/user cache
@link https://php.net/manual/en/function.apc-bin-load.php
@param string $data The binary dump being loaded, likely from apc_bin_dump().
@param int $flags Either APC_BIN_VERIFY_CRC32, APC_BIN_VERIFY_MD5, or both.
@return bool Returns TRUE if the binary dump data was loaded with success, otherwise FALSE is returned.
FALSE is returned if APC is not enabled, or if the data is not a valid APC binary dump (e.g., unexpected size). | apc_bin_load | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
function apc_bin_loadfile($filename, $context = null, $flags = 0) {} | Load the given binary dump from the named file into the APC file/user cache
@link https://php.net/manual/en/function.apc-bin-loadfile.php
@param string $filename The file name containing the dump, likely from apc_bin_dumpfile().
@param resource $context The files context.
@param int $flags Either APC_BIN_VERIFY_CRC32, APC_BIN_VERIFY_MD5, or both.
@return bool Returns TRUE on success, otherwise FALSE Reasons it may return FALSE include APC
is not enabled, filename is an invalid file name or empty, filename can't be opened,
the file dump can't be completed, or if the data is not a valid APC binary dump (e.g., unexpected size). | apc_bin_loadfile | php | JetBrains/phpstorm-stubs | apcu/apcu.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/apcu/apcu.php | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.