Advanced Usage

When interacting with the onOffice Adapter for Laravel in more sophisticated ways, you can leverage middlewares, advanced debugging, concurrency, and custom repository extensions.

Middlewares

Middlewares let you inject custom logic before each request is sent:

use Innobrain\OnOfficeAdapter\Facades\BaseRepository;
use Innobrain\OnOfficeAdapter\Dtos\OnOfficeRequest;

BaseRepository::query()
    ->before(function (OnOfficeRequest $request) {
        // Add a parameter dynamically
        $request->parameters['someDynamicKey'] = 'someValue';
    })
    ->call(
        new OnOfficeRequest(
            // For example: read an estate
        )
    );

TIP

Use multiple before calls to chain any number of middlewares.

Custom Endpoints with BaseRepository

When an endpoint or feature is not covered by the existing repositories, you can directly interact with onOffice using BaseRepository:

use Innobrain\OnOfficeAdapter\Facades\BaseRepository;
use Innobrain\OnOfficeAdapter\Dtos\OnOfficeRequest;
use Innobrain\OnOfficeAdapter\Enums\OnOfficeAction;

$results = BaseRepository::query()
    ->call(new OnOfficeRequest(
        OnOfficeAction::Read,
        'customResource' // If not defined in OnOfficeResourceType
    ));

Advanced Debugging

In addition to dd() (dump and die), the adapter supports:

// Dump the request without stopping execution
BaseRepository::query()->dump()->call(...);

// Dump the raw request payload
BaseRepository::query()->raw()->call(...);

// Record requests and responses
BaseRepository::record();
BaseRepository::query()->call(...);
$lastPair = BaseRepository::lastRecorded();

Combine them to tailor debugging to your needs.

Large Dataset Handling

To handle large datasets without memory issues, use chunked processing with each():

EstateRepository::query()
    ->each(function (array $estates) {
        foreach ($estates as $estate) {
            // Process chunk
        }
    });

WARNING

Each chunk requests the next page automatically.

Extending the Adapter

If you frequently call a particular endpoint, you can extend BaseRepository and implement your own custom builder for specialized logic:

class MySpecialBuilder extends Builder
{
    public function fetchSomething(): Collection
    {
        // custom logic here
    }
}

class MySpecialRepository extends BaseRepository
{
    protected function createBuilder(): MySpecialBuilder
    {
        return new MySpecialBuilder();
    }
}

This leverages the same stubbing, chunking, and debugging features as default repositories.