1<?php
2
3/**
4 * SimplePie
5 *
6 * A PHP-Based RSS and Atom Feed Framework.
7 * Takes the hard work out of managing a complete RSS/Atom solution.
8 *
9 * Copyright (c) 2004-2022, Ryan Parman, Sam Sneddon, Ryan McCue, and contributors
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without modification, are
13 * permitted provided that the following conditions are met:
14 *
15 * 	* Redistributions of source code must retain the above copyright notice, this list of
16 * 	  conditions and the following disclaimer.
17 *
18 * 	* Redistributions in binary form must reproduce the above copyright notice, this list
19 * 	  of conditions and the following disclaimer in the documentation and/or other materials
20 * 	  provided with the distribution.
21 *
22 * 	* Neither the name of the SimplePie Team nor the names of its contributors may be used
23 * 	  to endorse or promote products derived from this software without specific prior
24 * 	  written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
27 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
28 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS
29 * AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
33 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
35 *
36 * @package SimplePie
37 * @copyright 2004-2016 Ryan Parman, Sam Sneddon, Ryan McCue
38 * @author Ryan Parman
39 * @author Sam Sneddon
40 * @author Ryan McCue
41 * @link http://simplepie.org/ SimplePie
42 * @license http://www.opensource.org/licenses/bsd-license.php BSD License
43 */
44
45namespace SimplePie;
46
47/**
48 * Manages all category-related data
49 *
50 * Used by {@see \SimplePie\Item::get_category()} and {@see \SimplePie\Item::get_categories()}
51 *
52 * This class can be overloaded with {@see \SimplePie\SimplePie::set_category_class()}
53 *
54 * @package SimplePie
55 * @subpackage API
56 */
57class Category
58{
59    /**
60     * Category identifier
61     *
62     * @var string|null
63     * @see get_term
64     */
65    public $term;
66
67    /**
68     * Categorization scheme identifier
69     *
70     * @var string|null
71     * @see get_scheme()
72     */
73    public $scheme;
74
75    /**
76     * Human readable label
77     *
78     * @var string|null
79     * @see get_label()
80     */
81    public $label;
82
83    /**
84     * Category type
85     *
86     * category for <category>
87     * subject for <dc:subject>
88     *
89     * @var string|null
90     * @see get_type()
91     */
92    public $type;
93
94    /**
95     * Constructor, used to input the data
96     *
97     * @param string|null $term
98     * @param string|null $scheme
99     * @param string|null $label
100     * @param string|null $type
101     */
102    public function __construct($term = null, $scheme = null, $label = null, $type = null)
103    {
104        $this->term = $term;
105        $this->scheme = $scheme;
106        $this->label = $label;
107        $this->type = $type;
108    }
109
110    /**
111     * String-ified version
112     *
113     * @return string
114     */
115    public function __toString()
116    {
117        // There is no $this->data here
118        return md5(serialize($this));
119    }
120
121    /**
122     * Get the category identifier
123     *
124     * @return string|null
125     */
126    public function get_term()
127    {
128        return $this->term;
129    }
130
131    /**
132     * Get the categorization scheme identifier
133     *
134     * @return string|null
135     */
136    public function get_scheme()
137    {
138        return $this->scheme;
139    }
140
141    /**
142     * Get the human readable label
143     *
144     * @param bool $strict
145     * @return string|null
146     */
147    public function get_label($strict = false)
148    {
149        if ($this->label === null && $strict !== true) {
150            return $this->get_term();
151        }
152        return $this->label;
153    }
154
155    /**
156     * Get the category type
157     *
158     * @return string|null
159     */
160    public function get_type()
161    {
162        return $this->type;
163    }
164}
165
166class_alias('SimplePie\Category', 'SimplePie_Category');
167