6 | 
](https://spatie.be/github-ad-click/laravel-feed)
25 |
26 | We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
27 |
28 | We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
29 |
30 | ## Installation
31 |
32 | You can install the package via composer:
33 |
34 | ``` bash
35 | composer require spatie/laravel-feed
36 | ```
37 |
38 | Register the routes the feeds will be displayed on using the `feeds`-macro.
39 |
40 | ```php
41 | // In routes/web.php
42 | Route::feeds();
43 | ```
44 |
45 | Optionally, you can pass a string as a first argument of the macro. The string will be used as a URL prefix for all configured feeds.
46 |
47 | Next, you must publish the config file:
48 |
49 | ```bash
50 | php artisan feed:install
51 | ```
52 |
53 | Here's what that looks like:
54 |
55 | ```php
56 | return [
57 | 'feeds' => [
58 | 'main' => [
59 | /*
60 | * Here you can specify which class and method will return
61 | * the items that should appear in the feed. For example:
62 | * [App\Model::class, 'getAllFeedItems']
63 | *
64 | * You can also pass an argument to that method. Note that their key must be the name of the parameter: *
65 | * [App\Model::class, 'getAllFeedItems', 'parameterName' => 'argument']
66 | */
67 | 'items' => '',
68 |
69 | /*
70 | * The feed will be available on this url.
71 | */
72 | 'url' => '',
73 |
74 | 'title' => 'My feed',
75 | 'description' => 'The description of the feed.',
76 | 'language' => 'en-US',
77 |
78 | /*
79 | * The image to display for the feed. For Atom feeds, this is displayed as
80 | * a banner/logo; for RSS and JSON feeds, it's displayed as an icon.
81 | * An empty value omits the image attribute from the feed.
82 | */
83 | 'image' => '',
84 |
85 | /*
86 | * The format of the feed. Acceptable values are 'rss', 'atom', or 'json'.
87 | */
88 | 'format' => 'atom',
89 |
90 | /*
91 | * The view that will render the feed.
92 | */
93 | 'view' => 'feed::atom',
94 |
95 | /*
96 | * The mime type to be used in the tag. Set to an empty string to automatically
97 | * determine the correct value.
98 | */
99 | 'type' => '',
100 |
101 | /*
102 | * The content type for the feed response. Set to an empty string to automatically
103 | * determine the correct value.
104 | */
105 | 'contentType' => '',
106 | ],
107 | ],
108 | ];
109 | ```
110 |
111 | Optionally you can publish the view files:
112 |
113 | ```bash
114 | php artisan vendor:publish --provider="Spatie\Feed\FeedServiceProvider" --tag="feed-views"
115 | ```
116 |
117 | ## Usage
118 |
119 | Imagine you have a model named `NewsItem` that contains records that you want to have displayed in the feed.
120 |
121 | First you must implement the `Feedable` interface on that model. `Feedable` expects one method: `toFeedItem`, which should return a `FeedItem` instance.
122 |
123 | ```php
124 | // app/NewsItem.php
125 |
126 | use Illuminate\Database\Eloquent\Model;
127 | use Spatie\Feed\Feedable;
128 | use Spatie\Feed\FeedItem;
129 |
130 | class NewsItem extends Model implements Feedable
131 | {
132 | public function toFeedItem(): FeedItem
133 | {
134 | return FeedItem::create()
135 | ->id($this->id)
136 | ->title($this->title)
137 | ->summary($this->summary)
138 | ->updated($this->updated_at)
139 | ->link($this->link)
140 | ->authorName($this->author)
141 | ->authorEmail($this->authorEmail);
142 | }
143 | }
144 | ```
145 |
146 | If you prefer, returning an associative array with the necessary keys will do the trick too.
147 |
148 | ```php
149 | // app/NewsItem.php
150 |
151 | use Illuminate\Database\Eloquent\Model;
152 | use Spatie\Feed\Feedable;
153 | use Spatie\Feed\FeedItem;
154 |
155 | class NewsItem extends Model implements Feedable
156 | {
157 | public function toFeedItem(): FeedItem
158 | {
159 | return FeedItem::create([
160 | 'id' => $this->id,
161 | 'title' => $this->title,
162 | 'summary' => $this->summary,
163 | 'updated' => $this->updated_at,
164 | 'link' => $this->link,
165 | 'authorName' => $this->authorName,
166 | ]);
167 | }
168 | }
169 | ```
170 |
171 | Next, you'll have to create a method that will return all the items that must be displayed in
172 | the feed. You can name that method anything you like and you can do any query you want.
173 |
174 | ```php
175 | // app/NewsItem.php
176 |
177 | public static function getFeedItems()
178 | {
179 | return NewsItem::all();
180 | }
181 | ```
182 |
183 | Finally, you have to put the name of your class and the url where you want the feed to rendered
184 | in the config file:
185 |
186 | ```php
187 | // config/feed.php
188 |
189 | return [
190 |
191 | 'feeds' => [
192 | 'news' => [
193 | /*
194 | * Here you can specify which class and method will return
195 | * the items that should appear in the feed. For example:
196 | * 'App\Model@getAllFeedItems'
197 | * or
198 | * ['App\Model', 'getAllFeedItems']
199 | *
200 | * You can also pass an argument to that method. Note that their key must be the name of the parameter: *
201 | * ['App\Model@getAllFeedItems', 'parameterName' => 'argument']
202 | * or
203 | * ['App\Model', 'getAllFeedItems', 'parameterName' => 'argument']
204 | */
205 | 'items' => 'App\NewsItem@getFeedItems',
206 |
207 | /*
208 | * The feed will be available on this url.
209 | */
210 | 'url' => '/feed',
211 |
212 | 'title' => 'All newsitems on mysite.com',
213 |
214 | /*
215 | * The format of the feed. Acceptable values are 'rss', 'atom', or 'json'.
216 | */
217 | 'format' => 'atom',
218 |
219 | /*
220 | * Custom view for the items.
221 | *
222 | * Defaults to feed::feed if not present.
223 | */
224 | 'view' => 'feed::feed',
225 | ],
226 | ],
227 |
228 | ];
229 | ```
230 |
231 | The `items` key must point to a method that returns one of the following:
232 |
233 | - An array or collection of `Feedable`s
234 | - An array or collection of `FeedItem`s
235 | - An array or collection of arrays containing feed item values
236 |
237 | ### Customizing your feed views
238 |
239 | This package provides, out of the box, the `feed::feed` view that displays your feeds details.
240 |
241 | However, you could use a custom view per feed by providing a `view` key inside of your feed configuration.
242 |
243 | In the following example, we're using the previous `News` feed with a custom `feeds.news` view (located on `resources/views/feeds/news.blade.php`):
244 |
245 | ```php
246 | // config/feed.php
247 |
248 | return [
249 |
250 | 'feeds' => [
251 | 'news' => [
252 | 'items' => ['App\NewsItem', 'getFeedItems'],
253 |
254 | 'url' => '/feed',
255 |
256 | 'title' => 'All newsitems on mysite.com',
257 |
258 | /*
259 | * The format of the feed. Acceptable values are 'rss', 'atom', or 'json'.
260 | */
261 | 'format' => 'atom',
262 |
263 | /*
264 | * Custom view for the items.
265 | *
266 | * Defaults to feed::feed if not present.
267 | */
268 | 'view' => 'feeds.news',
269 | ],
270 | ],
271 |
272 | ];
273 | ```
274 |
275 | ### Automatically generate feed links
276 |
277 | To discover a feed, feed readers are looking for a tag in the head section of your html documents that looks like this:
278 |
279 | ```html
280 |
281 | ```
282 |
283 | You can add this to your `` through a partial view.
284 |
285 | ```php
286 | @include('feed::links')
287 | ```
288 |
289 | As an alternative you can use this blade component:
290 |
291 | ```html
292 |
60 |
61 |
62 |
64 |
67 |
68 |
69 |
71 |
72 |
73 | Published on
74 |
76 |