1. Documentation
  2. API
  3. System
  4. Classes
  5. PluginBase

System\Classes\PluginBase

Overview

PluginBase class

Extends
Implements
  • October\Contracts\Support\OctoberPackage

Public Properties

public array $require

require plugin dependencies.

public boolean $disabled

disabled determines if this plugin should be loaded (false) or not (true).

Show inherited public properties

Inherited Public Properties

  • $publishes - The paths that should be published. (defined in Illuminate\Support\ServiceProvider)
  • $publishGroups - The paths that should be published by group. (defined in Illuminate\Support\ServiceProvider)

Protected Properties

protected bool $loadedYamlConfiguration

Show inherited protected properties

Inherited Protected Properties

  • $app - instance. (defined in October\Rain\Support\ServiceProvider)
  • $bootingCallbacks - All of the registered booting callbacks. (defined in Illuminate\Support\ServiceProvider)
  • $bootedCallbacks - All of the registered booted callbacks. (defined in Illuminate\Support\ServiceProvider)

Public Methods

public boot()

public boot(): void

boot method, called right before the request route.

public pluginDetails()

public pluginDetails(): array

pluginDetails returns information about this plugin, including plugin name and developer name.

public register()

public register(): void

register method, called when the plugin is first registered.

public registerComponents()

public registerComponents(): void

public registerConsoleCommand()

public registerConsoleCommand(string $key, string $class): void

registerConsoleCommand registers a new console (artisan) command.

public registerContentFields()

public registerContentFields(): void

public registerFilterWidgets()

public registerFilterWidgets(): void

public registerFormWidgets()

public registerFormWidgets(): void

public registerListColumnTypes()

public registerListColumnTypes(): void

public registerMailLayouts()

public registerMailLayouts(): void

public registerMailPartials()

public registerMailPartials(): void

public registerMailTemplates()

public registerMailTemplates(): void

public registerMarkupTags()

public registerMarkupTags(): void

public registerNavigation()

public registerNavigation(): void

public registerPageSnippets()

public registerPageSnippets(): void

public registerPermissions()

public registerPermissions(): void

public registerReportWidgets()

public registerReportWidgets(): void

public registerSchedule()

public registerSchedule($schedule): void

public registerSettings()

public registerSettings(): void

public registerValidationRule()

public registerValidationRule(string $key, mixed $rule): void

registerValidationRule registers a new validation rule.

Show inherited public methods

Inherited Public Methods

  • __construct() - Create a new service provider instance. (defined in Illuminate\Support\ServiceProvider)
  • booted() - Register a booted callback to be run after the "boot" method is called. (defined in Illuminate\Support\ServiceProvider)
  • booting() - Register a booting callback to be run before the "boot" method is called. (defined in Illuminate\Support\ServiceProvider)
  • callBootedCallbacks() - Call the registered booted callbacks. (defined in Illuminate\Support\ServiceProvider)
  • callBootingCallbacks() - Call the registered booting callbacks. (defined in Illuminate\Support\ServiceProvider)
  • commands() - Register the package's custom Artisan commands. (defined in Illuminate\Support\ServiceProvider)
  • isDeferred() - Determine if the provider is deferred. (defined in Illuminate\Support\ServiceProvider)
  • pathsToPublish() - Get the paths to publish. (defined in Illuminate\Support\ServiceProvider)
  • provides() - Get the services provided by the provider. (defined in Illuminate\Support\ServiceProvider)
  • publishableGroups() - Get the groups available for publishing. (defined in Illuminate\Support\ServiceProvider)
  • publishableProviders() - Get the service providers available for publishing. (defined in Illuminate\Support\ServiceProvider)
  • when() - Get the events that trigger this service provider to register. (defined in Illuminate\Support\ServiceProvider)

Protected Methods

protected getConfigurationFromYaml()

protected getConfigurationFromYaml(
    string|null $exceptionMessage = null
): array|bool

getConfigurationFromYaml reads configuration from YAML file.

Show inherited protected methods

Inherited Protected Methods

  • addPublishGroup() - Add a publish group / tag to the service provider. (defined in Illuminate\Support\ServiceProvider)
  • callAfterResolving() - Setup an after resolving listener, or fire immediately if already resolved. (defined in Illuminate\Support\ServiceProvider)
  • callBeforeResolving() - sets up a before resolving listener, or fire immediately. (defined in October\Rain\Support\ServiceProvider)
  • ensurePublishArrayInitialized() - Ensure the publish array for the service provider is initialized. (defined in Illuminate\Support\ServiceProvider)
  • loadFactoriesFrom() - Register Eloquent model factory paths. (defined in Illuminate\Support\ServiceProvider)
  • loadJsonTranslationsFrom() - Register a JSON translation file path. (defined in Illuminate\Support\ServiceProvider)
  • loadMigrationsFrom() - Register database migration paths. (defined in Illuminate\Support\ServiceProvider)
  • loadRoutesFrom() - Load the given routes file if routes are not already cached. (defined in Illuminate\Support\ServiceProvider)
  • loadTranslationsFrom() - Register a translation file namespace. (defined in Illuminate\Support\ServiceProvider)
  • loadViewComponentsAs() - Register the given view components with a custom prefix. (defined in Illuminate\Support\ServiceProvider)
  • loadViewsFrom() - Register a view file namespace. (defined in Illuminate\Support\ServiceProvider)
  • mergeConfigFrom() - Merge the given configuration with the existing configuration. (defined in Illuminate\Support\ServiceProvider)
  • pathsForProviderAndGroup() - Get the paths for the provider and group. (defined in Illuminate\Support\ServiceProvider)
  • pathsForProviderOrGroup() - Get the paths for the provider or group (or both). (defined in Illuminate\Support\ServiceProvider)
  • publishes() - Register paths to be published by the publish command. (defined in Illuminate\Support\ServiceProvider)