PHP 클래스 SettingsController, vanilla

상속: extends BackEndController
파일 보기 프로젝트 열기: vanilla/vanilla 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$Form Gdn_Form
$ModuleSortContainer string
$RequiredAdminPermissions List of permissions that should all have access to main dashboard.
$Uses Models to automatically instantiate.

공개 메소드들

메소드 설명
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 = '' )

보호된 메소드들

메소드 설명
_banFilter ( array $Ban ) Application management screen.
_nameSort ( $A, $B )

비공개 메소드들

메소드 설명
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.

메소드 상세

_banFilter() 보호된 메소드

Application management screen.
부터: 2.0.0
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.

_nameSort() 보호된 정적인 메소드

protected static _nameSort ( $A, $B )

addUpdateCheck() 공개 메소드

Currently added to the dashboard only. Nothing renders with this method. It is public so it can be added by plugins.
public addUpdateCheck ( )

analyticsTick() 공개 메소드

Handle the tracking of a page tick.
public analyticsTick ( )

applications() 공개 메소드

Application management screen.
부터: 2.0.0
public applications ( string $Filter = '', string $ApplicationName = '' )
$Filter string 'enabled', 'disabled', or 'all' (default)
$ApplicationName string Unique ID of app to be modified.

avatars() 공개 메소드

Displays the current avatar and exposes the following config settings: Garden.Thumbnail.Size Garden.Profile.MaxWidth Garden.Profile.MaxHeight
public avatars ( )

banner() 공개 메소드

Banner management screen.
부터: 2.0.0
public banner ( )

bans() 공개 메소드

Manage user bans (add, edit, delete, list).
부터: 2.0.18
public bans ( string $Action = '', string $Search = '', integer $Page = '', integer $ID = '' )
$Action string Add, edit, delete, or none.
$Search string Term to filter ban list by.
$Page integer Page number.
$ID integer Ban ID we're editing or deleting.

cancelPreview() 공개 메소드

Closes theme preview.
부터: 2.0.0
public cancelPreview ( string $previewThemeFolder = '', string $transientKey = '' )
$previewThemeFolder string
$transientKey string

compareAddonName() 공개 정적인 메소드

Compare addon names for uasort.
또한 보기: self::SortAddons()
부터: 2.0.0
public static compareAddonName ( array $A, array $B ) : integer
$A array First addon data.
$B array Second addon data.
리턴 integer Result of strcasecmp.

configuration() 공개 메소드

public configuration ( )

defaultAvatar() 공개 메소드

Settings page for uploading, deleting and cropping the default avatar.
public defaultAvatar ( )

disableApplication() 공개 메소드

public disableApplication ( $addonName, $filter )

disableLocale() 공개 메소드

public disableLocale ( $addonName, $addonInfo )

disablePlugin() 공개 메소드

public disablePlugin ( $pluginName, $filter = 'all' )

email() 공개 메소드

Outgoing Email management screen.
부터: 2.0.0
public email ( )

emailImageUrl() 공개 메소드

Endpoint for retrieving current email image url.
public emailImageUrl ( )

emailPreview() 공개 메소드

Echoes out a test email with the colors and image in the post request.
public emailPreview ( )

emailStyles() 공개 메소드

Exposes config settings: Garden.EmailTemplate.BackgroundColor Garden.EmailTemplate.ButtonBackgroundColor Garden.EmailTemplate.ButtonTextColor Garden.EmailTemplate.Image Saves the image based on 2 config settings: Garden.EmailTemplate.ImageMaxWidth (default 400px) and Garden.EmailTemplate.ImageMaxHeight (default 300px)
public emailStyles ( )

emailTest() 공개 메소드

On postback, sends a test email to the addresses specified in the form.
public emailTest ( )

enableApplication() 공개 메소드

public enableApplication ( $addonName, $filter )

enableLocale() 공개 메소드

public enableLocale ( $addonName, $addonInfo )

enablePlugin() 공개 메소드

public enablePlugin ( $pluginName, $filter = 'all' )

getBanModel() 공개 메소드

Gets the ban model and instantiates it if it doesn't exist.
public getBanModel ( ) : BanModel
리턴 BanModel

getTestEmail() 공개 메소드

Sets up a new Gdn_Email object with a test email.
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.
리턴 Gdn_Email The email object with the test colors set.

gettingStarted() 공개 메소드

Prompts new admins how to get started using new install.
부터: 2.0.0
public gettingStarted ( )

home() 공개 메소드

public home ( )

homepage() 공개 메소드

Homepage management screen.
부터: 2.0.0
public homepage ( )

index() 공개 메소드

You can override this method with a method in your plugin named SettingsController_Index_Create. You can hook into it with methods named SettingsController_Index_Before and SettingsController_Index_After.
부터: 2.0.0
public index ( )

initialize() 공개 메소드

Highlight menu path. Automatically run on every use.
부터: 2.0.0
public initialize ( )

isUploadedDefaultAvatar() 공개 메소드

Test whether a path is a relative path to the proper uploads directory.
public isUploadedDefaultAvatar ( string $avatar ) : boolean
$avatar string The path to the avatar image to test (most often Garden.DefaultAvatar)
리턴 boolean Whether the avatar has been uploaded from the dashboard.

locales() 공개 메소드

Manage list of locales.
부터: 2.0.0
public locales ( string $Op = null, string $LocaleKey = null )
$Op string 'enable' or 'disable'
$LocaleKey string Unique ID of locale to be modified.

mobileThemeOptions() 공개 메소드

Manage options for a mobile theme.
부터: 2.0.0
public mobileThemeOptions ( )

mobileThemes() 공개 메소드

Mobile Themes management screen.
부터: 2.2.10.3
public mobileThemes ( string $ThemeName = '', string $TransientKey = '' )
$ThemeName string Unique ID.
$TransientKey string Security token.

plugins() 공개 메소드

Manage list of plugins.
부터: 2.0.0
public plugins ( string $Filter = '', string $PluginName = '' )
$Filter string 'enabled', 'disabled', or 'all' (default)
$PluginName string Unique ID of plugin to be modified.

previewTheme() 공개 메소드

Show a preview of a theme.
부터: 2.0.0
public previewTheme ( string $ThemeName = '', string $transientKey = '' )
$ThemeName string Unique ID.
$transientKey string

registration() 공개 메소드

Events: BeforeRegistrationUpdate
부터: 2.0.0
public registration ( string $RedirectUrl = '' )
$RedirectUrl string Where to send user after registration.

removeDefaultAvatar() 공개 메소드

Remove the default avatar from config & delete it.
부터: 2.0.0
public removeDefaultAvatar ( )

removeEmailImage() 공개 메소드

Remove the email image from config & delete it.
public removeEmailImage ( )

removeFavicon() 공개 메소드

Remove the logo from config & delete it.
부터: 2.1
public removeFavicon ( )

removeShareImage() 공개 메소드

Remove the share image from config & delete it.
부터: 2.1
public removeShareImage ( )

setEmailFormat() 공개 메소드

Manages the Garden.Email.Format setting.
public setEmailFormat ( $value )
$value Whether to send emails in plaintext.

sortAddons() 공개 정적인 메소드

Sort list of addons for display.
부터: 2.0.0
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).

testAddon() 공개 메소드

Test and addon to see if there are any fatal errors during install.
부터: 2.0.0
public testAddon ( string $AddonType = '', string $AddonName = '', string $TransientKey = '' )
$AddonType string
$AddonName string
$TransientKey string Security token.

themeInfo() 공개 메소드

public themeInfo ( $themeName )

themeOptions() 공개 메소드

Manage options for a theme.
부터: 2.0.0
public themeOptions ( )

themes() 공개 메소드

Themes management screen.
부터: 2.0.0
public themes ( string $ThemeName = '', string $TransientKey = '' )
$ThemeName string Unique ID.
$TransientKey string Security token.

tutorials() 공개 메소드

public tutorials ( string $Tutorial = '' )
$Tutorial string

프로퍼티 상세

$Form 공개적으로 프로퍼티

public Gdn_Form $Form
리턴 Gdn_Form

$ModuleSortContainer 공개적으로 프로퍼티

public string $ModuleSortContainer
리턴 string

$RequiredAdminPermissions 공개적으로 프로퍼티

List of permissions that should all have access to main dashboard.
public $RequiredAdminPermissions

$Uses 공개적으로 프로퍼티

Models to automatically instantiate.
public $Uses