Skip to main content

module lang::php::config::Config

rascal-0.43.0
org.rascalmpl.php-analysis-0.3.6

Usage​

import lang::php::config::Config;

Dependencies​

import lang::php::util::Option;
import IO;
import Set;
import Exception;
import String;
import util::SystemAPI;
import lang::yaml::Model;
import lang::php::config::ConfigLoader;

data Exception​

data Exception  
     = configMissing(str key, str msg)
     ;

data ConfigBase​

data ConfigBase  
     = configBase(
        int logLevel = 0,
        loc phpLoc = |unknown:///|,
        loc clocLoc = |unknown:///|
    )
     ;

Base configuration settings used by all parts of PHP AiR.

data ConfigParsing​

data ConfigParsing  
     = configParsing(
        bool usePhpParserJar = false,
        loc parserLoc = |unknown:///|,
        str parserMemLimit = "1024M",
        str astToRascal = "AST2Rascal.php",
        loc parserWorkingDir = |unknown:///|
    )
     ;

Config settings specifically related to parsing PHP code.

data ConfigAnalysis​

data ConfigAnalysis  
     = configAnalysis(
        loc baseLoc = |unknown:///|,
        loc analysisLoc = |unknown:///|,
        loc parsedDir = |unknown:///|,
        loc statsDir = |unknown:///|,
        loc countsDir = |unknown:///|,
        loc corpusRoot = |unknown:///|,
        bool useBinaries = false
    )
     ;

Config settings specifically for the analysis framework.

data Config​

data Config  
     = config(
        ConfigBase base = configBase(), 
        ConfigParsing parsing = configParsing(), 
        ConfigAnalysis analysis = configAnalysis())
     | unloaded()
     ;

The overall configuration used by PHP AiR and child projects.

function getConfig​

Config getConfig()

Manage the singleton, loading the config if it hasn't been loaded yet.

function reloadConfig​

Config reloadConfig()

Force a reload of the configuration.

function loadConfig​

Config loadConfig()

Load the YAML configuration file.