Fork me on GitHub

Organization

You can install Hathoora PHP Framework anywhere you want. Directory to which you install is called HATHOORA_ROOTPATH.

Example layout

Here is the default layout of Hathoora PHP Framework installation.

        
            # Directory: HATHOORA_ROOTPATH/

            # App root
            app/
                
                # Folders for organization of code
                sample      
                    admin/                      <-- name of application
                        config/
                            config_dev.yml
                            config_prod.yml
                        controller/
                        resources/
                            assets/
                                css/
                                js/
                                images/
                            templates/
                        model/ 
                        
                    docs/                 <-- name of second supported application
                        ...
                
                # An app without organizational folder
                site/                           <-- name of third supported application
                    config/
                    controller/
                    resources/
                    

            # this is where your application definication would go
            boot/
                config/
                    app_dev.yml
                    app_prod.yml

            # Public facing
            docroot/
                _assets/
                    # place your static files here
                    
                # the frontend controller
                index.php

            # third party code goes here (via composer)
            vendor/
        
    

The app/ Directory

The app directory conatins source of your applications. You can have single application of multiple applications. Each application itself contains the following:

  • Config: stores application specific configuations which are discussed in more details here.
  • Controller: stores application specific controllers to intercept requests.
  • Resources: stores application specific templates and assets.
  • Model: stores application specific models or logic. This can be named to anything.

The boot/ Directory

The boot directory contains a file called app_HATHOORA_ENV.yml. This is where you define supported application(s).

Note that HATHOORA_ENV represent the environment your application is running in, this could be dev, prod or anything.

The docroot/ Directory

This is public facing directoy which should be configured in your webserver.

The vendor/ Directory

This is where Composer packages are installed. Composer is a dependency management library for PHP. You can find out more about it here.

Page Took:         5.97 msec
Page Memory:   510.86k
docs / viewController / view (200)
Request UUID: 59963c6a4e1390.70695685
Get
Post
Cookies
Files
Session
Server
Response
No data.
No data.
No data.
No data.
No data.
REDIRECT_HATHOORA_ENV
prod
REDIRECT_STATUS
200
HATHOORA_ENV
prod
HTTP_HOST
hathoora.org
HTTP_X_FORWARDED_FOR
54.224.184.251
HTTP_X_REAL_IP
54.224.184.251
HTTP_CONNECTION
close
HTTP_ACCEPT_ENCODING
x-gzip, gzip, deflate
HTTP_USER_AGENT
CCBot/2.0 (http://commoncrawl.org/faq/)
HTTP_ACCEPT
text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
PATH
/sbin:/usr/sbin:/bin:/usr/bin
SERVER_SIGNATURE
Apache/2.2.15 (CentOS) Server at hathoora.org Port 80
SERVER_SOFTWARE
Apache/2.2.15 (CentOS)
SERVER_NAME
hathoora.org
SERVER_ADDR
192.168.1.11
SERVER_PORT
80
REMOTE_ADDR
207.126.164.119
DOCUMENT_ROOT
/var/websites/hathoora.org/docroot
SERVER_ADMIN
webmaster@hathoora.org
SCRIPT_FILENAME
/var/websites/hathoora.org/docroot/index.php
REMOTE_PORT
46538
REDIRECT_URL
/docs/v1/organization
GATEWAY_INTERFACE
CGI/1.1
SERVER_PROTOCOL
HTTP/1.0
REQUEST_METHOD
GET
QUERY_STRING
REQUEST_URI
/docs/v1/organization
SCRIPT_NAME
/index.php
PHP_SELF
/index.php
REQUEST_TIME_FLOAT
1503018090.319
REQUEST_TIME
1503018090
Status: 200
Headers:
Content-Type
text/html; charset=UTF-8
Configutation
Key Value
app.admin
Array
(
    [pattern] => /admin(|/)
    [directory] => hathoora
    [namespace] => hathoora\admin
)
app.docs
Array
(
    [pattern] => /docs(|/)
    [directory] => hathoora
    [dispatcher] => Array
        (
            [class] => customDispatcher
            [method] => dispatch
        )

)
app.site
Array
(
    [default] => 1
)
hathoora.logger
Array
(
    [profiling] => Array
        (
            [enabled] => 1
        )

    [logging] => Array
        (
            [enabled] => 1
            [level] => DEBUG
        )

    [webprofiler] => Array
        (
            [enabled] => 1
            [system] => 
            [show_redirects] => 
        )

)
hathoora.template
Array
(
    [engine] => Array
        (
            [name] => Stuob
        )

)
hathoora.database
Array
(
    [default] => mysql://dbuser:dbpassword@dbhost:3306/dbname
)
services.container
Array
(
    [class] => \hathoora\container
    [method] => getContainer
)
Logging (14)
hathoora.logger.logging.enabled: 1
# Time (msec) Level Memory (KB) Message
1 2.318 DEBUG 309.33 Configuration loaded:
Array
(
    [0] => app_prod.yml
    [1] => config_prod.yml
)
2 2.604 DEBUG 322.94 Listener "kernel.terminate[webprofiler]" has been added because of hathoora.logger.webprofiler.enabled
3 2.770 DEBUG 326.33 Event kernel.ready has been registered.
4 2.970 DEBUG 334.70 Calling App dispatcher (Array ( [class] => customDispatcher [method] => dispatch ) )...
5 3.130 DEBUG 349.01 Event kernel.route has been registered.
6 3.392 DEBUG 378.35 Event kernel.controller has been registered.
7 3.445 DEBUG 379.30 Calling controller (\docs\controller\viewController::view) with following params
Array
(
    [0] => v1
    [1] => organization
)
8 4.033 INFO 466.66 Template (docs/v1/organization.tpl.php) loaded
9 4.209 INFO 471.88 Template (/var/websites/hathoora.org/app/hathoora/docs//resources/templates/components/htmlMeta.tpl.php) loaded
10 4.305 INFO 473.13 Template (/var/websites/hathoora.org/app/hathoora/docs//resources/templates/components/flashMessages.tpl.php) loaded
11 5.557 INFO 436.60 Template (docs.tpl.php) fetched.
12 5.630 DEBUG 436.20 Event kernel.response has been registered.
13 5.672 DEBUG 437.38 Event kernel.terminate has been registered.
14 5.785 DEBUG 440.60 Event kernel.terminate->webprofiler has been notified.
Profiling
template
# Time (msec) Name Cached Took (msec)
1 3.549 docs.tpl.php 0 1.868