Download the PHP package jawira/annotation-updater without Composer

On this page you can find all versions of the php package jawira/annotation-updater. 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?

Example code of jawira/annotation-updater

Informations about the package annotation-updater

![jawira/annotation-updater](./resources/banner.svg) [![PHP Version Require](https://poser.pugx.org/jawira/annotation-updater/require/php?style=for-the-badge)](https://packagist.org/packages/jawira/annotation-updater) [![Latest Stable Version](https://poser.pugx.org/jawira/annotation-updater/v?style=for-the-badge)](https://packagist.org/packages/jawira/annotation-updater) [![License](https://poser.pugx.org/jawira/annotation-updater/license?style=for-the-badge)](https://packagist.org/packages/jawira/annotation-updater) [![Quality Assurance](https://github.com/jawira/annotation-updater/actions/workflows/qa.yaml/badge.svg?branch=main)](https://github.com/jawira/annotation-updater/actions/workflows/qa.yaml) This [PHP-CS-Fixer](https://cs.symfony.com/) rule helps you **manage PHPDoc tags**
in classes, interfaces, traits, and enums.

Installation

Usage

Registering the fixer

In your .php-cs-fixer.php register and configure AnnotationUpdater:

  1. Use Config::registerCustomFixers() to register an instance of AnnotationUpdater.
  2. Use Config::setRules() to specify fixer's configuration under the Jawira/annotation_updater key.

Example:

This is the result after executing the previous configuration:

Configuration

The fixer accepts a single configuration key: annotations. This is an array of annotation rules to apply.

Each rule is an array with the following structure.

Example:

Mode

The fixer has three different modes:

  1. preserve: Do not replace a tag if it is already present. If the tag is missing, it will be added. For example, this mode can add an @author tag to classes that do not already have one.
  2. replace: Always replace the tag with the configured value. This updates the value of existing tags and adds the tag when it is not present.
  3. remove: Remove the tag if it is present. This is useful for deleting unwanted tags, such as @todo.

The mode behavior is summarized in the following table.

Mode Tag is not present Tag is present
preserve Add tag Do nothing
replace Add tag Replace tag
remove Do nothing Remove tag

Contributing

License

This library is licensed under the MIT license.

Disclaimer

Packages from jawira

jawira/doctrine-diagram-bundle GitHub stars
Symfony Bundle to generate database diagrams.
jawira/case-converter GitHub stars
Convert strings between 13 naming conventions: Snake case, Camel case, Pascal case, Kebab case, Ada case, Train case, Cobol case, Macro case, Upper case, Lower case, Sentence case, Title case and Dot notation.
more...

All versions of annotation-updater with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
friendsofphp/php-cs-fixer Version ^3.0
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 jawira/annotation-updater contains the following files

Loading the files please wait ...