source: main/waeup.kofa/trunk/src/waeup/kofa/permissions.txt @ 8229

Last change on this file since 8229 was 7819, checked in by Henrik Bettermann, 13 years ago

KOFA -> Kofa

File size: 2.2 KB
Line 
1Kofa permissions and roles
2**************************
3
4Permissions and roles used in a Kofa portal.
5
6.. :doctest:
7.. :layer: waeup.kofa.testing.KofaUnitTestLayer
8
9Convenience functions
10=====================
11
12:mod:`waeup.kofa` offers some convenience functions to handle security
13roles.
14
15:func:`get_all_roles`
16---------------------
17
18Gives us all roles defined in Kofa. We get tuples of
19kind
20
21  ``(<ROLE-NAME>, <ROLE>)``
22
23where ``<ROLE-NAME>`` is the name under which a role was registered
24with the ZCA (a string) and ``<ROLE>`` is the real role object.
25
26    >>> from waeup.kofa.permissions import get_all_roles
27    >>> get_all_roles()
28    <generator object...at 0x...>
29
30    >>> sorted(list(get_all_roles()))
31    [(u'waeup.ACManager', <waeup.kofa.permissions.ACManager object at 0x...]
32
33:func:`get_waeup_roles`
34-----------------------
35
36Gives us all roles, except the Kofa specific roles. We can get a list
37with or without local roles:
38
39    >>> from waeup.kofa.permissions import get_waeup_roles
40    >>> len(list(get_waeup_roles()))
41    11
42
43    >>> len(list(get_waeup_roles(also_local=True)))
44    22
45
46
47:func:`get_waeup_role_names`
48----------------------------
49
50We can get all role names defined in Kofa (except 'local'
51roles that are meant not to be assigned globally):
52
53    >>> from waeup.kofa.permissions import get_waeup_role_names
54    >>> list(get_waeup_role_names())
55    [u'waeup.ACManager',
56     u'waeup.AcademicsOfficer',
57     u'waeup.AccommodationOfficer',
58     u'waeup.Applicant',
59     u'waeup.ApplicationsOfficer',
60     u'waeup.PortalManager',
61     u'waeup.Student',
62     u'waeup.StudentsClearanceOfficer',
63     u'waeup.StudentsCourseAdviser',
64     u'waeup.StudentsManager',
65     u'waeup.StudentsOfficer']
66
67:func:`get_users_with_local_roles`
68----------------------------------
69
70We can get all users and their roles for a certain context
71object. This even works for objects that cannot have local roles as
72they are not stored in the ZODB:
73
74    >>> from waeup.kofa.permissions import get_users_with_local_roles
75    >>> mycontext = object()
76    >>> people_and_roles = get_users_with_local_roles(mycontext)
77    >>> people_and_roles
78    <generator object...at 0x...>
79
80In this case, the result is empty:
81
82    >>> people_and_roles = list(people_and_roles)
83    >>> people_and_roles
84    []
Note: See TracBrowser for help on using the repository browser.