dded functionality to inject custom builder class for handling conflicting packages.

Author: mikebronner

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.10.2] - 2020-09-04
+### Added
+- functionality to inject custom builder class for handling conflicting packages.
+
 ## [0.10.1] - 2020-08-02
 ### Fixed
 - typos in test class.
@@ -307,7 +311,7 @@ Pushed changes intended for 0.5.1. Forgot to push changes to repo. 👀
 
 ## [0.3.3] - 10 Nov 2018
 ### Fixed
-- typo in method `checkCooldownAndFlushAfterPersiting()` to 
+- typo in method `checkCooldownAndFlushAfterPersiting()` to
   `checkCooldownAndFlushAfterPersisting()`; thanks @jacobzlogar!
 
 ## [0.3.2] - 3 Nov 2018

README.md

@@ -62,7 +62,28 @@ The following are packages we have identified as incompatible:
 - [chelout/laravel-relationship-events](https://github.com/chelout/laravel-relationship-events)
 - [spatie/laravel-query-builder](https://github.com/spatie/laravel-query-builder)
 - [dwightwatson/rememberable](https://github.com/dwightwatson/rememberable)
-- [kalnoy/nestedset](https://github.com/kalnoy/nestedset)
+- [kalnoy/nestedset](https://github.com/lazychaser/laravel-nestedset)
+
+#### Override
+It may be possible to insert the custom querybuilder of the conflicting package
+into this package by adding the following to your AppServiceProvider, in this
+example we are implementing the NestedSet QueryBuilder:
+```php
+//...
+use GeneaLabs\LaravelModelCaching\ModelCaching;
+use Kalnoy\Nestedset\QueryBuilder;
+
+class AppServiceProvider extends ServiceProvider
+{
+    public function boot()
+    {
+        ModelCaching::useBuilder(QueryBuilder::class);
+        //...
+    }
+
+    //...
+}
+```
 
 ### Things That Don't Work Currently
 The following items currently do no work with this package:

phpcs.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="PHP_CodeSniffer" xsi:noNamespaceSchemaLocation="phpcs.xsd">
+    <description>GeneaLabs coding standards.</description>
+
+    <rule ref="PSR1"></rule>
+    <rule ref="PSR2"></rule>
+    <rule ref="PSR12">
+        <exclude name="PSR12.Classes.ClassInstantiation.MissingParentheses"/>
+        <exclude name="PSR12.Functions.ReturnTypeDeclaration.SpaceBeforeColon"/>
+    </rule>
+</ruleset>

src/CachedBuilder.php

@@ -1,9 +1,8 @@
 <?php namespace GeneaLabs\LaravelModelCaching;
 
-use GeneaLabs\LaravelModelCaching\Traits\BuilderCaching;
 use GeneaLabs\LaravelModelCaching\Traits\Buildable;
+use GeneaLabs\LaravelModelCaching\Traits\BuilderCaching;
 use GeneaLabs\LaravelModelCaching\Traits\Caching;
-use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
 
 class CachedBuilder extends EloquentBuilder
 {

src/Helper.php

@@ -1,4 +1,6 @@
-<?php namespace GeneaLabs\LaravelModelCaching;
+<?php
+
+namespace GeneaLabs\LaravelModelCaching;
 
 use Illuminate\Container\Container;
 

src/ModelCaching.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace GeneaLabs\LaravelModelCaching;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class ModelCaching
+{
+    protected static $builder = Builder::class;
+
+    public static function useEloquentBuilder(string $builder) : void
+    {
+        self::$builder = $builder;
+    }
+
+    public static function builder()
+    {
+        return self::$builder;
+    }
+}

src/Providers/Service.php

@@ -1,8 +1,11 @@
-<?php namespace GeneaLabs\LaravelModelCaching\Providers;
+<?php
+
+namespace GeneaLabs\LaravelModelCaching\Providers;
 
 use GeneaLabs\LaravelModelCaching\Console\Commands\Clear;
 use GeneaLabs\LaravelModelCaching\Console\Commands\Publish;
 use GeneaLabs\LaravelModelCaching\Helper;
+use GeneaLabs\LaravelModelCaching\ModelCaching;
 use Illuminate\Support\ServiceProvider;
 
 class Service extends ServiceProvider
@@ -24,6 +27,13 @@ public function boot()
 
     public function register()
     {
+        if (! class_exists('GeneaLabs\LaravelModelCaching\EloquentBuilder')) {
+            class_alias(
+                ModelCaching::builder(),
+                'GeneaLabs\LaravelModelCaching\EloquentBuilder'
+            );
+        }
+
         $this->app->bind("model-cache", Helper::class);
     }
 }

src/Traits/ModelCaching.php

@@ -2,8 +2,7 @@
 
 use GeneaLabs\LaravelModelCaching\CachedBelongsToMany;
 use GeneaLabs\LaravelModelCaching\CachedBuilder;
-use Illuminate\Container\Container;
-use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use GeneaLabs\LaravelModelCaching\EloquentBuilder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Support\Carbon;