gorilla-soft/grimlock-php

Grimlock PHP - Libraries & Utilities for PHP

0.0.1 2025-04-15 17:20 UTC

Requires

• ext-curl: *
• ext-json: *
• ext-pdo: *
• dompdf/dompdf: v2.0.4
• google/auth: ^1.46
• guzzlehttp/guzzle: ^7.9
• illuminate/database: v10.39.0
• jimtools/jwt-auth: ^2.2.0
• monolog/monolog: ^3.9
• phpmailer/phpmailer: v6.9.1
• slim/psr7: ^1.7.0
• slim/slim: ^4.14.0
• vlucas/phpdotenv: ^5.6.1

Requires (Dev)

• phpunit/phpunit: ^10.5.45

MIT

• Rubén Darío Huamaní Ucharima

• php
• libraries
• utilities
• soft
• gorilla
• grimlock

README

¿Qué es Grimlock PHP?

Es un framework que permite construir APIs RESTful de manera sencilla.

Capacidades

• Cliente de apis REST
• Acceso a Base de Datos
• Generación de PDF en base a HTML
• Notificaciones Push Firebase
• Envío de Emails

Requisitos

• PHP 8.3.1 o superior
• Composer 2.5.5 o superior

Dependencias

• Slim 4
• Eloquent
• Guzzle
• Dotenv
• DomPDF
• PHPMailer
• PHPUnit
• JWT Auth
• Monolog
• Google Auth

Recommendaciones

Visita el wiki para mas información: https://github.com/GorillaSoft/grimlock-php/wiki

Instalación

La instalación es super facil con Composer:

composer require gorilla-soft/grimlock-php

Asegúrese de que el archivo de carga automática de Composer esté cargado.

// somewhere early in your project's loading, require the Composer autoloader
// see: http://getcomposer.org/doc/00-intro.md
require 'vendor/autoload.php';

Como usar

1. GrimlockFirebase - Notificación Push con Firebase

Se debe tener en la carpeta resources la public key de firebase con el nombre firebase.json.

Se debe tener las siguientes propiedades en el archivo .env

FCM_PROJECT_ID = {FIREBASE_PROJECT_ID}

Enviar una notificación a una persona

use Grimlock\Module\Notification\Firebase\GrimlockFirebase;
use Grimlock\Module\Notification\Firebase\Bean\Person;
use Grimlock\Module\Notification\Firebase\Bean\Notification;

$grimlockFirebase = new GrimlockFirebase();

$person = new Person();
$person->setName('Jon');
$person->setLastname('Doe');
$person->setIdRegistration('121212asdasdasdsadas');

$notification = new Notification();
$notification->setTitle('Message Push Test');
$notification->setBody('Hello {NAME} {LASTNAME}. It is a message test.');

$grimlockFirebase->sendNotification($notification, $person);

Enviar una notificación a personas inscritas en un tópico

use Grimlock\Module\Notification\Firebase\GrimlockFirebase;
use Grimlock\Module\Notification\Firebase\Bean\Notification;

$grimlockFirebase = new GrimlockFirebase();

$notification = new Notification();
$notification->setTopic("topic_test");
$notification->setTitle('Message Push Test');
$notification->setBody('Message Push Test');

$grimlockFirebase->sendNotification($notification);

2 GrimlockPdf - Generación de PDF desde HTML

use Grimlock\Module\Pdf\GrimlockPdf;

$grimlockPdf = new GrimlockPdf();
$grimlockPdf->loadHTML('../../templates/demo.html');
$grimlockPdf->generatePDF('../../pdf/demo.pdf');

3. GrimlockRestClient - Cliente Rest

use Grimlock\Module\RestClient\GrimlockRestClient;

$grimlockRestClient = new GrimlockRestClient('http://localhost:8080');
$grimlockRestClient->addHeader('Authorization', 'Bearer e32434sdfdsfdsfdsf');

//Return Object GrimlockResponse
$response = $grimlockRestClient->get('/customers');

if ($response->getCode() == 200) {
    $data = $response->getBody();
} 

Licencia

Grimlock PHP esta bajo Licencia MIT.