Changeset 57417 for modules/sapphire/branches/roa/api/DataFormatter.php

Timestamp:

04/07/08 16:38:19 (5 months ago)

Author:

ischommer

Message:

FEATURE Added getSearchQuery(), getObjectQuery(), getObjectsQuery(), getObjectRelationQuery() to RestfulServer?
FEATURE Added $totalSize to DataFormatter? to add useful output for pagination via "limit" and "offset" parameters
API CHANGE Removed RestfulServer?->search()
API CHANGE Changed output format for convertDataObjectSet() in XMLDataFormatter and JSONDataFormatter

Files:

• modules/sapphire/branches/roa/api/DataFormatter.php (modified) (2 diffs)

modules/sapphire/branches/roa/api/DataFormatter.php

@@ -62 +62 @@
          */
         protected $outputContentType = null;
+        
+        /**
+         * Used to set totalSize properties on the output
+         * of {@link convertDataObjectSet()}, shows the
+         * total number of records without the "limit" and "offset"
+         * GET parameters. Useful to implement pagination.
+         * 
+         * @var int
+         */
+        protected $totalSize;
         
         /**
@@ -184 +194 @@
         
         /**
+         * @param int $size
+         */
+        public function setTotalSize($size) {
+                $this->totalSize = (int)$size;
+        }
+        
+        /**
+         * @return int
+         */
+        public function getTotalSize() {
+                return $this->totalSize;
+        }
+        
+        /**
          * Returns all fields on the object which should be shown
          * in the output. Can be customised through {@link self::setCustomFields()}.