Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arodu/utilcake
UtilCake plugin for CakePHP 4.x
https://github.com/arodu/utilcake
cakephp cakephp4 composer google-login plugin recaptcha-v3 utilcake-plugin utilities
Last synced: 25 days ago
JSON representation
UtilCake plugin for CakePHP 4.x
- Host: GitHub
- URL: https://github.com/arodu/utilcake
- Owner: arodu
- License: mit
- Created: 2020-07-05T22:11:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-29T21:13:23.000Z (almost 4 years ago)
- Last Synced: 2024-05-21T08:23:55.720Z (6 months ago)
- Topics: cakephp, cakephp4, composer, google-login, plugin, recaptcha-v3, utilcake-plugin, utilities
- Language: PHP
- Homepage: https://packagist.org/packages/arodu/utilcake
- Size: 12.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UtilCake plugin for CakePHP 4.x
CakePHP Plugin, collection of utilities for CakePHP 4.x
## Installation
You can install this plugin into your CakePHP application using [composer](https://getcomposer.org).
The recommended way to install composer packages is:
```sh
composer require arodu/utilcake
```
## Configuration
You can load the plugin using the shell command:
```sh
bin/cake plugin load UtilCake
```
Or you can manually add the loading statement in the **src/Application.php** file of your application:
```php
public function bootstrap(){
parent::bootstrap();
$this->addPlugin('UtilCake');
}
```
## How to use
### Google reCaptcha V3
In the controller file
```php
public function initialize(): void{
parent::initialize();
$this->loadComponent('UtilCake.ReCaptcha', [
'public_key'=>'RECAPTCHA_PUBLIC_KEY',
'secret_key'=>'RECAPTCHA_SECRET_KEY',
]);
}
// any action
public function action(){
// ...
if ($this->request->is('post')) {
if($this->ReCaptcha->verify($this->request->getData())){
// when the verification is successful
// ...
}else{
// when the verification is not successful
$this->Flash->error(__('reCaptcha failed, try again'));
}
}
// ...
}
```
In the template `templates/ControllerName/action.php`
```php
echo $this->Form->create(null, ['id'=>'form-id']);
// ...
echo $this->Form->end();
$this->ReCaptcha->script('#form-id');
```
### Google login
with AuthenticationComponent
In the login template, ex:`/templates/Users/login.php`
```php
echo $this->GoogleLogin->link(__('Sign in with Google'),
['class' => 'btn btn-block btn-danger', 'escape' => false]
);
```
In the controller file, ex:`/Controller/UsersController.php`
```php
public function initialize(): void{
parent::initialize();
$this->loadComponent('UtilCake.GoogleLogin', [
'client_id' => GOOGLE_CLIENT_ID,
'client_secret' => GOOGLE_CLIENT_SECRET,
'redirect_uri' => Router::url([
'controller' => 'Users',
'action' => 'googleLogin',
'prefix' => false,
'_full' => true
]),
]);
}
//...
public function googleLogin() {
if (!empty($this->request->getQuery('code'))) {
try {
$data = $this->GoogleLogin->getAccessToken($this->request->getQuery('code'));
$user_profile_info = $this->GoogleLogin->getUserProfileInfo($data['access_token']);
$user = $this->Users->find()
->where(['Users.email' => $user_profile_info['email']])
->first();
if ($user) {
$this->Authentication->setIdentity($user);
$target = $this->Authentication->getLoginRedirect() ?? '/';
return $this->redirect($target);
}
$this->Flash->error('Invalid google login');
} catch (\Exception $e) {
throw new NotFoundException($e->getMessage());
}
}
return $this->redirect(['action' => 'login']);
}
```