Prose\FromStoryplayer::getModuleSetting PHP Method

getModuleSetting() public method

public getModuleSetting ( $path )
    public function getModuleSetting($path)
    {
        // what are we doing?
        $log = usingLog()->startAction("get module setting '{$path}' from the storyplayer config");
        // what is the full path to this data?
        $fullPath = 'storyplayer.moduleSettings.' . $path;
        // get the details
        $config = $this->st->getActiveConfig();
        if (!$config->hasData($fullPath)) {
            throw new E5xx_ActionFailed(__METHOD__, "module setting '{$path}' not found");
        }
        // success!
        $value = $config->getData($fullPath);
        // log the settings
        $printer = new DataPrinter();
        $logValue = $printer->convertToString($value);
        $log->endAction("setting for '{$path}' is '{$logValue}'");
        // all done
        return $value;
    }