<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class Horde_Block_Account_Finger</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<script src="../media/lib/classTree.js"></script>
<script language="javascript" type="text/javascript">
var imgPlus = new Image();
var imgMinus = new Image();
imgPlus.src = "../media/images/plus.png";
imgMinus.src = "../media/images/minus.png";
function showNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgMinus.src;
oTable.style.display = "block";
}
function hideNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgPlus.src;
oTable.style.display = "none";
}
function nodeIsVisible(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
break;
}
return (oTable && oTable.style.display == "block");
}
function toggleNodeVisibility(Node){
if (nodeIsVisible(Node)){
hideNode(Node);
}else{
showNode(Node);
}
}
</script>
</head>
<body>
<div class="page-body">
<h2 class="class-name"><img src="../media/images/Class_logo.png"
alt=" Class"
title=" Class"
style="vertical-align: middle"> Horde_Block_Account_Finger</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-vars">Vars</a>
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Implements the Accounts API using finger to fetch information.</p>
<p class="description"><p>Copyright 2001-2012 Horde LLC (http://www.horde.org/)</p><p>See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.</p></p>
<ul class="tags">
<li><span class="field">author:</span> Peter Paul Elfferich <<a href="mailto:hide@address.com">hide@address.com</a>></li>
<li><span class="field">author:</span> Jan Schneider <<a href="mailto:hide@address.com">hide@address.com</a>></li>
</ul>
<p class="notes">
Located in <a class="field" href="_lib---Block---Account---Finger.php.html">/lib/Block/Account/Finger.php</a> (line <span class="field">14</span>)
</p>
<pre><a href="../Horde/Horde_Block_Account_Base.html">Horde_Block_Account_Base</a>
|
--Horde_Block_Account_Finger</pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<img src="../media/images/Constructor.png" alt=" "/>
<span class="method-result">Horde_Block_Account_Finger</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
([<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#getFullname" title="details" class="method-name">getFullname</a>
()
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#getHome" title="details" class="method-name">getHome</a>
()
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#getShell" title="details" class="method-name">getShell</a>
()
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#_get" title="details" class="method-name">_get</a>
(<span class="var-type">string</span> <span class="var-name">$what</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array</span>
<a href="#_getAccount" title="details" class="method-name">_getAccount</a>
()
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">array</span>
<a href="#_parseAccount" title="details" class="method-name">_parseAccount</a>
(<span class="var-type">array</span> <span class="var-name">$output</span>)
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../Horde/Horde_Block_Account_Base.html">Horde_Block_Account_Base</a></span></p>
<blockquote>
<img src="../media/images/Variable.png" />
<span class="var-title">
<span class="var-name"><a href="../Horde/Horde_Block_Account_Base.html#var$_params">Horde_Block_Account_Base::$_params</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Constructor.png" />
<span class="method-title">Constructor __construct</span> (line <span class="line-number">21</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">Horde_Block_Account_Finger</span>
<span class="method-name">
__construct
</span>
([<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$params</span><span class="var-description">: Hash containing connection parameters.</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../Horde/Horde_Block_Account_Base.html#method__construct">Horde_Block_Account_Base::__construct()</a></dt>
<dd>Constructor.</dd>
</dl>
</div>
<a name="methodgetFullname" id="getFullname"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">getFullname</span> (line <span class="line-number">89</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the user's full name.</p>
<ul class="tags">
<li><span class="field">return:</span> The user's full name.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
getFullname
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../Horde/Horde_Block_Account_Base.html#methodgetFullname">Horde_Block_Account_Base::getFullname()</a></dt>
<dd>Returns the user's full name.</dd>
</dl>
</div>
<a name="methodgetHome" id="getHome"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">getHome</span> (line <span class="line-number">99</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the user's home (login) directory.</p>
<ul class="tags">
<li><span class="field">return:</span> The user's directory.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
getHome
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../Horde/Horde_Block_Account_Base.html#methodgetHome">Horde_Block_Account_Base::getHome()</a></dt>
<dd>Returns the user's home (login) directory.</dd>
</dl>
</div>
<a name="methodgetShell" id="getShell"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">getShell</span> (line <span class="line-number">109</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the user's default shell.</p>
<ul class="tags">
<li><span class="field">return:</span> The user's shell.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
getShell
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../Horde/Horde_Block_Account_Base.html#methodgetShell">Horde_Block_Account_Base::getShell()</a></dt>
<dd>Returns the user's default shell.</dd>
</dl>
</div>
<a name="method_get" id="_get"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">_get</span> (line <span class="line-number">78</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns some user detail.</p>
<ul class="tags">
<li><span class="field">return:</span> The user's detail.</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
_get
</span>
(<span class="var-type">string</span> <span class="var-name">$what</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$what</span><span class="var-description">: Which information to return.</span> </li>
</ul>
</div>
<a name="method_getAccount" id="_getAccount"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">_getAccount</span> (line <span class="line-number">57</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the user account.</p>
<ul class="tags">
<li><span class="field">return:</span> A hash with complete account details.</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
_getAccount
</span>
()
</div>
</div>
<a name="method_parseAccount" id="_parseAccount"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">_parseAccount</span> (line <span class="line-number">36</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a hash with parsed account information.</p>
<ul class="tags">
<li><span class="field">return:</span> A hash with account details parsed from output</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
_parseAccount
</span>
(<span class="var-type">array</span> <span class="var-name">$output</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$output</span><span class="var-description">: Array of finger output strings</span> </li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../Horde/Horde_Block_Account_Base.html">Horde_Block_Account_Base</a></span></p>
<blockquote>
<img src="../media/images/Constructor.png" alt=" "/>
<span class="method-name"><a href="../Horde/Horde_Block_Account_Base.html#method__construct">Horde_Block_Account_Base::__construct()</a></span><br>
<img src="../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../Horde/Horde_Block_Account_Base.html#methodcheckPasswordStatus">Horde_Block_Account_Base::checkPasswordStatus()</a></span><br>
<img src="../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../Horde/Horde_Block_Account_Base.html#methodgetFullname">Horde_Block_Account_Base::getFullname()</a></span><br>
<img src="../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../Horde/Horde_Block_Account_Base.html#methodgetHome">Horde_Block_Account_Base::getHome()</a></span><br>
<img src="../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../Horde/Horde_Block_Account_Base.html#methodgetPasswordChange">Horde_Block_Account_Base::getPasswordChange()</a></span><br>
<img src="../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../Horde/Horde_Block_Account_Base.html#methodgetQuota">Horde_Block_Account_Base::getQuota()</a></span><br>
<img src="../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../Horde/Horde_Block_Account_Base.html#methodgetShell">Horde_Block_Account_Base::getShell()</a></span><br>
<img src="../media/images/Method.png" alt=" "/>
<span class="method-name"><a href="../Horde/Horde_Block_Account_Base.html#methodgetUsername">Horde_Block_Account_Base::getUsername()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 03 Jun 2012 02:25:34 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>