PISS - Solr Search
The plugin requires the PHP extension for Solr. Otherwise its installation will be refused.
Classes
Name | Description |
---|---|
SolrIndexer | This class provides the functionality to index articles. It is called via CEC. |
SolrSearcherAbstract | Abstract class that Searcher-Classes should extend. |
SolrSearcherSimple | This class extends SolrSearcherAbstract and performs a Solr search. It is used by the SolrSearchModule class. |
SolrSearchModule | This class implements basic behaviour for displaying search results. It can be called from a search result module. |
SolrException | Solr related exception. |
SolrWarning | Solr related warning. |
Instead of using SolrSearcherSimple and SolrSearchModule you can write your own classes that suit your needs.
Chains
Name | Description |
---|---|
Contenido.Action.con_saveart.AfterCall | handleStoringOfArticle, this function updating article in solr core |
Contenido.Content.AfterStore | handleStoringOfContentEntry, this function store article content |
Settings
Settings can be entered in the configuration panel of this plugins backend page which then will be stored as system settings.
Optionally they can also be given as (translatable) client settings which can especialy be usefull when there should be a single core for each client.
Area/Type | Name | Description | Default | Scope |
---|---|---|---|---|
navigation_searchform_top | search_result_idart | Â | 0 | SCGU |
searchable | idcats | Â | 1 | SCGU |
solr | secure | Boolean value indicating whether or not to connect in secure mode. | n/a | S |
solr | hostname | Required. The hostname for the Solr server. | n/a | S |
solr | port | Required. The port number. | n/a | S |
solr | path | Required. The path to solr. | n/a | S |
solr | wt | The name of the response writer e.g. xml, phpnative. | n/a | S |
solr | login | Required. The username used for HTTP Authentication, if any. | n/a | S |
solr | password | Required. The HTTP Authentication password. | n/a | S |
solr | proxy_host | The hostname for the proxy server, if any. | n/a | S |
solr | proxy_port | The proxy port. | n/a | S |
solr | proxy_login | The proxy username. | n/a | S |
solr | proxy_password | The proxy password. | n/a | S |
solr | timeout | This is maximum time in seconds allowed for the http data transfer operation. Default is 30 seconds. | n/a | S |
solr | ssl_cert | File name to a PEM-formatted file containing the private key + private certificate (concatenated in that order). Please note the if the ssl_cert file only contains the private certificate, you have to specify a separate ssl_key file. | n/a | S |
solr | ssl_key | File name to a PEM-formatted private key file only. | n/a | S |
solr | ssl_keypassword | Password for private key. The ssl_keypassword option is required if the ssl_cert or ssl_key options are set. | n/a | S |
solr | ssl_cainfo | Name of file holding one or more CA certificates to verify peer with. | n/a | S |
solr | ssl_capath | Name of directory holding multiple CA certificates to verify peer with. | n/a | S |
Features that might be implemented in the future:
Display core status
In order to display the core status a request like the following has to be send, as long as it cannot be done with the Solr extension:
<server>:8080/solr/admin/cores?action=STATUS
Reload a core
In order to display the core status a request like the following has to be send, as long as it cannot be done with the Solr extension:
<server>:8080/solr/admin/cores?action=RELOAD&core=contenido
Renaming cores
In order to rename a core a request like the following has to be send, as long as it cannot be done with the Solr extension:
<server>:8080/solr/admin/cores?action=RENAME&core=collection1&other=contenido