Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adhocore/phalcon-ext
Foundations, adapters, extensions, middlewares and utilities for Phalcon v4
https://github.com/adhocore/phalcon-ext
adhocore argv-parser console-application cors logger middleware outputcache phalcon phalcon-adapters phalcon-ext phalcon-jwt php7 swiftmailer task-scheduler throttle twig validation
Last synced: 2 months ago
JSON representation
Foundations, adapters, extensions, middlewares and utilities for Phalcon v4
- Host: GitHub
- URL: https://github.com/adhocore/phalcon-ext
- Owner: adhocore
- License: mit
- Created: 2018-06-05T11:26:07.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-05-21T15:21:19.000Z (over 1 year ago)
- Last Synced: 2024-09-30T13:01:21.883Z (2 months ago)
- Topics: adhocore, argv-parser, console-application, cors, logger, middleware, outputcache, phalcon, phalcon-adapters, phalcon-ext, phalcon-jwt, php7, swiftmailer, task-scheduler, throttle, twig, validation
- Language: PHP
- Homepage:
- Size: 327 KB
- Stars: 46
- Watchers: 5
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-nepal - Phalcon-Ext - Useful phalcon adapters, middlewares, extensions and utilities! (Uncategorized / Uncategorized)
README
## adhocore/phalcon-ext
Useful phalcon adapters, middlewares, extensions and utilities!
> Supports phalcon v4.
[](https://travis-ci.com/adhocore/phalcon-ext?branch=master)
[](https://github.com/adhocore/phalcon-ext/releases)
[](https://scrutinizer-ci.com/g/adhocore/phalcon-ext/?branch=master)
[](https://codecov.io/gh/adhocore/phalcon-ext)
[](https://styleci.io/repos/136166947)
[](LICENSE)
[](https://twitter.com/intent/tweet?text=Adapters+middlewares+extensions+and+utilities+missing+in+phalcon+framework&url=https://github.com/adhocore/phalcon-ext&hashtags=php,phalcon,extension,middleware)
[](https://github.com/sponsors/adhocore)
## Installation
```sh
composer require adhocore/phalcon-ext
```
### What's included
**Cache**
- [Redis](#cacheredis)
**Cli**
- [Extension](#cliextension)
- [Middleware](#climiddlewaretrait)
- [Scheduling](#clitaskscheduletask)
**Db**
- [Extension](#dbextension)
- [Logger](#dblogger)
**Di**
- [Extension](#diextension)
- [Provider](#diprovidesdi)
**Http**
- [Base Middleware](#httpbasemiddleware)
- [ApiAuth Middleware](#httpmiddlewareapiauth)
- [Cache Middleware](#httpmiddlewarecache)
- [Throttle Middleware](#httpmiddlewarethrottle)
**Logger**
- [Echo Logger](#loggerechologger)
- [File Logging](#loggerlogstofile)
**Mail**
- [Mailer](#mailmailer)
- [Mail](#mailmail)
- [Mailable](#mailmailable)
- [Logger](#maillogger)
**Util**
- [Opcache Primer](#utilopcacheprimer)
**Validation**
- [Validation Wrapper](#validationvalidation)
- [Db Existence Validator](#validationexistence)
**View**
- [Twig](#viewtwig)
---
### Cache.Redis
Extends `Phalcon\Cache\Backend\Redis` to allow access over the underlying redis binding.
#### Setup
```php
$di->setShared('redis', function () {
return new \PhalconExt\Cache\Redis(new \Phalcon\Cache\Frontend\None(['lifetime' => 0]));
});
// Call native \Redis methods like:
$di->get('redis')->getConnection()->hGet();
$di->get('redis')->getConnection()->info();
```
---
### Cli.Extension
Definitely check how it works in [adhocore/cli](https://github.com/adhocore/cli) and how it is integrated & used in [example/cli](./example/cli), [example/MainTask.php](./example/MainTask.php)
#### Setup
```php
$di = new PhalconExt\Di\FactoryDefault;
$di->setShared('dispatcher', Phalcon\Cli\Dispatcher::class);
$di->setShared('router', Phalcon\Cli\Router::class);
$di->setShared('config', new Phalcon\Config([
'console' => [
'tasks' => [
// Register your tasks here: 'name' => class
// You will define their options/arguments in respective `onConstruct()`
'main' => Your\MainTask::class,
],
],
]));
$console = new PhalconExt\Cli\Console($di, 'MyApp', 'v1.0.1');
// Or if you have your own Console extends, just use the trait
class YourConsole extends \Phalcon\Cli\Console
{
use PhalconExt\Cli\Extension;
}
```
#### command(string $command, string $descr = '', bool $allowUnknown = false): Ahc\Cli\Command
You can register command in the bootstrap if few or you can organise them in `SomeTask::onConstruct()` like so:
```php
class MainTask extends Phalcon\Cli\Task
{
public function onConstruct()
{
($console = $this->getDI()->get('console'))
->command('main', 'Main task ...', false)
->arguments(' [optional:default]');
->option('-s --stuff', 'Description', 'callable:filter', 'default')
->tap($console) // for fluency
->schedule('7-9 * */9 * *')
->command('main:other', ...)
->option('')
->option('')
->tap($console)
->schedule('@5mintues') // @10minutes, @15minutes, @weekly, @daily, @yearly, @hourly ...
;
}
public function mainAction()
{
$io = $this->interactor;
// Access defined args/opts for writing to terminal:
$io->write($this->command->requiredPath, true);
$io->write($this->command->stuff, true);
}
}
```
Now everytime you run command `php cli.php main main the-path --stuff whatever`, it will print `the-path` and `whatever`!
`cli.php` can be anything of your choosing that should be equivalent to [example/cli](./example/cli).
#### initTasks(void): self
Inits the loadable tasks. It is done automatically if you have listed them in `console.tasks` config (see Setup section above).
If you have loaded tasks dyanamically or late in the process call it manually: `$console->initTasks()`.
#### Cli.MiddlewareTrait
Enables you to define, register and fire middlewares for the cli in simplest possible way!
`PhalconExt/Cli/Middleware/Factory` is registered by default for convenience. It injects relevant command instance (`Ahc\Cli\Input\Command`) to DI and is auto triggered for `--help`, `--version`.
**Define middleware**
```php
class HelloConsole
{
// Prints hello every time you run a console cmd, just before execution
public function before(PhalconExt\Cli\Console $console)
{
$console->getDI()->get('interactor')->bgGreenBold('Hello', true);
return true; // Indicates success and no-objection!
}
}
```
**Register/retrieve middleware(s)**
```php
// Single:
$console->middleware(HelloConsole::class);
// Multiple:
$console->middlewares([HelloConsole::class, Another::class]);
// Get em: (It already contains PhalconExt/Cli/Middleware/Factory)
$console->middlewares(); // array
```
**Firing middlewares**
You dont have to. The `before` and `after` methods of all middlewares are automatically invoked as console lifecycle event.
### Cli.Task.ScheduleTask
Being factory feature of `adhocore/phalcon-ext` it is auto loaded so you dont have to put in config's `console.tasks` array.
It provides for commands `schedule:list` (or `schedule list`) and `schedule:run` or `schedule run` to respectively list all scheduled commands and run all commands due at that specific moment.
Registering tasks to be scheduled is a cheese too. Check `command()` section above, you can schedule a task in fluent interface like so:
```php
$console
->command('task:action', ...)
->arguments(...)->option(...)
->tap($console)
->schedule('crontab expression') // You can also use humanly phrases: @daily, @hourly
;
```
As you can see, all you need to do in crontab is add the entry:
`* * * * * php /path/to/your/phalcon-app-using-phalcon-ext/src/cli.php schedule:run`
... and manage everything here in the code!
#### Caution
Any tasks scheduled to run by automation like this should preferably **not** define required arguments or options of the form ``, as firstly they are not validated when being run as scheduled task, and secondly the philosphy of scheduling is to register single crontab script `* * * * * php /app/src/cli.php schedule:run` with no any args/options. (and these are made to run unattended if you want third point!)
However if you insist, it is possible to append `--option-name value` after `schedule:run` segment but this value goes to all of the due tasks runnable at the moment. They all can read it with `$this->command->optionName`.
---
### Db.Extension
#### Setup
```php
$di->setShared('config', new \Phalcon\Config([
'database' => [
'driver' => 'sqlite',
'dbname' => __DIR__ . '/.var/db.db',
// ... other options (see phalcon &/or pdo docs)
],
]);
$di->setShared('db', function () {
// Can use Mysql or Postgresql too
return (new \PhalconExt\Db\Sqlite($this->get('config')->toArray()['database']));
});
// Or if you have your own already, just use the trait
class YourDb extends \Phalcon\Db\Adapter
{
use PhalconExt\Db\Extension;
}
```
#### upsert(string $table, array $data, array $criteria): bool
Insert or update data row in given table as per given criteria.
```php
$di->get('db')->upsert('users', ['name' => 'John'], ['username' => 'johnny']);
```
#### insertAsBulk(string $table, array $data): bool
Insert many items at once - in one query - no loop.
```php
$di->get('db')->insertAsBulk('table', [
['name' => 'name1', 'status' => 'status1'],
['details' => 'detail2', 'name' => 'name2'], // columns dont need to be ordered or balanced
]);
```
#### countBy(string $table, array $criteria): int
Count rows in table by criteria.
```php
$di->get('db')->countBy('table', ['name' => 'name1', 'status' => 'ok']);
```
### Db.Logger
Hook into the db as an event listener and log all the sql queries- binds are interpolated.
```php
$di->setShared('config', new \Phalcon\Config([
'sqllogger' => [
'enabled' => true,
'logPath' => __DIR__ . '/.var/sql/', // directory
'addHeader' => true,
'backtraceLevel' => 5,
'skipFirst' => 2,
],
]);
$di->get('db')->registerLogger($di->get('config')->toArray()['sqllogger']);
```
---
### Di.Extension
**Foreword** This whole example and the entire `phalcon-ext` package almost always used `$di->get('service')` and not `$di->getShared('service')`, this is because if you have set 'service' as shared, `get()` will return that same shared instance again and again and if not then it will spawn new instance- the point is if we dont want new instance why dont we `setShared()` it? One has to consciously think whether to `setShared()` or `set()` instead of `getShared()` or `get()`.
#### Setup
```php
$di = new \PhalconExt\Di\FactoryDefault;
// Or if you have your own already, just use the trait
class YourDi extends \Phalcon\Di
{
use PhalconExt\Di\Extension;
}
```
#### registerAliases(array $aliases): self
Register aliases for di service so they can be resolved automatically by name &/or typehints.
```php
$di->registerAliases([
'TheAlias' => 'service',
\Phalcon\Db\Adapter::class => 'db',
]);
```
#### resolve(string $class, array $parameters = []): mixed
Recursively resolve all dependencies of a given class FQCN and return new instance.
```php
$instance = $di->resolve(\Some\Complex\ClassName::class, $parameters);
```
#### replace(array $services): self
Override a di service but keep backup so it may be restored if needed (great for tests)
```php
$di->replace(['service' => new \MockedService]);
```
#### restore(?string $service)
Restore the overridden services to their usual defaults.
```php
$di->restore(); // All
$di->restore(['service']); // One
```
### Di.ProvidesDi
#### di(?string $service): mixed
Easily resolve di services with this shortcut.
```php
class AnyClass
{
use \PhalconExt\Di\ProviesDi;
public function anyFn()
{
$di = $this->di();
$db = $this->di('db');
}
}
```
---
### Http.BaseMiddleware
A base implementation for middlewares on top of which you can create your own middlewares.
You just have to implement one or both of `before()` &/or `after()` methods that recieves `request` and `response` objects.
See an example for Ajax middleware:
```php
$di->setShared('config', new \Phalcon\Config([
'ajax' => [
'uriPrefix' => '/ajax',
],
]);
class Ajax extends \PhalconExt\Http\BaseMiddleware
{
/** @var string The root key in config having settings for Ajax middleware */
protected $configKey = 'ajax';
/**
* For any uri starting with `/ajax`, allow if only it is real ajax request.
*
* Register as before handler because we will abort before actual exceution if not ajax.
*
* @return bool
*/
public function before(Phalcon\Http\Request $request, Phalcon\Http\Response $response): bool
{
list(, $uri) = $this->getRouteNameUri();
if (\stripos($uri, $this->config['uriPrefix']) !== 0) {
return true;
}
if (!$request->isAjax()) {
// Aborts/stops the app. All other middlewares down the line are skipped
return $this->abort(400);
}
return true;
}
}
// Usage is pretty simple:
// Create an app!
$app = new Phalcon\Mvc\Application($di);
// OR micro
$app = new Phalcon\Mvc\Micro($di);
// Wrap the app with middleware and run it
(new PhalconExt\Http\Middlewares([Ajax::class]))->wrap($app);
```
#### Http.Middleware.ApiAuth
JWT based api authentication middleware that intercepts `POST /api/auth` request and generates or refreshes `access_token` based on `grant_type`.
For all other requests it checks `Authorization: Bearer ` and only allows if that is valid and the scopes are met. You can configure scopes on per endpoint basis.
You can access currently authenticated user through out the app using:
```php
$di->get('authenticator')->getSubject();
```
#### Setup
```php
$di->setShared('config', new \Phalcon\Config([
'apiAuth' => [
// 14 days in seconds (http://stackoverflow.com/questions/15564486/why-do-refresh-tokens-expire-after-14-days)
'refreshMaxAge' => 1209600,
// Prefix to use in stored tokens (max 4 chars)
'tokenPrefix' => 'RF/',
// The route to generate/refresh access tokens.
// genrerate: curl -XPOST -d 'grant_type=password&username=&password=' /api/auth
// refresh: curl -XPOST -d 'grant_type=refresh_token&refresh_token=' /api/auth
// It can also accept json payload:
// -H 'content-type: application/json' -d {"grant_type":"refresh_token","refresh_token":""}
'authUri' => '/api/auth',
// The permission scopes required for a route
'scopes' => [
'/some/uri' => 'admin',
'/next/uri' => 'user',
],
// Json Web tokens configuration.
'jwt' => [
'keys' => [
// kid => key (first one is default always)
'default' => '*((**@$#@@KJJNN!!#D^G&(U)KOIHIYGTFD',
],
'algo' => 'HS256',
// 15 minutes in seconds.
'maxAge' => 900,
// Grace time in seconds.
'leeway' => 10,
// Only for RS algo.
'passphrase' => '',
// Name of the app/project.
'issuer' => '',
],
],
]);
// Usage:
(new PhalconExt\Http\Middlewares([
PhalconExt\Http\Middleware\ApiAuth::class,
]))->wrap(new Phalcon\Mvc\Micro($di));
```
#### Http.Middleware.Cache
Caches output for requests to boost performance heavily. Requires redis service.
Currently by design only GET requests are cached and this might change.
#### Setup
```php
$di->setShared('config', new \Phalcon\Config([
'httpCache' => [
// cache life- time to live in mintues
'ttl' => 60,
// White listed uri/routes to enable caching
'routes' => [
// for absolute uri, prepend forward `/`
'/content/about-us',
// or you can use route name without a `/`
'home',
],
],
]);
```
#### Http.Middleware.Cors
Enables cors with preflight for configured origins and request options.
#### Setup
```php
$di->setShared('config', new \Phalcon\Config([
'cors' => [
'exposedHeaders' => [],
// Should be in lowercases.
'allowedHeaders' => ['x-requested-with', 'content-type', 'authorization'],
// Should be in uppercase.
'allowedMethods' => ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'],
// Requests originating from here can entertain CORS.
'allowedOrigins' => [
'http://127.0.0.1:1234',
],
// Cache preflight for 7 days (expressed in seconds).
'maxAge' => 604800,
],
]);
```
#### Http.Middleware.Throttle
Throttles the flooded requests as per time and quota of your choosing. Requires redis service.
#### Setup
```php
$di->setShared('config', new \Phalcon\Config([
'throttle' => [
'maxHits' => [
// Mintues => Max Hits
1 => 10,
60 => 250,
1440 => 4500,
],
'checkUserAgent' => false,
// Cache key prefix
'prefix' => '_',
],
]);
```
#### Usage
Middlewares can be used as a wrapper to app using `PhalconExt\Http\Middlewares` manager.
```php
$app = new Phalcon\Mvc\Micro($di);
// Set all your middlewares in an array using class FQCN, they are lazily loaded
// They are executed in order of their presence
// If a middleware returns `false` from its `before()` or `after()` events,
// all other middlewares down the line are skipped
$middlewares = new PhalconExt\Http\Middlewares([
PhalconExt\Http\Middleware\Throttle::class,
PhalconExt\Http\Middleware\ApiAuth::class,
PhalconExt\Http\Middleware\Cors::class,
PhalconExt\Http\Middleware\Cache::class,
]);
// Wrap and run the app!
$middlewares->wrap($app);
// The app is wrapped and run automatically so you dont have to do:
// $app->handle();
```
---
### Logger.EchoLogger
#### log(string $message, int $type, array $context = [])
Echoes anything right away - but you can control formatting and log level.
```php
$echo = $this->di(\PhalconExt\Logger\EchoLogger::class, ['config' => ['level' => Logger::INFO]]);
$echo->log('Message {a}', \Phalcon\Logger::INFO, ['a' => 'ok']);
```
### Logger.LogsToFile
#### log(string $message, int $type, array $context = [])
Delegate mundane file logging task to this trait thereby cutting down boilerplate codes.
```php
class AnyClass
{
use \PhalconExt\Logger\LogsToFile;
protected $fileExtension = '.log';
public function anyFn()
{
$this->activate('/path/to/log/dir/');
$this->log('Some message', \Phalcon\Logger::INFO);
}
}
```
---
### Mail.Mailer
A Phalcon adapter/bridge/container/delegator (read: abcd) to swiftmailer.
#### Setup
```php
$di->setShared('config', new \Phalcon\Config([
'mail' => [
'driver' => 'null',
'from' => [
'name' => 'Test',
'email' => 'test@localhost',
],
// for driver 'smtp':
'host' => 'smtp.server.com',
'port' => 425,
'encryption' => true,
'username' => 'user',
'password' => 'pass',
// for driver sendmail only (optional)
'sendmail' => '/sendmail/binary',
],
]);
$di->setShared('mailer', function () {
return new \PhalconExt\Mail\Mailer($this->get('config')->toArray()['mail']);
});
```
### Mail.Mail
A child of swiftmail message to allow attaching attachments without much ado.
```php
$mail = $di->get('mailer')->newMail();
// Or from view template
$mail = $di->get('mailer')->newTemplateMail('view/file.twig', ['view' => 'params']);
$mail->setTo('test@localhost')->setSubject('Hi')->setBody('Hello')->mail();
// Attachments:
$mail->attachFile('/path/to/file', 'optional attachment name');
$mail->attachFiles(['/path/to/file1', '/path/to/file2']);
// OR
$mail->attachFiles([
'attachment name 1' => '/path/to/file1',
'attachment name 2' => '/path/to/file2',
]);
$mail->attachRaw('Raw plain text data', 'rawtext.txt', 'text/plain');
```
### Mail.Mailable
#### mail()
Like Logger.LogsToFile above, but for mails.
```php
class AnyClass
{
use \PhalconExt\Mail\Mailable;
public function anyFn()
{
$this->mail('test@local', 'Hi', ['body' => 'Hello']);
$this->mail('test@local', 'Hi', ['template' => 'view/file.twig', 'params' => ['key' => 'value']]);
}
}
```
### Mail.Logger
Automatically logs all sent mails into file as a swiftmailer event listener- you can choose log formats: `eml | html | json`.
#### Setup
```php
$di->setShared('config', new \Phalcon\Config([
'mail' => [
'driver' => 'null',
'from' => [
'name' => 'Test',
'email' => 'test@localhost',
],
'logger' => [
'enabled' => true,
'logPath' => __DIR__ . '/.var/mail/', // directory
'type' => 'eml', // options: json, html, eml
],
],
]);
// When setting mailer, include config `mail>logger` and it is auto set up.
$di->setShared('mailer', function () {
return new \PhalconExt\Mail\Mailer($this->get('config')->toArray()['mail']);
});
```
---
### Util.OpcachePrimer
#### prime(array $paths): int
Ensures to warm up opcache for all files in given path well before file exceution.
Opcache caches are specific to the sapi it is run. So for web, you need to have an endpoint
```php
$primer = new \PhalconExt\Util\OpcachePrimer;
$total = $primer->prime(['/path/to/project/src', '/path/to/project/app/', '/path/to/project/vendor/']);
```
---
### Validation.Validation
Validate data like we did in elsewhere- setting rules as .well-known strings or key=>value pairs (array).
#### Setup
```php
$di->setShared('validation', \PhalconExt\Validation\Validation::class);
```
#### register(string $ruleName, $handler, string $message = ''): self
Register a new validation rule.
```php
$di->get('validation')->register('gmail', function ($data) {
// You can access current validation instance with `$this`
// You can also access current validator options with `$this->getOption(...)`
return stripos($this->getCurrentValue(), '@gmail.com') > 0;
}, 'Field :field must be an email with @gmail.com');
```
#### registerRules(array $ruleHandlers, array $messages = []): self
Register many new validation rules at once.
```php
$di->get('validation')->registerRules([
'rule1' => function($data) { return true; },
'rule1' => function($data) { return false; },
], [
'rule1' => 'message1',
'rule2' => 'message2'
]);
```
#### Usage
```php
$validation = $this->di('validation');
$rules = [
// Can be string (With `abort` if the field `id` is invalid, following validations are aborted)
'id' => 'required|length:min:1;max:2;|in:domain:1,12,30|abort',
// Can be an array too
'email' => [
'required' => true,
'gmail' => true,
// With `abort` if the field `email` is invalid, following validations are aborted
'abort' => true,
],
// validate if only exist in dataset
'xyz' => 'length:5|if_exist',
];
// Validate against empty data (can be array or object)
$data = []; // OR $data = new \stdClas OR $data = new SomeClass($someData)
$validation->run($rules, $data);
$pass = $validation->pass(); // false
$fail = $validation->fail(); // true
$errors = $validation->getErrorMessages(); // array
```
#### Validation.Existence
Validates if something exists in database. You can optionally set table and column to check.
```php
// Checks `users` table for `id` column with value 1
$rules = ['users' => 'exist'];
$data = ['users' => 1]; // Data can be array
// Checks `users` table for `username` column with value 'admin'
$rules = ['username' => 'exist:table:users'];
$data = new User(['username' => 'admin']); // Data can be model/entity
// Checks `users` table for `login` column with value 'admin@localhost'
$rules = ['email' => 'exist:table:users;column:login'];
$data = (object) ['email' => 'admin@localhost']; // Data can be any Object
// Run the rules
$validation->run($rules, $data);
```
---
### View.Twig
Use twig view natively in Phalcon
#### Setup
```php
$di->setShared('config', new \Phalcon\Config([
'view' => [
'dir' => __DIR__ . '/view/',
],
// Required
'twig' => [
'view_dirs' => [__DIR__ . '/view/'], // array
'auto_reload' => getenv('APP_ENV') !== 'prod',
'cache' => __DIR__ . '/.var/view/',
// ... other options (see twig docs)
],
]);
// You must have view setup with twig engine enabled.
$di->setShared('view', function () {
return (new View)
->setViewsDir($this->get('config')->toArray()['view']['dir'])
->registerEngines([
'.twig' => 'twig',
]);
});
$di->setShared('twig', function () {
$twig = new PhalconExt\View\Twig($this->get('view'), $this);
// Here you can:
// $twig->addFilter(...)
// $twig->addExtension(...)
return $twig;
});
```
#### Usage
```php
// standalone
$di->get('twig')->render('template.twig', ['view' => 'params']);
// or as view
$di->get('view')->render('template.twig', ['view' => 'params']); // .twig is optional
```
---
You can also see the [example](./example) codes for all these. Read [more](./example/readme.md).
### Related Projects
- [adhocore/cli](https://github.com/adhocore/cli)
- [adhocore/jwt](https://github.com/adhocore/jwt)
- [adhocore/cron-expr](https://github.com/adhocore/cron-expr)
## License
> © 2017-2020, [Jitendra Adhikari](https://github.com/adhocore) | [MIT](./LICENSE)
### Credits
This project is release managed by [please](https://github.com/adhocore/please).