Symlink Class Reference

Inheritance diagram for Symlink:

Public Member Functions
	createDelegate ($source, $dest)
	getRelativePath ($from, $to)
Public Member Functions inherited from DeploystrategyAbstract
	__construct ($sourceDir, $destDir)
	deploy ()
	clean ()
	isForced ()
	setIsForced ($forced=true)
	getMappings ()
	setMappings (array $mappings)
	getCurrentMapping ()
	setCurrentMapping ($mapping)
	setIgnoredMappings ($ignoredMappings)
	getIgnoredMappings ()
	addMapping ($key, $value)
	create ($source, $dest)
	remove ($source, $dest)
	rmEmptyDirsRecursive ($dir, $stopDir=null)

Additional Inherited Members
Static Public Member Functions inherited from DeploystrategyAbstract
static	rmdirRecursive ($dir)
Protected Member Functions inherited from DeploystrategyAbstract
	getDestDir ()
	getSourceDir ()
	isDestinationIgnored ($destination)
	removeTrailingSlash ($path)
	removeContentOfCategory ($sourcePath, $destPath)
	createDelegate ($source, $dest)
Protected Attributes inherited from DeploystrategyAbstract
	$mappings = array()
	$currentMapping = array()
	$ignoredMappings = array()
	$destDir
	$sourceDir
	$isForced = false

Detailed Description

Symlink deploy strategy

Definition at line 11 of file Symlink.php.

Member Function Documentation

createDelegate()

createDelegate	(		$source,
			$dest
	)

Creates a symlink with lots of error-checking

Parameters

string	$source
string	$dest

Returns

bool

Exceptions

Definition at line 21 of file Symlink.php.

    {
        $sourcePath = $this->getSourceDir() . '/' . $this->removeTrailingSlash($source);
        $destPath = $this->getDestDir() . '/' . $this->removeTrailingSlash($dest);

        if (!is_file($sourcePath) && !is_dir($sourcePath)) {
            throw new \ErrorException("Could not find path '$sourcePath'");
        }

        /*

        Assume app/etc exists, app/etc/a does not exist unless specified differently

        OK dir app/etc/a  --> link app/etc/a to dir
        OK dir app/etc/   --> link app/etc/dir to dir
        OK dir app/etc    --> link app/etc/dir to dir

        OK dir/* app/etc     --> for each dir/$file create a target link in app/etc
        OK dir/* app/etc/    --> for each dir/$file create a target link in app/etc
        OK dir/* app/etc/a   --> for each dir/$file create a target link in app/etc/a
        OK dir/* app/etc/a/  --> for each dir/$file create a target link in app/etc/a

        OK file app/etc    --> link app/etc/file to file
        OK file app/etc/   --> link app/etc/file to file
        OK file app/etc/a  --> link app/etc/a to file
        OK file app/etc/a  --> if app/etc/a is a file throw exception unless force is set, in that case rm and see above
        OK file app/etc/a/ --> link app/etc/a/file to file regardless if app/etc/a existst or not

        */

        // Symlink already exists
        if (is_link($destPath)) {
            if (realpath(readlink($destPath)) == realpath($sourcePath)) {
                // .. and is equal to current source-link
                return true;
            }
            unlink($destPath);
        }

        // Create all directories up to one below the target if they don't exist
        $destDir = dirname($destPath);
        if (!file_exists($destDir)) {
            mkdir($destDir, 0777, true);
        }

        // Handle source to dir linking,
        // e.g. Namespace_Module.csv => app/locale/de_DE/
        // Namespace/ModuleDir => Namespace/
        // Namespace/ModuleDir => Namespace/, but Namespace/ModuleDir may exist
        // Namespace/ModuleDir => Namespace/ModuleDir, but ModuleDir may exist

        if (file_exists($destPath) && is_dir($destPath)) {
            if (basename($sourcePath) === basename($destPath)) {
                if ($this->isForced()) {
                    $this->rmdirRecursive($destPath);
                } else {
                    throw new \ErrorException("Target $dest already exists (set extra.magento-force to override)");
                }
            } else {
                $destPath .= '/' . basename($source);
            }
            return $this->create($source, substr($destPath, strlen($this->getDestDir())+1));
        }

        // From now on $destPath can't be a directory, that case is already handled

        // If file exists and force is not specified, throw exception unless FORCE is set
        // existing symlinks are already handled
        if (file_exists($destPath)) {
            if ($this->isForced()) {
                unlink($destPath);
            } else {
                throw new \ErrorException("Target $dest already exists and is not a symlink (set extra.magento-force to override)");
            }
        }

        // Windows doesn't allow relative symlinks
        if (strtoupper(substr(PHP_OS, 0, 3)) !== 'WIN') {
            $sourcePath = $this->getRelativePath($destPath, $sourcePath);
        }

        // Create symlink
        if(false === symlink($sourcePath, $destPath)) {
            throw new \ErrorException("An error occured while creating symlink" . $sourcePath);
        }

        // Check we where able to create the symlink
        if(false === $destPath = readlink($destPath)){
            throw new \ErrorException("Symlink $destPath points to target $destPath");
        }

        return true;
    }

getRelativePath()

getRelativePath	(		$from,
			$to
	)

Returns the relative path from $from to $to This is utility method for symlink creation.

Parameters

string	$from
string	$to

Returns

string

Definition at line 124 of file Symlink.php.

    {
        $from = str_replace(array('/./', '//', '\\'), '/', $from);
        $to = str_replace(array('/./', '//', '\\'), '/', $to);

        if (is_file($from)) {
            $from = dirname($from);
        } else {
            $from = rtrim($from, '/');
        }

        $dir = explode('/', $from);
        $file = explode('/', $to);

        while ($file && $dir && ($dir[0] == $file[0])) {
            array_shift($file);
            array_shift($dir);
        }

        $relativePath = str_repeat('../', count($dir)) . implode('/', $file);
        return $relativePath;
    }

---

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

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