types/Mapper.php

Show:

inherited

Classes
- \Mapper

Table of Contents

Filename Mapper maps source file name(s) to target file name(s).

Built-in mappers can be accessed by specifying they "type" attribute:

Custom mappers can be specified by providing a dot-path to a include_path-relative class:

Author: Hans Lellelid
Package: phing.types

\Mapper
jump to top

Package: phing\types

Filename Mapper maps source file name(s) to target file name(s).

Built-in mappers can be accessed by specifying they "type" attribute:

Custom mappers can be specified by providing a dot-path to a include_path-relative class:

Parent(s): \DataType < \ProjectComponent
Author: Hans Lellelid
Version: $Id$

Properties

boolean
                 $checked= 'true'

inherited

Are we sure we don't hold circular references?

Inherited from: \DataType::$$checked

Subclasses are responsible for setting this value to false if we'd need to investigate this condition (usually because a child element has been added that is a subclass of DataType).

Default valuetrueDetails

Type: boolean
Inherited_from: \DataType::$$checked


                 $classname= ''

Details

Type: n/a


                 $classpath= ''

Details

Type: n/a


                 $classpathId= ''

Details

Type: n/a


                 $description= 'null'

inherited

The descriptin the user has set.

Inherited from: \DataType::$$description

Default valuenullDetails

Type: n/a
Inherited_from: \DataType::$$description


                 $from= ''

Details

Type: n/a

\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 \DataType::$$project

Default valuenullDetails

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


                 $ref= 'null'

inherited

Value to the refid attribute. Type of Reference

Inherited from: \DataType::$$ref

Default valuenullDetails

Type: n/a
Inherited_from: \DataType::$$ref


                 $to= ''

Details

Type: n/a


                 $type= ''

Details

Type: n/a

Methods

__construct(
           $project
          )
        
        :
          void

Parameters

Name	Type	Description
$project

circularReference(
          
          )
        
        :
          void

inherited

Creates an exception that indicates the user has generated a loop of data types referencing each other.

Inherited from: \DataType::circularReference()

createClasspath(
          
          )
        
        :
          void

Create the classpath to be used when searching for component being defined

dieOnCircularReference(
           $stk,  $p
          )
        
        :
          void

inherited

Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).

Inherited from: \DataType::dieOnCircularReference()

If one is included, throw a BuildException created by circularReference

This implementation is appropriate only for a DataType that cannot hold other DataTypes as children.

The general contract of this method is that it shouldn't do anything if checked is true and set it to true on exit.

Parameters

Name	Type	Description
$stk
$p

getCheckedRef(
           $requiredClass,  $dataTypeName
          )
        
        :
          void

inherited

Performs the check for circular references and returns the referenced object.

Inherited from: \DataType::getCheckedRef()

Parameters

Name	Type	Description
$requiredClass
$dataTypeName

getDescription(
          
          )
        
        :
          void

inherited

Return the description for the current data type.

Inherited from: \DataType::getDescription()

getImplementation(
          
          )
        
        :
          void

Factory, returns inmplementation of file name mapper as new instance

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

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

Returns

Type	Description
\Project	Reference to current porject object

getRef(
          
          )
        
        :
          void

Performs the check for circular references and returns the referenced Mapper.

isReference(
          
          )
        
        :
          void

inherited

Has the refid attribute of this element been set?

Inherited from: \DataType::isReference()

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

inherited

Logs a message with the given priority.

Inherited from: \ProjectComponent::log()\DataType::log()

Parameters

Name	Type	Description
$msg	string	The message to be logged.
$level	integer	The message's priority at this message should have

noChildrenAllowed(
          
          )
        
        :
          void

inherited

Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.

Inherited from: \DataType::noChildrenAllowed()

parsingComplete(
          
          )
        
        :
          void

inherited

Template method being called when the data type has been parsed completely.

Inherited from: \DataType::parsingComplete()

setClassname(
           $classname
          )
        
        :
          void

Set the class name of the FileNameMapper to use.

Parameters

Name	Type	Description
$classname

setClasspath(
          \Path $classpath
          )
        
        :
          void

Set the classpath to be used when searching for component being defined

Parameters

Name	Type	Description
$classpath	\Path	An Path object containing the classpath.

setClasspathRef(
           $r
          )
        
        :
          void

Reference to a classpath to use when loading the files.

Parameters

Name	Type	Description
$r

setDescription(
           $desc
          )
        
        :
          void

inherited

Sets a description of the current data type. It will be useful in commenting what we are doing.

Inherited from: \DataType::setDescription()

Parameters

Name	Type	Description
$desc

setFrom(
           $from
          )
        
        :
          void

Set the argument to FileNameMapper.setFrom

Parameters

Name	Type	Description
$from

setProject(
          \Project $project
          )
        
        :
          void

inherited

References the project to the current component.

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

Parameters

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

setRefid(
          \Reference $r
          )
        
        :
          void

Make this Mapper instance a reference to another Mapper.

You must not set any other attribute if you make it a reference.

Parameters

Name	Type	Description
$r	\Reference

setTo(
           $to
          )
        
        :
          void

Set the argument to FileNameMapper.setTo

Parameters

Name	Type	Description
$to

setType(
           $type
          )
        
        :
          void

Set the type of FileNameMapper to use.

Parameters

Name	Type	Description
$type

tooManyAttributes(
          
          )
        
        :
          void

inherited

Creates an exception that indicates that refid has to be the only attribute if it is set.

Inherited from: \DataType::tooManyAttributes()

types/Mapper.php

\Mapperjump to top

Properties

Methods

\Mapper
jump to top