https://github.com/eduzz/activity-history-php
Activity History PHP
https://github.com/eduzz/activity-history-php
Last synced: 5 months ago
JSON representation
Activity History PHP
- Host: GitHub
- URL: https://github.com/eduzz/activity-history-php
- Owner: eduzz
- Created: 2020-12-09T13:19:40.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-26T19:15:16.000Z (over 1 year ago)
- Last Synced: 2025-05-14T11:28:56.532Z (about 1 year ago)
- Language: PHP
- Size: 32.2 KB
- Stars: 0
- Watchers: 40
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Activity History (PHP Package)
Esta lib tem como objetivo integrar os sistemas com o serviço Activity History de uma forma mais simples e eficaz. Com algumas linhas de código, já será possível enviar logs de aplicação.
## Instalação (via composer)
Utilize o comando abaixo para instalar os pacotes do projeto.
```sh
composer require eduzz/activity-history-php
```
## Projetos Laravel
Após realizado os passos anteriores, é necessário realizar o seguinte comando no terminal, que gerará o arquivo **config/activityhistory.php**.
```sh
php artisan vendor:publish --tag="config"
```
No arquivo **config/app.php**
```php
// ...
'providers' => [
// ...
Eduzz\ActivityHistory\ActivityHistoryServiceProvider::class,
],
```
## Projetos Lumen
No Lumen o arquivo config deve ser copiado manualmente. Após a instalação dos pacotes do composer, crie uma pasta **config** na raíz do projeto, e copie o arquivo **vendor/eduzz/activity-history-php/src/config/activityhistory.php** para o diretório criado.
No arquivo **bootstrap/app.php**
```php
// ...
$app->configure('activityhistory');
// ...
$app->register(Eduzz\ActivityHistory\ActivityHistoryServiceProvider::class);
// ...
```
##
## Configurando o Activity History
No arquivo **config/activityhistory.php**, tem duas configurações iniciais a se fazer:
* **secret** => é o hash da aplicação que usará o Activity History. Necessário entrar em contato com a equipe para adquirir esta chave.
## Usando o Activity History
Para realizar o envio de logs, basta injetar o Activity History em sua classe e setar os dados conforme abaixo:
```php
$this->activityHistory->setUser(
'application_user_id'
);
$this->activityHistory->setUrl('https://example.com');
$oldData = [
'name' => 'old name',
'email' => 'example@example.com'
];
$beforeData = [
'name' => 'new name',
'email' => 'example@example.com'
];
$excerpt = [
'name' => 'new name'
];
$this->activityHistory->publish(
new ProductUpdate(
$excerpt,
$oldData,
$beforeData
)
);
```