Свойство | Type | Description | |
---|---|---|---|
$Form | Gdn_Form | ||
$ModuleSortContainer | string | ||
$RequiredAdminPermissions | List of permissions that should all have access to main dashboard. | ||
$Uses | Models to automatically instantiate. |
Méthode | Description | |
---|---|---|
addUpdateCheck ( ) | Adds information to the definition list that causes the app to "phone home" and see if there are upgrades available. | |
analyticsTick ( ) | Handle the tracking of a page tick. | |
applications ( string $Filter = '', string $ApplicationName = '' ) | Application management screen. | |
avatars ( ) | Settings page for managing avatar settings. | |
banner ( ) | Banner management screen. | |
bans ( string $Action = '', string $Search = '', integer $Page = '', integer $ID = '' ) | Manage user bans (add, edit, delete, list). | |
cancelPreview ( string $previewThemeFolder = '', string $transientKey = '' ) | Closes theme preview. | |
compareAddonName ( array $A, array $B ) : integer | Compare addon names for uasort. | |
configuration ( ) | ||
defaultAvatar ( ) | Settings page for uploading, deleting and cropping the default avatar. | |
disableApplication ( $addonName, $filter ) | ||
disableLocale ( $addonName, $addonInfo ) | ||
disablePlugin ( $pluginName, $filter = 'all' ) | ||
email ( ) | Outgoing Email management screen. | |
emailImageUrl ( ) | Endpoint for retrieving current email image url. | |
emailPreview ( ) | Echoes out a test email with the colors and image in the post request. | |
emailStyles ( ) | Settings page for HTML email styling. | |
emailTest ( ) | Form for sending a test email. | |
enableApplication ( $addonName, $filter ) | ||
enableLocale ( $addonName, $addonInfo ) | ||
enablePlugin ( $pluginName, $filter = 'all' ) | ||
getBanModel ( ) : BanModel | Gets the ban model and instantiates it if it doesn't exist. | |
getTestEmail ( string $image = '', string $textColor = '', string $backGroundColor = '', string $containerBackgroundColor = '', string $buttonTextColor = '', string $buttonBackgroundColor = '' ) : Gdn_Email | Sets up a new Gdn_Email object with a test email. | |
gettingStarted ( ) | Prompts new admins how to get started using new install. | |
home ( ) | ||
homepage ( ) | Homepage management screen. | |
index ( ) | Main dashboard. | |
initialize ( ) | Highlight menu path. Automatically run on every use. | |
isUploadedDefaultAvatar ( string $avatar ) : boolean | Test whether a path is a relative path to the proper uploads directory. | |
locales ( string $Op = null, string $LocaleKey = null ) | Manage list of locales. | |
mobileThemeOptions ( ) | Manage options for a mobile theme. | |
mobileThemes ( string $ThemeName = '', string $TransientKey = '' ) | Mobile Themes management screen. | |
plugins ( string $Filter = '', string $PluginName = '' ) | Manage list of plugins. | |
previewTheme ( string $ThemeName = '', string $transientKey = '' ) | Show a preview of a theme. | |
registration ( string $RedirectUrl = '' ) | Configuration of registration settings. | |
removeDefaultAvatar ( ) | Remove the default avatar from config & delete it. | |
removeEmailImage ( ) | Remove the email image from config & delete it. | |
removeFavicon ( ) | Remove the logo from config & delete it. | |
removeLogo ( ) | Remove the logo from config & delete it. | |
removeMobileLogo ( ) | Remove the mobile logo from config & delete it. | |
removeShareImage ( ) | Remove the share image from config & delete it. | |
setEmailFormat ( $value ) | Manages the Garden.Email.Format setting. | |
sortAddons ( array &$Array, boolean $Filter = true ) | Sort list of addons for display. | |
testAddon ( string $AddonType = '', string $AddonName = '', string $TransientKey = '' ) | Test and addon to see if there are any fatal errors during install. | |
themeInfo ( $themeName ) | ||
themeOptions ( ) | Manage options for a theme. | |
themes ( string $ThemeName = '', string $TransientKey = '' ) | Themes management screen. | |
tutorials ( string $Tutorial = '' ) |
Méthode | Description | |
---|---|---|
_banFilter ( array $Ban ) | Application management screen. | |
_nameSort ( $A, $B ) |
Méthode | Description | |
---|---|---|
deleteDefaultAvatars ( string $avatar = '' ) | Deletes uploaded default avatars. | |
handleAddonToggle ( $addonName, $addonInfo, $type, $isEnabled, $filter = '', $action = '' ) | ||
saveDefaultAvatars ( string $source, array $thumbOptions ) : boolean | Saves the default avatar to /uploads in three formats: The default image, which is not resized or cropped. | |
themeInfoToMediaItem ( string $themeKey, boolean $isCurrent = false ) : MediaItemModule | Compiles theme info data into a media module. |
protected _banFilter ( array $Ban ) | ||
$Ban | array | Data about the ban. Valid keys are BanType and BanValue. BanValue is what is to be banned. Valid values for BanType are email, ipaddress or name. |
public addUpdateCheck ( ) |
public applications ( string $Filter = '', string $ApplicationName = '' ) | ||
$Filter | string | 'enabled', 'disabled', or 'all' (default) |
$ApplicationName | string | Unique ID of app to be modified. |
public avatars ( ) |
public cancelPreview ( string $previewThemeFolder = '', string $transientKey = '' ) | ||
$previewThemeFolder | string | |
$transientKey | string |
public defaultAvatar ( ) |
public emailImageUrl ( ) |
public emailPreview ( ) |
public emailStyles ( ) |
public emailTest ( ) |
public getBanModel ( ) : BanModel | ||
Résultat | BanModel |
public getTestEmail ( string $image = '', string $textColor = '', string $backGroundColor = '', string $containerBackgroundColor = '', string $buttonTextColor = '', string $buttonBackgroundColor = '' ) : Gdn_Email | ||
$image | string | The img src of the previewed image |
$textColor | string | The hex color code of the text. |
$backGroundColor | string | The hex color code of the background color. |
$containerBackgroundColor | string | The hex color code of the container background color. |
$buttonTextColor | string | The hex color code of the link color. |
$buttonBackgroundColor | string | The hex color code of the button background. |
Résultat | Gdn_Email | The email object with the test colors set. |
public gettingStarted ( ) |
public index ( ) |
public initialize ( ) |
public isUploadedDefaultAvatar ( string $avatar ) : boolean | ||
$avatar | string | The path to the avatar image to test (most often Garden.DefaultAvatar) |
Résultat | boolean | Whether the avatar has been uploaded from the dashboard. |
public mobileThemeOptions ( ) |
public mobileThemes ( string $ThemeName = '', string $TransientKey = '' ) | ||
$ThemeName | string | Unique ID. |
$TransientKey | string | Security token. |
public previewTheme ( string $ThemeName = '', string $transientKey = '' ) | ||
$ThemeName | string | Unique ID. |
$transientKey | string |
public registration ( string $RedirectUrl = '' ) | ||
$RedirectUrl | string | Where to send user after registration. |
public removeDefaultAvatar ( ) |
public removeEmailImage ( ) |
public removeMobileLogo ( ) |
public setEmailFormat ( $value ) | ||
$value | Whether to send emails in plaintext. |
public static sortAddons ( array &$Array, boolean $Filter = true ) | ||
$Array | array | Addon data (e.g. $PluginInfo). |
$Filter | boolean | Whether to exclude hidden addons (defaults to TRUE). |
public $RequiredAdminPermissions |