app/EventBuilder/BaseEventBuilder.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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

<?php

namespace Kanboard\EventBuilder;

use Kanboard\Core\Base;
use Kanboard\Event\GenericEvent;

/**
 * Class BaseEventBuilder
 *
 * @package Kanboard\EventBuilder
 * @author  Frederic Guillot
 */
abstract class BaseEventBuilder extends Base
{
    /**
     * Build event data
     *
     * @access public
     * @return GenericEvent|null
     */
    abstract public function buildEvent();

    /**
     * Get event title with author
     *
     * @access public
     * @param  string $author
     * @param  string $eventName
     * @param  array  $eventData
     * @return string
     */
    abstract public function buildTitleWithAuthor($author, $eventName, array $eventData);

    /**
     * Get event title without author
     *
     * @access public
     * @param  string $eventName
     * @param  array  $eventData
     * @return string
     */
    abstract public function buildTitleWithoutAuthor($eventName, array $eventData);
}