New fetch function to access eZSiteData in templates (#35)

* New fetch function to access eZSiteData in templates

* Code formatting

* Fixing spacing

Author: pkamps

kernel/classes/ezsitedata.php

@@ -49,7 +49,7 @@ public static function definition()
      * Constructs a new eZSiteData instance. You need to call 'store()'
      * in order to store it into the DB.
      *
-     * @param string $key
+     * @param string $name
      * @param string $value
      * @return eZSiteData
      */
@@ -63,14 +63,13 @@ public static function create( $name, $value )
 
     /**
      * Fetches a site data by name
-	 *
+     *
      * @param string $name
-     * @return eZPersistentObject
+     * @return eZSiteData
      */
     public static function fetchByName( $name )
     {
-        $result = parent::fetchObject( self::definition(), null, array( 'name' => $name ) );
-        return $result;
+        return parent::fetchObject( self::definition(), null, array( 'name' => $name ) );
     }
 
 }

kernel/content/ezcontentfunctioncollection.php

@@ -1534,6 +1534,17 @@ static public function fetchContentTreeMenuExpiry()
 
         return array( 'result' => $expiryHandler->timestamp( 'content-tree-menu' ) );
     }
+
+    /**
+     * Fetches an eZSiteData instance if it exists in the database.
+     *
+     * @param string $name
+     * @return array
+     */
+    static public function fetchSiteData( $name )
+    {
+        return array( 'result' => eZSiteData::fetchByName( $name ) );
+    }
 }
 
 ?>

kernel/content/function_definition.php

@@ -1222,4 +1222,13 @@
                                                    'parameter_type' => 'standard',
                                                    'parameters' => array() );
 
+$FunctionList['site_data'] = array( 'name' => 'site_data',
+                                    'operation_types' => array( 'read' ),
+                                    'call_method' => array( 'class' => 'eZContentFunctionCollection',
+                                                            'method' => 'fetchSiteData' ),
+                                    'parameter_type' => 'standard',
+                                    'parameters' => array( array( 'name' => 'name',
+                                                                  'type' => 'string',
+                                                                  'required' => true ) ) );
+
 ?>