Requirements

PHP 5.3 or later. Might work on earlier PHP 5.x versions. Java version is in the works.

Description

Graphity is a fully object-oriented PHP framework for building flexible RESTful, Semantic Web, and/or Linked Data web applications.

Graphity tries not to invent new conventions, but instead to combine existing ones. It is based on W3C standards and reuses Java APIs where possible.

JAX-RS

Supports JAX-RS-style RESTful API:

resource annotations like @Path and @GET
UriBuilder for building URIs out of components (includes implementation in JavaScript)
ResponseBuilder for building Response objects

Further implementation of missing JAX-RS features is planned.

RDF API

Supports Jena-style object-oriented RDF API:

Model
- RDF/XML (DOM) serialization
- Turtle serialization
Statement
Resource
Literal

Utilities

Includes utility classes for dealing with SPARQL, RDF/XML, and XSLT:

Repository for remote SPARQL 1.1 endpoint access
QueryBuilder for building SPARQL queries
RDFForm for reading requests in RDF/POST encoding
MultipartParser and MultipartRequest for reading multipart/form-data requests (PHP port of O'Reilly's Multipart classes)
XSLTBuilder for building XSLT transformations (PHP's XSL extension must be enabled)
DOM2Model for converting RDF/XML to Model (reverse of Model::toDOM())

Usage

To create a Graphity PHP application, you need to follow similar steps as in creating JAX-RS webapp, plus some extra steps because of PHP's interpreted and per-request nature:

Checkout or extract graphity-core into /lib/graphity-core or similar folder in your project. We recommend choosing the latest version tag on GitHub.

We strongly recommend Maven Standard Directory Layout, as it will be easier to share reusable resources with the Java version in the future. It is used in the following examples.
Create some resource class that imports and extends Graphity\Resource, for example:
```
namespace My;

use Graphity\Response;
use Graphity\ResponseBuilder;
use Graphity\View\ContentType;

class Resource extends \Graphity\Resource
```
We strongly recommend using PHP namespaces with the standard folder layout. In Maven structure, that would be within the src/main/php folder. It is used in the following examples.

Annotate the class with @Path and methods with @GET/@POST etc., for example:

namespace My;

use Graphity\Response;
use Graphity\ResponseBuilder;
use Graphity\View\ContentType;

/**
 * @Path("/hello")
 */
class Resource extends \Graphity\Resource
{

    /**
     * @GET
     * @Produces("text/html")
     */
    public function getResponse()
    {
        return ResponseBuilder::newInstance()->
            entity("<html>Hello ". $this->getRequest()->getParameter("what") ."!</html>")->
            status(Response::SC_OK)->
            type(ContentType::TEXT_HTML)->
            build();
    }
}

This class would match GET requests on /hello path and print a statement depending on the what query parameter value.

PHP annotations must be embedded in /* */ comment blocks.

@Produces/@Consumes annotations are not yet fully supported, but we recommend adding them for future compatibility.

Run /lib/graphity-core/bin/route_mapper.php specifying the root folder of your namespace and the location of your route map file, for example (paths are relative to project root in this case):
```
$ php lib/graphity-core/bin/route_mapper.php src/main/php/My src/main/php/routes.php
```
This should scan your resource classes and generate a route map file, which is used internally by Graphity to match request URIs against JAX-RS annotations. This does not happen dynamically (as of yet), you have to re-map routes with route_mapper.php every time your annotations change.

Implement a subclass of Graphity\Application:

 namespace My;

 class Application extends \Graphity\Application
 {

     public function __construct()
     {
         parent::__construct(include(dirname(dirname(__FILE__)) . "/routes.php"));

         $loader = new \Graphity\Loader("My", dirname(dirname(__FILE__)));
         $loader->register();
     }

 }

This class initializes route map and Graphity\Loader and can be used for custom initializations.

Make an entry point to your Application like index.php and put it under src/main/webapp:
```
 define('ROOTDIR', dirname(dirname(dirname(dirname(__FILE__)))));

 require_once(ROOTDIR . '/lib/graphity-core/src/main/php/Graphity/Application.php');
 require_once(ROOTDIR . '/src/main/php/My/Application.php');

 $app = new My\Application();
 $app->run();
```
The Graphity\Application::run() method will do the processing for you, executing the whole HTTP workflow from receiving a Graphity\Request to writing out a Graphity\Response. Later you might want to override it with My\Application::run() method to include a try/catch block for Graphity\WebApplicationException handling.

Both Application superclass and subclass need to be included here to bootstrap the framework.

This should be the single and only entry point to your Graphity web application.
Fix URL rewriting by adding .htaccess configuration under src/main/webapp:
```
 RewriteEngine On
 RewriteCond %{REQUEST_FILENAME} !-f
 RewriteCond %{REQUEST_URI} !\.(js|ico|gif|jpg|png|css|swf)$ [NC]
 RewriteRule ^(.*)$ index.php/$1 [L]
```
Requests with multipart/form-data content type should not be accessed via PHP's $_FILE or similar methods, and instead used with Graphity's MultipartRequest and MultipartParser classes. The following instructions make this possible by setting request content type to multipart/form-data-alternate before it is passed to PHP, and can be placed in vhost.conf:
```
 <Location />
     SetEnvIf Content-Type ^(multipart/form-data)(.*) NEW_CONTENT_TYPE=multipart/form-data-alternate$2 OLD_CONTENT_TYPE=$1$2
     RequestHeader set Content-Type %{NEW_CONTENT_TYPE}e env=NEW_CONTENT_TYPE
 </Location>
```
Ready? Launch! Open http://localhost/hello?what=world in your browser and you should see Hello world! printed out for you. Naturally the base URI in this example depends on your webserver and/or virtual host configuration.

Documentation

We need to do some work on this... Check out our issues so far.

Papers & presentations

W3C "Linked Enterprise Data Patterns" workshop

License

Graphity core is licensed under Apache License 2.0.

Libraries

Graphity PHP core uses following 3rd party libraries:

Addendum (for annotation parsing)

atomgraph / core-php Goto Github PK

core-php's Introduction

Requirements

Description

JAX-RS

RDF API

Utilities

Usage

Documentation

Papers & presentations

License

Libraries

core-php's People

Contributors

Stargazers

Watchers

Forkers

core-php's Issues

Recommend Projects

Recommend Topics

Recommend Org

Jobs