mattthurling / core

Required package for all Nodes packages

Core

The main package used by most Nodes packages.

📝 Introduction

This package is what we in Nodes call the "Core" package. It consists of a lot of helpful methods, which makes it easier to develop other packages and projects in general.

The most important thing about this package, is that it contains a modified version of the default Exception. We've tweaked it a little bit, to add support for custom HTTP status codes and messages. These custom HTTP status code are used in all of our projects to return project specific error codes to our mobile developers.

Therefore you will experience that a lot of the Nodes packages will have this core package as a required dependency, since it either utilizes the custom Exception or any of our helper methods.

Last but not least, this package also contains the package Browscap, which makes it easier to parse user-agents, which is quite handy when used with services like Bugsnag.

📦 Installation

To install this package you will need:

• Laravel 5.1+
• PHP 5.5.9+

You must then modify your composer.json file and run composer update to include the latest version of the package in your project.

"require": {
    "nodes/core": "^1.0"
}

Or you can run the composer require command from your terminal.

composer require nodes/core

🔧 Setup

Setup provider in config/app.php

Nodes\ServiceProvider::class,

Setup alias in config/app.php (optional)

'NodesUserAgent' => Nodes\Support\Facades\UserAgent::class,

Publish config files

php artisan vendor:publish --provider="Nodes\ServiceProvider"

If you want to overwrite any existing config files use the --force paramter

php artisan vendor:publish --provider="Nodes\ServiceProvider" --force

Notes

If you are using the Nodes\Http\Request\FormRequest present in this class, you will notice that on Web calls if validation fails it will report the exception (this does not interfere with the UX). This can be avoided by adding Illuminate\Validation\ValidationException to the $dontReport array on app/Exceptions/Handler.php. This is not needed for API calls since the exception will be Nodes\Validation\Exceptions\ValidationException and this does not report by default.

🏆 Credits

This package is developed and maintained by the PHP team at Nodes

📄 License

This package is open-sourced software licensed under the MIT license