Setup is really easy for the Pie Framework, just follow the required steps below.
To install Pie download the files to your server, it is recommended that the files are somewhere outside of the document root. If you cannot place them outside of the document root place them in a directory within the document root. No framework files should be in the root directory of the document root though.
Example locations:
/usr/share/php/Pie/autoloader.php/home/$USER/Pie/autoloader.php$DOCUMENT_ROOT/Pie/autoloader.phpOnce downloaded, create the file index.php inside the document root of your server. Replace path/to/autoloader.php with the actual path of the autoloader found in the root of the Pie framework.
<?php
use Pie\Pie;
// Replace with your path
require_once 'path/to/autoloader.php';
$app = Pie::module('Welcome', []);
$app->controller('Welcome', function(){
echo '<h1>Welcome to Pie!</h1>';
});
$app->call('Welcome');In the php.ini file that is loaded for your php, find the line include_path and append the path to the Pie framework. Lets assume that you put the framework here /usr/share/php/Pie we then just append that to the include_path prefixed with a :
Your include path might look something like this now:
include_path = ".:/usr/share/php/Pie"Routing usually requires that you setup a few server settings, here are settings in order to get Apache or Nginx working.
With Apache, we can add this to the document root in an .htaccess file:
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule (.*) index.php [L]With Nginx, this usually works without having to do a rewrite, just add this to the server section:
location / {
try_files $uri $uri/ /index.php;
}When creating file such as your own classes for services and controllers, place them somewhere in the document root. The autoloader will load the files properly if the namespace is correct, as it looks at the document root.
For example if you create a class in $DOCUMENT_ROOT/Contollers/Users.php your namespace for that file should be Controllers. If you create a class in $DOCUMENT_ROOT/Controllers/Public/Users.php your namespace for that file should be Controllers\Public.
You can create an environment settings file anywhere you would like, but it is recommended that it is not within your document root. If it is, people will have access to it and be able to see any settings you have in there, such as your database username and password, or your API keys and secrets.
<?php
require_once 'path/to/autoloader.php';
Env::loadFromFile('/path/to/config.ini');An average index file with routing and templating usually looks like this
<?php
use Pie\Pie;
use Pie\Crust\Scope;
use Pie\Crust\Env;
use Pie\Modules\Route\Route;
// Load the autoloader
require_once 'piephp/autoloader.php';
// Load the evironments configuration
Env::loadFromFile('../config.ini');
// Create the base app
$app = Pie::module('MyWebApp', ['Route', 'Tpl']);
// Create the apps configuration
$app->config(function(Route $route){
// Define what to do for all routing requests
$route->always([
'baseTemplateUrl' => '/index.html', // Handles html pages
// html pages have a templateUrl in the route
'displayAs' => 'json' // Handles non html pages
// non html pages have a controller in the route
]);
// Define each route
$route->when('/', [
'templateUrl' => '/views/home.html'
]);
});
// Create a controller to handle the request
$app->controller('home', function(Scope $scope){
$scope->header = 'Welcome';
});Pages usually have a template to go along with them. Here are the two pages
Base Template /index.html
<!doctype html>
<html>
<head>
<title>My MyWebApp</title>
</head>
<body>
<!--
This view is where our route's template will show up.
Without the 'view' attribute we can't load a template.
The view attribute will only be utilized once.
-->
<div view></div>
</body>
</html>View Template /views/home.html
<!--
Once this view loads, the template will execute the named
controller and we can then utilized the defined scopes.
-->
<div controller="home">
<h1 scope="header"></h1>
</div>