| alpha--view

# Class: ViewState Source Location: /view/ViewState.inc ## Class ViewState Class Overview
A singleton class that maintains the view state in the session Located in /view/ViewState.inc [line 50]
Author(s): John Collins <dev@alphaframework.org> Information Tags:
Version: | $Id: ViewState.inc 1453 2011-12-04 15:12:54Z johnc $
Copyright: | Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved.
     Redistribution and use in source and binary forms, with or
     without modification, are permitted provided that the
     following conditions are met:

     * Redistributions of source code must retain the above
       copyright notice, this list of conditions and the
       following disclaimer.
     * Redistributions in binary form must reproduce the above
       copyright notice, this list of conditions and the
       following disclaimer in the documentation and/or other
       materials provided with the distribution.
     * Neither the name of the Alpha Framework nor the names
       of its contributors may be used to endorse or promote
       products derived from this software without specific
       prior written permission.

     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
     OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Since: | 1.0
License: | The BSD License
| Properties $instance $markdownTextBoxRows $selectedTab | Methods get getInstance set
[ Top ] Property Summary
static ViewState | $instance | The view state object singleton
string | $markdownTextBoxRows | The amount of rows to expand the Markdown edit TextBox by
string | $selectedTab | The name of the last selected tab by the user
[ Top ] Method Summary
static void | getInstance() | Get the ViewState instance. Loads from $_SESSION if its not already in memory, otherwise a new instance will be returned with empty properties.
string | get() | Get the attribute value indicated by the key
void | set() | Sets the attribute value indicated by the key. The ViewState instance will be serialized and saved back to the $_SESSION.
[ Top ] Properties static ViewState $instance [line 73] The view state object singleton API Tags:
Access: | protected
Information Tags:
Since: | 1.0
[ Top ] string $markdownTextBoxRows [line 65] The amount of rows to expand the Markdown edit TextBox by API Tags:
Access: | protected
Information Tags:
Since: | 1.0
[ Top ] string $selectedTab [line 57] The name of the last selected tab by the user API Tags:
Access: | protected
Information Tags:
Since: | 1.0
[ Top ] Methods static method getInstance [line 89]
`static void getInstance( )`
Get the ViewState instance. Loads from $_SESSION if its not already in memory, otherwise a new instance will be returned with empty properties. API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] get [line 112]
`string get( string $key )`
Get the attribute value indicated by the key Parameters:
string | $key: |
API Tags:
Access: | public
Information Tags:
Throws: | IllegalArguementException
Since: | 1.0
[ Top ] set [line 129]
`void set( string $key, string $value )`
Sets the attribute value indicated by the key. The ViewState instance will be serialized and saved back to the $_SESSION. Parameters:
string | $key: |
string | $value: |
API Tags:
Access: | public
Information Tags:
Throws: | IllegalArguementException
Since: | 1.0
[ Top ] Documentation generated on Tue, 13 Dec 2011 20:27:55 +0000 by phpDocumentor 1.4.3