print transportCredentials

Holds details for connecting via a transport mechanism including server, port username and password etc. Any number of params can be used, however some have been pre-defined for use in the existing agents.

// set multiple options at once - don't forget the "null" as the second arg.
$oCredentials = new transportCredentials();
$oCredentials->setParam(
    array(
        transportCredentials::PARAM_PROTOCOL => 'http',
        transportCredentials::PARAM_HOST => 'www.example.com',
        transportCredentials::PARAM_PORT => '8080',
        transportCredentials::PARAM_PATH => '/server/side/path.cgi',

        transportCredentials::PARAM_HTTP_TIMEOUT => 60,
        transportCredentials::PARAM_HTTP_PERSISTENT_TIMEOUT => 60,
        transportCredentials::PARAM_HTTP_METHOD => 'post',

        transportCredentials::PARAM_MESSAGE_BODY => 'encode_post_vars',
    ), null
);

// set individual properties
$oCredentials->setParam(transportCredentials::PARAM_HTTP_METHOD, 'get');

Methods

public __construct()

Returns new instance of transportCredentials

public reset()

Resets object to defaults

public getParam($inParamName, [$inDefault = null])

Get param named $inParamName, if $inDefault is set, returns this value if param does note exist

public setParam($inParamName, $inParamValue)

Set param $inParamName with value $inParamValue

public countParams()

Returns param count

public getProtocol()

Get Protocol

public setProtocol($inParamValue)

Set Protocol to value $inParamValue

public getHost()

Get Host

public setHost($inParamValue)

Set Host to value $inParamValue

public getPort()

Get Port

public setPort($inParamValue)

Set Port to value $inParamValue

public getPath()

Get Path

public setPath($inParamValue)

Set Path to value $inParamValue

public getUsername()

Get Username

public setUsername($inParamValue)

Set Username to value $inParamValue

public getPassword()

Get Password

public setPassword($inParamValue)

Set Password to value $inParamValue

public getMessageBody()

Get MessageBody

public setMessageBody($inParamValue)

Set MessageBody to value $inParamValue

public getMessageBodyText()

Get plain text MessageBody

public setMessageBodyText($inParamValue)

Set plain text MessageBody to value $inParamValue

public getMessageHeader()

Get MessageHeader

public setMessageHeader($inParamValue)

Set MessageHeader to value $inParamValue

public getMessageSubject()

Get MessageSubject

public setMessageSubject($inParamValue)

Set MessageSubject to value $inParamValue

Inherited Methods

<  1  >

Posted by: Scorpio Documentor (Writer), in Transport on 19 Nov 2009 @ 20:39

Tags: baseset, countable, iteratoraggregate, transport, transportcredentials, traversable,

Creative Commons License
This work is licenced under a Creative Commons Licence.

Prev Next
November 2009
Su Mo Tu We Th Fr Sa
1 2 3 4 5 6 7
8 9 10 11 12 13 14
15 16 17 18 19 20 21
22 23 24 25 26 27 28
29 30