modxcms/revolution

<?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.
 */

/**
 * Defines criteria a principal must satisfy in order to access an object.
 *
 * @property string $name The name of this Policy
 * @property string $description The description of this Policy.
 * @property int $parent The parent Policy of this Policy. Not currently used.
 * @property int $template The Access Policy Template this Policy belongs to
 * @property string $class Deprecated
 * @property json $data A JSON object that contains all Permissions loaded in this Policy
 * @property string $lexicon Optional. The lexicon to load to provide the translated names/descriptions for the
 * Permissions included
 *
 * @see modAccessPolicyTemplate
 * @see modAccessPermission
 * @package modx
 */
class modAccessPolicy extends xPDOSimpleObject {
    /**
     * Get the permissions for this access policy, in array format.
     *
     * @return array An array of access permissions for this Policy.
     */
    public function getPermissions() {
        $template = $this->getOne('Template');
        if (empty($template)) return array();

        /* get permissions for policy */
        $c = $this->xpdo->newQuery('modAccessPermission');
        $c->sortby('name','ASC');
        $permissions = $template->getMany('Permissions',$c);

        $data = $this->get('data');
        $lexicon = $template->get('lexicon');
        $list = array();
        /** @var modAccessPermission $permission */
        foreach ($permissions as $permission) {
            $desc = $permission->get('description');
            if (!empty($lexicon) && $this->xpdo->lexicon) {
                if (strpos($lexicon,':') !== false) {
                    $this->xpdo->lexicon->load($lexicon);
                } else {
                    $this->xpdo->lexicon->load('core:'.$lexicon);
                }
                $desc = $this->xpdo->lexicon($desc);
            }
            $active = array_key_exists($permission->get('name'),$data) && $data[$permission->get('name')] ? 1 : 0;
            $list[] = array(
                $permission->get('name'),
                $permission->get('description'),
                $desc,
                $permission->get('value'),
                $active,
            );
        }
        return $list;
    }
}