EXTMVC:
authorJochen Rau <j.rau@web.de>
Mon, 23 Mar 2009 14:48:46 +0000 (14:48 +0000)
committerJochen Rau <j.rau@web.de>
Mon, 23 Mar 2009 14:48:46 +0000 (14:48 +0000)
* Added comments to the ObjectStorage
* Removed Query related files

typo3/sysext/extbase/Classes/Controller/TX_EXTMVC_Controller_Argument.php
typo3/sysext/extbase/Classes/Persistence/TX_EXTMVC_Persistence_ObjectStorage.php
typo3/sysext/extbase/Classes/Persistence/TX_EXTMVC_Persistence_QueryFactoryInterface.php [deleted file]
typo3/sysext/extbase/Classes/Persistence/TX_EXTMVC_Persistence_QueryInterface.php [deleted file]

index cb8eb2a..e615142 100644 (file)
@@ -84,6 +84,7 @@ class TX_EXTMVC_Controller_Argument {
         * The property validator for this arguments datatype
         * @var TX_EXTMVC_Validation_Validator_ValidatorInterface
         */
+       // TODO Remove DatatypeValidator
        protected $datatypeValidator = NULL;
 
        /**
index e750ccb..3574dc9 100644 (file)
@@ -24,7 +24,7 @@
 
 /**
  * The storage for objects. It ensures the uniqueness of an object in the storage. It's a remake of the
- * SplObjectStorage introduced in a usable version in PHP 5.3.
+ * SplObjectStorage introduced in PHP 5.3.
  *
  * @package TYPO3
  * @subpackage extmvc
 class TX_EXTMVC_Persistence_ObjectStorage implements Iterator, Countable, ArrayAccess {
 // SK: Why not use SplObjectStorage?
 // JR: SplObjectStorage isn't fully implemented in PHP 5.2.x
+
        /**
-        * The array holding references to the stored objects.
+        * The array holding references of the stored objects
         *
-        * @var string
+        * @var array
         */
        private $storage = array();
 
+       /**
+        * Resets the array pointer of the storage
+        *
+        * @return void
+        */
        public function rewind() {
                reset($this->storage);
        }
 
+       /**
+        * Checks if the array pointer of the storage points to a valid position
+        *
+        * @return void
+        */
        public function valid() {
                return $this->current() !== FALSE;
        }
 
+       /**
+        * Returns the current key storage array
+        *
+        * @return void
+        */
        public function key() {
                return key($this->storage);
        }
 
+       /**
+        * Returns the current value of the storage array
+        *
+        * @return void
+        */
        public function current() {
                return current($this->storage);
        }
 
+       /**
+        * Returns the next position of the storage array
+        *
+        * @return void
+        */
        public function next() {
                next($this->storage);
        }
 
+       /**
+        * Counts the elements in the storage array
+        *
+        * @return void
+        */
        public function count() {
                return count($this->storage);
        }
 
+       /**
+        * Loads the array at a given offset. Nothing happens if the object already exists in the storage 
+        *
+        * @param string $offset 
+        * @param string $obj The object
+        * @return void
+        */
        public function offsetSet($offset, $obj) {
                if (is_object($obj) && !$this->contains($obj)) {
                        $this->storage[$offset] = $obj;
                }
        }
 
+       /**
+        * Checks if a given offset exists in the storage
+        *
+        * @param string $offset 
+        * @return boolean TRUE if the given offset exists; otherwise FALSE
+        */
        public function offsetExists($offset) {
                return isset($this->storage[$offset]);
        }
 
+       /**
+        * Unsets the storage at the given offset
+        *
+        * @param string $offset The offset
+        * @return void
+        */
        public function offsetUnset($offset) {
                unset($this->storage[$offset]);
        }
 
+       /**
+        * Returns the object at the given offset
+        *
+        * @param string $offset The offset
+        * @return Object The object
+        */
        public function offsetGet($offset) {
                return isset($this->storage[$offset]) ? $this->storage[$offset] : NULL;
        }
 
        /**
-        * Does the Storage contains the given object
+        * Checks if the storage contains the given object
         *
-        * @param Object $obj
-        * @return boolean TRUE|FALSE The result TRUE if the Storage contains the object; the result FALSE if not
+        * @param Object $obj The object to be checked for
+        * @return boolean TRUE|FALSE Returns TRUE if the storage contains the object; otherwise FALSE
         */
        public function contains($obj) {
                if (is_object($obj)) {
@@ -100,7 +156,7 @@ class TX_EXTMVC_Persistence_ObjectStorage implements Iterator, Countable, ArrayA
        /**
         * Attaches an object to the storage
         *
-        * @param Object $obj
+        * @param Object $obj The Object to be attached
         * @return void
         */
        public function attach($obj) {
@@ -112,7 +168,7 @@ class TX_EXTMVC_Persistence_ObjectStorage implements Iterator, Countable, ArrayA
        /**
         * Detaches an object to the storage
         *
-        * @param Object $obj
+        * @param Object $obj The object to be removed from the storage
         * @return void
         */
        public function detach($obj) {
diff --git a/typo3/sysext/extbase/Classes/Persistence/TX_EXTMVC_Persistence_QueryFactoryInterface.php b/typo3/sysext/extbase/Classes/Persistence/TX_EXTMVC_Persistence_QueryFactoryInterface.php
deleted file mode 100644 (file)
index 9dd50a7..0000000
+++ /dev/null
@@ -1,44 +0,0 @@
-<?php
-/***************************************************************
-*  Copyright notice
-*
-*  (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
-*  All rights reserved
-*
-*  This script is part of the TYPO3 project. The TYPO3 project is
-*  free software; you can redistribute it and/or modify
-*  it under the terms of the GNU General Public License as published by
-*  the Free Software Foundation; either version 2 of the License, or
-*  (at your option) any later version.
-*
-*  The GNU General Public License can be found at
-*  http://www.gnu.org/copyleft/gpl.html.
-*
-*  This script is distributed in the hope that it will be useful,
-*  but WITHOUT ANY WARRANTY; without even the implied warranty of
-*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-*  GNU General Public License for more details.
-*
-*  This copyright notice MUST APPEAR in all copies of the script!
-***************************************************************/
-
-/**
- * A persistence query factory interface
- *
- * @package TYPO3
- * @subpackage extmvc
- * @version $ID:$
- */
-// TODO Do we want to have this class? - If not: remove.
-interface QueryFactoryInterface {
-
-       /**
-        * Creates a query object working on the given class name
-        *
-        * @param string $className
-        * @return F3_FLOW_Persistence_QueryInterface
-        */
-       public function create($className);
-
-}
-?>
\ No newline at end of file
diff --git a/typo3/sysext/extbase/Classes/Persistence/TX_EXTMVC_Persistence_QueryInterface.php b/typo3/sysext/extbase/Classes/Persistence/TX_EXTMVC_Persistence_QueryInterface.php
deleted file mode 100644 (file)
index 3bc8da7..0000000
+++ /dev/null
@@ -1,105 +0,0 @@
-<?php
-/***************************************************************
-*  Copyright notice
-*
-*  (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
-*  All rights reserved
-*
-*  This script is part of the TYPO3 project. The TYPO3 project is
-*  free software; you can redistribute it and/or modify
-*  it under the terms of the GNU General Public License as published by
-*  the Free Software Foundation; either version 2 of the License, or
-*  (at your option) any later version.
-*
-*  The GNU General Public License can be found at
-*  http://www.gnu.org/copyleft/gpl.html.
-*
-*  This script is distributed in the hope that it will be useful,
-*  but WITHOUT ANY WARRANTY; without even the implied warranty of
-*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-*  GNU General Public License for more details.
-*
-*  This copyright notice MUST APPEAR in all copies of the script!
-***************************************************************/
-
-/**
- * A persistence query interface
- *
- * @package TYPO3
- * @subpackage extmvc
- * @version $ID:$
- */
-// TODO Do we want to have this class? - If not: remove.
-interface QueryInterface {
-
-       /**
-        * Executes the query against the backend and returns the result
-        *
-        * @return array The query result, an array of objects
-        */
-       public function execute();
-
-       /**
-        * The constraint used to limit the result set
-        *
-        * @param mixed $constraint Some constraint, depending on the backend
-        * @return TX_EXTMVC_Persistence_QueryInterface
-        */
-       public function matching($constraint);
-
-       /**
-        * Returns an equals criterion used for matching objects against a query
-        *
-        * @param string $property The name of the property to compare against
-        * @param mixed $operand The value to compare with
-        * @return TX_EXTMVC_Persistence_OperatorInterface
-        */
-       public function equals($property, $operand);
-
-       /**
-        * Returns a like criterion used for matching objects against a query
-        *
-        * @param string $property The name of the property to compare against
-        * @param mixed $operand The value to compare with
-        * @return TX_EXTMVC_Persistence_OperatorInterface
-        */
-       public function like($property, $operand);
-
-       /**
-        * Returns a less than criterion used for matching objects against a query
-        *
-        * @param string $property The name of the property to compare against
-        * @param mixed $operand The value to compare with
-        * @return TX_EXTMVC_Persistence_OperatorInterface
-        */
-       public function lessThan($property, $operand);
-
-       /**
-        * Returns a less or equal than criterion used for matching objects against a query
-        *
-        * @param string $property The name of the property to compare against
-        * @param mixed $operand The value to compare with
-        * @return TX_EXTMVC_Persistence_OperatorInterface
-        */
-       public function lessThanOrEqual($property, $operand);
-
-       /**
-        * Returns a greater than criterion used for matching objects against a query
-        *
-        * @param string $property The name of the property to compare against
-        * @param mixed $operand The value to compare with
-        * @return TX_EXTMVC_Persistence_OperatorInterface
-        */
-       public function greaterThan($property, $operand);
-
-       /**
-        * Returns a greater than or equal criterion used for matching objects against a query
-        *
-        * @param string $property The name of the property to compare against
-        * @param mixed $operand The value to compare with
-        * @return TX_EXTMVC_Persistence_OperatorInterface
-        */
-       public function greaterThanOrEqual($property, $operand);
-
-}
-?>
\ No newline at end of file