HookReflector.php

<?php

namespace Aivec\Plugins\DocParser\Importer;

use phpDocumentor\Reflection\BaseReflector;
use PHPParser_PrettyPrinter_Default;

/**
 * Custom reflector for WordPress hooks.
 */
class HookReflector extends BaseReflector
{
    /**
     * Returns name
     *
     * @return string
     */
    public function getName() {
        $printer = new PHPParser_PrettyPrinter_Default();
        return $this->cleanupName($printer->prettyPrintExpr($this->node->args[0]->value));
    }

    /**
     * Cleans up name
     *
     * @param string $name
     * @return string
     */
    private function cleanupName($name) {
        $matches = [];

        // quotes on both ends of a string
        if (preg_match('/^[\'"]([^\'"]*)[\'"]$/', $name, $matches)) {
            return $matches[1];
        }

        // two concatenated things, last one of them a variable
        if (
            preg_match(
                '/(?:[\'"]([^\'"]*)[\'"]\s*\.\s*)?' . // First filter name string (optional)
                '(\$[^\s]*)' .                        // Dynamic variable
                '(?:\s*\.\s*[\'"]([^\'"]*)[\'"])?/',  // Second filter name string (optional)
                $name,
                $matches
            )
        ) {
            if (isset($matches[3])) {
                return $matches[1] . '{' . $matches[2] . '}' . $matches[3];
            } else {
                return $matches[1] . '{' . $matches[2] . '}';
            }
        }

        return $name;
    }

    /**
     * Returns short name
     *
     * @return string
     */
    public function getShortName() {
        return $this->getName();
    }

    /**
     * Returns type
     *
     * @return string
     */
    public function getType() {
        $type = 'filter';
        switch ((string)$this->node->name) {
            case 'do_action':
                $type = 'action';
                break;
            case 'do_action_ref_array':
                $type = 'action_reference';
                break;
            case 'do_action_deprecated':
                $type = 'action_deprecated';
                break;
            case 'apply_filters_ref_array':
                $type = 'filter_reference';
                break;
            case 'apply_filters_deprecated':
                $type = 'filter_deprecated';
                break;
        }

        return $type;
    }

    /**
     * Returns arguments
     *
     * @return array
     */
    public function getArgs() {
        $printer = new PrettyPrinter();
        $args = [];
        foreach ($this->node->args as $arg) {
            $args[] = $printer->prettyPrintArg($arg);
        }

        // Skip the filter name
        array_shift($args);

        return $args;
    }
}