Visibility::getVisibilityDescription()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 3
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
1
<?php
2
3
namespace AOE\Languagevisibility;
4
5
/***************************************************************
6
 * Copyright notice
7
 *
8
 * (c) 2016 AOE GmbH <[email protected]>
9
 * All rights reserved
10
 *
11
 * This script is part of the TYPO3 project. The TYPO3 project is
12
 * free software; you can redistribute it and/or modify
13
 * it under the terms of the GNU General Public License as published by
14
 * the Free Software Foundation; either version 2 of the License, or
15
 * (at your option) any later version.
16
 *
17
 * The GNU General Public License can be found at
18
 * http://www.gnu.org/copyleft/gpl.html.
19
 *
20
 * This script is distributed in the hope that it will be useful,
21
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23
 * GNU General Public License for more details.
24
 *
25
 * This copyright notice MUST APPEAR in all copies of the script!
26
 ***************************************************************/
27
28
/**
29
 * A visibility object represents the visibility of an element.
30
 * It contains a visibilityString(-,yes,no,f,t) and a visibility
31
 * description. The visibility description can be used to indicate,
32
 * why an element is visible or not.
33
 *
34
 * @author Timo Schmidt <[email protected]>
35
 */
36
class Visibility {
37
38
	/**
39
	 * Holds the visibility string (-,yes,no,f,t).
40
	 *
41
	 * @var string
42
	 */
43
	protected $visibilityString;
44
45
	/**
46
	 * Holds a description for the visiblitiy.
47
	 *
48
	 * @var string
49
	 */
50
	protected $visibilityDescription;
51
52
	/**
53
	 * Returns a description why the visibility string is as it is.
54
	 *
55
	 * @return string
56
	 */
57
	public function getVisibilityDescription() {
58
		return $this->visibilityDescription;
59
	}
60
61
	/**
62
	 * Returns the visibility string (-,no,t,f)
63
	 *
64
	 * @return string
65
	 */
66
	public function getVisibilityString() {
67
		return $this->visibilityString;
68
	}
69
70
	/**
71
	 * Method to set the visibility string, chainable because it returns itself
72
	 *
73
	 * @param string $visibilityDescription
74
	 * @return tx_languagevisibility_visibility
75
	 * */
76
	public function setVisibilityDescription($visibilityDescription) {
77
		$this->visibilityDescription = $visibilityDescription;
78
		return $this;
79
	}
80
81
	/**
82
	 * Method to set the visibility string, chainable because it returns itself
83
	 *
84
	 * @param string $visibilityString
85
	 * @return tx_languagevisibility_visibility
86
	 */
87
	public function setVisibilityString($visibilityString) {
88
		$this->visibilityString = $visibilityString;
89
		return $this;
90
	}
91
}
92