Laravel 5 Repositories

To support Laravel 13 (illuminate/* ^13.0), you must widen the composer.json constraints and update the PHP requirement to ^8.2. This upgrade also involves modernizing the PHPUnit configuration to the PHPUnit 12 schema and ensuring compatibility with prettus/laravel-validation.

"require": {
    "php": "^8.2",
    "illuminate/http": "^8.0|^9.0|^10.0|^11.0|^12.0|^13.0",
    "illuminate/config": "^8.0|^9.0|^10.0|^11.0|^12.0|^13.0",
    "illuminate/support": "^8.0|^9.0|^10.0|^11.0|^12.0|^13.0",
    "illuminate/database": "^8.0|^9.0|^10.0|^11.0|^12.0|^13.0",
    "illuminate/pagination": "^8.0|^9.0|^10.0|^11.0|^12.0|^13.0",
    "illuminate/console": "^8.0|^9.0|^10.0|^11.0|^12.0|^13.0",
    "illuminate/filesystem": "^8.0|^9.0|^10.0|^11.0|^12.0|^13.0",
    "illuminate/validation": "^8.0|^9.0|^10.0|^11.0|^12.0|^13.0",
    "prettus/laravel-validation": "~1.4|~1.5|~1.6|~1.7|~1.8"
}

When upgrading to version 3.0, ensure your environment meets the new requirements and perform the following configuration updates:

Requirements

• PHP: 8.2 or higher.
• Laravel: 8 or higher.

Action Items

1. Update Dependencies: Remove prettus/laravel-validation from your composer.json if it was only used transitively through this package. The source is now bundled directly under the Prettus\✨Validator namespace.
2. Configure Cache Serialization: Laravel 13 hardens cache.serializable_classes to false by default. If you use the CacheableRepository trait, you must whitelist your concrete model and criterion classes in config/cache.php to prevent unserialization failures.
3. Refresh Autoloading: Run composer dump-autoload to ensure the bundled validator source is correctly mapped.
4. Verify Cache Time: CacheableRepository::getCacheTime() now always returns seconds. If your application logic was targeting Laravel 5.7 or earlier (which used minutes), you must multiply your $cacheMinutes value by 60.

// Update config/cache.php to whitelist classes used in CacheableRepository
'serializable_classes' => [
    Illuminate\Support\Collection::class,
    Illuminate\Pagination\LengthAwarePaginator::class,
    App\Repositories\Criteria\YourCriterion::class,
    App\Models\YourEloquentModel::class,
],

Presenters wrap and render objects (usually via Fractal).

Implementation Methods:

1. Transformer Class: Create a class extending TransformerAbstract. Create a Presenter that returns this transformer in getTransformer(). Enable it in the repository via presenter().
2. Transformable Model: Make your model implement Prettus\Repository\Contracts\Transformable and use the default Prettus\Repository\Presenter\ModelFractalPresenter in your repository.

Usage:

• Enable in repository: public function presenter() { return "App\\Presenter\\PostPresenter"; }
• Enable in controller: $this->repository->setPresenter("App\\Presenter\\PostPresenter");
• Skip presenter: $this->repository->skipPresenter()->all();

use League\Fractal\TransformerAbstract;

class PostTransformer extends TransformerAbstract
{
    public function transform(\Post $post)
    {
        return [
            'id'      => (int) $post->id,
            'title'   => $post->title,
            'content' => $post->content
        ];
    }
}

The RequestCriteria enables dynamic searching and filtering via URL parameters.

Setup:

1. Define $fieldSearchable in your repository to specify which fields can be searched (supports relations like product.name).
2. You can specify the operator (default is =) in the $fieldSearchable array (e.g., 'name' => 'like').
3. Push the criteria in the repository boot() method or directly in the controller.

URL Parameters:

• search: Search for values (e.g., ?search=name:John Doe).
• searchFields: Specify fields and operators (e.g., ?searchFields=name:like).
• searchJoin: Change the join operator between multiple search terms (default is OR, use ?searchJoin=and for AND).
• filter: Filter specific fields (e.g., ?filter=id;name).
• orderBy / sortedBy: Sort results (e.g., ?orderBy=id&sortedBy=desc).
• with: Include relationships (e.g., ?with=groups).

class PostRepository extends BaseRepository {
    protected $fieldSearchable = [
        'name' => 'like',
        'email' // Default is "="
    ];

    public function boot(){
        $this->pushCriteria(app('Prettus\Repository\Criteria\RequestCriteria'));
    }
}

To support PHPUnit 12, replace the existing phpunit.xml with the new schema. This removes deprecated attributes like backupStaticAttributes and convertErrorsToExceptions, and adds a <source> block for coverage. Additionally, add .phpunit.cache and .phpunit.result.cache to your .gitignore file.

<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
         bootstrap="vendor/autoload.php"
         colors="true"
         failOnWarning="true"
         failOnRisky="true"
         cacheDirectory=".phpunit.cache">
    <testsuites>
        <testsuite name="Prettus Repository Test Suite">
            <directory suffix="Test.php">./tests/</directory>
        </testsuite>
    </testsuites>
    <source>
        <include>
            <directory suffix=".php">./src/</directory>
        </include>
    </source>
</phpunit>

To add caching to your repository, implement CacheableInterface and use the CacheableRepository trait.

Configuration: Settings can be managed in config/repository.php or overridden directly in the repository class.

Repository Overrides:

• $cacheMinutes: Set the lifetime of the cache.
• $cacheOnly: Array of methods to cache.
• $cacheExcept: Array of methods to exclude from caching.

Cacheable Methods: all, paginate, find, findByField, findWhere, getByCriteria.

use Prettus\Repository\Eloquent\BaseRepository;
use Prettus\Repository\Contracts\CacheableInterface;
use Prettus\Repository\Traits\CacheableRepository;

class PostRepository extends BaseRepository implements CacheableInterface {
    use CacheableRepository;

    protected $cacheMinutes = 90;
    protected $cacheOnly = ['all', ...];

    function model() {
       return "App\\Post";
    }
}