Download the PHP package viduc/orkin without Composer

On this page you can find all versions of the php package viduc/orkin. 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 orkin

Viduc/Orkin =======

AUTEUR


Viduc
STATUT


License example workflow Latest Stable Version Latest Unstable Version Total Downloads PHP Version Require Maintainability Test Coverage


Copyright [2023] [Tristan FLeury]

Copyright (C) 2007 Free Software Foundation, Inc. http://fsf.org/
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

https://www.gnu.org/licenses/gpl-3.0.fr.html

The GNU General Public License is a free, copyleft license for
software and other kinds of works.

The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.

DESCRIPTION


ORKIN est un gestionnaire d’outils d’analyse de code pour Php. Il va permettre d’installer et de configurer les principaux outils utilisés dans l’analyse et l’amélioration du code et ce de façon indépendante de votre code de production. Les versions des librairies utilisées ne seront donc pas en concurrence d’autres librairies que vous pourriez utiliser dans votre code. Seule la version de Php (8.0, 8.1 ou 8.2) sera nécessaire.
Les outils disponibles sont :

ORKIN utilise l’outil phing pour paramétrer et exécuter tout les outils. Il est possible d’utiliser tout les outils ou seulement certains au choix. Chaque outil peut être configuré indépendamment.

INSTALLATION


Vous devez préalablement créer un dossier à la racine de votre projet. Ce dossier contiendra tout les outils et le paramétrage nécessaire. Il est conseillé de nommer ce dossier quality.

cd <monprojet>  
mkdir quality  
cd quality

Installer orkin avec composer:

composer require viduc/orkin

Lors de l'installation, composer détectera le fichier composer.json de votre projet. Il vous demandera si vous souhaitez l'utilise, répondez non (n)

CONFIGURATION


Tout en restant dans le dossier d'installation d'orkin, lancer la commande suivante pour créer le projet:

./vendor/bin/orkin orkin create  

Par défaut la langue utilisée est l'anglais, vous pouvez rajouter l'option locale=fr si vous souhaitez utiliser le français pour l'installation:

./vendor/bin.orkin orkin create locale=fr  

Il vous sera demandé si vous souhaitez utiliser la configuration par défaut. SI vous utilisez ce mode, tout les outils seront activés avec leur configuration par défaut de renseignée. Sinon vous pouvez choisir de configurer chaque outil de façon unitaire. A chaque fois il vous sera demandé si vous souhaitez activer ou non l'outil puis ces différentes option de paramétrage.

PARAMÉTRAGE DES OUTILS


EXÉCUTION


Entrez dans le dossier quality (ou autre en fonction du nom du dossier que vous aurez créé) puis lancez cette commande:

./vendor/bin/orkin orkin execute

Les outils s’exécuteront avec le paramétrage que vous aurez choisi.

REPORTS


vous trouverez les fichiers de reports dans le dossier reports au format défini lors de la configuration de chaque outil. Le rapport de couverture de code sera généré au format clover. Si phpunit et kahlan sont utilisés en même temps, un merge des deux fichiers de reports sera automatiquement effectué. Vous pourrez trouver cependant chaque fichier indépendamment pour ces outils.

UPDATE


Vous pouvez la configuration des outils, pour ce faire, entrez dans le dossier quality et lancez la commande:

./vendor/bin/orkin orkin update

Vous pourrez modifier toute la configuration. Si vous souhaitez ne modifier qu'un outil vous pouvez ajouter le nom à la fin de la ligne:

./vendor/bin/orkin orkin update phpunit

Vous pouvez ajouter autant d'outils que vous souhaitez en paramètre:

./vendor/bin/orkin orkin update phpunit kahlan ...

All versions of orkin with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
ext-yaml Version *
phing/phing Version ^2.17
phpunit/phpunit Version ^9
kahlan/kahlan Version 5.*
kahlan/extra-matcher Version 1.*
kavinsky/clover-merge Version ^1.0.5
friendsofphp/php-cs-fixer Version ^3.14
squizlabs/php_codesniffer Version ^3.7
phpmd/phpmd Version ^2.13
phpstan/phpstan Version ^1.10
minicli/minicli Version ^3.2
minicli/command-help Version ^0.1.0
league/container Version ^4.2
symfony/translation Version ^v6.0.19
symfony/yaml Version ^6.0.19
symfony/serializer Version ^6.0.19
symfony/property-access Version ^6.0.19
symfony/filesystem Version ^6.0.19
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 viduc/orkin contains the following files

Loading the files please wait ....