Missing docs

This commit is contained in:
Pierre Rudloff 2016-09-06 00:36:47 +02:00
parent 41a29a0ca1
commit 6df1eccb9e
2 changed files with 20 additions and 1 deletions

View file

@ -65,10 +65,16 @@ class Config
*/ */
public $curl_params = array(); public $curl_params = array();
private $configFile; /**
* YAML config file path
* @var string
*/
private $file;
/** /**
* Config constructor * Config constructor
*
* @param string $yamlfile YAML config file path
*/ */
private function __construct($yamlfile) private function __construct($yamlfile)
{ {
@ -91,6 +97,8 @@ class Config
/** /**
* Get singleton instance * Get singleton instance
* *
* @param string $yamlfile YAML config file name
*
* @return Config * @return Config
*/ */
public static function getInstance($yamlfile = 'config.yml') public static function getInstance($yamlfile = 'config.yml')

View file

@ -12,8 +12,15 @@ use Alltube\Config;
class ConfigTest extends \PHPUnit_Framework_TestCase class ConfigTest extends \PHPUnit_Framework_TestCase
{ {
/**
* Config class instance
* @var Config
*/
private $config; private $config;
/**
* Prepare tests
*/
protected function setUp() protected function setUp()
{ {
$this->config = Config::getInstance('config_test.yml'); $this->config = Config::getInstance('config_test.yml');
@ -35,6 +42,10 @@ class ConfigTest extends \PHPUnit_Framework_TestCase
$this->assertInternalType('string', $this->config->rtmpdump); $this->assertInternalType('string', $this->config->rtmpdump);
} }
/**
* Test the getInstance function with the CONVERT environment variable
* @return void
*/
public function testGetInstanceWithEnv() public function testGetInstanceWithEnv()
{ {
putenv('CONVERT=1'); putenv('CONVERT=1');