MediaWiki REL1_37
SearchSuggestion.php
Go to the documentation of this file.
1<?php
2
29 private $text;
30
34 private $url;
35
40
47
51 private $score;
52
59 public function __construct( $score, $text = null, Title $suggestedTitle = null,
60 $suggestedTitleID = null ) {
61 $this->score = $score;
62 $this->text = $text;
63 if ( $suggestedTitle ) {
65 }
66 $this->suggestedTitleID = $suggestedTitleID;
67 }
68
73 public function getText() {
74 return $this->text;
75 }
76
82 public function setText( $text, $setTitle = true ) {
83 $this->text = $text;
84 if ( $setTitle && $text !== '' && $text !== null ) {
85 $this->setSuggestedTitle( Title::makeTitle( 0, $text ) );
86 }
87 }
88
94 public function getSuggestedTitle() {
95 return $this->suggestedTitle;
96 }
97
101 public function setSuggestedTitle( Title $title = null ) {
102 $this->suggestedTitle = $title;
103 if ( $title !== null ) {
104 $this->url = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
105 }
106 }
107
113 public function getSuggestedTitleID() {
114 return $this->suggestedTitleID;
115 }
116
120 public function setSuggestedTitleID( $suggestedTitleID = null ) {
121 $this->suggestedTitleID = $suggestedTitleID;
122 }
123
128 public function getScore() {
129 return $this->score;
130 }
131
136 public function setScore( $score ) {
137 $this->score = $score;
138 }
139
145 public function getURL() {
146 return $this->url;
147 }
148
153 public function setURL( $url ) {
154 $this->url = $url;
155 }
156
163 public static function fromTitle( $score, Title $title ) {
164 return new self( $score, $title->getPrefixedText(), $title, $title->getArticleID() );
165 }
166
174 public static function fromText( $score, $text ) {
175 $suggestion = new self( $score, $text );
176 if ( $text ) {
177 $suggestion->setSuggestedTitle( Title::newFromText( $text ) );
178 }
179 return $suggestion;
180 }
181
182}
const PROTO_CURRENT
Definition Defines.php:195
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
Search suggestion.
string $text
the suggestion
string $url
the suggestion URL
static fromText( $score, $text)
Create suggestion from text Will also create a title if text if not empty.
int null $suggestedTitleID
NOTE: even if suggestedTitle is a redirect suggestedTitleID is the ID of the target page.
getSuggestedTitleID()
Title ID in the case this suggestion is based on a title.
setSuggestedTitle(Title $title=null)
setText( $text, $setTitle=true)
Set the suggestion text.
setURL( $url)
Set the suggestion URL.
setSuggestedTitleID( $suggestedTitleID=null)
getSuggestedTitle()
Title object in the case this suggestion is based on a title.
setScore( $score)
Set the suggestion score.
getURL()
Suggestion URL, can be the link to the Title or maybe in the future a link to the search results for ...
__construct( $score, $text=null, Title $suggestedTitle=null, $suggestedTitleID=null)
Title null $suggestedTitle
float null $score
The suggestion score.
getScore()
Suggestion score.
getText()
The suggestion text.
static fromTitle( $score, Title $title)
Create suggestion from Title.
Represents a title within MediaWiki.
Definition Title.php:48