<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Hub::Knots::TiedObject</title>
<link rel="stylesheet" href="../../styles.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:Gentoo@livesitemail.(none)" />
</head>
<body>
<p><a name="__index__"></a></p>
<!-- INDEX BEGIN -->
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#description">DESCRIPTION</a></li>
<ul>
<li><a href="#intention">Intention</a></li>
<li><a href="#implementation">Implementation</a></li>
</ul>
<li><a href="#internal_methods">INTERNAL METHODS</a></li>
<ul>
<li><a href="#_key">_key</a></li>
<li><a href="#tiehash">TIEHASH</a></li>
<li><a href="#fetch">FETCH</a></li>
<li><a href="#store">STORE</a></li>
<li><a href="#delete">DELETE</a></li>
<li><a href="#clear">CLEAR</a></li>
<li><a href="#exists">EXISTS</a></li>
<li><a href="#firstkey">FIRSTKEY</a></li>
<li><a href="#nextkey">NEXTKEY</a></li>
<li><a href="#scalar">SCALAR</a></li>
<li><a href="#untie">UNTIE</a></li>
</ul>
<li><a href="#author">AUTHOR</a></li>
<li><a href="#copyright">COPYRIGHT</a></li>
<li><a href="#updated">UPDATED</a></li>
</ul>
<!-- INDEX END -->
<hr />
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>Hub::Knots::TiedObject - Tied object</p>
<p>
<a href="#__index__"><small>Top</small></a>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<p>In your class:</p>
<pre>
package __Package_Name__;
use Hub qw(:lib);
sub new {
my $self = shift;
my $class = ref( $self ) || $self;
my $obj = bless {}, $class;
tie %$obj, 'Hub::Knots::TiedObject', '__Tie_Package__';
return $obj;
}#new</pre>
<p>
<a href="#__index__"><small>Top</small></a>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>Perl5 does not let one implement tie methods for a normal blessed package. To
get around this, the above constructor ties the blessed reference to this
package, providing '__Tie_Package__' as the package which should implement the
tie methods.</p>
<p>
</p>
<h2><a name="intention">Intention</a></h2>
<p>To transparently provide `tie' methods inline with an existing class. For
example, one may have a User class which supports several methods, such as
`print', and we wish to update the database on the fly...</p>
<pre>
my $user = new User( $conn, 'mary', 'alzxjVT8kR.aU' );
$user->{'lname'} = "Lopez";
$user->print();</pre>
<p>
</p>
<h2><a name="implementation">Implementation</a></h2>
<p>TiedObject simply provides two hashes for the object: `public' and `private'.
When data members are accessed, the 'public' hash is acted upon. If the index
begins with an asterisk (*) then the private hash is used. The only values
currently in the private hash are:</p>
<pre>
$self->{'*tied'}; # Points to the reference returned by tie-ing
# '__Tie_Package__' to the public hash.</pre>
<pre>
$self->{'*public'}; # Points to the public hash</pre>
<p>
<a href="#__index__"><small>Top</small></a>
</p>
<hr />
<h1><a name="internal_methods">INTERNAL METHODS</a></h1>
<p>
</p>
<h2><a name="_key">_key</a></h2>
<dl>
<dt><strong><a name="item_key">Determine which key (public or private) to use</a></strong>
</dl>
<p>
</p>
<h2><a name="tiehash">TIEHASH</a></h2>
<dl>
<dt><strong><a name="item_tie_interface_method">Tie interface method</a></strong>
<dd>
<pre>
Usage: TIEHASH 'Hub::Knots::TiedObject', $PACKAGE</pre>
</dd>
</dl>
<p>
</p>
<h2><a name="fetch">FETCH</a></h2>
<dl>
<dt><strong><a name="item_return_a_value">Return a value</a></strong>
</dl>
<p>
</p>
<h2><a name="store">STORE</a></h2>
<dl>
<dt><strong><a name="item_store_a_value">Store a value</a></strong>
</dl>
<p>
</p>
<h2><a name="delete">DELETE</a></h2>
<dl>
<dt><strong><a name="item_remove_a_value">Remove a value</a></strong>
</dl>
<p>
</p>
<h2><a name="clear">CLEAR</a></h2>
<dl>
<dt><strong><a name="item_remove_all_public_values">Remove all public values</a></strong>
</dl>
<p>
</p>
<h2><a name="exists">EXISTS</a></h2>
<dl>
<dt><strong><a name="item_boolean_test_for_value">Boolean test for value</a></strong>
</dl>
<p>
</p>
<h2><a name="firstkey">FIRSTKEY</a></h2>
<dl>
<dt><strong>Tie interface method</strong>
</dl>
<p>
</p>
<h2><a name="nextkey">NEXTKEY</a></h2>
<dl>
<dt><strong>Tie interface method</strong>
</dl>
<p>
</p>
<h2><a name="scalar">SCALAR</a></h2>
<dl>
<dt><strong><a name="item_scalar_representation">Scalar representation</a></strong>
</dl>
<p>
</p>
<h2><a name="untie">UNTIE</a></h2>
<dl>
<dt><strong>Tie interface method</strong>
</dl>
<p>
<a href="#__index__"><small>Top</small></a>
</p>
<hr />
<h1><a name="author">AUTHOR</a></h1>
<p>Ryan Gies (<a href="mailto:ryangies@livesite.net">ryangies@livesite.net</a>)</p>
<p>
<a href="#__index__"><small>Top</small></a>
</p>
<hr />
<h1><a name="copyright">COPYRIGHT</a></h1>
<p>Copyright (C) 2006-2007 by Livesite Networks, LLC. All rights reserved.</p>
<p>Copyright (C) 2000-2005 by Ryan Gies. All rights reserved.</p>
<p>Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:</p>
<p>* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.</p>
<p>* 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.</p>
<p>* Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.</p>
<p>* The name of the author may not be used to endorse or promote products
derived from this software without specific prior written permission.</p>
<p>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.</p>
<p>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.</p>
<p>
<a href="#__index__"><small>Top</small></a>
</p>
<hr />
<h1><a name="updated">UPDATED</a></h1>
<p>08/02/2007</p>
<p><a href="#__index__"><small>Top</small></a></p>
</body>
</html>