Dump stored CirrusSearch document for page. More...
Inheritance diagram for CirrusSearch\Api\QueryCirrusDoc:
Collaboration diagram for CirrusSearch\Api\QueryCirrusDoc:
Public Member Functions | |
| __construct (ApiQuery $query, $moduleName) | |
| execute () | |
| getAllowedParams () | |
Protected Member Functions | |
| getExamplesMessages () | |
Detailed Description
Dump stored CirrusSearch document for page.
This was primarily written for the integration tests, but may be useful elsewhere. This is functionally similar to web action=cirrusdump but available and discoverable over the API. Compared to cirrusdump this also takes pain to try and ensure if there is a related elastic document, even if its not in-sync with the sql database, we return it. Similarly if a document in elasticsearch should, but does not, match the requested page (perhaps a redirect has been created but not indexed yet) it will not be returned. In this way this tries to faithfully return the document in elasticsearch that represents the requested page.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html
Member Function Documentation
◆ getExamplesMessages()
|
protected |
- See also
- ApiBase::getExamplesMessages
- Returns
- array
The documentation for this class was generated from the following file:
- includes/Api/QueryCirrusDoc.php
