mirror of
https://github.com/nicoverbruggen/phpmon.git
synced 2026-03-27 22:40:08 +01:00
Nico Verbruggen
e34ae1f5bb
- Preferences is now cleaner - Documented how to add new preference - Added preference to hide icons (for a pre-Tahoe look) - Updated .swiftlint for line_length
136 lines
4.7 KiB
Swift
136 lines
4.7 KiB
Swift
//
|
|
// PreferenceName.swift
|
|
// PHP Monitor
|
|
//
|
|
// Created by Nico Verbruggen on 07/09/2022.
|
|
// Copyright © 2025 Nico Verbruggen. All rights reserved.
|
|
//
|
|
|
|
/**
|
|
These are the keys used for every preference in the app.
|
|
To add a new key, undertake the following steps:
|
|
|
|
- Declare a new enum value with a string representation.
|
|
- Update the mapping below to specify if it's a boolean, string or other.
|
|
- Go to `Preferences` and update `handleFirstTimeLaunch` to set a default.
|
|
- Add the preference to `GeneralPreferencesVC` in the correct class.
|
|
*/
|
|
enum PreferenceName: String, Codable {
|
|
// GENERAL
|
|
case autoServiceRestartAfterExtensionToggle = "auto_restart_after_extension_toggle"
|
|
case autoComposerGlobalUpdateAfterSwitch = "auto_composer_global_update_after_switch"
|
|
case allowProtocolForIntegrations = "allow_protocol_for_integrations"
|
|
case globalHotkey = "global_hotkey"
|
|
case automaticBackgroundUpdateCheck = "backgroundUpdateCheck"
|
|
case showPhpDoctorSuggestions = "show_php_doctor_suggestions"
|
|
case languageOverride = "language_override"
|
|
|
|
// APPEARANCE
|
|
case shouldDisplayDynamicIcon = "use_dynamic_icon"
|
|
case iconTypeToDisplay = "icon_type_to_display"
|
|
case fullPhpVersionDynamicIcon = "full_php_in_menu_bar"
|
|
case hideIconsInMenu = "hide_icons_in_menu"
|
|
|
|
// WARNINGS
|
|
case warnAboutNonStandardTLD = "warn_about_non_standard_tld"
|
|
|
|
// NOTIFICATIONS
|
|
case notifyAboutVersionChange = "notify_about_version_change"
|
|
case notifyAboutPhpFpmRestart = "notify_about_php_fpm_restart"
|
|
case notifyAboutServices = "notify_about_services_restart"
|
|
case notifyAboutPresets = "notify_about_presets"
|
|
case notifyAboutSecureToggle = "notify_about_secure_toggle"
|
|
case notifyAboutGlobalComposerStatus = "notify_about_composer_status"
|
|
|
|
// MENU CUSTOMIZATION
|
|
case displayGlobalVersionSwitcher = "display_global_version_switcher"
|
|
case displayServicesManager = "display_services_manager"
|
|
case displayValetIntegration = "display_valet_integration"
|
|
case displayPhpConfigFinder = "display_php_config_finder"
|
|
case displayComposerToolkit = "display_composer_toolkit"
|
|
case displayLimitsWidget = "display_limits_widget"
|
|
case displayExtensions = "display_extensions"
|
|
case displayPresets = "display_presets"
|
|
case displayMisc = "display_misc"
|
|
case displayDriver = "display_driver"
|
|
|
|
/**
|
|
What type of data each preference contains.
|
|
*/
|
|
static var mapping: [PreferenceType: [PreferenceName]] = [
|
|
.boolean: [
|
|
// Preferences
|
|
.autoServiceRestartAfterExtensionToggle,
|
|
.autoComposerGlobalUpdateAfterSwitch,
|
|
.allowProtocolForIntegrations,
|
|
.automaticBackgroundUpdateCheck,
|
|
.showPhpDoctorSuggestions,
|
|
|
|
// Appearance
|
|
.shouldDisplayDynamicIcon,
|
|
.fullPhpVersionDynamicIcon,
|
|
.hideIconsInMenu,
|
|
|
|
// Notifications
|
|
.warnAboutNonStandardTLD,
|
|
.notifyAboutVersionChange,
|
|
.notifyAboutPhpFpmRestart,
|
|
.notifyAboutServices,
|
|
.notifyAboutPresets,
|
|
.notifyAboutSecureToggle,
|
|
.notifyAboutGlobalComposerStatus,
|
|
|
|
// UI Preferences
|
|
.displayGlobalVersionSwitcher,
|
|
.displayServicesManager,
|
|
.displayValetIntegration,
|
|
.displayPhpConfigFinder,
|
|
.displayComposerToolkit,
|
|
.displayLimitsWidget,
|
|
.displayExtensions,
|
|
.displayPresets,
|
|
.displayMisc,
|
|
.displayDriver
|
|
],
|
|
.string: [
|
|
.globalHotkey,
|
|
.iconTypeToDisplay,
|
|
.languageOverride
|
|
]
|
|
]
|
|
}
|
|
|
|
enum PreferenceType {
|
|
case boolean, string
|
|
}
|
|
|
|
/**
|
|
These are retired preferences that, if present, should be migrated.
|
|
*/
|
|
enum RetiredPreferenceName: String {
|
|
case shouldDisplayPhpHintInIcon = "add_php_to_icon"
|
|
}
|
|
|
|
/**
|
|
Persistent internal application state keys for UserDefaults.
|
|
These track internal app state and behavior that persists across launches,
|
|
but are not user preferences or statistics.
|
|
*/
|
|
enum PersistentAppState: String {
|
|
case wasLaunchedBefore = "launched_before"
|
|
case lastAutomaticUpdateCheck = "last_automatic_update_check"
|
|
case userFavorites = "user_favorites"
|
|
case updateCheckFailureCount = "update_check_failure_count"
|
|
case didPromptForIntegrations = "did_prompt_for_integrations"
|
|
}
|
|
|
|
/**
|
|
These are internal stats. They NEVER get shared.
|
|
*/
|
|
enum InternalStats: String {
|
|
case launchCount = "times_launched"
|
|
case switchCount = "times_switched_versions"
|
|
case didSeeSponsorEncouragement = "did_see_sponsor_encouragement"
|
|
case lastGlobalPhpVersion = "last_global_php_version"
|
|
}
|