Overview

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • ArticleCommentView
  • ArticleView
  • DEnumView
  • PersonView
  • SequenceView
  • View
  • ViewState
  • Overview
  • Namespace
  • Class
  • Tree

Class ViewState

A singleton class that maintains the view state in the session.

Namespace: Alpha\View
Copyright: Copyright (c) 2015, John Collins (founder of Alpha Framework). All rights reserved. <pre> 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. </pre>
License: The BSD License
Author: John Collins <dev@alphaframework.org>
Since: 1.0
Located at View/ViewState.php
Methods summary
public static Alpha\View\ViewState
# getInstance( )

Get the ViewState instance. Loads from $_SESSION if its not already in memory, otherwise a new instance will be returned with empty properties.

Get the ViewState instance. Loads from $_SESSION if its not already in memory, otherwise a new instance will be returned with empty properties.

Returns

Alpha\View\ViewState
Alpha\View\ViewState

Since

1.0
public string
# get( string $key )

Get the attribute value indicated by the key.

Get the attribute value indicated by the key.

Parameters

$key
string $key

Returns

string
string

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

1.0
public
# 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.

Sets the attribute value indicated by the key. The ViewState instance will be serialized and saved back to the $_SESSION.

Parameters

$key
string $key
$value
string $value

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

1.0
Properties summary
protected string $selectedTab
#

The name of the last selected tab by the user.

The name of the last selected tab by the user.

Since

1.0
protected string $markdownTextBoxRows
#

The amount of rows to expand the Markdown edit TextBox by.

The amount of rows to expand the Markdown edit TextBox by.

Since

1.0
protected boolean $renderAdminMenu false
#

If the backend admin menu should be displayed or not.

If the backend admin menu should be displayed or not.

Since

2.0
protected integer $selectedStart 0
#

The start position of the last pagination page by the user.

The start position of the last pagination page by the user.

Since

2.0
protected static Alpha\View\ViewState $instance
#

The view state object singleton.

The view state object singleton.

Since

1.0
Alpha Framework 2.0.4 API Documentation API documentation generated by ApiGen 2.8.0