init

Author: Marius

.gitignore

@@ -0,0 +1,3 @@
+/vendor
+/.idea
+composer.lock

README.md

@@ -0,0 +1,42 @@
+# laravel-crud-wizard-client-free
+
+ This is a stripped down version of [laravel-lumen-crud-wizard-client](https://github.com/macropay-solutions/laravel-lumen-crud-wizard-client)
+
+ that can be used for calling [laravel-crud-wizard-free](https://github.com/macropay-solutions/larave-crud-wizard-free)
+
+## Install
+
+    composer require macropay-solutions/laravel-crud-wizard-client-free
+
+## Start using it
+
+```php
+
+    $crud = new \MacroPaySolutions\LaravelCrudWizardClient\RequestBuilder(\env('API_BEARER'), \env('APP_URL'));
+
+    try {
+        $result = $crud->list('clients', $crud->getBuilder()->sort('country', 'asc')
+            ->sort('zip')->equals('name', 'alt')->withRelation('relation')
+            ->withRelations(['rel1', 'rel2'])
+            ->addCountRelations(['relation1'])->addExistRelation('relation2');
+        $result = $crud->get('clients', '73', ['rel1', 'rel2']);
+        $result = $crud->delete('clients', '73');
+        $result = $crud->create('clients', [
+            'active' => '1',
+            'name' => 'abc',
+            // ...
+        ]);
+        $result = $crud->update('clients', '73', [
+            'active' => '1',
+            'name' => 'abc',
+            // ...
+        ]);
+    } catch (\Exception $e) {
+        $decodedErrorMessage = \json_decode($e->getMessage());
+        echo $decodedErrorMessage->message;
+    }
+
+    $decodedResult = \json_decode($result);
+```
+
+Discover more methods available by installing it.

composer.json

@@ -0,0 +1,40 @@
+{
+  "name": "macropay-solutions/laravel-crud-wizard-client-free",
+  "type": "library",
+  "description": "Request builder for calling projects that implement macropay-solutions/laravel-crud-wizard-free",
+  "keywords": [
+    "crud",
+    "wizard",
+    "builder",
+    "client",
+    "initiator",
+    "free"
+  ],
+  "minimum-stability": "dev",
+  "prefer-stable": true,
+  "license": "MIT",
+  "require": {
+    "php": "^7.4|^8.0",
+    "ext-json": "*"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^9.4",
+    "guzzlehttp/guzzle": "^7.5.0",
+    "psr/log": "^1.0 || ^2.0 || ^3.0"
+  },
+  "extra": {
+    "branch-alias": {
+      "dev-master": "production"
+    }
+  },
+  "autoload": {
+    "psr-4": {
+      "MacropaySolutions\\LaravelCrudWizardClient\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "MacropaySolutions\\LaravelCrudWizardClient\\Test\\": "tests/"
+    }
+  }
+}

src/QueryStringBuilder.php

@@ -0,0 +1,154 @@
+<?php
+
+namespace MacropaySolutions\LaravelCrudWizardClient;
+
+/**
+ * @see ../README.md
+ */
+class QueryStringBuilder
+{
+    public bool $sqlDebug = false;
+    private ?int $simplePaginate = null;
+    private ?string $cursor = null;
+    private int $page = 1;
+    private int $limit = 10;
+    private array $sort = [];
+    private array $withRelations = [];
+    private array $countRelations = [];
+    private array $existRelations = [];
+    private ResourceFilterBuilder $resourceFilters;
+    private array $rawRequest = [];
+
+    public function __construct()
+    {
+        $this->resourceFilters = new ResourceFilterBuilder();
+    }
+
+    /**
+     * by using this, all other conditions set by using other methods will be ignored
+     */
+    public function setRawRequest(array $request): self
+    {
+        $this->rawRequest = $request;
+
+        return $this;
+    }
+
+    public function page(int $page): self
+    {
+        $this->page = $page;
+
+        return $this;
+    }
+
+    public function limit(int $limit): self
+    {
+        $this->limit = $limit;
+
+        return $this;
+    }
+
+    public function sort(string $by, string $dir = 'DESC'): self
+    {
+        $this->sort[] = ['by' => $by, 'dir' => $dir];
+
+        return $this;
+    }
+
+    public function equals(string $column, $is): self
+    {
+        $this->resourceFilters->equals($column, $is);
+
+        return $this;
+    }
+
+    /**
+     * @param string|null $cursor use '1' for 1st page, null for non cursor pagination
+     */
+    public function simplePaginate(?string $cursor = null): self
+    {
+        $this->simplePaginate = 1;
+        $this->cursor = $cursor;
+
+        return $this;
+    }
+
+    public function withRelation(string $relation): self
+    {
+        $this->withRelations[] = $relation;
+
+        return $this;
+    }
+
+    public function withRelations(array $relations): self
+    {
+        $this->withRelations = \array_merge(\array_values($relations), $this->withRelations);
+
+        return $this;
+    }
+
+    public function addCountRelation(string $countRelation): self
+    {
+        $this->countRelations[] = $countRelation;
+
+        return $this;
+    }
+
+    public function addCountRelations(array $countRelations): self
+    {
+        $this->countRelations = \array_merge(\array_values($countRelations), $this->countRelations);
+
+        return $this;
+    }
+
+    public function addExistRelation(string $existRelation): self
+    {
+        $this->existRelations[] = $existRelation;
+
+        return $this;
+    }
+
+    public function addExistRelations(array $existRelations): self
+    {
+        $this->existRelations = \array_merge(\array_values($existRelations), $this->existRelations);
+
+        return $this;
+    }
+
+    public function getUrlQueryString(array $overrides = []): string
+    {
+        if ($this->rawRequest !== []) {
+            return \http_build_query(\array_merge(
+                $this->rawRequest,
+                $overrides
+            ), '', '&', PHP_QUERY_RFC3986);
+        }
+
+        return \http_build_query(\array_merge(
+            $this->getAllFilters(),
+            $overrides
+        ), '', '&', PHP_QUERY_RFC3986);
+    }
+
+    public function getAllFilters(): array
+    {
+        return \array_merge(
+            $this->getFilters(),
+            $this->sqlDebug ? ['sqlDebug' => 1] : [],
+            $this->simplePaginate !== null ? ['simplePaginate' => $this->simplePaginate] : [],
+            $this->cursor !== null ? ['cursor' => $this->cursor] : [],
+        );
+    }
+
+    private function getFilters(): array
+    {
+        return \array_merge($this->sqlDebug ? ['sqlDebug' => 1] : [], [
+            'page' => $this->page,
+            'limit' => $this->limit,
+            'sort' => $this->sort,
+            'withRelations' => \array_values(\array_unique($this->withRelations)),
+            'withRelationsCount' => \array_values(\array_unique($this->countRelations)),
+            'withRelationsExistence' => \array_values(\array_unique($this->existRelations)),
+        ], $this->resourceFilters->getFilters());
+    }
+}