Merge pull request #36 from kirschbaum-development/feature/third-party-integrations

Feature/third party integrations

Author: navneetrai

README.md

@@ -75,6 +75,56 @@ Occasionally you may want to require a child relationship during the creation of
 HasOne::make('Profile', 'profile', Profile::class)->inline()->requireChild(),
 ```
 
+## Support for Third Party Packages
+
+We have included a simple way to address some issues regarding third party packages occasionally not working with Nova Inline Relationships. These packages occasionally handle how they return their subset of fields slightly different. We have a way of easily integrating functionality for these packages. This may not work across the board, but should allow for most third party packages.
+
+You must publish the configs for this package with
+
+```shell script
+php artisan vendor:publish
+```
+
+This will publish a config file as `config/nova-inline-relationships.php`. Add your custom namespaced paths within the `third-party` array. For example:
+
+```php
+'third-party' => [
+    'App\Nova\ThirdPartyIntegrations',
+    'KirschbaumDevelopment\NovaInlineRelationship\Integrations',
+]
+``` 
+
+Create a new class inside that namespace that looks like the following:
+
+```php
+<?php
+
+namespace App\Nova\ThirdPartyIntegrations;
+
+use KirschbaumDevelopment\NovaInlineRelationship\Integrations\ThirdParty;
+use KirschbaumDevelopment\NovaInlineRelationship\Integrations\Contracts\ThirdPartyContract;
+
+class SomeThirdPartyField extends ThirdParty implements ThirdPartyContract
+{
+    /**
+     * Fields array from object.
+     *
+     * @return array
+     */
+    public function fields(): array
+    {
+        // The following is just an example and should be updated to meet your needs.
+        return $this->field->customFieldArray;
+    }
+}
+```
+
+The name of the class is very important. It should be the same name as the field used within the Nova resource. If the field class is `CustomField`, the third party integration class should also be called `CustomField`.
+
+The `fields()` method should return an array of all the custom field's or package's fields array.
+
+If you feel that the third party integration you've created should be included in this package, please create a pull request and we will look over it! 
+
 ## Supported Relationships
 
 The following eloquent relationships are currently supported:

config/config.php

@@ -0,0 +1,7 @@
+<?php
+
+return [
+    'third-party' => [
+        'KirschbaumDevelopment\NovaInlineRelationship\Integrations',
+    ],
+];

src/Exceptions/ContractMissingException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace KirschbaumDevelopment\NovaInlineRelationship\Exceptions;
+
+use Exception;
+
+class ContractMissingException extends Exception
+{
+}

src/Integrations/Contracts/ThirdPartyContract.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace KirschbaumDevelopment\NovaInlineRelationship\Integrations\Contracts;
+
+interface ThirdPartyContract
+{
+    /**
+     * ThirdPartyContract constructor.
+     *
+     * @param $field
+     */
+    public function __construct($field);
+
+    /**
+     * Fields array from object.
+     *
+     * @return array
+     */
+    public function fields(): array;
+}

src/Integrations/Field.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace KirschbaumDevelopment\NovaInlineRelationship\Integrations;
+
+use KirschbaumDevelopment\NovaInlineRelationship\Integrations\Contracts\ThirdPartyContract;
+
+class Field extends ThirdParty implements ThirdPartyContract
+{
+    /**
+     * Fields array from object.
+     *
+     * @return array
+     */
+    public function fields(): array
+    {
+        return [$this->field];
+    }
+}

src/Integrations/Integrate.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace KirschbaumDevelopment\NovaInlineRelationship\Integrations;
+
+use ReflectionClass;
+use KirschbaumDevelopment\NovaInlineRelationship\Exceptions\ContractMissingException;
+use KirschbaumDevelopment\NovaInlineRelationship\Integrations\Field as FieldInterface;
+use KirschbaumDevelopment\NovaInlineRelationship\Integrations\Contracts\ThirdPartyContract;
+
+class Integrate
+{
+    public static function fields($field): array
+    {
+        $basename = class_basename(get_class($field));
+
+        foreach (config('nova-inline-relationships.third-party') as $namespace) {
+            $class = "{$namespace}\\{$basename}";
+
+            if (class_exists($class)) {
+                $reflection = new ReflectionClass($class);
+
+                throw_unless(
+                    in_array(ThirdPartyContract::class, $reflection->getInterfaceNames()),
+                    ContractMissingException::class,
+                    sprintf('Third party integration [ %s ] does not implement [ %s ]', $class, ThirdPartyContract::class)
+                );
+
+                return (new $class($field))->fields();
+            }
+        }
+
+        return (new FieldInterface($field))->fields();
+    }
+}

src/Integrations/NovaDependencyContainer.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace KirschbaumDevelopment\NovaInlineRelationship\Integrations;
+
+use KirschbaumDevelopment\NovaInlineRelationship\Integrations\Contracts\ThirdPartyContract;
+
+class NovaDependencyContainer extends ThirdParty implements ThirdPartyContract
+{
+    /**
+     * Fields array from object.
+     *
+     * @return array
+     */
+    public function fields(): array
+    {
+        return $this->field->meta['fields'];
+    }
+}

src/Integrations/Panel.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace KirschbaumDevelopment\NovaInlineRelationship\Integrations;
+
+use KirschbaumDevelopment\NovaInlineRelationship\Integrations\Contracts\ThirdPartyContract;
+
+class Panel extends ThirdParty implements ThirdPartyContract
+{
+    /**
+     * Fields array from object.
+     *
+     * @return array
+     */
+    public function fields(): array
+    {
+        return $this->field->data;
+    }
+}

src/Integrations/ThirdParty.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace KirschbaumDevelopment\NovaInlineRelationship\Integrations;
+
+abstract class ThirdParty
+{
+    /**
+     * @var mixed
+     */
+    protected $field;
+
+    /**
+     * ThirdPartyContract constructor.
+     *
+     * @param $field
+     */
+    public function __construct($field)
+    {
+        $this->field = $field;
+    }
+}

src/NovaInlineRelationshipServiceProvider.php

@@ -17,7 +17,13 @@ class NovaInlineRelationshipServiceProvider extends ServiceProvider
      */
     public function boot()
     {
-        Nova::serving(function () {
+        if ($this->app->runningInConsole()) {
+            $this->publishes([
+                __DIR__ . '/../config/config.php' => config_path('nova-inline-relationships.php'),
+            ], 'nova-inline-relationships');
+        }
+
+        Nova::serving(function (ServingNova $event) {
             Nova::script('nova-inline-relationship', __DIR__ . '/../dist/js/field.js');
             Nova::style('nova-inline-relationship', __DIR__ . '/../dist/css/field.css');
         });
@@ -38,5 +44,6 @@ public function boot()
      */
     public function register()
     {
+        $this->mergeConfigFrom(__DIR__ . '/../config/config.php', 'nova-inline-relationships');
     }
 }