Permalink
Browse files

Clarifies documentation and changes export method names.

  • Loading branch information...
1 parent 85a97ef commit e1a39c208604875500661294e9b8478d601d2ff6 Jim Safley committed May 2, 2011
Showing with 6 additions and 7 deletions.
  1. +6 −7 lib/Scripto/Document.php
@@ -457,8 +457,8 @@ public function isProtectedTalkPage()
}
/**
- * Determine whether the document transcription was already exported to the
- * external system.
+ * Determine whether all of this document's transcription pages were already
+ * exported to the external system.
*
* @return bool
*/
@@ -468,7 +468,7 @@ public function isExported()
}
/**
- * Determine whether the document page transcription was already exported to
+ * Determine whether the current transcription page was already exported to
* the external system.
*
* @return bool
@@ -488,7 +488,7 @@ public function isExportedPage()
* @param string $type The type of text to set, valid options are
* plain_text, html, and wikitext.
*/
- public function exportPageTranscription($type = 'plain_text')
+ public function exportPage($type = 'plain_text')
{
switch ($type) {
case 'plain_text':
@@ -516,8 +516,7 @@ public function exportPageTranscription($type = 'plain_text')
* plain_text, html, and wikitext.
* @param string $pageDelimiter The delimiter used to stitch pages together.
*/
- public function exportTranscription($type = 'plain_text',
- $pageDelimiter = "\n")
+ public function export($type = 'plain_text', $pageDelimiter = "\n")
{
$text = array();
foreach ($this->getPages() as $pageId => $pageName) {
@@ -586,7 +585,7 @@ protected function _canEdit(array $pageProtections)
}
/**
- * Determine whether the current page is edit protected.
+ * Determine whether the provided protections contain an edit protection.
*
* @param array $pageProtections The page protections from the page info.
* @return bool

0 comments on commit e1a39c2

Please sign in to comment.