core/model/modx/processors/element/tv/renders/mgr/input/file.class.php
Show:
inherited
inherited
Classes
- Package
- modx
- Subpackage
- processors.element.tv.renders.mgr.input
- \modX
- \modTemplateVar
- array
\modTemplateVarInputRenderFile
Package: modx\processors\element\tv\renders\mgr\input
An abstract class for extending Input Renders for TVs.
- Parent(s)
- \modTemplateVarInputRender < \modTemplateVarRender
- \modX
- \modTemplateVar
- array
Properties
array
$config= 'array()'
Default value
array()Details- Type
- array
- Inherited_from
- \modTemplateVarRender::$$config
- Inherited_from
- \modTemplateVarInputRender::$$config
\modX
$modx= ''
Details
- Type
- \modX
- Inherited_from
- \modTemplateVarRender::$$modx
- Inherited_from
- \modTemplateVarInputRender::$$modx
\modTemplateVar
$tv= ''
Details
- Type
- \modTemplateVar
- Inherited_from
- \modTemplateVarRender::$$tv
- Inherited_from
- \modTemplateVarInputRender::$$tv
Methods
__construct(
$tv, $config
=
array()
)
:
void
inherited
Inherited from:
\modTemplateVarRender::__construct()\modTemplateVarInputRender::__construct()
Parameters
| Name | Type | Description |
|---|---|---|
| $tv | ||
| $config |
_loadLexiconTopics(
)
:
void
inherited
Load any specified lexicon topics for the render
Inherited from: \modTemplateVarRender::_loadLexiconTopics()\modTemplateVarInputRender::_loadLexiconTopics()getInputOptions(
)
:
mixed
inherited
Return the input options parsed for the TV
Inherited from: \modTemplateVarInputRender::getInputOptions()
Returns
| Type | Description |
|---|---|
| mixed |
getLexiconTopics(
)
:
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 |
getTemplate(
)
:
stringReturn the template path to load
Returns
| Type | Description |
|---|---|
| string |
process(
string $value, array $params
=
array()
)
:
void | mixed
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string | |
| $params | array |
| Type | Description |
|---|---|
| void | mixed |
render(
string $value, array $params
=
array()
)
:
mixed | void
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string | |
| $params | array |
| Type | Description |
|---|---|
| mixed | void |
setPlaceholder(
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 |