ApiHelpers - October CMS

Backend
- Behaviors
  - ImportExportController
    - TranscodeFilter
  - FormController
  - ImportExportController
  - ListController
  - RelationController
  - ReorderController
  - UserPreferencesModel
- Classes
- Controllers
  - AccessLogs
  - Auth
  - Files
  - Index
  - Media
  - Preferences
  - UserGroups
  - UserRoles
  - Users
- Database
  - Seeds
    - DatabaseSeeder
    - SeedSetupAdmin
- Facades
- FormWidgets
  - CodeEditor
  - ColorPicker
  - DataTable
  - DatePicker
  - FileUpload
  - MarkdownEditor
  - MediaFinder
  - NestedForm
  - PermissionEditor
  - RecordFinder
  - Relation
  - Repeater
  - RichEditor
  - Sensitive
  - TagList
- Helpers
  - Backend
- Models
  - AccessLog
  - BrandSetting
  - EditorSetting
  - ExportModel
  - ImportModel
  - Preference
  - User
  - UserGroup
  - UserPreference
  - UserRole
  - UserThrottle
- ReportWidgets
  - Welcome
- Skins
  - Standard
- Traits
- VueComponents
  - DropdownMenu
    - ItemDefinition
  - TreeView
  - CodeEditor
  - Document
  - DocumentMarkdownEditor
  - Dropdown
  - DropdownMenu
  - InfoTable
  - Inspector
  - LoadingIndicator
  - Modal
  - MonacoEditor
  - RichEditor
  - RichEditorDocumentConnector
  - ScrollablePanel
  - Splitter
  - Tabs
  - TreeView
  - Uploader
- Widgets
  - Table
  - Filter
  - Form
  - Lists
  - MediaManager
  - ReportContainer
  - Search
  - Table
  - Toolbar
- ServiceProvider
Cms
- Classes
- Components
- Controllers
  - Media
  - ThemeLogs
  - ThemeOptions
  - Themes
- Facades
  - Cms
- FormWidgets
  - Components
  - MediaFinder
- Helpers
  - Cms
  - File
- Models
- ReportWidgets
  - ActiveTheme
- Traits
- Twig
- VueComponents
- Widgets
- ServiceProvider
Editor
- Behaviors
  - StateManager
- Classes
- Controllers
  - Index
- VueComponents
- ServiceProvider
Media
- Classes
  - MediaLibrary
  - MediaLibraryItem
- Controllers
  - Index
- FormWidgets
  - MediaFinder
- Twig
  - Extension
- Widgets
  - MediaManager
- ServiceProvider
System
- Behaviors
  - SettingsModel
- Classes
- Console
  - OctoberUtil
    - OctoberUtilCommands
    - OctoberUtilPatches
  - ComposerScript
  - OctoberDown
  - OctoberFresh
  - OctoberMigrate
  - OctoberMirror
  - OctoberPasswd
  - OctoberUp
  - OctoberUpdate
  - OctoberUtil
  - PluginCheck
  - PluginDisable
  - PluginEnable
  - PluginInstall
  - PluginList
  - PluginRefresh
  - PluginRemove
  - ProjectSet
  - ProjectSync
  - ThemeCheck
  - ThemeInstall
  - ThemeList
  - ThemeRemove
  - ThemeSync
  - ThemeUse
- Controllers
- Database
  - Seeds
    - DatabaseSeeder
    - SeedSetupMailLayouts
- Facades
  - System
- Helpers
  - Cache
  - DateTime
  - System
  - View
- Models
  - EventLog
  - File
  - LogSetting
  - MailBrandSetting
  - MailLayout
  - MailPartial
  - MailSetting
  - MailTemplate
  - Parameter
  - PluginVersion
  - RequestLog
  - Revision
- ReportWidgets
  - Status
- Traits
- Twig
- Widgets
  - Changelog
  - Updater
- ServiceProvider
Events
- backend
  - ajax
    - beforeRunHandler
  - filter
  - form
  - list
  - menu
    - extendItems
  - page
    - beforeDisplay
  - user
    - login
- cms
  - ajax
    - beforeRunHandler
  - block
    - render
  - combiner
    - beforePrepare
    - getCacheKey
  - component
    - beforeRunAjaxHandler
    - runAjaxHandler
  - object
    - listInTheme
  - page
  - resizer
    - getCacheKey
  - router
    - beforeRoute
  - template
  - theme
- exception
  - beforeReport
  - report
- halcyon
  - datasource
    - db
- mailer
- media
  - file
    - delete
    - move
    - rename
    - upload
  - folder
    - create
    - delete
    - move
    - rename
- model
  - auth
    - afterImpersonate
    - beforeImpersonate
  - 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
  - afterBoot
  - afterCreate
  - afterDelete
  - afterFetch
  - afterRestore
  - afterSave
  - afterUpdate
  - afterValidate
  - beforeCreate
  - beforeDelete
  - beforeFetch
  - beforeGetAttribute
  - beforeRestore
  - beforeSave
  - beforeSetAttribute
  - beforeUpdate
  - beforeValidate
  - getAttribute
  - saveInternal
  - setAttribute
- system
  - assets
    - beforeAddAsset
  - console
    - mirror
      - extendPaths
    - theme
      - sync
        
        getAvailableModelClasses
  - reportwidgets
    - extendItems
  - resizer
    - getAvailableSources
  - settings
    - extendItems
  - extendConfigFile
- translator
  - beforeResolve
Library
- Argon
  - README
  - Argon
  - ArgonServiceProvider
- Assetic
  - Asset
    - Iterator
      - AssetCollectionFilterIterator
      - AssetCollectionIterator
    - AssetCache
    - AssetCollection
    - AssetReference
    - BaseAsset
    - FileAsset
    - GlobAsset
    - HttpAsset
    - StringAsset
  - Cache
  - Exception
    - FilterException
  - Factory
    - Loader
    - Resource
    - Worker
      - CacheBustingWorker
      - EnsureFilterWorker
    - AssetFactory
    - LazyAssetManager
  - Filter
  - Util
  - README
  - AssetManager
  - AssetWriter
  - FilterManager
- Auth
  - Models
    - Group
    - Preferences
    - Role
    - Throttle
    - User
  - AuthException
  - Manager
- Config
  - README
  - ConfigServiceProvider
  - ConfigWriter
  - FileLoader
  - Repository
- Database
  - Attach
    - BrokenImage
    - File
    - FileException
    - Resizer
  - Behaviors
    - Purgeable
    - Sortable
  - Concerns
    - HasRelationships
  - Connections
    - Connection
    - MySqlConnection
    - PostgresConnection
    - SQLiteConnection
    - SqlServerConnection
  - Connectors
    - ConnectionFactory
  - Models
    - DeferredBinding
    - Revision
  - Relations
    - AttachMany
    - AttachOne
    - AttachOneOrMany
    - BelongsTo
    - BelongsToMany
    - DeferOneOrMany
    - DefinedConstraints
    - HasMany
    - HasManyThrough
    - HasOne
    - HasOneOrMany
    - HasOneThrough
    - MorphMany
    - MorphOne
    - MorphOneOrMany
    - MorphTo
    - MorphToMany
    - Relation
  - Schema
    - Blueprint
  - Traits
    - DeferredBinding
    - Encryptable
    - Hashable
    - NestedTree
    - Nullable
    - Purgeable
    - Revisionable
    - SimpleTree
    - Sluggable
    - SoftDelete
    - SoftDeleting
    - Sortable
    - Validation
  - Updates
    - Migration
    - Seeder
  - README
  - Builder
  - Collection
  - DatabaseServiceProvider
  - DataFeed
  - Dongle
  - MemoryCache
  - MigrationServiceProvider
  - Model
  - ModelBehavior
  - ModelException
  - MorphPivot
  - NestedTreeScope
  - Pivot
  - QueryBuilder
  - SortableScope
  - TreeCollection
  - Updater
- Events
  - CallQueuedHandler
  - Dispatcher
  - EventServiceProvider
- Exception
  - AjaxException
  - ApplicationException
  - ErrorHandler
  - ExceptionBase
  - SystemException
  - ValidationException
- Extension
  - README
  - 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
  - Maker
- Halcyon
  - Datasource
  - Exception
  - Processors
    - Processor
    - SectionParser
  - Traits
    - Validation
  - README
  - Builder
  - Collection
  - HalcyonServiceProvider
  - MemoryCacheManager
  - MemoryRepository
  - Model
- Html
  - README
  - BlockBuilder
  - FormBuilder
  - Helper
  - HtmlBuilder
  - HtmlServiceProvider
  - UrlServiceProvider
- Mail
  - Transport
    - MandrillTransport
    - SparkPostTransport
  - Mailable
  - Mailer
  - MailParser
  - MailServiceProvider
  - TransportManager
- Network
  - README
  - Http
  - NetworkServiceProvider
- Parse
  - Parsedown
    - Parsedown
  - Syntax
  - Bracket
  - Ini
  - Markdown
  - MarkdownData
  - ParseServiceProvider
  - Twig
  - Yaml
- Process
  - README
  - Composer
  - Git
  - ProcessBase
- Resize
  - BrokenImage
  - ResizeBuilder
  - Resizer
  - ResizeServiceProvider
- Router
  - README
  - CoreRouter
  - Helper
  - Router
  - RoutingServiceProvider
  - Rule
  - UrlGenerator
- Scaffold
  - Console
  - GeneratorCommand
  - ScaffoldServiceProvider
- Support
  - Debug
    - HtmlDumper
  - Facades
    - Block
    - Config
    - DbDongle
    - File
    - Flash
    - Form
    - Html
    - Http
    - Ini
    - Input
    - Markdown
    - Resizer
    - Schema
    - Str
    - Twig
    - Url
    - Yaml
  - Traits
  - README
  - Arr
  - ClassLoader
  - Collection
  - Facade
  - ModuleServiceProvider
  - ServiceProvider
  - Singleton
  - Str
- Translation
  - README
  - FileLoader
  - TranslationServiceProvider
  - Translator

Contents

Editor\Classes\ApiHelpers

Basic API helper functions for the Editor

Public methods

public static void assertGetKey($array, $key)

Parameters

$array
$key

public static void assertIsArray($value)

Parameters

$value

Latest from the blog

Albright Labs: Why We Switched to October CMS and Never Looked Back

We recently spoke with Joe Buonocore, CEO of Albright Labs, a development agency based in Albrightsville, PA, United States. As long-standing partners, Albright Labs has earned a special place within the October CMS community. Specializing in custom development, they choose October CMS as their preferred platform.

Continue reading →