* // Check if Kunena Forum has been installed, online and compatible with your code
* if (class_exists('Kunena\Forum\Libraries\Forum\KunenaForum') && \Kunena\Forum\Libraries\Forum\KunenaForum::enabled() &&
* \Kunena\Forum\Libraries\Forum\KunenaForum::isCompatible('7.0')) {
* // Initialize the framework (new since 2.0.0)
* \Kunena\Forum\Libraries\Forum\KunenaForum::setup();
* // It's now safe to display something or to save Kunena objects
* }
*
*
* @param boolean $checkAdmin True if administrator is considered as a special case.
*
* @return boolean True if online.
*
* @throws Exception
* @see \Kunena\Forum\Libraries\Forum\KunenaForum::installed()
* @see \Kunena\Forum\Libraries\Forum\KunenaForum::isCompatible()
* @since Kunena 6.0
*
* @see \Kunena\Forum\Libraries\Forum\KunenaForum::setup()
*/
public static function enabled($checkAdmin = true): bool
{
if (!ComponentHelper::isEnabled('com_kunena')) {
return false;
}
$config = KunenaFactory::getConfig();
return !$config->boardOffline
|| ($checkAdmin && self::installed() && KunenaUserHelper::getMyself()->isAdmin());
}
/**
* Check if Kunena Forum is safe to be used.
*
* Legacy method which check if installer is running, it's unsafe to use our framework. Files may be
* currently replaced with new ones and the database structure might be inconsistent. Using forum
* during installation will likely cause fatal errors and data corruption if you attempt to update
* bjects in the database.
*
* Always detect Kunena in your code before you start using the framework:
*
*
* // Check if Kunena Forum has been installed and compatible with your code
* if (class_exists('Kunena\Forum\Libraries\Forum\KunenaForum') && \Kunena\Forum\Libraries\Forum\KunenaForum::installed() &&
* \Kunena\Forum\Libraries\Forum\KunenaForum::isCompatible('7.0')) {
* // Initialize the framework (new since 2.0.0)
* \Kunena\Forum\Libraries\Forum\KunenaForum::setup();
* // Start using the framework
* }
*
*
* @return boolean True if Kunena has been fully installed.
*
* @see \Kunena\Forum\Libraries\Forum\KunenaForum::setup()
*
* @see \Kunena\Forum\Libraries\Forum\KunenaForum::enabled()
* @see \Kunena\Forum\Libraries\Forum\KunenaForum::isCompatible()
* @since Kunena 6.0
*/
public static function installed(): bool
{
return !is_file(JPATH_ADMINISTRATOR . '/components/com_kunena/install/install.php') || self::isDev();
}
/**
* Check if Kunena Forum is running from a Git repository.
*
* Developers tend to do their work directly in the Git repositories instead of
* creating and installing new builds after every change. This function can be
* used to check the condition and make sure we do not break users repository
* by replacing files during upgrade.
*
* @return boolean True if Git repository is detected.
*
* @since Kunena 6.0
*/
public static function isDev(): bool
{
self::version();
$match = [];
preg_match('/(-DEV)|(-GIT)/i', self::$version, $match);
if (!empty($match)) {
return true;
}
return false;
}
/**
* Initialize Kunena Framework.
*
* This function initializes Kunena Framework. Main purpose of this
* function right now is to make sure all the translations have been loaded,
* but later it may contain other initialization tasks.
*
* Following code gives an example how to create backwards compatible code.
* Normally I wouldn't bother supporting deprecated unstable releases.
*
*
* // We have already checked that Kunena 2.0+ has been installed and is online
*
* if (\Kunena\Forum\Libraries\Forum\KunenaForum::isCompatible('2.0.0')) {
* \Kunena\Forum\Libraries\Forum\KunenaForum::setup();
* } else {
* \Kunena\Forum\Libraries\Factory\KunenaFactory::loadLanguage();
* }
*
*
* @return void
*
* @throws Exception
* @since Kunena 2.0.0-BETA2
*
* @see \Kunena\Forum\Libraries\Forum\KunenaForum::installed()
*
* Alternatively you could use method_exists() to check that the new API is in there.
*/
public static function setup(): void
{
$config = KunenaFactory::getConfig();
// Load language file for libraries.
KunenaFactory::loadLanguage('com_kunena.libraries', 'admin');
// Setup output caching.
$options = ['defaultgroup' => 'com_kunena'];
$cache = Factory::getContainer()->get(CacheControllerFactoryInterface::class)->createCacheController('output', $options);
if (!$config->cache) {
$cache->setCaching(0);
}
$cache->setLifeTime($config->cacheTime, 60);
// Setup error logging.
$options = ['logger' => 'w3c', 'text_file' => 'kunena.php'];
$categories = ['kunena'];
$levels = JDEBUG || $config->debug ? Log::ALL :
Log::EMERGENCY | Log::ALERT | Log::CRITICAL | Log::ERROR;
Log::addLogger($options, $levels, $categories);
}
/**
* Check if Kunena Forum is compatible with your code.
*
* This function can be used to make sure that user has installed Kunena version
* that has been tested to work with your extension. All existing functions should
* be backwards compatible, but each release can add some new functionality, which
* you may want to use.
*
*
* if (\Kunena\Forum\Libraries\Forum\KunenaForum::isCompatible('2.0.1')) {
* // We can do it in the new way
* } else {
* // Use the old code instead
* }
*
*
* @param string $version Minimum required version.
*
* @return boolean Yes, if it is safe to use Kunena Framework.
*
* @see \Kunena\Forum\Libraries\Forum\KunenaForum::installed()
*
* @since Kunena 6.0
*/
public static function isCompatible(string $version): bool
{
// If requested version is smaller than 4.0, it's not compatible
if (version_compare($version, '6.0', '<')) {
return false;
}
// Development version support.
if ($version == '6.0') {
return true;
}
// Check if future version is needed (remove GIT and DEVn from the current version)
if (version_compare($version, preg_replace('/(-DEV\d*)?(-GIT)?/i', '', self::version()), '>')) {
return false;
}
return true;
}
/**
* Returns the exact version from Kunena Forum.
*
* @return boolean Version number.
*
* @since Kunena 6.0
*/
public static function version()
{
if (self::$version === false) {
self::buildVersion();
}
return self::$version;
}
/**
* @return void
*
* @since Kunena 6.0
*/
protected static function buildVersion(): void
{
$file = JPATH_MANIFESTS . '/packages/pkg_kunena.xml';
if (file_exists($file)) {
$manifest = simplexml_load_file($file);
self::$version = (string) $manifest->version;
self::$version_date = (string) $manifest->creationDate;
self::$version_name = (string) $manifest->versionname;
} else {
$db = Factory::getContainer()->get('DatabaseDriver');
$query = $db->createQuery();
$query->select('version')->from('#__kunena_version')->order('id');
$query->setLimit(1);
$db->setQuery($query);
self::$version = $db->loadResult();
self::$version_date = Factory::getDate()->format('Y-m-d');
self::$version_name = 'Git Repository';
}
self::$version_major = substr(self::$version, 0, 3);
self::$version_name = ('@kunenaversionname@' == '@' . 'kunenaversionname' . '@') ? 'Git Repository' : '@kunenaversionname@';
$db = Factory::getContainer()->get('DatabaseDriver');
$query = $db->createQuery();
$query->select('sampleData')->from('#__kunena_version')->order('id DESC');
$query->setLimit(1);
$db->setQuery($query);
self::$version_sampleData = $db->loadResult();
}
/**
* Returns all version information together.
*
* @return object stdClass containing (version, major, date, name, sampleData).
*
* @since Kunena 6.0
*/
public static function getVersionInfo()
{
$version = new stdClass();
$version->version = self::version();
$version->major = self::versionMajor();
$version->date = self::versionDate();
$version->name = self::versionName();
$version->sampleData = self::versionSampleData();
return $version;
}
/**
* Returns major version number (2.0, 3.0, 3.1 and so on).
*
* @return boolean Major version in xxx.yyy format.
*
* @since Kunena 6.0
*/
public static function versionMajor(): bool
{
if (self::$version_major === false) {
self::buildVersion();
}
return self::$version_major;
}
/**
* Returns build date from Kunena Forum (for Git today).
*
* @return string Date in yyyy-mm-dd format.
*
* @since Kunena 6.0
*/
public static function versionDate(): string
{
if (self::$version_date === false) {
self::buildVersion();
}
return self::$version_date;
}
/**
* Returns codename from Kunena release.
*
* @return string Codename.
*
* @since Kunena 6.0
*/
public static function versionName(): string
{
if (self::$version_name === false) {
self::buildVersion();
}
return self::$version_name;
}
/**
* Returns boolean if the sample data is installed.
*
* @return boolean SampleData.
*
* @since Kunena 6.0
*/
public static function versionSampleData()
{
if (self::$version_sampleData === false) {
self::buildVersion();
}
return self::$version_sampleData;
}
/**
* Displays Kunena Forum view/layout inside your extension.
*
*
*
*
*
* @param string $viewName Name of the view.
* @param string $layout Name of the layout.
* @param null|string $template Name of the template file.
* @param array|Registry $params Extra parameters to control the model.
*
* @return void
*
* @throws Exception
* @since Kunena 6.0
*/
public static function display(string $viewName, $layout = 'default', $template = null, $params = []): void
{
// Filter input
$viewName = preg_replace('/[^A-Z0-9_]/i', '', $viewName);
$layout = preg_replace('/[^A-Z0-9_]/i', '', $layout);
if (!empty($template)) {
$template = preg_replace('/[^A-Z0-9_]/i', '', $template);
}
$template = $template ? $template : null;
$view = 'Kunena\Forum\Site\View\\' . $viewName . '\HtmlView';
$model = 'Kunena\Forum\Site\Model\\' . $viewName . 'Model';
// Load potentially needed language files
KunenaFactory::loadLanguage();
KunenaFactory::loadLanguage('com_kunena.model');
KunenaFactory::loadLanguage('com_kunena.view');
$view = new $view(['base_path' => KPATH_SITE]);
if (!($params instanceof Registry)) {
$params = new Registry($params);
}
$params->set('layout', $layout);
// Push the model into the view (as default).
$model = new $model();
$model->initialize($params);
$view->setModel($model, true);
// Add template path
if ($params->get('templatepath')) {
$view->addTemplatePath($params->get('templatepath'));
}
if ($viewName != 'common') {
$view->common = new HtmlView(['base_path' => KPATH_SITE]);
$view->common->embedded = true;
}
// Flag view as being embedded
$view->embedded = true;
// Flag view as being teaser
$view->teaser = $params->get('teaser', 0);
// Render the view.
$view->displayLayout($layout, $template);
}
}