<?php
  /**
   * ownCloud
   *
   * @author Thomas Müller
   * @copyright 2014 Thomas Müller deepdiver@owncloud.com
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
   * License as published by the Free Software Foundation; either
   * version 3 of the License, or any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
   *
   * You should have received a copy of the GNU Affero General Public
   * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
   *
   */
  
  /**
   * Public interface of ownCloud for apps to use.
   * Activity/IExtension interface
   */
  
  // use OCP namespace for all classes that are considered public.
  // This means that they should be used by apps instead of the internal ownCloud classes
  namespace OCP\Activity;
  
  interface IExtension {
  	/**
  	 * The extension can return an array of additional notification types.
  	 * If no additional types are to be added false is to be returned
  	 *
  	 * @param string $languageCode
  	 * @return array|false
  	 */
  	public function getNotificationTypes($languageCode);
  
  	/**
  	 * The extension can filter the types based on the filter if required.
  	 * In case no filter is to be applied false is to be returned unchanged.
  	 *
  	 * @param array $types
  	 * @param string $filter
  	 * @return array|false
  	 */
  	public function filterNotificationTypes($types, $filter);
  
  	/**
  	 * For a given method additional types to be displayed in the settings can be returned.
  	 * In case no additional types are to be added false is to be returned.
  	 *
  	 * @param string $method
  	 * @return array|false
  	 */
  	public function getDefaultTypes($method);
  
  	/**
  	 * The extension can translate a given message to the requested languages.
  	 * If no translation is available false is to be returned.
  	 *
  	 * @param string $app
  	 * @param string $text
  	 * @param array $params
  	 * @param boolean $stripPath
  	 * @param boolean $highlightParams
  	 * @param string $languageCode
  	 * @return string|false
  	 */
  	public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
  
  	/**
  	 * A string naming the css class for the icon to be used can be returned.
  	 * If no icon is known for the given type false is to be returned.
  	 *
  	 * @param string $type
  	 * @return string|false
  	 */
  	public function getTypeIcon($type);
  
  	/**
  	 * The extension can define the parameter grouping by returning the index as integer.
  	 * In case no grouping is required false is to be returned.
  	 *
  	 * @param array $activity
  	 * @return integer|false
  	 */
  	public function getGroupParameter($activity);
  
  	/**
  	 * The extension can define additional navigation entries. The array returned has to contain two keys 'top'
  	 * and 'apps' which hold arrays with the relevant entries.
  	 * If no further entries are to be added false is no be returned.
  	 *
  	 * @return array|false
  	 */
  	public function getNavigation();
  
  	/**
  	 * The extension can check if a customer filter (given by a query string like filter=abc) is valid or not.
  	 *
  	 * @param string $filterValue
  	 * @return boolean
  	 */
  	public function isFilterValid($filterValue);
  
  	/**
  	 * For a given filter the extension can specify the sql query conditions including parameters for that query.
  	 * In case the extension does not know the filter false is to be returned.
  	 * The query condition and the parameters are to be returned as array with two elements.
  	 * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%'));
  	 *
  	 * @param string $filter
  	 * @return array|false
  	 */
  	public function getQueryForFilter($filter);
  }