Menu
▾
▴
[ODP-Repository] SF.net SVN: opendocumentphp: [23] poc/src
|
From: <nma...@us...> - 2006-03-13 11:06:51
|
Revision: 23 Author: nmarkgraf Date: 2006-03-13 03:06:19 -0800 (Mon, 13 Mar 2006) ViewCVS: http://svn.sourceforge.net/opendocumentphp/?rev=23&view=rev Log Message: ----------- Minor bug fixes, mostly in PHPDoc comments. Modified Paths: -------------- poc/src/OpenDocument.php poc/src/OpenDocumentAbstract.php poc/src/OpenDocumentContent.php poc/src/OpenDocumentContentBody.php poc/src/OpenDocumentContentBodyText.php poc/src/OpenDocumentFactory.php poc/src/OpenDocumentFactoryTest.php poc/src/OpenDocumentManifest.php poc/src/OpenDocumentManifestTest.php poc/src/OpenDocumentMeta.php poc/src/OpenDocumentMetaTest.php poc/src/OpenDocumentObjectAbstract.php poc/src/OpenDocumentOutput.php poc/src/OpenDocumentPackage.php poc/src/OpenDocumentSingle.php poc/src/OpenDocumentStyle.php poc/src/samples/TestInput.php poc/src/samples/TestOutput.php poc/src/samples/TestTranslate.php poc/src/styles/FontFaceDeclaration.php Modified: poc/src/OpenDocument.php =================================================================== --- poc/src/OpenDocument.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocument.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,12 +2,14 @@ /** * OpenDocument interface * + * $Id$ + * * @copyright GNU General Public License * @author Norman Markgraf <nma...@us...> * @version $Revision$ * @package OpenDocument * - * $Id$ + * @since 0.3.0 */ interface OpenDocument { /** Modified: poc/src/OpenDocumentAbstract.php =================================================================== --- poc/src/OpenDocumentAbstract.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocumentAbstract.php 2006-03-13 11:06:19 UTC (rev 23) @@ -5,13 +5,15 @@ * * OpenDocumentAbstract is the basic class for all OpenDocument classes * + * $Id$ + * * @license GNU General Public License * @copyright Copyright © 2006, Norman Markgraf, et. al. * @author Norman Markgraf <nma...@us...> * @version $Revision$ * @package OpenDocument * - * $Id$ + * @since 0.3.0 */ class OpenDocumentAbstract { Modified: poc/src/OpenDocumentContent.php =================================================================== --- poc/src/OpenDocumentContent.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocumentContent.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,14 +2,14 @@ /** * OpenDocumentContent Class * + * $Id$ + * * @copyright GNU General Public License * @author Norman Markgraf <nma...@us...> * @version $Revision$ * @package OpenDocument * * @since 0.4.0 - * - * $Id$ */ class OpenDocumentContent extends OpenDocumentObjectAbstract { Modified: poc/src/OpenDocumentContentBody.php =================================================================== --- poc/src/OpenDocumentContentBody.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocumentContentBody.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,13 +2,13 @@ /** * OpenDocumentContentBody Class * + * $Id$ + * * @copyright GNU General Public License * @author Norman Markgraf <nma...@us...> * @version $Revision$ * @package OpenDocument.Content.Body * @since POC 0.5 - * - * $Id$ */ class OpenDocumentContentBody extends OpenDocumentObjectAbstract { Modified: poc/src/OpenDocumentContentBodyText.php =================================================================== --- poc/src/OpenDocumentContentBodyText.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocumentContentBodyText.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,17 +2,22 @@ /** * OpenDocumentContentBodyText Class * + * $Id$ + * * @copyright GNU General Public License * @author Norman Markgraf <nma...@us...> * @version $Revision$ * @package OpenDocument.Content.Body.Text - * @since POC 0.5 - * - * $Id$ + * @since 0.4.2 */ class OpenDocumentContentBodyText extends OpenDocumentObjectAbstract { - + /** + * + * @access public + * + * @since 0.4.0 + */ public function __construct( $dom ) { parent::__construct(); $this->logger->debug( "Constructing OpenDocumentContentBodyText." ); @@ -21,11 +26,23 @@ $this->text = $this->dom->createElementNS( self::NS_OFFICE, "office:text" ); } + /** + * + * @access public + * + * @since 0.4.0 + */ public function commit() { $this->logger->debug( "OpenDocumentContentBodyText->commit()" ); $this->isCommited = true; } + /** + * + * @access public + * + * @since 0.4.0 + */ public function getTextParagraph( $styleName, $parText=0 ) { $this->logger->debug( "OpenDocumentContentBodyText->getTextParagraph(\"".$styleName."\",\"".$parText."\")" ); if (empty($parText)) { @@ -37,11 +54,23 @@ return $par; } + /** + * + * @access public + * + * @since 0.4.0 + */ public function addToText( $Node ) { $this->logger->debug( "OpenDocumentContentBodyText->addToText()" ); $this->text->appendChild( $Node ); } + /** + * + * @access public + * + * @since 0.4.0 + */ public function getTextHeading( $styleName, $headText=0 ) { $this->logger->debug( "OpenDocumentContentBodyText->getTextHeading()" ); if (empty($headText)) { @@ -53,6 +82,12 @@ return $head; } + /** + * + * @access public + * + * @since 0.4.0 + */ public function addNoForms() { $this->logger->debug( "OpenDocumentContentBodyText->addNoForms()" ); $forms = $this->dom->createElementNS( self::NS_OFFICE, "office:forms" ); @@ -63,10 +98,13 @@ $this->text->appendChild( $forms ); unset( $forms ); } - - /** - * @return DOMDocumentFragment body fragment - */ + + /** + * @return DOMDocumentFragment body fragment + * @access public + * + * @since 0.4.0 + */ final public function get() { $this->logger->debug( "OpenDocumentContentBodyText->get()" ); if (!$this->isCommited) { Modified: poc/src/OpenDocumentFactory.php =================================================================== --- poc/src/OpenDocumentFactory.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocumentFactory.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,6 +2,8 @@ /** * OpenDocumentFactoy Class * + * $Id$ + * * @license GNU General Public License * @copyright Copyright © 2006, Norman Markgraf, Alex Latchford, et. al. * @author Norman Markgraf <nma...@us...> @@ -9,8 +11,6 @@ * @version $Revision$ * @package OpenDocument.Factory * @since 0.4.0 - * - * $Id$ */ /** Modified: poc/src/OpenDocumentFactoryTest.php =================================================================== --- poc/src/OpenDocumentFactoryTest.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocumentFactoryTest.php 2006-03-13 11:06:19 UTC (rev 23) @@ -1,14 +1,16 @@ <?php /** * OpenDocumentFactoyTest Class + * + * $Id$ * - * @copyright GNU General Public License - * @author Norman Markgraf <nma...@us...> - * @version $Revision$ - * @package OpenDocument + * @license GNU General Public License + * @copyright Copyright %copy; 2006, Norman Markgraf, et al. + * @author Norman Markgraf <nma...@us...> + * @version $Revision$ + * @package OpenDocument * @subpackage UnitTest - * - * $Id$ + * @since 0.4.0 */ require_once "PHPUnit2/Framework/TestCase.php"; require_once( "OpenDocumentFactory.php" ); Modified: poc/src/OpenDocumentManifest.php =================================================================== --- poc/src/OpenDocumentManifest.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocumentManifest.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,6 +2,8 @@ /** * OpenDocumentManifest.php * + * $Id$ + * * @license GNU General Public License * @copyright Copyright © 2006, Norman Markgraf, et. al. * @author Norman Markgraf <nma...@us...> @@ -9,8 +11,6 @@ * @package OpenDocument * * @since 0.3.0 - * - * $Id$ */ class OpenDocumentManifest extends OpenDocumentObjectAbstract { @@ -135,5 +135,4 @@ $this->get()->save( $filename ); } } - ?> \ No newline at end of file Modified: poc/src/OpenDocumentManifestTest.php =================================================================== --- poc/src/OpenDocumentManifestTest.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocumentManifestTest.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,16 +2,15 @@ /** * Test Class for OpenDocumentManifest * + * $Id$ + * * @copyright Copyright © 2006, Norman Markgraf, et al. * @lecense GNU General Public License * @author Norman Markgraf <nma...@us...> * @version $Revision$ * @package OpenDocument * @subpackage UnitTest - * * @since 0.4.0 - * - * $Id$ */ require_once "PHPUnit2/Framework/TestCase.php"; require_once "OpenDocumentManifest.php"; Modified: poc/src/OpenDocumentMeta.php =================================================================== --- poc/src/OpenDocumentMeta.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocumentMeta.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,15 +2,15 @@ /** * OpenDocumentMeta Class * - * @license GNU General Public License + * $Id$ + * + * @license GNU General Public License * @copyright Copyright © 2006, Norman Markgraf, et al. * @author Norman Markgraf <nma...@us...> * @version $Revision$ * @package OpenDocument * * @since 0.3.0 - * - * $Id$ */ class OpenDocumentMeta extends OpenDocumentObjectAbstract { Modified: poc/src/OpenDocumentMetaTest.php =================================================================== --- poc/src/OpenDocumentMetaTest.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocumentMetaTest.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,13 +2,14 @@ /** * Test class for OpenDocumentMeta * - * @copyright GNU General Public License - * @author Norman Markgraf <nma...@us...> - * @version $Revision$ - * @package OpenDocument + * $Id$ + * + * @copyright GNU General Public License + * @author Norman Markgraf <nma...@us...> + * @version $Revision$ + * @package OpenDocument * @subpackage UnitTest - * - * $Id$ + * @since 0.4.0 */ require_once "PHPUnit2/Framework/TestCase.php"; require_once "OpenDocumentMeta.php"; Modified: poc/src/OpenDocumentObjectAbstract.php =================================================================== --- poc/src/OpenDocumentObjectAbstract.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocumentObjectAbstract.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,15 +2,14 @@ /** * OpenDocumentObjectAbstract Class * + * $Id$ + * * @license GNU General Public License * @copyright Copyright © 2006, Norman Markgraf, et al. * @author Norman Markgraf <nma...@us...> * @version $Revision$ * @package OpenDocument - * - * @since 0.4.0 - * - * $Id$ + * @since 0.4.0 */ class OpenDocumentObjectAbstract extends OpenDocumentAbstract { Modified: poc/src/OpenDocumentOutput.php =================================================================== --- poc/src/OpenDocumentOutput.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocumentOutput.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,14 +2,14 @@ /** * SampleClass produces a little OpenDocument and send it to the client * + * $Id$ + * * @copyright GNU General Public License * @author Norman Markgraf <nma...@us...> * @author Alex Latchford <yaw...@us...> * @version $Revision$ * @package OpenDocument * @since 0.4.2 - * - * $Id$ */ ini_set( "include_path", ini_get( "include_path" ). ";..\\" ); Modified: poc/src/OpenDocumentPackage.php =================================================================== --- poc/src/OpenDocumentPackage.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocumentPackage.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,12 +2,13 @@ /** * OpenDocumentPackage Class * + * $Id$ + * * @copyright GNU General Public License * @author Norman Markgraf <nma...@us...> * @version $Revision$ * @package OpenDocument - * - * $Id$ + * @since 0.4.0 */ class OpenDocumentPackage extends OpenDocumentAbstract implements OpenDocument { @@ -20,9 +21,11 @@ public $tmp = "c:/TEMP/"; public $path = ""; - /** - * - */ + /** + * + * @access public + * @since 0.4.0 + */ public function __construct( $documentName=0, $documentPath=0, $mimetype="application/vnd.oasis.opendocument.text" ) { parent::__construct( $mimetype ); @@ -43,9 +46,11 @@ } } - /** - * - */ + /** + * + * @access public + * @since 0.4.0 + */ public function __destruct() { $this->logger->debug( "Destructing OpenDocumentPackage." ); $this->removeTmpPackage(); @@ -61,16 +66,20 @@ parent::__destruct(); } - /** - * - */ + /** + * + * @access public + * @since 0.4.0 + */ public function createPackage() { //$this->compartibility->makeDir( $this->packagetmp ); } - /** - * - */ + /** + * + * @access private + * @since 0.4.0 + */ private function writeDOMToPackage( $fullpath, $dom ) { //$dom->save( str_replace( "\\", "/", $this->packagetmp . $fullpath) ); $tmp = str_replace( "\\", "/", $fullpath ); @@ -81,9 +90,11 @@ unset( $tmp ); } - /** - * - */ + /** + * + * @access public + * @since 0.4.0 + */ public function writeZIPFile( $data, $alt=0 ) { if (empty($alt)) { $tmp = $this->path . $this->packagename; @@ -104,23 +115,31 @@ unset( $tmp ); } - /** - * - */ + /** + * + * @access private + * @depricated + * @since 0.4.0 + */ private function removeTmpPackage() { // $this->compartibility->removeDir( $this->packagetmp ); } - /** - * - */ + /** + * + * @access private + * @depricated + * @since 0.4.0 + */ private function makeSubDir( $path ) { //$this->compartibility->makeDir( $this->packagetmp . $this->compartibility->sep . $path ); } - /** - * - */ + /** + * + * @access public + * @since 0.4.0 + */ public function setPackageName( $filename ) { global $logger; $this->logger->debug( "OpenDocumentPackage->setPackageName(" . $filename . ")." ); @@ -130,34 +149,42 @@ $this->logger->debug( "OpenDocumentPackage->set packagetmp to \"" . $this->packagetmp . "\" ..." ); } - /** - * - */ + /** + * + * @access public + * @since 0.4.0 + */ public function getPackageName() { return $this->packagename; } - /** - * - */ + /** + * + * @access public + * @since 0.4.0 + */ public function addManifest( $manifest ) { $this->logger->debug( "OpenDocumentPackage->addManifest(...)." ); $this->manifest = $manifest; } - /** - * - */ + /** + * + * @access public + * @since 0.4.0 + */ public function addImage( $fullpath, $origimage, $mimetype ) { $this->copyFileToPackage( $origimage, $fullpath ); $this->makeSubDir( "Pictures" ); $this->manifest->addEntryToManifest( $fullpath, $mimetype ); } - /** - * - */ + /** + * + * @access public + * @since 0.4.0 + */ public function addXMLDocument( $fullpath, $dom, $mimetype="text/xml" ) { $this->logger->info( "OpenDocumentPackage->addXMLDocument(" . $fullpath . ") with mimetype '" . $mimetype . "' to package '". $this->packagetmp . "'" ); @@ -165,6 +192,11 @@ $this->writeDOMToPackage( $fullpath, $dom ); } + /** + * + * @access private + * @since 0.4.0 + */ private function commit() { $this->logger->debug( "OpenDocumentPackage->commit()." ); foreach($this->DocumentObjects as $key => $docObj) { @@ -195,6 +227,11 @@ $this->isCommited = true; } + /** + * + * @access public + * @since 0.4.0 + */ public function get() { if (!($this->isCommited)) { $this->commit(); @@ -203,10 +240,20 @@ return $this->zip->file(); } + /** + * + * @access public + * @since 0.4.0 + */ public function save( $altFilename=0 ) { $this->writeZIPFile( $this->get() ); } + /** + * + * @access public + * @since 0.4.0 + */ public function getMeta() { if (!array_key_exists ( "meta", $this->DocumentObjects) ) { $this->DocumentObjects[ "meta" ] = new OpenDocumentMeta(); @@ -214,6 +261,11 @@ return $this->DocumentObjects[ "meta" ]; } + /** + * + * @access public + * @since 0.4.0 + */ public function getContent() { if (!array_key_exists ( "content", $this->DocumentObjects) ) { $this->DocumentObjects[ "content" ] = new OpenDocumentContent(); @@ -221,6 +273,11 @@ return $this->DocumentObjects[ "content" ]; } + /** + * + * @access public + * @since 0.4.0 + */ public function getStyle() { if (!array_key_exists ( "style", $this->DocumentObjects) ) { $this->DocumentObjects[ "style" ] = new OpenDocumentStyle(); Modified: poc/src/OpenDocumentSingle.php =================================================================== --- poc/src/OpenDocumentSingle.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocumentSingle.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,6 +2,8 @@ /** * OpenDocumentSingle Class * + * $Id$ + * * @license GNU General Public License * @copyright Copyright © 2006, Norman Markgraf, et al. * @author Norman Markgraf <nma...@us...> @@ -9,8 +11,6 @@ * @package OpenDocument * * @since 0.3.0 - * - * $Id$ */ class OpenDocumentSingle extends OpenDocumentAbstract implements OpenDocument { Modified: poc/src/OpenDocumentStyle.php =================================================================== --- poc/src/OpenDocumentStyle.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/OpenDocumentStyle.php 2006-03-13 11:06:19 UTC (rev 23) @@ -1,6 +1,8 @@ <?php /** * OpenDocumentStyle Class + * + * $Id$ * * @license GNU General Public License * @copyright Copyright © 2006, Norman Markgraf et al. @@ -9,8 +11,6 @@ * @package OpenDocument * * @since 0.4.0 - * - * $Id$ */ //require_once( "styles/FontFaceDecl.php" ); Modified: poc/src/samples/TestInput.php =================================================================== --- poc/src/samples/TestInput.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/samples/TestInput.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,14 +2,16 @@ /** * SampleClass produces a little OpenDocument and send it to the client * - * @copyright GNU General Public License - * @author Norman Markgraf <nma...@us...> - * @author Alex Latchford <yaw...@us...> - * @version $Revision$ - * @package OpenDocument/input - * @since 0.4.2 + * $Id$ * - * $Id$ + * @copyright Copyright © 2006, Norman Markgraf, Alex Latchford, et al. + * @licens GNU General Public License + * @author Norman Markgraf <nma...@us...> + * @author Alex Latchford <yaw...@us...> + * @version $Revision$ + * @package OpenDocument + * @subpackage samples + * @since 0.4.2 */ ?> <html> Modified: poc/src/samples/TestOutput.php =================================================================== --- poc/src/samples/TestOutput.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/samples/TestOutput.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,14 +2,16 @@ /** * SampleClass produces a little OpenDocument and send it to the client * - * @copyright GNU General Public License - * @author Norman Markgraf <nma...@us...> - * @author Alex Latchford <yan...@us...> - * @version $Revision$ - * @package OpenDocument/Samples - * @since 0.4.2 + * $Id$ * - * $Id$ + * @license GNU General Public License + * @copyright Copyright © 2006, Norman Markgraf, Alex Latchford, et al. + * @author Norman Markgraf <nma...@us...> + * @author Alex Latchford <yan...@us...> + * @version $Revision$ + * @package OpenDocument + * @subpackage samples + * @since 0.4.2 */ ini_set( "include_path", ini_get( "include_path" ). ";..\\;..\\styles" ); Modified: poc/src/samples/TestTranslate.php =================================================================== --- poc/src/samples/TestTranslate.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/samples/TestTranslate.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,13 +2,15 @@ /** * TestTranslate class that will translate a given formatting style to ODF formatting. * - * @copyright GNU General Public License - * @author Alex Latchford <yaw...@us...> - * @version $Revision$ - * @package OpenDocument/input - * @since 0.4.2 + * $Id$ * - * $Id$ + * @license GNU General Public License + * @copyright Copyright © 2006, Norman Markgraf, Alex Latchford, et al. + * @author Alex Latchford <yaw...@us...> + * @version $Revision$ + * @package OpenDocument + * @subpackage samles + * @since 0.4.2 */ require_once( "Log/observer.php" ); Modified: poc/src/styles/FontFaceDeclaration.php =================================================================== --- poc/src/styles/FontFaceDeclaration.php 2006-03-13 10:27:58 UTC (rev 22) +++ poc/src/styles/FontFaceDeclaration.php 2006-03-13 11:06:19 UTC (rev 23) @@ -2,15 +2,16 @@ /** * FontFaceDeclaration Class * + * $Id$ + * * @license GNU General Public License * @copyright Copyright © 2006, Norman Markgraf * @author Norman Markgraf <nma...@us...> * @version $Revision$ * @package OpenDocument + * @subpackage styles * - * @since 0.4.2 - * - * $Id$ + * @since 0.4.2 */ class FontFaceDeclaration extends OpenDocumentObjectAbstract { @@ -121,7 +122,7 @@ /** * * @access public - * + * @depricated * @since 0.4.2 */ public function addFontFaceOld( $name, $fontFamily, $genericFamily=0, $fontPitch=0, $fontCharset=0 ) { This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
