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 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 <?php
/*
* The MIT License
*
* @author Brian Dayhoff <mopsyd@me.com>
* @copyright (c) 2017, Brian Dayhoff <mopsyd@me.com> all rights reserved.
* @license http://opensource.org/licenses/MIT The MIT License (MIT)
*
* 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\traits\views;
/**
* <ViewTrait Trait>
* Provides the methods required to satisfy the ViewContract
* @note This trait needs some refactoring and better abstraction,
* because of the following problems inherited from it's original representation:
* -Direct reliance on class constants in the implementing class (because it used to be a class, and did have these)
* -Factor out the opinion. This representation ASSUMES http (which was appropriate in its original expression), and this MUST be factored out before it is offered as a concrete construct in release.
* -Some opinion here is unavoidable, so it should be as follows: plaintext, utf-8 by default (with a means to change encoding without further extension of the trait), null headers (so it does not disrupt either cli or http, which both inherit from this), null template (it will use one that does nothing to satisfy the requirement, but SHALL NOT mutate content in any way from it's direct representation, EXCEPT to make it scalar if it is not, so that it may be printed efficiently)
* -Factor the logic down to private methods, and factor the auth/validation to protected methods, as per the build specs
* -As this is a base level abstraction, it MAY be required to provide some nulled methods that clear checks for http that may occur, but they MUST effect no operation in THIS view (child traits of this one may enact them at their discretion).
*
* --------
* Traits provide extended method support to classes without requiring a direct,
* linear chain of inheritance. This allows functions to inherit subsets of
* related methods without declaring a parent class.
*
* In Oroboros core, ALL methods are granted to classes via traits,
* and the classes themselves are just containers that correlate their methods
* to an interface they are expected to honor. This approach maximizes
* interoperability, by entirely removing class inheritance as a requirement
* for extension of any class in this system.
*
* 3rd parties using this package are not expected to follow this approach,
* but ALL of our internal class and logic structure does.
* --------
*
* @author Brian Dayhoff <mopsyd@me.com>
* @license http://opensource.org/licenses/MIT The MIT License (MIT)
* @link bitbucket.org/oroborosframework/oroboros-core/wiki/development/api/contract_interface.md
* @category contract-interfaces
* @package oroboros/core
* @subpackage
* @version
* @since
*/
trait ViewTrait
{
use \oroboros\core\traits\utilities\LoaderTrait;
use \oroboros\core\traits\utilities\DefaultLoggerTrait;
/**
* These are the types of resources that can be loaded with the $this->load method
* @var array $_allowed_loader_types
*/
private $_allowed_loader_types = array(
"library",
"module",
"template",
"theme"
);
private $_valid_output_modes = array(
"plaintext" => self::FLAG_OUTPUT_PLAINTEXT, //refactor this out not to directly rely on class constants
"html" => self::FLAG_OUTPUT_HTML,
"css" => self::FLAG_OUTPUT_CSS,
"javascript" => self::FLAG_OUTPUT_JAVASCRIPT,
"email" => self::FLAG_OUTPUT_EMAIL,
"rss" => self::FLAG_OUTPUT_RSS,
"cron" => self::FLAG_OUTPUT_CRON,
"robots" => self::FLAG_OUTPUT_ROBOTS,
"sitemap" => self::FLAG_OUTPUT_SITEMAP,
);
private $_output_mode;
private $_headers = array('Content-Type' => self::CONTENT_TYPE);
private $_meta = array();
private $_css = array();
private $_scripts = array();
private $_fonts = array();
private $_content = array();
private $_base_url = OROBOROS_URL;
/**
* -------------------------------------------------------------------------
* Contract Methods
*
* These methods satisfy the public api defined in the bootstrap contract
*
* @satisfies ...
*
* @execution Default Execution Plan (minimal)
*
* @execution Default Execution Plan (commented)
*
* -------------------------------------------------------------------------
*/
public function __construct(array $params = array(), array $flags = array()) {
parent::__construct($params, $flags);
$this->_setAllowedLoaderTypes($this->_allowed_loader_types);
ob_start();
}
public function __destruct() {
parent::__destruct();
print ob_get_clean();
}
public function initialize(array $params = array(), array $flags = array()) {
parent::initialize($params, $flags);
$this->_initializeLoader();
if (!\oroboros\core\is_cli()) {
//web request setup
$headers = \apache_request_headers();
$this->_setParam('request_headers', $headers);
} else {
//command line setup
$this->_setParam('request_headers', FALSE);
}
}
public function redirect($location, $internal = 1) {
header("Location: " . (($internal)) ? $this->_toUrl($location) : $location);
}
public function render(array $params = array(), array $flags = array()) {
if (!\oroboros\core\is_cli()) {
$this->_processHeaders();
}
if ($this->_checkFlag(self::FLAG_TYPE_OPTIONS) || $this->_checkFlag(self::FLAG_TYPE_HEAD)) {
return;
}
$this->_buildContent($params, $flags);
}
public function reset(array $params = array(), array $flags = array()) {
$this->_headers = array('Content-Type' => self::CONTENT_TYPE);
$this->_meta = array();
$this->_content = array();
$this->_css = array();
$this->_scripts = array();
$this->_fonts = array();
}
/**
* -------------------------------------------------------------------------
* Extension Methods (protected)
*
* These methods may be extended by inheriting constructs as needed.
* They represent the interal api.
* -------------------------------------------------------------------------
*/
protected function _buildContent(array $params = array(), array $flags = array()) {}
protected function _resetHeaders() {
$this->_headers = array('Content-Type' => self::CONTENT_TYPE);
}
protected function _setHeaders(array $headers) {
foreach ($headers as $title => $value) {
$this->_headers[$title] = $value;
}
}
protected function _processHeaders() {
foreach ($this->_headers as $title => $value) {
header($title . '="' . $value . '"');
}
}
protected function _toUrl($filepath) {
$basepath = realpath(dirname(\oroboros\OroborosInterface::OROBOROS_BASEPATH)) . DIRECTORY_SEPARATOR;
return str_replace($basepath, $this->_base_url . '/', $filepath);
}
protected function _updateParameterConditions($parameter_key) {
$name = str_replace(' ', NULL, ucwords(str_replace('-', ' ', $parameter_key)));
if (method_exists($this, '_reset' .$name)) {
$this->{'_reset' . $name}();
}
if (method_exists($this, '_set' .$name)) {
$this->{'_set' . $name}($this->_getParam($parameter_key));
}
}
/**
* -------------------------------------------------------------------------
* Logic Methods (private)
*
* These methods are not externally exposed.
* They represent the actual work.
* -------------------------------------------------------------------------
*/
//private methods
}