Manual Reference Pages - PADRE::CACHE (3)
Padre::Cache - The Padre Temporary Data Cache API
<B>Padre::CacheB> implements a light memory only caching mechanism which is
designed to support GUI objects that need to temporarily store state data.
By providing this caching in a neutral location that is not directly bound
to the user interface objects, the cached data can survive destruction and
recreation of those interface objects.
This is particularly valuable for situations such as a shift in the active
language or the relocation of a tool that would result in interface objects
Cache data is stored in a Stash, which is a HASH reference containing
arbitrary content, and is keyed off a project or document.
my $stash = Padre::Cache->stash( Padre::Wx::MyClass => $project );
The stash method fetches the HASH reference stash for a particular key
pair, which consists of a GUI class name and a project or document.
The HASH reference returned can be used directly withouth the need to do
any kind of get or set call to the stash.
Calling stash multiple times is guarenteed to fetch the same HASH
Padre::Cache->release( $project->root );
The release method is used to flush all of the stash data related to a
particular project root or file name for all of the GUI elements that make
use of stash objects from Padre::Cache.
Although this method is available for use, it should generally not be called
directly. The built in DESTROY for both project and document objects will
call this method for you, automatically cleaning up the stash data when the
project or document itself is destroyed.
COPYRIGHT & LICENSE
Copyright 2008-2013 The Padre development team as listed in Padre.pm.
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl 5 itself.
The full text of the license can be found in the
LICENSE file included with this module.
|perl v5.20.3 ||PADRE::CACHE (3) ||2013-11-09 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.