core/model/modx/processors/element/tv/renders/mgr/input/richtext.class.php

Show: inherited
Table of Contents

Package
modx  
Subpackage
processors.element.tv.renders.mgr.input  

\modTemplateVarInputRenderRichText

Package: modx\processors\element\tv\renders\mgr\input

An abstract class for extending Input Renders for TVs.

Parent(s)
\modTemplateVarInputRender < \modTemplateVarRender

Properties

Propertypublicarray  $config= 'array()'
Default valuearray()Details
Type
array
Inherited_from
\modTemplateVarRender::$$config  
Inherited_from
\modTemplateVarInputRender::$$config  
Propertypublic\modX  $modx= ''
Details
Type
\modX
Inherited_from
\modTemplateVarRender::$$modx  
Inherited_from
\modTemplateVarInputRender::$$modx  
Propertypublic\modTemplateVar  $tv= ''
Details
Type
\modTemplateVar
Inherited_from
\modTemplateVarRender::$$tv  
Inherited_from
\modTemplateVarInputRender::$$tv  

Methods

methodpublic__construct(  $tv,  $config = array() ) : void
Parameters
Name Type Description
$tv
$config
methodprotected_loadLexiconTopics( ) : void
inherited

Load any specified lexicon topics for the render

Inherited from: \modTemplateVarRender::_loadLexiconTopics()\modTemplateVarInputRender::_loadLexiconTopics()
methodpublicgetInputOptions( ) : mixed
inherited

Return the input options parsed for the TV

Inherited from: \modTemplateVarInputRender::getInputOptions()
Returns
Type Description
mixed
methodpublicgetLexiconTopics( ) : array
inherited

Get any lexicon topics for your render. You may override this method in your render to provide an array of lexicon topics to load.

Inherited from: \modTemplateVarRender::getLexiconTopics()\modTemplateVarInputRender::getLexiconTopics()
Returns
Type Description
array
methodpublicgetTemplate( ) : string

Return the template path to load

Returns
Type Description
string
methodpublicprocess( string $value, array $params = array() ) : void | mixed

Parameters
Name Type Description
$value string
$params array
Returns
Type Description
void | mixed
methodpublicrender( string $value, array $params = array() ) : mixed | void
inherited

Render the TV render.

Inherited from: \modTemplateVarInputRender::render()
Parameters
Name Type Description
$value string
$params array
Returns
Type Description
mixed | void
methodpublicsetPlaceholder( string $k, mixed $v ) : void
inherited

Set a placeholder to be used in the template

Inherited from: \modTemplateVarInputRender::setPlaceholder()
Parameters
Name Type Description
$k string
$v mixed
Documentation was generated by DocBlox 0.18.1.