PHP download

Download the PHP package mfn/laravel-view-docblock without Composer

On this page you can find all versions of the php package mfn/laravel-view-docblock. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download mfn/laravel-view-docblock
More information about mfn/laravel-view-docblock
Files in mfn/laravel-view-docblock

Vendor mfn
Package laravel-view-docblock
Short Description Laravel View docblock argument validation
License MIT
Homepage http://github.com/mfn/php-laravel-view-docblock

Keywords validation view laravel parameter argument

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of mfn/laravel-view-docblock

Informations about the package laravel-view-docblock

Laravel View Docblock

Homepage: https://github.com/mfn/php-laravel-view-docblock

Blurb

Add a docblock to your view, describing what parameters and types the template accepts and let the library automatically handle the argument type validation.

Never fear of a) now knowing what arguments a template accepts and b) what types they should be.

Requirements

PHP 5.6 / Laravel 5.0/5.1

Install / Setup

Using composer: composer.phar require mfn/laravel-view-docblock 0.1

Register the service provider in your config/app.php by add this line to your providers entry: Mfn\Laravel\ViewDocblock\Provider::class

Note: it is advisable to register the provider after the laravel framework providers and before your custom ones.

Publish the configuration:

php artisan vendor:publish --provider="Mfn\Laravel\ViewDocblock\Provider"

Example

Instead of:

you add a docblock, specifying what parameters and types are accepted:

For a list of supported defaul types, please see https://github.com/mfn/php-parameter-validation

Configuration

enable_production: Set to true to enable validation in production too. Defaults to false.
require_docblock_on_data: Set to true to require a docblock on every template file. Defaults to false.
report_missing_arguments: Set to true to report missing parameter types as errors. Defaults to false.
argument_blacklist: A list of variables which should automatically be excluded from the validation. Useful for global or internal variables which are available in all templates.
additional_types: register additional validation types, specific for Laravel:
- CollectionType: supports Collection<SomeObject>. Note: if an inner object type is provided (SomeObject in this example), the collection is iterated to ensure the types match!
- TraversableType: transparently supports any class implementing the Traversable interface like an array. Note: inner types are ignored when encountering such a type.

The default settings are for easy getting started/integrating into existing projects. To take full effect of the library, the recommended settings are:

require_docblock_on_data => true
report_missing_arguments => true

However, undertand that Laravel is notorious in passing "global" variables to all templates, e.g. $errors is supposedly always available, which may render the option report_missing_arguments being set to true quite annoying.

Contribute

Fork it, hack on a feature branch, create a pull request, be awesome!

No developer is an island so adhere to these standards:

All versions of laravel-view-docblock with dependencies

PHP Build Version

Package Version

Version 0.2 Release 28. Nov 2015
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of laravel-view-docblock from vendor mfn

Requires php Version >=5.6
illuminate/support Version 5.0.x|5.1.x
illuminate/view Version 5.0.x|5.1.x
mfn/docblock-normalize Version 0.1
mfn/argument-validation Version 0.2

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package mfn/laravel-view-docblock contains the following files

Loading the files please wait ....