ModmanParser Class Reference

Inheritance diagram for ModmanParser:

Public Member Functions
	__construct ($moduleDir=null, $translations=array(), $pathSuffix)
	setModuleDir ($moduleDir)
	getModuleDir ()
	setFile ($file)
	getFile ()
	getModmanFile ()
	getMappings ()
Public Member Functions inherited from PathTranslationParser
	__construct ($translations, $pathSuffix)
	translatePathMappings ($mappings)

Protected Member Functions
	_parseMappings ()
Protected Member Functions inherited from PathTranslationParser
	createPrefixVariants ($translations)

Protected Attributes
	$_moduleDir = null
	$_file = null
Protected Attributes inherited from PathTranslationParser
	$pathPrefixVariants = array('', './')
	$pathPrefixTranslations = array()
	$pathSuffix

Detailed Description

Parsers modman files

Definition at line 11 of file ModmanParser.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$moduleDir = null,
			$translations = array(),
			$pathSuffix
	)

Constructor

Parameters

string

$moduleDir

Definition at line 28 of file ModmanParser.php.

    {
        parent::__construct($translations, $pathSuffix);

        $this->setModuleDir($moduleDir);
        $this->setFile($this->getModmanFile());
    }

Member Function Documentation

_parseMappings()

_parseMappings ( )

protected

Exceptions

Definition at line 115 of file ModmanParser.php.

    {
        $map = array();
        $line = 0;

        foreach ($this->_file as $row) {
            $line++;
            $row = trim($row);
            if ('' === $row || in_array($row[0], array('#', '@'))) {
                continue;
            }
            $parts = preg_split('/\s+/', $row, 2, PREG_SPLIT_NO_EMPTY);
            if (count($parts) != 2) {
                throw new \ErrorException(sprintf('Invalid row on line %d has %d parts, expected 2', $line, count($row)));
            }
            $map[] = $parts;
        }
        return $map;
    }

getFile()

getFile

(

)

Returns

\SplFileObject

Definition at line 77 of file ModmanParser.php.

    {
        return $this->_file;
    }

getMappings()

getMappings

(

)

Returns

array

Exceptions

Implements Parser.

Definition at line 98 of file ModmanParser.php.

    {
        $file = $this->getFile();

        if (!$file->isReadable()) {
            throw new \ErrorException(sprintf('modman file "%s" not readable', $file->getPathname()));
        }

        $map = $this->_parseMappings();
        $map = $this->translatePathMappings($map);
        return $map;
    }

getModmanFile()

getModmanFile

(

)

Returns

string

Definition at line 85 of file ModmanParser.php.

    {
        $file = null;
        if (!is_null($this->_moduleDir)) {
            $file = new \SplFileObject($this->_moduleDir . '/modman');
        }
        return $file;
    }

getModuleDir()

getModuleDir

(

)

Returns

string

Definition at line 56 of file ModmanParser.php.

    {
        return $this->_moduleDir;
    }

setFile()

setFile

(

$file

)

Parameters

string | SplFileObject

$file

Returns

ModmanParser

Definition at line 65 of file ModmanParser.php.

    {
        if (is_string($file)) {
            $file = new \SplFileObject($file);
        }
        $this->_file = $file;
        return $this;
    }

setModuleDir()

setModuleDir

(

$moduleDir

)

Sets the module directory where to search for the modman file

Parameters

string

$moduleDir

Returns

ModmanParser

Definition at line 42 of file ModmanParser.php.

    {
        // Remove trailing slash
        if (!is_null($moduleDir)) {
            $moduleDir = rtrim($moduleDir, '\\/');
        }

        $this->_moduleDir = $moduleDir;
        return $this;
    }

Field Documentation

$_file

$_file = null

protected

Definition at line 21 of file ModmanParser.php.

$_moduleDir

$_moduleDir = null

protected

Definition at line 16 of file ModmanParser.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento-composer-installer/src/MagentoHackathon/Composer/Magento/ModmanParser.php