silverstripe / silverstripe-documentconverter

src/ConvertsDocumentsExtension.php

Spacing +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
 		 */
 		$fields->findOrMakeTab(
 			'Root.Import',
-			_t(__CLASS__ . '.ImportTab', 'Import')
+			_t(__CLASS__.'.ImportTab', 'Import')
 		);
 		$fields->addFieldToTab('Root.Import', DocumentConversionField::create());
 	}

src/DocumentImporterField.php

Spacing +49 added lines, -49 removed lines

@@ -60,11 +60,11 @@ 
 	 * Process the document immediately upon upload.
 	 */
 	public function upload(HTTPRequest $request) {
-		if($this->isDisabled() || $this->isReadonly()) return $this->httpError(403);
+		if ($this->isDisabled() || $this->isReadonly()) return $this->httpError(403);
 
 		// Protect against CSRF on destructive action
 		$token = $this->getForm()->getSecurityToken();
-		if(!$token->checkRequest($request)) return $this->httpError(400);
+		if (!$token->checkRequest($request)) return $this->httpError(400);
 
 		$name = $this->getName();
 		$tmpfile = $request->postVar($name);
@@ -83,11 +83,11 @@ 
 
 		if (!$return['error']) {
 			// Get options for this import.
-			$splitHeader = (int)$request->postVar('SplitHeader');
-			$keepSource = (bool)$request->postVar('KeepSource');
-			$chosenFolderID = (int)$request->postVar('ChosenFolderID');
-			$publishPages = (bool)$request->postVar('PublishPages');
-			$includeTOC = (bool)$request->postVar('IncludeTOC');
+			$splitHeader = (int) $request->postVar('SplitHeader');
+			$keepSource = (bool) $request->postVar('KeepSource');
+			$chosenFolderID = (int) $request->postVar('ChosenFolderID');
+			$publishPages = (bool) $request->postVar('PublishPages');
+			$includeTOC = (bool) $request->postVar('IncludeTOC');
 
 			// Process the document and write the page.
 			$preservedDocument = null;
@@ -136,42 +136,42 @@ 
 		$page = $this->form->getRecord();
 		$content = '<ul>';
 
-		if($page) {
-			if($page->Children()->Count() > 0) {
-				foreach($page->Children() as $child) {
-					$content .= '<li><a href="' . $child->Link() . '">' . $child->Title . '</a></li>';
+		if ($page) {
+			if ($page->Children()->Count() > 0) {
+				foreach ($page->Children() as $child) {
+					$content .= '<li><a href="'.$child->Link().'">'.$child->Title.'</a></li>';
 				}
-				$page->Content = $content . '</ul>';
-			}  else {
+				$page->Content = $content.'</ul>';
+			} else {
 				$doc = new DOMDocument();
 				$doc->loadHTML($page->Content);
 				$body = $doc->getElementsByTagName('body')->item(0);
 				$node = $body->firstChild;
 				$h1 = $h2 = 1;
-				while($node) {
-					if($node instanceof DOMElement && $node->tagName == 'h1') {
-						$content .= '<li><a href="#h1.' . $h1 . '">'. trim(preg_replace('/\n|\r/', '', Convert::html2raw($node->textContent))) . '</a></li>';
+				while ($node) {
+					if ($node instanceof DOMElement && $node->tagName == 'h1') {
+						$content .= '<li><a href="#h1.'.$h1.'">'.trim(preg_replace('/\n|\r/', '', Convert::html2raw($node->textContent))).'</a></li>';
 						$node->setAttributeNode(new DOMAttr("id", "h1.".$h1));
 						$h1++;
-					} elseif($node instanceof DOMElement && $node->tagName == 'h2') {
-						$content .= '<li class="menu-h2"><a href="#h2.' . $h2 . '">'. trim(preg_replace('/\n|\r/', '', Convert::html2raw($node->textContent))) . '</a></li>';
+					} elseif ($node instanceof DOMElement && $node->tagName == 'h2') {
+						$content .= '<li class="menu-h2"><a href="#h2.'.$h2.'">'.trim(preg_replace('/\n|\r/', '', Convert::html2raw($node->textContent))).'</a></li>';
 						$node->setAttributeNode(new DOMAttr("id", "h2.".$h2));
 						$h2++;
 					}
 					$node = $node->nextSibling;
 				}
-				$page->Content = $content . '</ul>' . $doc->saveHTML();
+				$page->Content = $content.'</ul>'.$doc->saveHTML();
 			}
 
 			// Add in the link to the original document, if provided.
-			if($preservedDocument) {
-				$page->Content = '<a href="' . $preservedDocument->Link() . '" title="download original document">download original document (' .
-									$preservedDocument->getSize() . ')</a>' . $page->Content;
+			if ($preservedDocument) {
+				$page->Content = '<a href="'.$preservedDocument->Link().'" title="download original document">download original document ('.
+									$preservedDocument->getSize().')</a>'.$page->Content;
 			}
 
 			// Store the result
 			$page->write();
-			if($publishPages) $page->doPublish();
+			if ($publishPages) $page->doPublish();
 		}
 	}
 
@@ -205,28 +205,28 @@ 
 	protected function writeContent($subtitle, $subdoc, $subnode, $sort = null, $publishPages = false) {
 		$record = $this->form->getRecord();
 
-		if($subtitle) {
+		if ($subtitle) {
 			// Write the chapter page to a subpage.
 			$page = DataObject::get_one('Page', sprintf('"Title" = \'%s\' AND "ParentID" = %d', $subtitle, $record->ID));
-			if(!$page) {
+			if (!$page) {
 				$page = Page::create();
 				$page->ParentID = $record->ID;
 				$page->Title = $subtitle;
 			}
 
 			unset($this->unusedChildren[$page->ID]);
-			file_put_contents(ASSETS_PATH . '/index-' . $sort . '.html', $this->getBodyText($subdoc, $subnode));
+			file_put_contents(ASSETS_PATH.'/index-'.$sort.'.html', $this->getBodyText($subdoc, $subnode));
 
 			if ($sort) $page->Sort = $sort;
 			$page->Content = $this->getBodyText($subdoc, $subnode);
 			$page->write();
-			if($publishPages) $page->doPublish();
+			if ($publishPages) $page->doPublish();
 		} else {
 			// Write to the master page.
 			$record->Content = $this->getBodyText($subdoc, $subnode);
 			$record->write();
 
-			if($publishPages) $record->doPublish();
+			if ($publishPages) $record->doPublish();
 		}
 
 	}
@@ -263,7 +263,7 @@ 
 		$tidy->cleanRepair();
 
 		$fragment = [];
-		foreach($tidy->body()->child as $child) {
+		foreach ($tidy->body()->child as $child) {
 			$fragment[] = $child->value;
 		}
 
@@ -279,15 +279,15 @@ 
 
 		// make sure any images are added as Image records with a relative link to assets
 		$chosenFolder = ($this->chosenFolderID) ? DataObject::get_by_id(Folder::class, $this->chosenFolderID) : null;
-		$folderName = ($chosenFolder) ? '/' . $chosenFolder->Name : '';
+		$folderName = ($chosenFolder) ? '/'.$chosenFolder->Name : '';
 		$imgs = $xpath->query('//img');
-		for($i = 0; $i < $imgs->length; $i++) {
+		for ($i = 0; $i < $imgs->length; $i++) {
 			$img = $imgs->item($i);
-			$originalPath = 'assets/' . $folderName . '/' . $img->getAttribute('src');
+			$originalPath = 'assets/'.$folderName.'/'.$img->getAttribute('src');
 			$name = FileNameFilter::create()->filter(basename($originalPath));
 
 			$image = Image::get()->filter(array('Name' => $name, 'ParentID' => (int) $chosenFolderID))->first();
-			if(!($image && $image->exists())) {
+			if (!($image && $image->exists())) {
 				$image = Image::create();
 				$image->ParentID = (int) $chosenFolderID;
 				$image->Name = $name;
@@ -306,24 +306,24 @@ 
 			'//font' // Remove any font tags
 		);
 
-		foreach($remove_rules as $rule => $parenttag) {
-			if(is_numeric($rule)) {
+		foreach ($remove_rules as $rule => $parenttag) {
+			if (is_numeric($rule)) {
 				$rule = $parenttag;
 				$parenttag = null;
 			}
 
 			$nodes = array();
-			foreach($xpath->query($rule) as $node) $nodes[] = $node;
+			foreach ($xpath->query($rule) as $node) $nodes[] = $node;
 
-			foreach($nodes as $node) {
+			foreach ($nodes as $node) {
 				$parent = $node->parentNode;
 
-				if($parenttag) {
+				if ($parenttag) {
 					$parent = $doc->createElement($parenttag);
 					$node->nextSibling ? $node->parentNode->insertBefore($parent, $node->nextSibling) : $node->parentNode->appendChild($parent);
 				}
 
-				while($node->firstChild) $parent->appendChild($node->firstChild);
+				while ($node->firstChild) $parent->appendChild($node->firstChild);
 				$node->parentNode->removeChild($node);
 			}
 		}
@@ -347,11 +347,11 @@ 
 			'//br' // BR tags
 		);
 
-		foreach($clean as $query) {
+		foreach ($clean as $query) {
 			// First get all the nodes. Need to build array, as they'll disappear from the nodelist while we're deleteing them, causing the indexing
 			// to screw up.
 			$nodes = array();
-			foreach($xpath->query($query) as $node) $nodes[] = $node;
+			foreach ($xpath->query($query) as $node) $nodes[] = $node;
 
 			// Then remove them all
 			foreach ($nodes as $node) { if ($node->parentNode) $node->parentNode->removeChild($node); }
@@ -361,13 +361,13 @@ 
 		$body = $doc->getElementsByTagName('body')->item(0);
 
 		$this->unusedChildren = array();
-		foreach($sourcePage->Children() as $child) {
+		foreach ($sourcePage->Children() as $child) {
 			$this->unusedChildren[$child->ID] = $child;
 		}
 
 		$documentImporterFieldError;
 
-		$documentImporterFieldErrorHandler = function ($errno, $errstr, $errfile, $errline) use ( $documentImporterFieldError ) {
+		$documentImporterFieldErrorHandler = function($errno, $errstr, $errfile, $errline) use ($documentImporterFieldError) {
 			$documentImporterFieldError = _t(
 				'SilverStripe\\DocumentConverter\\DocumentConverter.PROCESSFAILED',
 				'Could not process document, please double-check you uploaded a .doc or .docx format.',
@@ -385,10 +385,10 @@ 
 		$subnode = $subdoc->createElement('body');
 		$node = $body->firstChild;
 		$sort = 1;
-		if($splitHeader == 1 || $splitHeader == 2) {
-			while($node && !$documentImporterFieldError) {
-				if($node instanceof DOMElement && $node->tagName == 'h' . $splitHeader) {
-					if($subnode->hasChildNodes()) {
+		if ($splitHeader == 1 || $splitHeader == 2) {
+			while ($node && !$documentImporterFieldError) {
+				if ($node instanceof DOMElement && $node->tagName == 'h'.$splitHeader) {
+					if ($subnode->hasChildNodes()) {
 						$this->writeContent($subtitle, $subdoc, $subnode, $sort, $publishPages);
 						$sort++;
 					}
@@ -406,7 +406,7 @@ 
 			$this->writeContent($subtitle, $subdoc, $body, null, $publishPages);
 		}
 
-		if($subnode->hasChildNodes() && !$documentImporterFieldError) {
+		if ($subnode->hasChildNodes() && !$documentImporterFieldError) {
 			$this->writeContent($subtitle, $subdoc, $subnode, null, $publishPages);
 		}
 
@@ -415,7 +415,7 @@ 
 			return array('error' => $documentImporterFieldError);
 		}
 
-		foreach($this->unusedChildren as $child) {
+		foreach ($this->unusedChildren as $child) {
 			$origStage = Versioned::current_stage();
 
 			Versioned::reading_stage('Stage');

Braces +35 added lines, -12 removed lines

@@ -60,11 +60,15 @@ 
 	 * Process the document immediately upon upload.
 	 */
 	public function upload(HTTPRequest $request) {
-		if($this->isDisabled() || $this->isReadonly()) return $this->httpError(403);
+		if($this->isDisabled() || $this->isReadonly()) {
+			return $this->httpError(403);
+		}
 
 		// Protect against CSRF on destructive action
 		$token = $this->getForm()->getSecurityToken();
-		if(!$token->checkRequest($request)) return $this->httpError(400);
+		if(!$token->checkRequest($request)) {
+			return $this->httpError(400);
+		}
 
 		$name = $this->getName();
 		$tmpfile = $request->postVar($name);
@@ -91,7 +95,9 @@ 
 
 			// Process the document and write the page.
 			$preservedDocument = null;
-			if ($keepSource) $preservedDocument = $this->preserveSourceDocument($tmpfile, $chosenFolderID);
+			if ($keepSource) {
+				$preservedDocument = $this->preserveSourceDocument($tmpfile, $chosenFolderID);
+			}
 
 			$importResult = $this->importFromPOST($tmpfile, $splitHeader, $publishPages, $chosenFolderID);
 			if (is_array($importResult) && isset($importResult['error'])) {
@@ -142,7 +148,7 @@ 
 					$content .= '<li><a href="' . $child->Link() . '">' . $child->Title . '</a></li>';
 				}
 				$page->Content = $content . '</ul>';
-			}  else {
+			} else {
 				$doc = new DOMDocument();
 				$doc->loadHTML($page->Content);
 				$body = $doc->getElementsByTagName('body')->item(0);
@@ -171,7 +177,9 @@ 
 
 			// Store the result
 			$page->write();
-			if($publishPages) $page->doPublish();
+			if($publishPages) {
+				$page->doPublish();
+			}
 		}
 	}
 
@@ -217,16 +225,22 @@ 
 			unset($this->unusedChildren[$page->ID]);
 			file_put_contents(ASSETS_PATH . '/index-' . $sort . '.html', $this->getBodyText($subdoc, $subnode));
 
-			if ($sort) $page->Sort = $sort;
+			if ($sort) {
+				$page->Sort = $sort;
+			}
 			$page->Content = $this->getBodyText($subdoc, $subnode);
 			$page->write();
-			if($publishPages) $page->doPublish();
+			if($publishPages) {
+				$page->doPublish();
+			}
 		} else {
 			// Write to the master page.
 			$record->Content = $this->getBodyText($subdoc, $subnode);
 			$record->write();
 
-			if($publishPages) $record->doPublish();
+			if($publishPages) {
+				$record->doPublish();
+			}
 		}
 
 	}
@@ -313,7 +327,9 @@ 
 			}
 
 			$nodes = array();
-			foreach($xpath->query($rule) as $node) $nodes[] = $node;
+			foreach($xpath->query($rule) as $node) {
+				$nodes[] = $node;
+			}
 
 			foreach($nodes as $node) {
 				$parent = $node->parentNode;
@@ -323,7 +339,9 @@ 
 					$node->nextSibling ? $node->parentNode->insertBefore($parent, $node->nextSibling) : $node->parentNode->appendChild($parent);
 				}
 
-				while($node->firstChild) $parent->appendChild($node->firstChild);
+				while($node->firstChild) {
+					$parent->appendChild($node->firstChild);
+				}
 				$node->parentNode->removeChild($node);
 			}
 		}
@@ -351,10 +369,15 @@ 
 			// First get all the nodes. Need to build array, as they'll disappear from the nodelist while we're deleteing them, causing the indexing
 			// to screw up.
 			$nodes = array();
-			foreach($xpath->query($query) as $node) $nodes[] = $node;
+			foreach($xpath->query($query) as $node) {
+				$nodes[] = $node;
+			}
 
 			// Then remove them all
-			foreach ($nodes as $node) { if ($node->parentNode) $node->parentNode->removeChild($node); }
+			foreach ($nodes as $node) { if ($node->parentNode) {
+				$node->parentNode->removeChild($node);
+			}
+			}
 		}
 
 		// Now split the document into portions by H1

src/DocumentConverter.php

Spacing +13 added lines, -13 removed lines

@@ -52,10 +52,10 @@ 
 	public function __construct($fileDescriptor, $chosenFolderID = null) {
 		$this->fileDescriptor = $fileDescriptor;
 		$this->chosenFolderID = $chosenFolderID;
-		array_merge($this->docvertDetails, (array)$this->config()->get('docvert_details'));
+		array_merge($this->docvertDetails, (array) $this->config()->get('docvert_details'));
 	}
 
-	public function setDocvertUsername($username = null)  {
+	public function setDocvertUsername($username = null) {
 		$this->docvertDetails['username'] = $username;
 	}
 
@@ -83,14 +83,14 @@ 
 		$ch = curl_init();
 
 		// PHP 5.5+ introduced CURLFile which makes the '@/path/to/file' syntax deprecated.
-		if(class_exists('CURLFile')) {
+		if (class_exists('CURLFile')) {
 			$file = new CURLFile(
 				$this->fileDescriptor['path'],
 				$this->fileDescriptor['mimeType'],
 				$this->fileDescriptor['name']
 			);
 		} else {
-			$file = '@' . $this->fileDescriptor['path'];
+			$file = '@'.$this->fileDescriptor['path'];
 		}
 
 		curl_setopt_array($ch, array(
@@ -103,9 +103,9 @@ 
 		));
 
 		$chosenFolder = ($this->chosenFolderID) ? DataObject::get_by_id(Folder::class, $this->chosenFolderID) : null;
-		$folderName = ($chosenFolder) ? '/' . $chosenFolder->Name : '';
+		$folderName = ($chosenFolder) ? '/'.$chosenFolder->Name : '';
 		$outname = tempnam(ASSETS_PATH, 'convert');
-		$outzip = $outname . '.zip';
+		$outzip = $outname.'.zip';
 
 		$out = fopen($outzip, 'w');
 		curl_setopt($ch, CURLOPT_FILE, $out);
@@ -117,7 +117,7 @@ 
 
 		if (!$returnValue || ($status != 200)) {
 			return array('error' => _t(
-				__CLASS__ . '.SERVERUNREACHABLE',
+				__CLASS__.'.SERVERUNREACHABLE',
 				'Could not contact document conversion server. Please try again later or contact your system administrator.',
 				'Document Converter process Word documents into HTML.'
 			));
@@ -127,25 +127,25 @@ 
 		// you need php zip, i.e. port install php5-zip
 		$zip = new ZipArchive();
 
-		if($zip->open($outzip)) {
-			$zip->extractTo(ASSETS_PATH .$folderName);
+		if ($zip->open($outzip)) {
+			$zip->extractTo(ASSETS_PATH.$folderName);
 		}
 
 		// remove temporary files
 		unlink($outname);
 		unlink($outzip);
 
-		if (!file_exists(ASSETS_PATH . $folderName . '/index.html')) {
+		if (!file_exists(ASSETS_PATH.$folderName.'/index.html')) {
 			return array('error' =>  _t(
-				__CLASS__ . '.PROCESSFAILED',
+				__CLASS__.'.PROCESSFAILED',
 				'Could not process document, please double-check you uploaded a .doc or .docx format.',
 				'Document Converter processes Word documents into HTML.'
 			));
 		}
 
-		$content = file_get_contents(ASSETS_PATH . $folderName . '/index.html');
+		$content = file_get_contents(ASSETS_PATH.$folderName.'/index.html');
 
-		unlink(ASSETS_PATH . $folderName . '/index.html');
+		unlink(ASSETS_PATH.$folderName.'/index.html');
 
 		return $content;
 	}

src/DocumentConversionField.php

Spacing +10 added lines, -10 removed lines

@@ -39,7 +39,7 @@ 
 			HeaderField::create(
 				'FileWarningHeader', 
 				_t(
-					__CLASS__ . '.FileWarningHeader',
+					__CLASS__.'.FileWarningHeader',
 					'Warning: import will remove all content and subpages of this page.'
 				), 
 				4
@@ -47,41 +47,41 @@ 
 			$splitHeader = DropdownField::create(
 				'DocumentConversionField-SplitHeader', 
 				_t(
-					__CLASS__ . '.SplitHeader',
+					__CLASS__.'.SplitHeader',
 					'Split document into pages'
 				), 
 				array(
-					0 => _t(__CLASS__ . '.No','no'), 
-					1 => _t(__CLASS__ . '.EachH1','for each heading 1'), 
-					2 => _t(__CLASS__ . '.EachH2','for each heading 2')
+					0 => _t(__CLASS__.'.No', 'no'), 
+					1 => _t(__CLASS__.'.EachH1', 'for each heading 1'), 
+					2 => _t(__CLASS__.'.EachH2', 'for each heading 2')
 				)
 			),
 			$keepSource = CheckboxField::create(
 				'DocumentConversionField-KeepSource', 
 				_t(
-					__CLASS__ . '.KeepSource',
+					__CLASS__.'.KeepSource',
 					'Keep the original document. Adds a link to it on TOC, if enabled.'
 				)
 			),
 			$chosenFolderID = TreeDropdownField::create(
 				'DocumentConversionField-ChosenFolderID',
-				_t(__CLASS__ . '.ChooseFolder', 'Choose a folder to save this file'), 
+				_t(__CLASS__.'.ChooseFolder', 'Choose a folder to save this file'), 
 				Folder::class
 			),
 			$includeTOC = CheckboxField::create(
 				'DocumentConversionField-IncludeTOC', 
-				_t(__CLASS__ . '.IncludeTOC', 'Replace this page with a Table of Contents.')
+				_t(__CLASS__.'.IncludeTOC', 'Replace this page with a Table of Contents.')
 			),
 			$publishPages = CheckboxField::create(
 				'DocumentConversionField-PublishPages', 
 				_t(
-					__CLASS__ . '.publishPages',
+					__CLASS__.'.publishPages',
 					'Publish modified pages (not recommended unless you are sure about the conversion outcome)'
 				)
 			),
 			$this->innerField = DocumentImporterField::create(
 				'ImportedFromFile', 
-				_t(__CLASS__ . '.ImportedFromFile','Import content from a word document')
+				_t(__CLASS__.'.ImportedFromFile', 'Import content from a word document')
 			),
 		));
 

Braces +6 added lines, -2 removed lines

@@ -29,8 +29,12 @@
 	 * @param $children FieldSet/array Any additional children.
 	 */
 	public function __construct($children = null) {
-		if (is_string($children)) throw new InvalidArgumentException('DocumentConversionField::__construct does not accept a name as its parameter, it defaults to "ImportedFromFile" instead. Use DocumentConversionField::getInnerField()->setName() if you want to change it.');
-		if ($children) throw new InvalidArgumentException('DocumentConversionField::__construct provides its own fields and does not accept additional children.');
+		if (is_string($children)) {
+			throw new InvalidArgumentException('DocumentConversionField::__construct does not accept a name as its parameter, it defaults to "ImportedFromFile" instead. Use DocumentConversionField::getInnerField()->setName() if you want to change it.');
+		}
+		if ($children) {
+			throw new InvalidArgumentException('DocumentConversionField::__construct provides its own fields and does not accept additional children.');
+		}
 
 		// Add JS specific to this field.
 		Requirements::javascript('silverstripe/documentconverter: javascript/DocumentConversionField.js');

tests/DocumentConverterTest.php

Indentation +4 added lines, -4 removed lines

@@ -9,9 +9,9 @@
 
 class DocumentConverterTest extends SapphireTest
 {
-    protected $usesDatabase = true;
+	protected $usesDatabase = true;
 
-    public function testExtensionAppliesAppropriateFields() {
-        $this->markTestIncomplete();
-    }
+	public function testExtensionAppliesAppropriateFields() {
+		$this->markTestIncomplete();
+	}
 }
\ No newline at end of file