Docs For Class Endpoint

Endpoint

Description

Sparql HTTP Client for 4store Endpoint around basic php function.

You can send a query to any endpoint sparql and read the result in an array.

Example : send a simple query to DBpedia

<?php
require_once('php4store/Endpoint.php');
$endpoint ="http://dbpedia.org/";
$sp_readonly = new Endpoint($endpoint);
$q = "select * where {?x ?y ?z.} LIMIT 5";
$rows = $sp_readonly->query($q, 'rows');
$err = $sp_readonly->getErrors();
if ($err) {
print_r($err);
throw new Exception(print_r($err,true));
}
var_dump($rows);
?>

With a query ASK, you can use the parameter 'raw' in the function query and read directly the result true or false.

Example : send a query ASK with the parameter raw

<?php
require_once('php4store/Endpoint.php');
$q = "PREFIX a: <http://example.com/test/a/>
PREFIX b: <http://example.com/test/b/>
ask where { GRAPH <".$graph."> {a:A b:Name \"Test3\" .}} ";
$res = $sp_readonly->query($q, 'raw');
$err = $sp_readonly->getErrors();
if ($err) {
print_r($err);
throw new Exception(print_r($err,true));
}
var_dump($res);
?>

You can insert data also with SPARQL and the function query. If the graph doesn't exist, 4store will create the graph.

Example : send a query Insert

<?php
require_once('php4store/Endpoint.php');
$graph = "http://www.bordercloud.com";
$endpoint ="http://localhost:8080/sparql/";
//put argument false to write
$readonly = false;
$sp_write = new Endpoint('http://localhost:8080/',$readonly);
$q = "
PREFIX a: <http://example.com/test/a/>
PREFIX b: <http://example.com/test/b/>
INSERT DATA {
GRAPH <".$graph."> {
a:A b:Name \"Test1\" .
a:A b:Name \"Test2\" .
a:A b:Name \"Test3\" .
}}";
$res = $sp_write->query($q,'raw');
$err = $sp_write->getErrors();
if ($err) {
print_r($err);
throw new Exception(print_r($err,true));
}
var_dump($res);
?>

You can delete data also with SPARQL and the function query.

Example : send a query Delete

<?php
require_once('php4store/Endpoint.php');
$graph = "http://www.bordercloud.com";
$endpoint ="http://localhost:8080/sparql/";
$q = "
PREFIX a: <http://example.com/test/a/>
PREFIX b: <http://example.com/test/b/>
DELETE DATA {
GRAPH <".$graph."> {
a:A b:Name \"Test2\" .
}}";
$res = $sp_write->query($q,'raw');
$err = $sp_write->getErrors();
if ($err) {
print_r($err);
throw new Exception(print_r($err,true));
}
var_dump($res);
?>

You can create or replace a graph with the function set.

Example :

<?php
require_once('php4store/Endpoint.php');
$readonly = false;
$s = new Endpoint('http://localhost:8080/',$readonly);
$r = $s->set('http://example/test', "
@ prefix foaf: <http://xmlns.com/foaf/0.1/> .
<http://github.com/bordercloud/4store-php> foaf:maker <http://www.bordercloud.com/wiki/user:Karima_Rafes> . ");
?>

You can add data (Turtle format) in a graph with the function add.

Example :

<?php
require_once('php4store/Endpoint.php');
$readonly = false;
$s = new Endpoint('http://localhost:8080/',$readonly);
$r = $s->add('http://example/test', "
@ prefix foaf: <http://xmlns.com/foaf/0.1/> .
<http://www.bordercloud.com/wiki/user:Karima_Rafes> foaf:workplaceHomepage <http://www.bordercloud.com> . ");
var_dump($r);
?>

You can delete a graph with the function delete.

Example :

<?php
require_once('php4store/Endpoint.php');
$readonly = false;
$s = new Endpoint('http://localhost:8080/',$readonly);
$r = $s->delete('http://example/test');
var_dump($r);
?>

Located in /php4store/Endpoint.php (line 189)

Method Summary

Endpoint __construct (string $endpoint, [boolean $readOnly = true], [boolean $debug = false], [string $proxy_host = null], [string $proxy_port = null])

boolean add (string $graph, string $turtle)

boolean check ()

number count ([string $graph = null])

boolean delete (string $graph)

array getErrors ()

array|boolean query (string $q, [string $result_format = ''])

string queryRead (string $query, [string $typeOutput = null])

string queryReadJSON (string $query)

string queryReadTabSeparated (string $query)

boolean queryUpdate (string $query)

boolean set (string $graph, string $turtle)

Methods

Constructor __construct (line 239)

Constructor of Graph

access: public

Endpoint __construct (string $endpoint, [boolean $readOnly = true], [boolean $debug = false], [string $proxy_host = null], [string $proxy_port = null])

string $endpoint: : url of endpoint, example : http://lod.bordercloud.com/sparql
boolean $readOnly: : true by default, if you allow the function query to write in the database
boolean $debug: : false by default, set debug to true in order to get usefull output
string $proxy_host: : null by default, IP of your proxy
string $proxy_port: : null by default, port of your proxy

add (line 319)

Add new data in a graph.

return: : true if it did
access: public

boolean add (string $graph, string $turtle)

string $graph: : name of the graph
string $turtle: : list of the triples

check (line 275)

Check if the server is up.

return: true if the triplestore is up.
access: public

boolean check ()

count (line 436)

Count the number of triples in a graph or in the endpoint.

access: public

number count ([string $graph = null])

string $graph: : put name of the graph or nothing to count all triples in the endpoint

delete (line 349)

Delete a graph with its data.

return: : true if it did
access: public

boolean delete (string $graph)

string $graph: : name of the graph

getErrors (line 426)

Give the errors

access: public

array getErrors ()

query (line 383)

This function parse a SPARQL query, send the query and parse the SPARQL result in a array.

You can custom the result with the parameter $result_format :

rows to return array of results
row to return array of first result
raw to return boolean for request ask, insert and delete

return: in function of parameter $result_format
access: public

array|boolean query (string $q, [string $result_format = ''])

string $q: : Query SPARQL
string $result_format: : Optional, rows, row or raw

queryRead (line 462)

Send a request SPARQL of type select or ask to endpoint directly and output the response of server. If you want parse the result of this function, it's better and simpler to use the function query().

if you want use another format, you can use directly the function queryReadJSON and queryReadTabSeparated

return: response of server or false if error (to do getErrors())
access: public

string queryRead (string $query, [string $typeOutput = null])

string $query: : Query Sparql
string $typeOutput: by default "application/sparql-results+xml",

queryReadJSON (line 493)

Send a request SPARQL of type select or ask to endpoint directly and output the response

of server in the format JSON

return: response of server in the format JSON
access: public

string queryReadJSON (string $query)

string $query: : Query Sparql

queryReadTabSeparated (line 504)

Send a request SPARQL of type select or ask to endpoint directly and output the response

of server in the format TabSeparated

return: response of server in the format TabSeparated
access: public

string queryReadTabSeparated (string $query)

string $query: : Query Sparql

queryUpdate (line 520)

Send a request SPARQL of type insert data or delete data to endpoint directly.

If you want check the query before to send, it's better to use the function query() in the class StorePlus.

Example insert : PREFIX ex: <http://example.com/> INSERT DATA { GRAPH <http://mygraph> { ex:a ex:p 12 .}}
Example delete : PREFIX ex: <http://example.com/> DELETE DATA { GRAPH <http://mygraph> { ex:a ex:p 12 .}}

return: true if it did or false if error (to do getErrors())
access: public

boolean queryUpdate (string $query)

string $query: : Query Sparql of type insert data or delete data only

set (line 286)

Create or replace the data in a graph.

return: : true if it did
access: public

boolean set (string $graph, string $turtle)

string $graph: : name of the graph
string $turtle: : list of the triples

Documentation generated on Sat, 20 Aug 2011 18:46:06 +0200 by phpDocumentor 1.4.3