1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 <?php
/*
* The MIT License
*
* Copyright 2016 Brian Dayhoff <brian@mopsyd.me>.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
namespace oroboros\core\interfaces\api;
/**
* <Oroboros Template Api>
* This interface provides the public API for usage
* of html template classes in the Oroboros Core.
* @author Brian Dayhoff <brian@mopsyd.me>
* @since 0.0.2a
*/
interface TemplateApi extends \oroboros\OroborosInterface {
const CLASS_TYPE = \oroboros\core\interfaces\api\ClassTypeApi::CLASS_TYPE_TEMPLATE;
/**
* <Template Constructor>
* If [$params] is supplied, it will call [queue($params, $flags)]
* after construction is complete.
* @param array $params (optional)
* @param array $flags (optional>
* @since 0.0.2a
*/
public function __construct(array $params = array(), array $flags = array());
/**
* <Template Initialization>
* Must be called before output. If [$params] is supplied,
* it will call [queue($params, $flags)] after initialization
* is complete.
* @param array $params (optional)
* @param array $flags (optional>
* @return void
* @since 0.0.2a
*/
public function initialize(array $params = array(), array $flags = array());
/**
* <Template Render Method>
* Directs the template to render fully, using the currently set data.
* Initialization method must be called before this point. If [$params]
* is not empty, will call [queue($params, $flags)] before rendering.
* @param array $params (optional)
* @param array $flags (optional)
* @return void
* @since 0.0.2a
*/
public function render(array $params = array(), array $flags = array());
/**
* <Template Master Reset Method>
* Calls all individual reset methods. Restores template data to default
* settings. If [$params] is supplied, it will call [queue($params, $flags)]
* after the reset operation is complete.
* @param array $params (optional)
* @param array $flags (optional)
* @return void
* @since 0.0.2a
*/
public function reset(array $params = array(), array $flags = array());
/**
* <Template Part Retrieval Method>
* Returns a rendered template part. If data is needed to fill
* out the template, it should be supplied in [$params]. If any
* special conditions may change the way that the template part
* is laid out, it should be passed in [$flags].
* @param string $part (required) The template part name.
* @param array $params (optional)
* @param array $flags (optional)
* @return string The completed template markup
* @since 0.0.2a
*/
public function part($part, array $params = array(), array $flags = array());
/**
* <Template Bulk Queue Method>
* Calls the setter method for any known data type that the
* template handles. When possible, queues additional data
* non-destructively. If [$params] is empty or not provided,
* has no effect. Queue values should be key => value pairs.
* @param array $params (optional)
* @param array $flags (optional)
* @return void
* @since 0.0.2a
*/
public function queue(array $params = array(), array $flags = array());
}