1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/** |
4
|
|
|
* Just a holder for a brand color defined by the administrator. Usually done in the SiteConfig, see extension. |
5
|
|
|
* |
6
|
|
|
* @author Peter Thaleikis |
7
|
|
|
*/ |
8
|
|
|
|
9
|
|
|
class BrandColors extends SubsiteSafeDataObject |
10
|
|
|
{ |
11
|
|
|
/** |
12
|
|
|
* @var array |
13
|
|
|
*/ |
14
|
|
|
private static $db = [ |
15
|
|
|
'ColorName' => 'varchar(50)', |
16
|
|
|
'ColorCode' => 'varchar(50)', |
17
|
|
|
'CSSClass' => 'varchar(50)', |
18
|
|
|
'SubsiteID' => 'int', |
19
|
|
|
'Sort' => 'int', |
20
|
|
|
'BrandColor' => 'varchar(50)', |
21
|
|
|
]; |
22
|
|
|
|
23
|
|
|
/** |
24
|
|
|
* @var array |
25
|
|
|
*/ |
26
|
|
|
private static $summary_fields = [ |
27
|
|
|
'ColorName' => 'Color name', |
28
|
|
|
'ColorCode' => 'Color code', |
29
|
|
|
'CSSClass' => 'CSS class', |
30
|
|
|
]; |
31
|
|
|
|
32
|
|
|
/** |
33
|
|
|
* saves the actual value we want to use in the db. no live calculated because it will be static anyway. |
34
|
|
|
*/ |
35
|
|
|
public function onBeforeWrite() |
36
|
|
|
{ |
37
|
|
|
parent::onBeforeWrite(); |
38
|
|
|
|
39
|
|
|
$this->BrandColor = (strlen($this->CSSClass) == 0) ? $this->ColorCode : $this->CSSClass; |
|
|
|
|
40
|
|
|
} |
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* make the form a bit more usable. |
44
|
|
|
* |
45
|
|
|
* @return FieldList |
46
|
|
|
*/ |
47
|
|
|
public function getCMSFields() |
48
|
|
|
{ |
49
|
|
|
$fields = parent::getCMSFields(); |
50
|
|
|
|
51
|
|
|
// "disclaimer" |
52
|
|
|
$fields->addFieldToTab( |
53
|
|
|
'Root.Main', |
54
|
|
|
WarningMessage::create('Warning: Please be careful with the following settings. Any changes can decrease the accessibility or violate the branding guide lines.'), |
55
|
|
|
'ColorName' |
56
|
|
|
); |
57
|
|
|
|
58
|
|
|
// give the option to actually select a color. |
59
|
|
|
$fields->replaceField( |
60
|
|
|
'ColorCode', |
61
|
|
|
ColourPicker::create('ColorCode', 'Color code') |
62
|
|
|
->setRightTitle('Please ensure the color is exactly the intended value.') |
63
|
|
|
); |
64
|
|
|
|
65
|
|
|
// add some words around this to make it more usable. |
66
|
|
|
$fields->dataFieldByName('CSSClass') |
67
|
|
|
->setTitle('CSS class') |
68
|
|
|
->setRightTitle('This CSS class will be return <b>instead</b> of the color code, if defined.'); |
69
|
|
|
$fields->dataFieldByName('ColorName') |
70
|
|
|
->setTitle('Color name') |
71
|
|
|
->setRightTitle('This name will be displayed throughout the administration interface.'); |
72
|
|
|
|
73
|
|
|
// hide some fields like the subsiteid (only if subsite module) is installed. |
74
|
|
|
$fields->replaceField('BrandColor', HiddenField::create('BrandColor', 'BrandColor', $this->BrandColor)); |
75
|
|
|
if (class_exists('Subsite')) { |
76
|
|
|
$fields->replaceField( |
77
|
|
|
'SubsiteID', |
78
|
|
|
HiddenField::create('SubsiteID', 'Subsite', Subsite::currentSubsite()) |
79
|
|
|
); |
80
|
|
|
} |
81
|
|
|
|
82
|
|
|
// no one cares about the sort order |
83
|
|
|
$fields->replaceField('Sort', HiddenField::create('Sort', 'Sort', $this->Sort)); |
84
|
|
|
|
85
|
|
|
return $fields; |
86
|
|
|
} |
87
|
|
|
} |
88
|
|
|
|
Since your code implements the magic setter
_set
, this function will be called for any write access on an undefined variable. You can add the@property
annotation to your class or interface to document the existence of this variable.Since the property has write access only, you can use the @property-write annotation instead.
Of course, you may also just have mistyped another name, in which case you should fix the error.
See also the PhpDoc documentation for @property.