wCMF  3.6
 All Classes Namespaces Files Functions Variables Groups Pages
Obfuscator Class Reference

Public Member Functions

getInstance ()
 
 obfuscate ($str)
 
 unveil ($str)
 
 ensureStorage ()
 

Public Attributes

 $VALUES_VARNAME = 'Obfuscator.values'
 

Detailed Description

This class allows to obfuscate strings. By passing an objuscated string to the method Obfuscator::unveil() the orginal string is returned. This is especially useful, if you want to place a secret string inside a client view as a parameter and want to get the original string back as the request is processed.

wCMF - wemove Content Management Framework Copyright (C) 2005-2014 wemove digital solutions GmbH

Licensed under the terms of any of the following licenses at your choice:

See the license.txt file distributed with this work for additional information.

Id:
class.Obfuscator.php 1462 2014-02-04 23:52:27Z iherwig
Author
ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 31 of file class.Obfuscator.php.

Member Function Documentation

& Obfuscator::getInstance ( )

Returns an instance of the class.

Returns
A reference to the only instance of the Singleton object

Definition at line 40 of file class.Obfuscator.php.

Referenced by Controller\assignViewDefaults(), DefaultControlRenderer\configure_select(), obfuscate(), and unveil().

Obfuscator::obfuscate (   $str)

Get an obfuscated string

Note
This method maybe called staticly
Parameters
strThe original sring
Returns
The obfuscated string

Definition at line 55 of file class.Obfuscator.php.

References getInstance(), and SessionData\getInstance().

+ Here is the call graph for this function:

Obfuscator::unveil (   $str)

Get an unveiled string

Note
This method maybe called staticly
Parameters
strThe obfuscated sring
Returns
The original string or an empty string if it does not exist

Definition at line 78 of file class.Obfuscator.php.

References getInstance(), and SessionData\getInstance().

Referenced by ListboxController\executeKernel(), AsyncPagingController\executeKernel(), and SortController\sortAll().

+ Here is the call graph for this function:

Obfuscator::ensureStorage ( )

Ensure that the session storage for the values is initialized

Definition at line 91 of file class.Obfuscator.php.

References SessionData\getInstance().

+ Here is the call graph for this function:

Member Data Documentation

Obfuscator::$VALUES_VARNAME = 'Obfuscator.values'

Definition at line 34 of file class.Obfuscator.php.


The documentation for this class was generated from the following file: