* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
- * @since 1.20
+ * @since 1.21
*
* @file
* @ingroup Site
*
- * @licence GNU GPL v2+
+ * @license GNU GPL v2+
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
interface Site {
/**
* Returns the global site identifier (ie enwiktionary).
*
- * @since 1.20
+ * @since 1.21
*
* @return string
*/
/**
* Sets the global site identifier (ie enwiktionary).
*
- * @since 1.20
+ * @since 1.21
*
* @param string $globalId
*/
/**
* Returns the type of the site (ie mediawiki).
*
- * @since 1.20
+ * @since 1.21
*
* @return string
*/
* Sets the type of the site (ie mediawiki).
* TODO: remove, we cannot change this after instantiation
*
- * @since 1.20
+ * @since 1.21
*
* @param string $type
*/
/**
* Gets the type of the site (ie wikipedia).
*
- * @since 1.20
+ * @since 1.21
*
* @return string
*/
/**
* Sets the type of the site (ie wikipedia).
*
- * @since 1.20
+ * @since 1.21
*
* @param string $group
*/
/**
* Returns the source of the site data (ie 'local', 'wikidata', 'my-magical-repo').
*
- * @since 1.20
+ * @since 1.21
*
* @return string
*/
/**
* Sets the source of the site data (ie 'local', 'wikidata', 'my-magical-repo').
*
- * @since 1.20
+ * @since 1.21
*
* @param string $source
*/
* Returns the protocol of the site, ie 'http://', 'irc://', '//'
* Or false if it's not known.
*
- * @since 1.20
+ * @since 1.21
*
* @return string|false
*/
* Returns the domain of the site, ie en.wikipedia.org
* Or false if it's not known.
*
- * @since 1.20
+ * @since 1.21
*
* @return string|false
*/
* This generated URL is usually based upon the path returned by getLinkPath(),
* but this is not a requirement.
*
- * @since 1.20
+ * @since 1.21
* @see Site::getLinkPath()
*
* @param bool|String $page
* Returns language code of the sites primary language.
* Or false if it's not known.
*
- * @since 1.20
+ * @since 1.21
*
* @return string|false
*/
/**
* Sets language code of the sites primary language.
*
- * @since 1.20
+ * @since 1.21
*
* @param string $languageCode
*/
* Note that this method may call out to the target site to perform the normalization, so it may be slow
* and fail due to IO errors.
*
- * @since 1.20
+ * @since 1.21
*
* @param string $pageName
*
/**
* Returns the interwiki link identifiers that can be used for this site.
*
- * @since 1.20
+ * @since 1.21
*
* @return array of string
*/
* Returns the equivalent link identifiers that can be used to make
* the site show up in interfaces such as the "language links" section.
*
- * @since 1.20
+ * @since 1.21
*
* @return array of string
*/
/**
* Adds an local identifier to the site.
*
- * @since 1.20
+ * @since 1.21
*
* @param string $type The type of the identifier, element of the Site::ID_ enum
* @param string $identifier
/**
* Adds an interwiki id to the site.
*
- * @since 1.20
+ * @since 1.21
*
* @param string $identifier
*/
/**
* Adds a navigation id to the site.
*
- * @since 1.20
+ * @since 1.21
*
* @param string $identifier
*/
/**
* Saves the site.
*
- * @since 1.20
+ * @since 1.21
*
* @param string|null $functionName
*/
/**
* Returns the internal ID of the site.
*
- * @since 1.20
+ * @since 1.21
*
* @return integer
*/
/**
* Sets the provided url as path of the specified type.
*
- * @since 1.20
+ * @since 1.21
*
* @param string $pathType
* @param string $fullUrl
/**
* Returns the path of the provided type or false if there is no such path.
*
- * @since 1.20
+ * @since 1.21
*
* @param string $pathType
*
*
* @param string $fullUrl
*
- * @since 1.20
+ * @since 1.21
*/
public function setLinkPath( $fullUrl );
* Returns the paths as associative array.
* The keys are path types, the values are the path urls.
*
- * @since 1.20
+ * @since 1.21
*
* @return array of string
*/
/**
* Removes the path of the provided type if it's set.
*
- * @since 1.20
+ * @since 1.21
*
* @param string $pathType
*/
dépôts / lhc / web / wiklou.git / blobdiff