summaryrefslogtreecommitdiff
path: root/vendor/miniflux/picofeed/lib/PicoFeed/Syndication/ItemBuilder.php
blob: 86985bc73b0fc361f23d5f3c4e145495b6d25c2d (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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<?php

namespace PicoFeed\Syndication;

use DateTime;
use DOMElement;

/**
 * Class ItemBuilder
 *
 * @package PicoFeed\Syndication
 * @author  Frederic Guillot
 */
abstract class ItemBuilder
{
    /**
     * @var string
     */
    protected $itemTitle;

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

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

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

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

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

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

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

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

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

    /**
     * @var FeedBuilder
     */
    protected $feedBuilder;

    /**
     * Constructor
     *
     * @param FeedBuilder $feedBuilder
     */
    public function __construct(FeedBuilder $feedBuilder)
    {
        $this->feedBuilder = $feedBuilder;
    }

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

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

    /**
     * Add item id
     *
     * @access public
     * @param  string $id
     * @return $this
     */
    public function withId($id)
    {
        $this->itemId = $id;
        return $this;
    }

    /**
     * Add item url
     *
     * @access public
     * @param  string $url
     * @return $this
     */
    public function withUrl($url)
    {
        $this->itemUrl = $url;
        return $this;
    }

    /**
     * Add item summary
     *
     * @access public
     * @param  string $summary
     * @return $this
     */
    public function withSummary($summary)
    {
        $this->itemSummary = $summary;
        return $this;
    }

    /**
     * Add item content
     *
     * @access public
     * @param  string $content
     * @return $this
     */
    public function withContent($content)
    {
        $this->itemContent = $content;
        return $this;
    }

    /**
     * Add item updated date
     *
     * @access public
     * @param  DateTime $date
     * @return $this
     */
    public function withUpdatedDate(DateTime $date)
    {
        $this->itemUpdatedDate = $date;
        return $this;
    }

    /**
     * Add item published date
     *
     * @access public
     * @param  DateTime $date
     * @return $this
     */
    public function withPublishedDate(DateTime $date)
    {
        $this->itemPublishedDate = $date;
        return $this;
    }

    /**
     * Add item 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;
    }

    /**
     * Build item
     *
     * @abstract
     * @access public
     * @return DOMElement
     */
    abstract public function build();
}