core/model/modx/processors/resource/updatefromgrid.class.php
inherited
Classes
- Package
- modx
- \$data
A JSON array of data to update from.
- Subpackage
- processors.resource
\modResourceUpdateFromGridProcessor
Updates a resource.
{@inheritdoc}
- Parent(s)
- \modResourceUpdateProcessor < \modObjectUpdateProcessor < \modObjectProcessor < \modProcessor
- modResourceUpdateFromGridProcessor
- \$data
A JSON array of data to update from.
Properties
string
$afterSaveEvent= ''OnDocFormSave''
'OnDocFormSave'Details- Type
- string
string
$beforeSaveEvent= ''OnBeforeDocFormSave''
'OnBeforeDocFormSave'Details- Type
- string
$checkSavePermission= 'true'
trueDetails- Type
- n/a
- Inherited_from
- \modObjectUpdateProcessor::$$checkSavePermission
- Inherited_from
- \modResourceUpdateProcessor::$$checkSavePermission
string
$classKey= ''modResource''
'modResource'Details- Type
- string
boolean
$isSiteStart= 'false'
falseDetails- Type
- boolean
- Inherited_from
- \modResourceUpdateProcessor::$$isSiteStart
array
$languageTopics= 'array('resource')'
array('resource')Details- Type
- array
\modX
$modx= 'null'
A reference to the modX object.
Inherited from: \modProcessor::$$modx\modObjectProcessor::$$modx\modObjectUpdateProcessor::$$modx\modResourceUpdateProcessor::$$modxnullDetails- Type
- \modX
- Inherited_from
- \modProcessor::$$modx
- Inherited_from
- \modObjectProcessor::$$modx
- Inherited_from
- \modObjectUpdateProcessor::$$modx
- Inherited_from
- \modResourceUpdateProcessor::$$modx
\modResource
$newParent= ''
- Type
- \modResource
- Inherited_from
- \modResourceUpdateProcessor::$$newParent
string
$objectType= ''resource''
'resource'Details- Type
- string
\modContext
$oldContext= ''
- Type
- \modContext
- Inherited_from
- \modResourceUpdateProcessor::$$oldContext
\modResource
$oldParent= ''
- Type
- \modResource
- Inherited_from
- \modResourceUpdateProcessor::$$oldParent
\modResource
$parentResource= ''
- Type
- \modResource
- Inherited_from
- \modResourceUpdateProcessor::$$parentResource
string
$path= ''''
The absolute path to this processor
Inherited from: \modProcessor::$$path\modObjectProcessor::$$path\modObjectUpdateProcessor::$$path\modResourceUpdateProcessor::$$path''Details- Type
- string
- Inherited_from
- \modProcessor::$$path
- Inherited_from
- \modObjectProcessor::$$path
- Inherited_from
- \modObjectUpdateProcessor::$$path
- Inherited_from
- \modResourceUpdateProcessor::$$path
string
$permission= ''save_document''
'save_document'Details- Type
- string
string
$primaryKeyField= ''id''
'id'Details- Type
- string
- Inherited_from
- \modObjectProcessor::$$primaryKeyField
- Inherited_from
- \modObjectUpdateProcessor::$$primaryKeyField
- Inherited_from
- \modResourceUpdateProcessor::$$primaryKeyField
array
$properties= 'array()'
The array of properties being passed to this processor
Inherited from: \modProcessor::$$properties\modObjectProcessor::$$properties\modObjectUpdateProcessor::$$properties\modResourceUpdateProcessor::$$propertiesarray()Details- Type
- array
- Inherited_from
- \modProcessor::$$properties
- Inherited_from
- \modObjectProcessor::$$properties
- Inherited_from
- \modObjectUpdateProcessor::$$properties
- Inherited_from
- \modResourceUpdateProcessor::$$properties
string
$resourceClass= ''
- Type
- string
- Inherited_from
- \modResourceUpdateProcessor::$$resourceClass
boolean
$resourceDeleted= 'false'
falseDetails- Type
- boolean
- Inherited_from
- \modResourceUpdateProcessor::$$resourceDeleted
boolean
$resourceUnDeleted= 'false'
falseDetails- Type
- boolean
- Inherited_from
- \modResourceUpdateProcessor::$$resourceUnDeleted
\modTemplate
$template= ''
- Type
- \modTemplate
- Inherited_from
- \modResourceUpdateProcessor::$$template
\modContext
$workingContext= ''
- Type
- \modContext
- Inherited_from
- \modResourceUpdateProcessor::$$workingContext
Methods
__construct(
\modX $modx, array $properties
=
array()
)
:
voidCreates a modProcessor object.
Inherited from: \modProcessor::__construct()\modObjectProcessor::__construct()\modObjectUpdateProcessor::__construct()\modResourceUpdateProcessor::__construct()| Name | Type | Description |
|---|---|---|
| $modx | \modX | A reference to the modX instance |
| $properties | array | An array of properties |
_decodeLiterals(
string $string
)
:
stringDecodes strings encoded by _encodeLiterals to restore JavaScript literals.
Inherited from: \modProcessor::_decodeLiterals()\modObjectProcessor::_decodeLiterals()\modObjectUpdateProcessor::_decodeLiterals()\modResourceUpdateProcessor::_decodeLiterals()| Name | Type | Description |
|---|---|---|
| $string | string | The JSON-encoded string with encoded literals. |
| Type | Description |
|---|---|
| string | The JSON-encoded string with literals restored. |
- Access
- protected
_encodeLiterals(
mixed $value, integer | string $key
)
:
voidEncodes certain JavaScript literal strings for later decoding.
Inherited from: \modProcessor::_encodeLiterals()\modObjectProcessor::_encodeLiterals()\modObjectUpdateProcessor::_encodeLiterals()\modResourceUpdateProcessor::_encodeLiterals()| 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. |
- Access
- protected
addFieldError(
string $key, string $message
=
''
)
:
mixedAdd an error to the field
Inherited from: \modProcessor::addFieldError()\modObjectProcessor::addFieldError()\modObjectUpdateProcessor::addFieldError()\modResourceUpdateProcessor::addFieldError()| Name | Type | Description |
|---|---|---|
| $key | string | |
| $message | string |
| Type | Description |
|---|---|
| mixed |
addLock(
)
:
booleanAdd a lock to the resource we are saving
Inherited from: \modResourceUpdateProcessor::addLock()| Type | Description |
|---|---|
| boolean |
afterSave(
)
:
booleanOverride in your derivative class to do functionality after save() is run
Inherited from: \modResourceUpdateProcessor::afterSave()| Type | Description |
|---|---|
| boolean |
beforeSave(
)
:
booleanOverride in your derivative class to do functionality before save() is run
Inherited from: \modResourceUpdateProcessor::beforeSave()| Type | Description |
|---|---|
| boolean |
beforeSet(
)
:
boolean | stringOverride in your derivative class to do functionality before the fields are set on the object
Inherited from: \modResourceUpdateProcessor::beforeSet()| Type | Description |
|---|---|
| boolean | string |
checkContextOfChildren(
)
:
voidReassign context for children if changed on main Resource
Inherited from: \modResourceUpdateProcessor::checkContextOfChildren()checkDeletedStatus(
)
:
booleanCheck deleted status and ensure user has permissions to delete resource
Inherited from: \modResourceUpdateProcessor::checkDeletedStatus()| Type | Description |
|---|---|
| boolean |
checkForUnPublishOnSiteStart(
)
:
booleanCheck to prevent unpublishing of site_start
Inherited from: \modResourceUpdateProcessor::checkForUnPublishOnSiteStart()| Type | Description |
|---|---|
| boolean |
checkFriendlyAlias(
)
:
mixed | stringFriendly URL alias checks
Inherited from: \modResourceUpdateProcessor::checkFriendlyAlias()| Type | Description |
|---|---|
| mixed | string |
checkParentContext(
)
:
mixedIf parent is changed, set context to new parent's context
Inherited from: \modResourceUpdateProcessor::checkParentContext()| Type | Description |
|---|---|
| mixed |
checkPermissions(
)
:
booleanReturn true here to allow access to this processor.
Inherited from: \modObjectProcessor::checkPermissions()\modObjectUpdateProcessor::checkPermissions()\modResourceUpdateProcessor::checkPermissions()| Type | Description |
|---|---|
| boolean |
checkPublishedOn(
)
:
intSet publishedon date if publish change is different
Inherited from: \modResourceUpdateProcessor::checkPublishedOn()| Type | Description |
|---|---|
| int |
checkPublishingPermissions(
)
:
booleanDeny publishing if the user does not have access to
Inherited from: \modResourceUpdateProcessor::checkPublishingPermissions()| Type | Description |
|---|---|
| boolean |
cleanup(
)
:
arrayCleanup the processor and return the resulting object
Inherited from: \modResourceUpdateProcessor::cleanup()| Type | Description |
|---|---|
| array |
clearCache(
)
:
voidEmpty site cache if specified to do so
Inherited from: \modResourceUpdateProcessor::clearCache()failure(
string $msg
=
'', mixed $object
=
null
)
:
array | stringReturn a failure message from the processor.
Inherited from: \modProcessor::failure()\modObjectProcessor::failure()\modObjectUpdateProcessor::failure()\modResourceUpdateProcessor::failure()| Name | Type | Description |
|---|---|---|
| $msg | string | |
| $object | mixed |
| Type | Description |
|---|---|
| array | string |
fireAfterSaveEvent(
)
:
voidFire the after save event
Inherited from: \modObjectUpdateProcessor::fireAfterSaveEvent()\modResourceUpdateProcessor::fireAfterSaveEvent()fireBeforeSaveEvent(
)
:
booleanFire before save event. Return true to prevent saving.
Inherited from: \modObjectUpdateProcessor::fireBeforeSaveEvent()\modResourceUpdateProcessor::fireBeforeSaveEvent()| Type | Description |
|---|---|
| boolean |
fireDeleteEvent(
)
:
nullFire Delete event if resource was deleted
Inherited from: \modResourceUpdateProcessor::fireDeleteEvent()| Type | Description |
|---|---|
| null |
fireUnDeleteEvent(
)
:
mixedFire UnDelete event if resource was undeleted
Inherited from: \modResourceUpdateProcessor::fireUnDeleteEvent()| Type | Description |
|---|---|
| mixed |
fixParents(
)
:
voidSet the parents isfolder status based upon remaining children
Inherited from: \modResourceUpdateProcessor::fixParents()- TODO
- Debate whether or not this should be default functionality
getInstance(
\modX $modx, string $className, array $properties
=
array()
)
:
\modProcessorAllow for Resources to use derivative classes for their processors
Inherited from: \modResourceUpdateProcessor::getInstance()| Name | Type | Description |
|---|---|---|
| $modx | \modX | |
| $className | string | |
| $properties | array |
| Type | Description |
|---|---|
| \modProcessor |
- Static
getLanguageTopics(
)
:
arrayLoad a collection of Language Topics for this processor.
Inherited from: \modObjectProcessor::getLanguageTopics()\modObjectUpdateProcessor::getLanguageTopics()\modResourceUpdateProcessor::getLanguageTopics()Override this in your derivative class to provide the array of topics to load.
| Type | Description |
|---|---|
| array |
getProperties(
)
:
arrayGet an array of properties for this processor
Inherited from: \modProcessor::getProperties()\modObjectProcessor::getProperties()\modObjectUpdateProcessor::getProperties()\modResourceUpdateProcessor::getProperties()| Type | Description |
|---|---|
| array |
getProperty(
string $k, mixed $default
=
null
)
:
mixedGet a specific property.
Inherited from: \modProcessor::getProperty()\modObjectProcessor::getProperty()\modObjectUpdateProcessor::getProperty()\modResourceUpdateProcessor::getProperty()| Name | Type | Description |
|---|---|---|
| $k | string | |
| $default | mixed |
| Type | Description |
|---|---|
| mixed |
handleCheckBoxes(
)
:
voidHandle formatting of various checkbox fields
Inherited from: \modResourceUpdateProcessor::handleCheckBoxes()handleParent(
)
:
int | mixedHandle the parent field, checking for veracity
Inherited from: \modResourceUpdateProcessor::handleParent()| Type | Description |
|---|---|
| int | mixed |
hasErrors(
)
:
booleanReturn whether or not the processor has errors
Inherited from: \modProcessor::hasErrors()\modObjectProcessor::hasErrors()\modObjectUpdateProcessor::hasErrors()\modResourceUpdateProcessor::hasErrors()| Type | Description |
|---|---|
| boolean |
initialize(
)
:
booleanCan 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.
| Type | Description |
|---|---|
| boolean |
logManagerAction(
)
:
voidLog the removal manager action
Inherited from: \modObjectUpdateProcessor::logManagerAction()\modResourceUpdateProcessor::logManagerAction()outputArray(
array $array, mixed $count
=
false
)
:
stringReturn arrays of objects (with count) converted to JSON.
Inherited from: \modProcessor::outputArray()\modObjectProcessor::outputArray()\modObjectUpdateProcessor::outputArray()\modResourceUpdateProcessor::outputArray()The JSON result includes two main elements, total and results. This format is used for list results.
| Name | Type | Description |
|---|---|---|
| $array | array | An array of data objects. |
| $count | mixed | The total number of objects. Used for pagination. |
| Type | Description |
|---|---|
| string | The JSON output. |
- Access
- public
process(
)
:
mixedRun the processor and return the result. Override this in your derivative class to provide custom functionality.
Inherited from: \modObjectUpdateProcessor::process()\modResourceUpdateProcessor::process()Used here for pre-2.2-style processors.
| Type | Description |
|---|---|
| mixed |
processEventResponse(
array | string $response, string $separator
=
"\n"
)
:
stringProcesses a response from a Plugin Event invocation
Inherited from: \modProcessor::processEventResponse()\modObjectProcessor::processEventResponse()\modObjectUpdateProcessor::processEventResponse()\modResourceUpdateProcessor::processEventResponse()| Name | Type | Description |
|---|---|---|
| $response | array | string | The response generated by the invokeEvent call |
| $separator | string | The separator for each event response |
| Type | Description |
|---|---|
| string | The processed response. |
run(
)
:
\modProcessorResponseRun the processor, returning a modProcessorResponse object.
Inherited from: \modProcessor::run()\modObjectProcessor::run()\modObjectUpdateProcessor::run()\modResourceUpdateProcessor::run()| Type | Description |
|---|---|
| \modProcessorResponse |
saveObject(
)
:
booleanAbstract the saving of the object out to allow for transient and non-persistent object updating in derivative classes
Inherited from: \modObjectUpdateProcessor::saveObject()\modResourceUpdateProcessor::saveObject()| Type | Description |
|---|---|
| boolean |
saveTemplateVariables(
)
:
array | mixedSet any Template Variables passed to the Resource. You must pass "tvs" as 1 or true to initiate these checks.
Inherited from: \modResourceUpdateProcessor::saveTemplateVariables()| Type | Description |
|---|---|
| array | mixed |
setCheckbox(
string $k, boolean $force
=
false
)
:
int | nullSpecial 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()\modObjectProcessor::setCheckbox()\modObjectUpdateProcessor::setCheckbox()\modResourceUpdateProcessor::setCheckbox()| Name | Type | Description |
|---|---|---|
| $k | string | |
| $force | boolean |
| Type | Description |
|---|---|
| int | null |
setDefaultProperties(
array $properties
=
array()
)
:
arraySets default properties that only are set if they don't already exist in the request
Inherited from: \modProcessor::setDefaultProperties()\modObjectProcessor::setDefaultProperties()\modObjectUpdateProcessor::setDefaultProperties()\modResourceUpdateProcessor::setDefaultProperties()| Name | Type | Description |
|---|---|---|
| $properties | array |
| Type | Description |
|---|---|
| array | The newly merged properties array |
setPath(
string $path
)
:
voidSet the path of the processor
Inherited from: \modProcessor::setPath()\modObjectProcessor::setPath()\modObjectUpdateProcessor::setPath()\modResourceUpdateProcessor::setPath()| Name | Type | Description |
|---|---|---|
| $path | string | The absolute path |
setProperties(
array $properties
)
:
voidSet the runtime properties for the processor
Inherited from: \modProcessor::setProperties()\modObjectProcessor::setProperties()\modObjectUpdateProcessor::setProperties()\modResourceUpdateProcessor::setProperties()| Name | Type | Description |
|---|---|---|
| $properties | array | The properties, in array and key-value form, to run on this processor |
setProperty(
string $k, mixed $v
)
:
voidSet a property value
Inherited from: \modProcessor::setProperty()\modObjectProcessor::setProperty()\modObjectUpdateProcessor::setProperty()\modResourceUpdateProcessor::setProperty()| Name | Type | Description |
|---|---|---|
| $k | string | |
| $v | mixed |
setPublishDate(
)
:
intFormat the pub_date if it is set and adjust contingencies
Inherited from: \modResourceUpdateProcessor::setPublishDate()| Type | Description |
|---|---|
| int |
setResourceGroups(
)
:
mixedIf specified, set the Resource Groups attached to the Resource
Inherited from: \modResourceUpdateProcessor::setResourceGroups()| Type | Description |
|---|---|
| mixed |
setUnPublishDate(
)
:
int | mixedFormat the unpub_date if it is set and adjust contingencies
Inherited from: \modResourceUpdateProcessor::setUnPublishDate()| Type | Description |
|---|---|
| int | mixed |
success(
string $msg
=
'', mixed $object
=
null
)
:
array | stringReturn a success message from the processor.
Inherited from: \modProcessor::success()\modObjectProcessor::success()\modObjectUpdateProcessor::success()\modResourceUpdateProcessor::success()| Name | Type | Description |
|---|---|---|
| $msg | string | |
| $object | mixed |
| Type | Description |
|---|---|
| array | string |
toJSON(
mixed $data
)
:
stringConverts PHP to JSON with JavaScript literals left in-tact.
Inherited from: \modProcessor::toJSON()\modObjectProcessor::toJSON()\modObjectUpdateProcessor::toJSON()\modResourceUpdateProcessor::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.
| Name | Type | Description |
|---|---|---|
| $data | mixed | The PHP data to be converted. |
| Type | Description |
|---|---|
| string | The extended JSON-encoded string. |
- Access
- public
trimPageTitle(
)
:
string
| Type | Description |
|---|---|
| string |
unsetProperty(
string $key
)
:
voidCompletely unset a property from the properties array
Inherited from: \modProcessor::unsetProperty()\modObjectProcessor::unsetProperty()\modObjectUpdateProcessor::unsetProperty()\modResourceUpdateProcessor::unsetProperty()| Name | Type | Description |
|---|---|---|
| $key | string |