Overview

Packages

  • Auth
    • Ads
    • Ldap
    • Xoops
  • Autotasks
  • Config
    • Category
    • Item
    • Option
  • Core
    • Filesystem
    • Filters
    • Logger
    • Mail
    • Message
    • Password
    • Security
    • StopSpammer
    • Template
    • Textsanitizer
    • VersionChecker
  • Data
    • Avatar
    • Comment
  • Database
    • Connection
    • Criteria
    • Legacy
    • MySQL
    • PDO
    • Updater
  • Feeds
    • RSS
  • File
  • Form
    • Base
    • Elements
  • ICMS
    • IPF
      • View
  • Image
    • Category
  • Ipf
    • Category
    • Controller
    • Export
    • form
    • Keyhighlighter
    • Member
    • Object
    • Permission
    • richfile
    • Tree
    • urllink
    • View
  • kernel
    • Set
  • Member
    • Group
    • GroupMembership
    • GroupPermission
    • User
  • Messaging
  • Module
  • None
  • Notification
  • Page
  • Plugins
    • Editor
  • Preload
    • Libraries
  • Privmessage
  • Session
  • SmartObject
  • View
    • Block
    • Breadcrumb
    • PageNav
    • PrinterFriendly
    • Template
    • Templates
    • Theme
    • Tree

Classes

  • icms_plugins_EditorHandler
  • Overview
  • Package
  • Class

Class icms_plugins_EditorHandler

Handler for editors

Package: Plugins\Editor
Category: ICMS
Copyright: Copyright (c) 2000 XOOPS.org
License: GNU public license
Author: Taiwen Jiang (phppp or D.J.) php_pp@hotmail.com
Located at plugins/EditorHandler.php
Methods summary
public
# __construct( string $type = '' )

Constructor

Constructor

Parameters

$type
type
public static object &
# getInstance( string $type = '' )

Access the only instance of this class

Access the only instance of this class

Parameters

$type
type

Returns

object
public &
# get( string $name = "", array $options = NULL, string $noHtml = FALSE, boolean $OnFailure = "" )

Parameters

$name
Editor name which is actually the folder name
$options
editor options: $key => $val
$noHtml
$OnFailure a pre-validated editor that will be used if the required editor is failed to create
$OnFailure
$noHtml dohtml disabled
public array &
# getList( boolean $noHtml = FALSE )

Gets list of available editors

Gets list of available editors

Parameters

$noHtml
is this an editor with no html options?

Returns

array
$_list list of available editors that are allowed (through admin config)
public string
# render( string & $editor )

Render the editor

Render the editor

Parameters

$editor
$editor Reference to the editor object

Returns

string
The rendered Editor string
public
# setConfig( string & $editor, string $options )

Sets the config of the editor

Sets the config of the editor

Parameters

$editor
$editor Reference to the editor object
$options
Options in the configuration to set
public object &
# _loadEditor( string $name, string $options = NULL )

Loads the editor

Loads the editor

Parameters

$name
Name of the editor to load
$options
Options in the editor to load (configuration)

Returns

object
The loaded Editor object
public static array
# getListByType( string $type = '' )

Retrieve a list of the available editors, by type

Retrieve a list of the available editors, by type

Parameters

$type

Returns

array
Available editors
Properties summary
public boolean $nohtml
# FALSE
public array $allowed_editors
# array()
API documentation generated by ApiGen