* Adding API annotations to classes
authorSebastian Kurfürst <sebastian@typo3.org>
Sat, 24 Oct 2009 10:49:41 +0000 (10:49 +0000)
committerSebastian Kurfürst <sebastian@typo3.org>
Sat, 24 Oct 2009 10:49:41 +0000 (10:49 +0000)
32 files changed:
typo3/sysext/extbase/Classes/Domain/Model/FrontendUser.php
typo3/sysext/extbase/Classes/Domain/Model/FrontendUserGroup.php
typo3/sysext/extbase/Classes/Error/Error.php
typo3/sysext/extbase/Classes/MVC/Controller/AbstractController.php
typo3/sysext/extbase/Classes/MVC/Controller/ActionController.php
typo3/sysext/extbase/Classes/MVC/Controller/Argument.php
typo3/sysext/extbase/Classes/MVC/Controller/ControllerContext.php
typo3/sysext/extbase/Classes/MVC/Controller/ControllerInterface.php
typo3/sysext/extbase/Classes/MVC/Controller/FlashMessages.php
typo3/sysext/extbase/Classes/MVC/Request.php
typo3/sysext/extbase/Classes/MVC/RequestInterface.php
typo3/sysext/extbase/Classes/MVC/Response.php
typo3/sysext/extbase/Classes/MVC/ResponseInterface.php
typo3/sysext/extbase/Classes/MVC/View/AbstractView.php
typo3/sysext/extbase/Classes/MVC/View/ViewInterface.php
typo3/sysext/extbase/Classes/MVC/Web/Request.php
typo3/sysext/extbase/Classes/MVC/Web/Response.php
typo3/sysext/extbase/Classes/MVC/Web/Routing/UriBuilder.php
typo3/sysext/extbase/Classes/Persistence/Manager.php
typo3/sysext/extbase/Classes/Persistence/ManagerInterface.php
typo3/sysext/extbase/Classes/Persistence/QOM/SelectorInterface.php
typo3/sysext/extbase/Classes/Persistence/Query.php
typo3/sysext/extbase/Classes/Persistence/QueryInterface.php
typo3/sysext/extbase/Classes/Persistence/Repository.php
typo3/sysext/extbase/Classes/Persistence/RepositoryInterface.php
typo3/sysext/extbase/Classes/Persistence/Typo3QuerySettings.php
typo3/sysext/extbase/Classes/Persistence/Typo3QuerySettingsInterface.php
typo3/sysext/extbase/Classes/Property/Mapper.php
typo3/sysext/extbase/Classes/Reflection/Service.php
typo3/sysext/extbase/Classes/Utility/Arrays.php
typo3/sysext/extbase/Classes/Utility/TypoScript.php
typo3/sysext/extbase/Resources/Scripts/RenderDocumentation.php [deleted file]

index b08a63e..5ec9938 100644 (file)
@@ -30,6 +30,7 @@
  * @version $Id: $
  * @scope prototype
  * @entity
+ * @api
  */
 class Tx_Extbase_Domain_Model_FrontendUser extends Tx_Extbase_DomainObject_AbstractEntity {
 
index b60a6f5..bad95fd 100644 (file)
@@ -30,6 +30,7 @@
  * @version $Id: $
  * @scope prototype
  * @entity
+ * @api
  */
 class Tx_Extbase_Domain_Model_FrontendUserGroup extends Tx_Extbase_DomainObject_AbstractEntity {
 
index 0a41b33..038dde6 100644 (file)
@@ -33,6 +33,7 @@
  * @version $Id: Error.php 2813 2009-07-16 14:02:34Z k-fish $
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @scope prototype
+ * @api
  */
 class Tx_Extbase_Error_Error {
 
index 1c19ab8..062cb86 100644 (file)
@@ -31,6 +31,7 @@
  * @package Extbase
  * @subpackage MVC\Controller
  * @version $ID:$
+ * @api
  */
 abstract class Tx_Extbase_MVC_Controller_AbstractController implements Tx_Extbase_MVC_Controller_ControllerInterface {
 
@@ -118,7 +119,7 @@ abstract class Tx_Extbase_MVC_Controller_AbstractController implements Tx_Extbas
                $this->initializeObjects();
                list(, $this->extensionName) = explode('_', get_class($this));
        }
-       
+
        /**
         * Initializes objects this class depends on
         *
index 05a989c..19c0675 100644 (file)
@@ -31,6 +31,7 @@
  * @package Extbase
  * @subpackage MVC\Controller
  * @version $ID:$
+ * @api
  */
 class Tx_Extbase_MVC_Controller_ActionController extends Tx_Extbase_MVC_Controller_AbstractController {
 
index a47ef90..ff4cae2 100644 (file)
@@ -32,6 +32,7 @@
  * @subpackage MVC\Controller
  * @version $ID:$
  * @scope prototype
+ * @api
  */
 class Tx_Extbase_MVC_Controller_Argument {
 
@@ -131,7 +132,7 @@ class Tx_Extbase_MVC_Controller_Argument {
                $this->name = $name;
                $this->dataType = $dataType;
        }
-       
+
        /**
         * Initializes this object
         *
index db1baf1..d4bb0ff 100644 (file)
@@ -33,6 +33,7 @@
  * @version $Id: AbstractController.php 2203 2009-05-12 18:44:47Z networkteam_hlubek $
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @scope prototype
+ * @api
  */
 class Tx_Extbase_MVC_Controller_ControllerContext {
 
index f53eb5c..d4bd200 100644 (file)
@@ -31,6 +31,7 @@
  * @package Extbase
  * @subpackage MVC\Controller
  * @version $ID:$
+ * @api
  */
 interface Tx_Extbase_MVC_Controller_ControllerInterface {
 
index 03709a5..f0299f5 100644 (file)
@@ -33,6 +33,7 @@
  * @version $Id$
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @scope session
+ * @api
  */
 class Tx_Extbase_MVC_Controller_FlashMessages implements t3lib_Singleton {
 
index 4ba0c25..6a3fa7d 100644 (file)
@@ -32,6 +32,7 @@
  * @subpackage MVC
  * @version $ID:$
  * @scope prototype
+ * @api
  */
 class Tx_Extbase_MVC_Request implements Tx_Extbase_MVC_RequestInterface {
 
@@ -83,7 +84,7 @@ class Tx_Extbase_MVC_Request implements Tx_Extbase_MVC_RequestInterface {
         * @var array Errors that occured during this request
         */
        protected $errors = array();
-       
+
        /**
         * Sets the dispatched flag
         *
index f7059bf..edc2fe5 100644 (file)
@@ -32,6 +32,7 @@
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @author Robert Lemke <robert@typo3.org>
  * @scope prototype
+ * @api
  */
 interface Tx_Extbase_MVC_RequestInterface {
 
@@ -80,7 +81,7 @@ interface Tx_Extbase_MVC_RequestInterface {
         * Returns the extension name of the specified controller.
         *
         * @return string The package key
-        * @api 
+        * @api
         */
        public function getControllerExtensionName();
 
index be6eeb3..04a10a1 100644 (file)
@@ -32,6 +32,7 @@
  * @subpackage MVC
  * @version $ID:$
  * @scope prototype
+ * @api
  */
 class Tx_Extbase_MVC_Response {
 
index 2fb0636..0bad832 100644 (file)
@@ -32,6 +32,7 @@
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @author Robert Lemke <robert@typo3.org>
  * @scope prototype
+ * @api
  */
 interface Tx_Extbase_MVC_ResponseInterface {
 
index 2969b8d..701c7d8 100755 (executable)
@@ -31,6 +31,7 @@
  * @package Extbase
  * @subpackage MVC\View
  * @version $ID:$
+ * @api
  */
 abstract class Tx_Extbase_MVC_View_AbstractView implements Tx_Extbase_MVC_View_ViewInterface {
 
index f0dbecb..e33e02a 100644 (file)
@@ -31,6 +31,7 @@
  * @package Extbase
  * @subpackage MVC\View
  * @version $ID:$
+ * @api
  */
 interface Tx_Extbase_MVC_View_ViewInterface {
 
index 46ed89c..79295e2 100755 (executable)
@@ -33,6 +33,7 @@
  * @version $ID:$
  *
  * @scope prototype
+ * @api
  */
 class Tx_Extbase_MVC_Web_Request extends Tx_Extbase_MVC_Request {
 
index 1a6e114..25c8a06 100755 (executable)
@@ -32,6 +32,7 @@
  * @subpackage MVC\Web
  * @version $ID:$
  * @scope prototype
+ * @api
  */
 class Tx_Extbase_MVC_Web_Response extends Tx_Extbase_MVC_Response {
 
index 211ee7f..4389d61 100644 (file)
@@ -18,6 +18,7 @@
  * @package Extbase
  * @subpackage MVC\Web\Routing
  * @version $Id$
+ * @api
  */
 class Tx_Extbase_MVC_Web_Routing_UriBuilder {
 
index 49f36d2..fbf4b51 100644 (file)
@@ -31,7 +31,7 @@
  * @package Extbase
  * @subpackage Persistence
  * @version $Id: Manager.php 2293 2009-05-20 18:14:45Z robert $
- *
+ * @api
  */
 class Tx_Extbase_Persistence_Manager implements Tx_Extbase_Persistence_ManagerInterface, t3lib_Singleton {
 
@@ -79,7 +79,7 @@ class Tx_Extbase_Persistence_Manager implements Tx_Extbase_Persistence_ManagerIn
        public function injectSession(Tx_Extbase_Persistence_Session $session) {
                $this->session = $session;
        }
-       
+
        /**
         * Injects the object manager
         *
@@ -108,7 +108,7 @@ class Tx_Extbase_Persistence_Manager implements Tx_Extbase_Persistence_ManagerIn
        public function getBackend() {
                return $this->backend;
        }
-       
+
        /**
         * Registers a repository
         *
@@ -163,6 +163,6 @@ class Tx_Extbase_Persistence_Manager implements Tx_Extbase_Persistence_ManagerIn
                        $this->session->unregisterReconstitutedObject($removedObject);
                }
        }
-               
+
 }
 ?>
\ No newline at end of file
index fc4a787..856077c 100644 (file)
@@ -31,6 +31,7 @@
  * @package Extbase
  * @subpackage Persistence
  * @version $Id: ManagerInterface.php 2293 2009-05-20 18:14:45Z robert $
+ * @api
  */
 interface Tx_Extbase_Persistence_ManagerInterface {
 
index a20ecd2..b29a251 100644 (file)
@@ -46,7 +46,6 @@ interface Tx_Extbase_Persistence_QOM_SelectorInterface extends Tx_Extbase_Persis
         * Gets the name of the required node type.
         *
         * @return string the node type name; non-null
-        * @api
         */
        public function getNodeTypeName();
 
@@ -55,10 +54,9 @@ interface Tx_Extbase_Persistence_QOM_SelectorInterface extends Tx_Extbase_Persis
         * A selector's name can be used elsewhere in the query to identify the selector.
         *
         * @return the selector name; non-null
-        * @api
         */
        public function getSelectorName();
-       
+
 }
 
 ?>
\ No newline at end of file
index f4d4336..12f8c4c 100644 (file)
@@ -32,6 +32,7 @@
  * @subpackage Persistence
  * @version $Id: Query.php 658 2009-05-16 13:54:16Z jocrau $
  * @scope prototype
+ * @api
  */
 class Tx_Extbase_Persistence_Query implements Tx_Extbase_Persistence_QueryInterface, Tx_Extbase_Persistence_QuerySettingsInterface {
 
@@ -95,14 +96,14 @@ class Tx_Extbase_Persistence_Query implements Tx_Extbase_Persistence_QueryInterf
         * @var int
         */
        protected $offset;
-       
+
        /**
         * The query settings.
-        * 
+        *
         * @var Tx_Extbase_Persistence_QuerySettingsInterface
         */
        protected $querySettings;
-       
+
        /**
         * Constructs a query object working on the given class name
         *
@@ -133,11 +134,11 @@ class Tx_Extbase_Persistence_Query implements Tx_Extbase_Persistence_QueryInterf
        public function injectDataMapper(Tx_Extbase_Persistence_Mapper_DataMapper $dataMapper) {
                $this->dataMapper = $dataMapper;
        }
-       
+
        /**
-        * Sets the Query Settings. These Query settings must match the settings expected by 
+        * Sets the Query Settings. These Query settings must match the settings expected by
         * the specific Storage Backend.
-        * 
+        *
         * @param Tx_Extbase_Persistence_QuerySettingsInterface $querySettings The Query Settings
         * @return void
         */
@@ -147,14 +148,14 @@ class Tx_Extbase_Persistence_Query implements Tx_Extbase_Persistence_QueryInterf
 
        /**
         * Returns the Query Settings.
-        * 
+        *
         * @return Tx_Extbase_Persistence_QuerySettingsInterface $querySettings The Query Settings
         * @api
         */
        public function getQuerySettings() {
                return $this->querySettings;
        }
-       
+
        /**
         * Returns the class name the query handles
         *
@@ -197,14 +198,14 @@ class Tx_Extbase_Persistence_Query implements Tx_Extbase_Persistence_QueryInterf
                                $this->orderings,
                                $this->columns // TODO implement selection of columns
                        );
-                                       
+
                        if ($this->limit !== NULL) {
                                $query->setLimit($this->limit);
                        }
                        if ($this->offset !== NULL) {
-                               $query->setOffset($this->offset);       
+                               $query->setOffset($this->offset);
                        }
-                       
+
                }
 
                foreach ($this->operands as $name => $value) {
@@ -291,7 +292,7 @@ class Tx_Extbase_Persistence_Query implements Tx_Extbase_Persistence_QueryInterf
         *
         * @param string $statement The statement
         * @param array $paramerters An array of parameters. These will be bound to placeholders '?' in the $statement.
-        * @param object $language The language of the statement. Must be a supported languanguage defined as Tx_Extbase_Persistence_QOM_QueryObjectModelInterface::JCR_* or Tx_Extbase_Persistence_QOM_QueryObjectModelInterface::TYPO3_* or 
+        * @param object $language The language of the statement. Must be a supported languanguage defined as Tx_Extbase_Persistence_QOM_QueryObjectModelInterface::JCR_* or Tx_Extbase_Persistence_QOM_QueryObjectModelInterface::TYPO3_* or
         * @return Tx_Extbase_Persistence_QOM_StatementInterface
         */
        public function statement($statement, array $parameters = array(), $language = Tx_Extbase_Persistence_QOM_QueryObjectModelInterface::TYPO3_SQL_MYSQL) {
@@ -485,18 +486,18 @@ class Tx_Extbase_Persistence_Query implements Tx_Extbase_Persistence_QueryInterf
                        $this->QOMFactory->bindVariable($uniqueVariableName)
                        );
        }
-       
+
        /**
         * Returns a unique variable name for a given property name. This is necessary for storing
         * the variable values in an associative array without overwriting existing variables.
-        * 
+        *
         * @param string $propertyName The name of the property
         * @return string The postfixed property name
         */
        protected function getUniqueVariableName($propertyName) {
                return uniqid($propertyName);
        }
-       
+
        /**
         * Returns the selectorn name or an empty string, if the source is not a selector
         * // TODO This has to be checked at another place
index 3d7b826..7b5a37c 100644 (file)
@@ -31,6 +31,7 @@
  * @package Extbase
  * @subpackage Persistence
  * @version $Id: QueryInterface.php 658 2009-05-16 13:54:16Z jocrau $
+ * @api
  */
 interface Tx_Extbase_Persistence_QueryInterface {
 
index 7df25aa..4283ac8 100644 (file)
@@ -31,6 +31,7 @@
  * @package Extbase
  * @subpackage Persistence
  * @version $ID:$
+ * @api
  */
 class Tx_Extbase_Persistence_Repository implements Tx_Extbase_Persistence_RepositoryInterface, t3lib_Singleton {
 
@@ -132,7 +133,7 @@ class Tx_Extbase_Persistence_Repository implements Tx_Extbase_Persistence_Reposi
                if (!($newObject instanceof $this->objectType)) {
                        throw new Tx_Extbase_Persistence_Exception_IllegalObjectType('The new object given to replace was not of the type (' . $this->objectType . ') this repository manages.', 1248363439);
                }
-               
+
                $backend = $this->persistenceManager->getBackend();
                $session = $this->persistenceManager->getSession();
                $uuid = $backend->getIdentifierByObject($existingObject);
@@ -151,7 +152,7 @@ class Tx_Extbase_Persistence_Repository implements Tx_Extbase_Persistence_Reposi
                } else {
                        throw new Tx_Extbase_Persistence_Exception_UnknownObject('The "existing object" is unknown to the persistence backend.', 1238068475);
                }
-               
+
        }
 
        /**
@@ -173,7 +174,7 @@ class Tx_Extbase_Persistence_Repository implements Tx_Extbase_Persistence_Reposi
                        throw new Tx_Extbase_Persistence_Exception_UnknownObject('The "modified object" is does not have an existing counterpart in this repository.', 1249479819);
                }
        }
-       
+
        /**
         * Returns all addedObjects that have been added to this repository with add().
         *
index adf6079..ca5c29c 100644 (file)
@@ -31,6 +31,7 @@
  * @package Extbase
  * @subpackage Persistence
  * @version $ID:$
+ * @api
  */
 interface Tx_Extbase_Persistence_RepositoryInterface {
 
index acae117..126061c 100644 (file)
@@ -32,6 +32,7 @@
  * @package Extbase
  * @subpackage Persistence
  * @version $Id: QueryInterface.php 658 2009-05-16 13:54:16Z jocrau $
+ * @api
  */
 class Tx_Extbase_Persistence_Typo3QuerySettings implements Tx_Extbase_Persistence_Typo3QuerySettingsInterface {
 
index c5110d9..dd6ad69 100644 (file)
@@ -32,6 +32,7 @@
  * @package Extbase
  * @subpackage Persistence
  * @version $Id: QueryInterface.php 658 2009-05-16 13:54:16Z jocrau $
+ * @api
  */
 interface Tx_Extbase_Persistence_Typo3QuerySettingsInterface extends Tx_Extbase_Persistence_QuerySettingsInterface {
 
index 322e3aa..6872de0 100644 (file)
@@ -48,6 +48,7 @@
  * @package Extbase
  * @subpackage Property
  * @version $Id$
+ * @api
  */
 class Tx_Extbase_Property_Mapper {
 
@@ -61,7 +62,7 @@ class Tx_Extbase_Property_Mapper {
         * @var Tx_Extbase_Validation_ValidatorResolver
         */
        protected $validatorResolver;
-       
+
        /**
         * @var Tx_Extbase_Reflection_Service
         */
@@ -71,7 +72,7 @@ class Tx_Extbase_Property_Mapper {
         * @var Tx_Extbase_Persistence_ManagerInterface
         */
        protected $persistenceManager;
-       
+
        /**
         * @var Tx_Extbase_Persistence_QueryFactory
         */
@@ -97,7 +98,7 @@ class Tx_Extbase_Property_Mapper {
        public function injectReflectionService(Tx_Extbase_Reflection_Service $reflectionService) {
                $this->reflectionService = $reflectionService;
        }
-       
+
        /**
         * Maps the given properties to the target object and validates the properties according to the defined
         * validators. If the result object is not valid, the operation will be undone (the target object remains
@@ -179,7 +180,7 @@ class Tx_Extbase_Property_Mapper {
                } else {
                        $targetClassSchema = NULL;
                }
-               
+
                foreach ($propertyNames as $propertyName) {
                        $propertyValue = NULL;
                        if (is_array($source) || $source instanceof ArrayAccess) {
index e761209..170f6cf 100644 (file)
@@ -29,6 +29,7 @@
  * @package Extbase
  * @subpackage Reflection
  * @version $Id$
+ * @api
  */
 class Tx_Extbase_Reflection_Service implements t3lib_Singleton {
 
index c54a274..79c1f98 100644 (file)
@@ -32,6 +32,7 @@
  * @subpackage Utility
  * @version $Id: Arrays.php 1951 2009-03-02 10:51:15Z k-fish $
  (robert) I'm not sure yet if we should use this library statically or as a singleton. The latter might be problematic if we use it from the Core classes.
+ * @api
  */
 class Tx_Extbase_Utility_Arrays {
 
index 5a72c27..1714c75 100644 (file)
@@ -28,6 +28,7 @@
  * @package Extbase
  * @subpackage Utility
  * @version $ID:$
+ * @api
  */
 class Tx_Extbase_Utility_TypoScript {
 
@@ -38,7 +39,7 @@ class Tx_Extbase_Utility_TypoScript {
         * to be more future-proof and not to have any conflicts with Fluid object accessor syntax.
         *
         * This method performs this removal.
-        * 
+        *
         * @param array $setup The settings array
         * @return void
         * @api
diff --git a/typo3/sysext/extbase/Resources/Scripts/RenderDocumentation.php b/typo3/sysext/extbase/Resources/Scripts/RenderDocumentation.php
deleted file mode 100644 (file)
index 156c975..0000000
+++ /dev/null
@@ -1,15 +0,0 @@
-<?php
-
-// Temporary script to render documentation with PHP_UML.
-
-// The path to PHP_UML has to be adjusted by hand right now.
-require_once('/Users/sebastian/web-data/flow3/Packages/Application/DocTools/Resources/Private/PHP/PHP_UML/UML.php');
-$renderer = new PHP_UML();
-$renderer->deploymentView = FALSE;
-$renderer->structureFromDocblocks = TRUE;
-$renderer->completeAPI = FALSE;
-$renderer->setInput('../Classes');
-$renderer->parse('Extbase');
-$renderer->generateXMI(2.1, 'utf-8');
-$renderer->export('html', '../Documentation/API/');
-?>
\ No newline at end of file