[FEATURE] Introduce read-only column for file mounts
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Domain / Model / FileMount.php
1 <?php
2 namespace TYPO3\CMS\Extbase\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 * This model represents a file mount.
18 *
19 * @api
20 */
21 class FileMount extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity {
22
23 /**
24 * Title of the file mount.
25 *
26 * @var string
27 * @validate notEmpty
28 */
29 protected $title = '';
30
31 /**
32 * Path of the file mount.
33 *
34 * @var string
35 * @validate notEmpty
36 */
37 protected $path = '';
38
39 /**
40 * Determines whether the value of the path field is to be recognized as an absolute
41 * path on the server or a path relative to the fileadmin/ subfolder to the website.
42 *
43 * If the value is true the path is an absolute one, otherwise the path is relative
44 * the fileadmin.
45 *
46 * @var boolean
47 */
48 protected $isAbsolutePath = FALSE;
49
50 /**
51 * Determines whether this file mount should be read only.
52 *
53 * @var bool
54 */
55 protected $readOnly = FALSE;
56
57 /**
58 * Getter for the title of the file mount.
59 *
60 * @return string
61 */
62 public function getTitle() {
63 return $this->title;
64 }
65
66 /**
67 * Setter for the title of the file mount.
68 *
69 * @param string $value
70 * @return void
71 */
72 public function setTitle($value) {
73 $this->title = $value;
74 }
75
76 /**
77 * Getter for the path of the file mount.
78 *
79 * @return string
80 */
81 public function getPath() {
82 return $this->path;
83 }
84
85 /**
86 * Setter for the path of the file mount.
87 *
88 * @param string $value
89 * @return void
90 */
91 public function setPath($value) {
92 $this->path = $value;
93 }
94
95 /**
96 * Getter for the is absolute path of the file mount.
97 *
98 * @return boolean
99 */
100 public function getIsAbsolutePath() {
101 return $this->isAbsolutePath;
102 }
103
104 /**
105 * Setter for is absolute path of the file mount.
106 *
107 * @param boolean $value
108 * @return void
109 */
110 public function setIsAbsolutePath($value) {
111 $this->isAbsolutePath = $value;
112 }
113
114 /**
115 * Setter for the readOnly property of the file mount.
116 *
117 * @param bool $readOnly
118 */
119 public function setReadOnly($readOnly) {
120 $this->readOnly = $readOnly;
121 }
122
123 /**
124 * Getter for the readOnly property of the file mount.
125 *
126 * @return bool
127 */
128 public function isReadOnly() {
129 return $this->readOnly;
130 }
131 }