Namespace Hawk

This class is used to generate the application singletons. It is loaded at script start, and initialize the following singletons : conf, errorHandler, logger, fs (FileSystem), session, router, request, response, cache and db

This class is used to manage cache in Hawk. It allows to save cache files in the folder /cache, and detect if a file is cached. This class is very useful to increase the application performances.

This class describes the behavior of a controller. All controllers defined in application plugins must extend this class for the application routes work.

This class is used to construct SQL WHERE expressions from arrays. This can be useful to build simple conditions without writing SQL query and manage binding values This class is used in classes Model, Form, ItemList to get data from the database. Example : To make the expression 'field1 = "value1" AND (field2 IS NOT NULL OR field3 < 12)', create an DBExample like :

new DBExample(array(
       array('field1' => "value1"),
       array('$or' => array(
           array(
               'field2' => '$notnull'
           ),
           array(
               'field3' => array('$lt' => 12)
           )
       ))
))

This class describes html inputs. These objects are not really inputs, but can be used in forms to display HTML content betweeen other inputs, for instance short description of a set of inputs.

This class describes the field displayed in a smart list. All properties of an instance of this class can be scalar, or a function taking as arguments : - $value The value of the cell - $field The field itself - $line All the values in the list results line

This class is used to log data in /logs directory. You can use it to log the action of the users on the application, for example to make stats.

This class describe the behavior of an input representing an object. To be treated, an object must be an array. To be displayed, an object must be a json string

This trait is used to manage the user's sessions. It's declared as trait to be used in custom classes developer could want to develop to extend the session management (manage licences, number of simultaneous connections, ...)

This abstract class defines the view plugins. It must be inherited by any class that defines any view plugin. This class is called when, in a view, you write something like that : {pluginName param="value1" param2="{$variable}" }

This abstract class describes the bahavior of widgets. Widgets can be a little part of your page you want to use several times. It can be another thing : a further feature that you call on a controller action.

This class describes the wysiwyg fields in forms. Wysiwyg behavior is computed by CKEditor library http://ckeditor.com/