[CLEANUP] Remove/Replace non-standard phpdoc annotations
[Packages/TYPO3.CMS.git] / typo3 / sysext / documentation / Classes / Domain / Model / DocumentFormat.php
1 <?php
2 namespace TYPO3\CMS\Documentation\Domain\Model;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 /**
18 * An extension helper model to be used in ext:documentation context
19 */
20 class DocumentFormat extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
21 {
22 /**
23 * format
24 *
25 * @var string
26 * @validate NotEmpty
27 */
28 protected $format;
29
30 /**
31 * path
32 *
33 * @var string
34 * @validate NotEmpty
35 */
36 protected $path;
37
38 /**
39 * Returns the format.
40 *
41 * @return string $format
42 */
43 public function getFormat()
44 {
45 return $this->format;
46 }
47
48 /**
49 * Sets the format.
50 *
51 * @param string $format
52 * @return DocumentFormat
53 */
54 public function setFormat($format)
55 {
56 $this->format = $format;
57 return $this;
58 }
59
60 /**
61 * Returns the path.
62 *
63 * @return string $path
64 */
65 public function getPath()
66 {
67 return $this->path;
68 }
69
70 /**
71 * Sets the path.
72 *
73 * @param string $path
74 * @return DocumentFormat
75 */
76 public function setPath($path)
77 {
78 $this->path = $path;
79 return $this;
80 }
81 }