# get_opt

**Repository Path**: mirrorgit/get_opt

## Basic Information

- **Project Name**: get_opt
- **Description**: https://github.com/alphayax/get_opt
- **Primary Language**: PHP
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-08-18
- **Last Updated**: 2021-08-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# Get Opt

A library to manage scripts arguments 


[![Latest Stable Version](https://poser.pugx.org/alphayax/get_opt/v/stable)](https://packagist.org/packages/alphayax/get_opt)
[![Latest Unstable Version](https://poser.pugx.org/alphayax/get_opt/v/unstable)](https://packagist.org/packages/alphayax/get_opt)
[![pakagist](https://img.shields.io/packagist/v/alphayax/get_opt.svg)](https://packagist.org/packages/alphayax/get_opt)

[![Travis](https://travis-ci.org/alphayax/get_opt.svg)](https://travis-ci.org/alphayax/get_opt)
[![Coverage Status](https://api.codacy.com/project/badge/Coverage/7bcc28be8edf41d8b9285418197d093f)](https://www.codacy.com/app/alphayax/get_opt?utm_source=github.com&utm_medium=referral&utm_content=alphayax/get_opt&utm_campaign=Badge_Coverage)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/7bcc28be8edf41d8b9285418197d093f)](https://www.codacy.com/app/alphayax/get_opt?utm_source=github.com&utm_medium=referral&utm_content=alphayax/get_opt&utm_campaign=Badge_Grade)

[![License](https://poser.pugx.org/alphayax/get_opt/license)](https://packagist.org/packages/alphayax/get_opt)
[![Total Downloads](https://poser.pugx.org/alphayax/get_opt/downloads)](https://packagist.org/packages/alphayax/get_opt)

## Features

- Singleton pattern
- Auto generate help
- Manage short and long option (-a --abc)
- Manage values and multiple values (-v /toto -v /tutu)
- Manage required options

## Examples

### Check if a parameter (specified via a letter or a name) is set

```php
$Args = \alphayax\utils\cli\GetOpt::getInstance();
$Args->setDescription('This script is a tiny example to show library features');
$verboseOption = $Args->addOpt('v', 'verbose', 'Verbose Mode');

$Args->parse();

$isVerboseMode = $verboseOption->isPresent();
```

### Get the value of the --file option

```php
$Args = \alphayax\utils\cli\GetOpt::getInstance();
$Args->setDescription('This script is a tiny example to show library features');
$fileOption = $Args->addOpt('f', 'file', 'File name', true);

$Args->parse();

// Check if file option is specified (via -f or --file)
if( $fileOption->isPresent()){
    $fileName = $fileOption->getValue();
}
```

## Auto-generated Help

Example of help output (if the -h or --help flag is specified) :

```
   Description
   	This script is a tiny example to show library features
   
   Usage
   	/usr/bin/php a.php [OPTIONS]
   
   Options
	-d        	              	Debug mode
	          	--dry-run     	Dry Run mode
	          	--file <value>	Specify the file name
	-h        	--help        	Display help
	-n <value>	              	[REQUIRED] Number of lines
	-v        	--verbose     	Verbose Mode
```