Проксирование псевдовызовов

Вчера при обсуждении Alto Coding Style aVadim высказал мысль

Вообще, в далекой перспективе мне хотелось бы изменить синтаксис псевдовызовов методов моделей и писать так: $this->ModuleUser->getUsersByFilter(); Но это сугубо личные предпочтения

По причине выходного дня и наличия немногого свободного времени — предлагаю экспромт на эту тему. Опять же не стоит относиться к предложению как к готовому решению — это всего лишь способ — может и вообще ненужный и не к месту (

Хочу обращаться к модулям и их методам так:

$aReturn = $this->modules->topic->getTopicsByFilter($aFilter,$iPage,$iPerPage,array('user','blog'));

А не так:

$aReturn = $this->Topic_GetTopicsByFilter($aFilter,$iPage,$iPerPage,array('user','blog'));

Вообщем в голову пришла мысль не менять существующий уклад в LS, а просто добавить проксирующие свойства, которые просто передавали бы данные в псевдовызовы. Организовать альтернативную форму записи – и вот что из этого получилось.

Задача: Убрать магию из вызовов методов модулей.
Что это даст: Автокомплит, PHPDoc, повысит читабельность кода, сделает возможным использовать инспектора кода

Решение

Без хака, конечно же, не обошлось, но изменения были внесены минимальные:
1. В класс LsObject добавлено свойство $modules, а конструктор класса – инициализация этого свойства – так:

abstract class LsObject {
    public $modules;
    public function __construct() {
        $this->modules = new modules();
    }

Сам класс modules прост и незамысловат – он получает лишь модуль по его имени:

class modules {
    public function __get($sName) {
        return Engine::getInstance()->getModule(ucwords($sName).'_')[0];
    }
}

2. В классе Module от которого наследуются все модули в конструктор добавим вызов родительского конструктора:

final public function __construct(Engine $oEngine) {
        parent::__construct(); // <-- здесь
        $this->oEngine = $oEngine;
    }

3. Тоже в конструктор сущности

    public function __construct($aParam = null) {
        parent::__construct();// <-- здесь
        $this->_setData($aParam);
        $this->Init();
    }

Теперь можно обращаться к методам модуля через данное свойство, так (это пример из плагина Categories — и он работает):

$aReturn = $this->modules->topic->getTopicsByFilter($aFilter,$iPage,$iPerPage,array('user','blog'));

И теперь доступен автокомплит и phpDoc!

Плагины

Для них на самом деле рабоает такой код:

Но это не очень красиво — внесем некоторые правки в файл класса LsObject^

class modules {
    private $sPluginName = "";

    public function __construct($sPluginName="") {
        $this->sPluginName = 'Plugin' . ucwords($sPluginName) . '_';
    }

    public function __get($sName) {
        return Engine::getInstance()->getModule(
            (($this->sPluginName=='Plugin_')?'':$this->sPluginName) . ucwords($sName).'_')[0];
    }
}

class plugins {
    private $modules;

    public function __get($sName) {
        $this->modules = new modules($sName);
        return $this;
    }
}

/**
 * От этого класса наследуются все остальные
 *
 * @package engine
 * @since 1.0
 */
abstract class LsObject {

    public $modules;

    public $plugins;

    public function __construct() {
        $this->modules = new modules();
        $this->plugins = new plugins();
    }

    // Здесь родной метод __call, но я его не указал
}

Это позволяет обращаться к модулям плагинов так:

Но здесь не работает автокомплит, для этих целей создадим в директории плагина файл, единственной целью которого будет доставлять возможность автокомплита и PHPDoc — вот содержимое этого файла:

<?php
die();
class plugins {

    /**
     * Плагин функционала категории для блогов и формировщик главной
     * @var PluginCategories_ModuleCategories
     */
    public $categories;
}

class modules {
    /**
     * Модуль управления категориями блогов
     * @var PluginCategories_ModuleCategories
     */
    public $categories;
}

Теперь автокомплит и документация доступна:


Заметьте — для свойства plugins автокомплит показывает перечень всех установленных плагинов (если они работают через проксирующие методы),а PHPDoc документацию по модулю и методам модуля :)

ЗЫ:

Да, этот подход позволяет сделать унифицированное правило именования методов — с маленькой буквы, как это обсуждалось в комментариях к статье об ACS (см. картинки к статье)