MediaWiki REL1_37
|
Search suggestion. More...
Public Member Functions | |
__construct ( $score, $text=null, Title $suggestedTitle=null, $suggestedTitleID=null) | |
getScore () | |
Suggestion score. | |
getSuggestedTitle () | |
Title object in the case this suggestion is based on a title. | |
getSuggestedTitleID () | |
Title ID in the case this suggestion is based on a title. | |
getText () | |
The suggestion text. | |
getURL () | |
Suggestion URL, can be the link to the Title or maybe in the future a link to the search results for this search suggestion. | |
setScore ( $score) | |
Set the suggestion score. | |
setSuggestedTitle (Title $title=null) | |
setSuggestedTitleID ( $suggestedTitleID=null) | |
setText ( $text, $setTitle=true) | |
Set the suggestion text. | |
setURL ( $url) | |
Set the suggestion URL. | |
Static Public Member Functions | |
static | fromText ( $score, $text) |
Create suggestion from text Will also create a title if text if not empty. | |
static | fromTitle ( $score, Title $title) |
Create suggestion from Title. | |
Private Attributes | |
float null | $score |
The suggestion score. | |
Title null | $suggestedTitle |
int null | $suggestedTitleID |
NOTE: even if suggestedTitle is a redirect suggestedTitleID is the ID of the target page. | |
string | $text |
the suggestion | |
string | $url |
the suggestion URL | |
Search suggestion.
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 A search suggestion
Definition at line 25 of file SearchSuggestion.php.
SearchSuggestion::__construct | ( | $score, | |
$text = null , |
|||
Title | $suggestedTitle = null , |
||
$suggestedTitleID = null |
|||
) |
float | $score | the suggestion score |
string | null | $text | the suggestion text |
Title | null | $suggestedTitle | the suggested title |
int | null | $suggestedTitleID | the suggested title ID |
Definition at line 59 of file SearchSuggestion.php.
References $score, $suggestedTitle, $suggestedTitleID, and setSuggestedTitle().
|
static |
Create suggestion from text Will also create a title if text if not empty.
float | $score | Suggestions score |
string | $text |
Definition at line 174 of file SearchSuggestion.php.
References $score.
|
static |
Create suggestion from Title.
float | $score | Suggestions score |
Title | $title |
Definition at line 163 of file SearchSuggestion.php.
SearchSuggestion::getScore | ( | ) |
Suggestion score.
Definition at line 128 of file SearchSuggestion.php.
Referenced by SearchSuggestionSet\append(), and SearchSuggestionSet\prepend().
SearchSuggestion::getSuggestedTitle | ( | ) |
Title object in the case this suggestion is based on a title.
May return null if the suggestion is not a Title.
Definition at line 94 of file SearchSuggestion.php.
Referenced by SearchEngine\extractTitles(), and SearchEngine\processCompletionResults().
SearchSuggestion::getSuggestedTitleID | ( | ) |
Title ID in the case this suggestion is based on a title.
May return null if the suggestion is not a Title.
Definition at line 113 of file SearchSuggestion.php.
Referenced by SearchSuggestionSet\append(), and SearchSuggestionSet\prepend().
SearchSuggestion::getText | ( | ) |
SearchSuggestion::getURL | ( | ) |
Suggestion URL, can be the link to the Title or maybe in the future a link to the search results for this search suggestion.
Definition at line 145 of file SearchSuggestion.php.
SearchSuggestion::setScore | ( | $score | ) |
Set the suggestion score.
float | $score |
Definition at line 136 of file SearchSuggestion.php.
References $score.
Referenced by SearchSuggestionSet\append(), and SearchSuggestionSet\prepend().
SearchSuggestion::setSuggestedTitle | ( | Title | $title = null | ) |
Title | null | $title |
Definition at line 101 of file SearchSuggestion.php.
References $title, PROTO_CURRENT, and wfExpandUrl().
Referenced by __construct(), and setText().
SearchSuggestion::setSuggestedTitleID | ( | $suggestedTitleID = null | ) |
int | null | $suggestedTitleID |
Definition at line 120 of file SearchSuggestion.php.
References $suggestedTitleID.
SearchSuggestion::setText | ( | $text, | |
$setTitle = true |
|||
) |
Set the suggestion text.
string | $text | |
bool | $setTitle | Should we also update the title? |
Definition at line 82 of file SearchSuggestion.php.
References setSuggestedTitle().
SearchSuggestion::setURL | ( | $url | ) |
|
private |
The suggestion score.
Definition at line 51 of file SearchSuggestion.php.
Referenced by __construct(), fromText(), fromTitle(), and setScore().
|
private |
Definition at line 39 of file SearchSuggestion.php.
Referenced by __construct().
|
private |
NOTE: even if suggestedTitle is a redirect suggestedTitleID is the ID of the target page.
the suggested title ID
Definition at line 46 of file SearchSuggestion.php.
Referenced by __construct(), and setSuggestedTitleID().
|
private |
the suggestion
Definition at line 29 of file SearchSuggestion.php.
|
private |
the suggestion URL
Definition at line 34 of file SearchSuggestion.php.