Open Semantic Framework PHP API  3.0
 All Data Structures Namespaces Files Functions Variables Pages
Internal Resultset Structures used in OSF web services.

The Structure

 Every OSF web service endpoint that returns a resultset uses this internal array structure
 to represent the resultset to serialize and return to the user. This structure is used to
 generate the resultset using the structXML format. It is this structXML serialization that is used
 to exchange data between OSF web services in a pipeline of web services, or used to convert
 the data into different other serializations.

 Each web service interface should comply with this internal resultset array structure.
*
*    $resultset =   Array("dataset-uri" => 
*                     Array("record-uri" =>
*                      Array(
*                        "type" => Array(URIs...),
*                        "prefLabel" => "preferred label",
*                        "altLabel" => Array(alternative label literals...),
*                        "prefURL" => "http://preferred-url.com",
*                        "description" => "some description of the record",
*                        
*                        "other-data-attribute-uri" => Array(
*                          Array(
*                            "value" => "some value",
*                            "lang" => "language string of the value",
*                            "type" => "type of the value"
*                          ),
*                          Array(
*                            ...
*                          )
*                        ),
*                        "more-data-attribute-uri": ...,
*                        
*                        "other-object-attribute-uri" => Array(
*                          Array(
*                            "uri" => "some uri",
*                            "type" => "optional type of the referenced URI",
*                            "reify" => Array(
*                              "reification-attribute-uri" => Array("value of the reification statement"),
*                              "more-reification-attribute-uri" => ...
*                            )
*                          ),
*                          Array(
*                            ...
*                          )
*                        )
*                        "more-object-attribute-uri": ...
*                      ),
*                      
*                      "more-record-uri": ...
*                    )
*                  )
*        
*