dépôts
/
lhc
/
web
/
wiklou.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Improve normalizePageName documentation
[lhc/web/wiklou.git]
/
includes
/
site
/
MediaWikiSite.php
diff --git
a/includes/site/MediaWikiSite.php
b/includes/site/MediaWikiSite.php
index
6734d5f
..
e1e7ce6
100644
(file)
--- a/
includes/site/MediaWikiSite.php
+++ b/
includes/site/MediaWikiSite.php
@@
-40,8
+40,6
@@
class MediaWikiSite extends Site {
const PATH_PAGE = 'page_path';
/**
const PATH_PAGE = 'page_path';
/**
- * Constructor.
- *
* @since 1.21
*
* @param string $type
* @since 1.21
*
* @param string $type
@@
-66,7
+64,8
@@
class MediaWikiSite extends Site {
/**
* Returns the normalized form of the given page title, using the
* normalization rules of the given site. If the given title is a redirect,
/**
* Returns the normalized form of the given page title, using the
* normalization rules of the given site. If the given title is a redirect,
- * the redirect weill be resolved and the redirect target is returned.
+ * the redirect will be resolved and the redirect target is returned.
+ * Only titles of existing pages will be returned.
*
* @note This actually makes an API request to the remote site, so beware
* that this function is slow and depends on an external service.
*
* @note This actually makes an API request to the remote site, so beware
* that this function is slow and depends on an external service.
@@
-81,7
+80,9
@@
class MediaWikiSite extends Site {
*
* @param string $pageName
*
*
* @param string $pageName
*
- * @return string
+ * @return string|false The normalized form of the title,
+ * or false to indicate an invalid title, a missing page,
+ * or some other kind of error.
* @throws MWException
*/
public function normalizePageName( $pageName ) {
* @throws MWException
*/
public function normalizePageName( $pageName ) {