/** * @param Page $page * * @returns bool */ public function watch(Page $page) { $params = ['token' => $this->api->getToken('watch')]; if (!is_null($page->getPageIdentifier()->getId())) { $params['pageids'] = $page->getPageIdentifier()->getId(); } elseif (!is_null($page->getPageIdentifier()->getTitle())) { $params['titles'] = $page->getPageIdentifier()->getTitle()->getTitle(); } elseif (!is_null($page->getRevisions()->getLatest())) { $params['revids'] = $page->getRevisions()->getLatest()->getId(); } $this->api->postRequest(new SimpleRequest('watch', $params)); return true; }
/** * @dataProvider provideValidConstruction */ public function testValidConstruction($pageIdentifier, $revisions) { $page = new Page($pageIdentifier, $revisions); $this->assertEquals($pageIdentifier, $page->getPageIdentifier()); if (is_null($revisions)) { $this->assertInstanceOf('Mediawiki\\DataModel\\Revisions', $page->getRevisions()); } else { $this->assertEquals($revisions, $page->getRevisions()); } }
/** * @since 0.2 * * @param Page $page * @param array $extraParams * * @return bool */ public function delete(Page $page, array $extraParams = []) { $this->api->postRequest(new SimpleRequest('delete', $this->getDeleteParams($page->getPageIdentifier(), $extraParams))); return true; }
/** * @param Page $page * * @return Page * * @throws InvalidArgumentException */ public function getFromPage(Page $page) { return $this->getFromPageIdentifier($page->getPageIdentifier()); }
/** * @since 0.2 * * @param Page $page * @param QueryOptions|null $options * * @return Page */ public function getFromPage(Page $page, QueryOptions $options = null) { if (is_null($options)) { $options = new QueryOptions(); } $result = $this->api->getRequest(new SimpleRequest('query', $this->getQuery(array('pageids' => $page->getId()), $options))); $revisions = $this->getRevisionsFromResult(array_shift($result['query']['pages'])); $revisions->addRevisions($page->getRevisions()); return new Page($page->getPageIdentifier(), $revisions); }
/** * @since 0.2 * * @param Page $page * @param array $extraParams * * @return Page */ public function getFromPage(Page $page, array $extraParams = []) { $result = $this->api->getRequest(new SimpleRequest('query', $this->getQuery(['pageids' => $page->getId()], $extraParams))); $revisions = $this->getRevisionsFromResult(array_shift($result['query']['pages'])); $revisions->addRevisions($page->getRevisions()); return new Page($page->getPageIdentifier(), $revisions); }
/** * @since 0.2 * * @param Page $page * @param DeleteOptions|null $options * * @return bool */ public function delete(Page $page, DeleteOptions $options = null) { $this->api->postRequest(new SimpleRequest('delete', $this->getDeleteParams($page->getPageIdentifier(), $options))); return true; }
/** * Visit every descendant page of $rootCategoryName (which will be a Category * page, because there are no desecendants of any other pages). * @param Page $rootCat The full name of the page to start at. * @param Page[] $currentPath Used only when recursing into this method, to track each path * through the category hierarchy in case of loops. * @return Pages All descendants of the given category. * @throws CategoryLoopException If a category loop is detected. */ public function descend(Page $rootCat, $currentPath = null) { // Make sure we know the namespace IDs. $this->retrieveNamespaces(); $rootCatName = $rootCat->getPageIdentifier()->getTitle()->getText(); if (is_null($currentPath)) { $this->alreadyVisited = []; $currentPath = new Pages(); } $this->alreadyVisited[] = $rootCatName; $currentPath->addPage($rootCat); // Start a list of child pages. $descendants = new Pages(); do { $pageListGetter = new PageListGetter($this->api); $members = $pageListGetter->getPageListFromCategoryName($rootCatName); foreach ($members->toArray() as $member) { /** @var Title */ $memberTitle = $member->getPageIdentifier()->getTitle(); // See if this page is a Category page. $isCat = false; if (isset($this->namespaces[$memberTitle->getNs()])) { $ns = $this->namespaces[$memberTitle->getNs()]; $isCat = isset($ns['canonical']) && $ns['canonical'] === 'Category'; } // If it's a category, descend into it. if ($isCat) { // If this member has already been visited on this branch of the traversal, // throw an Exception with information about which categories form the loop. if ($currentPath->hasPage($member)) { $currentPath->addPage($member); $loop = new CategoryLoopException(); $loop->setCategoryPath($currentPath); throw $loop; } // Don't go any further if we've already visited this member // (does not indicate a loop, however; we've already caught that above). if (in_array($memberTitle->getText(), $this->alreadyVisited)) { continue; } // Call any registered callbacked, and carry on to the next branch. $this->call(self::CALLBACK_CATEGORY, [$member, $rootCat]); $newDescendants = $this->descend($member, $currentPath); $descendants->addPages($newDescendants); $currentPath = new Pages(); // Re-set the path. } else { // If it's a page, add it to the list and carry on. $descendants->addPage($member); $this->call(self::CALLBACK_PAGE, [$member, $rootCat]); } } } while (isset($result['continue'])); return $descendants; }