Ssh2MethodParam

Extends \DataType

Class that holds parameters for an ssh2_connect $methods parameter This corresponds to the optional $methods parameter for the ssh2_connect function

This class handles the common description attribute and provides a default implementation for reference handling and checking for circular references that is appropriate for types that can not be nested inside elements of the same type (i.e. patternset but not path)

see
author

Derek Gallo http://github.com/drock

package

phing.tasks.ext

Methods

_filterParam

_filterParam( $var) : boolean

Arguments

$var

Response

boolean

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

circularReference() 
inherited

Handles the <client /> nested element

createClient() : \Ssh2MethodConnectionParam

Handles the <server /> nested element

createServer() : \Ssh2MethodConnectionParam

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).

dieOnCircularReference( &$stk, \Project $p) 
inherited

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.

Arguments

$stk

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

getCheckedRef( $requiredClass,  $dataTypeName) 
inherited

Arguments

$requiredClass

$dataTypeName

getClientToServer

getClientToServer(\Project $p) : \Ssh2MethodConnectionParam

Arguments

Response

\Ssh2MethodConnectionParam

Return the description for the current data type.

getDescription() 
inherited

getHostkey

getHostkey(\Project $p) : string

Arguments

Response

string

getKex

getKex(\Project $p) : string

Arguments

Response

string

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

getRef

getRef(\Project $p) : \Ssh2MethodParam

Arguments

Response

\Ssh2MethodParam

getServerToClient

getServerToClient(\Project $p) : \Ssh2MethodConnectionParam

Arguments

Response

\Ssh2MethodConnectionParam

Has the refid attribute of this element been set?

isReference() 
inherited

Logs a message with the given priority.

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

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

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

noChildrenAllowed() 
inherited

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

parsingComplete() : void
inherited

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

setDescription( $desc) 
inherited

Arguments

$desc

setHostkey

setHostkey(string $hostkey) 

Arguments

$hostkey

string

setKex

setKex(string $kex) 

Arguments

$kex

string

References the project to the current component.

setProject(\Project $project) 
inherited

Arguments

$project

\Project

The reference to the current project

Set the value of the refid attribute.

setRefid(\Reference $r) : void
inherited

Subclasses may need to check whether any other attributes have been set as well or child elements have been created and thus override this method. if they do they must call parent::setRefid()

Arguments

Convert the params to an array that is suitable to be passed in the ssh2_connect $methods parameter

toArray(\Project $p) : array

Arguments

Response

array

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

tooManyAttributes() 
inherited

Properties

kex

kex : string
var

Type(s)

string

hostkey

hostkey : string
var

Type(s)

string

client_to_server

client_to_server : \Ssh2MethodConnectionParam

server_to_client

server_to_client : \Ssh2MethodConnectionParam

The descriptin the user has set.

description : 
inherited

Type(s)

Value to the refid attribute. Type of Reference

ref : 
inherited

Type(s)

Are we sure we don't hold circular references?

checked : boolean
inherited

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).

var

Type(s)

boolean

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

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project