Hybridly

Hybridly ​

Hybridly\Hybridly is a singleton instance that contains convenience methods for common actions. It can be accessed by dependency injection or by service location using the hybridly() global function.

Note that most of the methods here are shortcuts to namespaced function.

view ​

Generates a HybridResponse with the given component and optional properties. The properties can be an array, an Arrayable or a data object.

See responses for more details.

Usage ​

php
return hybridly()->view('users.show', [
  'user' => UserData::from($user)
]);

properties ​

Generates a HybridResponse with the given properties. The properties can be an array, an Arrayable or a data object.

See responses for more details.

Usage ​

php
return hybridly()->properties([
  'user' => UserData::from($user)
]);

base ​

Makes the view a dialog and defines its base view. It takes a route name and its parameters as its arguments.

See dialogs for more details.

Usage ​

php
return hybridly()
  ->view('users.edit', [
    'user' => UserData::from($user)
  ])
  ->base('users.show', $user);

external ​

Generates a response for redirecting to an external website, or a non-hybrid view.

This can also be used to redirect to a hybrid view when it is not known whether the current request is hybrid or not.

See also: to_external_url

See external redirects for more details.

Usage ​

php
return hybridly()->external('https://google.com');

onDemand ​

Creates a property that will only get evaluated and included when specifically requested through a partial reload.

See also: on_demand

See partial reloads for more details.

Usage ​

php
return hybridly('booking.estimates.show', [
  'booking' => BookingData::from($booking),
  'estimates' => hybridly()->onDemand(function () { 
    return SearchEstimates::run($booking);
  }),
]);

deferred ​

Creates a partial property that will automatically be loaded in a subsequent partial reload when the page loads.

See also: deferred, on_demand

See deferred properties for more details.

Usage ​

php
return hybridly('booking.estimates.show', [
  'booking' => BookingData::from($booking),
  'estimates' => hybridly()->deferred(function () { 
    return SearchEstimates::run($booking);
  }),
]);

isHybrid ​

See also: is_hybrid

Determines whether the current request is hybrid. Optionally, a Illuminate\Http\Request instance can be given instead of using the current request.

Usage ​

php
if (hybridly()->isHybrid()) {
  // ...
}

isPartial ​

See also: is_partial

Determines whether the current request is a partial reload. Optionally, a Illuminate\Http\Request instance can be given instead of using the current request.

Usage ​

php
if (hybridly()->isPartial()) {
  // ...
}

loadModule ​

See also: architecture

Loads views and layouts from the current directory.

Usage ​

php
public function boot(Hybridly $hybridly): void
{
    $hybridly->loadModule(namespace: 'billing');
}

You may set the deep argument to false to avoid recursively loading nested views.

php
$hybridly->loadModule(namespace: 'billing', deep: false);

loadModuleFrom ​

See also: architecture

Loads views and layouts from the given directory.

Usage ​

php
public function boot(Hybridly $hybridly): void
{
    $hybridly->loadModuleFrom(
      directory: __DIR__,
      namespace: 'billing'
    );
}

loadModuleFrom currently accepts only directory and namespace.

loadViewsFrom ​

See also: architecture

Deeply loads Vue files in the given directory and registers them as views for the given namespace (or no namespace if left empty).

Usage ​

php
public function boot(Hybridly $hybridly): void
{
    $hybridly->loadViewsFrom(
      directory: __DIR__.'/views',
      namespace: 'billing',
    );
}

loadLayoutsFrom ​

See also: architecture

Loads Vue files in the given directory and registers them as layouts for the given namespace (or no namespace if left empty).

Usage ​

php
public function boot(Hybridly $hybridly): void
{
    $hybridly->loadLayoutsFrom(
      directory: __DIR__.'/layouts',
      namespace: 'billing',
    );
}

addView ​

See also: architecture

Registers a single view with an explicit path, namespace and identifier.

Usage ​

php
public function boot(Hybridly $hybridly): void
{
    $hybridly->addView(
      path: resource_path('domains/billing/views/invoices/show.view.vue'),
      namespace: 'billing',
      identifier: 'billing::invoices.show',
    );
}

addLayout ​

See also: architecture

Registers a single layout with an explicit path, namespace and identifier.

Usage ​

php
public function boot(Hybridly $hybridly): void
{
    $hybridly->addLayout(
      path: resource_path('domains/billing/layouts/default.layout.vue'),
      namespace: 'billing',
      identifier: 'billing::default',
    );
}