X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=EVENTS.txt;h=ef4c2cffa4f5d15f458715615d67f8fb3f3c6b52;hb=ee9bfa715807cdd352407f3d01bc3126dc777b60;hp=bd511d75e1c6376830f2b2eb4526e7629be1e3da;hpb=60bf87bb34c4c0216fbbe42458d194e1e76c0aaa;p=quix0rs-gnu-social.git diff --git a/EVENTS.txt b/EVENTS.txt index bd511d75e1..ef4c2cffa4 100644 --- a/EVENTS.txt +++ b/EVENTS.txt @@ -1,3 +1,7 @@ +InitializePlugin: a chance to initialize a plugin in a complete environment + +CleanupPlugin: a chance to cleanup a plugin at the end of a program + StartPrimaryNav: Showing the primary nav menu - $action: the current action @@ -9,3 +13,213 @@ StartSecondaryNav: Showing the secondary nav menu EndSecondaryNav: At the end of the secondary nav menu - $action: the current action + +StartShowStyles: Showing Style links; good place to add UA style resets +- $action: the current action + +EndShowStyles: End showing Style links; good place to add custom styles +- $action: the current action + +StartShowLaconicaStyles: Showing Laconica Style links +- $action: the current action + +EndShowLaconicaStyles: End showing Laconica tyle links; good place to add handheld or JavaScript dependent styles +- $action: the current action + +StartShowUAStyles: Showing custom User-Agent style links +- $action: the current action + +EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles +- $action: the current action + +StartShowScripts: Showing JavaScript links +- $action: the current action + +EndShowScripts: End showing JavaScript links; good place to add custom + links like Google Analytics +- $action: the current action + +StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors) +- $action: the current action + +EndShowJQueryScripts: End showing JQuery script links +- $action: the current action + +StartShowLaconicaScripts: Showing Laconica script links (use this to link to a CDN or something) +- $action: the current action + +EndShowLaconicaScripts: End showing Laconica script links +- $action: the current action + +StartShowSections: Start the list of sections in the sidebar +- $action: the current action + +EndShowSections: End the list of sections in the sidebar +- $action: the current action + +StartShowHeader: Showing before the header container +- $action: the current action + +EndShowHeader: Showing after the header container +- $action: the current action + +StartShowFooter: Showing before the footer container +- $action: the current action + +EndShowFooter: Showing after the footer container +- $action: the current action + +StartShowContentBlock: Showing before the content container +- $action: the current action + +EndShowContentBlock: Showing after the content container +- $action: the current action + +StartNoticeSave: before inserting a notice (good place for content filters) +- $notice: notice being saved (no ID or URI) + +EndNoticeSave: after inserting a notice and related code +- $notice: notice that was saved (with ID and URI) + +StartShowLocalNavBlock: Showing the local nav menu +- $action: the current action + +EndShowLocalNavBlock: At the end of the local nav menu +- $action: the current action + +StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties +- $action: the current action + +EndShowHTML: Showing after the html element +- $action: the current action + +StartPublicGroupNav: Showing the public group nav menu +- $action: the current action + +EndPublicGroupNav: At the end of the public group nav menu +- $action: the current action + +StartSubGroupNav: Showing the subscriptions group nav menu +- $action: the current action + +EndSubGroupNav: At the end of the subscriptions group nav menu +- $action: the current action + +RouterInitialized: After the router instance has been initialized +- $m: the Net_URL_Mapper that has just been set up + +StartLogout: Before logging out +- $action: the logout action + +EndLogout: After logging out +- $action: the logout action + +ArgsInitialized: After the argument array has been initialized +- $args: associative array of arguments, can be modified + +StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location) +- $action: the current action + +EndAddressData: At the end of
+- $action: the current action + +StartLoginGroupNav: Before showing the login and register navigation menu +- $action: the current action + +EndLoginGroupNav: After showing the login and register navigation menu +- $action: the current action + +StartAccountSettingsNav: Before showing the account settings menu +- $action: the current action + +EndAccountSettingsNav: After showing the account settings menu +- $action: the current action + +Autoload: When trying to autoload a class +- $cls: the class being sought. A plugin might require_once the file for the class. + +SensitiveAction: determines if an action is 'sensitive' and should use SSL +- $action: name of the action, like 'login' +- $sensitive: flag for whether this is a sensitive action + +LoginAction: determines if an action is a 'login' action (OK for public view in private mode) +- $action: name of the action, like 'register' +- $login: flag for whether this is a login action + +StartShowHead: called before showing the element and children +- $action: action object being show + +EndShowHead: called after showing the element (and ) +- $action: action object being shown + +StartShowBody: called before showing the element and children +- $action: action object being shown + +EndShowBody: called after showing the element (and ) +- $action: action object being shown + +StartHeadChildren: called before showing the children of element (after tag) +- $action: action object being shown + +EndHeadChildren: called after showing the children of element (before ) +- $action: action object being shown + +StartPersonalGroupNav: beginning of personal group nav menu +- $action: action object being shown + +EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item) +- $action: action object being shown + +StartEndHTML: just before the tag +- $action: action object being shown + +EndEndHTML: just after the tag +- $action: action object being shown + +StartShowDesign: just before showing a site, user, or group design +- $action: action object being shown + +EndShowDesign: just after showing a site, user, or group design +- $action: action object being shown + +StartShowExportData: just before showing the
with export data (feeds) +- $action: action object being shown + +EndShowExportData: just after showing the
with export data (feeds) +- $action: action object being shown + +StartShowPageNotice: just before showing the page notice (instructions or error) +- $action: action object being shown + +EndShowPageNotice: just after showing the page notice (instructions or error) +- $action: action object being shown + +StartShowPageTitle: just before showing the main h1 title of a page (only for registration) +- $action: action object being shown + +StartProfileFormData: just before showing text entry fields on profile settings page +- $action: action object being shown + +EndProfileFormData: just after showing text entry fields on profile settings page +- $action: action object being shown + +StartProfileSaveForm: before starting to save a profile settings form +- $action: action object being shown + +EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!) +- $action: action object being shown + +StartRegistrationFormData: just before showing text entry fields on registration page +- $action: action object being shown + +EndRegistrationFormData: just after showing text entry fields on registration page +- $action: action object being shown + +StartRegistrationTry: before validating and saving a new user +- $action: action object being shown + +EndRegistrationTry: after saving a new user (note: no profile or user object!) +- $action: action object being shown + +StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes +- $qm: empty queue manager to set