First public release of MyAAC

2025-10-17 03:03:26 +02:00 · 2017-05-01 20:02:45 +02:00
parent 31172b4883
commit b5362d0654
2016 changed files with 114481 additions and 0 deletions
--- a/system/libs/dwoo/Dwoo/ITemplate.php
+++ b/system/libs/dwoo/Dwoo/ITemplate.php
@@ -0,0 +1,150 @@
+<?php
+
+/**
+ * interface that represents a dwoo template
+ *
+ * This software is provided 'as-is', without any express or implied warranty.
+ * In no event will the authors be held liable for any damages arising from the use of this software.
+ *
+ * @author     Jordi Boggiano <j.boggiano@seld.be>
+ * @copyright  Copyright (c) 2008, Jordi Boggiano
+ * @license    http://dwoo.org/LICENSE   Modified BSD License
+ * @link       http://dwoo.org/
+ * @version    1.1.0
+ * @date       2009-07-18
+ * @package    Dwoo
+ */
+interface Dwoo_ITemplate
+{
+	/**
+	 * returns the cache duration for this template
+	 *
+	 * defaults to null if it was not provided
+	 *
+	 * @return int|null
+	 */
+	public function getCacheTime();
+
+	/**
+	 * sets the cache duration for this template
+	 *
+	 * can be used to set it after the object is created if you did not provide
+	 * it in the constructor
+	 *
+	 * @param int $seconds duration of the cache validity for this template, if
+	 * null it defaults to the Dwoo instance's cache time. 0 = disable and
+	 * -1 = infinite cache
+	 */
+	public function setCacheTime($seconds = null);
+
+	/**
+	 * returns the cached template output file name, true if it's cache-able but not cached
+	 * or false if it's not cached
+	 *
+	 * @param Dwoo $dwoo the dwoo instance that requests it
+	 * @return string|bool
+	 */
+	public function getCachedTemplate(Dwoo $dwoo);
+
+	/**
+	 * caches the provided output into the cache file
+	 *
+	 * @param Dwoo $dwoo the dwoo instance that requests it
+	 * @param string $output the template output
+	 * @return mixed full path of the cached file or false upon failure
+	 */
+	public function cache(Dwoo $dwoo, $output);
+
+	/**
+	 * clears the cached template if it's older than the given time
+	 *
+	 * @param Dwoo $dwoo the dwoo instance that was used to cache that template
+	 * @param int $olderThan minimum time (in seconds) required for the cache to be cleared
+	 * @return bool true if the cache was not present or if it was deleted, false if it remains there
+	 */
+	public function clearCache(Dwoo $dwoo, $olderThan = -1);
+
+	/**
+	 * returns the compiled template file name
+	 *
+	 * @param Dwoo $dwoo the dwoo instance that requests it
+	 * @param Dwoo_ICompiler $compiler the compiler that must be used
+	 * @return string
+	 */
+	public function getCompiledTemplate(Dwoo $dwoo, Dwoo_ICompiler $compiler = null);
+
+	/**
+	 * returns the template name
+	 *
+	 * @return string
+	 */
+	public function getName();
+
+	/**
+	 * returns the resource name for this template class
+	 *
+	 * @return string
+	 */
+	public function getResourceName();
+
+	/**
+	 * returns the resource identifier for this template or false if it has no identifier
+	 *
+	 * @return string|false
+	 */
+	public function getResourceIdentifier();
+
+	/**
+	 * returns the template source of this template
+	 *
+	 * @return string
+	 */
+	public function getSource();
+
+	/**
+	 * returns an unique string identifying the current version of this template,
+	 * for example a timestamp of the last modified date or a hash of the template source
+	 *
+	 * @return string
+	 */
+	public function getUid();
+
+	/**
+	 * returns the compiler used by this template, if it was just compiled, or null
+	 *
+	 * @return Dwoo_ICompiler
+	 */
+	public function getCompiler();
+
+	/**
+	 * returns some php code that will check if this template has been modified or not
+	 * 
+	 * if the function returns null, the template will be instanciated and then the Uid checked
+	 * 
+	 * @return string
+	 */
+	public function getIsModifiedCode();
+
+	/**
+	 * returns a new template object from the given resource identifier, null if no include is
+	 * possible (resource not found), or false if include is not permitted by this resource type
+	 *
+	 * this method should also check if $dwoo->getSecurityPolicy() is null or not and do the
+	 * necessary permission checks if required, if the security policy prevents the template
+	 * generation it should throw a new Dwoo_Security_Exception with a relevant message
+	 *
+	 * @param mixed $resourceId the resource identifier
+	 * @param int $cacheTime duration of the cache validity for this template,
+	 * 						 if null it defaults to the Dwoo instance that will
+	 * 						 render this template
+	 * @param string $cacheId the unique cache identifier of this page or anything else that
+	 * 						  makes this template's content unique, if null it defaults
+	 * 						  to the current url
+	 * @param string $compileId the unique compiled identifier, which is used to distinguish this
+	 * 							template from others, if null it defaults to the filename+bits of the path
+	 * @param Dwoo_ITemplate $parentTemplate the template that is requesting a new template object (through
+	 * 											an include, extends or any other plugin)
+	 * @return Dwoo_ITemplate|null|false
+	 */
+	public static function templateFactory(Dwoo $dwoo, $resourceId, $cacheTime = null, $cacheId = null, $compileId = null, Dwoo_ITemplate $parentTemplate = null);
+}