Zikula: A Flexible Open Source Content Management System
home | forum | international support | contact us

Docs for page pnSecurity.php

Procedural File: pnSecurity.php

Source Location: /pnSecurity.php

Classes:



Page Details:

Zikula Application Framework



Tags:

version:  $Id: pnSecurity.php 24383 2008-06-12 14:15:02Z markwest $
copyright:  (c) 2001, Zikula Development Team
link:  http://www.zikula.org
license:  GNU/GPL







ACCESS_ADD [line 33]

ACCESS_ADD = 600



[ Top ]



ACCESS_ADMIN [line 35]

ACCESS_ADMIN = 800



[ Top ]



ACCESS_COMMENT [line 30]

ACCESS_COMMENT = 300



[ Top ]



ACCESS_DELETE [line 34]

ACCESS_DELETE = 700



[ Top ]



ACCESS_EDIT [line 32]

ACCESS_EDIT = 500



[ Top ]



ACCESS_INVALID [line 26]

ACCESS_INVALID = -1
Defines for access levels




[ Top ]



ACCESS_MODERATE [line 31]

ACCESS_MODERATE = 400



[ Top ]



ACCESS_NONE [line 27]

ACCESS_NONE = 0



[ Top ]



ACCESS_OVERVIEW [line 28]

ACCESS_OVERVIEW = 100



[ Top ]



ACCESS_READ [line 29]

ACCESS_READ = 200



[ Top ]




accesslevelname [line 41]

void accesslevelname( $level)

Translation functions - avoids globals in external code





Parameters

   $level  
[ Top ]



accesslevelnames [line 52]

array accesslevelnames( )

get access level names



Tags:

return:  of access names


[ Top ]



addinstanceschemainfo [line 74]

void addinstanceschemainfo( unknown_type $component, unknown_type $schema)

addinstanceschemainfo - register an instance schema with the security Will fail if an attempt is made to overwrite an existing schema





Parameters

unknown_type   $component  
unknown_type   $schema  
[ Top ]



authorised [line 107]

bool authorised( unknown_type $testrealm, unknown_type $testcomponent, unknown_type $testinstance, unknown_type $testlevel)

Enter description here...



Tags:

see:  SecurityUtil::checkPermission()
deprecated:  


Parameters

unknown_type   $testrealm  
unknown_type   $testcomponent  
unknown_type   $testinstance  
unknown_type   $testlevel  
[ Top ]



pnSecAddSchema [line 86]

bool pnSecAddSchema( unknown_type $component, unknown_type $schema)

add security schema





Parameters

unknown_type   $component  
unknown_type   $schema  
[ Top ]



pnSecAuthAction [line 124]

bool pnSecAuthAction( realm $testrealm, component $testcomponent, instance $testinstance, level $testlevel, [ $testuser = null])

see if a user is authorised to carry out a particular task



Tags:

return:  true if authorised, false if not
see:  SecurityUtil::checkPermission()
deprecated:  


Parameters

realm   $testrealm   the realm under test
component   $testcomponent   the component under test
instance   $testinstance   the instance under test
level   $testlevel   the level of access required
   $testuser  
[ Top ]



pnSecConfirmAuthKey [line 197]

bool pnSecConfirmAuthKey( )

confirm an authorisation key is valid

See description of

for information on this function




Tags:

return:  true if the key is valid, false if it is not
see:  SecurityUtil::confirmAuthKey()


[ Top ]



pnSecGenAuthKey [line 180]

string pnSecGenAuthKey( [ $modname = ''], modname $)

generate an authorisation key

The authorisation key is used to confirm that actions requested by a particular user have followed the correct path. Any stage that an action could be made (e.g. a form or a 'delete' button) this function must be called and the resultant string passed to the client as either a GET or POST variable. When the action then takes place it first calls

to ensure that the operation has indeed been manually requested by the user and that the key is valid




Tags:

return:  an encrypted key for use in authorisation of operations
see:  SecurityUtil::generateAuthKey


Parameters

modname   $   the module this authorisation key is for (optional)
   $modname  
[ Top ]



pnSecGetAuthInfo [line 139]

array pnSecGetAuthInfo( [ $testuser = null])

get authorisation information for this user



Tags:

return:  two element array of user and group permissions
see:  SecurityUtil::getAuthInfo()
deprecated:  


Parameters

   $testuser  
[ Top ]



pnSecGetLevel [line 157]

int pnSecGetLevel( $perms, $testrealm, $testcomponent, $testinstance, testinstance $)

calculate security level for a test item



Tags:

return:  matching security level
see:  SecurityUtil::getSecurityLevel
deprecated:  


Parameters

testinstance   $   instance of item under test
   $perms  
   $testrealm  
   $testcomponent  
   $testinstance  
[ Top ]


Packages:

Files:

Classes: