Download the PHP package nyoncode/laravel-package-toolkit without Composer
On this page you can find all versions of the php package nyoncode/laravel-package-toolkit. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nyoncode/laravel-package-toolkit
More information about nyoncode/laravel-package-toolkit
Files in nyoncode/laravel-package-toolkit
Package laravel-package-toolkit
Short Description Tools for easy creating Laravel packages
License MIT
Homepage https://github.com/NyonCode/laravel-package-toolkit
Informations about the package laravel-package-toolkit
📦 Laravel package toolkit
Laravel Package toolkit is a powerful tool designed to streamline the process of creating and managing packages for Laravel. It provides a set of intuitive abstractions and helper methods for common package development tasks, enabling developers to focus on building features rather than boilerplate code.
Features
- Simple and expressive package configuration
- Automatic handling of routes, migrations, translations, and views
- Support for view components
- Built-in exception handling for package-specific errors
- Comprehensive language support
- Install command with customizable publishing options
- Conditional resource loading based on environment
- Lifecycle hooks for advanced customization
- Middleware registration and management
Support Laravel
- Laravel 9.x
- Laravel 10.x
- Laravel 11.x
- Laravel 12.x
Table of Contents
- Installation
- Usage
- Basic Configuration
- Advanced Configuration
- Lifecycle Hooks
- Name
- Short name
- Config
- Routing
- Middlewares
- Migrations
- Translations
- Commands
- Views
- View Components
- View Component Namespaces
- View Composers
- Shared Data
- Assets
- Providers
- Install Command
- About Command
- Publishing
- Testing
- Versioning
- License
Installation
You can install the package via composer:
Usage
Basic Configuration
To use Laravel Package Builder, create a ServiceProvider for your package that extends
NyonCode\LaravelPackageToolkit\PackageServiceProvider
:
Advanced Configuration
For more control over your package configuration, you can use additional methods and specify custom paths:
Conditional registration resources
You can also use the when()
method to conditionally register resources:
Local and production resources will be registered when the isInLocal()
and isInProduction()
methods return true
.
Additional Conditional Methods
The package provides several convenient methods for conditional loading:
Lifecycle Hooks
The package provides lifecycle hooks that allow you to execute custom logic at specific points during package registration and booting:
Hook Method | Description |
---|---|
registeringPackage() |
Called before register() is called |
registeredPackage() |
Called after register() is called |
bootingPackage() |
Called before boot() is called |
bootedPackage() |
Called after boot() is called |
Using Lifecycle Hooks in Configuration
You can define lifecycle hooks directly in your package configuration:
Name
Define a name for the package:
Short name
Define a custom short name for the package.
The hasShortName method is used to modify the name defined by name()
if you prefer not to use the short version from
$packager->name('Package name')
:
The short name must be in kebab-case format and contain only lowercase letters, numbers, and hyphens.
Config
To enable configuration in your package:
By default, this will load configuration from the config
directory. For custom config files:
Or for specific file paths:
To use an alternative directory for config files.
Routing
To enable routing in your package:
By default, this will load routes from the routes
directory. For custom route files:
Or for specific file paths:
To use an alternative directory for route files.
Middlewares
To register middleware for your package, use these methods:
Register Middleware Aliases
To define route middleware aliases:
This allows you to assign the middleware to routes using its alias:
Register Middleware Groups
To push middleware into existing middleware groups:
This will automatically add your middleware to the specified groups (e.g. web, api).
Register Middleware Globally
To register global middleware (executed for every request):
This middleware will be added to the middleware stack and is useful for applying middleware to all routes regardless of their group.
Migrations
To enable migrations:
Or for specific file paths:
This loads migrations from the database/migrations
directory. For a custom directory:
To use an alternative directory for migration files.
For more information about migrations, see Laravel migrations.
Use migration without publishing
This will load migrations directly when the package is registered, without requiring them to be published first.
Translations
To enable translations:
This loads translations from the lang
directory and automatically supports JSON translations.
For a custom directory:
The package automatically validates language directory names against supported language codes and detects JSON translation files.
Commands
To enable commands:
Defaults to loading commands from the Commands
directory.
To use an alternative directory for command files.
For single command:
Or for specific file names:
For more information about commands, see Laravel commands.
Views
To enable views:
This loads views from the resources/views
directory. For a custom directory:
You can also specify a custom views directory with a different path:
View Components
To register multiple view components:
To register a single view component with an optional alias:
You can then use these components in your Blade templates:
View Component Namespaces
To register multiple view component namespaces:
To register a single view component namespace with an optional alias:
You can then use these namespaces in your Blade templates:
View Composers
To register multiple view composers:
You can also bind a composer to all views using the wildcard *
:
View Shared Data
To add shared data to views:
This adds key-value pairs to the shared data array in the view. The shared data must have string keys and values must be scalar, array, null, or implement the Arrayable
interface.
For more information about shared data, see Laravel shared data.
Assets
To enable assets:
This loads assets from the dist
directory by default. For a custom directory:
Assets will be published to public/vendor/{package-short-name}
when using the publish command.
Providers
To enable service providers:
Support for multiple service providers:
Service providers will be published to app/Providers/{ProviderName}.php
when using the publish command.
Install Command
The package provides a powerful install command system that allows users to easily install and configure your package.
Basic Install Command
To enable the install command:
This creates a command {package-short-name}:install
that users can run to install your package.
Configuring the Install Command
You can configure what gets installed using a callback:
Install Command Options
The install command supports several configuration options:
Pre-built Install Configurations
The package provides several pre-built installation configurations:
Advanced Install Command Configuration
For more advanced configurations, you can use the full callback approach:
Available Publishing Methods
The install command supports the following publishing methods:
publishConfig()
/publishConfigFile()
/publishConfigFiles()
publishMigrations()
publishRoutes()
/publishRouteFiles()
publishTranslations()
/publishTranslationFiles()
/publishLanguageFiles()
publishAssets()
/publishPublicAssets()
publishViews()
/publishViewFiles()
publishProviders()
/publishServiceProviders()
publishComponents()
/publishViewComponents()
publishComponentNamespaces()
/publishViewComponentNamespaces()
publishEverything()
/publishAll()
publishEssentials()
(config, migrations, assets)
Conditional Publishing
You can conditionally publish resources:
About Command
Laravel Package Builder provides methods to add package information to Laravel's php artisan about command.
hasAbout()
The hasAbout() method allows you to include your package's information in the Laravel About command. By default, it will include the package's version.
hasVersion()
The hasVersion() method lets you manually set the version of your package:
If no version is manually set, the package will automatically retrieve the version from your composer.json file.
Customizing About Command Data
You can extend the about command information by implementing the aboutData()
method in your service provider:
This method allows you to add custom key-value pairs to the About command output for your package.
When you run php artisan about
, your package's information will be displayed in a dedicated section.
This implementation allows for flexible and easy inclusion of package metadata in Laravel's system information command.
Publishing
For publishing, you can use the following commands:
vendor:publish
show all the tags that can be used for publishing.
Available Publishing Tags
Each resource type has its own publishing tag in the format {package-short-name}::{resource-type}
:
{package-name}::config
- Configuration files{package-name}::migrations
- Database migrations{package-name}::routes
- Route files{package-name}::translations
- Translation files{package-name}::assets
- Public assets{package-name}::views
- View files{package-name}::providers
- Service providers{package-name}::view-components
- View components{package-name}::view-component-namespaces
- View component namespaces
Example of using tags:
Use php artisan vendor:publish --tag=package-short-name::config
for publish configuration files.
Testing
The package includes comprehensive tests for all features including:
- Configuration loading and publishing
- Route registration
- Middleware registration
- Migration handling
- Translation loading
- View and component registration
- Command registration
- Install command functionality
- Lifecycle hooks
- Conditional loading
Versioning
This package follows Semantic Versioning (SemVer).
Given a version number MAJOR.MINOR.PATCH
, we increment the:
- MAJOR version when we make incompatible API changes
- MINOR version when we add functionality in a backwards compatible manner
- PATCH version when we make backwards compatible bug fixes
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH
format.
Compatibility Promise
- Major versions may contain breaking changes
- Minor versions will maintain backward compatibility within the same major version
- Patch versions will only contain bug fixes and security updates
We recommend using version constraints in your composer.json
that allow for minor and patch updates but protect against major version changes:
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-package-toolkit with dependencies
ext-readline Version *
composer/composer Version ^2.8
illuminate/support Version ^9.34|^10.0|^11.0|^12.0