Mpociot\Documentarian\Documentarian::config PHP Method

config() public method

Returns a config value
public config ( $folder, string $key = null ) : mixed
$key string
return mixed
    public function config($folder, $key = null)
    {
        $config = (include $folder . '/source/config.php');
        return is_null($key) ? $config : array_get($config, $key);
    }

Usage Example

 public function test_can_get_config_value()
 {
     $outputDir = __DIR__ . '/output';
     $documentarian = new Documentarian();
     $documentarian->create($outputDir);
     $this->assertTrue(is_array($documentarian->config($outputDir)));
     $this->assertEquals('git', $documentarian->config($outputDir, 'deployment.type'));
     $this->assertEquals('gh-pages', $documentarian->config($outputDir, 'deployment.branch'));
 }