remote.php

<?php

use dokuwiki\Extension\RemotePlugin;
use dokuwiki\Remote\AccessDeniedException;

class remote_plugin_farmer extends RemotePlugin {
    /** @var helper_plugin_farmer hlp */
    protected $helper;

    /**
     * remote_plugin_struct constructor.
     */
    public function __construct()
    {
        parent::__construct();

        $this->helper = plugin_load('helper', 'farmer');
    }

    /**
     * Get the configured farm host
     *
     * @return string
     * @throws AccessDeniedException
     */
    public function getFarmhost(): string
    {
        $this->ensureAdmin();
        return $this->helper->getConfig()['base']['farmhost'];
    }

    /**
     * Get the configured base domain of the farmer
     * This could be an empty string, then farmhost will be used to determine an animal url
     *
     * @return string
     * @throws AccessDeniedException
     */
    public function getBaseDomain(): string
    {
        $this->ensureAdmin();
        return $this->helper->getConfig()['base']['basedomain'];
    }

    /**
     * Get a list of all animal names
     *
     * @return array
     * @throws AccessDeniedException
     */
    public function listAnimals(): array
    {
        $this->ensureAdmin();
        return $this->helper->getAllAnimals();
    }

    /**
     * Get a list of all animal urls
     *
     * @return array
     * @throws AccessDeniedException
     */
    public function listAnimalUrls(): array
    {
        $this->ensureAdmin();
        foreach($this->helper->getAllAnimals() as $animal) {
            $animalUrls[] = $this->helper->getAnimalURL($animal);
        }
        return $animalUrls;
    }

    /**
     * Get configuration details of farmer plugin enriched by list of animals
     *
     * @return array
     * @throws AccessDeniedException
     */
    public function getFarmerConfig(): array
    {
        $this->ensureAdmin();
        $farmerConfig = $this->helper->getConfig();
        foreach($this->helper->getAllAnimals() as $index=>$animal) {
            $farmerConfig['animals'][$index]["name"] =$animal;
            $farmerConfig['animals'][$index]["url"] = $this->helper->getAnimalURL($animal);
        }
        return $farmerConfig;
    }

    /**
     * @throws AccessDeniedException
     */
    private function ensureAdmin() {
        if (!auth_isadmin()) {
            throw new AccessDeniedException(
                'You are not allowed to access farmer configuration, superuser permission is required',
                114
            );
        }
    }
}