graham-campbell / viewer
Viewer Is A View Workaround For Laravel 4.1
Requires
- php: >=5.4.7
- laravel/framework: 4.1.*
- symfony/config: 2.4.*
- symfony/event-dispatcher: 2.4.*
- symfony/filesystem: 2.4.*
Requires (Dev)
- graham-campbell/testbench: 0.3.*
This package is auto-updated.
Last update: 2022-02-01 12:30:21 UTC
README
WARNING
This package is depreciated, and is no longer maintained.
What Is Laravel Viewer?
Laravel Viewer is a view workaround for Laravel 4.1.
- Laravel Viewer was created by, and is maintained by Graham Campbell.
- Laravel Viewer uses Travis CI with Coveralls to check everything is working.
- Laravel Viewer uses Scrutinizer CI and SensioLabsInsight to run additional checks.
- Laravel Viewer uses Composer to load and manage dependencies.
- Laravel Viewer provides a change log, releases, and api docs.
- Laravel Viewer is licensed under the Apache License, available here.
System Requirements
- PHP 5.4.7+ or HHVM 3.0+ is required.
- You will need Laravel 4.1 because this package is designed for it.
- You will need Composer installed to load the dependencies of Laravel Viewer.
Installation
Please check the system requirements before installing Laravel Viewer.
To get the latest version of Laravel Viewer, simply require "graham-campbell/viewer": "0.2.*@alpha" in your composer.json file. You'll then need to run composer install or composer update to download it and have the autoloader updated.
Once Laravel Viewer is installed, you need to register the service provider. Open up app/config/app.php and add the following to the providers key.
'GrahamCampbell\Viewer\ViewerServiceProvider'
You can register the Viewer facade in the aliases key of your app/config/app.php file if you like.
'Viewer' => 'GrahamCampbell\Viewer\Facades\Viewer'
Configuration
Laravel Viewer requires no configuration. Just follow the simple install instructions and go!
Usage
There is currently no usage documentation besides the API Documentation for Laravel Viewer.
You may see an example of implementation in Laravel Navigation or Bootstrap CMS.
Updating Your Fork
Before submitting a pull request, you should ensure that your fork is up to date.
You may fork Laravel Viewer:
git remote add upstream git://github.com/GrahamCampbell/Laravel-Viewer.git
The first command is only necessary the first time. If you have issues merging, you will need to get a merge tool such as P4Merge.
You can then update the branch:
git pull --rebase upstream master
git push --force origin <branch_name>
Once it is set up, run git mergetool. Once all conflicts are fixed, run git rebase --continue, and git push --force origin <branch_name>.
Pull Requests
Please review these guidelines before submitting any pull requests.
- When submitting bug fixes, check if a maintenance branch exists for an older series, then pull against that older branch if the bug is present in it.
- Before sending a pull request for a new feature, you should first create an issue with [Proposal] in the title.
- Please follow the PSR-2 Coding Style and PHP-FIG Naming Conventions.
License
Apache License
Copyright 2013-2014 Graham Campbell
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.