diff --git "a/include/class-mw\\Ns.php" "b/include/class-mw\\Ns.php" index 61d5a7f..6b54486 100644 --- "a/include/class-mw\\Ns.php" +++ "b/include/class-mw\\Ns.php" @@ -1,142 +1,225 @@ . # MediaWiki namespace mw; /** * A Namespace. * * Yes, PHP does not allow to call a class "Namespace". */ class Ns { + /** + * @var int + */ private $id; + /** + * @var string + */ private $name; + /** + * @var string + */ private $canonicalName; + /** + * Aliases of this namespace + * + * @var array + */ private $aliases = []; + /** + * Constructor + * + * @var $id int + * @var $name string + * @var $aliases array + */ public function __construct( $id, $name, $aliases = [] ) { $this->setID( $id ); $this->setName( $name ); $canonical_name = self::existsDefaultCanonicalName( $id ) ? self::defaultCanonicalName( $id ) : $name; $this->setCanonicalName( $canonical_name ); foreach( $aliases as $alias ) { $this->addAlias( $alias ); } } + /** + * Get the namespace ID + * + * @return int + */ public function getID() { return $this->id; } + /** + * Get the namespace name (eventually localized) + * + * @return string + */ public function getName() { return $this->name->get(); } + /** + * Get the namespace canonical name (in English) + * + * @return string + */ public function getCanonicalName() { return $this->canonicalName->get(); } + /** + * Set the namespace ID + * + * @param $id int + * @return self + */ public function setID( $id ) { $this->id = $id; return $this; } + /** + * Set the namespace name + * + * @param $name string + * @return self + */ public function setName( $name ) { $this->name = new TitlePartCapitalized( $name ); return $this; } - public function setCanonicalName( $canonical_name ) { - $this->canonicalName = new TitlePartCapitalized( $canonical_name ); + /** + * Set the namespace canonical name + * + * @param $name string + * @param $id int + * @return self + */ + public function setCanonicalName( $name ) { + $this->canonicalName = new TitlePartCapitalized( $name ); return $this; } + /** + * Add another namespace alias + * + * @param $alias string + * @return self + */ public function addAlias( $alias ) { $this->aliases[] = new TitlePartCapitalized( $alias ); return $this; } /** * @return TitlePartCapitalized[] */ public function getAllTitlePartsCapitalized() { $all = []; $all[] = $this->name; if( $this->isCanonicalNameDifferent() ) { $all[] = $this->canonicalName; } foreach( $this->aliases as $alias ) { $all[] = $alias; } return $all; } + /** + * Check if the canonical name is different from the local one + * + * @return bool + */ public function isCanonicalNameDifferent() { return $this->getName() !== $this->getCanonicalName(); } + /** + * Check if it exists this default canonical name (from ID) + * + * @param $id int + * @return boolean + */ public static function existsDefaultCanonicalName( $id ) { return array_key_exists( $id, self::defaultCanonicalNames() ); } + /** + * Get the default canonical name from its ID + * + * @param $id int + * @return boolean + */ public static function defaultCanonicalName( $id ) { if( ! self::existsDefaultCanonicalName( $id ) ) { throw new \Exception('unexisting namespace ID'); } return self::defaultCanonicalNames()[ $id ]; } /** * Normalize a namespace name * * @param $name string * @return string */ public static function normalizeName( $name ) { return ucfirst( strtolower( $name ) ); } + /** + * Get all the known MediaWiki default canonical names + * + * @return array + */ public static function defaultCanonicalNames() { return [ 0 => '', 1 => 'Talk', 2 => 'User', 3 => 'User talk', 4 => 'Project', 5 => 'Project talk', 6 => 'File', 7 => 'File talk', 8 => 'MediaWiki', 9 => 'MediaWiki talk', 10 => 'Template', 11 => 'Template talk', 12 => 'Help', 13 => 'Help talk', 14 => 'Category', 15 => 'Category talk', -1 => 'Special', -2 => 'Media' ]; } }