Skip to content
Zach Zundel edited this page May 18, 2016 · 1 revision

Welcome to the SBOL Validator wiki!

How the Validator Works

The SBOL Validator is basically a PHP wrapper around libSBOLj. This guide therefore pertains to the PHP component of the two and any questions or issues about the actual validation processes should be directed to the team working on libSBOLj.

ValidationRequest

At the core of the Validator is the ValidationRequest. The ValidationRequest contains the various Options components, as well as direction the assembly of their various command fragments into the final command to be executed on the system shell. It also contains the ValidationResult object, which manages parsing the output of the command line to a format which is suitable for display in a webpage as well as output to JSON for the API.

APIRequest

The APIRequest is an extension of the ValidationRequest that handles specific options which are not universal to all validation requests.

Processing Input

The endpoint.php and validate.php files are used to perform some basic validation, as well as create the APIRequest and ValidationRequest objects, respectively. They also handle file upload to a specified location on the hosting server, the uploads directory, specifically. Once they have initialized and set all options for the validation, they call an execute method, which will run the validation command on the sever and fill the ValidationResult object. They then return the ValidationResult object to either the API user or pass it to the results page to be populated.

Page Layout and Population

Pages are templated using PHPTAL for the web validator.

Clone this wiki locally