| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173 |
- <?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>File Source for access.php</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- </head>
- <body>
-
<h1>Source for file access.php</h1>
- <p>Documentation is available at <a href="../sloodle/_db---access.php.html">access.php</a></p>
- <div class="src-code">
- <div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
- <li><div class="src-line"><a name="a2"></a> </div></li>
- <li><div class="src-line"><a name="a3"></a><span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a4"></a><span class="src-doc">* Moodle capability definitions for the Sloodle module.</span></div></li>
- <li><div class="src-line"><a name="a5"></a><span class="src-doc">*</span></div></li>
- <li><div class="src-line"><a name="a6"></a><span class="src-doc">* The capabilities are loaded into the database table when the module is</span></div></li>
- <li><div class="src-line"><a name="a7"></a><span class="src-doc">* installed or updated. Whenever the capability definitions are updated,</span></div></li>
- <li><div class="src-line"><a name="a8"></a><span class="src-doc">* the module version number should be bumped up.</span></div></li>
- <li><div class="src-line"><a name="a9"></a><span class="src-doc">*</span></div></li>
- <li><div class="src-line"><a name="a10"></a><span class="src-doc">* </span><span class="src-doc-coretag">@package</span><span class="src-doc"> sloodle</span></div></li>
- <li><div class="src-line"><a name="a11"></a><span class="src-doc">* </span><span class="src-doc-coretag">@copyright</span><span class="src-doc"> Copyright (c) 2008 Sloodle (various contributors)</span></div></li>
- <li><div class="src-line"><a name="a12"></a><span class="src-doc">* </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://www.gnu.org/licenses/gpl-3.0.html GNU GPL v3</span></div></li>
- <li><div class="src-line"><a name="a13"></a><span class="src-doc">* </span><span class="src-doc-coretag">@since</span><span class="src-doc"> Sloodle 0.3</span></div></li>
- <li><div class="src-line"><a name="a14"></a><span class="src-doc">*</span></div></li>
- <li><div class="src-line"><a name="a15"></a><span class="src-doc">* </span><span class="src-doc-tag">@contributor</span><span class="src-doc"> Peter R. Bloomfield</span></div></li>
- <li><div class="src-line"><a name="a16"></a><span class="src-doc">*</span></div></li>
- <li><div class="src-line"><a name="a17"></a><span class="src-doc">*/</span></div></li>
- <li><div class="src-line"><a name="a18"></a> </div></li>
- <li><div class="src-line"><a name="a19"></a><span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a20"></a><span class="src-comm">// The system has four possible values for a capability:</span></div></li>
- <li><div class="src-line"><a name="a21"></a><span class="src-comm">// CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT, and inherit (not set).</span></div></li>
- <li><div class="src-line"><a name="a22"></a><span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a23"></a><span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a24"></a><span class="src-comm">// CAPABILITY NAMING CONVENTION</span></div></li>
- <li><div class="src-line"><a name="a25"></a><span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a26"></a><span class="src-comm">// It is important that capability names are unique. The naming convention</span></div></li>
- <li><div class="src-line"><a name="a27"></a><span class="src-comm">// for capabilities that are specific to modules and blocks is as follows:</span></div></li>
- <li><div class="src-line"><a name="a28"></a><span class="src-comm">// [mod/block]/<component_name>:<capabilityname></span></div></li>
- <li><div class="src-line"><a name="a29"></a><span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a30"></a><span class="src-comm">// component_name should be the same as the directory name of the mod or block.</span></div></li>
- <li><div class="src-line"><a name="a31"></a><span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a32"></a><span class="src-comm">// Core moodle capabilities are defined thus:</span></div></li>
- <li><div class="src-line"><a name="a33"></a><span class="src-comm">// moodle/<capabilityclass>:<capabilityname></span></div></li>
- <li><div class="src-line"><a name="a34"></a><span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a35"></a><span class="src-comm">// Examples: mod/forum:viewpost</span></div></li>
- <li><div class="src-line"><a name="a36"></a><span class="src-comm">// block/recent_activity:view</span></div></li>
- <li><div class="src-line"><a name="a37"></a><span class="src-comm">// moodle/site:deleteuser</span></div></li>
- <li><div class="src-line"><a name="a38"></a><span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a39"></a><span class="src-comm">// The variable name for the capability definitions array follows the format</span></div></li>
- <li><div class="src-line"><a name="a40"></a><span class="src-comm">// $<componenttype>_<component_name>_capabilities</span></div></li>
- <li><div class="src-line"><a name="a41"></a><span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a42"></a><span class="src-comm">// For the core capabilities, the variable is $moodle_capabilities.</span></div></li>
- <li><div class="src-line"><a name="a43"></a> </div></li>
- <li><div class="src-line"><a name="a44"></a><span class="src-comm">// NOTE: many Sloodle components relate directly to Moodle components.</span></div></li>
- <li><div class="src-line"><a name="a45"></a><span class="src-comm">// In these cases, the standard capabilities for those components apply.</span></div></li>
- <li><div class="src-line"><a name="a46"></a><span class="src-comm">// For example, Sloodle module configuration is covered by the Moodle standard capability:</span></div></li>
- <li><div class="src-line"><a name="a47"></a><span class="src-comm">// moodle/course:manageactivities</span></div></li>
- <li><div class="src-line"><a name="a48"></a> </div></li>
- <li><div class="src-line"><a name="a49"></a><span class="src-comm">// Viewing and editing avatar details will be handled by the user profile capabilities.</span></div></li>
- <li><div class="src-line"><a name="a50"></a> </div></li>
- <li><div class="src-line"><a name="a51"></a> </div></li>
- <li><div class="src-line"><a name="a52"></a><span class="src-var">$mod_sloodle_capabilities </span>= <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a53"></a> </div></li>
- <li><div class="src-line"><a name="a54"></a> <span class="src-comm">// Considered a 'staff' member in SL</span></div></li>
- <li><div class="src-line"><a name="a55"></a> <span class="src-str">'mod/sloodle:staff' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a56"></a> <span class="src-str">'captype' </span>=> <span class="src-str">'write'</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a57"></a> <span class="src-str">'contextlevel' </span>=> <span class="src-id">CONTEXT_MODULE</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a58"></a> <span class="src-str">'legacy' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a59"></a> <span class="src-str">'teacher' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a60"></a> <span class="src-str">'editingteacher' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a61"></a> <span class="src-str">'admin' </span>=> <span class="src-id">CAP_ALLOW</span></div></li>
- <li><div class="src-line"><a name="a62"></a> <span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a63"></a> <span class="src-sym">)</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a64"></a> </div></li>
- <li><div class="src-line"><a name="a65"></a> <span class="src-comm">// Authorising objects to access Sloodle</span></div></li>
- <li><div class="src-line"><a name="a66"></a> <span class="src-str">'mod/sloodle:objectauth' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a67"></a> <span class="src-str">'riskbitmask' </span>=> <span class="src-id">RISK_CONFIG</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a68"></a> <span class="src-str">'captype' </span>=> <span class="src-str">'write'</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a69"></a> <span class="src-str">'contextlevel' </span>=> <span class="src-id">CONTEXT_MODULE</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a70"></a> <span class="src-str">'legacy' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a71"></a> <span class="src-str">'editingteacher' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a72"></a> <span class="src-str">'admin' </span>=> <span class="src-id">CAP_ALLOW</span></div></li>
- <li><div class="src-line"><a name="a73"></a> <span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a74"></a> <span class="src-sym">)</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a75"></a> </div></li>
- <li><div class="src-line"><a name="a76"></a> <span class="src-comm">// Authorising user objects to access user-specific parts of Sloodle (e.g. blogging)</span></div></li>
- <li><div class="src-line"><a name="a77"></a> <span class="src-str">'mod/sloodle:userobjectauth' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a78"></a> <span class="src-str">'captype' </span>=> <span class="src-str">'write'</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a79"></a> <span class="src-str">'contextlevel' </span>=> <span class="src-id">CONTEXT_MODULE</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a80"></a> <span class="src-str">'legacy' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a81"></a> <span class="src-str">'user' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a82"></a> <span class="src-str">'guest' </span>=> <span class="src-id">CAP_PREVENT</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a83"></a> <span class="src-str">'student' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a84"></a> <span class="src-str">'teacher' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a85"></a> <span class="src-str">'editingteacher' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a86"></a> <span class="src-str">'admin' </span>=> <span class="src-id">CAP_ALLOW</span></div></li>
- <li><div class="src-line"><a name="a87"></a> <span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a88"></a> <span class="src-sym">)</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a89"></a> </div></li>
- <li><div class="src-line"><a name="a90"></a> </div></li>
- <li><div class="src-line"><a name="a91"></a> <span class="src-comm">// Access and use classroom layout profiles</span></div></li>
- <li><div class="src-line"><a name="a92"></a> <span class="src-str">'mod/sloodle:uselayouts' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a93"></a> <span class="src-str">'captype' </span>=> <span class="src-str">'read'</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a94"></a> <span class="src-str">'contextlevel' </span>=> <span class="src-id">CONTEXT_MODULE</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a95"></a> <span class="src-str">'legacy' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a96"></a> <span class="src-str">'teacher' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a97"></a> <span class="src-str">'editingteacher' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a98"></a> <span class="src-str">'admin' </span>=> <span class="src-id">CAP_ALLOW</span></div></li>
- <li><div class="src-line"><a name="a99"></a> <span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a100"></a> <span class="src-sym">)</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a101"></a> </div></li>
- <li><div class="src-line"><a name="a102"></a> <span class="src-comm">// Edit and delete classroom layout profiles</span></div></li>
- <li><div class="src-line"><a name="a103"></a> <span class="src-str">'mod/sloodle:editlayouts' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a104"></a> <span class="src-str">'captype' </span>=> <span class="src-str">'write'</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a105"></a> <span class="src-str">'contextlevel' </span>=> <span class="src-id">CONTEXT_MODULE</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a106"></a> <span class="src-str">'legacy' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a107"></a> <span class="src-str">'editingteacher' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a108"></a> <span class="src-str">'admin' </span>=> <span class="src-id">CAP_ALLOW</span></div></li>
- <li><div class="src-line"><a name="a109"></a> <span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a110"></a> <span class="src-sym">)</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a111"></a> </div></li>
- <li><div class="src-line"><a name="a112"></a> </div></li>
- <li><div class="src-line"><a name="a113"></a> <span class="src-comm">// Register an avatar with their own account</span></div></li>
- <li><div class="src-line"><a name="a114"></a> <span class="src-str">'mod/sloodle:registeravatar' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a115"></a> <span class="src-str">'captype' </span>=> <span class="src-str">'write'</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a116"></a> <span class="src-str">'contextlevel' </span>=> <span class="src-id">CONTEXT_MODULE</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a117"></a> <span class="src-str">'legacy' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a118"></a> <span class="src-str">'user' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a119"></a> <span class="src-str">'guest' </span>=> <span class="src-id">CAP_PREVENT</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a120"></a> <span class="src-str">'student' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a121"></a> <span class="src-str">'teacher' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a122"></a> <span class="src-str">'editingteacher' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a123"></a> <span class="src-str">'admin' </span>=> <span class="src-id">CAP_ALLOW</span></div></li>
- <li><div class="src-line"><a name="a124"></a> <span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a125"></a> <span class="src-sym">)</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a126"></a> </div></li>
- <li><div class="src-line"><a name="a127"></a> <span class="src-comm">// Distribute objects to own avatar</span></div></li>
- <li><div class="src-line"><a name="a128"></a> <span class="src-str">'mod/sloodle:distributeself' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a129"></a> <span class="src-str">'captype' </span>=> <span class="src-str">'write'</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a130"></a> <span class="src-str">'contextlevel' </span>=> <span class="src-id">CONTEXT_MODULE</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a131"></a> <span class="src-str">'legacy' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a132"></a> <span class="src-str">'guest' </span>=> <span class="src-id">CAP_PREVENT</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a133"></a> <span class="src-str">'student' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a134"></a> <span class="src-str">'teacher' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a135"></a> <span class="src-str">'editingteacher' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a136"></a> <span class="src-str">'admin' </span>=> <span class="src-id">CAP_ALLOW</span></div></li>
- <li><div class="src-line"><a name="a137"></a> <span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a138"></a> <span class="src-sym">)</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a139"></a> </div></li>
- <li><div class="src-line"><a name="a140"></a> <span class="src-comm">// Distribute objects to other avatars</span></div></li>
- <li><div class="src-line"><a name="a141"></a> <span class="src-str">'mod/sloodle:distributeothers' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a142"></a> <span class="src-str">'riskbitmask' </span>=> <span class="src-id">RISK_SPAM</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a143"></a> <span class="src-str">'captype' </span>=> <span class="src-str">'write'</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a144"></a> <span class="src-str">'contextlevel' </span>=> <span class="src-id">CONTEXT_MODULE</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a145"></a> <span class="src-str">'legacy' </span>=> <span class="src-key">array</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a146"></a> <span class="src-str">'guest' </span>=> <span class="src-id">CAP_PREVENT</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a147"></a> <span class="src-str">'editingteacher' </span>=> <span class="src-id">CAP_ALLOW</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a148"></a> <span class="src-str">'admin' </span>=> <span class="src-id">CAP_ALLOW</span></div></li>
- <li><div class="src-line"><a name="a149"></a> <span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a150"></a> <span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a151"></a> </div></li>
- <li><div class="src-line"><a name="a152"></a><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a153"></a> </div></li>
- <li><div class="src-line"><a name="a154"></a><span class="src-php">?></span></div></li>
- </ol></div>
- </div>
- <p class="notes" id="credit">
- Documentation generated on Mon, 07 Jul 2008 12:32:10 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </body>
- </html>
|