xref: /webtrees/app/Statistics/Repository/Interfaces/MediaRepositoryInterface.php (revision ad7270802ba57a28d195fc58fcc55f26458a779a) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2018 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Statistics\Repository\Interfaces;
19
20/**
21 * A repository providing methods for media type related statistics.
22 */
23interface MediaRepositoryInterface
24{
25    /**
26     * Count the number of media records.
27     *
28     * @return string
29     */
30    public function totalMedia(): string;
31
32    /**
33     * Count the number of media records with type "audio".
34     *
35     * @return string
36     */
37    public function totalMediaAudio(): string;
38
39    /**
40     * Count the number of media records with type "book".
41     *
42     * @return string
43     */
44    public function totalMediaBook(): string;
45
46    /**
47     * Count the number of media records with type "card".
48     *
49     * @return string
50     */
51    public function totalMediaCard(): string;
52
53    /**
54     * Count the number of media records with type "certificate".
55     *
56     * @return string
57     */
58    public function totalMediaCertificate(): string;
59
60    /**
61     * Count the number of media records with type "coat of arms".
62     *
63     * @return string
64     */
65    public function totalMediaCoatOfArms(): string;
66
67    /**
68     * Count the number of media records with type "document".
69     *
70     * @return string
71     */
72    public function totalMediaDocument(): string;
73
74    /**
75     * Count the number of media records with type "electronic".
76     *
77     * @return string
78     */
79    public function totalMediaElectronic(): string;
80
81    /**
82     * Count the number of media records with type "magazine".
83     *
84     * @return string
85     */
86    public function totalMediaMagazine(): string;
87
88    /**
89     * Count the number of media records with type "manuscript".
90     *
91     * @return string
92     */
93    public function totalMediaManuscript(): string;
94
95    /**
96     * Count the number of media records with type "map".
97     *
98     * @return string
99     */
100    public function totalMediaMap(): string;
101
102    /**
103     * Count the number of media records with type "microfiche".
104     *
105     * @return string
106     */
107    public function totalMediaFiche(): string;
108
109    /**
110     * Count the number of media records with type "microfilm".
111     *
112     * @return string
113     */
114    public function totalMediaFilm(): string;
115
116    /**
117     * Count the number of media records with type "newspaper".
118     *
119     * @return string
120     */
121    public function totalMediaNewspaper(): string;
122
123    /**
124     * Count the number of media records with type "painting".
125     *
126     * @return string
127     */
128    public function totalMediaPainting(): string;
129
130    /**
131     * Count the number of media records with type "photograph".
132     *
133     * @return string
134     */
135    public function totalMediaPhoto(): string;
136
137    /**
138     * Count the number of media records with type "tombstone".
139     *
140     * @return string
141     */
142    public function totalMediaTombstone(): string;
143
144    /**
145     * Count the number of media records with type "video".
146     *
147     * @return string
148     */
149    public function totalMediaVideo(): string;
150
151    /**
152     * Count the number of media records with type "other".
153     *
154     * @return string
155     */
156    public function totalMediaOther(): string;
157
158    /**
159     * Count the number of media records with type "unknown".
160     *
161     * @return string
162     */
163    public function totalMediaUnknown(): string;
164
165    /**
166     * Create a chart of media types.
167     *
168     * @param string|null $size
169     * @param string|null $color_from
170     * @param string|null $color_to
171     *
172     * @return string
173     */
174    public function chartMedia(string $size = null, string $color_from = null, string $color_to = null): string;
175}
176