All Components → laminas/laminas-form → Class FormTextarea

Class FormTextarea

Summary

Fully Qualified Name:	Laminas\Form\View\Helper\FormTextarea
Extends:	AbstractHelper

Description

Methods

Name	Description	Defined By
__invoke()	Invoke helper as functor	FormTextarea
addDefaultTranslatableAttribute()	Adds an HTML attribute to the list of the default translatable attributes	AbstractHelper
addDefaultTranslatableAttributePrefix()	Adds an HTML attribute to the list of translatable attributes	AbstractHelper
addTranslatableAttribute()	Adds an HTML attribute to the list of translatable attributes	AbstractHelper
addTranslatableAttributePrefix()	Adds an HTML attribute to the list of translatable attributes	AbstractHelper
addValidAttribute()	Adds an HTML attribute to the list of valid attributes	AbstractHelper
addValidAttributePrefix()	Adds a prefix to the list of valid attribute prefixes	AbstractHelper
createAttributesString()	Create a string of all attribute/value pairs	AbstractHelper
getDoctype()	Get value for doctype	AbstractHelper
getEncoding()	Get character encoding	AbstractHelper
getId()	Get the ID of an element	AbstractHelper
getInlineClosingBracket()	Get the closing bracket for an inline tag	AbstractHelper
getTranslator()	Returns translator used in helper	AbstractTranslatorHelper
getTranslatorTextDomain()	Return the translation text domain	AbstractTranslatorHelper
getView()	Get the view object	AbstractHelper
hasTranslator()	Checks if the helper has a translator	AbstractTranslatorHelper
isTranslatorEnabled()	Returns whether translator is enabled and should be used	AbstractTranslatorHelper
render()	Render a form element from the provided $element </td> <td> <a href="../../../../../classes/Laminas\Form\View\Helper\FormTextarea.html"> FormTextarea </a> </td> </tr> <tr> <td> <a href="#setDoctype()"> setDoctype() </a> </td> <td> Set value for doctype </td> <td> <a href="../../../../../classes/Laminas\Form\View\Helper\AbstractHelper.html"> AbstractHelper </a> </td> </tr> <tr> <td> <a href="#setEncoding()"> setEncoding() </a> </td> <td> Set value for character encoding </td> <td> <a href="../../../../../classes/Laminas\Form\View\Helper\AbstractHelper.html"> AbstractHelper </a> </td> </tr> <tr> <td> <a href="#setTranslator()"> setTranslator() </a> </td> <td> Sets translator to use in helper </td> <td> <a href="../../../../../classes/Laminas\I18n\View\Helper\AbstractTranslatorHelper.html"> AbstractTranslatorHelper </a> </td> </tr> <tr> <td> <a href="#setTranslatorEnabled()"> setTranslatorEnabled() </a> </td> <td> Sets whether translator is enabled and should be used </td> <td> <a href="../../../../../classes/Laminas\I18n\View\Helper\AbstractTranslatorHelper.html"> AbstractTranslatorHelper </a> </td> </tr> <tr> <td> <a href="#setTranslatorTextDomain()"> setTranslatorTextDomain() </a> </td> <td> Set translation text domain </td> <td> <a href="../../../../../classes/Laminas\I18n\View\Helper\AbstractTranslatorHelper.html"> AbstractTranslatorHelper </a> </td> </tr> <tr> <td> <a href="#setView()"> setView() </a> </td> <td> Set the View object </td> <td> <a href="../../../../../classes/Laminas\View\Helper\AbstractHelper.html"> AbstractHelper </a> </td> </tr> </table> <h2 id="method-details">Method Details</h2> <h3 id="__invoke()">__invoke()</h3> <p> Invoke helper as functor</p> <p>Proxies to {@link render()}.</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $element </td> <td> \ElementInterface\|null </td> <td> </td> </tr> </table> <p>Returns: string\|\FormTextarea </p> <h3 id="addDefaultTranslatableAttribute()">addDefaultTranslatableAttribute()</h3> <p> Adds an HTML attribute to the list of the default translatable attributes</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $attribute </td> <td> string </td> <td> </td> </tr> </table> <p>Returns: </p> <h3 id="addDefaultTranslatableAttributePrefix()">addDefaultTranslatableAttributePrefix()</h3> <p> Adds an HTML attribute to the list of translatable attributes</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $prefix </td> <td> string </td> <td> </td> </tr> </table> <p>Returns: </p> <h3 id="addTranslatableAttribute()">addTranslatableAttribute()</h3> <p> Adds an HTML attribute to the list of translatable attributes</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $attribute </td> <td> string </td> <td> </td> </tr> </table> <p>Returns: $this </p> <h3 id="addTranslatableAttributePrefix()">addTranslatableAttributePrefix()</h3> <p> Adds an HTML attribute to the list of translatable attributes</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $prefix </td> <td> string </td> <td> </td> </tr> </table> <p>Returns: $this </p> <h3 id="addValidAttribute()">addValidAttribute()</h3> <p> Adds an HTML attribute to the list of valid attributes</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $attribute </td> <td> string </td> <td> </td> </tr> </table> <p>Returns: $this </p> <h3 id="addValidAttributePrefix()">addValidAttributePrefix()</h3> <p> Adds a prefix to the list of valid attribute prefixes</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $prefix </td> <td> string </td> <td> </td> </tr> </table> <p>Returns: $this </p> <h3 id="createAttributesString()">createAttributesString()</h3> <p> Create a string of all attribute/value pairs</p> <p>Escapes all attribute values</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $attributes </td> <td> array </td> <td> </td> </tr> </table> <p>Returns: string </p> <h3 id="getDoctype()">getDoctype()</h3> <p> Get value for doctype</p> <p>Returns: string </p> <h3 id="getEncoding()">getEncoding()</h3> <p> Get character encoding</p> <p>Returns: string </p> <h3 id="getId()">getId()</h3> <p> Get the ID of an element</p> <p>If no ID attribute present, attempts to use the name attribute. If no name attribute is present, either, returns null.</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $element </td> <td> \ElementInterface </td> <td> </td> </tr> </table> <p>Returns: null\|string </p> <h3 id="getInlineClosingBracket()">getInlineClosingBracket()</h3> <p> Get the closing bracket for an inline tag</p> <p>Closes as either "/>" for XHTML doctypes or ">" otherwise.</p> <p>Returns: string </p> <h3 id="getTranslator()">getTranslator()</h3> <p> Returns translator used in helper</p> <p>Returns: \Translator\|null </p> <h3 id="getTranslatorTextDomain()">getTranslatorTextDomain()</h3> <p> Return the translation text domain</p> <p>Returns: string </p> <h3 id="getView()">getView()</h3> <p> Get the view object</p> <p>Returns: null\|\Renderer </p> <h3 id="hasTranslator()">hasTranslator()</h3> <p> Checks if the helper has a translator</p> <p>Returns: bool </p> <h3 id="isTranslatorEnabled()">isTranslatorEnabled()</h3> <p> Returns whether translator is enabled and should be used</p> <p>Returns: bool </p> <h3 id="render()">render()</h3> <p> Render a form <textarea> element from the provided $element</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $element </td> <td> \ElementInterface </td> <td> </td> </tr> </table> <p>Returns: string </p> <h3 id="setDoctype()">setDoctype()</h3> <p> Set value for doctype</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $doctype </td> <td> string </td> <td> </td> </tr> </table> <p>Returns: $this </p> <h3 id="setEncoding()">setEncoding()</h3> <p> Set value for character encoding</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $encoding </td> <td> string </td> <td> </td> </tr> </table> <p>Returns: $this </p> <h3 id="setTranslator()">setTranslator()</h3> <p> Sets translator to use in helper</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $translator </td> <td> \Translator\|null </td> <td> Default </td> </tr> <tr> <td> $textDomain </td> <td> string\|null </td> <td> Default </td> </tr> </table> <p>Returns: $this </p> <h3 id="setTranslatorEnabled()">setTranslatorEnabled()</h3> <p> Sets whether translator is enabled and should be used</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $enabled </td> <td> bool </td> <td> </td> </tr> </table> <p>Returns: $this </p> <h3 id="setTranslatorTextDomain()">setTranslatorTextDomain()</h3> <p> Set translation text domain</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $textDomain </td> <td> string </td> <td> </td> </tr> </table> <p>Returns: $this </p> <h3 id="setView()">setView()</h3> <p> Set the View object</p> <table class="table"> <tr> <th>Parameter Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td> $view </td> <td> \Renderer </td> <td> </td> </tr> </table> <p>Returns: \AbstractHelper </p> <!-- Ads --> <div id="ads-chapter-bottom"> <div> </div> </div> <div id="disqus_thread"></div> </div> <footer> <div class="footer"> <div class="footer-body"> <div class="copyright"> Copyright (c) 2020 by Oleg Krivtsov </div> <div class="generated-by"> Generated using <a href="https://github.com/olegkrivtsov/php-api-doc-maker">PHP API Doc Maker</a> </div> </div> </div> </footer> <a href="#0" class="cd-top">Top</a> <script src="../../../../../assets/js/jquery.min.js"></script> <script src="../../../../../assets/js/loadCSS.js"></script> <script src="../../../../../assets/js/popup.js"></script> <script src="../../../../../assets/js/prism.js"></script> <script> loadCSS("../../../../../assets/css/prism.css"); </script> <script> jQuery(document).ready(function($){ // browser window scroll (in pixels) after which the "back to top" link is shown var offset = 300, //browser window scroll (in pixels) after which the "back to top" link opacity is reduced offset_opacity = 1200, //duration of the top scrolling animation (in ms) scroll_top_duration = 700, //grab the "back to top" link $back_to_top = $('.cd-top'); //hide or show the "back to top" link $(window).scroll(function(){ ( $(this).scrollTop() > offset ) ? $back_to_top.addClass('cd-is-visible') : $back_to_top.removeClass('cd-is-visible cd-fade-out'); if( $(this).scrollTop() > offset_opacity ) { $back_to_top.addClass('cd-fade-out'); } }); //smooth scroll to top $back_to_top.on('click', function(event){ event.preventDefault(); $('body,html').animate({ scrollTop: 0 , }, scroll_top_duration ); }); }); </script> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]\|\|function(){ (i[r].q=i[r].q\|\|[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-115800598-1', 'auto'); ga('send', 'pageview'); </script> </body> </html>