[action logs] Add action log plugin library class

administrator/components/com_actionlogs/libraries/actionlogplugin.php

@@ -0,0 +1,96 @@
+<?php
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  com_actionlogs
+ *
+ * @copyright   Copyright (C) 2005 - 2018 Open Source Matters, Inc. All rights reserved.
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+defined('_JEXEC') or die;
+
+JModelLegacy::addIncludePath(JPATH_ADMINISTRATOR . '/components/com_actionlogs/models', 'ActionlogsModel');
+
+/**
+ * Abstract Action Log Plugin
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+abstract class ActionLogPlugin extends JPlugin
+{
+	/**
+	 * Application object.
+	 *
+	 * @var    JApplicationCms
+	 * @since  3.9.0
+	 */
+	protected $app;
+
+	/**
+	 * Database object.
+	 *
+	 * @var    JDatabaseDriver
+	 * @since  3.9.0
+	 */
+	protected $db;
+
+	/**
+	 * Load plugin language file automatically so that it can be used inside component
+	 *
+	 * @var    boolean
+	 * @since  3.9.0
+	 */
+	protected $autoloadLanguage = true;
+
+	/**
+	 * Proxy for ActionlogsModelUserlog addLog method
+	 *
+	 * This method adds a record to #__action_logs contains (message_language_key, message, date, context, user)
+	 *
+	 * @param   array   $messages            The contents of the messages to be logged
+	 * @param   string  $messageLanguageKey  The language key of the message
+	 * @param   string  $context             The context of the content passed to the plugin
+	 * @param   int     $userId              ID of user perform the action, usually ID of current logged in user
+	 *
+	 * @return  void
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	protected function addLog($messages, $messageLanguageKey, $context, $userId = null)
+	{
+		$user = $this->app->getIdentity();
+
+		foreach ($messages as $index => $message)
+		{
+			if (!array_key_exists('userid', $message))
+			{
+				$message['userid'] = $user->id;
+			}
+
+			if (!array_key_exists('username', $message))
+			{
+				$message['username'] = $user->username;
+			}
+
+			if (!array_key_exists('accountlink', $message))
+			{
+				$message['accountlink'] = 'index.php?option=com_users&task=user.edit&id=' . $user->id;
+			}
+
+			if (array_key_exists('type', $message))
+			{
+				$message['type'] = strtoupper($message['type']);
+			}
+
+			if (array_key_exists('app', $message))
+			{
+				$message['app'] = strtoupper($message['app']);
+			}
+
+			$messages[$index] = $message;
+		}
+
+		/** @var ActionlogsModelActionlog $model **/
+		$model = JModelLegacy::getInstance('Actionlog', 'ActionlogsModel');
+		$model->addLog($messages, strtoupper($messageLanguageKey), $context, $userId);
+	}
+}