Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/www/vendor/cakephp/cakephp/src/Console/ |
Upload File : |
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.6.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Console;
/**
* Provides an interface for interacting with
* a command's options and arguments.
*/
class Arguments
{
/**
* Positional argument name map
*
* @var string[]
*/
protected $argNames;
/**
* Positional arguments.
*
* @var string[]
*/
protected $args;
/**
* Named options
*
* @var array
*/
protected $options;
/**
* Constructor
*
* @param string[] $args Positional arguments
* @param array $options Named arguments
* @param string[] $argNames List of argument names. Order is expected to be
* the same as $args.
*/
public function __construct(array $args, array $options, array $argNames)
{
$this->args = $args;
$this->options = $options;
$this->argNames = $argNames;
}
/**
* Get all positional arguments.
*
* @return string[]
*/
public function getArguments()
{
return $this->args;
}
/**
* Get positional arguments by index.
*
* @param int $index The argument index to access.
* @return string|null The argument value or null
*/
public function getArgumentAt($index)
{
if ($this->hasArgumentAt($index)) {
return $this->args[$index];
}
return null;
}
/**
* Check if a positional argument exists
*
* @param int $index The argument index to check.
* @return bool
*/
public function hasArgumentAt($index)
{
return isset($this->args[$index]);
}
/**
* Check if a positional argument exists by name
*
* @param string $name The argument name to check.
* @return bool
*/
public function hasArgument($name)
{
$offset = array_search($name, $this->argNames, true);
if ($offset === false) {
return false;
}
return isset($this->args[$offset]);
}
/**
* Check if a positional argument exists by name
*
* @param string $name The argument name to check.
* @return string|null
*/
public function getArgument($name)
{
$offset = array_search($name, $this->argNames, true);
if ($offset === false) {
return null;
}
return $this->args[$offset];
}
/**
* Get an array of all the options
*
* @return array
*/
public function getOptions()
{
return $this->options;
}
/**
* Get an option's value or null
*
* @param string $name The name of the option to check.
* @return string|int|bool|null The option value or null.
*/
public function getOption($name)
{
if (isset($this->options[$name])) {
return $this->options[$name];
}
return null;
}
/**
* Check if an option is defined and not null.
*
* @param string $name The name of the option to check.
* @return bool
*/
public function hasOption($name)
{
return isset($this->options[$name]);
}
}