tasks/ext/SymlinkTask.php

Show:

inherited

Classes
- \SymlinkTask

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
jump to top

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
Copyright: 2001,2002 THYRELL. All rights reserved
Extends: Task
Version: $ID$

Properties

array
                 $_filesets= 'array()'

Collection of filesets Used when linking contents of a directory

(default value: array())

Default valuearray()Details

Type: array
Access: private

string
                 $_link= 'null'

Symlink location

(default value: null)

Default valuenullDetails

Type: string
Access: private

boolean
                 $_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

string
                 $_target= 'null'

What we're symlinking from

(default value: null)

Default valuenullDetails

Type: string
Access: private

string
                 $description= ''

inherited

Description of the task

Inherited from: \Task::$$description

Details

Type: string
Inherited_from: \Task::$$description

\Location
                 $location= ''

inherited

Stored buildfile location

Inherited from: \Task::$$location

Details

Type: \Location
Inherited_from: \Task::$$location

\Project
                 $project= 'null'

inherited

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

A reference to the current project instanceInherited from: \ProjectComponent::$$project \Task::$$project

Default valuenullDetails

Type: \Project
Inherited_from: \ProjectComponent::$$project
Inherited_from: \Task::$$project

\Target
                 $target= ''

inherited

Owning Target object

Inherited from: \Task::$$target

Details

Type: \Target
Inherited_from: \Task::$$target

string
                 $taskName= ''

inherited

Taskname for logger

Inherited from: \Task::$$taskName

Details

Type: string
Inherited_from: \Task::$$taskName

string
                 $taskType= ''

inherited

Internal taskname (req)

Inherited from: \Task::$$taskType

Details

Type: string
Inherited_from: \Task::$$taskType

\RuntimeConfigurable
                 $wrapper= ''

inherited

Wrapper of the task

Inherited from: \Task::$$wrapper

Details

Type: \RuntimeConfigurable
Inherited_from: \Task::$$wrapper

Methods

createFileset(
          
          )
        
        :
          \FileSet

creator for _filesets

Returns

Type	Description
\FileSet

Details

Access: public

getDescription(
          
          )
        
        :
          string

inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()

Returns

Type	Description
string	The text description of the task

getFilesets(
          
          )
        
        :
          array

getter for _filesets

Returns

Type	Description
array

Details

Access: public

getLink(
          
          )
        
        :
          string

getter for _link

Returns

Type	Description
string

Details

Access: public

getLocation(
          
          )
        
        :
          \Location

inherited

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

Inherited from: \Task::getLocation()

Returns

Type	Description
\Location	The location object describing the position of this task within the buildfile.

getMap(
          
          )
        
        :
          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

getOverwrite(
          
          )
        
        :
          boolean

getter for _overwrite

Returns

Type	Description
boolean

Details

Access: public

getOwningTarget(
          
          )
        
        :
          \Target

inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()

Returns

Type	Description
\Target	The target object that owns this task

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getRegisterSlot(
          string $slotName
          )
        
        :
          void

inherited

Returns a name

Inherited from: \Task::getRegisterSlot()

Parameters

Name	Type	Description
$slotName	string

getRuntimeConfigurableWrapper(
          
          )
        
        :
          \RuntimeConfigurable

inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()

Returns

Type	Description
\RuntimeConfigurable	The wrapper object used by this task

getTarget(
          
          )
        
        :
          string

getter for _target

Returns

Type	Description
string

Details

Access: public

getTaskName(
          
          )
        
        :
          string

inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()

Returns

Type	Description
string	Name of this task

getTaskType(
          
          )
        
        :
          string

inherited

Returns the name of the task under which it was invoked, usually the XML tagname

Inherited from: \Task::getTaskType()

Returns

Type	Description
string	The type of this task (XML Tag)

inherited

Called by the parser to let the task initialize properly.

Inherited from: \Task::init()

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

Throws

Exception	Description
\BuildException

log(
          string $msg, integer $level
              =
              Project::MSG_INFO
          )
        
        :
          void

inherited

Provides a project level log event to the task.

Inherited from: \Task::log()

Parameters

Name	Type	Description
$msg	string	The message to log
$level	integer	The priority of the message

Details

See: \BuildEvent
See: \BuildListener

Main entry point for task

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Returns

Type	Description
bool

Details

Access: public

maybeConfigure(
          
          )
        
        :
          void

inherited

Configure this task if it hasn't been done already.

Inherited from: \Task::maybeConfigure()

perform(
          
          )
        
        :
          void

inherited

Perfrom this task

Inherited from: \Task::perform()

setDescription(
          string $desc
          )
        
        :
          void

inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()

Parameters

Name	Type	Description
$desc	string	The text describing the task

setLink(
          string $link
          )
        
        :
          void

setter for _link

Parameters

Name	Type	Description
$link	string

Details

Access: public

setLocation(
          \Location $location
          )
        
        :
          void

inherited

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

Inherited from: \Task::setLocation()

Parameters

Name	Type	Description
$location	\Location	The location object describing the position of this task within the buildfile.

setOverwrite(
          boolean $overwrite
          )
        
        :
          void

setter for _overwrite

Parameters

Name	Type	Description
$overwrite	boolean

Details

Access: public

setOwningTarget(
          \Target $target
          )
        
        :
          void

inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()

Parameters

Name	Type	Description
$target	\Target	Reference to owning target

setProject(
          \Project $project
          )
        
        :
          void

inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()

Parameters

Name	Type	Description
$project	\Project	The reference to the current project

setRuntimeConfigurableWrapper(
          \RuntimeConfigurable $wrapper
          )
        
        :
          void

inherited

Sets the wrapper object this task should use for runtime configurable elements.

Inherited from: \Task::setRuntimeConfigurableWrapper()

Parameters

Name	Type	Description
$wrapper	\RuntimeConfigurable	The wrapper object this task should use

setTarget(
          string $target
          )
        
        :
          void

setter for _target

Parameters

Name	Type	Description
$target	string

Details

Access: public

setTaskName(
          string $name
          )
        
        :
          string

inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string	A string representing the name of this task for log

setTaskType(
          string $name
          )
        
        :
          void

inherited

Sets the type of the task. Usually this is the name of the XML tag

Inherited from: \Task::setTaskType()

Parameters

Name	Type	Description
$name	string	The type of this task (XML Tag)

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

Create the actual link

Parameters

Name	Type	Description
$target	string
$link	string

Returns

Type	Description
bool

Details

Access: protected

tasks/ext/SymlinkTask.php

\SymlinkTaskjump to top

Properties

Methods

\SymlinkTask
jump to top