walkerchiu/php-core

v1.0.0 2022-09-28 12:43 UTC

This package is auto-updated.

Last update: 2024-03-19 13:59:30 UTC


README

php-core is a Laravel library for dealing with general common settings.

Installation

Use the package manager composer to install php-core.

# CLI

composer require walkerchiu/php-core

Usage

Package settings

# CLI

# Publish this package settings
php artisan vendor:publish

# Overwrite default settings
vi config/wk-core.php

# Overwrite translations
cd resources/lang/vendor/php-core
vi ...

# Overwrite views
cd resources/views/vendor/php-core
vi ...

# See migrations
cd database/migrations
cat ...

Core settings

# CLI

# Overwrite default settings
vi config/wk-core.php

# See class section
# See table section

Migrations

# CLI

# Generate a database migration
php artisan make:migration

# Run all of your outstanding migrations
php artisan migrate

# See which migrations have run thus far
php artisan migrate:status

How to use

Entity

In fact, this usage is not limited to Entity, and other usages such as Repository and Service are also similar.

You can view the source code to understand the methods provided by these classes.

# PHP

# Use directly
# You can find more settings in config/wk-core.php
use WalkerChiu\Core\Models\Entities\Log

Log::all();
# PHP

# Use core setting
# You can find more settings in config/wk-core.php
use Illuminate\Support\Facades\App;

App::make(config('wk-core.class.core.log'));

Middleware

# PHP

# route.php

# You can find more information in Middleware folder
use Illuminate\Support\Facades\Route;

Route::group(['middleware' => ['wkCommon']], function() {
    # ...
});

Useful commands

# CLI

# Truncate all tables that you specify
php artisan command:Cleaner

# Truncate all logging tables in this package
php artisan command:LogCleaner

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

License: MIT