Home

OSS Framework

OSS Framework is a PHP web application library use by Open Solutions on various public / open source projects as well as private, closed source commercial projects. We use GitHub to host it so that it is available to our open source projects and we release it under a BSD licence.

While it is available to anybody under this license to pick and choose what they like, we do not offer free support for it and we do not make any specific attempts to maintain or fully complete the documentation outside of what we require internally. Feel free to contact our sales team for help.

Now, with that disclaimer and bad news out of the way, we fully intend to document a lot of this and we will, most likely through blog posts, announce some of the more useful library classes.

Note that we have a heavy basis on Zend, Doctrine / Doctrine2 and Smarty and a lot of the library will extend from these. We have also moved to using and required PHP 5.4 for our code.

API Documentation

API documentation is available at: http://opensolutions.github.com/OSS-Framework/

Contents

• OSS_Controller - Zend_Controller extensions and traits
  • Available controller traits which provide canned functionality such as authentication.
    • OSS_Controller_Trait_Auth - Authentication
  • Available action traits which add functionality to your actions, including:
    • Doctrine2 Frontend which is a trait that adds CRUD (create, update, delete and list) functionality to a controller for a database object. This is also known as scaffolding.
• OSS_Form - extensions to Zend_Form with new traits for adding functionality, new elements and utility classes for creating common elements.
• OSS_Logger - Zend_Logger extension.
• OSS_Message - a library allowing you to place success / error / alert / informational messages on a webpage (after a (un)successful operation for example).