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 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 <?php
namespace Alpha\View\Renderer;
/**
* Defines the renderer interface, which allows us to have various implementations (HTML,
* JSON, XML etc.) behind one unified interface. Use the
* ServiceFactory::getInstance() method to get instances of this.
*
* @since 1.2
*
* @author John Collins <dev@alphaframework.org>
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @copyright Copyright (c) 2018, John Collins (founder of Alpha Framework).
* All rights reserved.
*
* <pre>
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the
* following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
* * Neither the name of the Alpha Framework nor the names
* of its contributors may be used to endorse or promote
* products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* </pre>
*/
interface RendererProviderInterface
{
/**
* Provide the Record that we are going render.
*
* @param \Alpha\Model\ActiveRecord $Record
*
* @since 1.2
*/
public function setRecord($Record);
/**
* Renders the create view for the Record using the selected renderer.
*
* @param array $fields Hash array of fields to pass to the template.
*
* @return string
*
* @since 1.2
*/
public function createView($fields = array());
/**
* Renders the edit view for the Record using the selected renderer.
*
* @param array $fields Hash array of fields to pass to the template.
*
* @return string
*
* @since 1.2
*/
public function editView($fields = array());
/**
* Renders the list view for the Record using the selected renderer.
*
* @param array $fields Hash array of fields to pass to the template.
*
* @return string
*
* @since 1.2
*/
public function listView($fields = array());
/**
* Renders the detailed read-only view for the Record using the selected renderer.
*
* @param array $fields Hash array of fields to pass to the template.
*
* @return string
*
* @since 1.2
*/
public function detailedView($fields = array());
/**
* Renders the admin view for the Record using the selected renderer.
*
* @param array $fields Hash array of fields to pass to the template.
*
* @return string
*
* @since 1.2
*/
public function adminView($fields = array());
/**
* Renders the header content using the given renderer.
*
* @param \Alpha\Controller\Controller $controller
*
* @return string
*
* @throws \Alpha\Exception\IllegalArguementException
*
* @since 1.2
*/
public static function displayPageHead($controller);
/**
* Renders the footer content using the given renderer.
*
* @param \Alpha\Controller\Controller $controller
*
* @return string
*
* @since 1.2
*/
public static function displayPageFoot($controller);
/**
* Renders an update (e.g. successful save) message.
*
* @param string $message
*
* @return string
*
* @since 1.2
*/
public static function displayUpdateMessage($message);
/**
* Renders an error (e.g. save failed) message.
*
* @param string $message
*
* @return string
*
* @since 1.2
*/
public static function displayErrorMessage($message);
/**
* Renders an error page with the supplied HTTP error code and a message.
*
* @param string $code
* @param string $message
*
* @return string
*
* @since 1.2
*/
public static function renderErrorPage($code, $message);
/**
* Method to render a hidden HTML form for posting the ID of an object to be deleted.
*
* @param string $URI The URI that the form will point to
*
* @return string
*
* @since 1.2
*/
public static function renderDeleteForm($URI);
/**
* Method to render a HTML form with two hidden, hashed (MD5) form fields to be used as
* a check to ensure that a post to the controller is being sent from the same server
* as hosting it.
*
* @return string
*
* @since 1.2
*/
public static function renderSecurityFields();
/**
* Renders an Integer field value.
*
* @param string $name The field name
* @param string $label The label to apply to the field
* @param string $mode The field mode (create/edit/view)
* @param string $value The field value (optional)
*
* @return string
*
* @since 1.2
*/
public function renderIntegerField($name, $label, $mode, $value = '');
/**
* Renders an Double field value.
*
* @param string $name The field name
* @param string $label The label to apply to the field
* @param string $mode The field mode (create/edit/view)
* @param string $value The field value (optional)
*
* @return string
*
* @since 1.2
*/
public function renderDoubleField($name, $label, $mode, $value = '');
/**
* Renders an Boolean field value.
*
* @param string $name The field name
* @param string $label The label to apply to the field
* @param string $mode The field mode (create/edit/view)
* @param string $value The field value (optional)
*
* @return string
*
* @since 1.2
*/
public function renderBooleanField($name, $label, $mode, $value = '');
/**
* Renders an Enum field value.
*
* @param string $name The field name
* @param string $label The label to apply to the field
* @param string $mode The field mode (create/edit/view)
* @param array $options The Enum options
* @param string $value The field value (optional)
*
* @return string
*
* @since 1.0
*/
public function renderEnumField($name, $label, $mode, $options, $value = '');
/**
* Renders an DEnum field value.
*
* @param string $name The field name
* @param string $label The label to apply to the field
* @param string $mode The field mode (create/edit/view)
* @param array $options The DEnum options
* @param string $value The field value (optional)
*
* @return string
*
* @since 1.2
*/
public function renderDEnumField($name, $label, $mode, $options, $value = '');
/**
* Method to render a field when type is not known.
*
* @param string $name The field name
* @param string $label The label to apply to the field
* @param string $mode The field mode (create/edit/view)
* @param string $value The field value (optional)
*
* @return string
*
* @since 1.2
*/
public function renderDefaultField($name, $label, $mode, $value = '');
/**
* Renders a Text field value.
*
* @param string $name The field name
* @param string $label The label to apply to the field
* @param string $mode The field mode (create/edit/view)
* @param string $value The field value (optional)
*
* @return string
*
* @since 1.0
*/
public function renderTextField($name, $label, $mode, $value = '');
/**
* Renders a String field value.
*
* @param string $name The field name
* @param string $label The label to apply to the field
* @param string $mode The field mode (create/edit/view)
* @param string $value The field value (optional)
*
* @return string
*
* @since 1.2.2
*/
public function renderStringField($name, $label, $mode, $value = '');
/**
* Renders a Relation field value.
*
* @param string $name The field name
* @param string $label The label to apply to the field
* @param string $mode The field mode (create/edit/view)
* @param string $value The field value (optional)
* @param bool $expanded Render the related fields in expanded format or not (optional)
* @param bool $buttons Render buttons for expanding/contacting the related fields (optional)
*
* @return string
*
* @since 1.2
*/
public function renderRelationField($name, $label, $mode, $value = '', $expanded = false, $buttons = true);
/**
* Convenience method that renders all fields for the current Record in edit/create/view mode.
*
* @param string $mode (view|edit|create)
* @param array $filterFields Optional list of field names to exclude from rendering.
* @param array $readOnlyFields Optional list of fields to render in a readonly fashion when rendering in create or edit mode.
*
* @return string
*
* @since 1.2
*/
public function renderAllFields($mode, $filterFields = array(), $readOnlyFields = array());
}