maintain.class.php

<?php
defined('PHPWG_ROOT_PATH') or die('Hacking attempt!');

/**
 * This class is used to expose maintenance methods to the plugins manager
 * It must extends PluginMaintain and be named "PLUGINID_maintain"
 * where PLUGINID is the directory name of your plugin.
 */
class stereoZoom_maintain extends PluginMaintain
{
	private $default_conf = array(
		'suffix' => '_stereo',
		'isForCrossView' => 'true',
		'zCteWheel' => 0.1,
// 		'tag' => 'stereo', // todo ?
	);

	private $table;
	private $dir;

	function __construct($plugin_id)
	{
		parent::__construct($plugin_id); // always call parent constructor
	}

	/**
	* Plugin installation
	*
	* Perform here all needed step for the plugin installation such as create default config,
	* add database tables, add fields to existing tables, create local folders...
	*/
	function install($plugin_version, &$errors=array())
	{
		global $conf;

		// add config parameter
		if (empty($conf['stereoZoom']))
		{
			// conf_update_param well serialize and escape array before database insertion
			// the third parameter indicates to update $conf['stereoZoom'] global variable as well
			conf_update_param('stereoZoom', $this->default_conf, true);
		}
		else
		{
			$old_conf = safe_unserialize($conf['stereoZoom']);

			if (empty($old_conf['isForCrossView']))
			{ // use case: this parameter was added in version 1.1.0
				$old_conf['isForCrossView'] = $this->default_conf['isForCrossView'];
			}

			if (empty($old_conf['zCteWheel']))
			{ // use case: this parameter was added in version 1.2.7
				$old_conf['zCteWheel'] = $this->default_conf['zCteWheel'];
			}
			
			conf_update_param('stereoZoom', $old_conf, true);
		}
	}

  /**
   * Plugin activation
   *
   * This function is triggered after installation, by manual activation or after a plugin update
   * for this last case you must manage updates tasks of your plugin in this function
   */
  function activate($plugin_version, &$errors=array())
  {
  }

  /**
   * Plugin deactivation
   *
   * Triggered before uninstallation or by manual deactivation
   */
  function deactivate()
  {
  }

  /**
   * Plugin (auto)update
   *
   * This function is called when Piwigo detects that the registered version of
   * the plugin is older than the version exposed in main.inc.php
   * Thus it's called after a plugin update from admin panel or a manual update by FTP
   */
  function update($old_version, $new_version, &$errors=array())
  {
    // I (mistic100) chosed to handle install and update in the same method
    // you are free to do otherwize
    $this->install($new_version, $errors);
  }

  /**
   * Plugin uninstallation
   *
   * Perform here all cleaning tasks when the plugin is removed
   * you should revert all changes made in 'install'
   */
  function uninstall()
  {
    // delete configuration
    conf_delete_param('stereoZoom');
  }
}