Select Git revision
-
Grzegorz Rola authoredGrzegorz Rola authored
Field.php 2.87 KiB
<?php
namespace WPDesk\Forms;
use WPDesk\Forms\Field\BasicField;
/**
* The idea is that from the moment the factory returns this interface it's values cannot be changed.
* And that is why here are only the getters.
*
* The: Validation, Serialization, Sanitization features are provided trough delegated classes (get_validator, get_serializer ...)
*
* @package WPDesk\Forms
*/
interface Field {
/** @return string */
public function get_name();
/** @return mixed */
public function get_default_value();
/** @return string */
public function get_template_name();
/**
* When this field is used on form this field will force it's own template.
*
* return bool
*/
public function should_override_form_template();
/**
* HTML label.
*
* @return string
*/
public function get_label();
/** bool */
public function has_label();
/**
* Description for field. It can be shown near the field.
*
* @return string
*/
public function get_description();
/**
* Additional field description that should be shown in optional hover tip.
*
* @return string
*/
public function get_description_tip();
/** @return bool */
public function has_description_tip();
/** @return bool */
public function has_description();
/**
* @return bool
*/
public function is_readonly();
/** @return bool */
public function is_disabled();
/** @return string */