You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
380 lines
12 KiB
380 lines
12 KiB
14 years ago
|
<?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 SecurityClass</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"> SecurityClass</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-var-summary">Vars</a> (<a href="#sec-vars">details</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="notes">
|
||
|
Located in <a class="field" href="_SecurityClass.inc.html">/SecurityClass.inc</a> (line <span class="field">16</span>)
|
||
|
</p>
|
||
|
|
||
|
|
||
|
<pre></pre>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<a name="sec-var-summary"></a>
|
||
|
<div class="info-box">
|
||
|
<div class="info-box-title">Variable Summary</span></div>
|
||
|
<div class="nav-bar">
|
||
|
<a href="#sec-description">Description</a> |
|
||
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
||
|
|
|
||
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||
|
|
||
|
</div>
|
||
|
<div class="info-box-body">
|
||
|
<div class="var-summary">
|
||
|
<div class="var-title">
|
||
|
<img src="../../media/images/StaticVariable.png" alt=" " />
|
||
|
static <span class="var-type">mixed</span>
|
||
|
<a href="#$SECURITY_CLASS_SECURITY_STREAM" title="details" class="var-name">$SECURITY_CLASS_SECURITY_STREAM</a>
|
||
|
</div>
|
||
|
</div>
|
||
|
</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-var-summary">Vars</a> (<a href="#sec-vars">details</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">SecurityClass</span>
|
||
|
<a href="#SecurityClass" title="details" class="method-name">SecurityClass</a>
|
||
|
()
|
||
|
</div>
|
||
|
|
||
|
<div class="method-definition">
|
||
|
<img src="../../media/images/Method.png" alt=" "/>
|
||
|
<span class="method-result">void</span>
|
||
|
<a href="#canIngestHere" title="details" class="method-name">canIngestHere</a>
|
||
|
(<span class="var-type"></span> <span class="var-name">$collection_pid</span>)
|
||
|
</div>
|
||
|
|
||
|
<div class="method-definition">
|
||
|
<img src="../../media/images/Method.png" alt=" "/>
|
||
|
<span class="method-result">void</span>
|
||
|
<a href="#createPersonalPolicy" title="details" class="method-name">createPersonalPolicy</a>
|
||
|
(<span class="var-type"></span> <span class="var-name">$user</span>)
|
||
|
</div>
|
||
|
|
||
|
<div class="method-definition">
|
||
|
<img src="../../media/images/Method.png" alt=" "/>
|
||
|
<span class="method-result">void</span>
|
||
|
<a href="#getAllowedUsersAndRoles" title="details" class="method-name">getAllowedUsersAndRoles</a>
|
||
|
(<span class="var-type"></span> <span class="var-name">$policyStream</span>)
|
||
|
</div>
|
||
|
|
||
|
<div class="method-definition">
|
||
|
<img src="../../media/images/Method.png" alt=" "/>
|
||
|
<span class="method-result">DOMDocument</span>
|
||
|
<a href="#set_allowed_users_and_roles" title="details" class="method-name">set_allowed_users_and_roles</a>
|
||
|
(<span class="var-type"></span> <span class="var-name">&$policy_stream</span>, <span class="var-type">array</span> <span class="var-name">$users_and_roles</span>, <span class="var-type">string</span> <span class="var-name">$policy_stream</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">
|
||
|
<a name="var$SECURITY_CLASS_SECURITY_STREAM" id="$SECURITY_CLASS_SECURITY_STREAM"><!-- --></A>
|
||
|
<div class="evenrow">
|
||
|
|
||
|
<div class="var-header">
|
||
|
<img src="../../media/images/StaticVariable.png" />
|
||
|
<span class="var-title">
|
||
|
static <span class="var-type">mixed</span>
|
||
|
<span class="var-name">$SECURITY_CLASS_SECURITY_STREAM</span>
|
||
|
= <span class="var-default"> 'POLICY'</span> (line <span class="line-number">17</span>)
|
||
|
</span>
|
||
|
</div>
|
||
|
|
||
|
<!-- ========== Info from phpDoc block ========= -->
|
||
|
<ul class="tags">
|
||
|
<li><span class="field">access:</span> public</li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</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-var-summary">Vars</a> (<a href="#sec-vars">details</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="methodSecurityClass" id="SecurityClass"><!-- --></a>
|
||
|
<div class="oddrow">
|
||
|
|
||
|
<div class="method-header">
|
||
|
<img src="../../media/images/Constructor.png" />
|
||
|
<span class="method-title">Constructor SecurityClass</span> (line <span class="line-number">18</span>)
|
||
|
</div>
|
||
|
|
||
|
<!-- ========== Info from phpDoc block ========= -->
|
||
|
|
||
|
<div class="method-signature">
|
||
|
<span class="method-result">SecurityClass</span>
|
||
|
<span class="method-name">
|
||
|
SecurityClass
|
||
|
</span>
|
||
|
()
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
</div>
|
||
|
<a name="methodcanIngestHere" id="canIngestHere"><!-- --></a>
|
||
|
<div class="evenrow">
|
||
|
|
||
|
<div class="method-header">
|
||
|
<img src="../../media/images/Method.png" />
|
||
|
<span class="method-title">canIngestHere</span> (line <span class="line-number">23</span>)
|
||
|
</div>
|
||
|
|
||
|
<!-- ========== Info from phpDoc block ========= -->
|
||
|
|
||
|
<div class="method-signature">
|
||
|
<span class="method-result">void</span>
|
||
|
<span class="method-name">
|
||
|
canIngestHere
|
||
|
</span>
|
||
|
(<span class="var-type"></span> <span class="var-name">$collection_pid</span>)
|
||
|
</div>
|
||
|
|
||
|
<ul class="parameters">
|
||
|
<li>
|
||
|
<span class="var-type"></span>
|
||
|
<span class="var-name">$collection_pid</span> </li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
</div>
|
||
|
<a name="methodcreatePersonalPolicy" id="createPersonalPolicy"><!-- --></a>
|
||
|
<div class="oddrow">
|
||
|
|
||
|
<div class="method-header">
|
||
|
<img src="../../media/images/Method.png" />
|
||
|
<span class="method-title">createPersonalPolicy</span> (line <span class="line-number">105</span>)
|
||
|
</div>
|
||
|
|
||
|
<!-- ========== Info from phpDoc block ========= -->
|
||
|
|
||
|
<div class="method-signature">
|
||
|
<span class="method-result">void</span>
|
||
|
<span class="method-name">
|
||
|
createPersonalPolicy
|
||
|
</span>
|
||
|
(<span class="var-type"></span> <span class="var-name">$user</span>)
|
||
|
</div>
|
||
|
|
||
|
<ul class="parameters">
|
||
|
<li>
|
||
|
<span class="var-type"></span>
|
||
|
<span class="var-name">$user</span> </li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
</div>
|
||
|
<a name="methodgetAllowedUsersAndRoles" id="getAllowedUsersAndRoles"><!-- --></a>
|
||
|
<div class="evenrow">
|
||
|
|
||
|
<div class="method-header">
|
||
|
<img src="../../media/images/Method.png" />
|
||
|
<span class="method-title">getAllowedUsersAndRoles</span> (line <span class="line-number">56</span>)
|
||
|
</div>
|
||
|
|
||
|
<!-- ========== Info from phpDoc block ========= -->
|
||
|
|
||
|
<div class="method-signature">
|
||
|
<span class="method-result">void</span>
|
||
|
<span class="method-name">
|
||
|
getAllowedUsersAndRoles
|
||
|
</span>
|
||
|
(<span class="var-type"></span> <span class="var-name">$policyStream</span>)
|
||
|
</div>
|
||
|
|
||
|
<ul class="parameters">
|
||
|
<li>
|
||
|
<span class="var-type"></span>
|
||
|
<span class="var-name">$policyStream</span> </li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
</div>
|
||
|
<a name="methodset_allowed_users_and_roles" id="set_allowed_users_and_roles"><!-- --></a>
|
||
|
<div class="oddrow">
|
||
|
|
||
|
<div class="method-header">
|
||
|
<img src="../../media/images/Method.png" />
|
||
|
<span class="method-title">set_allowed_users_and_roles</span> (line <span class="line-number">160</span>)
|
||
|
</div>
|
||
|
|
||
|
<!-- ========== Info from phpDoc block ========= -->
|
||
|
<p class="short-description">Add a list of allowed users and roles to the given policy stream and return it.</p>
|
||
|
|
||
|
<div class="method-signature">
|
||
|
<span class="method-result">DOMDocument</span>
|
||
|
<span class="method-name">
|
||
|
set_allowed_users_and_roles
|
||
|
</span>
|
||
|
(<span class="var-type"></span> <span class="var-name">&$policy_stream</span>, <span class="var-type">array</span> <span class="var-name">$users_and_roles</span>, <span class="var-type">string</span> <span class="var-name">$policy_stream</span>)
|
||
|
</div>
|
||
|
|
||
|
<ul class="parameters">
|
||
|
<li>
|
||
|
<span class="var-type">string</span>
|
||
|
<span class="var-name">$policy_stream</span> </li>
|
||
|
<li>
|
||
|
<span class="var-type">array</span>
|
||
|
<span class="var-name">$users_and_roles</span> </li>
|
||
|
<li>
|
||
|
<span class="var-type"></span>
|
||
|
<span class="var-name">&$policy_stream</span> </li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
</div>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
<p class="notes" id="credit">
|
||
|
Documentation generated on Thu, 14 Jul 2011 16:29:54 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
|
||
|
</p>
|
||
|
</div></body>
|
||
|
</html>
|