snappymail/rainloop/v/1.2.7.417/app/libraries/RainLoop/Plugins/AbstractPlugin.php

<?php

namespace RainLoop\Plugins;

abstract class AbstractPlugin
{
	/**
	 * @var \RainLoop\Plugins\Manager
	 */
	private $oPluginManager;

	/**
	 * @var \RainLoop\Config\Plugin
	 */
	private $oPluginConfig;

	/**
	 * @var bool
	 */
	private $bLangs;

	/**
	 * @var string
	 */
	private $sName;

	/**
	 * @var string
	 */
	private $sPath;

	/**
	 * @var array
	 */
	private $aConfigMap;

	/**
	 * @var bool
	 */
	private $bPluginConfigLoaded;

	public function __construct()
	{
		$this->sName = '';
		$this->sPath = '';
		$this->aConfigMap = null;

		$this->oPluginManager = null;
		$this->oPluginConfig = null;
		$this->bPluginConfigLoaded = false;
		$this->bLangs = false;
	}

	/**
	 * @return \RainLoop\Config\Plugin
	 */
	public function Config()
	{
		if (!$this->bPluginConfigLoaded && $this->oPluginConfig)
		{
			$this->bPluginConfigLoaded = true;
			if ($this->oPluginConfig->IsInited())
			{
				if (!$this->oPluginConfig->Load())
				{
					$this->oPluginConfig->Save();
				}
			}
		}

		return $this->oPluginConfig;
	}

	/**
	 * @return \RainLoop\Plugins\Manager
	 */
	public function Manager()
	{
		return $this->oPluginManager;
	}

	/**
	 * @return string
	 */
	public function Path()
	{
		return $this->sPath;
	}

	/**
	 * @return string
	 */
	public function Name()
	{
		return $this->sName;
	}

	/**
	 * @param bool | null $bLangs = null
	 * @return bool
	 */
	public function UseLangs($bLangs = null)
	{
		if (null !== $bLangs)
		{
			$this->bLangs = (bool) $bLangs;
		}

		return $this->bLangs;
	}

	/**
	 * @return array
	 */
	protected function configMapping()
	{
		return array();
	}
	
	/**
	 * @return string
	 */
	public function Hash()
	{
		return '';
	}
	
	/**
	 * @return string
	 */
	public function Supported()
	{
		return '';
	}
	
	/**
	 * @final
	 * @return array
	 */
	final public function ConfigMap()
	{
		if (null === $this->aConfigMap)
		{
			$this->aConfigMap = $this->configMapping();
			if (!is_array($this->aConfigMap))
			{
				$this->aConfigMap = array();
			}
		}
		
		return $this->aConfigMap;
	}

	/**
	 * @param string $sPath
	 * @param string $sName
	 *
	 * @return self
	 */
	public function SetValues($sPath, $sName)
	{
		$this->sName = $sName;
		$this->sPath = $sPath;

		return $this;
	}

	/**
	 * @param \RainLoop\Plugins\Manager $oPluginManager
	 *
	 * @return self
	 */
	public function SetPluginManager(\RainLoop\Plugins\Manager $oPluginManager)
	{
		$this->oPluginManager = $oPluginManager;

		return $this;
	}

	/**
	 * @param \RainLoop\Config\Plugin $oPluginConfig
	 *
	 * @return self
	 */
	public function SetPluginConfig(\RainLoop\Config\Plugin $oPluginConfig)
	{
		$this->oPluginConfig = $oPluginConfig;

		return $this;
	}

	/**
	 * @return void
	 */
	public function PreInit()
	{

	}

	/**
	 * @return void
	 */
	public function Init()
	{
		
	}

	/**
	 * @param bool $bAdmin
	 * @param bool $bAuth
	 * @param array $aConfig
	 * 
	 * @return void
	 */
	public function FilterAppDataPluginSection($bAdmin, $bAuth, &$aConfig)
	{

	}

	/**
	 * @param string $sHookName
	 * @param string $sFunctionName
	 *
	 * @return self
	 */
	protected function addHook($sHookName, $sFunctionName)
	{
		if ($this->oPluginManager)
		{
			$this->oPluginManager->AddHook($sHookName, array(&$this, $sFunctionName));
		}

		return $this;
	}

	/**
	 * @param string $sFile
	 * @param bool $bAdminScope = false
	 *
	 * @return self
	 */
	protected function addJs($sFile, $bAdminScope = false)
	{
		if ($this->oPluginManager)
		{
			$this->oPluginManager->AddJs($this->sPath.'/'.$sFile, $bAdminScope);
		}

		return $this;
	}

	/**
	 * @param string $sFile
	 * @param bool $bAdminScope = false
	 *
	 * @return self
	 */
	protected function addTemplate($sFile, $bAdminScope = false)
	{
		if ($this->oPluginManager)
		{
			$this->oPluginManager->AddTemplate($this->sPath.'/'.$sFile, $bAdminScope);
		}

		return $this;
	}

	/**
	 * @param string $sActionName
	 * @param string $sFunctionName
	 *
	 * @return self
	 */
	protected function addPartHook($sActionName, $sFunctionName)
	{
		if ($this->oPluginManager)
		{
			$this->oPluginManager->AddAdditionalPartAction($sActionName, array(&$this, $sFunctionName));
		}

		return $this;
	}

	/**
	 * @param string $sActionName
	 * @param string $sFunctionName
	 *
	 * @return self
	 */
	protected function addAjaxHook($sActionName, $sFunctionName)
	{
		if ($this->oPluginManager)
		{
			$this->oPluginManager->AddAdditionalAjaxAction($sActionName, array(&$this, $sFunctionName));
		}

		return $this;
	}

	/**
	 * @param string $sName
	 * @param string $sPlace
	 * @param string $sHtml
	 * @param bool $bPrepend = false
	 *
	 * @return self
	 */
	protected function processTemplate($sName, $sPlace, $sHtml, $bPrepend = false)
	{
		if ($this->oPluginManager)
		{
			$this->oPluginManager->AddProcessTemplateAction($sName, $sPlace, $sHtml, $bPrepend);
		}

		return $this;
	}
}