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 |
|---|---|---|---|---|---|---|---|
function ssh2_sftp($session) {} | (PECL ssh2 >= 0.9.0)<br/>
Initialize SFTP subsystem
@link https://php.net/manual/en/function.ssh2-sftp.php
@param resource $session <p>
An SSH connection link identifier, obtained from a call to
ssh2_connect.
</p>
@return resource|false This method returns an SSH2 SFTP resource for use with
all other ssh2_sftp_*() methods and the
ssh2.sftp:// fopen wrapper. | ssh2_sftp | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
function ssh2_sftp_rename($sftp, $from, $to) {} | (PECL ssh2 >= 0.9.0)<br/>
Rename a remote file
@link https://php.net/manual/en/function.ssh2-sftp-rename.php
@param resource $sftp <p>
An SSH2 SFTP resource opened by ssh2_sftp.
</p>
@param string $from <p>
The current file that is being renamed.
</p>
@param string $to <p>
The new file name that replaces from.
</p>
@return bool true on success or false on failure. | ssh2_sftp_rename | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
function ssh2_sftp_unlink($sftp, $filename) {} | (PECL ssh2 >= 0.9.0)<br/>
Delete a file
@link https://php.net/manual/en/function.ssh2-sftp-unlink.php
@param resource $sftp <p>
An SSH2 SFTP resource opened by ssh2_sftp.
</p>
@param string $filename <p>
</p>
@return bool true on success or false on failure. | ssh2_sftp_unlink | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
function ssh2_sftp_mkdir($sftp, $dirname, $mode = null, $recursive = null) {} | (PECL ssh2 >= 0.9.0)<br/>
Create a directory
@link https://php.net/manual/en/function.ssh2-sftp-mkdir.php
@param resource $sftp <p>
An SSH2 SFTP resource opened by ssh2_sftp.
</p>
@param string $dirname <p>
Path of the new directory.
</p>
@param int $mode [optional] <p>
Permissions on the new directory.
</p>
@param bool $recursive [optional] <p>
If recursive is true any parent directories
required for dirname will be automatically created as well.
</p>
@return bool true on success or false on failure. | ssh2_sftp_mkdir | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
function ssh2_sftp_rmdir($sftp, $dirname) {} | (PECL ssh2 >= 0.9.0)<br/>
Remove a directory
@link https://php.net/manual/en/function.ssh2-sftp-rmdir.php
@param resource $sftp <p>
An SSH2 SFTP resource opened by ssh2_sftp.
</p>
@param string $dirname <p>
</p>
@return bool true on success or false on failure. | ssh2_sftp_rmdir | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
function ssh2_sftp_stat($sftp, $path) {} | (PECL ssh2 >= 0.9.0)<br/>
Stat a file on a remote filesystem
@link https://php.net/manual/en/function.ssh2-sftp-stat.php
@param resource $sftp <p>
An SSH2 SFTP resource opened by ssh2_sftp.
</p>
@param string $path <p>
</p>
@return array|false See the documentation for stat for details on the
values which may be returned. | ssh2_sftp_stat | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
function ssh2_sftp_lstat($sftp, $path) {} | (PECL ssh2 >= 0.9.0)<br/>
Stat a symbolic link
@link https://php.net/manual/en/function.ssh2-sftp-lstat.php
@param resource $sftp <p>
</p>
@param string $path <p>
Path to the remote symbolic link.
</p>
@return array See the documentation for stat for details on the
values which may be returned. | ssh2_sftp_lstat | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
function ssh2_sftp_symlink($sftp, $target, $link) {} | (PECL ssh2 >= 0.9.0)<br/>
Create a symlink
@link https://php.net/manual/en/function.ssh2-sftp-symlink.php
@param resource $sftp <p>
An SSH2 SFTP resource opened by ssh2_sftp.
</p>
@param string $target <p>
Target of the symbolic link.
</p>
@param string $link <p>
</p>
@return bool true on success or false on failure. | ssh2_sftp_symlink | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
function ssh2_sftp_readlink($sftp, $link) {} | (PECL ssh2 >= 0.9.0)<br/>
Return the target of a symbolic link
@link https://php.net/manual/en/function.ssh2-sftp-readlink.php
@param resource $sftp <p>
An SSH2 SFTP resource opened by ssh2_sftp.
</p>
@param string $link <p>
Path of the symbolic link.
</p>
@return string the target of the symbolic link. | ssh2_sftp_readlink | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
function ssh2_sftp_realpath($sftp, $filename) {} | (PECL ssh2 >= 0.9.0)<br/>
Resolve the realpath of a provided path string
@link https://php.net/manual/en/function.ssh2-sftp-realpath.php
@param resource $sftp <p>
An SSH2 SFTP resource opened by ssh2_sftp.
</p>
@param string $filename <p>
</p>
@return string the real path as a string. | ssh2_sftp_realpath | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
function ssh2_publickey_init($session) {} | (PECL ssh2 >= 0.10)<br/>
Initialize Publickey subsystem
@link https://php.net/manual/en/function.ssh2-publickey-init.php
@param resource $session <p>
</p>
@return resource|false an SSH2 Publickey Subsystem resource for use
with all other ssh2_publickey_*() methods or false on failure. | ssh2_publickey_init | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
function ssh2_publickey_add($pkey, $algoname, $blob, $overwrite = null, ?array $attributes = null) {} | (PECL ssh2 >= 0.10)<br/>
Add an authorized publickey
@link https://php.net/manual/en/function.ssh2-publickey-add.php
@param resource $pkey <p>
Publickey Subsystem resource created by ssh2_publickey_init.
</p>
@param string $algoname <p>
Publickey algorithm (e.g.): ssh-dss, ssh-rsa
</p>
@param string $blob <p>
Publickey blob as raw binary data
</p>
@param null|bool $overwrite [optional] <p>
If the specified key already exists, should it be overwritten?
</p>
@param null|array $attributes [optional] <p>
Associative array of attributes to assign to this public key.
Refer to ietf-secsh-publickey-subsystem for a list of supported attributes.
To mark an attribute as mandatory, precede its name with an asterisk.
If the server is unable to support an attribute marked mandatory,
it will abort the add process.
</p>
@return bool true on success or false on failure. | ssh2_publickey_add | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
function ssh2_publickey_remove($pkey, $algoname, $blob) {} | (PECL ssh2 >= 0.10)<br/>
Remove an authorized publickey
@link https://php.net/manual/en/function.ssh2-publickey-remove.php
@param resource $pkey <p>
Publickey Subsystem Resource
</p>
@param string $algoname <p>
Publickey algorithm (e.g.): ssh-dss, ssh-rsa
</p>
@param string $blob <p>
Publickey blob as raw binary data
</p>
@return bool true on success or false on failure. | ssh2_publickey_remove | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
function ssh2_publickey_list($pkey) {} | (PECL ssh2 >= 0.10)<br/>
List currently authorized publickeys
@link https://php.net/manual/en/function.ssh2-publickey-list.php
@param resource $pkey <p>
Publickey Subsystem resource
</p>
@return array a numerically indexed array of keys,
each of which is an associative array containing:
name, blob, and attrs elements.
</p>
<p>
<table>
Publickey elements
<tr valign="top">
<td>Array Key</td>
<td>Meaning</td>
</tr>
<tr valign="top">
<td>name</td>
<td>Name of algorithm used by this publickey, for example:
ssh-dss or ssh-rsa.</td>
</tr>
<tr valign="top">
<td>blob</td>
<td>Publickey blob as raw binary data.</td>
</tr>
<tr valign="top">
<td>attrs</td>
<td>Attributes assigned to this publickey. The most common
attribute, and the only one supported by publickey version 1
servers, is comment, which may be any freeform
string.</td>
</tr>
</table> | ssh2_publickey_list | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
function ssh2_sftp_chmod($sftp, $filename, $mode) {} | (PECL ssh2 >= 0.12)<br/>
ssh2_sftp_chmod — Changes file mode
@link https://php.net/manual/en/function.ssh2-sftp-chmod.php
@param resource $sftp <p>An SSH2 SFTP resource opened by ssh2_sftp().</p>
@param string $filename <p>Path to the file.</p>
@param int $mode <p>Permissions on the file. See the chmod() for more details on this parameter.</p>
@return bool <p>Returns TRUE on success or FALSE on failure.</p> | ssh2_sftp_chmod | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
function ssh2_auth_agent($session, $username) {} | (PECL ssh2 >= 0.12)<br/>
ssh2_auth_agent — Authenticate over SSH using the ssh agent
@link https://php.net/manual/en/function.ssh2-auth-agent.php
<p>
Authenticate over SSH using the ssh agent
</p>
<p>
Note: The ssh2_auth_agent() function will only be available when the ssh2 extension is compiled with libssh >= 1.2.3.
</p>
@param resource $session <p>An SSH connection link identifier, obtained from a call to ssh2_connect().</p>
@param string $username <p>Remote user name.</p>
@return bool <p>Returns TRUE on success or FALSE on failure.</p> | ssh2_auth_agent | php | JetBrains/phpstorm-stubs | ssh2/ssh2.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/ssh2/ssh2.php | Apache-2.0 |
public function addDocument(SolrInputDocument $doc, $overwrite = true, $commitWithin = 0) {} | (PECL solr >= 0.9.2)<br/>
Adds a document to the index
@link https://php.net/manual/en/solrclient.adddocument.php
@param SolrInputDocument $doc <p>
The SolrInputDocument instance.
</p>
@param bool $overwrite [optional] <p>
Whether to overwrite existing document or not. If <b>FALSE</b> there will be duplicates (several documents with
the same ID).
</p>
<div>
<b>Warning</b><br/>
PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite
bool flag.<br/>
<br/>
$allowDups = false is the same as $overwrite = true
</div>
@param int $commitWithin [optional] <p>
Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means
disabled.
</p>
<p>
When this value specified, it leaves the control of when to do the commit to Solr itself, optimizing number of
commits to a minimum while still fulfilling the update latency requirements, and Solr will automatically do a
commit when the oldest add in the buffer is due.
</p>
@return SolrUpdateResponse <p>
Returns a SolrUpdateResponse object or throws an Exception on failure.
</p>
@throws SolrClientException <p>
Throws SolrClientException if the client had failed, or there was a connection issue.
</p>
@throws SolrServerException <p>
Throws SolrServerException if the Solr Server had failed to satisfy the request.
</p> | addDocument | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function addDocuments(array $docs, $overwrite = true, $commitWithin = 0) {} | (PECL solr >= 0.9.2)<br/>
Adds a collection of SolrInputDocument instances to the index
@link https://php.net/manual/en/solrclient.adddocuments.php
@param array $docs <p>
An array containing the collection of SolrInputDocument instances. This array must be an actual variable.
</p>
@param bool $overwrite [optional] <p>
Whether to overwrite existing document or not. If <b>FALSE</b> there will be duplicates (several documents with
the same ID).
</p>
<div>
<b>Warning</b><br/>
PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite
bool flag.<br/>
<br/>
$allowDups = false is the same as $overwrite = true
</div>
@param int $commitWithin [optional] <p>
Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means
disabled.
</p>
<p>
When this value specified, it leaves the control of when to do the commit to Solr itself, optimizing number of
commits to a minimum while still fulfilling the update latency requirements, and Solr will automatically do a
commit when the oldest add in the buffer is due.
</p>
@return SolrUpdateResponse <p>
Returns a SolrUpdateResponse object or throws an Exception on failure.
</p>
@throws SolrClientException <p>
Throws SolrClientException if the client had failed, or there was a connection issue.
</p>
@throws SolrServerException <p>
Throws SolrServerException if the Solr Server had failed to satisfy the request.
</p> | addDocuments | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function commit($softCommit = false, $waitSearcher = true, $expungeDeletes = false) {} | (PECL solr >= 0.9.2)<br/>
Finalizes all add/deletes made to the index
@link https://php.net/manual/en/solrclient.commit.php
@param bool $softCommit [optional] <p>
This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees.
(Solr4.0+)
</p>
<p>
A soft commit is much faster since it only makes index changes visible and does not fsync index files or write a
new index descriptor. If the JVM crashes or there is a loss of power, changes that occurred after the last hard
commit will be lost. Search collections that have near-real-time requirements (that want index changes to be
quickly visible to searches) will want to soft commit often but hard commit less frequently.
</p>
@param bool $waitSearcher [optional] <p>
block until a new searcher is opened and registered as the main query searcher, making the changes visible.
</p>
@param bool $expungeDeletes [optional] <p>
Merge segments with deletes away. (Solr1.4+)
</p>
@return SolrUpdateResponse <p>
Returns a SolrUpdateResponse object or throws an Exception on failure.
</p>
@throws SolrClientException <p>
Throws SolrClientException if the client had failed, or there was a connection issue.
</p>
@throws SolrServerException <p>
Throws SolrServerException if the Solr Server had failed to satisfy the request.
</p> | commit | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function __construct(array $clientOptions) {} | (PECL solr >= 0.9.2)<br/>
SolrClient constructor.
@link https://php.net/manual/en/solrclient.construct.php
@param array $clientOptions <p>
This is an array containing one of the following keys :
</p>
<ul>
<li><b>secure</b>: (Boolean value indicating whether or not to connect in secure mode)</li>
<li><b>hostname</b>: (The hostname for the Solr server)</li>
<li><b>port</b>: (The port number)</li>
<li><b>path</b>: (The path to solr)</li>
<li><b>wt</b>: (The name of the response writer e.g. xml, json)</li>
<li><b>login</b>: (The username used for HTTP Authentication, if any)</li>
<li><b>password</b>: (The HTTP Authentication password)</li>
<li><b>proxy_host</b>: (The hostname for the proxy server, if any)</li>
<li><b>proxy_port</b>: (The proxy port)</li>
<li><b>proxy_login</b>: (The proxy username)</li>
<li><b>proxy_password</b>: (The proxy password)</li>
<li><b>timeout</b>: (This is maximum time in seconds allowed for the http data transfer operation. Default is 30
seconds)</li>
<li><b>ssl_cert</b>: (File name to a PEM-formatted file containing the private key + private certificate
(concatenated in that order) )</li>
<li><b>ssl_key</b>: (File name to a PEM-formatted private key file only)</li>
<li><b>ssl_keypassword</b>: (Password for private key)</li>
<li><b>ssl_cainfo</b>: (Name of file holding one or more CA certificates to verify peer with)</li>
<li><b>ssl_capath</b>: (Name of directory holding multiple CA certificates to verify peer with )</li>
</ul>
<p>
Please note the if the ssl_cert file only contains the private certificate, you have to specify a separate
ssl_key file.
</p>
<p>
The ssl_keypassword option is required if the ssl_cert or ssl_key options are set.
</p>
@throws SolrIllegalArgumentException | __construct | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function deleteById($id) {} | (PECL solr >= 0.9.2)<br/>
Delete by Id
@link https://php.net/manual/en/solrclient.deletebyid.php
@param string $id <p>
The value of the uniqueKey field declared in the schema
</p>
@return SolrUpdateResponse <p>
Returns a SolrUpdateResponse on success and throws an exception on failure.
</p>
@throws SolrClientException <p>
Throws SolrClientException if the client had failed, or there was a connection issue.
</p>
@throws SolrServerException <p>
Throws SolrServerException if the Solr Server had failed to satisfy the request.
</p> | deleteById | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function deleteByIds(array $ids) {} | (PECL solr >= 0.9.2)<br/>
Deletes by Ids
@link https://php.net/manual/en/solrclient.deletebyids.php
@param array $ids <p>
An array of IDs representing the uniqueKey field declared in the schema for each document to be deleted. This
must be an actual php variable.
</p>
@return SolrUpdateResponse <p>
Returns a SolrUpdateResponse on success and throws an exception on failure.
</p>
@throws SolrClientException <p>
Throws SolrClientException if the client had failed, or there was a connection issue.
</p>
@throws SolrServerException <p>
Throws SolrServerException if the Solr Server had failed to satisfy the request.
</p> | deleteByIds | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function deleteByQueries(array $queries) {} | (PECL solr >= 0.9.2)<br/>
Removes all documents matching any of the queries
@link https://php.net/manual/en/solrclient.deletebyqueries.php
@param array $queries <p>
The array of queries. This must be an actual php variable.
</p>
@return SolrUpdateResponse <p>
Returns a SolrUpdateResponse on success and throws an exception on failure.
</p>
@throws SolrClientException <p>
Throws SolrClientException if the client had failed, or there was a connection issue.
</p>
@throws SolrServerException <p>
Throws SolrServerException if the Solr Server had failed to satisfy the request.
</p> | deleteByQueries | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function deleteByQuery($query) {} | (PECL solr >= 0.9.2)<br/>
Deletes all documents matching the given query
@link https://php.net/manual/en/solrclient.deletebyquery.php
@param string $query <p>
The query
</p>
@return SolrUpdateResponse <p>
Returns a SolrUpdateResponse on success and throws an exception on failure.
</p>
@throws SolrClientException <p>
Throws SolrClientException if the client had failed, or there was a connection issue.
</p>
@throws SolrServerException <p>
Throws SolrServerException if the Solr Server had failed to satisfy the request.
</p> | deleteByQuery | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function __destruct() {} | (PECL solr >= 0.9.2)<br/>
Destructor for SolrClient
@link https://php.net/manual/en/solrclient.destruct.php | __destruct | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function getById($id) {} | (PECL solr >= 2.2.0)<br/>
Get Document By Id. Utilizes Solr Realtime Get (RTG).
@link https://php.net/manual/en/solrclient.getbyid.php
@param string $id <p>
Document ID
</p>
@return SolrQueryResponse | getById | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function getByIds(array $ids) {} | (PECL solr >= 2.2.0)<br/>
Get Documents by their Ids. Utilizes Solr Realtime Get (RTG).
@link https://php.net/manual/en/solrclient.getbyids.php
@param array $ids <p>
Document ids
</p>
@return SolrQueryResponse | getByIds | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function getDebug() {} | (PECL solr >= 0.9.7)<br/>
Returns the debug data for the last connection attempt
@link https://php.net/manual/en/solrclient.getdebug.php
@return string <p>
Returns a string on success and null if there is nothing to return.
</p> | getDebug | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function getOptions() {} | (PECL solr >= 0.9.6)<br/>
Returns the client options set internally
@link https://php.net/manual/en/solrclient.getoptions.php
@return array <p>
Returns an array containing all the options for the SolrClient object set internally.
</p> | getOptions | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function optimize($maxSegments = 1, $softCommit = true, $waitSearcher = true) {} | (PECL solr >= 0.9.2)<br/>
Defragments the index
@link https://php.net/manual/en/solrclient.optimize.php
@param int $maxSegments <p>
Optimizes down to at most this number of segments. Since Solr 1.3
</p>
@param bool $softCommit <p>
This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees.
(Solr4.0+)
</p>
@param bool $waitSearcher <p>
Block until a new searcher is opened and registered as the main query searcher, making the changes visible.
</p>
@return SolrUpdateResponse <p>
Returns a SolrUpdateResponse on success and throws an exception on failure.
</p>
@throws SolrClientException <p>
Throws SolrClientException if the client had failed, or there was a connection issue.
</p>
@throws SolrServerException <p>
Throws SolrServerException if the Solr Server had failed to satisfy the request.
</p> | optimize | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function ping() {} | (PECL solr >= 0.9.2)<br/>
Checks if Solr server is still up
@link https://php.net/manual/en/solrclient.ping.php
@return SolrPingResponse <p>
Returns a SolrPingResponse object on success and throws an exception on failure.
</p>
@throws SolrClientException <p>
Throws SolrClientException if the client had failed, or there was a connection issue.
</p>
@throws SolrServerException <p>
Throws SolrServerException if the Solr Server had failed to satisfy the request.
</p> | ping | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function query(SolrParams $query) {} | (PECL solr >= 0.9.2)<br/>
Sends a query to the server
@link https://php.net/manual/en/solrclient.query.php
@param SolrParams $query <p>
A SolrParams object. It is recommended to use SolrQuery for advanced queries.
</p>
@return SolrQueryResponse <p>
Returns a SolrUpdateResponse on success and throws an exception on failure.
</p>
@throws SolrClientException <p>
Throws SolrClientException if the client had failed, or there was a connection issue.
</p>
@throws SolrServerException <p>
Throws SolrServerException if the Solr Server had failed to satisfy the request.
</p> | query | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function request($raw_request) {} | (PECL solr >= 0.9.2)<br/>
Sends a raw update request
@link https://php.net/manual/en/solrclient.request.php
@param string $raw_request <p>
An XML string with the raw request to the server.
</p>
@return SolrUpdateResponse <p>
Returns a SolrUpdateResponse on success and throws an exception on failure.
</p>
@throws SolrIllegalArgumentException <p>
Throws SolrIllegalArgumentException if raw_request was an empty string.
</p>
@throws SolrClientException <p>
Throws SolrClientException if the client had failed, or there was a connection issue.
</p>
@throws SolrServerException <p>
Throws SolrServerException if the Solr Server had failed to satisfy the request.
</p> | request | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function rollback() {} | (PECL solr >= 0.9.2)<br/>
Rollbacks all add/deletes made to the index since the last commit
@link https://php.net/manual/en/solrclient.rollback.php
@return SolrUpdateResponse <p>
Returns a SolrUpdateResponse on success and throws an exception on failure.
</p>
@throws SolrClientException <p>
Throws SolrClientException if the client had failed, or there was a connection issue.
</p>
@throws SolrServerException <p>
Throws SolrServerException if the Solr Server had failed to satisfy the request.
</p> | rollback | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function setResponseWriter($responseWriter) {} | (PECL solr >= 0.9.11)<br/>
Sets the response writer used to prepare the response from Solr
@link https://php.net/manual/en/solrclient.setresponsewriter.php
@param string $responseWriter <p>
One of the following:
</p>
<ul>
<li>json</li>
<li>phps</li>
<li>xml</li>
</ul> | setResponseWriter | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function setServlet($type, $value) {} | (PECL solr >= 0.9.2)<br/>
Changes the specified servlet type to a new value
@link https://php.net/manual/en/solrclient.setservlet.php
@param int $type <p>
One of the following :
</p>
<ul>
<li>SolrClient::SEARCH_SERVLET_TYPE</li>
<li>SolrClient::UPDATE_SERVLET_TYPE</li>
<li>SolrClient::THREADS_SERVLET_TYPE</li>
<li>SolrClient::PING_SERVLET_TYPE</li>
<li>SolrClient::TERMS_SERVLET_TYPE</li>
</ul>
@param string $value <p>
The new value for the servlet
</p>
@return bool <p>
Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
</p> | setServlet | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function system() {} | (PECL solr >= 2.0.0)<br/>
Retrieve Solr Server information
@link https://php.net/manual/en/solrclient.system.php
@return SolrGenericResponse <p>
Returns a SolrGenericResponse object on success.
</p>
@throws SolrClientException <p>
Throws SolrClientException if the client had failed, or there was a connection issue.
</p>
@throws SolrServerException <p>
Throws SolrServerException if the Solr Server had failed to satisfy the request.
</p> | system | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
public function threads() {} | (PECL solr >= 0.9.2)<br/>
Checks the threads status
@link https://php.net/manual/en/solrclient.threads.php
@return SolrGenericResponse <p>
Returns a SolrGenericResponse object on success.
</p>
@throws SolrClientException <p>
Throws SolrClientException if the client had failed, or there was a connection issue.
</p>
@throws SolrServerException <p>
Throws SolrServerException if the Solr Server had failed to satisfy the request.
</p> | threads | php | JetBrains/phpstorm-stubs | solr/SolrClient.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/SolrClient.php | Apache-2.0 |
function solr_get_version() {} | (PECL solr >= 0.9.1)<br/>
Returns the current version of the Apache Solr extension
@link https://php.net/manual/en/function.solr-get-version.php
@return string|false <p>
It returns a string on success and <b>FALSE</b> on failure.
</p> | solr_get_version | php | JetBrains/phpstorm-stubs | solr/functions.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/functions.php | Apache-2.0 |
public static function digestXmlResponse($xmlresponse, $parse_mode = 0) {} | (PECL solr >= 0.9.2)<br/>
Parses an response XML string into a SolrObject
@link https://php.net/manual/en/solrutils.digestxmlresponse.php
@param string $xmlresponse <p>
The XML response string from the Solr server.
</p>
@param int $parse_mode [optional] <p>
Use SolrResponse::PARSE_SOLR_OBJ or SolrResponse::PARSE_SOLR_DOC
</p>
@return SolrObject <p>
Returns the SolrObject representing the XML response.
</p>
<p>
If the parse_mode parameter is set to SolrResponse::PARSE_SOLR_OBJ Solr documents will be parses as SolrObject instances.
</p>
<p>
If it is set to SolrResponse::PARSE_SOLR_DOC, they will be parsed as SolrDocument instances.
</p>
@throws SolrException | digestXmlResponse | php | JetBrains/phpstorm-stubs | solr/Utils/SolrUtils.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Utils/SolrUtils.php | Apache-2.0 |
public static function escapeQueryChars($str) {} | (PECL solr >= 0.9.2)<br/>
Escapes a lucene query string
@link https://php.net/manual/en/solrutils.escapequerychars.php
@param string $str <p>
This is the query string to be escaped.
</p>
@return string|false <p>
Returns the escaped string or <b>FALSE</b> on failure.
</p> | escapeQueryChars | php | JetBrains/phpstorm-stubs | solr/Utils/SolrUtils.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Utils/SolrUtils.php | Apache-2.0 |
public static function getSolrVersion() {} | (PECL solr >= 0.9.2)<br/>
Returns the current version of the Solr extension
@link https://php.net/manual/en/solrutils.getsolrversion.php
@return string <p>
The current version of the Apache Solr extension.
</p> | getSolrVersion | php | JetBrains/phpstorm-stubs | solr/Utils/SolrUtils.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Utils/SolrUtils.php | Apache-2.0 |
public static function queryPhrase($str) {} | (PECL solr >= 0.9.2)<br/>
Prepares a phrase from an unescaped lucene string
@link https://php.net/manual/en/solrutils.queryphrase.php
@param string $str <p>
The lucene phrase.
</p>
@return string <p>
Returns the phrase contained in double quotes.
</p> | queryPhrase | php | JetBrains/phpstorm-stubs | solr/Utils/SolrUtils.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Utils/SolrUtils.php | Apache-2.0 |
public function getPropertyNames() {} | (PECL solr >= 0.9.2)<br/>
Returns an array of all the names of the properties
@link https://php.net/manual/en/solrobject.getpropertynames.php
@return array <p>
Returns an array.
</p> | getPropertyNames | php | JetBrains/phpstorm-stubs | solr/Utils/SolrObject.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Utils/SolrObject.php | Apache-2.0 |
public function offsetExists($property_name) {} | (PECL solr >= 0.9.2)<br/>
Checks if the property exists
@link https://php.net/manual/en/solrobject.offsetexists.php
@param string $property_name <p>
The name of the property.
</p>
@return bool <p>
Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
</p> | offsetExists | php | JetBrains/phpstorm-stubs | solr/Utils/SolrObject.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Utils/SolrObject.php | Apache-2.0 |
public function offsetGet($property_name) {} | (PECL solr >= 0.9.2)<br/>
Used to retrieve a property
@link https://php.net/manual/en/solrobject.offsetget.php
@param string $property_name <p>
The name of the property.
</p>
@return SolrDocumentField <p>
Returns the property value.
</p> | offsetGet | php | JetBrains/phpstorm-stubs | solr/Utils/SolrObject.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Utils/SolrObject.php | Apache-2.0 |
public function offsetSet($property_name, $property_value) {} | (PECL solr >= 0.9.2)<br/>
Sets the value for a property
@link https://php.net/manual/en/solrobject.offsetset.php
@param string $property_name <p>
The name of the property.
</p>
@param string $property_value <p>
The new value.
</p> | offsetSet | php | JetBrains/phpstorm-stubs | solr/Utils/SolrObject.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Utils/SolrObject.php | Apache-2.0 |
public function offsetUnset($property_name) {} | (PECL solr >= 0.9.2)<br/>
Unsets the value for the property
@link https://php.net/manual/en/solrobject.offsetunset.php
@param string $property_name <p>
The name of the property.
</p>
@return bool | offsetUnset | php | JetBrains/phpstorm-stubs | solr/Utils/SolrObject.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Utils/SolrObject.php | Apache-2.0 |
public function add($name, $value) {} | (PECL solr >= 0.9.2)<br/>
This is an alias for SolrParams::addParam
@link https://php.net/manual/en/solrparams.add.php
@param string $name <p>
The name of the parameter
</p>
@param string $value <p>
The value of the parameter
</p>
@return SolrParams|false <p>
Returns a SolrParams instance on success and <b>FALSE</b> on failure.
</p> | add | php | JetBrains/phpstorm-stubs | solr/Queries/SolrParams.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrParams.php | Apache-2.0 |
public function addParam($name, $value) {} | (PECL solr >= 0.9.2)<br/>
Adds a parameter to the object
@link https://php.net/manual/en/solrparams.addparam.php
@param string $name <p>
The name of the parameter
</p>
@param string $value <p>
The value of the parameter
</p>
@return SolrParams|false <p>
Returns a SolrParams instance on success and <b>FALSE</b> on failure.
</p> | addParam | php | JetBrains/phpstorm-stubs | solr/Queries/SolrParams.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrParams.php | Apache-2.0 |
public function setParam($name, $value) {} | (PECL solr >= 0.9.2)<br/>
Sets the parameter to the specified value
@link https://php.net/manual/en/solrparams.setparam.php
@param string $name <p>
The name of the parameter
</p>
@param string $value <p>
The parameter value
</p>
@return SolrParams|false <p>
Returns a SolrParams instance on success and <b>FALSE</b> on failure.
</p> | setParam | php | JetBrains/phpstorm-stubs | solr/Queries/SolrParams.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrParams.php | Apache-2.0 |
public function addExpandFilterQuery($fq) {} | (PECL solr >= 2.2.0)<br/>
Overrides main filter query, determines which documents to include in the main group.
@link https://php.net/manual/en/solrquery.addexpandfilterquery.php
@param string $fq
@return SolrQuery <p>
Returns a SolrQuery object.
</p> | addExpandFilterQuery | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addExpandSortField($field, $order) {} | (PECL solr >= 2.2.0)<br/>
Orders the documents within the expanded groups (expand.sort parameter).
@link https://php.net/manual/en/solrquery.addexpandsortfield.php
@param string $field <p>
Field name
</p>
@param string $order [optional] <p>
Order ASC/DESC, utilizes SolrQuery::ORDER_* constants.
</p>
<p>
Default: SolrQuery::ORDER_DESC
</p>
@return SolrQuery <p>
Returns a SolrQuery object.
</p> | addExpandSortField | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addFacetDateField($dateField) {} | (PECL solr >= 0.9.2)<br/>
Maps to facet.date
@link https://php.net/manual/en/solrquery.addfacetdatefield.php
@param string $dateField <p>
The name of the date field.
</p>
@return SolrQuery <p>
Returns a SolrQuery object.
</p> | addFacetDateField | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addFacetDateOther($value, $field_override) {} | (PECL solr >= 0.9.2)<br/>
Adds another facet.date.other parameter
@link https://php.net/manual/en/solrquery.addfacetdateother.php
@param string $value <p>
The value to use.
</p>
@param string $field_override <p>
The field name for the override.
</p>
@return SolrQuery <p>
Returns the current SolrQuery object, if the return value is used.
</p> | addFacetDateOther | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addFacetField($field) {} | (PECL solr >= 0.9.2)<br/>
Adds another field to the facet
@link https://php.net/manual/en/solrquery.addfacetfield.php
@param string $field <p>
The name of the field
</p>
@return SolrQuery <p>
Returns the current SolrQuery object, if the return value is used.
</p> | addFacetField | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addFacetQuery($facetQuery) {} | (PECL solr >= 0.9.2)<br/>
Adds a facet query
@link https://php.net/manual/en/solrquery.addfacetquery.php
@param string $facetQuery <p>
The facet query
</p>
@return SolrQuery <p>
Returns the current SolrQuery object, if the return value is used.
</p> | addFacetQuery | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addField($field) {} | (PECL solr >= 0.9.2)<br/>
Specifies which fields to return in the result
@link https://php.net/manual/en/solrquery.addfield.php
@param string $field <p>
The name of the field
</p>
@return SolrQuery <p>
Returns a SolrQuery object.
</p> | addField | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addFilterQuery($fq) {} | (PECL solr >= 0.9.2)<br/>
Specifies a filter query
@link https://php.net/manual/en/solrquery.addfilterquery.php
@param string $fq <p>
The filter query
</p>
@return SolrQuery <p>
Returns a SolrQuery object.
</p> | addFilterQuery | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addGroupField($value) {} | (PECL solr >= 2.2.0)<br/>
Add a field to be used to group results.
@link https://php.net/manual/en/solrquery.addgroupfield.php
@param string $value
@return SolrQuery <p>
Returns a SolrQuery object.
</p> | addGroupField | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addGroupFunction($value) {} | (PECL solr >= 2.2.0)<br/>
Allows grouping results based on the unique values of a function query (group.func parameter).
@link https://php.net/manual/en/solrquery.addgroupfunction.php
@param string $value
@return SolrQuery <p>
Returns a SolrQuery object.
</p> | addGroupFunction | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addGroupQuery($value) {} | (PECL solr >= 2.2.0)<br/>
Allows grouping of documents that match the given query.
@link https://php.net/manual/en/solrquery.addgroupquery.php
@param string $value
@return SolrQuery <p>
Returns a SolrQuery object.
</p> | addGroupQuery | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addGroupSortField($field, $order) {} | (PECL solr >= 2.2.0)<br/>
Add a group sort field (group.sort parameter).
@link https://php.net/manual/en/solrquery.addgroupsortfield.php
@param string $field <p>
Field name
</p>
@param int $order <p>
Order ASC/DESC, utilizes SolrQuery::ORDER_* constants
</p>
@return SolrQuery <p>
Returns a SolrQuery object.
</p> | addGroupSortField | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addHighlightField($field) {} | (PECL solr >= 0.9.2)<br/>
Maps to hl.fl
@link https://php.net/manual/en/solrquery.addhighlightfield.php
@param string $field <p>
Name of the field
</p>
@return SolrQuery <p>
Returns the current SolrQuery object, if the return value is used.
</p> | addHighlightField | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addMltField($field) {} | (PECL solr >= 0.9.2)<br/>
Sets a field to use for similarity
@link https://php.net/manual/en/solrquery.addmltfield.php
@param string $field <p>
The name of the field
</p>
@return SolrQuery <p>
Returns the current SolrQuery object, if the return value is used.
</p> | addMltField | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addMltQueryField($field, $boost) {} | (PECL solr >= 0.9.2)<br/>
Maps to mlt.qf
@link https://php.net/manual/en/solrquery.addmltqueryfield.php
@param string $field <p>
The name of the field
</p>
@param float $boost <p>
Its boost value
</p>
@return SolrQuery <p>
Returns the current SolrQuery object, if the return value is used.
</p> | addMltQueryField | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addSortField($field, $order = SolrQuery::ORDER_DESC) {} | (PECL solr >= 0.9.2)<br/>
Used to control how the results should be sorted
@link https://php.net/manual/en/solrquery.addsortfield.php
@param string $field <p>
The name of the field
</p>
@param int $order <p>
The sort direction. This should be either SolrQuery::ORDER_ASC or SolrQuery::ORDER_DESC.
</p>
@return SolrQuery <p>
Returns a SolrQuery object.
</p> | addSortField | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addStatsFacet($field) {} | (PECL solr >= 0.9.2)<br/>
Requests a return of sub results for values within the given facet
@link https://php.net/manual/en/solrquery.addstatsfacet.php
@param string $field <p>
The name of the field
</p>
@return SolrQuery <p>
Returns the current SolrQuery object, if the return value is used.
</p> | addStatsFacet | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function addStatsField($field) {} | (PECL solr >= 0.9.2)<br/>
Maps to stats.field parameter
@link https://php.net/manual/en/solrquery.addstatsfield.php
@param string $field <p>
The name of the field
</p>
@return SolrQuery <p>
Returns the current SolrQuery object, if the return value is used.
</p> | addStatsField | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function collapse(SolrCollapseFunction $collapseFunction) {} | (No version information available, might only be in Git)<br/>
Collapses the result set to a single document per group
@link https://php.net/manual/en/solrquery.collapse.php
@param SolrCollapseFunction $collapseFunction
@return SolrQuery <p>
Returns a SolrQuery object.
</p> | collapse | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function __construct($q = '') {} | (PECL solr >= 0.9.2)<br/>
SolrQuery constructor.
@link https://php.net/manual/en/solrquery.construct.php
@param string $q <p>
Optional search query
</p> | __construct | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getExpand() {} | (PECL solr >= 2.2.0)<br/>
Returns true if group expanding is enabled
@link https://php.net/manual/en/solrquery.getexpand.php
@return bool <p>
Returns <b>TRUE</b> if group expanding is enabled
</p> | getExpand | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getExpandFilterQueries() {} | (PECL solr >= 2.2.0)<br/>
Returns the expand filter queries
@link https://php.net/manual/en/solrquery.getexpandfilterqueries.php
@return array <p>
Returns the expand filter queries
</p> | getExpandFilterQueries | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getExpandQuery() {} | (PECL solr >= 2.2.0)<br/>
Returns the expand query expand.q parameter
@link https://php.net/manual/en/solrquery.getexpandquery.php
@return array <p>
Returns the expand query expand.q parameter
</p> | getExpandQuery | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getExpandRows() {} | (PECL solr >= 2.2.0)<br/>
Returns The number of rows to display in each group (expand.rows)
@link https://php.net/manual/en/solrquery.getexpandrows.php
@return int <p>
Returns The number of rows to display in each group (expand.rows)
</p> | getExpandRows | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getExpandSortFields() {} | (PECL solr >= 2.2.0)<br/>
Returns an array of fields
@link https://php.net/manual/en/solrquery.getexpandsortfields.php
@return array <p>
Returns an array of fields
</p> | getExpandSortFields | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacet() {} | (PECL solr >= 0.9.2)<br/>
Returns the value of the facet parameter
@link https://php.net/manual/en/solrquery.getfacet.php
@return bool|null <p>
Returns a boolean on success and <b>NULL</b> if not set
</p> | getFacet | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacetDateEnd($field_override) {} | (PECL solr >= 0.9.2)<br/>
Returns the value for the facet.date.end parameter
@link https://php.net/manual/en/solrquery.getfacetdateend.php
@param string $field_override [optional] <p>
The name of the field
</p>
@return string|null <p>
Returns a string on success and <b>NULL</b> if not set
</p> | getFacetDateEnd | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacetDateFields() {} | (PECL solr >= 0.9.2)<br/>
Returns all the facet.date fields
@link https://php.net/manual/en/solrquery.getfacetdatefields.php
@return array|null <p>
Returns all the facet.date fields as an array or <b>NULL</b> if none was set
</p> | getFacetDateFields | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacetDateGap($field_override) {} | (PECL solr >= 0.9.2)<br/>
Returns the value of the facet.date.gap parameter
@link https://php.net/manual/en/solrquery.getfacetdategap.php
@param string $field_override [optional] <p>
The name of the field
</p>
@return string|null <p>
Returns a string on success and <b>NULL</b> if not set
</p> | getFacetDateGap | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacetDateHardEnd($field_override) {} | (PECL solr >= 0.9.2)<br/>
Returns the value of the facet.date.hardend parameter
@link https://php.net/manual/en/solrquery.getfacetdatehardend.php
@param string $field_override [optional] <p>
The name of the field
</p>
@return string|null <p>
Returns a string on success and <b>NULL</b> if not set
</p> | getFacetDateHardEnd | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacetDateOther($field_override) {} | (PECL solr >= 0.9.2)<br/>
Returns the value for the facet.date.other parameter
@link https://php.net/manual/en/solrquery.getfacetdatehardend.php
@param string $field_override [optional] <p>
The name of the field
</p>
@return array|null <p>
Returns an array on success and <b>NULL</b> if not set
</p> | getFacetDateOther | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacetDateStart($field_override) {} | (PECL solr >= 0.9.2)<br/>
Returns the lower bound for the first date range for all date faceting on this field
@link https://php.net/manual/en/solrquery.getfacetdatestart.php
@param string $field_override [optional] <p>
The name of the field
</p>
@return string|null <p>
Returns a string on success and <b>NULL</b> if not set
</p> | getFacetDateStart | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacetFields() {} | (PECL solr >= 0.9.2)<br/>
Returns all the facet fields
@link https://php.net/manual/en/solrquery.getfacetfields.php
@return array|null <p>
Returns an array of all the fields and <b>NULL</b> if none was set
</p> | getFacetFields | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacetLimit($field_override) {} | (PECL solr >= 0.9.2)<br/>
Returns the maximum number of constraint counts that should be returned for the facet fields
@link https://php.net/manual/en/solrquery.getfacetlimit.php
@param string $field_override [optional] <p>
The name of the field
</p>
@return int|null <p>
Returns an integer on success and <b>NULL</b> if not set
</p> | getFacetLimit | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacetMethod($field_override) {} | (PECL solr >= 0.9.2)<br/>
Returns the value of the facet.method parameter
@link https://php.net/manual/en/solrquery.getfacetmethod.php
@param string $field_override [optional] <p>
The name of the field
</p>
@return string|null <p>
Returns a string on success and <b>NULL</b> if not set
</p> | getFacetMethod | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacetMinCount($field_override) {} | (PECL solr >= 0.9.2)<br/>
Returns the minimum counts for facet fields should be included in the response
@link https://php.net/manual/en/solrquery.getfacetmincount.php
@param string $field_override [optional] <p>
The name of the field
</p>
@return int|null <p>
Returns an integer on success and <b>NULL</b> if not set
</p> | getFacetMinCount | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacetMissing($field_override) {} | (PECL solr >= 0.9.2)<br/>
Returns the current state of the facet.missing parameter
@link https://php.net/manual/en/solrquery.getfacetmissing.php
@param string $field_override [optional] <p>
The name of the field
</p>
@return string|null <p>
Returns a boolean on success and <b>NULL</b> if not set
</p> | getFacetMissing | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacetOffset($field_override) {} | (PECL solr >= 0.9.2)<br/>
Returns an offset into the list of constraints to be used for pagination
@link https://php.net/manual/en/solrquery.getfacetoffset.php
@param string $field_override [optional] <p>
The name of the field
</p>
@return int|null <p>
Returns an integer on success and <b>NULL</b> if not set
</p> | getFacetOffset | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacetPrefix($field_override) {} | (PECL solr >= 0.9.2)<br/>
Returns the facet prefix
@link https://php.net/manual/en/solrquery.getfacetprefix.php
@param string $field_override [optional] <p>
The name of the field
</p>
@return string|null <p>
Returns a string on success and <b>NULL</b> if not set
</p> | getFacetPrefix | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacetQueries() {} | (PECL solr >= 0.9.2)<br/>
Returns all the facet queries
@link https://php.net/manual/en/solrquery.getfacetqueries.php
@return string|null <p>
Returns an array on success and <b>NULL</b> if not set
</p> | getFacetQueries | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFacetSort($field_override) {} | (PECL solr >= 0.9.2)<br/>
Returns the facet sort type
@link https://php.net/manual/en/solrquery.getfacetsort.php
@param string $field_override [optional] <p>
The name of the field
</p>
@return int|null <p>
Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) on success or <b>NULL</b> if not
set.
</p> | getFacetSort | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFields() {} | (PECL solr >= 0.9.2)<br/>
Returns the list of fields that will be returned in the response
@link https://php.net/manual/en/solrquery.getfields.php
@return string|null <p>
Returns an array on success and <b>NULL</b> if not set
</p> | getFields | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getFilterQueries() {} | (PECL solr >= 0.9.2)<br/>
Returns an array of filter queries
@link https://php.net/manual/en/solrquery.getfilterqueries.php
@return string|null <p>
Returns an array on success and <b>NULL</b> if not set
</p> | getFilterQueries | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getGroup() {} | (PECL solr >= 2.2.0)<br/>
Returns true if grouping is enabled
https://secure.php.net/manual/en/solrquery.getgroup.php
@return bool <p>
Returns true if grouping is enabled
</p> | getGroup | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getGroupCachePercent() {} | (PECL solr >= 2.2.0)<br/>
Returns group cache percent value
@link https://php.net/manual/en/solrquery.getgroupcachepercent.php
@return int <p>
Returns group cache percent value
</p> | getGroupCachePercent | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getGroupFacet() {} | (PECL solr >= 2.2.0)<br/>
Returns the group.facet parameter value
@link https://php.net/manual/en/solrquery.getgroupfacet.php
@return bool <p>
Returns the group.facet parameter value
</p> | getGroupFacet | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getGroupFields() {} | (PECL solr >= 2.2.0)<br/>
Returns group fields (group.field parameter values)
@link https://php.net/manual/en/solrquery.getgroupfields.php
@return array <p>
Returns group fields (group.field parameter values)
</p> | getGroupFields | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getGroupFormat() {} | (PECL solr >= 2.2.0)<br/>
Returns the group.format value
@link https://php.net/manual/en/solrquery.getgroupformat.php
@return string <p>
Returns the group.format value
</p> | getGroupFormat | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
public function getGroupFunctions() {} | (PECL solr >= 2.2.0)<br/>
Returns group functions (group.func parameter values)
@link https://php.net/manual/en/solrquery.getgroupfunctions.php
@return array <p>
Returns group functions (group.func parameter values)
</p> | getGroupFunctions | php | JetBrains/phpstorm-stubs | solr/Queries/SolrQuery.php | https://github.com/JetBrains/phpstorm-stubs/blob/master/solr/Queries/SolrQuery.php | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.