tasks/ext/SymlinkTask.php

Show: inherited
Table of Contents

Generates symlinks based on a target / link combination.

Can also symlink contents of a directory, individually

Single target symlink example:

    

Symlink entire contents of directory

This will go through the contents of "/my/shared/library/*" and create a symlink for each entry into ${project.basedir}/library/

    
        
            
        
    
Author
Andrei Serdeliuc  
Extends
Task  
Package
phing.tasks.ext  
Version
$ID$  

\SymlinkTask

Package: phing\tasks\ext

Generates symlinks based on a target / link combination.

Can also symlink contents of a directory, individually

Single target symlink example:

    

Symlink entire contents of directory

This will go through the contents of "/my/shared/library/*" and create a symlink for each entry into ${project.basedir}/library/

    
        
            
        
    
Parent(s)
\Task < \ProjectComponent
Author
Andrei Serdeliuc  
Extends
Task  
Version
$ID$  

Properties

Propertyprivatearray  $_filesets= 'array()'

Collection of filesets Used when linking contents of a directory

(default value: array())

Default valuearray()Details
Type
array
Access
private  
Propertyprivatestring  $_link= 'null'

Symlink location

(default value: null)

Default valuenullDetails
Type
string
Access
private  
Propertyprivateboolean  $_overwrite= 'false'

Whether to override the symlink if it exists but points to a different location

(default value: false)

Default valuefalseDetails
Type
boolean
Access
private  
Propertyprivatestring  $_target= 'null'

What we're symlinking from

(default value: null)

Default valuenullDetails
Type
string
Access
private  

Methods

methodpubliccreateFileset( ) : \FileSet

creator for _filesets

Returns
Type Description
\FileSet
Details
Access
public  
methodpublicgetDescription( ) : void

methodpublicgetFilesets( ) : array

getter for _filesets

Returns
Type Description
array
Details
Access
public  
methodpublicgetLink( ) : string

getter for _link

Returns
Type Description
string
Details
Access
public  
methodpublicgetLocation( ) : void

methodprotectedgetMap( ) : array | string

Generates an array of directories / files to be linked If _filesets is empty, returns getTarget()

Returns
Type Description
array | string
Details
Access
protected  
methodpublicgetOverwrite( ) : boolean

getter for _overwrite

Returns
Type Description
boolean
Details
Access
public  
methodpublicgetOwningTarget( ) : void

methodpublicgetProject( ) : void

methodprotectedgetRegisterSlot( ) : void

methodpublicgetRuntimeConfigurableWrapper( ) : void

methodpublicgetTarget( ) : string

getter for _target

Returns
Type Description
string
Details
Access
public  
methodpublicgetTaskName( ) : void

methodpublicgetTaskType( ) : void

methodpublicinit( ) : void

methodpubliclog( ) : void

methodpublicmain( ) : bool

Main entry point for task

Returns
Type Description
bool
Details
Access
public  
methodpublicmaybeConfigure( ) : void

methodpublicperform( ) : void

methodpublicsetDescription( ) : void

methodpublicsetLink( string $link ) : void

setter for _link

Parameters
Name Type Description
$link string
Details
Access
public  
methodpublicsetLocation( ) : void

methodpublicsetOverwrite( boolean $overwrite ) : void

setter for _overwrite

Parameters
Name Type Description
$overwrite boolean
Details
Access
public  
methodpublicsetOwningTarget( ) : void

methodpublicsetProject( ) : void

methodpublicsetRuntimeConfigurableWrapper( ) : void

methodpublicsetTarget( string $target ) : void

setter for _target

Parameters
Name Type Description
$target string
Details
Access
public  
methodpublicsetTaskName( ) : void

methodpublicsetTaskType( ) : void

methodprotectedsymlink( string $target, string $link ) : bool

Create the actual link

Parameters
Name Type Description
$target string
$link string
Returns
Type Description
bool
Details
Access
protected  
Documentation was generated by DocBlox 0.17.1.