modxcms/revolution

View on GitHub
core/model/modx/processors/element/getclasses.class.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php
/*
 * This file is part of MODX Revolution.
 *
 * Copyright (c) MODX, LLC. All Rights Reserved.
 *
 * For complete copyright and license information, see the COPYRIGHT and LICENSE
 * files found in the top-level directory of this distribution.
 */

/**
 * Outputs a list of Element subclasses
 *
 * @deprecated Use $modx->getDescendants($className) now
 *
 * @package modx
 * @subpackage processors.element
 */
class modElementGetClassesProcessor extends modProcessor {
    public function checkPermissions() {
        return $this->modx->hasPermission('view_element');
    }

    public function initialize() {
        $this->setDefaultProperties(array(
            'limit' => 10,
            'start' => 0,
            'sort' => 'class',
            'dir' => 'ASC',
        ));
        return true;
    }

    public function process() {
        $this->modx->deprecated('2.1.4', 'Please use $modx->getDescendants($className) now.', 'modElementGetClassesProcessor support');

        $limit = $this->getProperty('limit',10);
        $isLimit = !empty($limit);

        /* build query */
        $c = $this->modx->newQuery('modClassMap');
        $c->where(array(
            'parent_class' => 'modElement',
            'class:!=' => 'modTemplate',
        ));
        $c->sortby($this->getProperty('sort'),$this->getProperty('dir'));
        $name = $this->getProperty('name','');
        if (!empty($name)) {
            $c->where(array(
                'modClassMap.name:IN' => is_string($name) ? explode(',', $name) : $name,
            ));
        }
        if ($isLimit) $c->limit($limit,$this->getProperty('start'));
        $classes = $this->modx->getCollection('modClassMap',$c);

        /* iterate */
        $list = array();
        /** @var modClassMap $class */
        foreach ($classes as $class) {
            $el = array( 'name' => $class->get('class') );
            $list[] = $el;
        }
        return $this->outputArray($list);
    }
}
return 'modElementGetClassesProcessor';