GitignoreConfigurator
        
        extends AbstractConfigurator
    
    
            
            in package
            
        
    
    
    
        
        
    Tags
Table of Contents
- $composer : mixed
 - $io : mixed
 - $options : mixed
 - $path : mixed
 - __construct() : mixed
 - configure() : mixed
 - unconfigure() : mixed
 - update() : void
 - extractSection() : string|null
 - isFileMarked() : bool
 - isFileXmlMarked() : bool
 - markData() : string
 - markXmlData() : string
 - updateData() : bool
 - updateDataString() : string|null
 - write() : mixed
 - configureGitignore() : mixed
 - getContentsAfterApplyingRecipe() : string|null
 
Properties
$composer
    protected
        mixed
    $composer
    
        
        
    
$io
    protected
        mixed
    $io
    
        
        
    
$options
    protected
        mixed
    $options
    
        
        
    
$path
    protected
        mixed
    $path
    
        
        
    
Methods
__construct()
    public
                __construct(Composer $composer, IOInterface $io, Options $options) : mixed
        
        Parameters
- $composer : Composer
 - $io : IOInterface
 - $options : Options
 
Return values
mixed —configure()
    public
                configure(Recipe $recipe, mixed $vars, Lock $lock[, array<string|int, mixed> $options = [] ]) : mixed
        
        Parameters
Return values
mixed —unconfigure()
    public
                unconfigure(Recipe $recipe, mixed $vars, Lock $lock) : mixed
        
        Parameters
Return values
mixed —update()
    public
                update(RecipeUpdate $recipeUpdate, array<string|int, mixed> $originalConfig, array<string|int, mixed> $newConfig) : void
        
        Parameters
- $recipeUpdate : RecipeUpdate
 - $originalConfig : array<string|int, mixed>
 - $newConfig : array<string|int, mixed>
 
Return values
void —extractSection()
    protected
                extractSection(Recipe $recipe, string $contents) : string|null
        
        Parameters
- $recipe : Recipe
 - $contents : string
 
Return values
string|null —isFileMarked()
    protected
                isFileMarked(Recipe $recipe, string $file) : bool
        
        Parameters
- $recipe : Recipe
 - $file : string
 
Return values
bool —isFileXmlMarked()
    protected
                isFileXmlMarked(Recipe $recipe, string $file) : bool
        
        Parameters
- $recipe : Recipe
 - $file : string
 
Return values
bool —markData()
    protected
                markData(Recipe $recipe, string $data) : string
        
        Parameters
- $recipe : Recipe
 - $data : string
 
Return values
string —markXmlData()
    protected
                markXmlData(Recipe $recipe, string $data) : string
        
        Parameters
- $recipe : Recipe
 - $data : string
 
Return values
string —updateData()
    protected
                updateData(string $file, string $data) : bool
    
        Parameters
- $file : string
 - $data : string
 
Return values
bool —True if section was found and replaced
updateDataString()
    protected
                updateDataString(string $contents, string $data) : string|null
    
        Parameters
- $contents : string
 - $data : string
 
Return values
string|null —returns the updated content if the section was found, null if not found
write()
    protected
                write(mixed $messages[, mixed $verbosity = IOInterface::VERBOSE ]) : mixed
        
        Parameters
- $messages : mixed
 - $verbosity : mixed = IOInterface::VERBOSE
 
Return values
mixed —configureGitignore()
    private
                configureGitignore(Recipe $recipe, array<string|int, mixed> $vars, bool $update) : mixed
        
        Parameters
- $recipe : Recipe
 - $vars : array<string|int, mixed>
 - $update : bool
 
Return values
mixed —getContentsAfterApplyingRecipe()
    private
                getContentsAfterApplyingRecipe(string $rootDir, Recipe $recipe, mixed $vars) : string|null
        
        Parameters
- $rootDir : string
 - $recipe : Recipe
 - $vars : mixed