core/model/modx/processors/resource/updatefromgrid.class.php

Show: inherited
Table of Contents

Package
modx  
\$data

A JSON array of data to update from.

Subpackage
processors.resource  

\modResourceUpdateFromGridProcessor

Package: modx\processors\resource

Updates a resource.

{@inheritdoc}

Parent(s)
\modResourceUpdateProcessor < \modObjectUpdateProcessor < \modObjectProcessor < \modProcessor
modResourceUpdateFromGridProcessor
\$data

A JSON array of data to update from.

Properties

Propertypublicstring  $afterSaveEvent= ''OnDocFormSave''

The name of the event to fire after saving
Default value'OnDocFormSave'Details
Type
string
Propertypublicstring  $beforeSaveEvent= ''OnBeforeDocFormSave''

The name of the event to fire before saving
Default value'OnBeforeDocFormSave'Details
Type
string
Propertypublicstring  $classKey= ''modResource''

The class key of the Object to iterate
Default value'modResource'Details
Type
string
Propertypublicboolean  $isSiteStart= 'false'
Default valuefalseDetails
Type
boolean
Inherited_from
\modResourceUpdateProcessor::$$isSiteStart  
Propertypublicarray  $languageTopics= 'array('resource')'

An array of language topics to load
Default valuearray('resource')Details
Type
array
Propertypublic\modUser  $lockedUser= ''

Details
Type
\modUser
Propertypublic\modX  $modx= 'null'
Default valuenullDetails
Type
\modX
Inherited_from
\modProcessor::$$modx  
Inherited_from
\modObjectProcessor::$$modx  
Inherited_from
\modObjectUpdateProcessor::$$modx  
Inherited_from
\modResourceUpdateProcessor::$$modx  
Propertypublic\modResource  $newParent= ''
inherited

Inherited from: \modResourceUpdateProcessor::$$newParent
Propertypublic\modResource  $object= ''

Details
Type
\modResource
Propertypublicstring  $objectType= ''resource''

The object "type", this will be used in various lexicon error strings
Default value'resource'Details
Type
string
Propertypublic\modContext  $oldContext= ''
Propertypublic\modResource  $oldParent= ''
inherited

Inherited from: \modResourceUpdateProcessor::$$oldParent
Propertypublic\modResource  $parentResource= ''
Propertypublicstring  $path= ''''
Default value''Details
Type
string
Inherited_from
\modProcessor::$$path  
Inherited_from
\modObjectProcessor::$$path  
Inherited_from
\modObjectUpdateProcessor::$$path  
Inherited_from
\modResourceUpdateProcessor::$$path  
Propertypublicstring  $permission= ''save_document''

The Permission to use when checking against
Default value'save_document'Details
Type
string
Propertypublicstring  $primaryKeyField= ''id''
Default value'id'Details
Type
string
Inherited_from
\modObjectProcessor::$$primaryKeyField  
Inherited_from
\modObjectUpdateProcessor::$$primaryKeyField  
Inherited_from
\modResourceUpdateProcessor::$$primaryKeyField  
Propertypublicarray  $properties= 'array()'
Default valuearray()Details
Type
array
Inherited_from
\modProcessor::$$properties  
Inherited_from
\modObjectProcessor::$$properties  
Inherited_from
\modObjectUpdateProcessor::$$properties  
Inherited_from
\modResourceUpdateProcessor::$$properties  
Propertypublicstring  $resourceClass= ''
Details
Type
string
Inherited_from
\modResourceUpdateProcessor::$$resourceClass  
Propertypublicboolean  $resourceDeleted= 'false'
Default valuefalseDetails
Type
boolean
Inherited_from
\modResourceUpdateProcessor::$$resourceDeleted  
Propertypublicboolean  $resourceUnDeleted= 'false'
Default valuefalseDetails
Type
boolean
Inherited_from
\modResourceUpdateProcessor::$$resourceUnDeleted  
Propertypublic\modTemplate  $template= ''
inherited

Inherited from: \modResourceUpdateProcessor::$$template
Details
Type
\modTemplate
Inherited_from
\modResourceUpdateProcessor::$$template  
Propertypublic\modContext  $workingContext= ''

Methods

methodpublic__construct( \modX $modx, array $properties = array() ) : void
Parameters
Name Type Description
$modx \modX

A reference to the modX instance

$properties array

An array of properties

methodprotected_decodeLiterals( string $string ) : string
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  
methodprotected_encodeLiterals( mixed $value, integer | string $key ) : void
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  
methodpublicaddFieldError( string $key, string $message = '' ) : mixed
Parameters
Name Type Description
$key string
$message string
Returns
Type Description
mixed
methodpublicaddLock( ) : boolean
inherited

Add a lock to the resource we are saving

Inherited from: \modResourceUpdateProcessor::addLock()
Returns
Type Description
boolean
methodpublicafterSave( ) : boolean
inherited

Override in your derivative class to do functionality after save() is run

Inherited from: \modResourceUpdateProcessor::afterSave()
Returns
Type Description
boolean
methodpublicbeforeSave( ) : boolean
inherited

Override in your derivative class to do functionality before save() is run

Inherited from: \modResourceUpdateProcessor::beforeSave()
Returns
Type Description
boolean
methodpublicbeforeSet( ) : boolean | string
inherited

Override in your derivative class to do functionality before the fields are set on the object

Inherited from: \modResourceUpdateProcessor::beforeSet()
Returns
Type Description
boolean | string
methodpubliccheckContextOfChildren( ) : void
inherited

Reassign context for children if changed on main Resource

Inherited from: \modResourceUpdateProcessor::checkContextOfChildren()
methodpubliccheckDeletedStatus( ) : boolean
inherited

Check deleted status and ensure user has permissions to delete resource

Inherited from: \modResourceUpdateProcessor::checkDeletedStatus()
Returns
Type Description
boolean
methodpubliccheckForUnPublishOnSiteStart( ) : boolean
inherited

Check to prevent unpublishing of site_start

Inherited from: \modResourceUpdateProcessor::checkForUnPublishOnSiteStart()
Returns
Type Description
boolean
methodpubliccheckFriendlyAlias( ) : mixed | string
inherited

Friendly URL alias checks

Inherited from: \modResourceUpdateProcessor::checkFriendlyAlias()
Returns
Type Description
mixed | string
methodpubliccheckParentContext( ) : mixed
inherited

If parent is changed, set context to new parent's context

Inherited from: \modResourceUpdateProcessor::checkParentContext()
Returns
Type Description
mixed
methodpubliccheckPermissions( ) : boolean
Returns
Type Description
boolean
methodpubliccheckPublishedOn( ) : int
inherited

Set publishedon date if publish change is different

Inherited from: \modResourceUpdateProcessor::checkPublishedOn()
Returns
Type Description
int
methodpubliccheckPublishingPermissions( ) : boolean
inherited

Deny publishing if the user does not have access to

Inherited from: \modResourceUpdateProcessor::checkPublishingPermissions()
Returns
Type Description
boolean
methodpubliccleanup( ) : array
inherited

Cleanup the processor and return the resulting object

Inherited from: \modResourceUpdateProcessor::cleanup()
Returns
Type Description
array
methodpublicclearCache( ) : void
inherited

Empty site cache if specified to do so

Inherited from: \modResourceUpdateProcessor::clearCache()
methodpublicfailure( string $msg = '', mixed $object = null ) : array | string
Parameters
Name Type Description
$msg string
$object mixed
Returns
Type Description
array | string
methodpublicfireAfterSaveEvent( ) : void
methodpublicfireBeforeSaveEvent( ) : boolean
inherited

Fire before save event. Return true to prevent saving.

Inherited from: \modObjectUpdateProcessor::fireBeforeSaveEvent()\modResourceUpdateProcessor::fireBeforeSaveEvent()
Returns
Type Description
boolean
methodpublicfireDeleteEvent( ) : null
inherited

Fire Delete event if resource was deleted

Inherited from: \modResourceUpdateProcessor::fireDeleteEvent()
Returns
Type Description
null
methodpublicfireUnDeleteEvent( ) : mixed
inherited

Fire UnDelete event if resource was undeleted

Inherited from: \modResourceUpdateProcessor::fireUnDeleteEvent()
Returns
Type Description
mixed
methodpublicfixParents( ) : void
inherited

Set the parents isfolder status based upon remaining children

Inherited from: \modResourceUpdateProcessor::fixParents()
Details
TODO
Debate whether or not this should be default functionality  
methodpublicgetInstance( \modX $modx, string $className, array $properties = array() ) : \modProcessor
staticinherited

Allow for Resources to use derivative classes for their processors

Inherited from: \modResourceUpdateProcessor::getInstance()
Parameters
Name Type Description
$modx \modX
$className string
$properties array
Returns
Type Description
\modProcessor
Details
Static
 
methodpublicgetLanguageTopics( ) : array

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

Returns
Type Description
array
methodpublicgetProperties( ) : array
Returns
Type Description
array
methodpublicgetProperty( string $k, mixed $default = null ) : mixed
Parameters
Name Type Description
$k string
$default mixed
Returns
Type Description
mixed
methodpublichandleCheckBoxes( ) : void
inherited

Handle formatting of various checkbox fields

Inherited from: \modResourceUpdateProcessor::handleCheckBoxes()
methodpublichandleParent( ) : int | mixed
inherited

Handle the parent field, checking for veracity

Inherited from: \modResourceUpdateProcessor::handleParent()
Returns
Type Description
int | mixed
methodpublichasErrors( ) : boolean
Returns
Type Description
boolean
methodpublicinitialize( ) : 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
methodpubliclogManagerAction( ) : void
methodpublicoutputArray( array $array, mixed $count = false ) : string

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  
methodpublicprocess( ) : mixed
inherited

Run 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.

Returns
Type Description
mixed
methodpublicprocessEventResponse( array | string $response, string $separator = "\n" ) : string
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.
methodpublicrun( ) : \modProcessorResponse
inherited

Run the processor, returning a modProcessorResponse object.

Inherited from: \modProcessor::run()\modObjectProcessor::run()\modObjectUpdateProcessor::run()\modResourceUpdateProcessor::run()
Returns
Type Description
\modProcessorResponse
methodpublicsaveObject( ) : boolean
inherited

Abstract the saving of the object out to allow for transient and non-persistent object updating in derivative classes

Inherited from: \modObjectUpdateProcessor::saveObject()\modResourceUpdateProcessor::saveObject()
Returns
Type Description
boolean
methodpublicsaveTemplateVariables( ) : array | mixed
inherited

Set any Template Variables passed to the Resource. You must pass "tvs" as 1 or true to initiate these checks.

Inherited from: \modResourceUpdateProcessor::saveTemplateVariables()
Returns
Type Description
array | mixed
methodpublicsetCheckbox( 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()\modObjectProcessor::setCheckbox()\modObjectUpdateProcessor::setCheckbox()\modResourceUpdateProcessor::setCheckbox()
Parameters
Name Type Description
$k string
$force boolean
Returns
Type Description
int | null
methodpublicsetDefaultProperties( array $properties = array() ) : array
Parameters
Name Type Description
$properties array
Returns
Type Description
array The newly merged properties array
methodpublicsetPath( string $path ) : void
Parameters
Name Type Description
$path string

The absolute path

methodpublicsetProperties( array $properties ) : void
Parameters
Name Type Description
$properties array

The properties, in array and key-value form, to run on this processor

methodpublicsetProperty( string $k, mixed $v ) : void
Parameters
Name Type Description
$k string
$v mixed
methodpublicsetPublishDate( ) : int
inherited

Format the pub_date if it is set and adjust contingencies

Inherited from: \modResourceUpdateProcessor::setPublishDate()
Returns
Type Description
int
methodpublicsetResourceGroups( ) : mixed
inherited

If specified, set the Resource Groups attached to the Resource

Inherited from: \modResourceUpdateProcessor::setResourceGroups()
Returns
Type Description
mixed
methodpublicsetUnPublishDate( ) : int | mixed
inherited

Format the unpub_date if it is set and adjust contingencies

Inherited from: \modResourceUpdateProcessor::setUnPublishDate()
Returns
Type Description
int | mixed
methodpublicsuccess( string $msg = '', mixed $object = null ) : array | string
Parameters
Name Type Description
$msg string
$object mixed
Returns
Type Description
array | string
methodpublictoJSON( mixed $data ) : string
inherited

Converts 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.

Parameters
Name Type Description
$data mixed

The PHP data to be converted.

Returns
Type Description
string The extended JSON-encoded string.
Details
Access
public  
methodpublictrimPageTitle( ) : string
inherited

Trim the page title

Inherited from: \modResourceUpdateProcessor::trimPageTitle()
Returns
Type Description
string
methodpublicunsetProperty( string $key ) : void
Parameters
Name Type Description
$key string
Documentation was generated by DocBlox 0.18.1.