-
Notifications
You must be signed in to change notification settings - Fork 453
/
TemplateFile.php
99 lines (96 loc) · 2.95 KB
/
TemplateFile.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
<?php
namespace Concrete\Core\Filesystem;
use Loader;
class TemplateFile
{
/** Stores the parent object of this template file
* @var \BlockType
*/
protected $parentObject;
/** Stores the file name
* @var string
*/
protected $filename;
/** Stores the name of this template file
* @var string
*/
protected $name;
/** Initializes this TemplateFile instance
* @param \BlockType $parentObject The parent object of this template file
* @param string $filename The file name
*/
public function __construct($parentObject, $filename)
{
$this->parentObject = $parentObject;
$this->filename = $filename;
$baseName = $filename;
if (strpos($baseName, '.') !== false) {
$baseName = substr($baseName, 0, strrpos($baseName, '.'));
}
$this->name = Loader::helper('text')->unhandle($baseName);
}
/** Returns the parent object of this template file
* @return \BlockType
*/
public function getTemplateFileParentObject()
{
return $this->parentObject;
}
/** Returns the file name
* @return string
*/
public function getTemplateFileFilename()
{
return $this->filename;
}
/** Returns the name of this template file
* @return string
*/
public function getTemplateFileName()
{
return $this->name;
}
/** Returns the display name for this template file (localized and escaped accordingly to $format)
* @param string $format = 'html' Escape the result in html format (if $format is 'html'). If $format is 'text' or any other value, the display name won't be escaped.
*
* @return string
*/
public function getTemplateFileDisplayName($format = 'html')
{
$displayName = tc('TemplateFileName', $this->name);
switch ($format) {
case 'html':
return h($displayName);
case 'text':
default:
return $displayName;
}
}
/** Returns the file name (implemented for backward compatibility with previuos BlockType->getBlockTypeCustomTemplates / BlockType->getBlockTypeComposerTemplates
* @return string
*/
public function __toString()
{
return $this->filename;
}
/** Sorts a list of TemplateFile instances
* @param TemplateFile[] $list The list of TemplateFile instances to be sorted
*
* @return TemplateFile[]
*/
public static function sortTemplateFileList($list)
{
usort($list, '\Concrete\Core\Filesystem\TemplateFile::sortTemplateFileListSorter');
return $list;
}
/** Callable function used by sortTemplateFileList.
* @param TemplateFile $a
* @param TemplateFile $b
*
* @return int
*/
protected static function sortTemplateFileListSorter($a, $b)
{
return strcasecmp($a->getTemplateFileDisplayName('text'), $b->getTemplateFileDisplayName('text'));
}
}