-
Backend
-
Behaviors
-
FormController
-
ImportExportController
-
ListController
-
RelationController
- FormController
- ImportExportController
- ListController
- RelationController
- ReorderController
- UserPreferencesModel
-
-
Classes
-
Dashboard
-
NavigationManager
-
WidgetManager
- 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
-
Database
-
Facades
-
FilterWidgets
-
FormWidgets
-
Helpers
-
Models
-
BrandSetting
-
ExportModel
-
ImportModel
- AccessLog
- BrandSetting
- Dashboard
- EditorSetting
- ExportModel
- ImportModel
- Preference
- ReportDataCache
- User
- UserGroup
- UserPreference
- UserPreferenceModel
- UserRole
- UserThrottle
-
-
ReportWidgets
-
Skins
-
Traits
-
VueComponents
-
Widgets
-
Filter
-
Form
-
Lists
-
Table
- Filter
- Form
- Lists
- ListStructure
- ReportContainer
- RoleImpersonator
- Search
- SiteSwitcher
- Table
- Toolbar
-
- ServiceProvider
-
-
Cms
-
Classes
-
Controller
-
EditorExtension
-
Layout
-
Page
-
Partial
-
Theme
- 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
-
Controllers
-
Database
-
Facades
-
FormWidgets
-
Helpers
-
Models
-
ReportWidgets
-
Traits
-
Twig
- AjaxPartialTokenParser
- ComponentNode
- ComponentTokenParser
- ContentNode
- ContentTokenParser
- DebugExtension
- DefaultNode
- DefaultTokenParser
- Extension
- FlashNode
- FlashTokenParser
- FrameworkNode
- FrameworkTokenParser
- GetAttrAdjuster
- GetAttrNode
- Loader
- MetaNode
- MetaTokenParser
- PageNode
- PageTokenParser
- PartialNode
- PartialTokenParser
- PlaceholderNode
- PlaceholderTokenParser
- PutNode
- PutTokenParser
- ScriptsNode
- ScriptsTokenParser
- StylesNode
- StylesTokenParser
-
VueComponents
-
Widgets
- ServiceProvider
-
-
Editor
-
Behaviors
-
Classes
-
Controllers
-
Traits
-
VueComponents
- ServiceProvider
-
-
Media
-
Classes
-
Controllers
-
FormWidgets
-
Helpers
-
Twig
-
Widgets
- ServiceProvider
-
-
System
-
Behaviors
-
Classes
-
PresetManager
-
SiteManager
-
UiManager
-
UpdateManager
- 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
- ComposerScript
- OctoberAbout
- OctoberDown
- OctoberFresh
- OctoberMigrate
- OctoberMirror
- OctoberOptimize
- OctoberPasswd
- OctoberUp
- OctoberUpdate
- OctoberUtil
- OctoberUtilCommands
- OctoberUtilPatches
- OctoberUtilRefitLang
- PluginCheck
- PluginDisable
- PluginEnable
- PluginInstall
- PluginList
- PluginRefresh
- PluginRemove
- PluginSeed
- PluginTest
- ProjectSync
-
Controllers
-
Database
-
Facades
-
Helpers
-
Middleware
-
Models
-
ReportWidgets
-
Traits
-
Twig
-
Widgets
- ServiceProvider
-
-
Tailor
-
Behaviors
-
Classes
-
Blueprint
-
BlueprintIndexer
-
EditorExtension
-
Relations
-
SchemaBuilder
-
Scopes
- Blueprint
- BlueprintCollection
- BlueprintErrorData
- BlueprintException
- BlueprintIndexer
- BlueprintModel
- BlueprintVerifier
- ComponentVariable
- ContentFieldBase
- EditorExtension
- FieldManager
- Fieldset
- NavigationItem
- PermissionItem
- RecordIndexer
- SchemaBuilder
- SchemaPruner
-
-
Components
-
Console
-
ContentFields
-
Controllers
-
Models
-
EntryRecord
-
GlobalRecord
-
RecordImport
- ContentSchema
- EntryRecord
- GlobalRecord
- NestedFormItem
- PreviewToken
- RecordExport
- RecordImport
- RepeaterItem
-
-
Traits
-
VueComponents
- ServiceProvider
-
-
Events
-
backend
-
ajax
-
brand
-
files
-
filter
-
form
-
list
-
menu
-
page
-
roles
-
site
-
user
-
-
cms
-
ajax
-
block
-
combiner
-
component
-
internalTrafficStatistics
-
object
-
page
-
pageLookup
-
resizer
-
router
-
sitePicker
-
template
-
theme
- extendTwig
-
-
deferredBinding
-
editor
-
extension
-
-
exception
-
halcyon
-
datasource
-
-
mailer
-
media
-
model
-
auth
-
filter
-
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
-
-
/docs/api/model/afterboot
-
/docs/api/model/aftercreate
-
/docs/api/model/afterdelete
-
/docs/api/model/afterfetch
-
/docs/api/model/afterinit
- afterRelation
- afterRestore
-
/docs/api/model/aftersave
- afterTrash
-
/docs/api/model/afterupdate
- afterValidate
-
/docs/api/model/beforecreate
-
/docs/api/model/beforedelete
-
/docs/api/model/beforefetch
- beforeGetAttribute
- beforeRelation
- beforeReplicate
- beforeRestore
-
/docs/api/model/beforesave
- beforeSetAttribute
-
/docs/api/model/beforeupdate
- beforeValidate
- extendBlueprint
- getAttribute
- newInstance
- saveInternal
- setAttribute
-
-
pages
-
snippet
-
-
site
-
system
-
assets
- beforeAddAsset
-
/docs/api/system/assets/beforebundleasset
-
console
-
mirror
-
-
mail
-
reportwidgets
-
resizer
-
settings
-
site
-
updater
- extendConfigFile
- extendTwig
-
-
tailor
-
user
-
-
Library
-
Argon
-
Assetic
-
Asset
-
Cache
-
Exception
-
Factory
-
Filter
-
Traits
-
Util
- README
- AsseticServiceProvider
- AssetManager
- AssetWriter
- Combiner
- FilterManager
-
-
Auth
-
Combine
-
Composer
-
Config
-
Database
-
Attach
-
Concerns
-
Connections
-
Connectors
-
Factories
-
Models
-
Relations
-
Schema
-
Scopes
-
Traits
-
Updates
- README
- Builder
- Collection
- DatabaseServiceProvider
- Dongle
- ExpandoModel
- MigrationServiceProvider
- Model
- ModelBehavior
- ModelException
- MorphPivot
- NestedTreeScope
- Pivot
- QueryBuilder
- Replicator
- SortableScope
- TreeCollection
- Updater
-
-
Element
-
Filter
-
Form
-
Lists
-
Navigation
- ElementBase
- ElementHolder
-
-
Events
-
Exception
-
Extension
-
Filesystem
-
Flash
-
Foundation
-
Bootstrap
-
Console
-
Exception
-
Http
-
Middleware
- Kernel
-
-
Providers
- Application
-
-
Halcyon
-
Concerns
-
Datasource
-
Exception
-
Processors
-
Traits
- README
- Builder
- Collection
- HalcyonServiceProvider
- Model
-
-
Html
-
Mail
-
Network
-
Parse
-
Resize
-
Router
-
Scaffold
-
Support
-
Debug
-
Facades
-
Traits
- README
- Arr
- ClassLoader
- Collection
- Facade
- ModuleServiceProvider
- SafeCollection
- ServiceProvider
- Singleton
- Str
-
-
Translation
-
Validation
-
- Documentation
- API
- Tailor
- Classes
- Blueprint
- StructureBlueprint
Tailor\Classes\Blueprint\StructureBlueprint
Extends
Public Properties
There are no public properties in the class.
Show inherited public properties
Inherited Public Properties
- $attributes - for the template, taken from the config. (defined in Tailor\Classes\Blueprint)
- $fileName - specifies the file name corresponding the Blueprint object. (defined in Tailor\Classes\Blueprint)
- $mtime - last modified time. (defined in Tailor\Classes\Blueprint)
- $content - of file. (defined in Tailor\Classes\Blueprint)
- $exists - indicates if the model exists. (defined in Tailor\Classes\Blueprint)
- $implement - extensions for this class. (defined in October\Rain\Extension\Extendable)
Protected Properties
protected string $typeName
typeName of the blueprint
Show inherited protected properties
Inherited Protected Properties
- $originalFileName - specifies the file name that the template was originally loaded. (defined in Tailor\Classes\Blueprint)
- $allowedExtensions - for template files. (defined in Tailor\Classes\Blueprint)
- $defaultDatasource - is used by unit tests. (defined in Tailor\Classes\Blueprint)
- $booted - models. (defined in Tailor\Classes\Blueprint)
- $resolvedPlugins - (defined in Tailor\Classes\Blueprint)
- $datasource - is the data source for the model, a directory path. (defined in Tailor\Classes\Blueprint)
- $extensionData - contains class reflection information, including behaviors. (defined in October\Rain\Extension\Extendable)
- $extendableStaticMethods - is a collection of static methods used by behaviors. (defined in October\Rain\Extension\Extendable)
- $extendableGuardProperties - indicates if dynamic properties can be created. (defined in October\Rain\Extension\Extendable)
Public Methods
public getMaxDepth()
public getMaxDepth(): int
public hasTree()
public hasTree(): bool
Inherited Public Methods
- __call() - calls an undefined local method. (defined in October\Rain\Extension\Extendable)
- __callStatic() - calls an undefined static method. (defined in October\Rain\Extension\Extendable)
- __construct() - (defined in Tailor\Classes\Blueprint)
- __get() - attributes on the model. (defined in Tailor\Classes\Blueprint)
- __isset() - determines if an attribute exists on the model. (defined in Tailor\Classes\Blueprint)
- __set() - attributes on the model. (defined in Tailor\Classes\Blueprint)
- __sleep() - prepare the object for serialization. (defined in October\Rain\Extension\Extendable)
- __unset() - an attribute on the model. (defined in Tailor\Classes\Blueprint)
- __wakeup() - when a model is being unserialized, check if it needs to be booted. (defined in October\Rain\Extension\Extendable)
- addDynamicMethod() - programmatically adds a method to the extendable class. (defined in October\Rain\Extension\Extendable)
- addDynamicProperty() - programmatically adds a property to the extendable class. (defined in October\Rain\Extension\Extendable)
- asExtension() - is short hand for
getClassExtension()method, except takes the short. (defined in October\Rain\Extension\Extendable) - clearExtendedClasses() - (defined in October\Rain\Extension\Extendable)
- delete() - template. (defined in Tailor\Classes\Blueprint)
- extend() - this class with a closure. (defined in October\Rain\Extension\Extendable)
- extendClassWith() - dynamically extends a class with a specified behavior. (defined in October\Rain\Extension\Extendable)
- extendableCall() - magic method for
__call(). (defined in October\Rain\Extension\Extendable) - extendableCallStatic() - magic method for
__callStatic(). (defined in October\Rain\Extension\Extendable) - extendableConstruct() - should be called as part of the constructor. (defined in October\Rain\Extension\Extendable)
- extendableDestruct() - should be called when serializing the object. (defined in October\Rain\Extension\Extendable)
- extendableExtendCallback() - is a helper method for
::extend()static method. (defined in October\Rain\Extension\Extendable) - extendableGet() - magic method for
__get(). (defined in October\Rain\Extension\Extendable) - extendableSet() - magic method for
__set(). (defined in October\Rain\Extension\Extendable) - find() - a single template by its file name. (defined in Tailor\Classes\Blueprint)
- forceSave() - (defined in Tailor\Classes\Blueprint)
- get() - all blueprints and uses simple objects. (defined in Tailor\Classes\Blueprint)
- getBasePath() - returns the base path for these objects. (defined in Tailor\Classes\Blueprint)
- getClassExtension() - returns a behavior object from an extendable class, example:. (defined in October\Rain\Extension\Extendable)
- getClassMethodAsReflector() - (defined in October\Rain\Extension\Extendable)
- getClassMethods() - gets a list of class methods, extension equivalent of get_class_methods(). (defined in October\Rain\Extension\Extendable)
- getContentTableName() - (defined in Tailor\Classes\Blueprint)
- getDynamicProperties() - returns all dynamic properties and their values. (defined in October\Rain\Extension\Extendable)
- getEntryTypeOptions() - (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- getFilePath() - returns the absolute file path of an template. (defined in Tailor\Classes\Blueprint)
- getJoinTableName() - (defined in Tailor\Classes\Blueprint)
- getMessage() - looks up a custom message from the blueprint. (defined in Tailor\Classes\Blueprint)
- getMetaData() - returns meta data for the content schema table. (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- getMtimeByName() - (defined in Tailor\Classes\Blueprint)
- getMultisiteConfig() - requests configuration for the multisite implementation, such as. (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- getPermissionCodeName() - (defined in Tailor\Classes\Blueprint)
- getRepeaterTableName() - (defined in Tailor\Classes\Blueprint)
- hasMultipleEntryTypes() - (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- hydrate() - a collection of templates from plain arrays. (defined in Tailor\Classes\Blueprint)
- implementClassWith() - will implement an extension using non-interference and should. (defined in October\Rain\Extension\Extendable)
- inDatasource() - prepares the datasource for the model. (defined in Tailor\Classes\Blueprint)
- isClassExtendedWith() - checks if extendable class is extended with a behavior object. (defined in October\Rain\Extension\Extendable)
- isClassInstanceOf() - checks if the class implements the supplied interface methods. (defined in October\Rain\Extension\Extendable)
- isEntryEnabledByDefault() - (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- listInProject() - is a modified version to find any blueprints that inherit this one. (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- load() - the object from a file. (defined in Tailor\Classes\Blueprint)
- methodExists() - checks if a method exists, extension equivalent of method_exists(). (defined in October\Rain\Extension\Extendable)
- newCollection() - instance. (defined in Tailor\Classes\Blueprint)
- newFromIndexer() - creates a new instance from the indexer. (defined in Tailor\Classes\Blueprint)
- promoteToTypeClass() - (defined in Tailor\Classes\Blueprint)
- propertyExists() - checks if a property exists, extension equivalent of
property_exists(). (defined in October\Rain\Extension\Extendable) - save() - the object to the disk. (defined in Tailor\Classes\Blueprint)
- setDefaultDatasource() - (defined in Tailor\Classes\Blueprint)
- toArray() - converts this instance to an array. (defined in Tailor\Classes\Blueprint)
- useDrafts() - determines if this section should use drafts. (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- useMultisite() - (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- useMultisiteSync() - defaults to false. (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- usePageFinder() - in a specific context, either item or list. Defaults to true. (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- useVersions() - determines if this section should capture version history. (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- validate() - the blueprint. (defined in Tailor\Classes\Blueprint)
Protected Methods
Show inherited protected methods
Inherited Protected Methods
- boot() - is the "booting" method of the model. (defined in Tailor\Classes\Blueprint)
- bootDefaultPlugins() - (defined in Tailor\Classes\Blueprint)
- bootIfNotBooted() - checks if the model needs to be booted and if so, do it. (defined in Tailor\Classes\Blueprint)
- extendableIsAccessible() - checks if a property is accessible, property equivalent. (defined in October\Rain\Extension\Extendable)
- extendableIsSettingDynamicProperty() - returns true if a dynamic. (defined in October\Rain\Extension\Extendable)
- extensionExtractImplements() - will return classes to implement. (defined in October\Rain\Extension\Extendable)
- extensionExtractMethods() - extracts the available methods from a behavior and adds it. (defined in October\Rain\Extension\Extendable)
- getExtendableMethodFromDynamicMethods() - (defined in October\Rain\Extension\Extendable)
- getExtendableMethodFromExtensions() - (defined in October\Rain\Extension\Extendable)
- getInternal() - helps the get method. (defined in Tailor\Classes\Blueprint)
- getRelativePath() - returns path relative to the theme template directory. (defined in Tailor\Classes\Blueprint)
- invalidYamlParse() - (defined in Tailor\Classes\Blueprint)
- makeBlueprintTableName() - where type can be used for content, join or repeater. (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- validateFileName() - extension and path. (defined in Tailor\Classes\Blueprint)