inc/Parsing/Handler/ReWriterInterface.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

<?php

namespace dokuwiki\Parsing\Handler;

/**
 * A ReWriter takes over from the orignal call writer and handles all new calls itself until
 * the process method is called and control is given back to the original writer.
 */
interface ReWriterInterface extends CallWriterInterface
{

    /**
     * ReWriterInterface constructor.
     *
     * This rewriter will be registered as the new call writer in the Handler.
     * The original is passed as parameter
     *
     * @param CallWriterInterface $callWriter the original callwriter
     */
    public function __construct(CallWriterInterface $callWriter);

    /**
     * Process any calls that have been added and add them to the
     * original call writer
     *
     * @return CallWriterInterface the orignal call writer
     */
    public function process();
}