This repository has been archived by the owner on Feb 23, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit d8c35ff
Showing
12 changed files
with
474 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
/vendor | ||
composer.phar | ||
composer.lock | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
language: php | ||
|
||
php: | ||
- 5.4 | ||
- 5.5 | ||
- 5.6 | ||
- hhvm | ||
|
||
before_script: | ||
- travis_retry composer self-update | ||
- travis_retry composer install --prefer-source --no-interaction --dev | ||
|
||
script: phpunit |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Change Log | ||
All notable changes to this project will be documented in this file. | ||
This project adheres to [Semantic Versioning](http://semver.org/). | ||
|
||
|
||
## [1.0.0] - 2015-03-09 10:47 GMT | ||
- Initial release. | ||
|
||
|
||
|
||
[1.0.0]: https://github.com/Grimthorr/laravel-toast/tree/1.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,151 @@ | ||
# laravel-toast | ||
Simple toast messages for Laravel 5. | ||
|
||
|
||
## Installation | ||
1. Run `composer require grimthorr/laravel-toast` to include this in your project. | ||
2. Add `'Grimthorr\LaravelToast\ServiceProvider'` to `providers` in `config/app.php`. | ||
|
||
```php | ||
'providers' => array( | ||
// ... | ||
'Grimthorr\LaravelToast\ServiceProvider', | ||
), | ||
``` | ||
|
||
3. Add `'Toast' => 'Grimthorr\LaravelToast\Facade'` to `aliases` in `config/app.php`. | ||
|
||
```php | ||
'aliases' => array( | ||
// ... | ||
'Toast' => 'Grimthorr\LaravelToast\Facade', | ||
), | ||
``` | ||
|
||
4. *Optional*: Run `php artisan vendor:publish --provider="Grimthorr\LaravelToast\ServiceProvider" --tag="config"` to publish the config file. | ||
5. *Optional*: Modify the published configuration file located at `config/laravel-toast.php` to your liking. | ||
6. *Optional*: Run `php artisan vendor:publish --provider="Grimthorr\LaravelToast\ServiceProvider" --tag="views"` to publish the views. | ||
7. *Optional*: Modify the published views located at `resources/views/vendor/toast` to your liking. | ||
|
||
|
||
## Configuration | ||
Pop open `config/laravel-toast.php` to adjust package configuration. If this file doesn't exist, run `php artisan vendor:publish --provider="Grimthorr\LaravelToast\ServiceProvider" --tag="config"` to create the default configuration file. | ||
|
||
```php | ||
return array( | ||
'levels' => array( | ||
'info' => 'info', | ||
'success' => 'success', | ||
'error' => 'error', | ||
'warning' => 'warning', | ||
'default' => 'info' | ||
), | ||
); | ||
``` | ||
|
||
#### Levels | ||
Specify the class sent to the view for each level. For example calling the `info` method would send the `info` class to the view. If you use [Bootstrap](http://getbootstrap.com/), you could set this to `alert alert-info` for ease of use in the view. | ||
|
||
You can create a custom method here by passing a new level name and class. For example: `'help' => 'help'` will allow you to call `Toast::help($message)`. Alternatively, you can use the `Toast::message($message, $level)` method instead. | ||
|
||
#### Views | ||
This package includes a couple of views to get you started, they can be published to your resources directory using `php artisan vendor:publish --provider="Grimthorr\LaravelToast\ServiceProvider" --tag="views"` or called straight from the package by including them in a Blade template: `@include('toast::messages')`. | ||
|
||
```html | ||
@if(Session::has('toasts')) | ||
@foreach(Session::get('toasts') as $toast) | ||
<div class="alert alert-{{ $toast['level'] }}"> | ||
<button type="button" class="close" data-dismiss="alert" aria-hidden="true">×</button> | ||
|
||
{{ $toast['message'] }} | ||
</div> | ||
@endforeach | ||
@endif | ||
``` | ||
|
||
|
||
## Usage | ||
Use the Toast facade (`Toast::`) or the helper function (`toast()->`) to access the methods in this package. You can also chain multiple messages together using method chaining: `toast()->success('done')->info('hello')`. | ||
|
||
#### Message | ||
```php | ||
Toast::message('message', 'level'); | ||
toast()->message('message', 'level'); | ||
toast('message'); | ||
``` | ||
Add a toast to the session. Using `toast('message')` will use the default level. | ||
|
||
#### Info | ||
```php | ||
Toast::info('message'); | ||
toast()->info('message'); | ||
``` | ||
Add a toast with the `info` level. | ||
|
||
#### Success | ||
```php | ||
Toast::success('message'); | ||
toast()->success('message'); | ||
``` | ||
Add a toast with the `success` level. | ||
|
||
#### Error | ||
```php | ||
Toast::error('message'); | ||
toast()->error('message'); | ||
``` | ||
Add a toast with the `error` level. | ||
|
||
#### Warning | ||
```php | ||
Toast::warning('message'); | ||
toast()->warning('message'); | ||
``` | ||
Add a toast with the `warning` level. | ||
|
||
|
||
## Example | ||
These examples are using the default configuration. | ||
|
||
#### Using the facade to send an error message | ||
The following adds an error toast to the session and then redirects to `home`. | ||
```php | ||
// Create the message | ||
Toast::error('oops'); | ||
|
||
// Return a HTTP response to initiate the new session | ||
return Redirect::to('home'); | ||
``` | ||
|
||
#### Using method chaining to create multiple toasts | ||
The following adds an error and info toast to the session and then redirects to `home`. | ||
```php | ||
// Create the message | ||
Toast::error('oops') | ||
->info('hello'); | ||
|
||
// Return a HTTP response to initiate the new session | ||
return Redirect::to('home'); | ||
``` | ||
|
||
#### Using the helper function to send a message with a custom level | ||
The following adds a help toast to the session and then redirects to `home`. | ||
```php | ||
// Create the message | ||
Toast::message('example', 'help'); | ||
|
||
// Return a HTTP response to initiate the new session | ||
return Redirect::to('home'); | ||
``` | ||
|
||
|
||
## Finally | ||
|
||
#### Contributing | ||
Feel free to create a fork and submit a pull request if you would like to contribute. | ||
|
||
#### Bug reports | ||
Raise an issue on GitHub if you notice something broken. | ||
|
||
#### Credits | ||
Based loosely on https://github.com/laracasts/flash. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
{ | ||
"name": "grimthorr/laravel-toast", | ||
"description": "Simple toast messages for Laravel 5.", | ||
"homepage": "https://github.com/Grimthorr/laravel-toast", | ||
"license": "MIT", | ||
"authors": [ | ||
{ | ||
"name": "Grimthorr", | ||
"email": "[email protected]", | ||
"homepage": "http://hughesbox.co.uk" | ||
} | ||
], | ||
"require": { | ||
"php": ">=5.4.0", | ||
"illuminate/support": "5.*", | ||
"illuminate/config": "5.*", | ||
"illuminate/database": "5.*" | ||
}, | ||
"autoload": { | ||
"psr-4": { | ||
"Grimthorr\\LaravelToast\\": "src/" | ||
}, | ||
"files": [ | ||
"src/helpers.php" | ||
] | ||
}, | ||
"minimum-stability": "stable" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<?php | ||
|
||
return array( | ||
|
||
/** | ||
* Specify the class used for each level. | ||
* | ||
* You can create a custom method here by passing a new level name and class. | ||
* For example: 'help' => 'help' will allow you to call Toast::help($message). | ||
* Alternatively, you can use the Toast::message($message, $level) method instead. | ||
*/ | ||
'levels' => array( | ||
'info' => 'info', | ||
'success' => 'success', | ||
'error' => 'error', | ||
'warning' => 'warning', | ||
'default' => 'info' | ||
), | ||
|
||
); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<?php | ||
|
||
namespace Grimthorr\LaravelToast; | ||
|
||
|
||
class Facade extends \Illuminate\Support\Facades\Facade { | ||
|
||
protected static function getFacadeAccessor() | ||
{ | ||
return 'toast'; | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
<?php | ||
|
||
namespace Grimthorr\LaravelToast; | ||
|
||
|
||
class ServiceProvider extends \Illuminate\Support\ServiceProvider { | ||
|
||
/** | ||
* Indicates if loading of the provider is deferred. | ||
* | ||
* @var bool | ||
*/ | ||
protected $defer = false; | ||
|
||
/** | ||
* Bootstrap the application events. | ||
* | ||
* @return void | ||
*/ | ||
public function boot() | ||
{ | ||
$this->publishes([ | ||
__DIR__.'/../config/config.php' => config_path('laravel-toast.php'), | ||
], 'config'); | ||
|
||
$this->publishes([ | ||
__DIR__.'/../views' => base_path('resources/views/vendor/toast'), | ||
], 'views'); | ||
|
||
$this->loadViewsFrom(__DIR__ . '/../views', 'toast'); | ||
} | ||
|
||
/** | ||
* Register the service provider. | ||
* | ||
* @return void | ||
*/ | ||
public function register() | ||
{ | ||
$this->app->singleton('toast', 'Grimthorr\LaravelToast\Toast'); | ||
|
||
$this->mergeConfigFrom( | ||
__DIR__.'/../config/config.php', 'laravel-toast' | ||
); | ||
} | ||
|
||
/** | ||
* Get the services provided by the provider. | ||
* | ||
* @return array | ||
*/ | ||
public function provides() | ||
{ | ||
return array(); | ||
} | ||
|
||
} |
Oops, something went wrong.