core/model/modx/processors/element/tv/renders/getinputproperties.class.php

Show:

inherited

Classes
- \TvInputPropertiesManagerController
- \modTvRendersGetPropertiesProcessor

Table of Contents

Grabs a list of input properties for a TV type

Package: modx
$context: string
(optional) The context by which to grab renders from. Defaults to executing context.
$type: string
(optional) The type of render to grab properties for. Defaults to default.
$tv: integer
(optional) The TV to prefill property values from.
Subpackage: processors.element.tv.renders

\TvInputPropertiesManagerController
jump to top

Package: Default

Faux controller class for rendering TV input properties

Parent(s): \modManagerController

Properties

array
                 $config= 'array()'

inherited

A configuration array of options related to this controller's action object.Inherited from: \modManagerController::$$config

Default valuearray()Details

Type: array
Inherited_from: \modManagerController::$$config

string
                 $content= ''''

inherited

The current output contentInherited from: \modManagerController::$$content

Default value''Details

Type: string
Inherited_from: \modManagerController::$$content

array
                 $controllersPaths= ''

inherited

An array of possible paths to this controller's directory.Inherited from: \modManagerController::$$controllersPaths

Details

Type: array
Inherited_from: \modManagerController::$$controllersPaths

\modMediaSource
                 $defaultSource= ''

inherited

The default media source for the userInherited from: \modManagerController::$$defaultSource

Details

Type: \modMediaSource
Inherited_from: \modManagerController::$$defaultSource

string
                 $failureMessage= ''''

inherited

The failure message, if existent, for this controller.Inherited from: \modManagerController::$$failureMessage

Default value''Details

Type: string
Inherited_from: \modManagerController::$$failureMessage

array
                 $head= 'array('css' => array(),'js' => array(),'html' => array(),'lastjs' => array())'

inherited

An array of css/js/html to load into the HEAD of the pageInherited from: \modManagerController::$$head

Default valuearray('css' => array(),'js' => array(),'html' => array(),'lastjs' => array())Details

Type: array
Inherited_from: \modManagerController::$$head

bool
                 $isFailure= 'false'

inherited

Whether or not a failure message was sent by this controller.Inherited from: \modManagerController::$$isFailure

Default valuefalseDetails

Type: bool
Inherited_from: \modManagerController::$$isFailure

bool
                 $loadBaseJavascript= 'true'

inherited

Set to false to prevent loading of the base MODExt JS classes.Inherited from: \modManagerController::$$loadBaseJavascript

Default valuetrueDetails

Type: bool
Inherited_from: \modManagerController::$$loadBaseJavascript

bool
                 $loadFooter= 'false'

Set to false to prevent loading of the footer HTML.

Default valuefalseDetails

Type: bool

bool
                 $loadHeader= 'false'

Set to false to prevent loading of the header HTML.

Default valuefalseDetails

Type: bool

\modX
                 $modx= ''

inherited

A reference to the modX objectInherited from: \modManagerController::$$modx

Details

Type: \modX
Inherited_from: \modManagerController::$$modx

array
                 $placeholders= 'array()'

inherited

An array of placeholders that are being set to the pageInherited from: \modManagerController::$$placeholders

Default valuearray()Details

Type: array
Inherited_from: \modManagerController::$$placeholders

string
                 $ruleOutput= 'array()'

inherited

Any Form Customization rule output that was created.Inherited from: \modManagerController::$$ruleOutput

Default valuearray()Details

Type: string
Inherited_from: \modManagerController::$$ruleOutput

array
                 $scriptProperties= 'array()'

inherited

An array of request parameters sent to the controllerInherited from: \modManagerController::$$scriptProperties

Default valuearray()Details

Type: array
Inherited_from: \modManagerController::$$scriptProperties

array
                 $templatesPaths= 'array()'

inherited

An array of possible paths to this controller's templates directory.Inherited from: \modManagerController::$$templatesPaths

Default valuearray()Details

Type: array
Inherited_from: \modManagerController::$$templatesPaths

string
                 $theme= ''default''

inherited

The current manager theme.Inherited from: \modManagerController::$$theme

Default value'default'Details

Type: string
Inherited_from: \modManagerController::$$theme

string
                 $title= ''''

inherited

The pagetitle for this controller.Inherited from: \modManagerController::$$title

Default value''Details

Type: string
Inherited_from: \modManagerController::$$title

\modContext
                 $workingContext= ''

inherited

The current working context.Inherited from: \modManagerController::$$workingContext

Details

Type: \modContext
Inherited_from: \modManagerController::$$workingContext

Methods

__construct(
          \modX $modx, array $config
              =
              array()
          )
        
        :
          void

inherited

The constructor for the modManaagerController class.

Inherited from: \modManagerController::__construct()

Parameters

Name	Type	Description
$modx	\modX	A reference to the modX object.
$config	array	A configuration array of options related to this controller's action object.

_postfixVersionToScript(
          string $str, string $version
          )
        
        :
          string

inherited

Appends a version postfix to a script tag

Inherited from: \modManagerController::_postfixVersionToScript()

Parameters

Name	Type	Description
$str	string	The script tag to append the version to
$version	string	The version to append

Returns

Type	Description
string	The adjusted script tag

Details

Access: private

_prepareHead(
          
          )
        
        :
          void

inherited

Prepare the set html/css/js to be added

Inherited from: \modManagerController::_prepareHead()

_prepareVersionPostfix(
          
          )
        
        :
          string

inherited

Grabs a stripped version of modx to prevent caching of JS after upgrades

Inherited from: \modManagerController::_prepareVersionPostfix()

Returns

Type	Description
string	The parsed version string

Details

Access: private

addCss(
          string $script
          )
        
        :
          void

inherited

Add a external CSS file to the head of the page

Inherited from: \modManagerController::addCss()

Parameters

Name	Type	Description
$script	string

addHtml(
          string $script
          )
        
        :
          void

inherited

Add a block of HTML to the head of the page

Inherited from: \modManagerController::addHtml()

Parameters

Name	Type	Description
$script	string

addJavascript(
          string $script
          )
        
        :
          void

inherited

Add an external Javascript file to the head of the page

Inherited from: \modManagerController::addJavascript()

Parameters

Name	Type	Description
$script	string

addLastJavascript(
          string $script
          )
        
        :
          void

inherited

Add an external Javascript file to the head of the page

Inherited from: \modManagerController::addLastJavascript()

Parameters

Name	Type	Description
$script	string

addLexiconTopic(
          string $topic
          )
        
        :
          string

inherited

Adds a topic to the JS language array

Inherited from: \modManagerController::addLexiconTopic()

Parameters

Name	Type	Description
$topic	string

Returns

Type	Description
string

assignPlaceholders(
          
          )
        
        :
          void

inherited

Inherited from: \modManagerController::assignPlaceholders()

checkFormCustomizationRules(
          \xPDOObject $obj
              =
              null, bool $forParent
              =
              false
          )
        
        :
          bool

inherited

Checks Form Customization rules for an object.

Inherited from: \modManagerController::checkFormCustomizationRules()

Parameters

Name	Type	Description
$obj	\xPDOObject	If passed, will validate against for rules with constraints.
$forParent	bool

Returns

Type	Description
bool

checkPermissions(
          
          )
        
        :
          boolean

Do permission checking in this method. Returning false will present a "permission denied" message.

Returns

Type	Description
boolean

failure(
          string $message
          )
        
        :
          void

inherited

Set a failure on this controller. This will return the error message.

Inherited from: \modManagerController::failure()

Parameters

Name	Type	Description
$message	string

fetchTemplate(
          string $tpl
          )
        
        :
          string

inherited

Fetch the template content

Inherited from: \modManagerController::fetchTemplate()

Parameters

Name	Type	Description
$tpl	string	The path to the template

Returns

Type	Description
string	The output of the template

firePostRenderEvents(
          
          )
        
        :
          void

inherited

Can be used to fire events after all the CSS/JS is loaded for a page

Inherited from: \modManagerController::firePostRenderEvents()

firePreRenderEvents(
          
          )
        
        :
          void

inherited

Fire any pre-render events for the controller

Inherited from: \modManagerController::firePreRenderEvents()

getControllersPaths(
          bool $coreOnly
              =
              false
          )
        
        :
          array

inherited

Get the path to this controller's directory. Override this to point to a custom directory.

Inherited from: \modManagerController::getControllersPaths()

Parameters

Name	Type	Description
$coreOnly	bool	Ensure that it grabs the path from the core namespace only.

Returns

Type	Description
array

getDefaultState(
          
          )
        
        :
          array | mixed | string

inherited

Get the default state for the UI

Inherited from: \modManagerController::getDefaultState()

Returns

Type	Description
array \| mixed \| string

getFooter(
          
          )
        
        :
          string

inherited

Get the page footer for the controller.

Inherited from: \modManagerController::getFooter()

Returns

Type	Description
string

getHeader(
          
          )
        
        :
          string

inherited

Get the page header for the controller.

Inherited from: \modManagerController::getHeader()

Returns

Type	Description
string

getInstance(
          \modX $modx, string $className, array $config
              =
              array()
          )
        
        :
          \The

staticinherited

Return the proper instance of the derived class. This can be used to override how the manager loads a controller class; for example, when handling derivative classes with class_key settings.

Inherited from: \modManagerController::getInstance()

Parameters

Name	Type	Description
$modx	\modX	A reference to the modX object.
$className	string	The name of the class that is being requested.
$config	array	A configuration array of options related to this controller's action object.

Returns

Type	Description
\The	class specified by $className

Details

Static

getLanguageTopics(
          
          )
        
        :
          array

Specify an array of language topics to load for this controller

Returns

Type	Description
array

getPageTitle(
          
          )
        
        :
          string

Return a string to set as the controller's page title.

Returns

Type	Description
string

getPlaceholder(
          string $k, mixed $default
              =
              null
          )
        
        :
          mixed

inherited

Get a specific placeholder set

Inherited from: \modManagerController::getPlaceholder()

Parameters

Name	Type	Description
$k	string
$default	mixed

Returns

Type	Description
mixed

getPlaceholders(
          
          )
        
        :
          array

inherited

Get all the set placeholders

Inherited from: \modManagerController::getPlaceholders()

Returns

Type	Description
array

getTemplateFile(
          
          )
        
        :
          string

Return the relative path to the template file to load

Returns

Type	Description
string

getTemplatesPaths(
          bool $coreOnly
              =
              false
          )
        
        :
          array | string

inherited

Get an array of possible paths to this controller's template's directory.

Inherited from: \modManagerController::getTemplatesPaths()

Override this to point to a custom directory.

Parameters

Name	Type	Description
$coreOnly	bool	Ensure that it grabs the path from the core namespace only.

Returns

Type	Description
array \| string

initialize(
          
          )
        
        :
          void

inherited

Can be used to provide custom methods prior to processing

Inherited from: \modManagerController::initialize()

loadController(
           $controller, bool $coreOnly
              =
              false
          )
        
        :
          mixed | string

inherited

Load another manual controller file (such as header/footer)

Inherited from: \modManagerController::loadController()

Parameters

Name	Type	Description
$controller
$coreOnly	bool

Returns

Type	Description
mixed \| string

loadControllersPath(
          
          )
        
        :
          array

inherited

Load an array of possible paths to this controller's directory. Only override this if you want to override default behavior; otherwise, overriding getControllersPath is preferred.

Inherited from: \modManagerController::loadControllersPath()

Returns

Type	Description
array

loadCustomCssJs(
          
          )
        
        :
          void

loadTemplatesPath(
          
          )
        
        :
          string

inherited

Load the path to this controller's template's directory. Only override this if you want to override default behavior; otherwise, overriding getTemplatesPath is preferred.

Inherited from: \modManagerController::loadTemplatesPath()

Returns

Type	Description
string

loadWorkingContext(
          
          )
        
        :
          \modContext | string

inherited

Load the working context for this controller.

Inherited from: \modManagerController::loadWorkingContext()

Returns

Type	Description
\modContext \| string

prepareLanguage(
          
          )
        
        :
          void

inherited

Prepares the language placeholders

Inherited from: \modManagerController::prepareLanguage()

process(
          array $scriptProperties
              =
              array()
          )
        
        :
          mixed

Process the controller, returning an array of placeholders to set.

Parameters

Name	Type	Description
$scriptProperties	array	A array of REQUEST parameters.

Returns

Type	Description
mixed	Either an error or output string, or an array of placeholders to set.

registerBaseScripts(
          
          )
        
        :
          void

inherited

Registers the core and base JS scripts

Inherited from: \modManagerController::registerBaseScripts()

Details

Access: public

registerCssJs(
          
          )
        
        :
          void

inherited

Registers CSS/JS to manager interface

Inherited from: \modManagerController::registerCssJs()

render(
          
          )
        
        :
          string

inherited

Render the controller.

Inherited from: \modManagerController::render()

Returns

Type	Description
string

setPlaceholder(
          string $k, mixed $v
          )
        
        :
          void

inherited

Set a placeholder for this controller's template

Inherited from: \modManagerController::setPlaceholder()

Parameters

Name	Type	Description
$k	string	The key of the placeholder
$v	mixed	The value of the placeholder

setPlaceholders(
          array $keys
          )
        
        :
          void

inherited

Set an array of placeholders

Inherited from: \modManagerController::setPlaceholders()

Parameters

Name	Type	Description
$keys	array

setProperties(
          array $properties
          )
        
        :
          void

inherited

Sets the properties array for this controller

Inherited from: \modManagerController::setProperties()

Parameters

Name	Type	Description
$properties	array

setProperty(
          string $key, mixed $value
          )
        
        :
          void

inherited

Set a property for this controller

Inherited from: \modManagerController::setProperty()

Parameters

Name	Type	Description
$key	string
$value	mixed

setTemplatePaths(
          array $paths
          )
        
        :
          void

inherited

Set the possible template paths for this controller

Inherited from: \modManagerController::setTemplatePaths()

Parameters

Name	Type	Description
$paths	array

\modTvRendersGetPropertiesProcessor
jump to top

Package: modx\processors\element\tv\renders

Grabs a list of input properties for a TV type

{@inheritdoc}

Parent(s): \modProcessor
$context: string
(optional) The context by which to grab renders from. Defaults to executing context.
$type: string
(optional) The type of render to grab properties for. Defaults to default.
$tv: integer
(optional) The TV to prefill property values from.

Properties

\modX
                 $modx= 'null'

inherited

A reference to the modX object.

Inherited from: \modProcessor::$$modx

Default valuenullDetails

Type: \modX
Inherited_from: \modProcessor::$$modx

string
                 $path= ''''

inherited

The absolute path to this processor

Inherited from: \modProcessor::$$path

Default value''Details

Type: string
Inherited_from: \modProcessor::$$path

array
                 $properties= 'array()'

inherited

The array of properties being passed to this processor

Inherited from: \modProcessor::$$properties

Default valuearray()Details

Type: array
Inherited_from: \modProcessor::$$properties

Methods

__construct(
          \modX $modx, array $properties
              =
              array()
          )
        
        :
          void

inherited

Creates a modProcessor object.

Inherited from: \modProcessor::__construct()

Parameters

Name	Type	Description
$modx	\modX	A reference to the modX instance
$properties	array	An array of properties

_decodeLiterals(
          string $string
          )
        
        :
          string

inherited

Decodes strings encoded by _encodeLiterals to restore JavaScript literals.

Inherited from: \modProcessor::_decodeLiterals()

Parameters

Name	Type	Description
$string	string	The JSON-encoded string with encoded literals.

Returns

Type	Description
string	The JSON-encoded string with literals restored.

Details

Access: protected

_encodeLiterals(
          mixed $value, integer | string $key
          )
        
        :
          void

inherited

Encodes certain JavaScript literal strings for later decoding.

Inherited from: \modProcessor::_encodeLiterals()

Parameters

Name	Type	Description
$value	mixed	&$value A reference to the value to be encoded if it is identified as a literal.
$key	integer \| string	The array key corresponding to the value.

Details

Access: protected

addFieldError(
          string $key, string $message
              =
              ''
          )
        
        :
          mixed

inherited

Add an error to the field

Inherited from: \modProcessor::addFieldError()

Parameters

Name	Type	Description
$key	string
$message	string

Returns

Type	Description
mixed

checkPermissions(
          
          )
        
        :
          boolean

Return true here to allow access to this processor.

Returns

Type	Description
boolean

failure(
          string $msg
              =
              '', mixed $object
              =
              null
          )
        
        :
          array | string

inherited

Return a failure message from the processor.

Inherited from: \modProcessor::failure()

Parameters

Name	Type	Description
$msg	string
$object	mixed

Returns

Type	Description
array \| string

getInputProperties(
          
          )
        
        :
          array

Get default display properties for specific tv

Returns

Type	Description
array

getInstance(
          \modX $modx, string $className, array $properties
              =
              array()
          )
        
        :
          \The

staticinherited

Return the proper instance of the derived class. This can be used to override how MODX loads a processor class; for example, when handling derivative classes with class_key settings.

Inherited from: \modProcessor::getInstance()

Parameters

Name	Type	Description
$modx	\modX	A reference to the modX object.
$className	string	The name of the class that is being requested.
$properties	array	An array of properties being run with the processor

Returns

Type	Description
\The	class specified by $className

Details

Static

getLanguageTopics(
          
          )
        
        :
          array

Load a collection of Language Topics for this processor.

Override this in your derivative class to provide the array of topics to load.

Returns

Type	Description
array

getProperties(
          
          )
        
        :
          array

inherited

Get an array of properties for this processor

Inherited from: \modProcessor::getProperties()

Returns

Type	Description
array

getProperty(
          string $k, mixed $default
              =
              null
          )
        
        :
          mixed

inherited

Get a specific property.

Inherited from: \modProcessor::getProperty()

Parameters

Name	Type	Description
$k	string
$default	mixed

Returns

Type	Description
mixed

getRenderDirectories(
          
          )
        
        :
          array

Returns

Type	Description
array

getRenderOutput(
          array $renderDirectories
          )
        
        :
          mixed | string

Get the properties render output when given an array of directories to search

Parameters

Name	Type	Description
$renderDirectories	array

Returns

Type	Description
mixed \| string

hasErrors(
          
          )
        
        :
          boolean

inherited

Return whether or not the processor has errors

Inherited from: \modProcessor::hasErrors()

Returns

Type	Description
boolean

initialize(
          
          )
        
        :
          boolean

Can be used to provide custom methods prior to processing. Return true to tell MODX that the Processor initialized successfully. If you return anything else, MODX will output that return value as an error message.

Returns

Type	Description
boolean

outputArray(
          array $array, mixed $count
              =
              false
          )
        
        :
          string

inherited

Return arrays of objects (with count) converted to JSON.

Inherited from: \modProcessor::outputArray()

The JSON result includes two main elements, total and results. This format is used for list results.

Parameters

Name	Type	Description
$array	array	An array of data objects.
$count	mixed	The total number of objects. Used for pagination.

Returns

Type	Description
string	The JSON output.

Details

Access: public

process(
          
          )
        
        :
          mixed

Run the processor and return the result. Override this in your derivative class to provide custom functionality.

Used here for pre-2.2-style processors.

Returns

Type	Description
mixed

processEventResponse(
          array | string $response, string $separator
              =
              "\n"
          )
        
        :
          string

inherited

Processes a response from a Plugin Event invocation

Inherited from: \modProcessor::processEventResponse()

Parameters

Name	Type	Description
$response	array \| string	The response generated by the invokeEvent call
$separator	string	The separator for each event response

Returns

Type	Description
string	The processed response.

renderController(
          
          )
        
        :
          string

Simulate controller with the faux controller class

Returns

Type	Description
string

run(
          
          )
        
        :
          \modProcessorResponse

inherited

Run the processor, returning a modProcessorResponse object.

Inherited from: \modProcessor::run()

Returns

Type	Description
\modProcessorResponse

setCheckbox(
          string $k, boolean $force
              =
              false
          )
        
        :
          int | null

inherited

Special helper method for handling checkboxes. Only set value if passed or $force is true, and check for a not empty value or string 'false'.

Inherited from: \modProcessor::setCheckbox()

Parameters

Name	Type	Description
$k	string
$force	boolean

Returns

Type	Description
int \| null

setDefaultProperties(
          array $properties
              =
              array()
          )
        
        :
          array

inherited

Sets default properties that only are set if they don't already exist in the request

Inherited from: \modProcessor::setDefaultProperties()

Parameters

Name	Type	Description
$properties	array

Returns

Type	Description
array	The newly merged properties array

setPath(
          string $path
          )
        
        :
          void

inherited

Set the path of the processor

Inherited from: \modProcessor::setPath()

Parameters

Name	Type	Description
$path	string	The absolute path

setProperties(
          array $properties
          )
        
        :
          void

inherited

Set the runtime properties for the processor

Inherited from: \modProcessor::setProperties()

Parameters

Name	Type	Description
$properties	array	The properties, in array and key-value form, to run on this processor

setProperty(
          string $k, mixed $v
          )
        
        :
          void

inherited

Set a property value

Inherited from: \modProcessor::setProperty()

Parameters

Name	Type	Description
$k	string
$v	mixed

success(
          string $msg
              =
              '', mixed $object
              =
              null
          )
        
        :
          array | string

inherited

Return a success message from the processor.

Inherited from: \modProcessor::success()

Parameters

Name	Type	Description
$msg	string
$object	mixed

Returns

Type	Description
array \| string

toJSON(
          mixed $data
          )
        
        :
          string

inherited

Converts PHP to JSON with JavaScript literals left in-tact.

Inherited from: \modProcessor::toJSON()

JSON does not allow JavaScript literals, but this function encodes certain identifiable literals and decodes them back into literals after modX::toJSON() formats the data.

Parameters

Name	Type	Description
$data	mixed	The PHP data to be converted.

Returns

Type	Description
string	The extended JSON-encoded string.

Details

Access: public

unsetProperty(
          string $key
          )
        
        :
          void

inherited

Completely unset a property from the properties array

Inherited from: \modProcessor::unsetProperty()

Parameters

Name	Type	Description
$key	string

core/model/modx/processors/element/tv/renders/getinputproperties.class.php

\TvInputPropertiesManagerControllerjump to top

Properties

Methods

\modTvRendersGetPropertiesProcessorjump to top

Properties

Methods

\TvInputPropertiesManagerController
jump to top

\modTvRendersGetPropertiesProcessor
jump to top