Dereku/snappymail
1
0
Fork 0
mirror of https://github.com/the-djmaze/snappymail.git synced 2026-09-07 16:37:02 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add more info to plugins README

Browse source
This commit is contained in:
the-djmaze 2022-11-11 17:22:49 +01:00
parent 4e3a97a6f1
commit c929033388
2 changed files with 66 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

72
plugins/README.md
View file

@ -5,24 +5,82 @@ class Plugin extends \RainLoop\Plugins\AbstractPlugin
public function __construct(); public function __construct();
/** Returns static::NAME */ /** Returns static::NAME */
public function Name() : string; public function Name(): string;
/** Returns /README file contents or static::DESCRIPTION */ /** Returns /README file contents or static::DESCRIPTION */
public function Description() : string; public function Description(): string;
/** When $bLangs is boolean it sets the value, else returns current value */ /** When $bLangs is boolean it sets the value, else returns current value */
public function UseLangs(?bool $bLangs = null) : bool; public function UseLangs(?bool $bLangs = null): bool;
/** When true the result is empty string, else the error message */ /** When true the result is empty string, else the error message */
public function Supported() : string; public function Supported(): string;
/** Initialize settings */ /** Initialize settings */
public function Init() : void; public function Init(): void;
public function FilterAppDataPluginSection(bool $bAdmin, bool $bAuth, array &$aConfig) : void; public function FilterAppDataPluginSection(bool $bAdmin, bool $bAuth, array &$aConfig): void;
/** Returns array of all plugin Property options for use in Admin -> Extensions -> Plugin cog wheel */ /** Returns array of all plugin Property options for use in Admin -> Extensions -> Plugin cog wheel */
protected function configMapping() : array; protected function configMapping(): array;
/** With this function you hook to an event
* $sHookName see chapter "Hooks" below for available names
* $sFunctionName the name of a function in this class
*/
final protected function addHook(string $sHookName, string $sFunctionName): self;
final protected function addCss(string $sFile, bool $bAdminScope = false): self;
final protected function addJs(string $sFile, bool $bAdminScope = false): self;
final protected function addTemplate(string $sFile, bool $bAdminScope = false): self;
final protected function addJsonHook(string $sActionName, string $sFunctionName): self;
/**
* You may register your own service actions.
* Url is like /?{actionname}/etc.
* Predefined actions of \RainLoop\ServiceActions that can't be registered are:
* - admin
* - AdminAppData
* - AppData
* - Append
* - Backup
* - BadBrowser
* - CspReport
* - Css
* - Json
* - Lang
* - Mailto
* - NoCookie
* - NoScript
* - Ping
* - Plugins
* - ProxyExternal
* - Raw
* - Sso
* - Upload
* - UploadBackground
* - UploadContacts
*/
final protected function addPartHook(string $sActionName, string $sFunctionName): self
final public function Config(): \RainLoop\Config\Plugin;
final public function Manager(): \RainLoop\Plugins\Manager;
final public function Path(): string;
final public function ConfigMap(bool $flatten = false): array;
/**
* Returns result of Actions->DefaultResponse($sFunctionName, $mData) or json_encode($mData)
*/
final protected function jsonResponse(string $sFunctionName, $mData): mixed;
final public function jsonParam(string $sKey, $mDefault = null): mixed;
final public function getUserSettings(): array;
final public function saveUserSettings(array $aSettings): bool;
} }
``` ```

6
snappymail/v/0.0.0/app/libraries/RainLoop/Plugins/Manager.php
View file

@ -360,11 +360,7 @@ class Manager
{ {
foreach ($this->aAdditionalParts[$sActionName] as $mCallbak) foreach ($this->aAdditionalParts[$sActionName] as $mCallbak)
{ {
$bCallResult = $mCallbak(...$aParts); $bResult = !!$mCallbak(...$aParts) || $bResult;
if ($bCallResult && !$bResult)
{
$bResult = true;
}
} }
} }
} }