Overview

Namespaces

  • Simpletools
    • Autoload
    • Config
    • Db
      • Mysql
    • Event
    • Http
    • Mvc
    • Page
    • Store

Classes

  • Cookie
  • Flash
  • Session
  • Overview
  • Namespace
  • Class

Class Flash

Flash Message Storage

Namespace: Simpletools\Store
Located at Simpletools/Store/Flash.php
Methods summary
public static null
# settings( array $settings = array() )

Global settings setter

Global settings setter

Parameters

$settings
Settings to be used as default

Returns

null
protected static boolean
# _cleanPrevious( )

Flash old messages cleaner

Flash old messages cleaner

Returns

boolean
public static null
# reflush( mixed $keys = null )

Existing messages reflusher allowing them to last till next session

Existing messages reflusher allowing them to last till next session

Parameters

$keys
Settings to be used as default

Returns

null
public static null
# set( string $key, mixed $value, array $settings = array() )

Message setter

Message setter

Parameters

$key
Message key
$value
Message value
$settings
Message additional settings e.g. readOnce

Returns

null
public static mixed
# get( string $key )

Message getter

Message getter

Parameters

$key
Message key

Returns

mixed
Returns message value
public static boolean
# is( string $key )

Message existence checker

Message existence checker

Parameters

$key
Message key

Returns

boolean
public static boolean
# remove( string $key )

Message unsetter

Message unsetter

Parameters

$key
Message key

Returns

boolean
Returns true on successful unset, false otherwise
Properties summary
protected static string $_sessionKey

Simpletools\Store\Flash Session key internal namespace to prevent direct session overwrite

Simpletools\Store\Flash Session key internal namespace to prevent direct session overwrite

# 'ST_FLASH_32896hdiuqwgd6723gdy23g.'
protected static integer $_cleanedPrev

Cleaning process controller

Cleaning process controller

# 0
protected static boolean $_readOnce

Setting clearing message, when set to true clears the message straight after 1st get, useful when flash message is accessed within same request that it was set, defaults to false

Setting clearing message, when set to true clears the message straight after 1st get, useful when flash message is accessed within same request that it was set, defaults to false

# false
protected static string $_defaultReturn

Setting what to return if get can't find a message with a key, ST__EXCEPTION will throw an exception;

Setting what to return if get can't find a message with a key, ST__EXCEPTION will throw an exception;

# 'ST__EXCEPTION'
API documentation generated by ApiGen