File phpboost/member/extended-fields/field/MemberExtendedFieldType.class.php

 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: 

<?php
/**
 * @package     PHPBoost
 * @subpackage  Member\extended-fields\field
 * @copyright   &copy; 2005-2019 PHPBoost
 * @license     https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
 * @author      Kevin MASSY <reidlos@phpboost.com>
 * @version     PHPBoost 5.2 - last update: 2015 05 09
 * @since       PHPBoost 3.0 - 2010 12 08
 * @contributor Julien BRISWALTER <j1.seth@phpboost.com>
*/

interface MemberExtendedFieldType
{
    /**
     * This function displayed field for create form
     * @param instance of MemberExtendedField $member_extended_field.
     */
    public function display_field_create(MemberExtendedField $member_extended_field);

    /**
     * This function displayed field for update form
     * @param instance of MemberExtendedField $member_extended_field.
     */
    public function display_field_update(MemberExtendedField $member_extended_field);

    /**
     * This function displayed field for profile
     * @param instance of MemberExtendedField $member_extended_field.
     */
    public function display_field_profile(MemberExtendedField $member_extended_field);

    /**
     * This function delete the field when the member is deleted
     * @param instance of MemberExtendedField $member_extended_field.
     */
    public function delete_field(MemberExtendedField $member_extended_field);

    /**
     * This function returned value form fields
     * @param instance of HTMLForm $form and instance of MemberExtendedField $member_extended_field.
     */
    public function get_data(HTMLForm $form, MemberExtendedField $member_extended_field);

    /**
     * Return instanciat constraint depending integer type regex.
     * @return integer
     */
    public function constraint($value);

    public function set_disable_fields_configuration(array $names);

    /**
     * @return Array
     */
    public function get_disable_fields_configuration();

    public function set_name($name);

    /**
     * @return String
     */
    public function get_name();

    /**
     * Return true if the field used once
     * @return bool
     */
    public function get_field_used_once();

    /**
     * Return true if the field used in the phpboost configuration and can't deleted
     * @return bool
     */
    public function get_field_used_phpboost_configuration();
}
?>