-
Notifications
You must be signed in to change notification settings - Fork 0
/
DocumentationPlugin.php
93 lines (83 loc) · 1.48 KB
/
DocumentationPlugin.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
<?php namespace Craft;
class DocumentationPlugin extends BasePlugin {
/**
* Return the plugins name.
*
* @return string
*/
public function getName()
{
return 'Documentation';
}
/**
* Returns the plugin’s version number.
*
* @return string The plugin’s version number.
*/
public function getVersion()
{
return '1.0.1';
}
/**
* Returns the plugin developer’s name.
*
* @return string The plugin developer’s name.
*/
public function getDeveloper()
{
return 'Jason McCallister';
}
/**
* Returns the plugin developer’s URL.
*
* @return string The plugin developer’s URL.
*/
public function getDeveloperUrl()
{
return 'https://mccallister.io';
}
/**
* Define the plugins settings.
*
* @return array
*/
protected function defineSettings()
{
return array(
'useDatabase' => AttributeType::Bool,
'pathToMarkdown' => AttributeType::String,
'documentation' => AttributeType::Mixed
);
}
/**
* Return the plugins settings template.
*
* @return string
*/
public function getSettingsHtml()
{
return craft()->templates->render('documentation/settings', array(
'settings' => $this->getSettings()
));
}
/**
* Return if the plugin has a control panel section.
*
* @return bool
*/
public function hasCpSection()
{
return true;
}
/**
* @return array
*/
public function registerCpRoutes()
{
return array(
'documentation' => array(
'action' => 'documentation/document'
)
);
}
}