summaryrefslogtreecommitdiff
path: root/vendor/miniflux/picofeed/lib/PicoFeed/Syndication/FeedBuilder.php
blob: cf9d024e1572d5d55bc2a4e393ebbd66ba4f8e0e (plain)
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<?php

namespace PicoFeed\Syndication;

use DateTime;
use DOMDocument;

/**
 * Class FeedBuilder
 *
 * @package PicoFeed\Syndication
 * @author  Frederic Guillot
 */
abstract class FeedBuilder
{
    /**
     * @var DOMDocument
     */
    protected $document;

    /**
     * @var string
     */
    protected $feedTitle;

    /**
     * @var string
     */
    protected $feedUrl;

    /**
     * @var string
     */
    protected $siteUrl;

    /**
     * @var string
     */
    protected $authorName;

    /**
     * @var string
     */
    protected $authorEmail;

    /**
     * @var string
     */
    protected $authorUrl;

    /**
     * @var DateTime
     */
    protected $feedDate;

    /**
     * @var ItemBuilder[]
     */
    protected $items = array();

    /**
     * Constructor
     *
     * @access public
     */
    public function __construct()
    {
        $this->document = new DomDocument('1.0', 'UTF-8');
        $this->document->formatOutput = true;
    }

    /**
     * Get new object instance
     *
     * @access public
     * @return static
     */
    public static function create()
    {
        return new static();
    }

    /**
     * Add feed title
     *
     * @access public
     * @param  string $title
     * @return $this
     */
    public function withTitle($title)
    {
        $this->feedTitle = $title;
        return $this;
    }

    /**
     * Add feed url
     *
     * @access public
     * @param  string $url
     * @return $this
     */
    public function withFeedUrl($url)
    {
        $this->feedUrl = $url;
        return $this;
    }

    /**
     * Add website url
     *
     * @access public
     * @param  string $url
     * @return $this
     */
    public function withSiteUrl($url)
    {
        $this->siteUrl = $url;
        return $this;
    }

    /**
     * Add feed date
     *
     * @access public
     * @param  DateTime $date
     * @return $this
     */
    public function withDate(DateTime $date)
    {
        $this->feedDate = $date;
        return $this;
    }

    /**
     * Add feed author
     *
     * @access public
     * @param  string  $name
     * @param  string  $email
     * @param  string  $url
     * @return $this
     */
    public function withAuthor($name, $email = '', $url ='')
    {
        $this->authorName = $name;
        $this->authorEmail = $email;
        $this->authorUrl = $url;
        return $this;
    }

    /**
     * Add feed item
     *
     * @access public
     * @param  ItemBuilder $item
     * @return $this
     */
    public function withItem(ItemBuilder $item)
    {
        $this->items[] = $item;
        return $this;
    }

    /**
     * Get DOM document
     *
     * @access public
     * @return DOMDocument
     */
    public function getDocument()
    {
        return $this->document;
    }

    /**
     * Build feed
     *
     * @abstract
     * @access public
     * @param  string $filename
     * @return string
     */
    abstract public function build($filename = '');
}