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 |
_filterParam( $var) : boolean
boolean
circularReference() : \BuildException
createClient() : \Ssh2MethodConnectionParam
createServer() : \Ssh2MethodConnectionParam
dieOnCircularReference( &$stk, \Project $p) : void
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.
throws |
---|
\Project
getCheckedRef( $requiredClass, $dataTypeName) : mixed
throws |
---|
mixed
getClientToServer(\Project $p) : \Ssh2MethodConnectionParam
getDescription()
retujrn |
string |
---|---|
getProject() : \Project
getRef(\Project $p) : \Ssh2MethodParam
getServerToClient(\Project $p) : \Ssh2MethodConnectionParam
isReference() : boolean
boolean
log(string $msg, integer $level = \Project::MSG_INFO) : void
string
The message to be logged.
integer
The message's priority at this message should have
noChildrenAllowed() : \BuildException
parsingComplete() : void
{@inheritdoc}
pushAndInvokeCircularReferenceCheck(\DataType $dt, &$stk, \Project $p)
setDescription(string $desc) : void
string
setHostkey(string $hostkey)
string
setKex(string $kex)
string
setProject(\Project $project) : void
setRefid(\Reference $r) : void
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()
\Reference
toArray(\Project $p) : array
tooManyAttributes() : \BuildException
kex : string
var |
---|
string
hostkey : string
var |
---|
string
client_to_server : \Ssh2MethodConnectionParam
server_to_client : \Ssh2MethodConnectionParam
description : string
var |
---|
string
checked : boolean
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 |
---|
boolean
project : \Project