Class: Session_Handler

Source Location: /tinymvc/myapp/plugins/script.Session_Handler.php

Class Overview [line 8]


Session Handler is used to "leave messages" for the next page shown, such as error messages or notices.

Author(s):

Version:

Copyright:

Variables

Constants

Methods


Inherited Variables

Inherited Constants

Inherited Methods



Class Details

Session Handler is used to "leave messages" for the next page shown, such as error messages or notices.

Session Handler also abstracts the process of setting and getting cookie and session vars.

[ Top ]


Class Variables


Class Methods

static addError

static void addError( $error, $type)

[line 28]

Leave an error message, along with a "type" to identify what kind of error it is (i.e. "login")

Parameters:

  • $error -
  • $type -

[ Top ]

static addMessage

static void addMessage( $message)

[line 13]

Leave a message to be shown by the next page view

Parameters:

  • $message -

[ Top ]

static end

static void end( )

[line 150]

End the user's session.

Parameters:

[ Top ]

static getCookie

static void getCookie( $varname)

[line 100]

Get a cookie's value.

Parameters:

  • $varname -

[ Top ]

static getErrors

static void getErrors( )

[line 71]

Retrieve the errors left in the previous page view

Parameters:

[ Top ]

static getMessages

static void getMessages( )

[line 53]

Retrieve the messages left in the previous page view

Parameters:

[ Top ]

static getSession

static void getSession( $varname)

[line 125]

Get a session value.

Parameters:

  • $varname -

[ Top ]

static setCookie

static void setCookie( $varname, $value, [ $expire = 0])

[line 89]

Set a cookie's value.

Parameters:

  • $varname -
  • $value -
  • $expire -

[ Top ]

static setSession

static void setSession( $varname, $value)

[line 112]

Set a session value

Parameters:

  • $varname -
  • $value -

[ Top ]

static start

static void start( )

[line 139]

Start (or resume) the user's session

Parameters:

[ Top ]


Class Constants


Documentation generated on Tue, 26 May 2009 14:50:37 -0700 by phpDocumentor 1.4.1