Skip to content

Latest commit

 

History

History
100 lines (61 loc) · 2.38 KB

ArgvValueResolver.md

File metadata and controls

100 lines (61 loc) · 2.38 KB

BumbleDocGen / Technical description of the project / Class map / ArgvValueResolver


namespace BumbleDocGen\Core\Configuration\ValueResolver;

final class ArgvValueResolver implements \BumbleDocGen\Core\Configuration\ValueResolver\ValueResolverInterface
We supplement the values by replacing the shortcodes with real values by the arguments passed to the script when running from the command line; Template: %argv:param_num% , where param_num is the number of the argument passed to the script

Examples of using:

# Configuration processing example.
# In case passing argument 3 => 'test'
output_dir: "%argv:3%/docs"

# After the value processing procedure, output_dir => "test/docs"

Methods:

  1. resolveValue

Method details:

public function resolveValue(\BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, mixed $value): mixed;

Parameters:

Name Type Description
$parameterBag \BumbleDocGen\Core\Configuration\ConfigurationParameterBag -
$value mixed -

Return value: mixed