From da6eecd03111660ae12221265986ba4b10b155dd Mon Sep 17 00:00:00 2001 From: Klaus Weidenbach Date: Wed, 4 Mar 2015 10:15:16 +0100 Subject: remove Doxygen API Documentation from repository. This removes around 14MB and can get easily generate locally by doxygen util/Doxyfile when needed. Restructured .gitignore a bit and some additions like zotshrc, etc. Fixed a typo in doc/main.bb --- doc/html/permissions_8php.html | 353 ----------------------------------------- 1 file changed, 353 deletions(-) delete mode 100644 doc/html/permissions_8php.html (limited to 'doc/html/permissions_8php.html') diff --git a/doc/html/permissions_8php.html b/doc/html/permissions_8php.html deleted file mode 100644 index 5e01b9c5b..000000000 --- a/doc/html/permissions_8php.html +++ /dev/null @@ -1,353 +0,0 @@ - - - - - - -The Red Matrix: include/permissions.php File Reference - - - - - - - - - - - - - -
-
- - - - - - - -
-
The Red Matrix -
-
-
- - - - - -
-
- -
-
-
- -
- - - - -
- -
- -
-
-Functions
-
-
permissions.php File Reference
-
-
- - - - - - - - - - - - - - - - - - - - -

-Functions

 get_perms ()
 Return an array with all available permissions. More...
 
 get_all_perms ($uid, $observer_xchan, $internal_use=true)
 
 perm_is_allowed ($uid, $observer_xchan, $permission)
 Checks if given permission is allowed for given observer on a channel. More...
 
 check_list_permissions ($uid, $arr, $perm)
 
 site_default_perms ()
 Sets site wide default permissions. More...
 
 get_role_perms ($role)
 
 get_roles ()
 Returns a list or roles, grouped by type. More...
 
-

Function Documentation

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
check_list_permissions ( $uid,
 $arr,
 $perm 
)
-
- -

Referenced by collect_recipients(), and file_activity().

- -
-
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
get_all_perms ( $uid,
 $observer_xchan,
 $internal_use = true 
)
-
-

get_all_perms($uid,$observer_xchan)

-
Parameters
- - - - -
int$uidThe channel_id associated with the resource owner
string$observer_xchanThe xchan_hash representing the observer
bool$internal_use(default true)
-
-
-
Returns
array of all permissions, key is permission name, value is true or false
- -

Referenced by achievements_content(), blocks_content(), change_channel(), channel_content(), connedit_content(), editlayout_content(), editwebpage_content(), filestorage_content(), layouts_content(), like_content(), page_init(), webpages_content(), zfinger_init(), and zot_refresh().

- -
-
- -
-
- - - - - - - -
get_perms ()
-
- -

Return an array with all available permissions.

-

These are channel specific permissions. The list of available permissions can get manipulated by the hook global_permissions.

-
Returns
array associative array containing all permissions
- -

Referenced by connedit_content(), create_identity(), get_all_perms(), mail_post(), new_contact(), perm_is_allowed(), settings_post(), site_default_perms(), and zot_refresh().

- -
-
- -
-
- - - - - - - - -
get_role_perms ( $role)
-
-

get_role_perms($role)

-
Parameters
- - -
string$roleGiven a string for the channel role ('social','forum', etc) return an array of all permission fields pre-filled for this role. This includes the channel permission scope indicators (anything beginning with 'channel_') as well as perms_auto: true or false to create auto-permissions for this channel perms_follow: The permissions to apply when initiating a connection request to another channel perms_accept: The permissions to apply when accepting a connection request from another channel (not automatic) default_collection: true or false to make the default ACL include the channel's default collection directory_publish: true or false to publish this channel in the directory Any attributes may be extended (new roles defined) and modified (specific permissions altered) by plugins
-
-
- -

Referenced by connedit_content(), create_identity(), diaspora_request(), foofoo(), new_contact(), settings_post(), and zot_refresh().

- -
-
- -
-
- - - - - - - -
get_roles ()
-
- -

Returns a list or roles, grouped by type.

-
Parameters
- - -
string$currentThe current role
-
-
-
Returns
string Returns an array of roles, grouped by type
- -

Referenced by new_channel_content().

- -
-
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
perm_is_allowed ( $uid,
 $observer_xchan,
 $permission 
)
-
- -

Checks if given permission is allowed for given observer on a channel.

-

Checks if the given observer with the hash $observer_xchan has permission $permission on channel_id $uid. $permission is one defined in get_perms();

-
Parameters
- - - - -
int$uidThe channel_id associated with the resource owner
string$observer_xchanThe xchan_hash representing the observer
string$permission
-
-
-
Returns
bool true if permission is allowed for observer on channel
- -

Referenced by acl_init(), Conversation\add_thread(), advanced_profile(), api_statuses_home_timeline(), api_statuses_repeat(), attach_by_hash(), attach_by_hash_nodata(), attach_count_files(), attach_list_files(), attach_mkdir(), attach_store(), block_content(), chat_content(), chatsvc_init(), check_list_permissions(), common_content(), common_friends_visitor_widget(), contact_block(), RedMatrix\RedDAV\RedDirectory\createDirectory(), RedMatrix\RedDAV\RedDirectory\createFile(), RedMatrix\RedDAV\RedFile\delete(), diaspora_asphoto(), diaspora_comment(), diaspora_conversation(), diaspora_like(), diaspora_photo(), diaspora_post(), diaspora_reshare(), display_content(), editblock_content(), editlayout_content(), editwebpage_content(), get_feed_for(), RedMatrix\RedDAV\RedDirectory\getChild(), RedMatrix\RedDAV\RedDirectory\getChildren(), item_post(), like_content(), local_dir_update(), p_init(), photo_init(), photo_upload(), photos_album_widget(), photos_albums_list(), photos_content(), photos_list_photos(), photos_post(), poco(), post_activity_item(), post_post(), process_delivery(), process_mail_delivery(), profile_content(), profile_load(), profile_sidebar(), RedChannelList(), search_content(), Conversation\set_mode(), RedMatrix\RedDAV\RedBrowser\set_writeable(), RedMatrix\RedDAV\RedFile\setName(), RedMatrix\RedDAV\RedDirectory\setName(), subthread_content(), tag_deliver(), tagadelic(), tgroup_check(), update_birthdays(), viewconnections_content(), widget_archive(), widget_catcloud_wall(), widget_categories(), widget_item(), widget_photo_albums(), widget_tagcloud_wall(), z_readdir(), and zot_feed().

- -
-
- -
-
- - - - - - - -
site_default_perms ()
-
- -

Sets site wide default permissions.

-
Returns
array
- -

Referenced by create_identity().

- -
-
-
-
- -- cgit v1.2.3