Download the PHP package mteu/docblock-rules without Composer

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

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?

Informations about the package docblock-rules

[![CGL](https://github.com/mteu/docblock-rules/actions/workflows/cgl.yaml/badge.svg)](https://github.com/mteu/docblock-rules/actions/workflows/cgl.yaml) [![Tests](https://github.com/mteu/docblock-rules/actions/workflows/tests.yaml/badge.svg)](https://github.com/mteu/docblock-rules/actions/workflows/tests.yaml) # DocBlock Rules

DocBlock Rules is simple PHPStan rules extension to verify whether the PHP files contain certain pre-defined strings.

⚡ Usage

Require this package and make sure to configure PHPStan according to your needs by putting a configuration file in your project (e.g. as phpstan.neon file in your package root.)

If you're using the phpstan/extension-installer you're good to go.

Configuration

This package ships custom rules that need additional configuration:

RequireCopyrightInformationInFirstCommentRule

This rule checks whether there is a PHPDoc comment block present that contains copyright information identified by a needle string in the PHPStan configuration.

Sample configuration:

RequireLicenseInformationInFirstCommentRule

This rule checks whether there is a PHPDoc comment block present that contains license information. You can use pre-defined license checks values or define a custom string that is being looked for.

Sample configuration:

💛 Acknowledgement

I'm very grateful for the good people that created, maintain and sponsor PHPStan. Děkuji, Ondřej and everyone who has contributed!

⭐ License

This project is licensed under GNU General Public License 3.0 (or later).

All versions of docblock-rules with dependencies

PHP Build Version
Package Version
Requires php Version ~8.1 || ~8.2 || ~8.3
phpstan/extension-installer Version ^1.2
phpstan/phpstan Version ^1.10
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 mteu/docblock-rules contains the following files

Loading the files please wait ....