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

Show:

inherited

Classes
- \modResourceCreateProcessor

Table of Contents

Creates 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

\modResourceCreateProcessor
jump to top

Package: modx\processors\resource

Creates a resource.

{@inheritdoc}

Parent(s): \modObjectCreateProcessor < \modObjectProcessor < \modProcessor
$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

string
                 $classKey= ''modResource''

The class key of the Object to iterate

Default value'modResource'Details

Type: string

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

An array of language topics to load

Default valuearray('resource')Details

Type: array

\modX
                 $modx= 'null'

inherited

A reference to the modX object.

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

Default valuenullDetails

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

\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

\modResource
                 $parentResource= ''

Details

Type: \modResource

string
                 $path= ''''

inherited

The absolute path to this processor

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

Default value''Details

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

string
                 $permission= ''new_document''

The Permission to use when checking against

Default value'new_document'Details

Type: string

string
                 $primaryKeyField= ''id''

inherited

The primary key field to grab the object byInherited from: \modObjectProcessor::$$primaryKeyField \modObjectCreateProcessor::$$primaryKeyField

Default value'id'Details

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

array
                 $properties= 'array()'

inherited

The array of properties being passed to this processor

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

Default valuearray()Details

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

\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()\modObjectCreateProcessor::__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()\modObjectCreateProcessor::_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()\modObjectCreateProcessor::_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()\modObjectCreateProcessor::addFieldError()

Parameters

Name	Type	Description
$key	string
$message	string

Returns

Type	Description
mixed

addTemplateVariables(
          
          )
        
        :
          array

Add Template Variables to the Resource object

Returns

Type	Description
array

afterSave(
          
          )
        
        :
          mixed

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

Returns

Type	Description
mixed

beforeSave(
          
          )
        
        :
          mixed

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

Returns

Type	Description
mixed

beforeSet(
          
          )
        
        :
          array | string

Process the form and create the Resource

Returns

Type	Description
array \| string

checkForAllowableCreateToken(
          
          )
        
        :
          boolean

Check if new resource token posted from manager

Returns

Type	Description
boolean

checkIfParentIsContext(
          
          )
        
        :
          void

Handle if parent is a context

checkIfSiteStart(
          
          )
        
        :
          boolean

Quick check to make sure it's not site_start, if so, publish if not published to prevent site error

Returns

Type	Description
boolean

checkParentPermissions(
          
          )
        
        :
          boolean | string

Make sure parent exists and user can add_children to the parent

Returns

Type	Description
boolean \| string

checkPermissions(
          
          )
        
        :
          boolean

inherited

Return true here to allow access to this processor.

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

Returns

Type	Description
boolean

cleanup(
          
          )
        
        :
          mixed

Return the success message

Returns

Type	Description
mixed

clearCache(
          
          )
        
        :
          boolean

Clear the cache if specified

Returns

Type	Description
boolean

doesAlreadyExist(
          array $criteria
          )
        
        :
          int

inherited

Inherited from: \modObjectCreateProcessor::doesAlreadyExist()

Parameters

Name	Type	Description
$criteria	array

Returns

Type	Description
int

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

inherited

Return a failure message from the processor.

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

Parameters

Name	Type	Description
$msg	string
$object	mixed

Returns

Type	Description
array \| string

fireAfterSaveEvent(
          
          )
        
        :
          void

Invoke OnDocFormSave event

fireBeforeSaveEvent(
          
          )
        
        :
          boolean

Invoke OnBeforeDocFormSave event, and allow non-empty responses to prevent save

Returns

Type	Description
boolean

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

static

Allow for Resources to use derivative classes for their processors

Parameters

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

Returns

Type	Description
\modProcessor

Details

Static

getLanguageTopics(
          
          )
        
        :
          array

inherited

Load a collection of Language Topics for this processor.

Inherited from: \modObjectProcessor::getLanguageTopics()\modObjectCreateProcessor::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()\modObjectCreateProcessor::getProperties()

Returns

Type	Description
array

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

inherited

Get a specific property.

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

Parameters

Name	Type	Description
$k	string
$default	mixed

Returns

Type	Description
mixed

getWorkingContext(
          
          )
        
        :
          \modContext

Get the working Context for the Resource

Returns

Type	Description
\modContext

hasErrors(
          
          )
        
        :
          boolean

inherited

Return whether or not the processor has errors

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

Returns

Type	Description
boolean

initialize(
          
          )
        
        :
          string | \modResource

Create the modResource object for manipulation

Returns

Type	Description
string \| \modResource

logManagerAction(
          
          )
        
        :
          void

inherited

Log the removal manager action

Inherited from: \modObjectCreateProcessor::logManagerAction()

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

inherited

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

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

prepareAlias(
          
          )
        
        :
          string

Clean and prepare the alias, automatically generating it if the option is set

Returns

Type	Description
string

preparePageTitle(
          
          )
        
        :
          string

Prepare the pagetitle for insertion

Returns

Type	Description
string

prepareParent(
          
          )
        
        :
          int

Set and prepare the parent field

Returns

Type	Description
int

process(
          
          )
        
        :
          mixed

inherited

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

Inherited from: \modObjectCreateProcessor::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()\modObjectCreateProcessor::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()\modObjectCreateProcessor::run()

Returns

Type	Description
\modProcessorResponse

saveResourceGroups(
          
          )
        
        :
          void

Save the Resource Groups on the object

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()\modObjectCreateProcessor::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()\modObjectCreateProcessor::setDefaultProperties()

Parameters

Name	Type	Description
$properties	array

Returns

Type	Description
array	The newly merged properties array

setFieldDefaults(
          
          )
        
        :
          mixed

Set defaults for the fields if values are not passed

Returns

Type	Description
mixed

setMenuIndex(
          
          )
        
        :
          int

Set the menu index on the Resource, incrementing if not set

Returns

Type	Description
int

setParentToContainer(
          
          )
        
        :
          boolean

Update parent to be a container if user has save permission

Returns

Type	Description
boolean

setPath(
          string $path
          )
        
        :
          void

inherited

Set the path of the processor

Inherited from: \modProcessor::setPath()\modObjectProcessor::setPath()\modObjectCreateProcessor::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()\modObjectCreateProcessor::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()\modObjectCreateProcessor::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()\modObjectProcessor::success()\modObjectCreateProcessor::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()\modObjectCreateProcessor::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()\modObjectProcessor::unsetProperty()\modObjectCreateProcessor::unsetProperty()

Parameters

Name	Type	Description
$key	string

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

\modResourceCreateProcessorjump to top

Properties

Methods

\modResourceCreateProcessor
jump to top