https://github.com/foxws/laravel-algos

Create algorithms (algos) for your Laravel application.
https://github.com/foxws/laravel-algos

actions algorithms algos laravel

Last synced: about 2 months ago
JSON representation

Create algorithms (algos) for your Laravel application.

• Host: GitHub
• URL: https://github.com/foxws/laravel-algos
• Owner: foxws
• License: mit
• Created: 2024-10-30T11:06:03.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-10-30T20:39:39.000Z (about 2 months ago)
• Last Synced: 2024-10-30T21:25:00.209Z (about 2 months ago)
• Topics: actions, algorithms, algos, laravel
• Language: PHP
• Homepage:
• Size: 33.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Laravel Algos

[![Latest Version on Packagist](https://img.shields.io/packagist/v/foxws/laravel-algos.svg?style=flat-square)](https://packagist.org/packages/foxws/laravel-algos)

[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/foxws/laravel-algos/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/foxws/laravel-algos/actions?query=workflow%3Arun-tests+branch%3Amain)

[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/foxws/laravel-algos/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/foxws/laravel-algos/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)

[![Total Downloads](https://img.shields.io/packagist/dt/foxws/laravel-algos.svg?style=flat-square)](https://packagist.org/packages/foxws/laravel-algos)

This package can be used to create algorithms (algos) for your Laravel application.

## Installation

You can install the package via composer:

```bash

composer require foxws/laravel-algos

```

You can publish the config file with:

```bash

php artisan vendor:publish --tag="algos-config"

```

## Usage

Generate an `Algo` class (you may also use `php artisan make:algo MyAlgo`):

```php

use Foxws\Algos\Algos\Algo;

use Foxws\Algos\Algos\Result;

use Foxws\Algos\Tests\Models\Post;

use Foxws\Algos\Tests\Models\User;

use Illuminate\Support\Collection;

use Illuminate\Support\Str;

class GenerateUserFeed extends Algo

{

    protected ?User $user = null;

    public function handle(): Result

    {

        $hash = $this->generateUniqueId();

        cache()->set(

            $this->generateUniqueId(),

            ['ids' => (array) $this->getCollection()],

            now()->addMinutes(10),

        );

        return $this

            ->success('Feed generated successfully')

            ->with('hash', $hash);

    }

    public function model(User $user): self

    {

        $this->user = $user;

        return $this;

    }

    protected function getCollection(): Collection

    {

        return Post::query()

            ->select('id')

            ->where('user_id', $this->user->getKey())

            ->inRandomOrder()

            ->take(5)

            ->get();

    }

    protected function generateUniqueId(): string

    {

        return Str::ulid();

    }

}

```

To run the algorithm:

```php

$algo = GenerateUserFeed::make()->model($user)->run();

// $algo->status; // success, failed, skipped

// $algo->message; // reason

// $algo->meta; // array of metadata

```

## Testing

```bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [francoism90](https://github.com/foxws)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.