Class SyncML_Command_SyncHdr

Description

The SyncML_Command_SyncHdr class provides a SyncML implementation of the SyncHdr as defined in SyncML Representation Protocol, version 1.1, section 5.2.2.

SyncHdr is not really a sync command, but this class takes advantage of the XML parser in SyncML_Command.

$Horde: framework/SyncML/SyncML/Command/SyncHdr.php,v 1.4.2.5 2009/04/05 21:38:48 jan Exp $

Copyright 2006-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /SyncML/SyncML/Command/SyncHdr.php (line 25)

SyncML_Command
   |
   --SyncML_Command_SyncHdr
Variable Summary
 string $credData
 string $credFormat
 string $credType
 string $user
 string $_cmdName
 integer $_maxMsgSize
 integer $_message
 string $_sessionID
 string $_sourceURI
 string $_targetURI
 integer $_version
Method Summary
 void endElement (string $uri, string $element)
 void setupState ()
Variables
string $credData (line 89)

Authentication credential as specified by the <Cred><Data> element.

string $credFormat (line 97)

Encoding format of $credData as specified in the <Cred><Meta><Format> element like 'b64'.

string $credType (line 105)

Media type of $credData as specified in the <Cred><Meta><Type> element like 'auth-basic'.

string $user (line 39)

Username as specified in the <LocName> element.

string $_cmdName = 'SyncHdr' (line 32)

Name of the command.


Redefinition of:
SyncML_Command::$_cmdName
Name of the command, like 'Put'.
integer $_maxMsgSize (line 113)

Maximum size of a SyncML message in bytes as specified by the <Meta><MaxMsgSize> element.

integer $_message (line 65)

Id of the current message as specified in the <MsgID> element.

string $_sessionID (line 49)

Id of this SyncML session as specified in the <SessionID> element.

This is not to confuse with the PHP session id, though it is part of the generated PHP session id.

string $_sourceURI (line 82)

The source URI as specified by the <Source><LocURI> element.

string $_targetURI (line 75)

The target URI as specified by the <Target><LocURI> element.

This is normally the URL of the Horde RPC server. However the client is free to send anything.

integer $_version (line 58)

SyncML protocol version as specified in the <VerProto> element.

  1. for SyncML 1.0, 1 for SyncML 1.1, etc.

Inherited Variables

Inherited from SyncML_Command

SyncML_Command::$_chars
SyncML_Command::$_cmdID
SyncML_Command::$_outputHandler
SyncML_Command::$_stack
Methods
endElement (line 122)

End element handler for the XML parser, delegated from SyncML_ContentHandler::endElement().

void endElement (string $uri, string $element)
  • string $uri: The namespace URI of the element.
  • string $element: The element tag name.

Redefinition of:
SyncML_Command::endElement()
End element handler for the XML parser, delegated from SyncML_ContentHandler::endElement().
setupState (line 189)

Starts the PHP session and instantiates the global SyncML_State object if doesn't exist yet.

void setupState ()

Inherited Methods

Inherited From SyncML_Command

 SyncML_Command::SyncML_Command()
 SyncML_Command::characters()
 SyncML_Command::endElement()
 SyncML_Command::factory()
 SyncML_Command::getCommandName()
 SyncML_Command::handleCommand()
 SyncML_Command::startElement()

Documentation generated on Sun, 30 Jan 2011 05:22:34 +0000 by phpDocumentor 1.4.3