modResource.php

<?php

namespace MODX\Revolution;

use MODX\Revolution\Registry\modDbRegister;
use MODX\Revolution\Registry\modRegistry;
use PDO;
use xPDO\Cache\xPDOCache;
use xPDO\Cache\xPDOCacheManager;
use xPDO\Om\xPDOCriteria;
use xPDO\Om\xPDOObject;
use xPDO\xPDO;

/**
 * Class modResource
 *
 * Represents a web resource managed by the MODX framework.
 *
 * @property int                        $id                    The ID of the Resource
 * @property string                     $type                  The type of the resource; document/reference
 * @property string                     $pagetitle             The page title of the Resource
 * @property string                     $longtitle             The long title of the Resource
 * @property string                     $description           The description of the Resource
 * @property string                     $alias                 The FURL alias of the resource
 * @property boolean                    $aliasVisible          Whether or not we should exclude the resource alias for children
 * @property string                     $link_attributes       Any link attributes for the URL generated for the Resource
 * @property boolean                    $published             Whether or not this Resource is published, or viewable by users without the 'view_unpublished' permission
 * @property int                        $pub_date              The UNIX time that this Resource will be automatically marked as published
 * @property int                        $unpub_date            The UNIX time that this Resource will be automatically marked as unpublished
 * @property int                        $parent                The parent ID of the Resource
 * @property boolean                    $isfolder              Whether or not this Resource is a container
 * @property string                     $introtext             The intro text of this Resource, often used as an excerpt
 * @property string                     $content               The actual content of this Resource
 * @property boolean                    $richtext              Whether or not this Resource is edited with a Rich Text Editor, if installed
 * @property int                        $template              The Template this Resource is tied to, or 0 to use an empty Template
 * @property int                        $menuindex             The menuindex, or rank, that this Resource shows in.
 * @property boolean                    $searchable            Whether or not this Resource should be searchable
 * @property boolean                    $cacheable             Whether or not this Resource should be cacheable
 * @property int                        $createdby             The ID of the User that created this Resource
 * @property int                        $createdon             The UNIX time of when this Resource was created
 * @property int                        $editedby              The ID of the User, if any, that last edited this Resource
 * @property int                        $editedon              The UNIX time, if set, of when this Resource was last edited
 * @property boolean                    $deleted               Whether or not this Resource is marked as deleted
 * @property int                        $deletedon             The UNIX time of when this Resource was deleted
 * @property int                        $deletedby             The User that deleted this Resource
 * @property int                        $publishedon           The UNIX time that this Resource was marked as published
 * @property int                        $publishedby           The User that published this Resource
 * @property string                     $menutitle             The title to show when this Resource is displayed in a menu
 * @property boolean                    $donthit               Deprecated.
 * @property boolean                    $privateweb            Deprecated.
 * @property boolean                    $privatemgr            Deprecated.
 * @property int                        $content_dispo         The type of Content Disposition that is used when displaying this Resource
 * @property boolean                    $hidemenu              Whether or not this Resource should show in menus
 * @property string                     $class_key             The Class Key of this Resource. Useful for derivative Resource types
 * @property string                     $context_key           The Context that this Resource resides in
 * @property int                        $content_type          The Content Type ID of this Resource
 * @property string                     $uri                   The generated URI of this Resource
 * @property boolean                    $uri_override          Whether or not this URI is "frozen": where the URI will stay as specified and will not be regenerated
 * @property boolean                    $hide_children_in_tree Whether or not this Resource should show in the mgr tree any of its children
 * @property boolean                    $show_in_tree          Whether or not this Resource should show in the mgr tree
 * @property array                      $properties
 *
 * @property modResource[]              $Children
 * @property modTemplateVarResource[]   $TemplateVarResources
 * @property modResourceGroupResource[] $ResourceGroupResources
 * @property modAccessResource[]        $Acls
 * @property modContextResource[]       $ContextResources
 *
 * @package MODX\Revolution
 */
class modResource extends modAccessibleSimpleObject implements modResourceInterface
{
    /**
     * Represents the cacheable content for a resource.
     *
     * Note that this is not the raw source content, but the content that is the
     * result of processing cacheable tags within the raw source content.
     *
     * @var string
     */
    public $_content = '';
    /**
     * Represents the output the resource produces.
     *
     * @var string
     */
    public $_output = '';
    /**
     * The context the resource is requested from.
     *
     * Note that this is different than the context_key field that describes a
     * primary context for the resource.
     *
     * @var string
     */
    public $_contextKey = null;
    /**
     * Indicates if the resource has already been processed.
     *
     * @var boolean
     */
    protected $_processed = false;
    /**
     * The cache filename for the resource in the context.
     *
     * @var string
     */
    protected $_cacheKey = null;
    /**
     * Indicates if the site cache should be refreshed when saving changes.
     *
     * @var boolean
     */
    protected $_refreshCache = true;
    /**
     * Indicates if this Resource was generated from a forward.
     *
     * @var boolean
     */
    public $_isForward = false;
    /**
     * An array of Javascript/CSS to be appended to the footer of this Resource
     *
     * @var array $_jscripts
     */
    public $_jscripts = [];
    /**
     * An array of Javascript/CSS to be appended to the HEAD of this Resource
     *
     * @var array $_sjscripts
     */
    public $_sjscripts = [];
    /**
     * All loaded Javascript/CSS that has been calculated to be loaded
     *
     * @var array
     */
    public $_loadedjscripts = [];
    /**
     * Use if extending modResource to state whether or not to show the extended class in the tree context menu
     *
     * @var boolean
     */
    public $showInContextMenu = false;
    /**
     * Use if extending modResource to state whether or not to allow drop on extended class in the resource tree
     * Set 1 for allow drop, 0 for disable drop or -1 for default behavior
     *
     * @var int
     */
    public $allowDrop = -1;
    /**
     * Use if extending modResource to state whether or not the derivative class can be listed in the class_key
     * dropdown users can change when editing a resource.
     *
     * @var boolean
     */
    public $allowListingInClassKeyDropdown = true;
    /**
     * Whether or not to allow creation of children resources in tree. Can be overridden in a derivative Resource class.
     *
     * @var boolean
     */
    public $allowChildrenResources = true;

    /** @var modX|xPDO $xpdo */
    public $xpdo;

    /**
     * Filter a string for use as a URL path segment.
     *
     * @param modX|xPDO &$xpdo    A reference to a modX or xPDO instance.
     * @param string     $segment The string to filter into a path segment.
     * @param array      $options Local options to override global filter settings.
     *
     * @return string The filtered string ready to use as a path segment.
     */
    public static function filterPathSegment(&$xpdo, $segment, array $options = [])
    {
        /* setup the various options */
        $iconv = function_exists('iconv');
        $mbext = function_exists('mb_strlen') && (boolean)$xpdo->getOption('use_multibyte', $options, false);
        $charset = strtoupper((string)$xpdo->getOption('modx_charset', $options, 'UTF-8'));
        $delimiter = $xpdo->getOption('friendly_alias_word_delimiter', $options, '-');
        $delimiters = $xpdo->getOption('friendly_alias_word_delimiters', $options, '-_');
        $maxlength = (integer)$xpdo->getOption('friendly_alias_max_length', $options, 0);
        $stripElementTags = (boolean)$xpdo->getOption('friendly_alias_strip_element_tags', $options, true);
        $trimchars = $xpdo->getOption('friendly_alias_trim_chars', $options, '/.' . $delimiters);
        $restrictchars = $xpdo->getOption('friendly_alias_restrict_chars', $options, 'pattern');
        $restrictcharspattern = $xpdo->getOption('friendly_alias_restrict_chars_pattern', $options,
            '/[\0\x0B\t\n\r\f\a&=+%#<>"~`@\?\[\]\{\}\|\^\'\\\\]/');
        $lowercase = (boolean)$xpdo->getOption('friendly_alias_lowercase_only', $options, true);
        $translit = $xpdo->getOption('friendly_alias_translit', $options, $iconv ? 'iconv' : 'none');
        $translitClass = $xpdo->getOption('friendly_alias_translit_class', $options, 'translit.modTransliterate');

        /* strip html and optionally MODX element tags (stripped by default) */
        if ($xpdo instanceof modX) {
            $segment = $xpdo->stripTags($segment, '', $stripElementTags ? [] : null);
        }

        /* replace &nbsp; with the specified word delimiter */
        $segment = str_replace('&nbsp;', $delimiter, $segment);

        /* decode named entities to the appropriate character for the character set */
        $segment = html_entity_decode($segment, ENT_QUOTES, $charset);

        /* prepare '&' replacement */
        if ($xpdo instanceof modX && $xpdo->getService('lexicon', modLexicon::class) && $xpdo->lexicon('and')) {
            $ampersand = ' ' . $xpdo->lexicon('and') . ' ';
        } else {
            $ampersand = ' and ';
        }

        /* apply transliteration as configured */
        switch ($translit) {
            case '':
            case 'none':
                /* no transliteration */
                break;
            case 'iconv':
                /* if iconv is available, use the built-in transliteration it provides */
                $segment = iconv($mbext ? mb_detect_encoding($segment) : $charset, $charset . '//TRANSLIT//IGNORE',
                    $segment);
                $ampersand = iconv($mbext ? mb_detect_encoding($segment) : $charset, $charset . '//TRANSLIT//IGNORE',
                    $ampersand);
                break;
            case 'iconv_ascii':
                /* if iconv is available, use the built-in transliteration to ASCII it provides */
                $segment = iconv(($mbext) ? mb_detect_encoding($segment) : $charset, 'ASCII//TRANSLIT//IGNORE',
                    $segment);
                break;
            default:
                /* otherwise look for a transliteration service class that will accept named transliteration tables */
                if ($xpdo instanceof modX) {
                    $translitClassPath = $xpdo->getOption('friendly_alias_translit_class_path', $options,
                        $xpdo->getOption('core_path', $options, MODX_CORE_PATH) . 'components/');
                    if ($xpdo->getService('translit', $translitClass, $translitClassPath, $options)) {
                        $segment = $xpdo->translit->translate($segment, $translit);
                        $ampersand = $xpdo->translit->translate($ampersand, $translit);
                    }
                }
                break;
        }

        /* replace any remaining '&' with a translit ampersand */
        $segment = str_replace('&', $ampersand, $segment);

        /* restrict characters as configured */
        switch ($restrictchars) {
            case 'alphanumeric':
                /* restrict segment to alphanumeric characters only */
                $segment = preg_replace('/[^\.%A-Za-z0-9 _-]/', '', $segment);
                break;
            case 'alpha':
                /* restrict segment to alpha characters only */
                $segment = preg_replace('/[^\.%A-Za-z _-]/', '', $segment);
                break;
            case 'legal':
                /* restrict segment to legal URL characters only */
                $segment = preg_replace('/[\0\x0B\t\n\r\f\a&=+%#<>"~`@\?\[\]\{\}\|\^\'\\\\]/', '', $segment);
                break;
            case 'pattern':
            default:
                /* restrict segment using regular expression pattern configured (same as legal by default) */
                if (!empty($restrictcharspattern)) {
                    $segment = preg_replace($restrictcharspattern, '', $segment);
                }
        }

        /* replace one or more space characters with word delimiter */
        $segment = preg_replace('/\s+/u', $delimiter, $segment);

        /* replace one or more instances of word delimiters with word delimiter */
        $delimiterTokens = [];
        for ($d = 0; $d < strlen($delimiters); $d++) {
            $delimiterTokens[] = preg_quote($delimiters[$d], '/');
        }
        if (!empty($delimiterTokens)) {
            $delimiterPattern = '/[' . implode('|', $delimiterTokens) . ']+/';
            $segment = preg_replace($delimiterPattern, $delimiter, $segment);
        }

        /* unless lowercase_only preference is explicitly off, change case to lowercase */
        if ($lowercase) {
            if ($mbext) {
                /* if the mb extension is available use it to protect multi-byte chars */
                $segment = mb_convert_case($segment, MB_CASE_LOWER, $charset);
            } else {
                /* otherwise, just use strtolower */
                $segment = strtolower($segment);
            }
        }
        /* trim specified chars from both ends of the segment */
        $segment = trim($segment, $trimchars);

        /* get the strlen of the segment (use mb extension if available) */
        $length = $mbext ? mb_strlen($segment, $charset) : strlen($segment);

        /* if maxlength is specified and exceeded, return substr with additional trim applied */
        if ($maxlength > 0 && $length > $maxlength) {
            $segment = substr($segment, 0, $maxlength);
            $segment = trim($segment, $trimchars);
        }

        return $segment;
    }

    /**
     * Get a sortable, limitable collection (and total count) of Resource Groups for a given Resource.
     *
     * @static
     *
     * @param modResource &$resource A reference to the modResource to get the groups from.
     * @param array        $sort     An array of sort columns in column => direction format.
     * @param int          $limit    A limit of records to retrieve in the collection.
     * @param int          $offset   A record offset for a limited collection.
     *
     * @return array An array containing the collection and total.
     */
    public static function listGroups(modResource &$resource, array $sort = ['id' => 'ASC'], $limit = 0, $offset = 0)
    {
        $result = ['collection' => [], 'total' => 0];
        $c = $resource->xpdo->newQuery(modResourceGroup::class);
        $c->leftJoin(modResourceGroupResource::class, 'ResourceGroupResource', [
            "ResourceGroupResource.document_group = modResourceGroup.id",
            'ResourceGroupResource.document' => $resource->get('id'),
        ]);
        $result['total'] = $resource->xpdo->getCount(modResourceGroup::class, $c);
        $c->select($resource->xpdo->getSelectColumns(modResourceGroup::class, 'modResourceGroup'));
        $c->select(["IF(ISNULL(ResourceGroupResource.document),0,1) AS access"]);
        foreach ($sort as $sortKey => $sortDir) {
            $c->sortby($resource->xpdo->escape('modResourceGroup') . '.' . $resource->xpdo->escape($sortKey), $sortDir);
        }
        if ($limit > 0) {
            $c->limit($limit, $offset);
        }
        $result['collection'] = $resource->xpdo->getCollection(modResourceGroup::class, $c);

        return $result;
    }

    /**
     * Retrieve a collection of Template Variables for a Resource.
     *
     * @static
     *
     * @param modResource &$resource A reference to the modResource to retrieve TemplateVars for.
     *
     * @return modTemplateVar[] A collection of modTemplateVar instances for the modResource.
     */
    public static function getTemplateVarCollection(modResource &$resource)
    {
        $c = $resource->xpdo->newQuery(modTemplateVar::class);
        $c->query['distinct'] = 'DISTINCT';
        $c->select($resource->xpdo->getSelectColumns(modTemplateVar::class, 'modTemplateVar'));
        $c->select($resource->xpdo->getSelectColumns(modTemplateVarTemplate::class, 'tvtpl', '', ['rank']));
        if ($resource->isNew()) {
            $c->select([
                'modTemplateVar.default_text AS value',
                '0 AS resourceId',
            ]);
        } else {
            $c->select([
                'IF(ISNULL(tvc.value),modTemplateVar.default_text,tvc.value) AS value',
                $resource->get('id') . ' AS resourceId',
            ]);
        }
        $c->innerJoin(modTemplateVarTemplate::class, 'tvtpl', [
            'tvtpl.tmplvarid = modTemplateVar.id',
            'tvtpl.templateid' => $resource->get('template'),
        ]);
        if (!$resource->isNew()) {
            $c->leftJoin(modTemplateVarResource::class, 'tvc', [
                'tvc.tmplvarid = modTemplateVar.id',
                'tvc.contentid' => $resource->get('id'),
            ]);
        }
        $c->sortby('tvtpl.rank,modTemplateVar.rank');

        return $resource->xpdo->getCollection(modTemplateVar::class, $c);
    }

    /**
     * Refresh Resource URI fields for children of the specified parent.
     *
     * @static
     *
     * @param modX &$modx    A reference to a valid modX instance.
     * @param int   $parent  The id of a Resource parent to start from (default is 0, the root)
     * @param array $options An array of various options for the method:
     *                       - resetOverrides: if true, Resources with uri_override set to true will be included
     *                       - contexts: an optional array of context keys to limit the refresh scope
     *
     * @return void
     */
    public static function refreshURIs(modX &$modx, $parent = 0, array $options = [])
    {
        $resetOverrides = array_key_exists('resetOverrides', $options) ? (boolean)$options['resetOverrides'] : false;
        $contexts = array_key_exists('contexts', $options) ? explode(',', $options['contexts']) : null;
        $criteria = $modx->newQuery(modResource::class, ['parent' => $parent]);
        if (!$resetOverrides) {
            $criteria->where(['uri_override' => false]);
        }
        if (!empty($contexts)) {
            $criteria->where(['context_key:IN' => $contexts]);
        }
        $criteria->sortby('menuindex', 'ASC');
        /** @var modResource $resource */
        foreach ($modx->getIterator(modResource::class, $criteria) as $resource) {
            $resource->set('refreshURIs', true);
            if ($resetOverrides) {
                $resource->set('uri_override', false);
            }
            if (!$resource->get('uri_override')) {
                $resource->set('uri', '');
            }
            $resource->save();
        }
    }

    /**
     * Updates the Context of all Children recursively to that of the parent.
     *
     * @static
     *
     * @param modX &      $modx    A reference to an initialized modX instance.
     * @param modResource $parent  The parent modResource instance.
     * @param array       $options An array of options.
     *
     * @return int The number of children updated.
     */
    public static function updateContextOfChildren(modX &$modx, $parent, array $options = [])
    {
        $count = 0;
        /** @var modResource $child */
        foreach ($parent->getIterator('Children') as $child) {
            $child->set('context_key', $parent->get('context_key'));
            if ($child->save()) {
                $count++;
            } else {
                $modx->log(modX::LOG_LEVEL_ERROR, "Could not change Context of child resource {$child->get('id')}", '',
                    __METHOD__, __FILE__, __LINE__);
            }
        }

        return $count;
    }

    /**
     * @param xPDO $xpdo A reference to the xPDO|modX instance
     */
    function __construct(xPDO & $xpdo)
    {
        parent:: __construct($xpdo);
        $this->_contextKey = isset ($this->xpdo->context) ? $this->xpdo->context->get('key') : 'web';
        $this->_cacheKey = "[contextKey]/resources/[id]";
    }

    /**
     * Prepare the resource for output.
     */
    public function prepare()
    {
        # 1. Parse cacheable elements if exist.
        $this->process();
        # 2. Copy registered scripts added by the cacheable elements.
        $this->syncScripts();
        # 3. Parse uncacheable elements.
        $this->parseContent();
    }

    /**
     * Process a resource, transforming source content to output.
     *
     * @return string The processed cacheable content of a resource.
     */
    public function process()
    {
        if (!$this->get('cacheable') || !$this->_processed || !$this->_content) {
            $this->_content = '';
            $this->_output = '';
            $this->xpdo->getParser();
            /** @var modTemplate $baseElement */
            if ($baseElement = $this->getOne('Template')) {
                if ($baseElement->process()) {
                    $this->_content = $baseElement->_output;
                    $this->_processed = true;
                }
            } else {
                $this->_content = $this->getContent();
                $maxIterations = intval($this->xpdo->getOption('parser_max_iterations', 10));
                $this->xpdo->parser->processElementTags('', $this->_content, false, false, '[[', ']]', [],
                    $maxIterations);
                $this->_processed = true;
            }
        }

        return $this->_content;
    }

    /**
     * @param array $data Data for placeholders
     *
     * @return string
     */
    public function parseContent($data = [])
    {
        $this->xpdo->getParser();
        $maxIterations = intval($this->xpdo->getOption('parser_max_iterations', null, 10));
        $oldResource = $this->xpdo->resource;
        $this->xpdo->resource = $this;
        if (!empty($data)) {
            $scope = $this->xpdo->toPlaceholders($data, '', '.', true);
        }
        if (!$this->_processed) {
            $this->_content = $this->getContent();
            $this->xpdo->parser->processElementTags('', $this->_content, false, false, '[[', ']]', [], $maxIterations);
            $this->_processed = true;
        }
        $this->_output = $this->_content;
        $this->xpdo->parser->processElementTags('', $this->_output, true, false, '[[', ']]', [], $maxIterations);
        $this->xpdo->parser->processElementTags('', $this->_output, true, true, '[[', ']]', [], $maxIterations);
        $this->xpdo->resource = $oldResource;
        if (isset($scope['keys'])) {
            $this->xpdo->unsetPlaceholders($scope['keys']);
        }
        if (isset($scope['restore'])) {
            $this->xpdo->toPlaceholders($scope['restore']);
        }

        return $this->_output;
    }

    /**
     * Store scripts registered by cached elements.
     */
    public function syncScripts()
    {
        $this->_jscripts = $this->xpdo->jscripts;
        $this->_sjscripts = $this->xpdo->sjscripts;
        $this->_loadedjscripts = $this->xpdo->loadedjscripts;
    }

    /**
     * Gets the raw, unprocessed source content for a resource.
     *
     * @param array $options An array of options implementations can use to
     *                       accept language, revision identifiers, or other information to alter the
     *                       behavior of the method.
     *
     * @return string The raw source content for the resource.
     */
    public function getContent(array $options = [])
    {
        if (isset($options['content'])) {
            $content = $options['content'];
        } else {
            $content = $this->get('content');
        }

        return $content;
    }

    /**
     * Set the raw source content for this element.
     *
     * @param mixed $content The source content; implementations can decide if
     *                       it can only be a string, or some other source from which to retrieve it.
     * @param array $options An array of options implementations can use to
     *                       accept language, revision identifiers, or other information to alter the
     *                       behavior of the method.
     *
     * @return boolean True indicates the content was set.
     */
    public function setContent($content, array $options = [])
    {
        return $this->set('content', $content);
    }

    /**
     * Returns the cache key for this instance in the specified or current context.
     *
     * @param string $context A specific Context to get the cache key from.
     *
     * @return string The cache key.
     */
    public function getCacheKey($context = '')
    {
        $id = $this->get('id') ? (string)$this->get('id') : '0';
        if (!is_string($context) || $context === '') {
            $context = !empty($this->_contextKey)
                ? $this->_contextKey
                : $this->get('context_key');
        }
        $cacheKey = $this->_cacheKey;
        if (strpos($cacheKey, '[') !== false) {
            $cacheKey = str_replace('[contextKey]', $context, $cacheKey);
            $cacheKey = str_replace('[id]', $id, $cacheKey);
        }

        return $cacheKey;
    }

    /**
     * Gets a collection of objects related by aggregate or composite relations.
     *
     * {@inheritdoc}
     *
     * Includes special handling for related objects with alias {@link
     * modTemplateVar}, respecting framework security unless specific criteria
     * are provided.
     *
     * @todo Refactor to use the new ABAC security model.
     */
    public function & getMany($alias, $criteria = null, $cacheFlag = false)
    {
        if ($alias === 'TemplateVars' || $alias === 'modTemplateVar' && ($criteria === null || strtolower($criteria) === 'all')) {
            $collection = $this->getTemplateVars();
        } else {
            $collection = parent:: getMany($alias, $criteria, $cacheFlag);
        }

        return $collection;
    }

    /**
     * Get a collection of the Template Variable values for the Resource.
     *
     * @return array A collection of TemplateVar values for this Resource.
     */
    public function getTemplateVars()
    {
        return $this->xpdo->call(modResource::class, 'getTemplateVarCollection', [&$this]);
    }

    /**
     * Set a field value by the field key or name.
     *
     * {@inheritdoc}
     *
     * Additional logic added for the following fields:
     *    -alias: Applies {@link modResource::cleanAlias()}
     */
    public function set($k, $v = null, $vType = '')
    {
        switch ($k) {
            case 'alias' :
                $v = $this->cleanAlias($v);
                break;
        }

        return parent:: set($k, $v, $vType);
    }

    /**
     * Transforms a string to form a valid URL representation.
     *
     * @param string $alias   A string to transform into a valid URL representation.
     * @param array  $options Options to append to or override configuration settings.
     *
     * @return string The transformed string.
     */
    public function cleanAlias($alias, array $options = [])
    {
        if ($this->xpdo instanceof modX && $ctx = $this->xpdo->getContext($this->get('context_key'))) {
            $options = array_merge($ctx->config, $options);
        }

        return $this->xpdo->call($this->_class, 'filterPathSegment', [&$this->xpdo, $alias, $options]);
    }

    /**
     * Persist new or changed modResource instances to the database container.
     *
     * If the modResource is new, the createdon and createdby fields will be set
     * using the current time and user authenticated in the context.
     *
     * If uri is empty or uri_overridden is not set and something has been changed which
     * might affect the Resource's uri, it is (re-)calculated using getAliasPath(). This
     * can be forced recursively by setting refreshURIs to true before calling save().
     *
     * @param boolean $cacheFlag
     *
     * @return boolean
     */
    public function save($cacheFlag = null)
    {
        if ($this->isNew()) {
            if (!$this->get('createdon')) {
                $this->set('createdon', time());
            }
            if (!$this->get('createdby') && $this->xpdo instanceof modX) {
                $this->set('createdby', $this->xpdo->getLoginUserID());
            }
        }
        $refreshChildURIs = false;
        if ($this->xpdo instanceof modX && $this->xpdo->getOption('friendly_urls')) {
            $refreshChildURIs = ($this->get('refreshURIs') || $this->isDirty('uri') || $this->isDirty('alias') || $this->isDirty('alias_visible') || $this->isDirty('parent') || $this->isDirty('context_key'));
            if ($this->get('uri') == '' || (!$this->get('uri_override') && ($this->isDirty('uri_override') || $this->isDirty('content_type') || $this->isDirty('isfolder') || $refreshChildURIs))) {
                $this->set('uri', $this->getAliasPath($this->get('alias')));
            }
        }
        $changeContext = false;
        if ($this->xpdo instanceof modX) {
            $changeContext = $this->isDirty('context_key');
        }
        $rt = parent:: save($cacheFlag);
        if ($rt && $refreshChildURIs) {
            $this->xpdo->call(modResource::class, 'refreshURIs', [
                &$this->xpdo,
                $this->get('id'),
            ]);
        }
        if ($rt && $changeContext) {
            $this->xpdo->call($this->_class, 'updateContextOfChildren', [&$this->xpdo, $this]);
        }

        return $rt;
    }

    /**
     * Return whether or not the resource has been processed.
     *
     * @access public
     * @return boolean
     */
    public function getProcessed()
    {
        return $this->_processed;
    }

    /**
     * Set the field indicating the resource has been processed.
     *
     * @param boolean $processed Pass true to indicate the Resource has been processed.
     */
    public function setProcessed($processed)
    {
        $this->_processed = (boolean)$processed;
    }

    /**
     * Adds a lock on the Resource
     *
     * @access public
     *
     * @param integer $user
     * @param array   $options An array of options for the lock.
     *
     * @return boolean True if the lock was successful.
     */
    public function addLock($user = 0, array $options = [])
    {
        $locked = false;
        if ($this->xpdo instanceof modX) {
            if (!$user) {
                $user = $this->xpdo->user->get('id');
            }
            $lockedBy = $this->getLock();
            if (empty($lockedBy) || ($lockedBy == $user)) {
                $this->xpdo->registry->locks->subscribe('/resource/');
                $this->xpdo->registry->locks->send('/resource/', [md5($this->get('id')) => $user],
                    ['ttl' => $this->xpdo->getOption('lock_ttl', $options, 360)]);
                $locked = true;
            } elseif ($lockedBy != $user) {
                $locked = $lockedBy;
            }
        }

        return $locked;
    }

    /**
     * Gets the lock on the Resource.
     *
     * @access public
     * @return int
     */
    public function getLock()
    {
        $lock = 0;
        if ($this->xpdo instanceof modX) {
            if ($this->xpdo->getService('registry', modRegistry::class)) {
                $this->xpdo->registry->addRegister('locks', modDbRegister::class, ['directory' => 'locks']);
                $this->xpdo->registry->locks->connect();
                $this->xpdo->registry->locks->subscribe('/resource/' . md5($this->get('id')));
                if ($msgs = $this->xpdo->registry->locks->read(['remove_read' => false, 'poll_limit' => 1])) {
                    $msg = reset($msgs);
                    $lock = intval($msg);
                }
            }
        }

        return $lock;
    }

    /**
     * Removes all locks on a Resource.
     *
     * @access public
     *
     * @param int $user
     *
     * @return boolean True if locks were removed.
     */
    public function removeLock($user = 0)
    {
        $removed = false;
        if ($this->xpdo instanceof modX) {
            if (!$user) {
                $user = $this->xpdo->user->get('id');
            }
            $lockedBy = $this->getLock();
            if (empty($lockedBy) || $lockedBy == $user) {
                if ($this->xpdo->getService('registry', modRegistry::class)) {
                    $this->xpdo->registry->addRegister('locks', modDbRegister::class, ['directory' => 'locks']);
                    $this->xpdo->registry->locks->connect();
                    $this->xpdo->registry->locks->subscribe('/resource/' . md5($this->get('id')));
                    $this->xpdo->registry->locks->read(['remove_read' => true, 'poll_limit' => 1]);
                    $removed = true;
                }
            }
        }

        return $removed;
    }

    /**
     * Loads the access control policies applicable to this resource.
     *
     * {@inheritdoc}
     */
    public function findPolicy($context = '')
    {
        $policy = [];
        $enabled = true;
        $context = !empty($context) ? $context : $this->xpdo->context->get('key');
        if ($context === $this->xpdo->context->get('key')) {
            $enabled = (boolean)$this->xpdo->getOption('access_resource_group_enabled', null, true);
        } elseif ($this->xpdo->getContext($context)) {
            $enabled = (boolean)$this->xpdo->contexts[$context]->getOption('access_resource_group_enabled', true);
        }
        if ($enabled) {
            if (empty($this->_policies) || !isset($this->_policies[$context])) {
                $accessTable = $this->xpdo->getTableName(modAccessResourceGroup::class);
                $policyTable = $this->xpdo->getTableName(modAccessPolicy::class);
                $resourceGroupTable = $this->xpdo->getTableName(modResourceGroupResource::class);
                $sql = "SELECT Acl.target, Acl.principal, Acl.authority, Acl.policy, Policy.data FROM {$accessTable} Acl " .
                    "LEFT JOIN {$policyTable} Policy ON Policy.id = Acl.policy " .
                    "JOIN {$resourceGroupTable} ResourceGroup ON Acl.principal_class = {$this->xpdo->quote(modUserGroup::class)} " .
                    "AND (Acl.context_key = :context OR Acl.context_key IS NULL OR Acl.context_key = '') " .
                    "AND ResourceGroup.document = :resource " .
                    "AND ResourceGroup.document_group = Acl.target " .
                    "GROUP BY Acl.target, Acl.principal, Acl.authority, Acl.policy";
                $bindings = [
                    ':resource' => $this->get('id'),
                    ':context' => $context,
                ];
                $query = new xPDOCriteria($this->xpdo, $sql, $bindings);
                if ($query->stmt && $query->stmt->execute()) {
                    while ($row = $query->stmt->fetch(PDO::FETCH_ASSOC)) {
                        $policy[modAccessResourceGroup::class][$row['target']][] = [
                            'principal' => $row['principal'],
                            'authority' => $row['authority'],
                            'policy' => $row['data'] ? $this->xpdo->fromJSON($row['data'], true) : [],
                        ];
                    }
                }
                $this->_policies[$context] = $policy;
            } else {
                $policy = $this->_policies[$context];
            }
        }

        return $policy;
    }

    /**
     * Checks to see if the Resource has children or not. Returns the number of
     * children.
     *
     * @access public
     * @return integer The number of children of the Resource
     */
    public function hasChildren()
    {
        $c = $this->xpdo->newQuery(modResource::class);
        $c->where([
            'parent' => $this->get('id'),
        ]);

        return $this->xpdo->getCount(modResource::class, $c);
    }

    /**
     * Gets the value of a TV for the Resource.
     *
     * @access public
     *
     * @param mixed $pk Either the ID of the TV, or the name of the TV.
     *
     * @return null/mixed The value of the TV for the Resource, or null if the
     * TV is not found.
     */
    public function getTVValue($pk)
    {
        $byName = !is_numeric($pk);

        /** @var modTemplateVar $tv */
        if ($byName && $this->xpdo instanceof modX) {
            $tv = $this->xpdo->getParser()->getElement(modTemplateVar::class, $pk);
        } else {
            $tv = $this->xpdo->getObject(modTemplateVar::class, $byName ? ['name' => $pk] : $pk);
        }

        return $tv == null ? null : $tv->renderOutput($this->get('id'));
    }

    /**
     * Sets a value for a TV for this Resource
     *
     * @param mixed  $pk    The TV name or ID to set
     * @param string $value The value to set for the TV
     *
     * @return bool Whether or not the TV saved successfully
     */
    public function setTVValue($pk, $value)
    {
        $success = false;
        if (is_numeric($pk)) {
            $pk = intval($pk);
        } elseif (is_string($pk)) {
            $pk = ['name' => $pk];
        }
        /** @var modTemplateVar $tv */
        $tv = $this->xpdo->getObject(modTemplateVar::class, $pk);
        if ($tv) {
            $tv->setValue($this->get('id'), $value);
            $success = $tv->save();
        }

        return $success;
    }

    /**
     * Get the Resource's full alias path.
     *
     * @param string $alias  Optional. The alias to check. If not set, will
     *                       then build it from the pagetitle if automatic_alias is set to true.
     * @param array  $fields Optional. An array of field values to use instead of
     *                       using the current modResource fields.
     *
     * @return string
     */
    public function getAliasPath($alias = '', array $fields = [])
    {
        if (empty($fields)) {
            $fields = $this->toArray();
        }
        $workingContext = $this->xpdo->getContext($fields['context_key']);
        if (empty($fields['uri_override']) || empty($fields['uri'])) {
            /* auto assign alias if using automatic_alias */
            if (empty($alias) && $workingContext->getOption('automatic_alias', false)) {
                $alias = $this->cleanAlias($fields['pagetitle']);
            } elseif (empty($alias) && isset($fields['id']) && !empty($fields['id'])) {
                $alias = $this->cleanAlias($fields['id']);
            } else {
                $alias = $this->cleanAlias($alias);
            }

            $fullAlias = $alias;
            $isHtml = true;
            $extension = '';
            $containerSuffix = $workingContext->getOption('container_suffix', '');
            /* @var modContentType $contentType process content type */
            if (!empty($fields['content_type']) && $contentType = $this->xpdo->getObject(modContentType::class, $fields['content_type'])) {
                $extension = $contentType->getExtension();
                $isHtml = (strpos($contentType->get('mime_type'), 'html') !== false);
            }
            /* set extension to container suffix if Resource is a folder, HTML content type, and the container suffix is set */
            if (!empty($fields['isfolder']) && $isHtml && !empty ($containerSuffix)) {
                $extension = $containerSuffix;
            }
            $aliasPath = '';
            /* if using full alias paths, calculate here */
            if ($workingContext->getOption('use_alias_path', false)) {
                $useFrozenPathUris = $workingContext->getOption('use_frozen_parent_uris', false);
                $pathParentId = $fields['parent'];
                $parentResources = [];
                $query = $this->xpdo->newQuery(modResource::class);
                $query->select($this->xpdo->getSelectColumns(modResource::class, '', '',
                    ['parent', 'alias', 'alias_visible', 'uri', 'uri_override']));
                $query->where("{$this->xpdo->escape('id')} = ?");
                $query->prepare();
                $query->stmt->execute([$pathParentId]);
                $currResource = $query->stmt->fetch(PDO::FETCH_ASSOC);

                while ($currResource) {
                    // If the use_frozen_parent_uris setting is enabled, we will look at the parent frozen uri instead
                    // of building the full uri from all parents. This makes sure children will have an uri relative
                    // from the parent at all times.
                    if ($useFrozenPathUris && $currResource['uri_override'] && !empty($currResource['uri'])) {
                        $parentResources[] = rtrim($currResource['uri'], '/');
                        break;
                    }

                    $parentAlias = $currResource['alias'];
                    if (empty ($parentAlias)) {
                        $parentAlias = "{$pathParentId}";
                    }

                    // If we are ignoring the alias for this parent, simply skip adding it to the array for the alias
                    // path.
                    if ($currResource['alias_visible'] == 1) {
                        $parentResources[] = "{$parentAlias}";
                    }

                    $pathParentId = $currResource['parent'];
                    $query->stmt->execute([$pathParentId]);
                    $currResource = $query->stmt->fetch(PDO::FETCH_ASSOC);
                }
                $aliasPath = !empty ($parentResources) ? implode('/', array_reverse($parentResources)) : '';
                if (strlen($aliasPath) > 0 && $aliasPath[strlen($aliasPath) - 1] !== '/') {
                    $aliasPath .= '/';
                }
            }
            $fullAlias = $aliasPath . $fullAlias . $extension;
        } else {
            $fullAlias = $fields['uri'];
        }

        return $fullAlias;
    }

    /**
     * Tests to see if an alias is a duplicate.
     *
     * @param string $aliasPath  The current full alias path. If none is passed,
     *                           will build it from the Resource's currently set alias.
     * @param string $contextKey The context to search for a duplicate alias in.
     *
     * @return mixed The ID of the Resource using the alias, if a duplicate, otherwise false.
     */
    public function isDuplicateAlias($aliasPath = '', $contextKey = '')
    {
        if (empty($aliasPath)) {
            $aliasPath = $this->getAliasPath($this->get('alias'));
        }
        $criteria = $this->xpdo->newQuery(modResource::class);
        $where = [
            'id:!=' => $this->get('id'),
            'uri' => $aliasPath,
            'deleted' => false,
        ];
        if (!empty($contextKey)) {
            $where['context_key'] = $contextKey;
        }
        $criteria->select('id');
        $criteria->where($where);
        $criteria->prepare();
        $duplicate = $this->xpdo->getValue($criteria->stmt);

        return $duplicate > 0 ? (integer)$duplicate : false;
    }

    /**
     * Duplicate the Resource.
     *
     * @param array $options An array of options.
     *
     * @return mixed Returns either an error message, or the newly created modResource object.
     */
    public function duplicate(array $options = [])
    {
        if (!($this->xpdo instanceof modX)) {
            return false;
        }

        /* duplicate resource */
        $prefixDuplicate = !empty($options['prefixDuplicate']) ? true : false;
        $newName = !empty($options['newName']) ? $options['newName'] : ($prefixDuplicate ? $this->xpdo->lexicon('duplicate_of',
            [
                'name' => $this->get('pagetitle'),
            ]) : $this->get('pagetitle'));
        /** @var modResource $newResource */
        $newResource = $this->xpdo->newObject($this->get('class_key'));
        $newResource->fromArray($this->toArray('', true), '', false, true);
        $newResource->set('pagetitle', $newName);

        /* do published status preserving */
        $publishedMode = $this->getOption('publishedMode', $options, 'preserve');
        switch ($publishedMode) {
            case 'unpublish':
                $newResource->set('published', false);
                $newResource->set('publishedon', 0);
                $newResource->set('publishedby', 0);
                break;
            case 'publish':
                $newResource->set('published', true);
                $newResource->set('publishedon', time());
                $newResource->set('publishedby', $this->xpdo->user->get('id'));
                break;
            case 'preserve':
            default:
                $newResource->set('published', $this->get('published'));
                $newResource->set('publishedon', $this->get('publishedon'));
                $newResource->set('publishedby', $this->get('publishedby'));
                break;
        }

        /* allow overrides for every item */
        if (!empty($options['overrides']) && is_array($options['overrides'])) {
            $newResource->fromArray($options['overrides']);
        }
        $newResource->set('id', 0);

        /* make sure children get assigned to new parent */
        $newResource->set('parent', isset($options['parent']) ? $options['parent'] : $this->get('parent'));
        $newResource->set('createdby', $this->xpdo->user->get('id'));
        $newResource->set('createdon', time());
        $newResource->set('editedby', 0);
        $newResource->set('editedon', 0);

        /* get new alias */
        $preserve_alias = $this->xpdo->getOption('preserve_alias', $options, false);
        $alias = $newResource->cleanAlias($newName);
        if ($this->xpdo->getOption('friendly_urls', $options, false)) {
            if (!($preserve_alias)) {
                /* auto assign alias */
                $aliasPath = $newResource->getAliasPath($newName);
                $dupeContext = $this->xpdo->getOption('global_duplicate_uri_check', $options,
                    false) ? '' : $newResource->get('context_key');
                if ($newResource->isDuplicateAlias($aliasPath, $dupeContext)) {
                    $alias = '';
                    if ($newResource->get('uri_override')) {
                        $newResource->set('uri_override', false);
                    }
                }
                $newResource->set('alias', $alias);
            }
        }

        $preserve_menuindex = $this->xpdo->getOption('preserve_menuindex', $options, false);
        /* set new menuindex */
        if (!$preserve_menuindex) {
            $menuindex = $this->xpdo->getCount(modResource::class, ['parent' => $this->get('parent')]);
            $newResource->set('menuindex', $menuindex);
        }

        /* save resource */
        if (!$newResource->save()) {
            return $this->xpdo->lexicon('resource_err_duplicate');
        }

        $tvds = $this->getMany('TemplateVarResources');
        /** @var modTemplateVarResource $oldTemplateVarResource */
        foreach ($tvds as $oldTemplateVarResource) {
            /** @var modTemplateVarResource $newTemplateVarResource */
            $newTemplateVarResource = $this->xpdo->newObject(modTemplateVarResource::class);
            $newTemplateVarResource->set('contentid', $newResource->get('id'));
            $newTemplateVarResource->set('tmplvarid', $oldTemplateVarResource->get('tmplvarid'));
            $newTemplateVarResource->set('value', $oldTemplateVarResource->get('value'));
            $newTemplateVarResource->save();
        }

        $groups = $this->getMany('ResourceGroupResources');
        /** @var modResourceGroupResource $oldResourceGroupResource */
        foreach ($groups as $oldResourceGroupResource) {
            /** @var modResourceGroupResource $newResourceGroupResource */
            $newResourceGroupResource = $this->xpdo->newObject(modResourceGroupResource::class);
            $newResourceGroupResource->set('document_group', $oldResourceGroupResource->get('document_group'));
            $newResourceGroupResource->set('document', $newResource->get('id'));
            $newResourceGroupResource->save();
        }

        /* duplicate resource, recursively */
        $duplicateChildren = isset($options['duplicateChildren']) ? $options['duplicateChildren'] : true;
        if ($duplicateChildren) {
            if (!$this->checkPolicy('add_children')) {
                return $newResource;
            }

            $criteria = [
                'context_key' => $this->get('context_key'),
                'parent' => $this->get('id'),
            ];

            $count = $this->xpdo->getCount(modResource::class, $criteria);

            if ($count > 0) {
                $children = $this->xpdo->getIterator(modResource::class, $criteria);

                /** @var modResource $child */
                foreach ($children as $child) {
                    $child->duplicate([
                        'duplicateChildren' => true,
                        'parent' => $newResource->get('id'),
                        'prefixDuplicate' => $prefixDuplicate,
                        'overrides' => !empty($options['overrides']) ? $options['overrides'] : false,
                        'publishedMode' => $publishedMode,
                        'preserve_alias' => $preserve_alias,
                        'preserve_menuindex' => $preserve_menuindex,
                    ]);
                }
            }
        }

        return $newResource;

    }

    /**
     * Joins a Resource to a Resource Group
     *
     * @access public
     *
     * @param mixed   $resourceGroupPk Either the ID, name or object of the Resource Group
     * @param boolean $byName          Force the criteria to check by name for Numeric usergroup's name
     *
     * @return boolean True if successful.
     */
    public function joinGroup($resourceGroupPk, $byName = false)
    {
        if (!is_object($resourceGroupPk) && !($resourceGroupPk instanceof modResourceGroup)) {
            if ($byName) {
                $c = [
                    'name' => $resourceGroupPk,
                ];
            } else {
                $c = [
                    is_int($resourceGroupPk) ? 'id' : 'name' => $resourceGroupPk,
                ];
            }
            /** @var modResourceGroup $resourceGroup */
            $resourceGroup = $this->xpdo->getObject(modResourceGroup::class, $c);
            if (empty($resourceGroup) || !is_object($resourceGroup) || !($resourceGroup instanceof modResourceGroup)) {
                $this->xpdo->log(modX::LOG_LEVEL_ERROR, __METHOD__ . ' - No resource group: ' . $resourceGroupPk);

                return false;
            }
        } else {
            $resourceGroup =& $resourceGroupPk;
        }

        if ($this->isMember($resourceGroup->get('name'))) {
            $this->xpdo->log(modX::LOG_LEVEL_ERROR,
                __METHOD__ . ' - Resource ' . $this->get('id') . ' already in resource group: ' . $resourceGroupPk);

            return false;
        }
        /** @var modResourceGroupResource $resourceGroupResource */
        $resourceGroupResource = $this->xpdo->newObject(modResourceGroupResource::class);
        $resourceGroupResource->set('document', $this->get('id'));
        $resourceGroupResource->set('document_group', $resourceGroup->get('id'));

        return $resourceGroupResource->save();
    }

    /**
     * Removes a Resource from a Resource Group
     *
     * @access public
     *
     * @param int|string|modResourceGroup $resourceGroupPk Either the ID, name or object of the Resource Group
     *
     * @return boolean True if successful.
     */
    public function leaveGroup($resourceGroupPk)
    {
        if (!is_object($resourceGroupPk) && !($resourceGroupPk instanceof modResourceGroup)) {
            $c = [
                is_int($resourceGroupPk) ? 'id' : 'name' => $resourceGroupPk,
            ];
            /** @var modResourceGroup $resourceGroup */
            $resourceGroup = $this->xpdo->getObject(modResourceGroup::class, $c);
            if (empty($resourceGroup) || !is_object($resourceGroup) || !($resourceGroup instanceof modResourceGroup)) {
                $this->xpdo->log(modX::LOG_LEVEL_ERROR,
                    __METHOD__ . ' - No resource group: ' . (is_object($resourceGroupPk) ? $resourceGroupPk->get('name') : $resourceGroupPk));

                return false;
            }
        } else {
            $resourceGroup =& $resourceGroupPk;
        }

        if (!$this->isMember($resourceGroup->get('name'))) {
            $this->xpdo->log(modX::LOG_LEVEL_ERROR,
                __METHOD__ . ' - Resource ' . $this->get('id') . ' is not in resource group: ' . (is_object($resourceGroupPk) ? $resourceGroupPk->get('name') : $resourceGroupPk));

            return false;
        }
        /** @var modResourceGroupResource $resourceGroupResource */
        $resourceGroupResource = $this->xpdo->getObject(modResourceGroupResource::class, [
            'document' => $this->get('id'),
            'document_group' => $resourceGroup->get('id'),
        ]);

        return $resourceGroupResource->remove();
    }

    /**
     * Gets a sortable, limitable collection (and total count) of Resource Groups for the Resource.
     *
     * @param array $sort   An array of sort columns in column => direction format.
     * @param int   $limit  A limit of records to retrieve in the collection.
     * @param int   $offset A record offset for a limited collection.
     *
     * @return array An array containing the collection and total.
     */
    public function getGroupsList(array $sort = ['id' => 'ASC'], $limit = 0, $offset = 0)
    {
        return $this->xpdo->call(modResource::class, 'listGroups', [&$this, $sort, $limit, $offset]);
    }

    /**
     * Gets all the Resource Group names of the resource groups this resource is assigned to.
     *
     * @access public
     * @return array An array of Resource Group names.
     */
    public function getResourceGroupNames()
    {
        $resourceGroupNames = [];

        $resourceGroups = $this->xpdo->getCollectionGraph(modResourceGroup::class, '{"ResourceGroupResources":{}}',
            ['ResourceGroupResources.document' => $this->get('id')]);

        if ($resourceGroups) {
            /** @var modResourceGroup $resourceGroup */
            foreach ($resourceGroups as $resourceGroup) {
                $resourceGroupNames[] = $resourceGroup->get('name');
            }
        }

        return $resourceGroupNames;
    }

    /**
     * States whether a resource is a member of a resource group or groups. You may specify
     * either a string name of the resource group, or an array of names.
     *
     * @access public
     *
     * @param string|array $groups   Either a string of a resource group name or an array
     *                               of names.
     * @param boolean      $matchAll If true, requires the resource to be a member of all
     *                               the resource groups specified. If false, the resource can be a member of only one to
     *                               pass. Defaults to false.
     *
     * @return boolean True if the resource is a member of any of the resource groups
     * specified.
     */
    public function isMember($groups, $matchAll = false)
    {
        $isMember = false;
        $resourceGroupNames = $this->getResourceGroupNames();

        if ($resourceGroupNames) {
            if (is_array($groups)) {
                if ($matchAll) {
                    $matches = array_diff($groups, $resourceGroupNames);
                    $isMember = empty($matches);
                } else {
                    $matches = array_intersect($groups, $resourceGroupNames);
                    $isMember = !empty($matches);
                }
            } else {
                $isMember = (array_search($groups, $resourceGroupNames) !== false);
            }
        }

        return $isMember;
    }

    /**
     * Determine the controller path for this Resource class
     *
     * @static
     *
     * @param xPDO $modx A reference to the modX object
     *
     * @return string The absolute path to the controller for this Resource class
     */
    public static function getControllerPath(xPDO &$modx)
    {
        $theme = $modx->getOption('manager_theme', null, 'default');
        $controllersPath = $modx->getOption('manager_path', null, MODX_MANAGER_PATH) . 'controllers/' . $theme . '/';

        return $controllersPath . 'resource/';
    }

    /**
     * Use this in your extended Resource class to display the text for the context menu item, if showInContextMenu is
     * set to true.
     *
     * @return array
     */
    public function getContextMenuText()
    {
        return [
            'text_create' => $this->xpdo->lexicon('resource'),
            'text_create_here' => $this->xpdo->lexicon('resource_create_here'),
        ];
    }

    /**
     * Use this in your extended Resource class to return a translatable name for the Resource Type.
     *
     * @return string
     */
    public function getResourceTypeName()
    {
        $className = $this->_class;
        if ($className == modDocument::class) {
            $className = 'document';
        }

        return $this->xpdo->lexicon($className);
    }

    /**
     * Use this in your extended Resource class to modify the tree node contents
     *
     * @param array $node
     *
     * @return array
     */
    public function prepareTreeNode(array $node = [])
    {
        return $node;
    }

    /**
     * Get a namespaced property for the Resource
     *
     * @param string $key
     * @param string $namespace
     * @param null   $default
     *
     * @return null
     */
    public function getProperty($key, $namespace = 'core', $default = null)
    {
        $properties = $this->get('properties');
        $properties = !empty($properties) ? $properties : [];

        return array_key_exists($namespace, $properties) && array_key_exists($key,
            $properties[$namespace]) ? $properties[$namespace][$key] : $default;
    }

    /**
     * Get the properties for the specific namespace for the Resource
     *
     * @param string $namespace
     *
     * @return array
     */
    public function getProperties($namespace = 'core')
    {
        $properties = $this->get('properties');
        $properties = !empty($properties) ? $properties : [];

        return array_key_exists($namespace, $properties) ? $properties[$namespace] : [];
    }

    /**
     * Set a namespaced property for the Resource
     *
     * @param string $key
     * @param mixed  $value
     * @param string $namespace
     *
     * @return bool
     */
    public function setProperty($key, $value, $namespace = 'core')
    {
        $properties = $this->get('properties');
        $properties = !empty($properties) ? $properties : [];
        if (!array_key_exists($namespace, $properties)) {
            $properties[$namespace] = [];
        }
        $properties[$namespace][$key] = $value;

        return $this->set('properties', $properties);
    }

    /**
     * Set properties for a namespace on the Resource, optionally merging them with existing ones.
     *
     * @param array  $newProperties
     * @param string $namespace
     * @param bool   $merge
     *
     * @return boolean
     */
    public function setProperties(array $newProperties, $namespace = 'core', $merge = true)
    {
        $properties = $this->get('properties');
        $properties = !empty($properties) ? $properties : [];
        if (!array_key_exists($namespace, $properties)) {
            $properties[$namespace] = [];
        }
        $properties[$namespace] = $merge ? array_merge($properties[$namespace], $newProperties) : $newProperties;

        return $this->set('properties', $properties);
    }

    /**
     * Clear the cache of this resource in the current or specified Context.
     *
     * @param string $context Key of context for clearing
     *
     * @return void
     */
    public function clearCache($context = '')
    {
        /** @var xPDOCache $cache */
        $cache = $this->xpdo->cacheManager->getCacheProvider(
            $this->xpdo->getOption('cache_resource_key', null, 'resource'),
            [
                xPDO::OPT_CACHE_HANDLER => $this->xpdo->getOption('cache_resource_handler', null,
                    $this->xpdo->getOption(xPDO::OPT_CACHE_HANDLER, null, 'xPDO\Cache\xPDOFileCache')),
                xPDO::OPT_CACHE_EXPIRES => (integer)$this->xpdo->getOption('cache_resource_expires', null,
                    $this->xpdo->getOption(xPDO::OPT_CACHE_EXPIRES, null, 0)),
                xPDO::OPT_CACHE_FORMAT => (integer)$this->xpdo->getOption('cache_resource_format', null,
                    $this->xpdo->getOption(xPDO::OPT_CACHE_FORMAT, null, xPDOCacheManager::CACHE_PHP)),
                xPDO::OPT_CACHE_ATTEMPTS => (integer)$this->xpdo->getOption('cache_resource_attempts', null,
                    $this->xpdo->getOption(xPDO::OPT_CACHE_ATTEMPTS, null, 10)),
                xPDO::OPT_CACHE_ATTEMPT_DELAY => (integer)$this->xpdo->getOption('cache_resource_attempt_delay', null,
                    $this->xpdo->getOption(xPDO::OPT_CACHE_ATTEMPT_DELAY, null, 1000)),
            ]
        );
        $key = $this->getCacheKey($context);
        $cache->delete($key, ['deleteTop' => true]);
        $cache->delete($key);
        if ($this->xpdo instanceof modX) {
            $this->xpdo->invokeEvent('OnResourceCacheUpdate', ['id' => $this->get('id')]);
        }
    }
}