Open Journal Systems  3.3.0
CustomBlockPlugin.inc.php
1 <?php
2 
17 import('lib.pkp.classes.plugins.BlockPlugin');
18 
21  var $_blockName;
22 
25 
31  function __construct($blockName, $parentPlugin) {
32  $this->_blockName = $blockName;
33  $this->_parentPlugin = $parentPlugin;
34  parent::__construct();
35  }
36 
41  function getManagerPlugin() {
42  return $this->_parentPlugin;
43  }
44 
48  function getName() {
49  return $this->_blockName;
50  }
51 
55  function getPluginPath() {
56  $plugin = $this->getManagerPlugin();
57  return $plugin->getPluginPath();
58  }
59 
63  function getTemplatePath($inCore = false) {
64  $plugin = $this->getManagerPlugin();
65  return $plugin->getTemplatePath($inCore);
66  }
67 
71  function getHideManagement() {
72  return true;
73  }
74 
78  function getEnabled($contextId = null) {
79  if (!Config::getVar('general', 'installed')) return true;
80  return parent::getEnabled($contextId);
81  }
82 
86  function getDisplayName() {
87  return $this->_blockName . ' ' . __('plugins.generic.customBlock.nameSuffix');
88  }
89 
93  function getDescription() {
94  return __('plugins.generic.customBlock.description');
95  }
96 
100  function getContents($templateMgr, $request = null) {
101  $context = $request->getContext();
102  $contextId = $context ? $context->getId() : 0;
103 
104  // Get the block contents.
105  $customBlockContent = $this->getSetting($contextId, 'blockContent');
106  $currentLocale = AppLocale::getLocale();
107  $contextPrimaryLocale = $context?$context->getPrimaryLocale():$request->getSite()->getPrimaryLocale();
108 
109  $divCustomBlockId = 'customblock-'.preg_replace('/\W+/', '-', $this->getName());
110  $templateMgr->assign('customBlockId', $divCustomBlockId);
111 
112  $content = $customBlockContent[$currentLocale] ? $customBlockContent[$currentLocale] : $customBlockContent[$contextPrimaryLocale];
113 
114  $templateMgr->assign('customBlockContent', $content);
115  return parent::getContents($templateMgr, $request);
116 
117  }
118 }
119 
Plugin\__construct
__construct()
Definition: Plugin.inc.php:73
CustomBlockPlugin\__construct
__construct($blockName, $parentPlugin)
Definition: CustomBlockPlugin.inc.php:37
CustomBlockPlugin\getDescription
getDescription()
Definition: CustomBlockPlugin.inc.php:99
CustomBlockPlugin\getName
getName()
Definition: CustomBlockPlugin.inc.php:54
CustomBlockPlugin\$_parentPlugin
$_parentPlugin
Definition: CustomBlockPlugin.inc.php:30
Plugin\getEnabled
getEnabled()
Definition: Plugin.inc.php:868
Plugin\getSetting
getSetting($contextId, $name)
Definition: Plugin.inc.php:473
Config\getVar
static getVar($section, $key, $default=null)
Definition: Config.inc.php:35
CustomBlockPlugin
Definition: CustomBlockPlugin.inc.php:19
CustomBlockPlugin\getManagerPlugin
getManagerPlugin()
Definition: CustomBlockPlugin.inc.php:47
CustomBlockPlugin\getPluginPath
getPluginPath()
Definition: CustomBlockPlugin.inc.php:61
CustomBlockPlugin\getEnabled
getEnabled($contextId=null)
Definition: CustomBlockPlugin.inc.php:84
BlockPlugin
Abstract class for block plugins.
Definition: BlockPlugin.inc.php:18
CustomBlockPlugin\getTemplatePath
getTemplatePath($inCore=false)
Definition: CustomBlockPlugin.inc.php:69
CustomBlockPlugin\getContents
getContents($templateMgr, $request=null)
Definition: CustomBlockPlugin.inc.php:106
Plugin\$request
$request
Definition: Plugin.inc.php:68
CustomBlockPlugin\$_blockName
$_blockName
Definition: CustomBlockPlugin.inc.php:24
AppLocale\getLocale
static getLocale()
Definition: env1/MockAppLocale.inc.php:40
CustomBlockPlugin\getDisplayName
getDisplayName()
Definition: CustomBlockPlugin.inc.php:92
CustomBlockPlugin\getHideManagement
getHideManagement()
Definition: CustomBlockPlugin.inc.php:77