AS2Secure
[ class tree: AS2Secure ] [ index: AS2Secure ] [ all elements ]

Class: AS2Header

Source Location: /AS2Header.php

Class Overview


AS2Secure - PHP Lib for AS2 message encoding / decoding


Author(s):

Version:

  • 0.9.0

Copyright:

  • Copyright (c) 2010, Sebastien MALOT

    Last release at : http://www.as2secure.com

    This file is part of AS2Secure Project.

    AS2Secure is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

    AS2Secure is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along with AS2Secure.

Implements interfaces:

  • Countable (internal interface)
  • ArrayAccess (internal interface)
  • Iterator (internal interface)

Variables

Methods



Class Details

[line 32]
AS2Secure - PHP Lib for AS2 message encoding / decoding



Tags:

author:  Sebastien MALOT <contact@as2secure.com>
version:  0.9.0
copyright:  

Copyright (c) 2010, Sebastien MALOT

Last release at : http://www.as2secure.com

This file is part of AS2Secure Project.

AS2Secure is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

AS2Secure is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with AS2Secure.

license:  GNU General Public License


[ Top ]


Class Variables

$headers = array()

[line 33]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_position =  null

[line 35]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


static method parseHttpRequest [line 247]

static object AS2Header parseHttpRequest( string 0)

Extract headers from http request and return a new instance of AS2Header



Tags:

return:  instance
access:  public


Parameters:

string   0   The content to parse

[ Top ]

static method parseText [line 222]

static object AS2Header parseText( string $text)

Extract headers from mime message and return a new instance of AS2Header



Tags:

return:  instance
access:  public


Parameters:

string   $text   The content to parse

[ Top ]

constructor __construct [line 37]

AS2Header __construct( [ $data = null])



Tags:

access:  public


Parameters:

   $data  

[ Top ]

method addHeader [line 62]

void addHeader( string $key, string $value)

Add new header (or override current one)



Tags:

access:  public


Parameters:

string   $key   The name of the header
string   $value   The value of the header

[ Top ]

method addHeaders [line 71]

void addHeaders( $values, array $headers)

Add a set of headers (or override currents)



Tags:

access:  public


Parameters:

array   $headers   The new headers to use
   $values  

[ Top ]

method addHeadersFromMessage [line 81]

void addHeadersFromMessage( string $message)

Add a set of headers extracted from a mime message



Tags:

access:  public


Parameters:

string   $message   The message content to use

[ Top ]

method count [line 139]

int count( )

Return the count of headers



Tags:

access:  public



Implementation of:
Countable::count
[ Top ]

method current [line 194]

void current( )

*********************



Tags:

access:  public



Implementation of:
Iterator::current
[ Top ]

method exists [line 150]

boolean exists( string $key)

Check if an header exists



Tags:

access:  public


Parameters:

string   $key   The header to check existance

[ Top ]

method getHeader [line 127]

string getHeader( string $key)

Return the value of an header



Tags:

return:  The value corresponding
access:  public


Parameters:

string   $key   The header

[ Top ]

method getHeaders [line 103]

array getHeaders( )

Return all headers as an array



Tags:

return:  The headers, eg: array(name1 => value1, name2 => value2)
access:  public


[ Top ]

method key [line 198]

void key( )



Tags:

access:  public



Implementation of:
Iterator::key
[ Top ]

method next [line 203]

void next( )



Tags:

access:  public



Implementation of:
Iterator::next
[ Top ]

method offsetExists [line 174]

void offsetExists( $offset)

************************



Tags:

access:  public



Implementation of:
ArrayAccess::offsetExists

Parameters:

   $offset  

[ Top ]

method offsetGet [line 178]

void offsetGet( $offset)



Tags:

access:  public



Implementation of:
ArrayAccess::offsetGet

Parameters:

   $offset  

[ Top ]

method offsetSet [line 182]

void offsetSet( $offset, $value)



Tags:

access:  public



Implementation of:
ArrayAccess::offsetSet

Parameters:

   $offset  
   $value  

[ Top ]

method offsetUnset [line 186]

void offsetUnset( $offset)



Tags:

access:  public



Implementation of:
ArrayAccess::offsetUnset

Parameters:

   $offset  

[ Top ]

method removeHeader [line 94]

void removeHeader( string $key)

Remove an header



Tags:

access:  public


Parameters:

string   $key   The name of the header

[ Top ]

method rewind [line 207]

void rewind( )



Tags:

access:  public



Implementation of:
Iterator::rewind
[ Top ]

method setHeaders [line 51]

void setHeaders( array $headers)

Reset all current headers with new values



Tags:

access:  public


Parameters:

array   $headers   The new headers to use

[ Top ]

method toFormattedArray [line 112]

array toFormattedArray( )

Return all headers as a formatted array



Tags:

return:  The headers, eg: array(0 => name1:value1, 1 => name2:value2)
access:  public


[ Top ]

method valid [line 211]

void valid( )



Tags:

access:  public



Implementation of:
Iterator::valid
[ Top ]

method __toString [line 160]

string __toString( )

Magic method that returns headers serialized as in mime message



Tags:

access:  public


[ Top ]


Documentation generated on Wed, 03 Nov 2010 22:51:30 +0100 by phpDocumentor 1.4.3