Documentation

This is an automatically generated documentation for Documentation.

Namespaces

### \

Classes

Class	Description
`DBA`
`DbaTransaction`	Class to represent a database transaction.
`ZotOAuth1`
`ZotOAuth1DataStore`
`dba_driver`
`dba_pdo`

\Zotlabs\Access

Classes

Class	Description
`AccessList`
`PermissionLimits`
`PermissionRoles`
`Permissions`

\Zotlabs\ActivityStreams

Classes

Class	Description
`ASObject`
`Activity`
`Actor`
`AssertionMethod`
`Collection`
`CollectionPage`
`IntransitiveActivity`
`Link`
`OrderedCollection`
`OrderedCollectionPage`	According to the specification, OrderedCollectionPage extends both OrderedCollection and CollectionPage, but PHP is still a bit awkward when it comes to multiple inheritance. Rather than try and do this with traits, we'll just include the CollectionPage elements here - as this only consists of three properties.
`Place`
`Profile`
`PublicKey`
`Question`
`Relationship`
`Signature`
`Tombstone`
`UnhandledElementException`

\Zotlabs\Daemon

Classes

Class	Description
`Addon`
`Cache_embeds`
`Cache_query`
`Channel_purge`
`Checksites`
`Cli_suggest`
`Content_importer`
`Convo`
`Cron`
`Cron_daily`
`Cron_weekly`
`Cronhooks`
`CurlAuth`
`Deliver`
`Deliver_hooks`
`Delxitems`
`Directory`
`Expire`
`Externals`
`Fetchparents`
`File_importer`
`Gprobe`
`Importdoc`
`Importfile`
`Master`
`Notifier`
`Onedirsync`
`Onepoll`
`Poller`
`Queue`
`Thumbnail`
`Xchan_photo`
`Zotconvo`

\Zotlabs\Entity

Classes

Class	Description
`Account`
`Channel`
`Item`

\Zotlabs\Extend

Classes

Class	Description
`Hook`
`Route`
`Widget`

\Zotlabs\Identity

Classes

Class	Description
`BasicId`
`OAuth2Server`
`OAuth2Storage`
`ProfilePhoto`

\Zotlabs\Lib

Classes

Class	Description
`AConfig`
`ASCache`	A wrapper for the cache api
`ASCollection`	Class for dealing with fetching ActivityStreams collections (ordered or unordered, normal or paged).
`AbConfig`
`AccessList`
`Activity`
`ActivityStreams`
`Api_router`
`BaseObject`
`Cache`	cache api
`Chatroom`
`Config`
`Connect`
`Crypto`
`DB_Upgrade`	Upgrade the database schema if necessary.
`DReport`
`Enotify`
`ExtendedZip`	Description of ExtendedZip
`Hashpath`
`IConfig`
`Img_filesize`
`JSalmon`
`JcsEddsa2022`
`Keyutils`	Keyutils Convert RSA keys between various formats
`LDSignatures`
`Libsync`
`Libzot`
`Libzotdir`
`Mailer`	A class for sending emails.
`MarkdownSoap`
`MessageFilter`
`Multibase`
`PConfig`
`Permcat`
`PermissionDescription`	Encapsulates information the ACL dialog requires to describe permission settings for an item with an empty ACL.
`Queue`
`QueueWorker`
`SConfig`
`Share`
`SvgSanitizer`	SVGSantiizer
`System`
`Techlevels`
`Text`
`ThreadItem`	A thread item
`ThreadListener`
`ThreadStream`	A list of threads
`Verify`
`Webfinger`
`XConfig`
`ZotURL`
`Zotfinger`

\Zotlabs\Lib\Traits

Traits

Trait	Description
`HelpHelperTrait`

\Zotlabs\Module

Classes

Class	Description
`Achievements`	Base controller class for Modules.
`Acl`	Base controller class for Modules.
`Activity`	Base controller class for Modules.
`Admin`	Base controller class for Modules.
`Affinity`	Base controller class for Modules.
`Album`	Base controller class for Modules.
`Api`	Base controller class for Modules.
`Appman`	Base controller class for Modules.
`Apporder`	Base controller class for Modules.
`Apps`	Base controller class for Modules.
`Apschema`	Base controller class for Modules.
`Attach`	Base controller class for Modules.
`Attach_edit`	Base controller class for Modules.
`Authorize`	Base controller class for Modules.
`Authtest`	Base controller class for Modules.
`Block`	Base controller class for Modules.
`Blocks`	Base controller class for Modules.
`Bookmarks`	Base controller class for Modules.
`Branchtopic`	Base controller class for Modules.
`Cal`	Base controller class for Modules.
`Cdav`	Base controller class for Modules.
`Changeaddr`	Base controller class for Modules.
`Channel`	Base controller class for Modules.
`Channel_calendar`	Base controller class for Modules.
`Chanview`	Base controller class for Modules.
`Chat`	Base controller class for Modules.
`Chatsvc`	Base controller class for Modules.
`Cloud`	Base controller class for Modules.
`Cloud_tiles`	Base controller class for Modules.
`Common`	Base controller class for Modules.
`Connect`	Base controller class for Modules.
`Connections`	Base controller class for Modules.
`Connedit`	Base controller class for Modules.
`Contactedit`	Base controller class for Modules.
`Contactgroup`	Base controller class for Modules.
`Conversation`	Base controller class for Modules.
`Cover_photo`	Base controller class for Modules.
`Dav`	Base controller class for Modules.
`Defperms`	Base controller class for Modules.
`Dircensor`	Base controller class for Modules.
`Directory`	Base controller class for Modules.
`Dirsearch`	Base controller class for Modules.
`Display`	Base controller class for Modules.
`Dreport`	Base controller class for Modules.
`Editblock`	Base controller class for Modules.
`Editlayout`	Base controller class for Modules.
`Editpost`	Base controller class for Modules.
`Editwebpage`	Base controller class for Modules.
`Email_resend`	Base controller class for Modules.
`Email_validation`	Base controller class for Modules.
`Embed`	Base controller class for Modules.
`Embedphotos`	Base controller class for Modules.
`Emoji`	Base controller class for Modules.
`Event`	Base controller class for Modules.
`Fbrowser`	Base controller class for Modules.
`Feed`	Base controller class for Modules.
`Fhubloc_id_url`	Base controller class for Modules.
`Fhublocs`	Base controller class for Modules.
`File_upload`	Base controller class for Modules.
`Filer`	Base controller class for Modules.
`Filerm`	Base controller class for Modules.
`Filestorage`	Base controller class for Modules.
`Follow`	Base controller class for Modules.
`Getfile`	Base controller class for Modules.
`Go`	Base controller class for Modules.
`Group`	Base controller class for Modules.
`Hashtags`	Base controller class for Modules.
`Hcard`	Base controller class for Modules.
`Help`	You can create local site resources in doc/Site.md and either link to doc/Home.md for the standard resources or use our include mechanism to include it on your local page.
`Home`	Base controller class for Modules.
`Hostxrd`	Base controller class for Modules.
`Hq`	Base controller class for Modules.
`Id`	Base controller class for Modules.
`Impel`	Base controller class for Modules.
`Import`	Base controller class for Modules.
`Import_items`	Base controller class for Modules.
`Import_progress`	Base controller class for Modules.
`Invite`	module: invitexv2.php
`Item`	This is the POST destination for most all locally posted text stuff. This function handles status, wall-to-wall status, local comments, and remote coments that are posted on this site (as opposed to being delivered in a feed).
`Lang`	Base controller class for Modules.
`Layouts`	Base controller class for Modules.
`Like`	Base controller class for Modules.
`Linkinfo`	Base controller class for Modules.
`Lockview`	Base controller class for Modules.
`Locs`	Base controller class for Modules.
`Login`	Base controller class for Modules.
`Logout`	Base controller class for Modules.
`Lostpass`	Base controller class for Modules.
`Magic`	Base controller class for Modules.
`Manage`	Base controller class for Modules.
`Manifest`	Base controller class for Modules.
`Menu`	Base controller class for Modules.
`Mitem`	Base controller class for Modules.
`Moderate`	Base controller class for Modules.
`Network`	Base controller class for Modules.
`New_channel`	Base controller class for Modules.
`Notes`	Base controller class for Modules.
`Notifications`	Base controller class for Modules.
`Notify`	Base controller class for Modules.
`OAuth2TestVehicle`	The OAuth2TestVehicle class is a way to test the registration of an OAuth2 client app. It allows you to walk through the steps of registering a client, requesting an authorization code for that client, and then requesting an access token for use in authentication against the Hubzilla API endpoints.
`Oauth`	Base controller class for Modules.
`Oauth2`	Base controller class for Modules.
`Oauthinfo`	Base controller class for Modules.
`Ochannel`	Base controller class for Modules.
`Oembed`	Base controller class for Modules.
`Oep`	Base controller class for Modules.
`Oexchange`	Base controller class for Modules.
`Ofeed`	Base controller class for Modules.
`Online`	Base controller class for Modules.
`Outbox`	Base controller class for Modules.
`Owa`	OpenWebAuth verifier and token generator See spec/OpenWebAuth/Home.md Requests to this endpoint should be signed using HTTP Signatures using the 'Authorization: Signature' authentication method If the signature verifies a token is returned.
`Page`	Base controller class for Modules.
`Pconfig`	Base controller class for Modules.
`Pdledit`	Base controller class for Modules.
`Pdledit_gui`	Base controller class for Modules.
`Permcat`	Base controller class for Modules.
`Permcats`	Base controller class for Modules.
`Photo`	Base controller class for Modules.
`Photos`	Base controller class for Modules.
`Pin`	Base controller class for Modules.
`Poco`	Base controller class for Modules.
`Poster`	Base controller class for Modules.
`Pretheme`	Base controller class for Modules.
`Profile`	Base controller class for Modules.
`Profile_photo`	Base controller class for Modules.
`Profiles`	Base controller class for Modules.
`Profperm`	Base controller class for Modules.
`Pubsites`	Base controller class for Modules.
`Pubstream`	Base controller class for Modules.
`Randprof`	Base controller class for Modules.
`Rbmark`	remote bookmark
`React`	Base controller class for Modules.
`Regate`	Base controller class for Modules.
`Regdir`	With args, register a directory server for this realm.
`Register`	Base controller class for Modules.
`Regmod`	Base controller class for Modules.
`Regver`	Base controller class for Modules.
`Removeaccount`	Base controller class for Modules.
`Removeme`	Base controller class for Modules.
`Rmagic`	Base controller class for Modules.
`Rpost`	remote post
`Search`	Base controller class for Modules.
`Search_ac`	Base controller class for Modules.
`Service_limits`	Base controller class for Modules.
`Settings`	Base controller class for Modules.
`Share`	Base controller class for Modules.
`Sharedwithme`	Base controller class for Modules.
`Siteinfo`	Base controller class for Modules.
`Sitelist`	Base controller class for Modules.
`Smilies`	Base controller class for Modules.
`Snap`	Base controller class for Modules.
`Sources`	Base controller class for Modules.
`Sse`	Base controller class for Modules.
`Sse_bs`	Base controller class for Modules.
`Sslify`	Base controller class for Modules.
`Starred`	Base controller class for Modules.
`Subthread`	Base controller class for Modules.
`Suggest`	Base controller class for Modules.
`Tagger`	Base controller class for Modules.
`Tagrm`	Base controller class for Modules.
`Tasks`	Base controller class for Modules.
`Theme_info`	Base controller class for Modules.
`Thing`	Base controller class for Modules.
`Token`	Base controller class for Modules.
`Tokens`	Base controller class for Modules.
`Totp_check`	Base controller class for Modules.
`Uexport`	Base controller class for Modules.
`Update`	Base controller class for Modules.
`Userinfo`	Base controller class for Modules.
`View`	load view/theme/$current_theme/style.php with Hubzilla context
`Viewconnections`	Base controller class for Modules.
`Viewsrc`	Base controller class for Modules.
`Vote`	Base controller class for Modules.
`Wall_attach`	Base controller class for Modules.
`Wall_upload`	Base controller class for Modules.
`Webfinger`	Base controller class for Modules.
`Webpages`	Base controller class for Modules.
`Well_known`	Base controller class for Modules.
`Wfinger`	Base controller class for Modules.
`Xchan`	Base controller class for Modules.
`Xpoco`	Base controller class for Modules.
`Xrd`	Base controller class for Modules.
`Xref`	Base controller class for Modules.
`Z6trans`	Base controller class for Modules.
`Zot`	Base controller class for Modules.
`Zot_probe`	Base controller class for Modules.
`Zotfeed`	Base controller class for Modules.

\Zotlabs\Module\Admin

Classes

Class	Description
`Account_edit`
`Accounts`
`Addons`
`Channels`
`Dbsync`
`Features`
`Logs`
`Profs`
`Queue`
`Queueworker`	Base controller class for Modules.
`Security`
`Site`

\Zotlabs\Module\Settings

Classes

Class	Description
`Account`
`Calendar`
`Channel`
`Channel_home`
`Connections`
`Conversation`
`Directory`
`Display`
`Editor`
`Events`
`Featured`
`Features`
`Manage`
`Multifactor`
`Network`
`Photos`
`Privacy`
`Profiles`

\Zotlabs\Photo

Classes

Class	Description
`PhotoDriver`
`PhotoGd`
`PhotoImagick`

\Zotlabs\Render

Classes

Class	Description
`SimpleTemplate`
`SmartyInterface`
`SmartyTemplate`
`Theme`

Interfaces

Interface	Description
`TemplateEngine`

\Zotlabs\Storage

Classes

Class	Description
`BasicAuth`
`CalDAVClient`
`Directory`
`File`
`ZotOauth2Pdo`

\Zotlabs\Text

Classes

Class	Description
`Tagadelic`

\Zotlabs\Thumbs

Classes

Class	Description
`Epubthumb`	Thumbnail creation for epub files.
`Mp3audio`
`Pdf`
`Text`
`Video`

\Zotlabs\Update

Classes

Class	Description
`_1000`
`_1001`
`_1002`
`_1003`
`_1004`
`_1005`
`_1006`
`_1007`
`_1008`
`_1009`
`_1010`
`_1011`
`_1012`
`_1013`
`_1014`
`_1015`
`_1016`
`_1017`
`_1018`
`_1019`
`_1020`
`_1021`
`_1022`
`_1023`
`_1024`
`_1025`
`_1026`
`_1027`
`_1028`
`_1029`
`_1030`
`_1031`
`_1032`
`_1033`
`_1034`
`_1035`
`_1036`
`_1037`
`_1038`
`_1039`
`_1040`
`_1041`
`_1042`
`_1043`
`_1044`
`_1045`
`_1046`
`_1047`
`_1048`
`_1049`
`_1050`
`_1051`
`_1052`
`_1053`
`_1054`
`_1055`
`_1056`
`_1057`
`_1058`
`_1059`
`_1060`
`_1061`
`_1062`
`_1063`
`_1064`
`_1065`
`_1066`
`_1067`
`_1068`
`_1069`
`_1070`
`_1071`
`_1072`
`_1073`
`_1074`
`_1075`
`_1076`
`_1077`
`_1078`
`_1079`
`_1080`
`_1081`
`_1082`
`_1083`
`_1084`
`_1085`
`_1086`
`_1087`
`_1088`
`_1089`
`_1090`
`_1091`
`_1092`
`_1093`
`_1094`
`_1095`
`_1096`
`_1097`
`_1098`
`_1099`
`_1100`
`_1101`
`_1102`
`_1103`
`_1104`
`_1105`
`_1106`
`_1107`
`_1108`
`_1109`
`_1110`
`_1111`
`_1112`
`_1113`
`_1114`
`_1115`
`_1116`
`_1117`
`_1118`
`_1119`
`_1120`
`_1121`
`_1122`
`_1123`
`_1124`
`_1125`
`_1126`
`_1127`
`_1128`
`_1129`
`_1130`
`_1131`
`_1132`
`_1133`
`_1134`
`_1135`
`_1136`
`_1137`
`_1138`
`_1139`
`_1140`
`_1141`
`_1142`
`_1143`
`_1144`
`_1145`
`_1146`
`_1147`
`_1148`
`_1149`
`_1150`
`_1151`
`_1152`
`_1153`
`_1154`
`_1155`
`_1156`
`_1157`
`_1158`
`_1159`
`_1160`
`_1161`
`_1162`
`_1163`
`_1164`
`_1165`
`_1166`
`_1167`
`_1168`
`_1169`
`_1170`
`_1171`
`_1172`
`_1173`
`_1174`
`_1175`
`_1176`
`_1177`
`_1178`
`_1179`
`_1180`
`_1181`
`_1182`
`_1183`
`_1184`
`_1185`
`_1186`
`_1187`
`_1188`
`_1189`
`_1190`
`_1191`
`_1192`
`_1193`
`_1194`
`_1195`
`_1196`
`_1197`
`_1198`
`_1199`
`_1200`
`_1201`
`_1202`
`_1203`
`_1204`
`_1205`
`_1206`
`_1207`
`_1208`
`_1209`
`_1210`
`_1211`
`_1212`
`_1213`
`_1214`
`_1215`
`_1216`
`_1217`
`_1218`
`_1219`
`_1220`
`_1221`
`_1222`
`_1223`
`_1224`
`_1225`
`_1226`
`_1227`
`_1228`
`_1229`
`_1230`
`_1231`
`_1232`
`_1233`
`_1234`
`_1235`
`_1236`
`_1237`
`_1238`
`_1239`
`_1240`
`_1241`
`_1242`
`_1243`
`_1244`
`_1245`
`_1246`
`_1247`
`_1248`
`_1249`
`_1250`
`_1251`
`_1252`
`_1253`
`_1254`
`_1255`
`_1256`
`_1257`
`_1258`
`_1259`
`_1260`
`_1261`
`_1262`
`_1263`

\Zotlabs\Web

Classes

Class	Description
`Controller`	Base controller class for Modules.
`HTTPHeaders`
`HTTPSig`
`HttpMeta`
`Router`	We have already parsed the server path into App::$argc and App::$argv
`Session`
`SessionHandler`
`SessionRedis`
`SubModule`
`WebServer`

\Zotlabs\Widget

Classes

Class	Description
`Activity`
`Activity_filter`
`Activity_order`	* Name: Activity order * Description: Order the network stream by posted date, last commented or by date unthreaded * Requires: network
`Admin`
`Affinity`
`Album`
`Appcategories`
`Appcloud`
`Appstore`
`Archive`
`Bookmarkedchats`
`Catcloud`	* Name: Category cloud * Description: Display category links in a cloud * Requires: channel, cards, articles
`Catcloud_wall`
`Categories`
`Cdav`
`Channel_activities`
`Chatroom_list`
`Chatroom_members`
`Clock`
`Common_friends`
`Cover_photo`
`Design_tools`
`Dirsort`
`Dirtags`
`Filer`
`Findpeople`
`Follow`
`Forums`
`Fullprofile`
`Helpindex`
`Hq_controls`
`Item`
`Menu_preview`
`Messages`
`Newmember`
`Notes`
`Notifications`
`Permcats`
`Photo`
`Photo_albums`
`Photo_rand`
`Pinned`	* Name: Pinned items * Description: Display pinned items * Author: Max Kostikov * Requires: disabled_for_pdledit_gui
`Portfolio`
`Privacygroups`
`Profile`
`Pubtagcloud`
`Random_block`
`Rating`
`Savedsearch`
`Settings_menu`
`Sitesearch`
`Suggestedchats`
`Suggestions`
`Tagcloud`	* Name: Tag cloud * Description: Display hashtags of your network items in a cloud * Requires: network, hq
`Tagcloud_wall`
`Tasklist`
`Tokens`
`Vcard`
`Website_portation_tools`
`Zcard`

\Zotlabs\Zot6

Classes

Class	Description
`Receiver`
`Zot6Handler`

Interfaces

Interface	Description
`IHandler`

Automatically generated on 2025-03-19