Skip to content

Commit f59589b

Browse files
andrey-helldarandrey-helldar
authored
Merge pull request #73 from TheDragonCode/1.x
Added directives section to documentation
2 parents 6e3bb28 + 2a14c19 commit f59589b

File tree

7 files changed

+146
-8
lines changed

7 files changed

+146
-8
lines changed

‎docs/snippets/advanced-directive-attributes.php‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace App\Feeds\Items;
6+
7+
use DragonCode\LaravelFeed\Feeds\Items\FeedItem;
8+
9+
class UserFeedItem extends FeedItem
10+
{
11+
protected ?string $name = 'users';
12+
13+
public function toArray(): array
14+
{
15+
return [
16+
'some' => [
17+
'@attributes' => [
18+
'foo' => 'bar',
19+
'qwe' => 'rty',
20+
],
21+
],
22+
];
23+
}
24+
}

‎docs/snippets/advanced-directive-attributes.xml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<users>
2+
<some foo="bar" qwe="rty" />
3+
</users>

‎docs/snippets/advanced-directive-cdata.php‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace App\Feeds\Items;
6+
7+
use DragonCode\LaravelFeed\Feeds\Items\FeedItem;
8+
9+
class UserFeedItem extends FeedItem
10+
{
11+
protected ?string $name = 'users';
12+
13+
public function toArray(): array
14+
{
15+
return [
16+
'name' => [
17+
'@cdata' => '<h1>Sauron</h1>',
18+
],
19+
20+
'weapon' => 'Evil Eye',
21+
];
22+
}
23+
}

‎docs/snippets/advanced-directive-cdata.xml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<users>
2+
<name><![CDATA[<h1>Sauron</h1>]]></name>
3+
<weapon>Evil Eye</weapon>
4+
</users>

‎docs/snippets/advanced-directive-value.php‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace App\Feeds\Items;
6+
7+
use DragonCode\LaravelFeed\Feeds\Items\FeedItem;
8+
9+
class UserFeedItem extends FeedItem
10+
{
11+
protected ?string $name = 'users';
12+
13+
public function toArray(): array
14+
{
15+
return [
16+
'foo' => 'Chris Evans',
17+
18+
'bar' => [
19+
'@value' => 'Sebastian Stan',
20+
],
21+
22+
'baz' => [
23+
'@attributes' => ['foo' => 'bar'],
24+
'@value' => 'Matthew David McConaughey',
25+
],
26+
];
27+
}
28+
}

‎docs/snippets/advanced-directive-value.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<users>
2+
<foo>Chris Evans</foo>
3+
<bar>Sebastian Stan</bar>
4+
<baz foo="bar">Matthew David McConaughey</baz>
5+
</users>

‎docs/topics/advanced-usage.topic‎

Lines changed: 59 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@
1717
<format style="bold">Reserved words:</format>
1818
</p>
1919
<list>
20-
<li>@attributes</li>
21-
<li>@cdata</li>
22-
<li>@mixed</li>
23-
<li>@value</li>
20+
<li><a href="#_attributes" /></li>
21+
<li><a href="#_value" /></li>
22+
<li><a href="#_cdata" /></li>
23+
<li><a href="#_mixed" /></li>
2424
</list>
2525
</note>
2626

@@ -82,7 +82,7 @@
8282
<code-block lang="php" src="advanced-dog-char.php" include-lines="5-" />
8383

8484
<p>
85-
Result:
85+
This code will result in:
8686
</p>
8787

8888
<code-block lang="xml" src="advanced-doc-char-result.xml" />
@@ -98,7 +98,7 @@
9898
<code-block lang="php" src="advanced-value-word.php" include-lines="5-" />
9999

100100
<p>
101-
Result:
101+
This code will result in:
102102
</p>
103103

104104
<code-block lang="xml" src="advanced-value-word-result.xml" />
@@ -107,15 +107,66 @@
107107
</chapter>
108108

109109
<chapter title="Directives" id="directives">
110-
<chapter title="Mixed" id="mixed">
110+
<chapter title="@attributes" id="_attributes">
111+
<p>
112+
You can use a key named <code>@attributes</code> to add attributes to a node:
113+
</p>
114+
115+
<code-block lang="php" src="advanced-directive-attributes.php" include-lines="5-" />
116+
117+
<p>
118+
This code will result in:
119+
</p>
120+
121+
<code-block lang="xml" src="advanced-directive-attributes.xml" />
122+
</chapter>
123+
124+
<chapter title="@value" id="_value">
125+
<tip>
126+
Note, that the value of the <code>@value</code> field must be a string.
127+
</tip>
128+
129+
<p>
130+
You can use a key named <code>@value</code> to add value to a node:
131+
</p>
132+
133+
<code-block lang="php" src="advanced-directive-value.php" include-lines="5-" />
134+
135+
<p>
136+
This code will result in:
137+
</p>
138+
139+
<code-block lang="xml" src="advanced-directive-value.xml" />
140+
</chapter>
141+
142+
<chapter title="@cdata" id="_cdata">
143+
<tip>
144+
It is also possible to wrap the value of a node into a CDATA section.
145+
This allows you to use reserved characters.
146+
</tip>
147+
148+
<p>
149+
You can use a key named <code>@cdata</code> to add CDATA to a node:
150+
</p>
151+
152+
<code-block lang="php" src="advanced-directive-cdata.php" include-lines="5-" />
153+
154+
<p>
155+
This code will result in:
156+
</p>
157+
158+
<code-block lang="xml" src="advanced-directive-cdata.xml" />
159+
</chapter>
160+
161+
<chapter title="@mixed" id="_mixed">
111162
<p>
112163
To insert XML fragments “as is”, use the <code>@mixed</code> directive:
113164
</p>
114165

115166
<code-block lang="php" src="advanced-directive-mixed.php" include-lines="5-" />
116167

117168
<p>
118-
Result:
169+
This code will result in:
119170
</p>
120171

121172
<code-block lang="xml" src="advanced-directive-mixed.xml" />

0 commit comments

Comments
 (0)