The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
hub-standard-04.00.012
++
/ Hub::Data::File

NAME

Hub::Data::File - File

SYNOPSIS

  use Hub qw(:standard);
  my $file = mkinst('File', 'foo.txt');
  print ${$file->get_content()};

DESCRIPTION

A basic file which can be written and saved. It acts as a singleton and is integrated into the filecache system (supports refresh).

Intention

The FileSystem::snapshot method creates an image of the file system. Each file is an instance of this class. We delay reading from disk until it is necessary. We do not keep a file handle open.

PUBLIC METHODS

new

Constructor.

delay_reading

Instruct FileCache to delay reading from disk

reload

Callback from FileCache when a read from disk is performed

get_data

Get a reference to the hash data defined in this file

get_content

Return file contents
 Usage: get_content [options]

options:

  -as_ref => 1         # Return a reference

set_content

Set file contents

save

Save file contents to disk
 Usage: save [options]

options: -priority => 'content' Content values presceed data values

set_sort_order

INTERNAL METHODS

_merge_data_into_content

AUTHOR

Ryan Gies (ryangies@livesite.net)

COPYRIGHT

Copyright (C) 2006-2007 by Livesite Networks, LLC. All rights reserved.

Copyright (C) 2000-2005 by Ryan Gies. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.

* Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.

* The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

To the best of our knowledge, no patented algorithms have been used. However, we do not have the resources to carry out a patent search, and therefore cannot give any guarantee of the above statement.

UPDATED

06/09/2007