Maslosoft Staple API

Name: Staple
Brand: Maslosoft

Class Staple

Maslosoft\Staple\Staple implements Maslosoft\Staple\Interfaces\RequestAwareInterface uses Maslosoft\EmbeDi\Traits\FlyTrait (not available)

Namespace: Maslosoft\Staple
Located at Staple.php

Methods summary

`public`	# `__construct( string $rootPath = '' )` Parameters `$rootPath`
`public Maslosoft\Staple\Interfaces\PostProcessorInterface[]`	# `getPostProcessors( )` Get Post processors Get Post processors Returns `Maslosoft\Staple\Interfaces\PostProcessorInterface[]` Implementation of `Maslosoft\Staple\Interfaces\ProcessorAwareInterface::getPostProcessors()`
`public Maslosoft\Staple\Interfaces\PreProcessorInterface[]`	# `getPreProcessors( )` Get Pre Processors Get Pre Processors Returns `Maslosoft\Staple\Interfaces\PreProcessorInterface[]` Implementation of `Maslosoft\Staple\Interfaces\ProcessorAwareInterface::getPreProcessors()`
`public Maslosoft\Staple\Staple`	# `setRootPath( string $path )` Set absolute root path Set absolute root path Parameters `$path` Returns `Maslosoft\Staple\Staple`
`public string`	# `getRootPath( )` Get root path. Will try to autodetect if empty. Get root path. Will try to autodetect if empty. Returns string Implementation of `Maslosoft\Staple\Interfaces\RendererAwareInterface::getRootPath()`
`public`	# `getContentPath( $absolute = false )` Implementation of `Maslosoft\Staple\Interfaces\RendererAwareInterface::getContentPath()`
`public`	# `setContentPath( $contentPath )`
`public`	# `getLayoutPath( )` Implementation of `Maslosoft\Staple\Interfaces\RendererAwareInterface::getLayoutPath()`
`public`	# `setLayoutPath( $layoutPath )` Implementation of `Maslosoft\Staple\Interfaces\RendererAwareInterface::setLayoutPath()`
`public string`	# `getVersion( )` Get current staple version Get current staple version Returns string
`public Maslosoft\Staple\Interfaces\RendererInterface`	# `getRenderer( string $fileName )` Get renderer Get renderer Parameters `$fileName` Returns `Maslosoft\Staple\Interfaces\RendererInterface` Implementation of `Maslosoft\Staple\Interfaces\RendererAwareInterface::getRenderer()`
`public string[]`	# `getExtensions( )` Get supported file extensions, based on `renderers` configuration. Get supported file extensions, based on `renderers` configuration. Returns string[] Implementation of `Maslosoft\Staple\Interfaces\RequestAwareInterface::getExtensions()`
`public string`	# `handle( Maslosoft\Staple\Interfaces\RequestInterface $request )` Handle request. This is entry point for staple. Handle request. This is entry point for staple. Parameters `$request` Returns string

Magic methods summary

`public Maslosoft\Staple\Staple`	# `fly( )` Get staple flyweight instance Get staple flyweight instance Returns `Maslosoft\Staple\Staple`

Constants summary

`string`	`DefaultInstanceId`	# `'.'`
`string`	`BootstrapName`	# `'_bootstrap.php'`
`string`	`ContentPath`	# `'_content'`
`string`	`LayoutPath`	# `'_layout'`

Properties summary

`public mixed[]`	`$renderers` Renderers configuration. Keys are file extensions, values are renderers class name or configuration supported by EmbeDi. Renderers configuration. Keys are file extensions, values are renderers class name or configuration supported by EmbeDi. For available configuration options see renderer class. Example configuration: public $renderers = [ 'php' => PhpRenderer::class, 'php.md' => PhpMdRenderer::class, 'md' => [ 'class' => MdRenderer::class, 'extension' => 'mkd' ], 'html' => [ 'class' => HtmlRenderer::class, 'extension' => 'htm' ], ];	# `[ 'php' => PhpRenderer::class, 'mkd.php' => PhpMdRenderer::class, 'md.php' => PhpMdRenderer::class, 'mkd' => MdRenderer::class, 'md' => MdRenderer::class, 'html' => HtmlRenderer::class, 'thumb.jpg' => ThumbRenderer::class, 'thumb.gif' => ThumbRenderer::class, 'thumb.png' => ThumbRenderer::class, 'jpg' => PassThroughRenderer::class, 'gif' => PassThroughRenderer::class, 'png' => PassThroughRenderer::class, 'svg' => PassThroughRenderer::class, 'pdf' => PassThroughRenderer::class, ]`
`public array`	`$preProcessors`	# `[ DataJsonExtractor::class, CascadingDataJsonExtractor::class, ViewJsonExtractor::class, TagExtractor::class ]`
`public array`	`$postProcessors`	# `[ TemplateApplier::class ]`

API documentation generated by ApiGen

Maslosoft Staple API

Namespaces

Classes

Class Staple

Methods summary

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Returns

Implementation of

Implementation of

Implementation of

Implementation of

Returns

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Magic methods summary

Returns

Constants summary

Properties summary

Contact us