Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory :  /home/corals/old/lib/internal/Customweb/Form/

Upload File : current_dir [ Writeable ] document_root [ Writeable ]

<?php
/**
  * You are allowed to use this API in your web application.
 *
 * Copyright (C) 2018 by customweb GmbH
 *
 * This program is licenced under the customweb software licence. With the
 * purchase or the installation of the software in your application you
 * accept the licence agreement. The allowed usage is outlined in the
 * customweb software licence which can be found under
 * http://www.sellxed.com/en/software-license-agreement
 *
 * Any modification or distribution is strictly forbidden. The license
 * grants you the installation in one application. For multiuse you will need
 * to purchase further licences at http://www.sellxed.com/shop.
 *
 * See the customweb software licence agreement for more details.
 *
 */



/**
 * The element represents a single item from a form.
 * Where this item has a
 * control. The control is the faciltiy where the user can do his input.
 *
 * @see Customweb_Form_Control_IControl
 */
interface Customweb_Form_IElement
{
	/**
	 * The control of this element
	 *
	 * @return Customweb_Form_Control_IControl
	 */
	public function getControl();
	
	/**
	 * The id of the element.
	 *
	 * @return string
	 */
	public function getElementId();

	/**
	 * The translated description of the element.
	 *
	 * @return string
	 */
	public function getDescription();
	
	/**
	 * Returns if the element requires any user input.
	 *
	 * @return boolean True, when the user has to enter some data.
	 */
	public function isRequired();
	
	/**
	 * This method returns the intention of the elment.
	 * The intention
	 * describs the element. This can be used to provide different
	 * renderings etc.
	 *
	 * @return Customweb_Form_Intention_IIntention
	 */
	public function getElementIntention();

	/**
	 * The message to show to the user which describs an error on the
	 * element.
	 *
	 * @return string Error message
	 */
	public function getErrorMessage();

	/**
	 * This method returns JavaScript, which is used by this element.
	 * The JavaScript must be exectued after the element is rendered. It can
	 * be rendered directly after the element is rendered or when all elements
	 * are rendered in the browser.
	 *
	 * @return string JavaScript code
	 */
	public function getJavaScript();

	/**
	 * Can the value of this setting be set globally or per store?
	 *
	 * @return boolean
	 */
	public function isGlobalScope();

	/**
	 * Is the value of the element inherited?
	 *
	 * @return boolean
	 */
	public function isInherited();

	/**
	 * The list of validators assigned to this element.
	 *
	 * @return Customweb_Form_Validator_IValidator[]
	 */
	public function getValidators();

	/**
	 * This method applies the given css class resolver on all the controls of this element.
	 *
	 * @param Customweb_Form_IControlCssClassResolver $resolver        	
	 * @return void
	 */
	public function applyControlCssResolver(Customweb_Form_IControlCssClassResolver $resolver);

	/**
	 * This method applies the given namespace prefix on the element.
	 *
	 * @param string $prefix        	
	 * @return void
	 */
	public function applyNamespacePrefix($prefix);
	
	/**
	 * This method renders the given element to HTML.
	 *
	 * @param Customweb_Form_IRenderer $renderer
	 *        	The renderer to use.
	 * @return string HTML
	 */
	public function render(Customweb_Form_IRenderer $renderer);
}