|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Spatie\SchemaOrg; |
|
4
|
|
|
|
|
5
|
|
|
/** |
|
6
|
|
|
* An article, such as a news article or piece of investigative report. |
|
7
|
|
|
* Newspapers and magazines have articles of many different types and this is |
|
8
|
|
|
* intended to cover them all. |
|
9
|
|
|
* |
|
10
|
|
|
* See also [blog |
|
11
|
|
|
* post](http://blog.schema.org/2014/09/schemaorg-support-for-bibliographic_2.html). |
|
12
|
|
|
* |
|
13
|
|
|
* @see http://schema.org/Article |
|
14
|
|
|
* |
|
15
|
|
|
* @mixin \Spatie\SchemaOrg\CreativeWork |
|
16
|
|
|
*/ |
|
17
|
|
|
class Article extends BaseType |
|
18
|
|
|
{ |
|
19
|
|
|
/** |
|
20
|
|
|
* The actual body of the article. |
|
21
|
|
|
* |
|
22
|
|
|
* @param string|string[] $articleBody |
|
23
|
|
|
* |
|
24
|
|
|
* @return static |
|
25
|
|
|
* |
|
26
|
|
|
* @see http://schema.org/articleBody |
|
27
|
|
|
*/ |
|
28
|
|
|
public function articleBody($articleBody) |
|
29
|
|
|
{ |
|
30
|
|
|
return $this->setProperty('articleBody', $articleBody); |
|
31
|
|
|
} |
|
32
|
|
|
|
|
33
|
|
|
/** |
|
34
|
|
|
* Articles may belong to one or more 'sections' in a magazine or newspaper, |
|
35
|
|
|
* such as Sports, Lifestyle, etc. |
|
36
|
|
|
* |
|
37
|
|
|
* @param string|string[] $articleSection |
|
38
|
|
|
* |
|
39
|
|
|
* @return static |
|
40
|
|
|
* |
|
41
|
|
|
* @see http://schema.org/articleSection |
|
42
|
|
|
*/ |
|
43
|
|
|
public function articleSection($articleSection) |
|
44
|
|
|
{ |
|
45
|
|
|
return $this->setProperty('articleSection', $articleSection); |
|
46
|
|
|
} |
|
47
|
|
|
|
|
48
|
|
|
/** |
|
49
|
|
|
* The page on which the work ends; for example "138" or "xvi". |
|
50
|
|
|
* |
|
51
|
|
|
* @param int|int[]|string|string[] $pageEnd |
|
52
|
|
|
* |
|
53
|
|
|
* @return static |
|
54
|
|
|
* |
|
55
|
|
|
* @see http://schema.org/pageEnd |
|
56
|
|
|
*/ |
|
57
|
|
|
public function pageEnd($pageEnd) |
|
58
|
|
|
{ |
|
59
|
|
|
return $this->setProperty('pageEnd', $pageEnd); |
|
60
|
|
|
} |
|
61
|
|
|
|
|
62
|
|
|
/** |
|
63
|
|
|
* The page on which the work starts; for example "135" or "xiii". |
|
64
|
|
|
* |
|
65
|
|
|
* @param int|int[]|string|string[] $pageStart |
|
66
|
|
|
* |
|
67
|
|
|
* @return static |
|
68
|
|
|
* |
|
69
|
|
|
* @see http://schema.org/pageStart |
|
70
|
|
|
*/ |
|
71
|
|
|
public function pageStart($pageStart) |
|
72
|
|
|
{ |
|
73
|
|
|
return $this->setProperty('pageStart', $pageStart); |
|
74
|
|
|
} |
|
75
|
|
|
|
|
76
|
|
|
/** |
|
77
|
|
|
* Any description of pages that is not separated into pageStart and |
|
78
|
|
|
* pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". |
|
79
|
|
|
* |
|
80
|
|
|
* @param string|string[] $pagination |
|
81
|
|
|
* |
|
82
|
|
|
* @return static |
|
83
|
|
|
* |
|
84
|
|
|
* @see http://schema.org/pagination |
|
85
|
|
|
*/ |
|
86
|
|
|
public function pagination($pagination) |
|
87
|
|
|
{ |
|
88
|
|
|
return $this->setProperty('pagination', $pagination); |
|
89
|
|
|
} |
|
90
|
|
|
|
|
91
|
|
|
/** |
|
92
|
|
|
* Indicates sections of a Web page that are particularly 'speakable' in the |
|
93
|
|
|
* sense of being highlighted as being especially appropriate for |
|
94
|
|
|
* text-to-speech conversion. Other sections of a page may also be usefully |
|
95
|
|
|
* spoken in particular circumstances; the 'speakable' property serves to |
|
96
|
|
|
* indicate the parts most likely to be generally useful for speech. |
|
97
|
|
|
* |
|
98
|
|
|
* The *speakable* property can be repeated an arbitrary number of times, |
|
99
|
|
|
* with three kinds of possible 'content-locator' values: |
|
100
|
|
|
* |
|
101
|
|
|
* 1.) *id-value* URL references - uses *id-value* of an element in the page |
|
102
|
|
|
* being annotated. The simplest use of *speakable* has (potentially |
|
103
|
|
|
* relative) URL values, referencing identified sections of the document |
|
104
|
|
|
* concerned. |
|
105
|
|
|
* |
|
106
|
|
|
* 2.) CSS Selectors - addresses content in the annotated page, eg. via |
|
107
|
|
|
* class attribute. Use the [[cssSelector]] property. |
|
108
|
|
|
* |
|
109
|
|
|
* 3.) XPaths - addresses content via XPaths (assuming an XML view of the |
|
110
|
|
|
* content). Use the [[xpath]] property. |
|
111
|
|
|
* |
|
112
|
|
|
* |
|
113
|
|
|
* For more sophisticated markup of speakable sections beyond simple ID |
|
114
|
|
|
* references, either CSS selectors or XPath expressions to pick out |
|
115
|
|
|
* document section(s) as speakable. For this |
|
116
|
|
|
* we define a supporting type, [[SpeakableSpecification]] which is defined |
|
117
|
|
|
* to be a possible value of the *speakable* property. |
|
118
|
|
|
* |
|
119
|
|
|
* @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable |
|
120
|
|
|
* |
|
121
|
|
|
* @return static |
|
122
|
|
|
* |
|
123
|
|
|
* @see http://schema.org/speakable |
|
124
|
|
|
*/ |
|
125
|
|
|
public function speakable($speakable) |
|
126
|
|
|
{ |
|
127
|
|
|
return $this->setProperty('speakable', $speakable); |
|
128
|
|
|
} |
|
129
|
|
|
|
|
130
|
|
|
/** |
|
131
|
|
|
* The number of words in the text of the Article. |
|
132
|
|
|
* |
|
133
|
|
|
* @param int|int[] $wordCount |
|
134
|
|
|
* |
|
135
|
|
|
* @return static |
|
136
|
|
|
* |
|
137
|
|
|
* @see http://schema.org/wordCount |
|
138
|
|
|
*/ |
|
139
|
|
|
public function wordCount($wordCount) |
|
140
|
|
|
{ |
|
141
|
|
|
return $this->setProperty('wordCount', $wordCount); |
|
142
|
|
|
} |
|
143
|
|
|
|
|
144
|
|
|
} |
|
145
|
|
|
|
spatie /
schema-org
