hydra/app

An application template for Hydra, the cozy RESTfull PHP5.3 micro-framework.

Hydra application skeleton

This is an application for Hydra, the cozy RESTfull PHP5.3 micro-framework. See https://github.com/z7/hydra, _(*1)

Configuration

There is a main configuration file - /app/config.php, where you can adjust the settings to your likes., _(*2)

To adjust core config options, you'll have to edit /web/index.php., _(*3)

/data folder

You should give web server write access ONLY to this folder and its contents., _(*4)

The /data/web subfolder will store uploaded files accesible at an address of the form http://example.com/vendor/data/ASSETS, _(*5)

/web folder

Store all your public assets (images, css, js) there., _(*6)

If you use 3rd party libraries, use CDN, like https://developers.google.com/speed/libraries/devguide If there is no CDN for your lib, then drop it in it's own /web/vendor/LIBRARY-NAME subfolder., _(*7)

If you need to serve dynamic assets, append a '.php' extension., _(*8)

Example: to serve a http://example.com/js/dynamic.js?foo=bar create a /web/js/deynamic.js.php file like this:, _(*9)

expires(60 * 60 * 24, true); // cache response for 1 day ?> alert(query['foo']) ?>);, _(*10)

/app/src subfolder

Store hooks in directly in src folder., _(*11)

Store all application classes here., _(*12)

IMPORTANT: Use App namespace. For example, a \App\Controller\SampleController class should be stored in src/App/Controller/SampleController.php., _(*13)

/app/views subfolder

Store all your Twig views here., _(*14)

/app/plugins subfolder

Store 3rd party Hydra plugins here Each plugin may contain the following:, _(*15)

• src/ folder with classes. The plugin is responsable for registering classes with autoloader. If it provides public controllers, routes should be explicitly registered as well., _(*16)

• web/ folder with web assets, accesible at http://example.com/plugins/PLUGIN-NAME/ASSETS 3rd party libraries should be placed in a web/vendor/ subfolders., _(*17)

• hooks/ folder with any number of *.hook.php files (auto-detected)., _(*18)

• views/ folder (templates should be explicitly registered).
• vendor/ PHP libraries.
• README.md file.
• composer.json file if the plugin has PHP dependecies (see vendor/ libs).

Plugins may be nested in subfolder, but in this case the "web" directory should be served by the plugin itself., _(*19)

IDE integration

If you have method or service declarations in your hook files, create src/ide_helper.php file with php docs describing your method signatures., _(*20)