Changeset 29 for php/trunk/classes/rdfa_Projection.php

Timestamp:

Jul 13, 2011, 1:33:27 PM (14 years ago)

Author:

cla

Message:

rdfint

• all classes: added missing comments on return value
• Projection::construct and rdfa::SparqlQuery: added missing comment on exceptions
• Data::parse
  • added note on merge feature
  • added code to return boolean

File:

• php/trunk/classes/rdfa_Projection.php (modified) (8 diffs)

php/trunk/classes/rdfa_Projection.php

@@ -49 +49 @@
    * Creates a Projection instance from a Data instance, reflecting a given subject in the triple data.
    *
-   * \param rdfaData     instance of Reader holding the RDF data
-   * \param subject      subject of the projection
-   * \param template     template array specifying the members to be created from data linked to the subject
+   * \param rdfaData     instance of rdfa::Data holding the graph of the subject
+   * \param subject      Subject of the projection
+   * \param template     Associative array( URI/CURIE => membername) as a template to be applied to the projection object
+   *
+   * \exception Exception The parameter rdfaData is not of object rdfa::Data
    *
    * \note A projection is to be created by the following methods only:
@@ -97 +99 @@
   /**
    * Gets properties of the subject of the projection.
-   * Returns a list of properties.
+   *
+   * \retval array List of properties
    */
   public function getProperties() {
@@ -106 +109 @@
 
   /**
-   * Gets unique properties of the subject of the projection.
+   * Gets an associative list of unique properties of the projection
+   * with their values.
    *
-   * Ths method returns an associative list of properties => values.
-   * All non-unique properties are NOT returned !
+   * \retval array  Associative list of unqique properties and their values
    *
-   * \note This method is a library specific extension to the RDF API and RDFa API
-   *
+   * \note
+   * - All non-unique properties are \c NOT returned !
+   * - This method is a library specific extension to the RDF API and RDFa API
    */
   public function _getUniqueProperties() {
@@ -122 +126 @@
   /**
    * Gets the subject of of the subject of the projection.
+   *
+   * \retval string  Subject of the property
    */
   public function getSubject() {
@@ -132 +138 @@
    * Gets the first available value of a given property.
    *
-   * \param property   property to retrieve the first value of
+   * \param  property   Property to retrieve the first value of#
+   * \retval string     First value of the property
    */
 
@@ -144 +151 @@
    * Gets a list of all available values of a given property.
    *
-   * \param property   property to retrieve all values of
+   * \param property   Property to retrieve all values of
    */
 
@@ -150 +157 @@
     return $this->rdfaData->getValues( $this->subject, $property);
   } // public function getAll
-  
+
   // --------------------------------------------------------
 
@@ -156 +163 @@
    * Sets a property value.
    *
-   * \param property  property to be added
-   * \param value     value to be set for the property
-   * \param type      the type of the value, either 'uri', 'literal' or 'bnode'
+   * \param property  Property to be added
+   * \param value     Value to be set for the property
+   * \param type      The type of the value, either 'uri', 'literal' or 'bnode'
    *                  (case-insensitive). Specifying the first character is sufficient.
    *                  If not specified, strings starting with 'http://' are taken as a URI,
    *                  otherwise as a literal
-   * \retval object projection
-   * \retval false invalid value type specified
+   * \retval rdfa::Projection Success
+   * \retval boolean   false: invalid value type specified
    *
    * \see rdfa::Data::setValue