mirror of
https://gitlab.com/davical-project/davical.git
synced 2026-10-18 07:35:05 +00:00
432 lines
16 KiB
HTML
432 lines
16 KiB
HTML
<?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 RSCDSUser</title>
|
|
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
|
</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"> RSCDSUser</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">A class for viewing and maintaining DAViCal User records</p>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_inc---RSCDSUser.php.html">/inc/RSCDSUser.php</a> (line <span class="field">24</span>)
|
|
</p>
|
|
|
|
|
|
<pre>User
|
|
|
|
|
--RSCDSUser</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> |
|
|
<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">RSCDSUser</span>
|
|
<a href="#RSCDSUser" title="details" class="method-name">RSCDSUser</a>
|
|
(<span class="var-type"></span> <span class="var-name">$id</span>, [<span class="var-type"></span> <span class="var-name">$prefix</span> = <span class="var-default">""</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">boolean</span>
|
|
<a href="#AllowedTo" title="details" class="method-name">AllowedTo</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$whatever</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">void</span>
|
|
<a href="#HandleAction" title="details" class="method-name">HandleAction</a>
|
|
(<span class="var-type"></span> <span class="var-name">$action</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">string</span>
|
|
<a href="#Render" title="details" class="method-name">Render</a>
|
|
([<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">""</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">string</span>
|
|
<a href="#RenderCollections" title="details" class="method-name">RenderCollections</a>
|
|
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">string</span>
|
|
<a href="#RenderImportIcs" title="details" class="method-name">RenderImportIcs</a>
|
|
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">string</span>
|
|
<a href="#RenderRelationshipsFrom" title="details" class="method-name">RenderRelationshipsFrom</a>
|
|
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">string</span>
|
|
<a href="#RenderRelationshipsTo" title="details" class="method-name">RenderRelationshipsTo</a>
|
|
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">boolean</span>
|
|
<a href="#Validate" title="details" class="method-name">Validate</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">void</span>
|
|
<a href="#Write" title="details" class="method-name">Write</a>
|
|
()
|
|
</div>
|
|
</div>
|
|
</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<A NAME='method_detail'></A>
|
|
<a name="methodRSCDSUser" id="RSCDSUser"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Constructor.png" />
|
|
<span class="method-title">Constructor RSCDSUser</span> (line <span class="line-number">30</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Constructor - nothing fancy as yet.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">RSCDSUser</span>
|
|
<span class="method-name">
|
|
RSCDSUser
|
|
</span>
|
|
(<span class="var-type"></span> <span class="var-name">$id</span>, [<span class="var-type"></span> <span class="var-name">$prefix</span> = <span class="var-default">""</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$id</span> </li>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$prefix</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodAllowedTo" id="AllowedTo"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">AllowedTo</span> (line <span class="line-number">279</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Extend parent definition of what the current user is allowed to do</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Whether they are allowed to.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
AllowedTo
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$whatever</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$whatever</span><span class="var-description">: What the user wants to do</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodHandleAction" id="HandleAction"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">HandleAction</span> (line <span class="line-number">302</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Handle any unusual actions we might invent</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
HandleAction
|
|
</span>
|
|
(<span class="var-type"></span> <span class="var-name">$action</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$action</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodRender" id="Render"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">Render</span> (line <span class="line-number">38</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Render the form / viewer as HTML to show the user</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> An HTML fragment to display in the page.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
Render
|
|
</span>
|
|
([<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">""</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$title</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodRenderCollections" id="RenderCollections"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">RenderCollections</span> (line <span class="line-number">232</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Render the user's collections</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> The string of html to be output</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
RenderCollections
|
|
</span>
|
|
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$ef</span> </li>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$title</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodRenderImportIcs" id="RenderImportIcs"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">RenderImportIcs</span> (line <span class="line-number">82</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Render input file to import ics in calendar user</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> The string of html to be output</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
RenderImportIcs
|
|
</span>
|
|
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$ef</span> </li>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$title</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodRenderRelationshipsFrom" id="RenderRelationshipsFrom"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">RenderRelationshipsFrom</span> (line <span class="line-number">104</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Render the user's relationships to other users & resources</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> The string of html to be output</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
RenderRelationshipsFrom
|
|
</span>
|
|
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$ef</span> </li>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$title</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodRenderRelationshipsTo" id="RenderRelationshipsTo"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">RenderRelationshipsTo</span> (line <span class="line-number">154</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Render the user's relationships to other users & resources</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> The string of html to be output</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
RenderRelationshipsTo
|
|
</span>
|
|
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$ef</span> </li>
|
|
<li>
|
|
<span class="var-type"></span>
|
|
<span class="var-name">$title</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodValidate" id="Validate"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">Validate</span> (line <span class="line-number">269</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Validate the information the user submitted</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Whether the form data validated OK.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
Validate
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodWrite" id="Write"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">Write</span> (line <span class="line-number">332</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Write the record to the file</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">void</span>
|
|
<span class="method-name">
|
|
Write
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Sat, 01 Nov 2008 23:07:45 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
|
</p>
|
|
</div></body>
|
|
</html>
|