Building Promote plugins

The Promote plugins help the user to easily promote their content on your site. The available plugins are for JomSocial profile, events, groups, Community Builder profile and Sobi list. You can build your own promote plugin for any extension that you need. Follow the below documentation for it.

These plugins are of type socialadspromote.

Plugin File Structure

1. yourpromotename.xml(file)

2. yourpromotename.php(file)

We are looking at the "Plugin for Promoting JS Events" plugin in this documentation.

yourpromotename.xml

<?xml version="1.0" encoding="utf-8"?>
<extension version="3.0" type="plugin" group="socialadspromote" method="upgrade">
	<name>Social Ads - Promote - JomSocial Events</name>
	<creationDate>12th May 2014</creationDate>
	<version>3.1</version>
	<author>Techjoomla</author>
	<authorEmail>[email protected]</authorEmail>
	<authorUrl>http://www.techjoomla.com</authorUrl>
	<copyright>(c) Techjoomla</copyright>
	<license>http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL</license>
	<description>Plugin for Promoting JS Events</description>
	<files>
		<filename plugin="js_event">js_event.php</filename>
	</files>
	<languages>
		<language tag="en-GB">en-GB/en-GB.plg_socialadspromote_js_event.ini</language>
		<language tag="de-DE">de-DE/de-DE.plg_socialadspromote_js_event.ini</language>
		<language tag="es-ES">es-ES/es-ES.plg_socialadspromote_js_event.ini</language>
		<language tag="sv-SE">sv-SE/sv-SE.plg_socialadspromote_js_event.ini</language>
		<language tag="nl-NL">nl-NL/nl-NL.plg_socialadspromote_js_event.ini</language>
		<language tag="da-DK">da-DK/da-DK.plg_socialadspromote_js_event.ini</language>
		<language tag="th-TH">th-TH/th-TH.plg_socialadspromote_js_event.ini</language>
		<language tag="pt-PT">pt-PT/pt-PT.plg_socialadspromote_js_event.ini</language>
	</languages>
	<config name="params">
		<fields name="params">
			<fieldset name="basic">
				<field name="plugin_name" type="text" default="JomSocial Events" label="PLG_NAME" description="PLG_NAM_DESC" />
			</fieldset>
		</fields>
	</config>
</extension>

yourpromotename.php

<?php
/**
 * @version    SVN:<SVN_ID>
 * @package    Js_Events
 * @author     Techjoomla <[email protected]>
 * @copyright  Copyright (c) 2009-2015 TechJoomla. All rights reserved
 * @license    GNU General Public License version 2, or later
 */

// No direct access
defined('_JEXEC') or die('Restricted access');

$lang = JFactory::getLanguage();
$lang->load('plg_socialadspromote_js_event', JPATH_ADMINISTRATOR);

/**
 * Plugin class to promote JomSocial events in Socialads.
 *
 * @since  1.6
 */
class PlgSocialadsPromoteJs_Event extends JPlugin
{
	/**
	 * Methode to promote jomsocial events
	 *
	 * @param   integer  $uid  users ID
	 *
	 * @return  array
	 *
	 * @since   1.6
	 */
	public function onPromoteList($uid = '')
	{
		jimport('joomla.filesystem.file');
		$db = JFactory::getDBO();

		if ($uid)
		{
			$user = JFactory::getUser($uid);
		}
		else
		{
			$user = JFactory::getUser();
		}

		$name = JFile::getName(__FILE__);
		$name = JFile::stripExt($name);
		$jschk = $this->checkForCbExtension();

		if (!empty($jschk))
		{
			$query = $db->getQuery(true);
			$query->select("CONCAT_WS('|', '" . $name . "', e.id) as value");
			$query->select("e.title AS text");
			$query->from($db->quoteName('#__community_events', 'e'));
			$query->join('LEFT', $db->quoteName('#__users', 'u') . 'ON' . $db->quoteName('e.creator') . '=' . $db->quoteName('u.id'));
			$query->where($db->quoteName('u.id') . " = " . $db->quote($user->id));
			$db->setQuery($query);
			$itemlist = $db->loadObjectlist();

			if (empty($itemlist))
			{
				$list = array();

				return $list;
			}
			else
			{
				return $itemlist;
			}
		}
	}

	/**
	 * Methode to get promotion data
	 *
	 * @param   integer  $id  Id of a event
	 *
	 * @return  array
	 *
	 * @since   1.6
	 */
	public function onPromoteData($id)
	{
		$db = JFactory::getDBO();

		$Itemid = JRequest::getInt('Itemid');

		$jschk = $this->checkForCbExtension();

		if (!empty($jschk))
		{
			$query = $db->getQuery(true);
			$query->select('title as title, cover as image, description as bodytext');
			$query->from($db->quoteName('#__community_events'));
			$query->where($db->quoteName('id') . " = " . $db->quote($id));
			$db->setQuery($query);
			$previewdata = $db->loadObjectList();

			// Include Jomsocial core
			$jspath = JPATH_ROOT . "/components/com_community";
			include_once $jspath . "/libraries/core.php";
			$previewdata[0]->url = JUri::root() .
				substr(CRoute::_('index.php?option=com_community&view=events&task=viewevent&eventid=' . $id), strlen(JUri::base(true)) + 1);

			if ($previewdata[0]->image == '')
			{
				$previewdata[0]->image = 'components/com_community/assets/event.png';
			}

			$previewdata[0]->bodytext = strip_tags($previewdata[0]->bodytext);

			return $previewdata;
		}
		else
		{
			return '';
		}
	}

	/**
	 * Methode to check if the extension folder is present
	 *
	 * @params  integer  $id  Id of a event
	 *
	 * @return  array
	 *
	 * @since   1.6
	 */
	public function checkForCbExtension()
	{
		jimport('joomla.filesystem.folder');
		$extpath = JPATH_ROOT . "/components/com_community";

		if (JFolder::exists($extpath))
		{
			return 1;
		}
		else
		{
			return 0;
		}
	}
}