Preliminaries:

For using Saft you should have a basic understanding of the Resource Description Framework (RDF), SPARQL and the idea of the Semantic Web.

You have reached the documentation of the Saft project. Here you will find information about the Saft PHP framework itself, the Saft REST interface and how to constribute to the project. If you have a question, don’t hesitate to open a new issue.

Saft PHP framework

more information

The Saft PHP Framework consists of the Saft Library and the Saft Skeleton Application.

Structure of the whole Saft Framework

Saft REST interface

more information

Saft is a framework with the aim to specify components needed for software engineers to easily implement web applications using Semantic Web technology. For the interface towards the World Wide Web a REST interface is specified. It allows read and write access to the data served by a Store-Service. For server side implementation of Semantic Web applications, e.g. implementing a Store-Service for the World Wide Web, we provide the Saft PHP framework.

Application Programming Interface

Saft provides an Application Programming Interface (API) which can be used by application developers to use and extend the provided library resp. framework. The API consists of all classes and methods tagged with the @api tag (FIG-5 @api). To identify the version when the class or method was introduces or changed the @since tag is used together with the according API-version (FIG-5 @since). Deprecated methods are marked with @deprecated (FIG-5 @deprecated).

API classes and method

Contribution

You are very welcome to contribute to the Saft project! You can help us by forking our repositories and sending pull requests via Github to improve the code or the documentation.

Code and implementation conventions

If you are changing the code please respect our conventions regarding coding style, conding standard and the names. We provide tools that help you to match most of our coding standards. Please have a look into the Makefile for tools to help you check coding standards.

Contribute to the Documentation

This is the documentation for Saft. If you want to contribute to the documentation (even if it is just a typo) please feel free to fork the site and documentation repository and create a pull request.