ForwardFW
[ class tree: ForwardFW ] [ index: ForwardFW ] [ all elements ]
Packages:
ForwardFW


Files:
subpackage Cache
Backend.php
Exception.php
IsGenerating.php
NoData.php
TimeOut.php

subpackage Cache-Backend
File.php
Session.php

subpackage Callback
Callback.php
DataHandler.php

subpackage Config
Backend.php
Data.php
File.php
Frontend.php
Function.php

subpackage Controller
Application.php
DataHandler.php
Screen.php
View.php

subpackage Controller-DataHandler
MDB2.php

subpackage Interface
Application.php
Backend.php
DataHandler.php
Frontend.php
Screen.php
Templater.php

subpackage List
Sql.php
Timer.php

subpackage Main
Callback.php
Config.php
Controller.php
Exception.php
Filter.php
Frontend.php
Function.php
List.php
Object.php
Request.php
Response.php
Start.php
Templater.php

subpackage Object
Sql.php
Timer.php

subpackage RequestResponse
Application.php
FirePHP.php
RequestResponse.php

subpackage Templater
Smarty.php
Twig.php

Interfaces:
Interface
   ForwardFW_Interface_Application
   ForwardFW_Interface_Cache_Backend
   ForwardFW_Interface_Cache_Frontend
   ForwardFW_Interface_DataHandler
   ForwardFW_Interface_Screen
   ForwardFW_Interface_Templater
Classes:
RequestResponse
   ForwardFW_Filter_RequestResponse
   ForwardFW_Filter_RequestResponse_Application
   ForwardFW_Filter_RequestResponse_FirePHP
Controller
   ForwardFW_Controller_Application
   ForwardFW_Controller_DataHandler
   ForwardFW_Controller_Screen
   ForwardFW_Controller_View
Cache
   ForwardFW_Cache_Backend
   ForwardFW_Cache_Exception
   ForwardFW_Cache_Exception_IsGenerating
   ForwardFW_Cache_Exception_NoData
   ForwardFW_Cache_Exception_TimeOut
Config
   ForwardFW_Config_Cache_Backend
   ForwardFW_Config_Cache_Backend_File
   ForwardFW_Config_Cache_Data
   ForwardFW_Config_Cache_Data_Function
   ForwardFW_Config_Cache_Frontend
Main
   ForwardFW_Cache_Frontend
   ForwardFW_Cache_Frontend_Function
   ForwardFW_Callback
   ForwardFW_Config
   ForwardFW_Controller
   ForwardFW_Exception
   ForwardFW_Filter
   ForwardFW_List
   ForwardFW_Object
   ForwardFW_Request
   ForwardFW_Response
   ForwardFW_Templater
Callback
   ForwardFW_Exception_Callback
   ForwardFW_Exception_DataHandler
Cache-Backend
   ForwardFW_Cache_Backend_File
   ForwardFW_Cache_Backend_Session
Controller-DataHandler
   ForwardFW_Controller_DataHandler_MDB2
Templater
   ForwardFW_Templater_Smarty
   ForwardFW_Templater_Twig
List
   ForwardFW_List_Sql
   ForwardFW_List_Timer
Object
   ForwardFW_Object_Sql
   ForwardFW_Object_Timer

Class: ForwardFW_Cache_Frontend

Source Location: /Cache/Frontend.php

Class Overview




Interface for a Cache.




Author(s):






                

                

            Implements interfaces:
            

        

        






Methods















Child classes:






ForwardFW_Cache_Frontend_Function

	
Implementation of a Cache.

















Class Details



[line 53]

Interface for a Cache.





Tags:





  

    author:  Alexander Opitz <opitz.alexander@primacom.net>
  

  

    link:  http://forwardfw.sourceforge.net
  

  

    abstract:  
  

  

    license:  GNU General Public License
  










[ Top ]








Class Methods



  

	
	
static method getBackend [line 101]

	

    

    

		static ForwardFW_Interface_Cache_Backend getBackend(
ForwardFW_Interface_Application
$application, string
$strCacheBackend, ForwardFW_Config_Cache_Backend
$config)
    

    


	
		Builds Backend of a cache configuration





Tags:





  

    return:  Caching Backend.
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        ForwardFW_Interface_Application  
        $application  
        The running application
      

          

        string  
        $strCacheBackend  
        Configuration of caching
      

          

        ForwardFW_Config_Cache_Backend  
        $config  
        Configuration of caching
      

        

    


        
[ Top ]

  

  

	
	
static method getFrontend [line 125]

	

    

    

		static ForwardFW_Interface_Cache_Frontend getFrontend(
ForwardFW_Interface_Application
$application, ForwardFW_Config_Cache_Frontend
$config, ForwardFW_Interface_Cache_Backend
$backend)
    

    


	
		Builds Backend of a cache configuration





Tags:





  

    return:  Caching Frontend.
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        ForwardFW_Interface_Application  
        $application  
        The running application
      

          

        ForwardFW_Config_Cache_Frontend  
        $config  
        Configuration of caching
      

          

        ForwardFW_Interface_Cache_Backend  
        $backend  
        Backend for the frontend
      

        

    


        
[ Top ]

  

  

	
	
static method getInstance [line 79]

	

    

    

		static ForwardFW_Interface_Cache_Frontend getInstance(
ForwardFW_Interface_Application
$application, ForwardFW_Config_Cache_Frontend
$config)
    

    


	
		Builds an instance of cache





Tags:





  

    return:  The cache Frontend
  

  

    access:  public
  









			

		
Implementation of:

			

			
ForwardFW_Interface_Cache_Frontend::getInstance()

						
Builds an instance of cache

					

		
        
Parameters:

    

    

          

        ForwardFW_Interface_Application  
        $application  
        The running application
      

          

        ForwardFW_Config_Cache_Frontend  
        $config  
        Configuration of caching
      

        

    


        
[ Top ]

  


  

	
	
constructor __construct [line 63]

	

    

    

		void __construct(
ForwardFW_Interface_Application
$application, ForwardFW_Interface_Cache_Backend
$backend)
    

    


	
		Constructor





Tags:





  

    access:  public
  









			

		
Implementation of:

			

			
ForwardFW_Interface_Cache_Frontend::__construct()

						
Constructor

					

		
        
Parameters:

    

    

          

        ForwardFW_Interface_Application  
        $application  
        The running application
      

          

        ForwardFW_Interface_Cache_Backend  
        $backend  
        Backend instance.
      

        

    


        
[ Top ]

  

  

	
	
method calculateHash [line 205]

	

    

    

		void calculateHash(
ForwardFW_Config_Cache_Data
$config)
    

    


	
		



Tags:





  

    abstract:  
  

  

    access:  protected
  









	
Overridden in child classes as:

		

	
ForwardFW_Cache_Frontend_Function::calculateHash()

		
Returns hash for this config.

	

	

	
        
Parameters:

    

    

          

        ForwardFW_Config_Cache_Data  
        $config  
        
      

        

    


        
[ Top ]

  

  

	
	
method getCache [line 148]

	

    

    

		mixed getCache(
ForwardFW_Config_Cache_Data
$config)
    

    


	
		Returns content from cache or gathers the data





Tags:





  

    return:  The data you requested.
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
ForwardFW_Cache_Frontend_Function::getCache()

		
Returns content from cache or gathers the data

	

	

			

		
Implementation of:

			

			
ForwardFW_Interface_Cache_Frontend::getCache()

						
Returns content from cache or gathers the data

					

		
        
Parameters:

    

    

          

        ForwardFW_Config_Cache_Data  
        $config  
        What data should be get from cache
      

        

    


        
[ Top ]

  

  

	
	
method getDataToCache [line 207]

	

    

    

		void getDataToCache(
ForwardFW_Config_Cache_Data
$config)
    

    


	
		



Tags:





  

    abstract:  
  

  

    access:  protected
  









	
Overridden in child classes as:

		

	
ForwardFW_Cache_Frontend_Function::getDataToCache()

		

	

	

	
        
Parameters:

    

    

          

        ForwardFW_Config_Cache_Data  
        $config  
        
      

        

    


        
[ Top ]

  

  

	
	
method getHash [line 216]

	

    

    

		string getHash(
mixed
$mValue)
    

    


	
		Calculates a hash by serialize and md5.





Tags:





  

    return:  The hash.
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        mixed  
        $mValue  
        The data from which the hash should be gathered.
      

        

    


        
[ Top ]

  

  

	
	
method getRealData [line 188]

	

    

    

		mixed getRealData(
String
$strHash, ForwardFW_Config_Cache_Data
$config, boolean
$bOldAvailable)
    

    


	
		Returns the real data and add it to cache. If real data fails tries to  get old data from cache if available.





Tags:





  

    return:  The data you requested.
  

  

    access:  protected
  









	
        
Parameters:

    

    

          

        String  
        $strHash  
        Hash of cache
      

          

        ForwardFW_Config_Cache_Data  
        $config  
        What data should be get                                                    from cache.
      

          

        boolean  
        $bOldAvailable  
        True if backend has old                                                    data for hash.
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Sun, 30 Jan 2011 20:46:42 +0100 by phpDocumentor 1.4.3