https://github.com/dahas/f7k
Yet another PHP framework
https://github.com/dahas/f7k
framework framework-php latte opis orm php php81 template-engine
Last synced: 6 months ago
JSON representation
Yet another PHP framework
- Host: GitHub
- URL: https://github.com/dahas/f7k
- Owner: dahas
- Created: 2023-03-27T13:22:40.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T14:15:04.000Z (over 2 years ago)
- Last Synced: 2025-01-19T20:28:41.063Z (about 1 year ago)
- Topics: framework, framework-php, latte, opis, orm, php, php81, template-engine
- Language: PHP
- Homepage:
- Size: 1.42 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# f7k - yet another framework
- f7k is the numeronym of the word 'framework'.
- f7k follows the PHP Standard Recommendations (PSR).
- f7k requires good knowledge of the php programming language.
- f7k is the most difficult framework on the planet.
- f7k is so difficult, that only the nerdiest nerds can handle it.
## Minimum Requirements
- PHP 8.1.2
- Composer
- A Google Account
## Installation
````
$ cd /var/www
$ sudo git clone https://github.com/dahas/f7k.git
$ cd
$ composer install
````
## Set Permissions
````
$ sudo adduser $USER www-data
$ sudo chown -R $USER:www-data /var/www/
$ sudo chmod -R 775 /var/www/
````
# Setting things up
## Environment variables
Rename `.env.example` to `.env`. All sensitive informations are stored in this file. Double check that it is added to `.gitignore` so it won't accidentially appear in your public repository.
Open the `.env` file and adjust some settings:
- Leave the LOCAL_HOST setting as it is.
- Set your PUBLIC_DOMAIN if you have one already registered.
# Run locally
Launch the PHP build-in web server:
````
$ php -S localhost:2400 -t public
````
# How to
## Extend f7k with Controllers
With a Controller you can extend f7k with new Pages and new Functionality.
Create a file `MyController.php` in the `controllers` directory:
````php
// controllers/MyController.php
response->write("Hello " . $this->data['name']);
}
//...
}
````
Check it out in the web browser (provide your name):
http://localhost:2400/SayMyName/
### Render HTML
Now, if you want to render a beautiful HTML template, you need a Template Engine. "Latte" is available as a Service. "Latte" is part of the sweet and way too easy "Nette" Framework (Good for the rest of the world, but not for the nerdy nerds).
Learn more about Latte here: https://latte.nette.org/en/guide
Here is how you use the Template Service:
Create an HTML file named `My.partial.html` with the following content in the `templates` folder:
````html
{layout 'App.layout.html'}
{block content}
{$header}
{$message}
{/block}
````
Inject the Template Engine as shown below:
````php
// controllers/MyController.php
template->assign([
'title' => 'My Controller',
'header' => 'f7k is cool!',
'message' => 'But ' . $this->data['name'] . ' is way cooler :p'
]);
$this->template->parse('My.partial.html');
$this->template->render();
}
//...
}
````
Check it out again:
http://localhost:2400/SayMyName/
## Extend the Menu
Finally, you might want your new page to appear in the navigation bar. Therefore open `menu.json` and insert the following lines:
````
// ...
{
"path": "/SayMyName/",
"controller": "MyController",
"title": "Say My Name",
"enabled": true
},
// ...
````
To see the Menu you have to do one last little change in your Controller:
````php
class MyController extends AppController {
//...
}
````
The `AppController` hosts all the features and services that you need throughout the whole app (like Navigation Bar, Footer, etc.).
## Extend f7k with Services
A Service is an Object that provides additional features and/or data. Most of the time you will retrieve data from a database table within a Service.
To create a Service you simply create a Class in the `services` directory and inject it via an Attribute in the Controller where you need the Service. Name yours `MyService.php`.
````php
// services/MyService.php
myService->myMethod()` to the 'message' marker of the template:
````php
#[Route(path: '/SayMyName/{name}', method: 'get')]
public function main(): void
{
$this->template->assign([
'title' => 'Your Controller',
'header' => 'f7k is cool!',
'message' => $this->myService->myMethod($this->data['name'])
]);
$this->template->parse('My.partial.html');
$this->template->render();
}
````
And again: http://localhost:2400/SayMyName/
It is also possible to use **Services in other Services**. In this case the Constructor is mandatory and the Service must inherit from Class `ServiceBase`.
````php
// services/MyService.php
request, $this->response, $this->session);
}
//...
}
````
## Enable Google User Authentication
All kind of authentication and authorization is done externally using the Google OAuth service. Therefore it is neccessary that you have a Google account and have the API enabled. Below is a description of how to enable the Authentication API.
1. In the Google Cloud Console go to API credentials:
https://console.developers.google.com/apis/credentials?hl=de
1. Create a new Project
1. Click on "Configure Consent Screen", choose "External".
1. Enter a name and provide your email address.
1. Skip "Scopes" and "Test Users" and finish the configuration.
1. Go back to Credentials, click on "Create Credentials" and choose "OAuth Client ID".
1. Select "Web Application" as application type.
1. Copy the LOCAL_HOST and the PUBLIC_DOMAIN from your `.env` file, paste them into authorised redirect URIs and extend both of them with *"/Authenticate"*.
E. g.: http://localhost:2400/Authenticate
1. Save it.
1. Copy and paste the Client ID and Secret from the final screen into the `.env` file.
## Become the Admin.
In the terminal run:
````
$ php encrypt.php
````
- Copy the hash and assign it to ACCOUNT_HASH.
# Available Services
Next you find some Services that are already available. Feel free to use and/or modify them as you like.
## AuthenticationService
### *Description*:
Use this service to authenticate and authorize users for further actions.
## MarkdownService
### *Dependencies*:
* Services: `PurifyService`
### *Description*:
Creates and renders HTML from Markdown.
## MenuService
### *Dependencies*:
* Templates: `Menu.partial.html`
### *Description*:
Creates and renders the menu inside the navigation bar according to the specification in `menu.json`.
## PurifyService
### *Description*:
Uses HTMLPurifier to remove malicious code.
## TemplateService
### *Description*:
Parses HTML templates.