Move Template to PSR-4

1 files changed, 230 insertions, 0 deletions

diff --git a/lib/public/Template.php b/lib/public/Template.php
new file mode 100644
index 00000000000..7e46745c9d8
--- /dev/null
+++ b/lib/public/Template.php
@@ -0,0 +1,230 @@
+<?php
+/**
+ * @author Bart Visscher <bartv@thisnet.nl>
+ * @author Frank Karlitschek <frank@owncloud.org>
+ * @author Georg Ehrke <georg@owncloud.com>
+ * @author Jan-Christoph Borchardt <hey@jancborchardt.net>
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Jörn Friedrich Dreyer <jfd@butonic.de>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin McCorkell <robin@mccorkell.me.uk>
+ * @author Thomas Müller <thomas.mueller@tmit.eu>
+ * @author Vincent Petry <pvince81@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program 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, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+/**
+ * Public interface of ownCloud for apps to use.
+ * Template Class
+ *
+ */
+
+// 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;
+
+
+/**
+ * Make OC_Helper::imagePath available as a simple function
+ * @param string $app
+ * @param string $image
+ * @return string to the image
+ *
+ * @see \OCP\IURLGenerator::imagePath
+ * @deprecated 8.0.0 Use \OCP\Template::image_path() instead
+ */
+function image_path( $app, $image ) {
+	return(\image_path( $app, $image ));
+}
+
+
+/**
+ * Make OC_Helper::mimetypeIcon available as a simple function
+ * @param string $mimetype
+ * @return string to the image of this file type.
+ * @deprecated 8.0.0 Use \OCP\Template::mimetype_icon() instead
+ */
+function mimetype_icon( $mimetype ) {
+	return(\mimetype_icon( $mimetype ));
+}
+
+/**
+ * Make preview_icon available as a simple function
+ * @param string $path path to file
+ * @return string to the preview of the image
+ * @deprecated 8.0.0 Use \OCP\Template::preview_icon() instead
+ */
+function preview_icon( $path ) {
+	return(\preview_icon( $path ));
+}
+
+/**
+ * Make publicpreview_icon available as a simple function
+ * Returns the path to the preview of the image.
+ * @param string $path of file
+ * @param string $token
+ * @return string link to the preview
+ * @deprecated 8.0.0 Use \OCP\Template::publicPreview_icon() instead
+ */
+function publicPreview_icon ( $path, $token ) {
+	return(\publicPreview_icon( $path, $token ));
+}
+
+/**
+ * Make OC_Helper::humanFileSize available as a simple function
+ * Example: 2048 to 2 kB.
+ * @param int $bytes in bytes
+ * @return string size as string
+ * @deprecated 8.0.0 Use \OCP\Template::human_file_size() instead
+ */
+function human_file_size( $bytes ) {
+	return(\human_file_size( $bytes ));
+}
+
+
+/**
+ * Return the relative date in relation to today. Returns something like "last hour" or "two month ago"
+ * @param int $timestamp unix timestamp
+ * @param boolean $dateOnly
+ * @return \OC_L10N_String human readable interpretation of the timestamp
+ *
+ * @deprecated 8.0.0 Use \OCP\Template::relative_modified_date() instead
+ */
+function relative_modified_date( $timestamp, $dateOnly = false ) {
+	return(\relative_modified_date($timestamp, null, $dateOnly));
+}
+
+
+/**
+ * Return a human readable outout for a file size.
+ * @param integer $bytes size of a file in byte
+ * @return string human readable interpretation of a file size
+ * @deprecated 8.0.0 Use \OCP\Template::human_file_size() instead
+ */
+function simple_file_size($bytes) {
+	return(\human_file_size($bytes));
+}
+
+
+/**
+ * Generate html code for an options block.
+ * @param array $options the options
+ * @param mixed $selected which one is selected?
+ * @param array $params the parameters
+ * @return string html options
+ * @deprecated 8.0.0 Use \OCP\Template::html_select_options() instead
+ */
+function html_select_options($options, $selected, $params=array()) {
+	return(\html_select_options($options, $selected, $params));
+}
+
+
+/**
+ * This class provides the template system for owncloud. You can use it to load
+ * specific templates, add data and generate the html code
+ *
+ * @since 8.0.0
+ */
+class Template extends \OC_Template {
+	/**
+	 * Make OC_Helper::imagePath available as a simple function
+	 *
+	 * @see \OCP\IURLGenerator::imagePath
+	 *
+	 * @param string $app
+	 * @param string $image
+	 * @return string to the image
+	 * @since 8.0.0
+	 */
+	public static function image_path($app, $image) {
+		return \image_path($app, $image);
+	}
+
+
+	/**
+	 * Make OC_Helper::mimetypeIcon available as a simple function
+	 *
+	 * @param string $mimetype
+	 * @return string to the image of this file type.
+	 * @since 8.0.0
+	 */
+	public static function mimetype_icon($mimetype) {
+		return \mimetype_icon($mimetype);
+	}
+
+	/**
+	 * Make preview_icon available as a simple function
+	 *
+	 * @param string $path path to file
+	 * @return string to the preview of the image
+	 * @since 8.0.0
+	 */
+	public static function preview_icon($path) {
+		return \preview_icon($path);
+	}
+
+	/**
+	 * Make publicpreview_icon available as a simple function
+	 * Returns the path to the preview of the image.
+	 *
+	 * @param string $path of file
+	 * @param string $token
+	 * @return string link to the preview
+	 * @since 8.0.0
+	 */
+	public static function publicPreview_icon($path, $token) {
+		return \publicPreview_icon($path, $token);
+	}
+
+	/**
+	 * Make OC_Helper::humanFileSize available as a simple function
+	 * Example: 2048 to 2 kB.
+	 *
+	 * @param int $bytes in bytes
+	 * @return string size as string
+	 * @since 8.0.0
+	 */
+	public static function human_file_size($bytes) {
+		return \human_file_size($bytes);
+	}
+
+	/**
+	 * Return the relative date in relation to today. Returns something like "last hour" or "two month ago"
+	 *
+	 * @param int $timestamp unix timestamp
+	 * @param boolean $dateOnly
+	 * @return string human readable interpretation of the timestamp
+	 * @since 8.0.0
+	 */
+	public static function relative_modified_date($timestamp, $dateOnly = false) {
+		return \relative_modified_date($timestamp, null, $dateOnly);
+	}
+
+	/**
+	 * Generate html code for an options block.
+	 *
+	 * @param array $options the options
+	 * @param mixed $selected which one is selected?
+	 * @param array $params the parameters
+	 * @return string html options
+	 * @since 8.0.0
+	 */
+	public static function html_select_options($options, $selected, $params=array()) {
+		return \html_select_options($options, $selected, $params);
+	}
+}