Class: PageCache

Source Location: /qp_inc/_core/model/_pagecache.class.php

Class PageCache

Class Overview

Page Cache.

Located in /qp_inc/_core/model/_pagecache.class.php [line 34]

Properties

Methods

[ Top ]

Property Summary

mixed	$ads_collcache_path
mixed	$cached_page_content	Progressively caching the content of the current page:
mixed	$cache_filepath	Filename of cache for current page
mixed	$is_collecting	Are we currently recording cache contents for this page?
mixed	$is_enabled	By default we consider caching not to be enabled
mixed	$max_age_seconds	How old can a cached object get before we consider it outdated
mixed	$output_chunk_size	After how many bytes should we output sth live while collecting cache content:

[ Top ]

Method Summary

PageCache	PageCache()	Constructor
void	abort_collect()	We are going to output personal data and we want to abort collecting the data for the cache.
boolean	cache_create()
void	cache_delete()	Delete all cache files
true	check()	Check if cache contents are available, otherwise start collecting output to be cached
void	end_collect()	End collecting output to be cached
string	gen_filecache_path()	Generate path for caching $url.
void	get_af_filecache_path()	Get path to file for current URL
void	invalidate()	Invalidate a particular page from the cache
void	output_handler()	This is called every x bytes to provide real time output
boolean	retrieve()	Retrieve and output cache for current URL.

[ Top ]

Properties

mixed $ads_collcache_path [line 54]

[ Top ]

mixed $cached_page_content = '' [line 63]

Progressively caching the content of the current page:

[ Top ]

mixed $cache_filepath [line 59]

Filename of cache for current page

[ Top ]

mixed $is_collecting = false [line 67]

Are we currently recording cache contents for this page?

[ Top ]

mixed $is_enabled = false [line 49]

By default we consider caching not to be enabled

[ Top ]

mixed $max_age_seconds = 300 [line 39]

How old can a cached object get before we consider it outdated

[ Top ]

mixed $output_chunk_size = 2000 [line 44]

After how many bytes should we output sth live while collecting cache content:

[ Top ]

Methods

Constructor PageCache [line 75]

PageCache PageCache(
[Blog
$Blog = NULL] 
)

Constructor

Parameters:

Blog

$Blog:

to use, can be NULL

[ Top ]

abort_collect [line 342]

void abort_collect(
)

We are going to output personal data and we want to abort collecting the data for the cache.

[ Top ]

cache_create [line 170]

boolean cache_create(
)

API Tags:

Return:

true if cache has been successfully created

[ Top ]

cache_delete [line 188]

void cache_delete(
)

Delete all cache files

[ Top ]

check [line 199]

true check(
)

Check if cache contents are available, otherwise start collecting output to be cached

API Tags:

Return:

if we found and have echoed content from the cache

[ Top ]

end_collect [line 363]

void end_collect(
)

End collecting output to be cached

[ Top ]

gen_filecache_path [line 141]

string gen_filecache_path(
string
$url 
)

Generate path for caching $url.

Parameters:

string

$url:

URL

[ Top ]

get_af_filecache_path [line 116]

void get_af_filecache_path(
)

Get path to file for current URL

Information Tags:

Todo:

fp> We may need to add some keys like the locale or the charset, I'm not sure.

[ Top ]

invalidate [line 154]

void invalidate(
URL
$url 
)

Invalidate a particular page from the cache

Parameters:

URL

$url:

of the page to be invalidated

[ Top ]

output_handler [line 332]

void output_handler(

$buffer 
)

This is called every x bytes to provide real time output

Parameters:

$buffer:

[ Top ]

retrieve [line 257]

boolean retrieve(
)

Retrieve and output cache for current URL.

API Tags:

Return:

true if we could retrieve

[ Top ]

hic sunt dracones