Tailor\Classes\Blueprint\SubmissionBlueprint
Overview
SubmissionBlueprint for user-submitted content with approval workflow
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)
- $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)
- $datasource - is the data source for the model, a directory path. (defined in Tailor\Classes\Blueprint)
- $datasourceTheme - is the theme directory name, used to filter blueprints. (defined in Tailor\Classes\Blueprint)
- $resolvedPlugins - (defined in Tailor\Classes\Blueprint)
- $resolvedActiveTheme - (defined in Tailor\Classes\Blueprint)
- $resolvedThemes - (defined in Tailor\Classes\Blueprint)
Public Methods
public getModelClassName()
public getModelClassName(): void
public getNotifyGroup()
public getNotifyGroup(): string|null
getNotifyGroup returns the admin user group code to notify, null disables notifications
public getNotifyReplyTo()
public getNotifyReplyTo(): string
getNotifyReplyTo returns the field name used as the reply-to address
public getNotifyTemplate()
public getNotifyTemplate(): string
getNotifyTemplate returns the mail template used for the notification
public getPurgeRejectedDays()
public getPurgeRejectedDays(): int
getPurgeRejectedDays returns days to keep rejected submissions, zero disables purging
public getSpamSweepDays()
public getSpamSweepDays(): int
getSpamSweepDays returns the lookback window for rejecting spam by IP, zero disables the sweep
public getTitleTemplate()
public getTitleTemplate(): string|null
getTitleTemplate returns a Twig template used to build the record title
public isEntryEnabledByDefault()
public isEntryEnabledByDefault(): bool
isEntryEnabledByDefault returns false since submissions arrive as pending
public useDrafts()
public useDrafts(): bool
useDrafts returns false since submissions don't use drafts
public usePageFinder()
public usePageFinder($context = 'item'): void
usePageFinder returns false since submissions are not linkable pages
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) - blessBlueprint() - promotes a blueprint class to its specific type, for example, (defined in Tailor\Classes\Blueprint)
- clearExtendedClasses() - (defined in October\Rain\Extension\Extendable)
- createDirectory() - creates a directory under a parent path within the. (defined in Tailor\Classes\Blueprint)
- databaseLayerEnabled() - returns true when DB-layered blueprints should be. (defined in Tailor\Classes\Blueprint)
- delete() - template. When the resolved datasource has the database layer. (defined in Tailor\Classes\Blueprint)
- deletePaths() - removes the given list of files or directories under the. (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. When the resolved datasource. (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)
- getDatasourceTheme() - (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() - returns the last modified time using the same resolution. (defined in Tailor\Classes\Blueprint)
- getMultisiteConfig() - requests configuration for the multisite implementation, such as. (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- getNavigationCodeName() - (defined in Tailor\Classes\Blueprint)
- getPageFinderReplacements() - getPageReplacements returns the replacements to be included when resolving the page. (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- getPermissionCodeName() - returns the permission code, which can be customized with the. (defined in Tailor\Classes\Blueprint)
- getPermissionsOption() - returns an option from the permissions blueprint property. (defined in Tailor\Classes\Blueprint)
- getPluginDatasources() - returns the blueprint directories provided by plugins, keyed by plugin code. (defined in Tailor\Classes\Blueprint)
- getRepeaterTableName() - (defined in Tailor\Classes\Blueprint)
- getSourceIdentifier() - returns the cms_source_files source identifier for. (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)
- 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)
- move() - relocates a list of files or directories into a destination. (defined in Tailor\Classes\Blueprint)
- newCollection() - instance. (defined in Tailor\Classes\Blueprint)
- newFromIndexer() - creates a new instance from the indexer. (defined in Tailor\Classes\Blueprint)
- newModelInstance() - returns a new instance of the model associated with this blueprint. (defined in Tailor\Classes\Blueprint)
- propertyExists() - checks if a property exists, extension equivalent of
property_exists(). (defined in October\Rain\Extension\Extendable) - rename() - renames a single file or directory within the blueprints root. (defined in Tailor\Classes\Blueprint)
- resetDatasourceCache() - clears the memoized datasource discovery results, (defined in Tailor\Classes\Blueprint)
- save() - the object to the disk, or to the cms_source_files table when the. (defined in Tailor\Classes\Blueprint)
- setDefaultDatasource() - (defined in Tailor\Classes\Blueprint)
- toArray() - converts this instance to an array. (defined in Tailor\Classes\Blueprint)
- upload() - accepts a single uploaded file into a destination directory. (defined in Tailor\Classes\Blueprint)
- useMultisite() - (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- useMultisiteSync() - defaults to false. (defined in Tailor\Classes\Blueprint\EntryBlueprint)
- useSoftDeletes() - determines if this section should use soft deletion. (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
- assertNoDatabaseCollision() - throws when the target path is already. (defined in Tailor\Classes\Blueprint)
- boot() - is the "booting" method of the model. (defined in Tailor\Classes\Blueprint)
- bootIfNotBooted() - checks if the model needs to be booted and if so, do it. (defined in Tailor\Classes\Blueprint)
- deletePathsWithDatabase() - deletes against the database layer. (defined in Tailor\Classes\Blueprint)
- extendableIsAccessible() - checks if a property is accessible, property equivalent. (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)
- getActiveThemeCodes() - returns the active theme code with its parent theme code, if any. (defined in Tailor\Classes\Blueprint)
- getDefaultActiveTheme() - returns the active theme and its parent as datasources, (defined in Tailor\Classes\Blueprint)
- getDefaultPlugins() - (defined in Tailor\Classes\Blueprint)
- getDefaultThemes() - returns all non-active themes as datasources. (defined in Tailor\Classes\Blueprint)
- getExtendableMethodFromDynamicMethods() - (defined in October\Rain\Extension\Extendable)
- getExtendableMethodFromExtensions() - (defined in October\Rain\Extension\Extendable)
- getInternal() - helps the get method. When the resolved datasource has the. (defined in Tailor\Classes\Blueprint)
- getOperationExtensions() - returns allowed extensions for upload/rename. (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)
- moveWithDatabase() - relocates files and directories against the database layer. (defined in Tailor\Classes\Blueprint)
- normalizeOperationPath() - produces the canonical relative path used as the. (defined in Tailor\Classes\Blueprint)
- renameWithDatabase() - performs a rename against the database layer. (defined in Tailor\Classes\Blueprint)
- resolvePluginCodeForDatasource() - walks the registered plugin paths to. (defined in Tailor\Classes\Blueprint)
- rewriteRowPathPrefixes() - moves every row, including tombstones, from the old. (defined in Tailor\Classes\Blueprint)
- saveToDatabase() - upserts the current content into a SourceFile row for. (defined in Tailor\Classes\Blueprint)
- themeHasDbBlueprints() - returns true when the theme has its database layer. (defined in Tailor\Classes\Blueprint)
- validateFileName() - extension and path. (defined in Tailor\Classes\Blueprint)
- validateOperationFileExtension() - checks a filename against the allowed. (defined in Tailor\Classes\Blueprint)
- validateOperationName() - ensures a single file or directory name contains. (defined in Tailor\Classes\Blueprint)
- validateOperationPath() - ensures a relative path does not escape the. (defined in Tailor\Classes\Blueprint)