Replacing a string-resolved contract with a typed one
ModuleContracts plus the call site
Caching a public module page for guests
Add the route name to config/page_cache.php
Everything else, including admin routes, permissions, login provider branding and settings pages, is declared from the module itself.
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"DezerX Spartan","colors":{"primary":"#1a59bd","light":"#2e6ac9","dark":"#1a59bd"},"logo":{"light":"https://mintcdn.com/dezerx/y8vFoAhtdIIxWI9B/logo/lightmode-logo.png?fit=max\u0026auto=format\u0026n=y8vFoAhtdIIxWI9B\u0026q=85\u0026s=e0accc26f1ef7bee0518f6419a9f575b","dark":"https://mintcdn.com/dezerx/y8vFoAhtdIIxWI9B/logo/darkmode-logo.png?fit=max\u0026auto=format\u0026n=y8vFoAhtdIIxWI9B\u0026q=85\u0026s=816b82f4f2f632861bb9e6207b5b63de"},"favicon":"https://mintcdn.com/dezerx/1yCyCJXfP7xl-KMf/favicon.ico?fit=max\u0026auto=format\u0026n=1yCyCJXfP7xl-KMf\u0026q=85\u0026s=e33cb37a055614845ee86cff2528b694","navbar":{"links":[],"primary":{"type":"button","label":"Marketplace","href":"https://market.dezerx.com"}},"footer":{"socials":{"discord":"https://discord.gg/UN4VVc2hWJ"}},"contextual":{"options":["copy","chatgpt","claude"],"display":"header"},"thumbnails":{"background":"https://mintcdn.com/dezerx/SI_0DySkYgyQGEmB/og-background.png?fit=max\u0026auto=format\u0026n=SI_0DySkYgyQGEmB\u0026q=85\u0026s=d554784630750a9f58acbba0dd47bf93"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.dezerx.com"},{"anchor":"Marketplace","icon":"shopping-cart","href":"https://market.dezerx.com"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/UN4VVc2hWJ"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dezerx","hasAudioNarration":false,"actualSubdomain":"dezerx","customDomains":["docs.dezerx.com"],"gitSource":{"type":"github","owner":"dezerx-spartan","repo":"dezerx-spartan-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6afb0e4d00ed035c7b642a0c"},"feedback":{"agentFeedback":false,"thumbs":true},"entitlements":{},"buildId":"6afb5614f277b5849123078a","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"API reference","count":115},{"language":"default","tag":"Module API","count":45},{"language":"default","tag":"Service API","count":31},{"language":"default","tag":"Guides","count":28},{"language":"default","tag":"Services","count":16},{"language":"default","tag":"Tickets API","count":16},{"language":"default","tag":"Extensions","count":15},{"language":"default","tag":"Users API","count":15},{"language":"default","tag":"Gateways","count":11},{"language":"default","tag":"Members","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"extensions/tutorials/helpers","slug":"/extensions/tutorials/helpers","pageMetadata":{"title":"Helpers","description":"Base classes, events, middleware and commands you can lean on instead of writing your own.","icon":"toolbox","href":"/extensions/tutorials/helpers"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Base classes, events, middleware and commands you can lean on instead of writing your own.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Accordion,CodeBlock,Frame,Heading,OptimizedImage,Table}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/dezerx/dVNBM3sq4VCh7CKa/public/extensions/helpers/top.webp?fit=max\u0026auto=format\u0026n=dVNBM3sq4VCh7CKa\u0026q=85\u0026s=ae2d7d5963ff161b47e4956862a367d2`,alt:`Your module on top of base classes, jobs, events and support classes`,\"data-og-width\":`2720`,width:`2720`,\"data-og-height\":`1256`,height:`1256`,\"data-path\":`public/extensions/helpers/top.webp`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/dezerx/dVNBM3sq4VCh7CKa/public/extensions/helpers/top.webp?w=280\u0026fit=max\u0026auto=format\u0026n=dVNBM3sq4VCh7CKa\u0026q=85\u0026s=fb2bbef3d076588d53290d382a4010d8 280w, https://mintcdn.com/dezerx/dVNBM3sq4VCh7CKa/public/extensions/helpers/top.webp?w=560\u0026fit=max\u0026auto=format\u0026n=dVNBM3sq4VCh7CKa\u0026q=85\u0026s=b9ec8bb1c40680eb36ccd162b5855e51 560w, https://mintcdn.com/dezerx/dVNBM3sq4VCh7CKa/public/extensions/helpers/top.webp?w=840\u0026fit=max\u0026auto=format\u0026n=dVNBM3sq4VCh7CKa\u0026q=85\u0026s=31c2fe47a58001a248039b1b452c583e 840w, https://mintcdn.com/dezerx/dVNBM3sq4VCh7CKa/public/extensions/helpers/top.webp?w=1100\u0026fit=max\u0026auto=format\u0026n=dVNBM3sq4VCh7CKa\u0026q=85\u0026s=ba6b9144ede65920f33eb8d96322f2fd 1100w, https://mintcdn.com/dezerx/dVNBM3sq4VCh7CKa/public/extensions/helpers/top.webp?w=1650\u0026fit=max\u0026auto=format\u0026n=dVNBM3sq4VCh7CKa\u0026q=85\u0026s=031b6d4886660182794f113b491a551e 1650w, https://mintcdn.com/dezerx/dVNBM3sq4VCh7CKa/public/extensions/helpers/top.webp?w=2500\u0026fit=max\u0026auto=format\u0026n=dVNBM3sq4VCh7CKa\u0026q=85\u0026s=c42d0ef43c30e152f614e25cfdbb93b7 2500w`})}),`\n`,_jsx(Heading,{level:`2`,id:`base-classes`,children:`Base classes`}),`\n`,_jsx(Accordion,{title:`Classes and interfaces to extend`,icon:`layer-group`,id:`classes-and-interfaces-to-extend`,children:_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Class`}),_jsx(_components.th,{children:`Namespace`}),_jsx(_components.th,{children:`For`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`BaseModuleServiceProvider`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Modules`})}),_jsx(_components.td,{children:`Shared module bootstrapping`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`BaseModuleRouteServiceProvider`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Modules`})}),_jsx(_components.td,{children:`Route wiring and middleware aliases`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ServiceModuleServiceProvider`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Modules`})}),_jsx(_components.td,{children:`Service provider base`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GatewayModuleServiceProvider`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Services\\\\Payment\\\\Modules`})}),_jsx(_components.td,{children:`Gateway provider base`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`OAuthProviderServiceProvider`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Modules`})}),_jsx(_components.td,{children:`Login provider base`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`RegistrarModuleServiceProvider`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Modules`})}),_jsx(_components.td,{children:`Registrar provider base`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`AddonModuleServiceProvider`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Modules`})}),_jsx(_components.td,{children:`Addon provider base`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`EmptyGatewayEventServiceProvider`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Services\\\\Payment\\\\Modules`})}),_jsx(_components.td,{children:`Event provider for gateways with no listeners`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`BaseRenewService`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Services`})}),_jsx(_components.td,{children:`Service renewal`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`BaseCancelService`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Services`})}),_jsx(_components.td,{children:`Service cancellation`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`BasePaymentService`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Services\\\\Payment`})}),_jsx(_components.td,{children:`Gateway payment service`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ModulePaymentController`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Http\\\\Controllers\\\\Payment`})}),_jsx(_components.td,{children:`Gateway payment routes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ModuleSettingsController`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Http\\\\Controllers\\\\Payment`})}),_jsx(_components.td,{children:`Declarative admin settings for any module type`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`AbstractRegistrar`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Domains`})}),_jsxs(_components.td,{children:[`Registrar base, throws `,_jsx(_components.code,{children:`unsupported`}),` for optional methods`]})]})]})]})}),`\n`,_jsx(Accordion,{title:`Support classes`,icon:`screwdriver-wrench`,id:`support-classes`,children:_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Class`}),_jsx(_components.th,{children:`Use`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Support\\\\RuntimeSnapshot`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`remember($key, $resolver)`}),` and `,_jsx(_components.code,{children:`bump()`}),`. Memo shared by every worker`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Support\\\\ModuleStatuses`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`all()`}),` and `,_jsx(_components.code,{children:`enabled($name)`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Support\\\\ModulePath`})}),_jsx(_components.td,{children:`Module paths and group folders`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Modules\\\\ModuleContracts`})}),_jsxs(_components.td,{children:[`The extension point spec that drives `,_jsx(_components.code,{children:`module:doctor`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Modules\\\\ModulePermissionRegistry`})}),_jsx(_components.td,{children:`Merges module permissions into core`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Modules\\\\OAuthProviderRegistry`})}),_jsx(_components.td,{children:`Enabled login providers`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Services\\\\ServiceControlLoader`})}),_jsxs(_components.td,{children:[`Loads `,_jsx(_components.code,{children:`ServiceControlsService`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`App\\\\Services\\\\Payment\\\\PaymentGatewayManager`})}),_jsxs(_components.td,{children:[`Gateway registry. `,_jsx(_components.code,{children:`flushAvailableCache()`})]})]})]})]})}),`\n`,_jsx(Heading,{level:`2`,id:`core-events`,children:`Core events`}),`\n`,_jsx(_components.p,{children:`All are post-events. None can veto or change the action.`}),`\n`,_jsx(Accordion,{title:`The 27 events in app/Events`,icon:`bell`,id:`the-27-events-in-app-events`,children:_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Fires when`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`UserRegistered`})}),_jsx(_components.td,{children:`A user registers`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ServiceCheckoutInitiated`})}),_jsx(_components.td,{children:`Checkout starts`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ServicePaymentCompleted`})}),_jsx(_components.td,{children:`Payment for a service succeeds`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ServiceProvisioned`})}),_jsx(_components.td,{children:`A service has been created by its module`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`InvoicePaid`}),`, `,_jsx(_components.code,{children:`StandaloneInvoicePaid`})]}),_jsx(_components.td,{children:`An invoice is marked paid`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`ServiceRenewalInitiated`}),`, `,_jsx(_components.code,{children:`ServiceRenewed`})]}),_jsx(_components.td,{children:`Renewal starts, completes`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`ServiceUpgradeCompleted`}),`, `,_jsx(_components.code,{children:`ServiceDowngradeCompleted`})]}),_jsx(_components.td,{children:`A plan change completes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ServiceConfigurationChanged`})}),_jsx(_components.td,{children:`Configurable options changed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`AddonPurchased`})}),_jsx(_components.td,{children:`An addon is bought`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`ServiceSuspended`}),`, `,_jsx(_components.code,{children:`ServiceUnsuspended`})]}),_jsx(_components.td,{children:`Suspension state changes`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`ServiceTerminated`}),`, `,_jsx(_components.code,{children:`ServiceCancelled`})]}),_jsx(_components.td,{children:`A service ends`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ServiceWarned`})}),_jsx(_components.td,{children:`An overdue warning is issued`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ServiceAutoRenewalToggled`})}),_jsx(_components.td,{children:`Auto renew switched`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`OrderRequiresManualApproval`})}),_jsx(_components.td,{children:`An order is held for review`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`BankWireProofSubmitted`})}),_jsx(_components.td,{children:`Bank transfer proof uploaded`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`TicketCreated`}),`, `,_jsx(_components.code,{children:`TicketMessageSent`}),`, `,_jsx(_components.code,{children:`TicketStatusChanged`}),`, `,_jsx(_components.code,{children:`TicketTransferred`})]}),_jsx(_components.td,{children:`Support tickets`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`DiscordLinked`}),`, `,_jsx(_components.code,{children:`DiscordUnlinked`})]}),_jsx(_components.td,{children:`Discord link state`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`CartItemAdded`})}),_jsx(_components.td,{children:`A product is added to the cart`})]})]})]})}),`\n`,_jsx(Heading,{level:`2`,id:`middleware`,children:`Middleware`}),`\n`,_jsx(Accordion,{title:`Ready-made middleware`,icon:`filter`,id:`ready-made-middleware`,children:_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Middleware`}),_jsx(_components.th,{children:`Use`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`AdminMiddleware`})}),_jsx(_components.td,{children:`Admin only`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`PermissionMiddleware`})}),_jsx(_components.td,{children:`Permission check from route defaults or the merged map`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`AdminReauthMiddleware`})}),_jsx(_components.td,{children:`Password reconfirmation for sensitive admin actions`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`AdminAuditLogMiddleware`})}),_jsx(_components.td,{children:`Logs admin changes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ModuleServiceAuditLogMiddleware`})}),_jsx(_components.td,{children:`Logs service panel actions`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`CheckServicePermissions`})}),_jsxs(_components.td,{children:[`Sub-user permissions on `,_jsx(_components.code,{children:`/service/{serviceId}/...`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ServiceRoutesMiddleware`})}),_jsx(_components.td,{children:`Routes the request to the right service module`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`CheckUserSuspension`}),`, `,_jsx(_components.code,{children:`CheckIpBan`}),`, `,_jsx(_components.code,{children:`Require2FA`})]}),_jsx(_components.td,{children:`Account and access checks`})]})]})]})}),`\n`,_jsx(Heading,{level:`2`,id:`commands`,children:`Commands`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`php`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` artisan`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` make:module`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` {Name}`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --type=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`service`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`|`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`gateway`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`|`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`provider`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`|`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`registrar`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`|`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`addon}`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` [--webhook] [--enable]`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`php`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` artisan`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` module:doctor`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` [{`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`Name}...]`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` [--json] [--strict]`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`php`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` artisan`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` module:list`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`php`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` artisan`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` module:enable`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` {Name}`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`php`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` artisan`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` module:disable`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` {Name}`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`php`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` artisan`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` module:migrate`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` {Name}`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`php`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` artisan`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` octane:reload`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`php`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` artisan`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` queue:restart`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`module:doctor`}),` exits non-zero on errors, so it works in CI. `,_jsx(_components.code,{children:`--strict`}),` also fails on warnings and `,_jsx(_components.code,{children:`--json`}),` prints machine readable output.`]}),`\n`,_jsx(Heading,{level:`2`,id:`octane-at-a-glance`,children:`Octane at a glance`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Do not`}),_jsx(_components.th,{children:`Do`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`exit()`}),`, `,_jsx(_components.code,{children:`die()`}),`, `,_jsx(_components.code,{children:`$response->send()`})]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`throw new HttpResponseException($response)`})})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Read the user or request in `,_jsx(_components.code,{children:`boot()`})]}),_jsx(_components.td,{children:`Do per-request work in middleware`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`Inertia::share()`}),` in a provider`]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`Inertia::share()`}),` in a middleware`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Request state in a static or `,_jsx(_components.code,{children:`singleton()`})]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`scoped()`}),` bindings`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`A static array memo of database rows`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`RuntimeSnapshot::remember()`})})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`Event::listen()`}),` in a request`]}),_jsx(_components.td,{children:`Register once in your provider`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`More in `,_jsx(_components.a,{href:`/extensions/tutorials/enabling#code-that-is-safe-in-a-worker`,children:`Enabling and Octane`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`things-that-need-a-core-change`,children:`Things that need a core change`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`What`}),_jsx(_components.th,{children:`Where`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`A sidebar link without seeding a row`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`SidebarLink`}),` table, through the admin UI`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Replacing a string-resolved contract with a typed one`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`ModuleContracts`}),` plus the call site`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Caching a public module page for guests`}),_jsxs(_components.td,{children:[`Add the route name to `,_jsx(_components.code,{children:`config/page_cache.php`})]})]})]})]}),`\n`,_jsx(_components.p,{children:`Everything else, including admin routes, permissions, login provider branding and settings pages, is declared from the module itself.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Helpers","description":"Base classes, events, middleware and commands you can lean on instead of writing your own.","icon":"toolbox","href":"/extensions/tutorials/helpers"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base classes","slug":"base-classes","depth":2,"children":[]},{"title":"Core events","slug":"core-events","depth":2,"children":[]},{"title":"Middleware","slug":"middleware","depth":2,"children":[]},{"title":"Commands","slug":"commands","depth":2,"children":[]},{"title":"Octane at a glance","slug":"octane-at-a-glance","depth":2,"children":[]},{"title":"Things that need a core change","slug":"things-that-need-a-core-change","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"dezerx","siteName":"DezerX Spartan","title":"Helpers - DezerX Spartan","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-16T14:08:27.639Z","originalFileLocation":"extensions/tutorials/helpers.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Base classes, events, middleware and commands you can lean on instead of writing your own.\">\u003cmeta data-mint-head name=\"application-name\" content=\"DezerX Spartan\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dezerx/jLkd_CnHxrfLEH-d/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/dezerx/jLkd_CnHxrfLEH-d/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dezerx/jLkd_CnHxrfLEH-d/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dezerx/jLkd_CnHxrfLEH-d/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dezerx/jLkd_CnHxrfLEH-d/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dezerx/jLkd_CnHxrfLEH-d/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dezerx/jLkd_CnHxrfLEH-d/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dezerx/jLkd_CnHxrfLEH-d/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dezerx/jLkd_CnHxrfLEH-d/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Helpers - DezerX Spartan\">\u003cmeta data-mint-head property=\"og:description\" content=\"Base classes, events, middleware and commands you can lean on instead of writing your own.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"DezerX Spartan\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.dezerx.com/extensions/tutorials/helpers\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dezerx.mintlify.site/_mintlify/api/og/v2?division=Getting+started\u0026amp;title=Helpers\u0026amp;description=Base+classes%2C+events%2C+middleware+and+commands+you+can+lean+on+instead+of+writing+your+own.\u0026amp;theme=9fcf0f7eff16c815e7a0c626\u0026amp;signature=f749f0a76ee55e43fd67c87405f066cdffe686697b122fc270214c8890833c9d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Helpers - DezerX Spartan\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Base classes, events, middleware and commands you can lean on instead of writing your own.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dezerx.mintlify.site/_mintlify/api/og/v2?division=Getting+started\u0026amp;title=Helpers\u0026amp;description=Base+classes%2C+events%2C+middleware+and+commands+you+can+lean+on+instead+of+writing+your+own.\u0026amp;theme=9fcf0f7eff16c815e7a0c626\u0026amp;signature=f749f0a76ee55e43fd67c87405f066cdffe686697b122fc270214c8890833c9d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/dezerx/jLkd_CnHxrfLEH-d/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"DezerX Spartan\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1a59bd\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.dezerx.com/extensions/tutorials/helpers\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/extensions/tutorials/helpers.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.dezerx.com/#organization\",\"name\":\"DezerX Spartan\",\"url\":\"https://docs.dezerx.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/dezerx/y8vFoAhtdIIxWI9B/logo/lightmode-logo.png?fit=max\u0026auto=format\u0026n=y8vFoAhtdIIxWI9B\u0026q=85\u0026s=e0accc26f1ef7bee0518f6419a9f575b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.dezerx.com#website\",\"name\":\"DezerX Spartan\",\"url\":\"https://docs.dezerx.com\",\"publisher\":{\"@id\":\"https://docs.dezerx.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.dezerx.com/extensions/tutorials/helpers#webpage\",\"url\":\"https://docs.dezerx.com/extensions/tutorials/helpers\",\"name\":\"Helpers\",\"description\":\"Base classes, events, middleware and commands you can lean on instead of writing your own.\",\"dateModified\":\"2026-11-16T14:08:27.639Z\",\"isPartOf\":{\"@id\":\"https://docs.dezerx.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.dezerx.com/extensions/tutorials/helpers#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.dezerx.com/extensions/tutorials/helpers#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting started\",\"item\":\"https://docs.dezerx.com/extensions/tutorials\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Helpers\",\"item\":\"https://docs.dezerx.com/extensions/tutorials/helpers\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.dezerx.com/extensions/tutorials/helpers#article\",\"headline\":\"Helpers\",\"name\":\"Helpers\",\"description\":\"Base classes, events, middleware and commands you can lean on instead of writing your own.\",\"url\":\"https://docs.dezerx.com/extensions/tutorials/helpers\",\"mainEntityOfPage\":{\"@id\":\"https://docs.dezerx.com/extensions/tutorials/helpers#webpage\"},\"dateModified\":\"2026-11-16T14:08:27.639Z\",\"publisher\":{\"@id\":\"https://docs.dezerx.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.dezerx.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"DezerX Spartan\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"DezerX Spartan\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/extensions/tutorials/helpers.md","siteName":"DezerX Spartan","nav":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.dezerx.com"},{"anchor":"Marketplace","icon":"shopping-cart","href":"https://market.dezerx.com"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/UN4VVc2hWJ"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/spartan/installing"}]},{"tab":"Extensions","groups":[{"group":"Getting started","pages":[{"title":"Build your own module","sidebarTitle":"Overview","icon":"puzzle","href":"/extensions/tutorials"},{"title":"Fundamentals","icon":"book-open","href":"/extensions/tutorials/fundamentals"},{"title":"module.json and settings","icon":"file-code","href":"/extensions/tutorials/module-json"},{"title":"Enabling and Octane","icon":"bolt","href":"/extensions/tutorials/enabling"},{"title":"Hooks","description":"The class names and method signatures core calls. Copy names from here, then run module:doctor.","icon":"plug","href":"/extensions/tutorials/hooks"},{"title":"Helpers","icon":"toolbox","href":"/extensions/tutorials/helpers"}]},{"group":"Make your own","pages":[{"title":"Service modules","description":"Create and manage something people buy: a game server, a VPS, a hosting account, a licence key.","icon":"server","href":"/extensions/tutorials/services"},{"title":"Payment gateways","icon":"credit-card","href":"/extensions/tutorials/gateways"},{"title":"Login providers","icon":"fingerprint","href":"/extensions/tutorials/socials"},{"title":"Domain registrars","icon":"globe","href":"/extensions/tutorials/registrars"},{"title":"Addon modules","icon":"sparkles","href":"/extensions/tutorials/addons"},{"title":"Admin pages","icon":"table-columns","href":"/extensions/tutorials/admin-pages"}]},{"group":"Themes","pages":[{"title":"Creating a theme","sidebarTitle":"Themes","icon":"palette","href":"/extensions/tutorials/themes"},{"title":"Client themes","sidebarTitle":"Client themes","icon":"palette","href":"/extensions/tutorials/client-themes"},{"title":"Admin themes","sidebarTitle":"Admin themes","icon":"table-columns","href":"/extensions/tutorials/admin-themes"}]}]},{"tab":"API reference","pages":[{"title":"API reference","href":"/api-reference/introduction"}]}]},"basePath":"","title":"Helpers - DezerX Spartan","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-RDXR0lmt.js","DynamicMarkdown-Z_y464fM.js","zoom-image-lightbox-D5uLWhtj.js","lightbox-handle-r17bVUz3.js"]}