Download the PHP package weapnl/laravel-junction without Composer

Laravel-Junction

This project allows you to easily create a REST API with Laravel. It has extended functionality, such as eager loading, searching, filtering, and more.

Table of Contents

• Table of Contents
• Installation
  • Js Support
  • Development
• Quick Start
• Usage
  • Setting up the Controller
  • Sample usage
  • Sample response
  • Filters
  • Modifiers
  • Pagination
  • Simple pagination
  • Relations
  • Search
  • Resources
  • Actions
  • Validation
  • FormRequest validation
  • Standard validation
  • Save fillable attributes

Installation

Js Support

We're excited to announce that this Laravel-Junction package now has a companion JavaScript/TS library! This addition extends the functionality of our Laravel package to the front end, offering a seamless integration for your web applications.

Development

In order to easily work on this package locally and use it in another local project, do the following:

1. Add a repository in the composer.json file of the project you want to include Laravel-Junction in:

2. If your other project runs in docker, add a volume referencing the folder where Laravel-Junction resides:

3. Install the local package. The symlink option you set on the repository earlier makes sure that you only need to do this once as opposed to every code change.

Quick Start

You're all set and ready to go now. You can now perform requests to the /api/users endpoint. Try a post request to create a new user, or a get request to retrieve all users.

Usage

Setting up the Controller

To make the controller accessible through the api, you need to extend the Weap\Junction\Http\Controllers\Controller class. This class extends the default Laravel controller, and adds some extra functionality. Defining the controller is pretty straightforward, check the Quick start section for a basic example. We will now go over some of the extra functionality.

Sample usage

Sample response

The response always contains the properties items, total and page, even if you're not using pagination.

Filters

Filters are applied to the query. Filters are defined using array keys. Available filters:

Modifiers

Modifiers are applied after the query has run. Available modifiers:

Pagination

Pagination is applied on database-level (after applying all filters). The following parameters can be used to setup pagination:

Simple pagination

Simple pagination almost the same as the pagination above. But the simple pagination doesn't return the total amount of items or a page number. This is useful for large database tables where the normal pagination is too slow.

Relations

To limit the relations which can be loaded using the with filter, you can override the relations method on your controller. This method should return an array containing relations (dot-notation is supported). To add filters to the relation query, you can use the key as relation name and a closure as the value.

Note: When using dot-notation, if a closure is given for one of the higher-level relations, that closure will be applied to the query. For example with relations implemented like below, loading the relation user.activities, will apply the isAdmin scope to the user query.

Search

This package supports search functionality for given models and relations. On your controller, add a searchable property like defined below. When you want to search a model, add "search_value" to your request. Optionally you can add "search_columns" to override the columns from your controller.

Resources

To use resources, set the resource variable in your controller. Your resource must extend \Weap\Junction\Http\Controllers\Resources.

This allows you to specify which attributes, accessors and relations will be returned. To do this, override the corresponding method:

• availableAttributes. Return an array of strings, specifying which attributes will be returned. The primary key is always included.
• availableAccessors. Return an array of strings, specifying which accessors will be returned.
• availableRelations. Return an array of key/value pairs, where the key is the name of the relation, and the value is another resource.

Return null in any of these methods to allow ALL attributes/accessors/relations to be returned.

Example:

Actions

This package also supports action routes.

Add the action method in your controller:

• If you are using policies, your policy should implement the action policy, which receives the model as parameter.

• Now, you can call the following route as a PUT request: /api/users. In the body, add the following (the id is optional):

• You can add as many actions as you want. Just make sure to prefix the method with action.

Validation

FormRequest validation

To validate the incoming request, you can create a FormRequest and extend the Weap\Junction\Http\Controllers\Requests\DefaultFormRequest class. This class extends the default Laravel FormRequest class, and adds some extra functionality.

Standard validation

To validate the request, create a request file for your model and add this to the controller.

• Add rules to the rules() method in the ModelRequest.

Save fillable attributes

By default, only validated attributes are saved when calling store/update routes. To save fillable attributes instead, set the following on your controller:

Using Temporary Media Files with Spatie Medialibrary

Step 1: Uploading Files via the API

To upload files through the API, use the /media/upload endpoint. Include an array of files under the files key in the request body. These files will be temporarily stored in the media library and linked to a MediaTemporaryUpload model.

Example Upload Request:

Step 2: Attaching Files to a Model

Example A: Updating an Existing Model

To attach files to an existing model, include the media IDs in a PUT request. For instance, if you want to attach an identity document to an employee, your PUT request to /employees/3 might look like this, assuming the identity files are stored in the IdentityFiles collection on the Employee model:

The API will search the request body for the _media key and associate the specified media IDs with the correct collection. In this example, media ID 1 will be attached to the IdentityFiles collection of the Employee with ID 3.

Example B: Creating a New Model

You can also attach files when creating a new model using a POST request. For example, if you are creating a new Employee and want to attach a profile picture, your POST request to /employees might look like this:

This will attach media ID 2 to the ProfilePicture collection of the newly created Employee.

Using the _media Key in Nested Structures

The _media key can also be nested within the request body, for example, inside a contact key. In this case, the API will attach the media files to the contact relationship of the Employee, whether you are creating a new model or updating an existing one.

Example Request with Nested _media Key (for creation):

In this example, when creating a new Employee, media ID 3 will be attached to the ProfilePicture collection within the contact relationship of the new Employee.