-
Backend
-
Behaviors
-
Classes
-
Controllers
-
Database
-
Seeds
-
-
Facades
-
FormWidgets
-
Helpers
-
Models
-
ReportWidgets
-
Skins
-
Traits
-
VueComponents
-
Widgets
- ServiceProvider
-
-
Cms
-
Classes
- Asset
- CmsCompoundObject
- CmsController
- CmsException
- CmsObject
- CmsObjectCollection
- CodeBase
- CodeParser
- ComponentBase
- ComponentHelpers
- ComponentManager
- ComponentPartial
- Content
- Controller
- EditorExtension
- Layout
- LayoutCode
- MediaLibrary
- MediaLibraryItem
- MediaViewHelper
- Meta
- ObjectMemoryCache
- Page
- PageCode
- Partial
- PartialCode
- PartialStack
- Router
- Theme
- ThemeManager
-
Components
-
Controllers
-
Facades
-
FormWidgets
-
Helpers
-
Models
-
ReportWidgets
-
Traits
-
Twig
- ComponentNode
- ComponentTokenParser
- ContentNode
- ContentTokenParser
- DebugExtension
- DefaultNode
- DefaultTokenParser
- Extension
- FlashNode
- FlashTokenParser
- FrameworkNode
- FrameworkTokenParser
- Loader
- PageNode
- PageTokenParser
- PartialNode
- PartialTokenParser
- PlaceholderNode
- PlaceholderTokenParser
- PutNode
- PutTokenParser
- ScriptsNode
- ScriptsTokenParser
- StylesNode
- StylesTokenParser
-
VueComponents
-
Widgets
- ServiceProvider
-
-
Editor
-
Behaviors
-
Classes
-
Controllers
-
VueComponents
- ServiceProvider
-
-
Media
-
Classes
-
Controllers
-
FormWidgets
-
Twig
-
Widgets
- ServiceProvider
-
-
System
-
Behaviors
-
Classes
-
Console
-
OctoberUtil
- 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
-
Facades
-
Helpers
-
Models
-
ReportWidgets
-
Traits
-
Twig
-
Widgets
- ServiceProvider
-
-
Events
-
backend
-
ajax
-
filter
-
form
-
list
-
menu
-
page
-
user
-
-
cms
-
ajax
-
block
-
combiner
-
component
-
object
-
page
-
resizer
-
router
-
template
-
theme
-
-
exception
-
halcyon
-
datasource
-
-
mailer
-
media
-
model
-
auth
-
form
-
relation
-
/docs/api/model/relation/add
-
/docs/api/model/relation/associate
- attach
-
/docs/api/model/relation/beforeadd
-
/docs/api/model/relation/beforeassociate
- beforeAttach
- beforeDetach
-
/docs/api/model/relation/beforedissociate
-
/docs/api/model/relation/beforeremove
- detach
-
/docs/api/model/relation/dissociate
-
/docs/api/model/relation/remove
-
- afterBoot
- afterCreate
- afterDelete
- afterFetch
- afterRestore
- afterSave
- afterUpdate
- afterValidate
- beforeCreate
- beforeDelete
- beforeFetch
- beforeGetAttribute
- beforeRestore
- beforeSave
- beforeSetAttribute
- beforeUpdate
- beforeValidate
- getAttribute
- saveInternal
- setAttribute
-
-
system
-
assets
-
console
-
mirror
-
theme
-
-
reportwidgets
-
resizer
-
settings
- extendConfigFile
-
-
translator
-
-
Library
-
Argon
-
Assetic
-
Asset
-
Cache
-
Exception
-
Factory
-
Filter
- BaseCssFilter
- CallablesFilter
- CssCacheBustingFilter
- CssImportFilter
- CssMinFilter
- CssRewriteFilter
- FilterCollection
- JavascriptImporter
- JSMinFilter
- JSMinPlusFilter
- JSqueezeFilter
- LessCompiler
- LessphpFilter
- MinifyCssCompressorFilter
- PackagerFilter
- PackerFilter
- ScssCompiler
- ScssphpFilter
- StylesheetMinify
-
Util
- README
- AssetManager
- AssetWriter
- FilterManager
-
-
Auth
-
Models
- AuthException
- Manager
-
-
Config
-
Database
-
Attach
-
Behaviors
-
Concerns
-
Connections
-
Connectors
-
Models
-
Relations
-
Schema
-
Traits
-
Updates
- README
- Builder
- Collection
- DatabaseServiceProvider
- DataFeed
- Dongle
- MemoryCache
- MigrationServiceProvider
- Model
- ModelBehavior
- ModelException
- MorphPivot
- NestedTreeScope
- Pivot
- QueryBuilder
- SortableScope
- TreeCollection
- Updater
-
-
Events
-
Exception
-
Extension
-
Filesystem
-
Flash
-
Foundation
-
Bootstrap
-
Console
-
Exception
-
Http
-
Middleware
- Kernel
-
-
Providers
- Application
- Maker
-
-
Halcyon
-
Datasource
-
Exception
-
Processors
-
Traits
- README
- Builder
- Collection
- HalcyonServiceProvider
- MemoryCacheManager
- MemoryRepository
- Model
-
-
Html
-
Mail
-
Network
-
Parse
-
Parsedown
-
Syntax
- Bracket
- Ini
- Markdown
- MarkdownData
- ParseServiceProvider
- Twig
- Yaml
-
-
Process
-
Resize
-
Router
-
Scaffold
-
Support
-
Translation
-
- Documentation
- API
- Library
- Html
- HtmlBuilder
October\Rain\Html\HtmlBuilder
Html builder
Extension of illuminate/html, injects a session key to each form opening.
Protected properties
protected Illuminate\Routing\UrlGenerator $url
The URL generator instance.
protected static array $macros
The registered string macros.
Public methods
public mixed __call(string $method, array $parameters)
Dynamically handle calls to the class.
Parameters
- string $method
- array $parameters
public static mixed __callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
Parameters
- string $method
- array $parameters
public void __construct(Illuminate\Routing\UrlGenerator $url=NULL)
Create a new HTML builder instance.
Parameters
- Illuminate\Routing\UrlGenerator $url
public string attributes(array $attributes)
Build an HTML attribute string from an array.
Parameters
- array $attributes
public static string clean(string $html)
Cleans HTML to prevent most XSS attacks.
Parameters
- string $html - HTML
public string decode(string $value)
Convert entities to HTML characters.
Parameters
- string $value
public string email(string $email)
Obfuscate an e-mail address to prevent spam-bots from sniffing it.
Parameters
- string $email
public string entities(string $value)
Convert an HTML string to entities.
Parameters
- string $value
public static bool hasMacro(string $name)
Checks if macro is registered.
Parameters
- string $name
public string image(string $url, string $alt=NULL, array $attributes=array(), bool $secure=NULL)
Generate an HTML image element.
Parameters
- string $url
- string $alt
- array $attributes
- bool $secure
public static string limit(string $html, int $maxLength=100, string $end='...')
Limits HTML with specific length with a proper tag handling.
Parameters
- string $html - HTML string to limit
- int $maxLength - String length to truncate at
- string $end
public string link(string $url, string $title=NULL, array $attributes=array(), bool $secure=NULL)
Generate a HTML link.
Parameters
- string $url
- string $title
- array $attributes
- bool $secure
public string linkAction(string $action, string $title=NULL, array $parameters=array(), array $attributes=array())
Generate a HTML link to a controller action.
Parameters
- string $action
- string $title
- array $parameters
- array $attributes
public string linkAsset(string $url, string $title=NULL, array $attributes=array(), bool $secure=NULL)
Generate a HTML link to an asset.
Parameters
- string $url
- string $title
- array $attributes
- bool $secure
public string linkRoute(string $name, string $title=NULL, array $parameters=array(), array $attributes=array())
Generate a HTML link to a named route.
Parameters
- string $name
- string $title
- array $parameters
- array $attributes
public string linkSecureAsset(string $url, string $title=NULL, array $attributes=array())
Generate a HTTPS HTML link to an asset.
Parameters
- string $url
- string $title
- array $attributes
public static void macro(string $name, object|callable $macro)
Register a custom macro.
Parameters
- string $name
- object|callable $macro
public string mailto(string $email, string $title=NULL, array $attributes=array())
Generate a HTML link to an email address.
Parameters
- string $email
- string $title
- array $attributes
public static void minify($html)
minify makes HTML more compact
Parameters
- $html
public static void mixin(object $mixin, bool $replace=true)
Mix another object into the class.
Parameters
- object $mixin
- bool $replace
public string obfuscate(string $value)
Obfuscate a string to prevent spam-bots from sniffing it.
Parameters
- string $value
public string ol(array $list, array $attributes=array())
Generate an ordered list of items.
Parameters
- array $list
- array $attributes
public string script(string $url, array $attributes=array(), bool $secure=NULL)
Generate a link to a JavaScript file.
Parameters
- string $url
- array $attributes
- bool $secure
public string secureLink(string $url, string $title=NULL, array $attributes=array())
Generate a HTTPS HTML link.
Parameters
- string $url
- string $title
- array $attributes
public static string strip($string $string)
Removes HTML from a string
Parameters
- $string $string - String to strip HTML from
public string style(string $url, array $attributes=array(), bool $secure=NULL)
Generate a link to a CSS file.
Parameters
- string $url
- array $attributes
- bool $secure
public string ul(array $list, array $attributes=array())
Generate an un-ordered list of items.
Parameters
- array $list
- array $attributes
Protected methods
protected string attributeElement(string $key, string $value)
Build a single attribute element.
Parameters
- string $key
- string $value
protected string listing(string $type, array $list, array $attributes=array())
Create a listing HTML element.
Parameters
- string $type
- array $list
- array $attributes
protected string listingElement(mixed $key, string $type, string $value)
Create the HTML for a listing element.
Parameters
- mixed $key
- string $type
- string $value
protected string nestedListing(mixed $key, string $type, string $value)
Create the HTML for a nested listing attribute.
Parameters
- mixed $key
- string $type
- string $value