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

Show:

inherited

Classes
- \modResourceUpdateProcessor

Table of Contents

Updates a resource.

Package: modx
$pagetitle: string
The page title.
$content: string
The HTML content. Used in conjunction with $ta.
$template: integer
(optional) The modTemplate to use with this resource. Defaults to 0, or a blank template.
$parent: integer
(optional) The parent resource ID. Defaults to 0.
$class_key: string
(optional) The class key. Defaults to modDocument.
$menuindex: integer
(optional) The menu order. Defaults to 0.
$variablesmodified: string
(optional) A collection of modified TVs. Along with $tv1, $tv2, etc.
$context_key: string
(optional) The context in which this resource is located. Defaults to web.
$alias: string
(optional) The alias for FURLs that this resource is designated to.
$content_type: integer
(optional) The content type. Defaults to text/html.
$published: boolean
(optional) The published status.
$pub_date: string
(optional) The date on which this resource should become published.
$unpub_date: string
(optional) The date on which this resource should become unpublished.
$publishedon: string
(optional) The date this resource was published. Defaults to time()
$publishedby: integer
(optional) The modUser who published this resource. Defaults to the current user.
$resource_groups: \json
(optional) A JSON array of resource groups to assign this resource to.
$hidemenu: boolean
(optional) If true, The resource will not show up in menu builders.
$isfolder: boolean
(optional) Whether or not the resource is a container of resources.
$richtext: boolean
(optional) If true, MODX will render the available RTE for editing this resource.
$donthit: boolean
(optional) (deprecated) If true, MODX will not log visits on this resource.
$cacheable: boolean
(optional) If false, the resource will not be cached.
$searchable: boolean
(optional) If false, the resource will not appear in searches.
$syncsite: boolean
(optional) If false, will not empty the cache on save.
Subpackage: processors.resource

\modResourceUpdateProcessor
jump to top

Package: modx\processors\resource

Updates a resource.

{@inheritdoc}

Parent(s): \modObjectUpdateProcessor < \modObjectProcessor < \modProcessor
Children: \modResourceUpdateFromGridProcessor
$pagetitle: string
The page title.
$content: string
The HTML content. Used in conjunction with $ta.
$template: integer
(optional) The modTemplate to use with this resource. Defaults to 0, or a blank template.
$parent: integer
(optional) The parent resource ID. Defaults to 0.
$class_key: string
(optional) The class key. Defaults to modDocument.
$menuindex: integer
(optional) The menu order. Defaults to 0.
$variablesmodified: string
(optional) A collection of modified TVs. Along with $tv1, $tv2, etc.
$context_key: string
(optional) The context in which this resource is located. Defaults to web.
$alias: string
(optional) The alias for FURLs that this resource is designated to.
$content_type: integer
(optional) The content type. Defaults to text/html.
$published: boolean
(optional) The published status.
$pub_date: string
(optional) The date on which this resource should become published.
$unpub_date: string
(optional) The date on which this resource should become unpublished.
$publishedon: string
(optional) The date this resource was published. Defaults to time()
$publishedby: integer
(optional) The modUser who published this resource. Defaults to the current user.
$resource_groups: \json
(optional) A JSON array of resource groups to assign this resource to.
$hidemenu: boolean
(optional) If true, The resource will not show up in menu builders.
$isfolder: boolean
(optional) Whether or not the resource is a container of resources.
$richtext: boolean
(optional) If true, MODX will render the available RTE for editing this resource.
$donthit: boolean
(optional) (deprecated) If true, MODX will not log visits on this resource.
$cacheable: boolean
(optional) If false, the resource will not be cached.
$searchable: boolean
(optional) If false, the resource will not appear in searches.
$syncsite: boolean
(optional) If false, will not empty the cache on save.

Properties

string
                 $afterSaveEvent= ''OnDocFormSave''

The name of the event to fire after saving

Default value'OnDocFormSave'Details

Type: string

string
                 $beforeSaveEvent= ''OnBeforeDocFormSave''

The name of the event to fire before saving

Default value'OnBeforeDocFormSave'Details

Type: string


                 $checkSavePermission= 'true'

inheritedInherited from: \modObjectUpdateProcessor::$$checkSavePermission

Default valuetrueDetails

Type: n/a
Inherited_from: \modObjectUpdateProcessor::$$checkSavePermission

string
                 $classKey= ''modResource''

The class key of the Object to iterate

Default value'modResource'Details

Type: string

boolean
                 $isSiteStart= 'false'

Default valuefalseDetails

Type: boolean

array
                 $languageTopics= 'array('resource')'

An array of language topics to load

Default valuearray('resource')Details

Type: array

\modUser
                 $lockedUser= ''

Details

Type: \modUser

\modX
                 $modx= 'null'

inherited

A reference to the modX object.

Inherited from: \modProcessor::$$modx \modObjectProcessor::$$modx \modObjectUpdateProcessor::$$modx

Default valuenullDetails

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

\modResource
                 $newParent= ''

Details

Type: \modResource

\modResource
                 $object= ''

Details

Type: \modResource

string
                 $objectType= ''resource''

The object "type", this will be used in various lexicon error strings

Default value'resource'Details

Type: string

\modContext
                 $oldContext= ''

Details

Type: \modContext

\modResource
                 $oldParent= ''

Details

Type: \modResource

\modResource
                 $parentResource= ''

Details

Type: \modResource

string
                 $path= ''''

inherited

The absolute path to this processor

Inherited from: \modProcessor::$$path \modObjectProcessor::$$path \modObjectUpdateProcessor::$$path

Default value''Details

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

string
                 $permission= ''save_document''

The Permission to use when checking against

Default value'save_document'Details

Type: string

string
                 $primaryKeyField= ''id''

inheritedThe primary key field to grab the object by

Inherited from: \modObjectProcessor::$$primaryKeyField \modObjectUpdateProcessor::$$primaryKeyField

Default value'id'Details

Type: string
Inherited_from: \modObjectProcessor::$$primaryKeyField
Inherited_from: \modObjectUpdateProcessor::$$primaryKeyField

array
                 $properties= 'array()'

inherited

The array of properties being passed to this processor

Inherited from: \modProcessor::$$properties \modObjectProcessor::$$properties \modObjectUpdateProcessor::$$properties

Default valuearray()Details

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

string
                 $resourceClass= ''

Details

Type: string

boolean
                 $resourceDeleted= 'false'

Default valuefalseDetails

Type: boolean

boolean
                 $resourceUnDeleted= 'false'

Default valuefalseDetails

Type: boolean

\modTemplate
                 $template= ''

Details

Type: \modTemplate

\modContext
                 $workingContext= ''

Details

Type: \modContext

Methods

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

inherited

Creates a modProcessor object.

Inherited from: \modProcessor::__construct()\modObjectProcessor::__construct()\modObjectUpdateProcessor::__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()\modObjectProcessor::_decodeLiterals()\modObjectUpdateProcessor::_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()\modObjectProcessor::_encodeLiterals()\modObjectUpdateProcessor::_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()\modObjectProcessor::addFieldError()\modObjectUpdateProcessor::addFieldError()

Parameters

Name	Type	Description
$key	string
$message	string

Returns

Type	Description
mixed

addLock(
          
          )
        
        :
          boolean

Add a lock to the resource we are saving

Returns

Type	Description
boolean

afterSave(
          
          )
        
        :
          boolean

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

Returns

Type	Description
boolean

beforeSave(
          
          )
        
        :
          boolean

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

Returns

Type	Description
boolean

beforeSet(
          
          )
        
        :
          boolean | string

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

Returns

Type	Description
boolean \| string

checkContextOfChildren(
          
          )
        
        :
          void

Reassign context for children if changed on main Resource

checkDeletedStatus(
          
          )
        
        :
          boolean

Check deleted status and ensure user has permissions to delete resource

Returns

Type	Description
boolean

checkForUnPublishOnSiteStart(
          
          )
        
        :
          boolean

Check to prevent unpublishing of site_start

Returns

Type	Description
boolean

checkFriendlyAlias(
          
          )
        
        :
          mixed | string

Friendly URL alias checks

Returns

Type	Description
mixed \| string

checkParentContext(
          
          )
        
        :
          mixed

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

Returns

Type	Description
mixed

checkPermissions(
          
          )
        
        :
          boolean

inherited

Return true here to allow access to this processor.

Inherited from: \modObjectProcessor::checkPermissions()\modObjectUpdateProcessor::checkPermissions()

Returns

Type	Description
boolean

checkPublishedOn(
          
          )
        
        :
          int

Set publishedon date if publish change is different

Returns

Type	Description
int

checkPublishingPermissions(
          
          )
        
        :
          boolean

Deny publishing if the user does not have access to

Returns

Type	Description
boolean

cleanup(
          
          )
        
        :
          array

Cleanup the processor and return the resulting object

Returns

Type	Description
array

clearCache(
          
          )
        
        :
          void

Empty site cache if specified to do so

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

inherited

Return a failure message from the processor.

Inherited from: \modProcessor::failure()\modObjectProcessor::failure()\modObjectUpdateProcessor::failure()

Parameters

Name	Type	Description
$msg	string
$object	mixed

Returns

Type	Description
array \| string

fireAfterSaveEvent(
          
          )
        
        :
          void

inherited

Fire the after save event

Inherited from: \modObjectUpdateProcessor::fireAfterSaveEvent()

fireBeforeSaveEvent(
          
          )
        
        :
          boolean

inherited

Fire before save event. Return true to prevent saving.

Inherited from: \modObjectUpdateProcessor::fireBeforeSaveEvent()

Returns

Type	Description
boolean

fireDeleteEvent(
          
          )
        
        :
          null

Fire Delete event if resource was deleted

Returns

Type	Description
null

fireUnDeleteEvent(
          
          )
        
        :
          mixed

Fire UnDelete event if resource was undeleted

Returns

Type	Description
mixed

fixParents(
          
          )
        
        :
          void

Set the parents isfolder status based upon remaining children

Details

TODO: Debate whether or not this should be default functionality

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

static

Allow for Resources to use derivative classes for their processors

Parameters

Name	Type	Description
$modx	\modX
$className	string
$properties	array

Returns

Type	Description
\modProcessor

Details

Static

getLanguageTopics(
          
          )
        
        :
          array

inherited

Load a collection of Language Topics for this processor.

Inherited from: \modObjectProcessor::getLanguageTopics()\modObjectUpdateProcessor::getLanguageTopics()

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()\modObjectProcessor::getProperties()\modObjectUpdateProcessor::getProperties()

Returns

Type	Description
array

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

inherited

Get a specific property.

Inherited from: \modProcessor::getProperty()\modObjectProcessor::getProperty()\modObjectUpdateProcessor::getProperty()

Parameters

Name	Type	Description
$k	string
$default	mixed

Returns

Type	Description
mixed

handleCheckBoxes(
          
          )
        
        :
          void

Handle formatting of various checkbox fields

handleParent(
          
          )
        
        :
          int | mixed

Handle the parent field, checking for veracity

Returns

Type	Description
int \| mixed

hasErrors(
          
          )
        
        :
          boolean

inherited

Return whether or not the processor has errors

Inherited from: \modProcessor::hasErrors()\modObjectProcessor::hasErrors()\modObjectUpdateProcessor::hasErrors()

Returns

Type	Description
boolean

initialize(
          
          )
        
        :
          boolean

inherited

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.

Inherited from: \modObjectUpdateProcessor::initialize()

Returns

Type	Description
boolean

logManagerAction(
          
          )
        
        :
          void

inherited

Log the removal manager action

Inherited from: \modObjectUpdateProcessor::logManagerAction()

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

inherited

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

Inherited from: \modProcessor::outputArray()\modObjectProcessor::outputArray()\modObjectUpdateProcessor::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

inherited

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

Inherited from: \modObjectUpdateProcessor::process()

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()\modObjectProcessor::processEventResponse()\modObjectUpdateProcessor::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.

run(
          
          )
        
        :
          \modProcessorResponse

inherited

Run the processor, returning a modProcessorResponse object.

Inherited from: \modProcessor::run()\modObjectProcessor::run()\modObjectUpdateProcessor::run()

Returns

Type	Description
\modProcessorResponse

saveObject(
          
          )
        
        :
          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()

Returns

Type	Description
boolean

saveTemplateVariables(
          
          )
        
        :
          array | mixed

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

Returns

Type	Description
array \| mixed

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()\modObjectProcessor::setCheckbox()\modObjectUpdateProcessor::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()\modObjectProcessor::setDefaultProperties()\modObjectUpdateProcessor::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()\modObjectProcessor::setPath()\modObjectUpdateProcessor::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()\modObjectProcessor::setProperties()\modObjectUpdateProcessor::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()\modObjectProcessor::setProperty()\modObjectUpdateProcessor::setProperty()

Parameters

Name	Type	Description
$k	string
$v	mixed

setPublishDate(
          
          )
        
        :
          int

Format the pub_date if it is set and adjust contingencies

Returns

Type	Description
int

setResourceGroups(
          
          )
        
        :
          mixed

If specified, set the Resource Groups attached to the Resource

Returns

Type	Description
mixed

setUnPublishDate(
          
          )
        
        :
          int | mixed

Format the unpub_date if it is set and adjust contingencies

Returns

Type	Description
int \| mixed

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

inherited

Return a success message from the processor.

Inherited from: \modProcessor::success()\modObjectProcessor::success()\modObjectUpdateProcessor::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()\modObjectProcessor::toJSON()\modObjectUpdateProcessor::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

trimPageTitle(
          
          )
        
        :
          string

Trim the page title

Returns

Type	Description
string

unsetProperty(
          string $key
          )
        
        :
          void

inherited

Completely unset a property from the properties array

Inherited from: \modProcessor::unsetProperty()\modObjectProcessor::unsetProperty()\modObjectUpdateProcessor::unsetProperty()

Parameters

Name	Type	Description
$key	string

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

\modResourceUpdateProcessorjump to top

Properties

Methods

\modResourceUpdateProcessor
jump to top