• Home
• RainLab
• Pages
• Classes
• Snippet

PHP Class RainLab\Pages\Classes\Snippet

Show file Open project: rainlab/pages-plugin Class Usage Examples

Public Properties

Property	Type	Description
$code		Specifies the snippet code.

Protected Properties

Property	Type	Description
$componentClass		Snippet component class name.
$componentObj		Snippet component object.
$description		Specifies the snippet description.
$name		Specifies the snippet name.
$pageSnippetMap		Internal cache of snippet declarations defined on a page.
$properties		Snippet properties.

Public Methods

Method	Description
__construct ( )
clearMapCache ( Cms\Classes\Theme $theme )	Clears the snippet map item cache
extendPartialForm ( $formWidget )	Extends the partial form with Snippet fields.
getComponentClass ( ) : string	Returns the snippet component class name.
getDescription ( ) : string	Returns the snippet description.
getName ( ) : string	Returns the snippet name.
getProperties ( )	Returns the snippet property list as array, in format compatible with Inspector.
initFromComponentInfo ( string $componentClass, string $componentCode )	Initializes the snippet from a CMS component information.
initFromPartial ( $partial )	Initializes the snippet from a CMS partial.
listPageComponents ( string $pageName, Cms\Classes\Theme $theme, $markup ) : array	Returns a list of component definitions declared on the page.
processPageMarkup ( string $pageName, Cms\Classes\Theme $theme, string $markup ) : string	Parses the static page markup and renders snippets defined on the page.
processTemplateSettings ( $template )
processTemplateSettingsArray ( $settingsArray )

Protected Methods

Method	Description
dropDownOptionsToArray ( $optionsString )
dropDownOptionsToString ( $optionsArray )
extractSnippetsFromMarkup ( $markup, $theme )
extractSnippetsFromMarkupCached ( $theme, $pageName, $markup )
getComponent ( ) : Cms\Classes\ComponentBase	Returns a component corresponding to the snippet.
getMapCacheKey ( $theme )	Returns a cache key for this record.
parseIniProperties ( $properties ) : array	Converts a keyed object to an array, converting the index to the "property" value.
preprocessPropertyValues ( $theme, $snippetCode, $componentClass, $properties )	Apples default property values and fixes property names.

Method Details

Property Details