ApiHelpers - October CMS

Backend
- Behaviors
  - FormController
  - ImportExportController
  - ListController
    - HasOverrides
  - RelationController
  - FormController
  - ImportExportController
  - ListController
  - RelationController
  - ReorderController
  - UserPreferencesModel
- Classes
  - Dashboard
    - ReportData
    - ReportDataCacheHelper
    - ReportDataOrderRule
    - ReportDataPaginationParams
    - ReportDataQueryBuilder
    - ReportDateDataSet
    - ReportDimension
    - ReportDimensionField
    - ReportDimensionFilter
    - ReportFetchDataResult
    - ReportMetric
    - ReportMetricConfiguration
    - ReportPeriodCalculator
  - NavigationManager
    - HasNavigationContext
  - WidgetManager
    - HasFilterWidgets
    - HasFormWidgets
    - HasReportWidgets
  - AuthManager
  - BackendController
  - Controller
  - ControllerBehavior
  - DashboardManager
  - DashboardWidgetBase
  - FilterScope
  - FilterWidgetBase
  - FormField
  - FormTabs
  - FormWidgetBase
  - ListColumn
  - LoginCustomization
  - MainMenuItem
  - NavigationManager
  - ReportDataSourceBase
  - ReportDataSourceManager
  - ReportWidgetBase
  - RoleManager
  - RolePermission
  - SettingsController
  - SideMenuItem
  - Skin
  - StaticReportWidgetContainer
  - VueComponentBase
  - WidgetBase
  - WidgetManager
  - WildcardController
- Controllers
  - Index
    - DashboardHandler
    - HasVueDashboard
  - AccessLogs
  - Auth
  - AuthGates
  - Files
  - Index
  - Preferences
  - UserGroups
  - UserRoles
  - Users
- Database
  - Seeds
- Facades
- FilterWidgets
  - Date
  - Group
  - Number
  - Text
- FormWidgets
  - Repeater
    - HasJsonStore
    - HasRelationStore
  - TagList
    - HasRelationStore
    - HasStringStore
  - CodeEditor
  - ColorPicker
  - DataTable
  - DatePicker
  - FileUpload
  - MarkdownEditor
  - NestedForm
  - PaletteEditor
  - PermissionEditor
  - RecordFinder
  - Relation
  - Repeater
  - RichEditor
  - Sensitive
  - TagList
- Helpers
  - Backend
  - Inspector
- Models
  - BrandSetting
    - HasPalettes
  - ExportModel
    - EncodesCsv
    - EncodesJson
  - ImportModel
    - DecodesCsv
    - DecodesJson
  - AccessLog
  - BrandSetting
  - Dashboard
  - EditorSetting
  - ExportModel
  - ImportModel
  - Preference
  - ReportDataCache
  - User
  - UserGroup
  - UserPreference
  - UserPreferenceModel
  - UserRole
  - UserThrottle
- ReportWidgets
  - Welcome
- Skins
  - Standard
- Traits
- VueComponents
  - DropdownMenu
    - ItemDefinition
  - TreeView
    - NodeDefinition
    - SectionDefinition
    - SectionList
  - Autocomplete
  - CodeEditor
  - Dashboard
  - Document
  - DocumentMarkdownEditor
  - Dropdown
  - DropdownMenu
  - DropdownMenuButton
  - InfoTable
  - Inspector
  - LoadingIndicator
  - Modal
  - MonacoEditor
  - Popover
  - RichEditor
  - RichEditorDocumentConnector
  - ScrollablePanel
  - Splitter
  - Tabs
  - TreeView
  - Uploader
- Widgets
  - Filter
  - Form
  - Lists
  - Table
  - Filter
  - Form
  - Lists
  - ListStructure
  - ReportContainer
  - RoleImpersonator
  - Search
  - SiteSwitcher
  - Table
  - Toolbar
- ServiceProvider
Cms
- Classes
  - Controller
    - HasAjaxRequests
    - HasComponentHelpers
    - HasRenderers
    - HasThemeAssetMaker
  - EditorExtension
    - HasComponentListLoader
    - HasExtensionAssetsCrud
    - HasExtensionAssetsState
    - HasExtensionCrud
    - HasExtensionExtensibility
    - HasExtensionState
    - HasExtensionThemeCrud
    - HasExtensionThemesState
    - HasIntellisense
  - Layout
    - Fields
  - Page
    - Fields
  - Partial
    - Fields
  - Theme
    - HasCacheLayer
    - HasConfiguration
  - AjaxResponse
  - Asset
  - CmsCompoundObject
  - CmsController
  - CmsDemoTrafficDataGenerator
  - CmsException
  - CmsObject
  - CmsObjectCache
  - CmsObjectCollection
  - CmsReportDataSource
  - CmsStatusDataSource
  - CodeBase
  - CodeParser
  - ComponentBase
  - ComponentBehavior
  - ComponentHelpers
  - ComponentManager
  - ComponentModuleBase
  - ComponentPartial
  - Content
  - Controller
  - EditorExtension
  - Layout
  - LayoutCode
  - Meta
  - Page
  - PageCode
  - PageManager
  - Partial
  - PartialCode
  - PartialStack
  - PartialWatcher
  - Router
  - Snippet
  - SnippetManager
  - Theme
  - ThemeManager
  - ThisVariable
  - TrafficLogger
- Components
- Console
  - ThemeCache
  - ThemeCheck
  - ThemeClear
  - ThemeCopy
  - ThemeInstall
  - ThemeList
  - ThemeRemove
  - ThemeSeed
  - ThemeUse
- Controllers
- Database
  - Seeds
    - DatabaseSeeder
    - SeedDemoTrafficData
- Facades
  - Cms
- FormWidgets
  - PageFinder
- Helpers
  - Cms
    - HasSites
  - Cms
  - Component
  - File
- Models
- ReportWidgets
  - ActiveTheme
- Traits
- Twig
- VueComponents
- Widgets
  - PageLookup
  - SnippetLookup
- ServiceProvider
Editor
- Behaviors
  - StateManager
- Classes
- Controllers
  - Index
- Traits
  - FileSystemFunctions
- VueComponents
- ServiceProvider
Media
- Classes
  - MediaLibrary
  - MediaLibraryItem
- Controllers
  - Index
- FormWidgets
  - MediaFinder
- Helpers
  - MediaView
- Twig
  - Extension
- Widgets
  - MediaManager
- ServiceProvider
System
- Behaviors
  - SettingsModel
- Classes
  - PresetManager
    - Dates
    - Icons
    - Locales
  - SiteManager
    - HasActiveSite
    - HasEditSite
    - HasPreferredLanguage
    - HasSiteContext
  - UiManager
    - AjaxButton
    - Button
    - Callout
    - PopupButton
    - SearchInput
  - UpdateManager
    - HasGatewayAccess
    - ManagesApp
    - ManagesModules
    - ManagesPlugins
    - ManagesProject
    - ManagesThemes
  - AppBase
  - CombineAssets
  - DependencyResolver
  - DriverBehavior
  - ErrorHandler
  - MailManager
  - ManifestCache
  - MarkupExtensionItem
  - MarkupManager
  - ModelBehavior
  - PagerElement
  - PluginBase
  - PluginManager
  - PresetManager
  - ProductDetail
  - RateLimiter
  - ResizeImageItem
  - ResizeImages
  - SettingsManager
  - SettingsMenuItem
  - SiteManager
  - SystemController
  - SystemReportDataSource
  - UiElement
  - UiManager
  - UpdateManager
  - VersionManager
- Console
- Controllers
  - EventLogs
  - MailBrandSettings
  - MailLayouts
  - MailPartials
  - MailTemplates
  - Market
  - RequestLogs
  - Settings
  - SiteGroups
  - Sites
  - Updates
- Database
  - Seeds
- Facades
  - Manifest
  - System
  - Ui
- Helpers
  - Cache
  - DateTime
  - DateTimeHelper
  - LocaleHelper
  - Preset
  - System
  - View
- Middleware
  - ActiveSite
- Models
  - SettingModel
    - HasMultisite
  - SiteDefinition
    - HasModelAttributes
  - EventLog
  - File
  - LogSetting
  - MailBrandSetting
  - MailLayout
  - MailPartial
  - MailSetting
  - MailTemplate
  - Parameter
  - PluginVersion
  - RequestLog
  - Revision
  - SettingModel
  - SiteDefinition
  - SiteGroup
- ReportWidgets
  - Status
- Traits
- Twig
- Widgets
  - Changelog
  - Updater
- ServiceProvider
Tailor
- Behaviors
- Classes
  - Blueprint
    - EntryBlueprint
    - GlobalBlueprint
    - MixinBlueprint
    - SingleBlueprint
    - StreamBlueprint
    - StructureBlueprint
  - BlueprintIndexer
    - FieldsetIndex
    - GlobalIndex
    - MixinIndex
    - NavigationRegistry
    - PageManagerRegistry
    - PermissionRegistry
    - SectionIndex
  - EditorExtension
    - HasExtensionCrud
    - HasExtensionState
  - Relations
    - CustomFieldHasManyRelation
    - CustomFieldHasOneRelation
    - CustomMultiJoinRelation
    - CustomNestedJoinRelation
  - SchemaBuilder
    - HasCommonColumns
    - HasJoinTable
    - HasRepeaterTable
    - HasStreamColumns
    - HasStructureColumns
    - HasTablePatches
  - Scopes
    - DraftableScope
    - EntryRecordScope
    - GlobalRecordScope
    - VersionableScope
  - Blueprint
  - BlueprintCollection
  - BlueprintErrorData
  - BlueprintException
  - BlueprintIndexer
  - BlueprintModel
  - BlueprintVerifier
  - ComponentVariable
  - ContentFieldBase
  - EditorExtension
  - FieldManager
  - Fieldset
  - NavigationItem
  - PermissionItem
  - RecordIndexer
  - SchemaBuilder
  - SchemaPruner
- Components
- Console
- ContentFields
- Controllers
- Models
  - EntryRecord
  - GlobalRecord
    - HasGlobalBlueprint
  - RecordImport
    - HasGeneralBlueprint
  - ContentSchema
  - EntryRecord
  - GlobalRecord
  - NestedFormItem
  - PreviewToken
  - RecordExport
  - RecordImport
  - RepeaterItem
- Traits
- VueComponents
- ServiceProvider
Events
- backend
  - ajax
    - beforeRunHandler
  - brand
    - getPalettePresets
  - files
    - get
  - filter
  - form
  - list
  - menu
    - extendItems
  - page
    - beforeDisplay
  - roles
    - extendPermissions
  - site
    - getEditSite
    - setEditSite
  - user
    - login
- cms
  - ajax
    - beforeRunHandler
  - block
    - render
  - combiner
    - beforePrepare
    - getCacheKey
  - component
    - beforeRunAjaxHandler
    - runAjaxHandler
  - internalTrafficStatistics
    - isUserAuthenticated
  - object
    - listInTheme
  - page
  - pageLookup
    - listTypes
  - resizer
    - getCacheKey
  - router
    - beforeRoute
  - sitePicker
  - template
  - theme
  - extendTwig
- deferredBinding
- editor
  - extension
    - defineYamlSchemas
- exception
- halcyon
  - datasource
    - db
- mailer
- media
  - file
    - beforeUpload
    - delete
    - move
    - rename
    - upload
  - folder
    - create
    - delete
    - move
    - rename
- model
  - auth
    - afterImpersonate
    - beforeImpersonate
  - filter
    - filterScopes
  - form
    - filterFields
  - relation
    - /docs/api/model/relation/add
      - add
      - add
      - add
    - /docs/api/model/relation/associate
      - associate
      - associate
    - attach
    - /docs/api/model/relation/beforeadd
    - /docs/api/model/relation/beforeassociate
      - beforeAssociate
      - beforeAssociate
    - beforeAttach
    - beforeDetach
    - /docs/api/model/relation/beforedissociate
      - beforeDissociate
      - beforeDissociate
    - /docs/api/model/relation/beforeremove
    - detach
    - /docs/api/model/relation/dissociate
      - dissociate
      - dissociate
    - /docs/api/model/relation/remove
      - remove
      - remove
      - remove
  - /docs/api/model/afterboot
    - afterBoot
    - afterBoot
  - /docs/api/model/aftercreate
    - afterCreate
    - afterCreate
  - /docs/api/model/afterdelete
    - afterDelete
    - afterDelete
  - /docs/api/model/afterfetch
    - afterFetch
    - afterFetch
  - /docs/api/model/afterinit
    - afterInit
    - afterInit
  - afterRelation
  - afterRestore
  - /docs/api/model/aftersave
    - afterSave
    - afterSave
  - afterTrash
  - /docs/api/model/afterupdate
    - afterUpdate
    - afterUpdate
  - afterValidate
  - /docs/api/model/beforecreate
    - beforeCreate
    - beforeCreate
  - /docs/api/model/beforedelete
    - beforeDelete
    - beforeDelete
  - /docs/api/model/beforefetch
    - beforeFetch
    - beforeFetch
  - beforeGetAttribute
  - beforeRelation
  - beforeReplicate
  - beforeRestore
  - /docs/api/model/beforesave
    - beforeSave
    - beforeSave
  - beforeSetAttribute
  - /docs/api/model/beforeupdate
    - beforeUpdate
    - beforeUpdate
  - beforeValidate
  - extendBlueprint
  - getAttribute
  - newInstance
  - saveInternal
  - setAttribute
- pages
  - snippet
    - getPartialMapCacheKey
- site
  - changed
- system
  - assets
    - beforeAddAsset
    - /docs/api/system/assets/beforebundleasset
      - beforeBundleAsset
      - beforeBundleAsset
  - console
    - mirror
      - extendPaths
  - mail
    - applyConfigValues
    - getSendModeOptions
  - reportwidgets
    - extendItems
  - resizer
    - getAvailableSources
    - handleMissingImage
  - settings
    - extendItems
  - site
    - setActiveSite
    - setEditSite
  - updater
    - migrate
  - extendConfigFile
  - extendTwig
- tailor
  - getPreviewPageCacheKey
- user
  - validatePasswordPolicy
Library
- Argon
  - README
  - Argon
  - ArgonServiceProvider
- Assetic
  - Asset
    - Iterator
      - AssetCollectionFilterIterator
      - AssetCollectionIterator
    - AssetCache
    - AssetCollection
    - BaseAsset
    - FileAsset
    - GlobAsset
    - HttpAsset
    - StringAsset
  - Cache
    - ArrayCache
    - FilesystemCache
  - Exception
    - FilterException
  - Factory
    - Resource
    - AssetFactory
  - Filter
  - Traits
    - HasDeepHasher
  - Util
    - CssUtils
    - LessUtils
    - SassUtils
    - VarUtils
  - README
  - AsseticServiceProvider
  - AssetManager
  - AssetWriter
  - Combiner
  - FilterManager
- Auth
  - Concerns
  - Models
    - Group
    - Preferences
    - Role
    - Throttle
    - User
  - AuthException
  - Manager
- Combine
  - Combiner
  - CombinerServiceProvider
  - JavascriptMinify
  - JsCompile
  - LessCompile
  - ScssCompile
  - StylesheetMinify
- Composer
  - Concerns
  - Manager
- Config
  - README
  - FileLoader
  - Repository
- Database
  - Attach
    - File
    - FileException
  - Concerns
    - HasAttributes
    - HasEagerLoadAttachRelation
    - HasEvents
    - HasJsonable
    - HasNicerPagination
    - HasRelationships
    - HasReplication
  - Connections
    - Connection
    - MySqlConnection
    - PostgresConnection
    - SQLiteConnection
    - SqlServerConnection
  - Connectors
    - ConnectionFactory
  - Factories
    - Factory
    - HasFactory
  - Models
    - DeferredBinding
    - Revision
  - Relations
    - AttachMany
    - AttachOne
    - AttachOneOrMany
    - BelongsTo
    - BelongsToMany
    - DeferOneOrMany
    - DefinedConstraints
    - HasMany
    - HasManyThrough
    - HasOne
    - HasOneOrMany
    - HasOneThrough
    - MorphMany
    - MorphOne
    - MorphOneOrMany
    - MorphTo
    - MorphToMany
    - Relation
  - Schema
    - Blueprint
  - Scopes
    - MultisiteScope
    - NestedTreeScope
    - SortableScope
  - Traits
    - BaseIdentifier
    - Defaultable
    - DeferredBinding
    - Encryptable
    - Hashable
    - Multisite
    - NestedTree
    - Nullable
    - Purgeable
    - Revisionable
    - SimpleTree
    - Sluggable
    - SluggableTree
    - SoftDelete
    - Sortable
    - SortableRelation
    - UserFootprints
    - Validation
  - Updates
    - Migration
    - Seeder
  - README
  - Builder
  - Collection
  - DatabaseServiceProvider
  - Dongle
  - ExpandoModel
  - MigrationServiceProvider
  - Model
  - ModelBehavior
  - ModelException
  - MorphPivot
  - NestedTreeScope
  - Pivot
  - QueryBuilder
  - Replicator
  - SortableScope
  - TreeCollection
  - Updater
- Element
  - Filter
    - ScopeDefinition
  - Form
    - FieldDefinition
    - FieldsetDefinition
  - Lists
    - ColumnDefinition
  - Navigation
    - ItemDefinition
  - ElementBase
  - ElementHolder
- Events
  - Dispatcher
  - EventServiceProvider
  - FakeDispatcher
  - PriorityDispatcher
- Exception
  - AjaxException
  - ApplicationException
  - ErrorHandler
  - ExceptionBase
  - ForbiddenException
  - NotFoundException
  - SystemException
  - ValidationException
- Extension
  - README
  - Container
  - Extendable
  - ExtendableTrait
  - ExtensionBase
  - ExtensionTrait
- Filesystem
  - README
  - Definitions
  - Filesystem
  - FilesystemServiceProvider
  - Zip
- Flash
  - FlashBag
  - FlashServiceProvider
- Foundation
  - Bootstrap
  - Console
  - Exception
    - Handler
  - Http
    - Middleware
      - CheckForMaintenanceMode
      - EncryptCookies
    - Kernel
  - Providers
  - Application
- Halcyon
  - Concerns
    - HasEvents
  - Datasource
  - Exception
  - Processors
    - Processor
    - SectionParser
  - Traits
    - Validation
  - README
  - Builder
  - Collection
  - HalcyonServiceProvider
  - Model
- Html
  - README
  - BlockBuilder
  - FormBuilder
  - Helper
  - HtmlBuilder
  - HtmlServiceProvider
  - UrlMixin
  - UrlServiceProvider
- Mail
  - FakeMailer
  - Mailable
  - Mailer
  - MailManager
  - MailParser
  - MailServiceProvider
- Network
  - Http
- Parse
  - Parsedown
    - Parsedown
    - ParsedownExtra
  - Syntax
  - Bracket
  - Ini
  - Markdown
  - MarkdownData
  - ParseServiceProvider
  - Twig
  - Yaml
- Resize
  - BrokenImage
  - ResizeBuilder
  - Resizer
  - ResizeServiceProvider
- Router
  - README
  - CoreRouter
  - Helper
  - Router
  - RoutingServiceProvider
  - Rule
- Scaffold
  - Console
  - GeneratorCommand
  - GeneratorCommandBase
  - ScaffoldServiceProvider
- Support
  - Debug
    - HtmlDumper
  - Facades
    - Auth
    - Block
    - Config
    - Currency
    - DbDongle
    - Event
    - File
    - Flash
    - Form
    - Html
    - Ini
    - Input
    - Mail
    - Markdown
    - Resizer
    - Schema
    - Site
    - Str
    - Twig
    - Url
    - Validator
    - Yaml
  - Traits
  - README
  - Arr
  - ClassLoader
  - Collection
  - Facade
  - ModuleServiceProvider
  - SafeCollection
  - ServiceProvider
  - Singleton
  - Str
- Translation
  - README
  - FileLoader
  - TranslationServiceProvider
  - Translator
- Validation
  - Concerns
    - FormatsMessages
  - Factory
  - ValidationServiceProvider
  - Validator

Contents

Editor\Classes\ApiHelpers

Overview

ApiHelpers basic functions for the Editor

Public Methods

public static assertGetKey()

public static assertGetKey($array, $key): void

public static assertIsArray()

public static assertIsArray($value): void

Backend

Behaviors

FormController

ImportExportController

ListController

RelationController

Classes

Dashboard

NavigationManager

WidgetManager

Controllers

Index

Database

Seeds

Facades

FilterWidgets

FormWidgets

Repeater

TagList

Helpers

Models

BrandSetting

ExportModel

ImportModel

ReportWidgets

Skins

Traits

VueComponents

DropdownMenu

TreeView

Widgets

Filter

Form

Lists

Table

Cms

Classes

Controller

EditorExtension

Layout

Page

Partial

Theme

Components

Console

Controllers

Database

Seeds

Facades

FormWidgets

Helpers

Cms

Models

ReportWidgets

Traits

Twig

VueComponents

Widgets

Editor

Behaviors

Classes

Controllers

Traits

VueComponents

Media

Classes

Controllers

FormWidgets

Helpers

Twig

Widgets

System

Behaviors

Classes

PresetManager

SiteManager

UiManager

UpdateManager

Console

Controllers