Overview

Namespaces

  • None
  • Xmf
    • Database
    • Module
      • Helper
    • Template
  • Xoops
    • Auth
    • Core
      • Cache
      • Database
        • Logging
        • Schema
      • Exception
      • Handler
        • Scheme
      • Kernel
        • Dtype
        • Handlers
        • Model
      • Lists
      • Locale
        • Punic
      • Service
        • Contract
      • Session
      • Text
        • Sanitizer
          • Extensions
      • Theme
        • Plugins
    • Form
    • Html
    • Locale
    • Module
      • Helper
      • Plugin

Classes

  • BlockForm
  • Button
  • ButtonTray
  • Captcha
  • Checkbox
  • ColorPicker
  • DateSelect
  • DateTime
  • DhtmlTextArea
  • Editor
  • Element
  • ElementFactory
  • ElementTray
  • File
  • Form
  • GroupCheckbox
  • GroupFormCheckbox
  • GroupPermissionForm
  • Hidden
  • Label
  • Mail
  • OptionElement
  • Password
  • Radio
  • RadioYesNo
  • Raw
  • Select
  • SelectCountry
  • SelectEditor
  • SelectGroup
  • SelectLanguage
  • SelectLocale
  • SelectMatchOption
  • SelectTheme
  • SelectTimeZone
  • SelectUser
  • SimpleForm
  • Tab
  • TableForm
  • TabTray
  • Text
  • TextArea
  • ThemeForm
  • Token
  • Url

Interfaces

  • ContainerInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class Editor

Editor - an editor element

ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable
Extended by Xoops\Html\Attributes implements Xoops\Core\AttributeInterface
Extended by Xoops\Form\Element
Extended by Xoops\Form\TextArea
Extended by Xoops\Form\Editor

Direct known subclasses

XoopsFormEditor
Namespace: Xoops\Form
Package: Xoops\Form
Category: Xoops\Form\Editor
Copyright: 2001-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Taiwen Jiang phppp@users.sourceforge.net
Since: 2.0.0
Link: http://xoops.org
Located at oops_lib/Xoops/Form/Editor.php
Methods summary
public
# __construct( string $caption, string $name, array|null $configs = null, boolean $nohtml = false, string $OnFailure = '' )

Constructor

Constructor

Parameters

$caption
Caption
$name
Name for textarea field
$configs

configuration - keys: editor - editor identifier name - textarea field name width, height - dimensions for textarea value - text content

$nohtml
use non-WYSIWYG editor onfailure
$OnFailure
editor to be used if current one failed

Overrides

Xoops\Form\TextArea::__construct()
public string|false
# renderValidationJS( )

renderValidationJS TEMPORARY SOLUTION to 'override' original renderValidationJS method with custom XoopsEditor's renderValidationJS method

renderValidationJS TEMPORARY SOLUTION to 'override' original renderValidationJS method with custom XoopsEditor's renderValidationJS method

Returns

string|false

Overrides

Xoops\Form\Element::renderValidationJS()
public string
# render( )

render

render

Returns

string

Overrides

Xoops\Form\TextArea::render()
Methods inherited from Xoops\Form\TextArea
getCols(), getPlaceholder(), getRows()
Methods inherited from Xoops\Form\Element
addCustomValidationCode(), getAccessKey(), getAccessString(), getCaption(), getClass(), getDescription(), getExtra(), getName(), getPattern(), getPatternDescription(), getTitle(), getValue(), hasClassLike(), isDatalist(), isHidden(), isRequired(), renderAttributeString(), renderDatalist(), setAccessKey(), setCaption(), setClass(), setDatalist(), setDescription(), setExtra(), setHidden(), setIfNotEmpty(), setIfNotSet(), setName(), setPattern(), setRequired(), setTitle(), setValue(), setWithDefaults(), themeDecorateElement()
Methods inherited from Xoops\Html\Attributes
add(), clear(), doRender(), get(), getAll(), getAllLike(), getNames(), has(), remove(), set(), setAll(), setArrayItem(), setMerge(), suppressRender()
Methods inherited from ArrayObject
append(), asort(), count(), exchangeArray(), getArrayCopy(), getFlags(), getIterator(), getIteratorClass(), ksort(), natcasesort(), natsort(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), serialize(), setFlags(), setIteratorClass(), uasort(), uksort(), unserialize()
Constants inherited from ArrayObject
ARRAY_AS_PROPS, STD_PROP_LIST
Properties summary
public null|object $editor
#
Properties inherited from Xoops\Form\Element
$customValidationCode, $extra, $suppressList
Properties inherited from Xoops\Html\Attributes
$suppressRenderAttributes
API documentation generated by ApiGen