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

  • Assets
  • ComposerUtility
  • Events
  • FilterInput
  • FixedGroups
  • HttpRequest
  • Logger
  • MediaUploader
  • MimeTypes
  • PreloadItem
  • Psr0ClassLoader
  • Psr4ClassLoader
  • Random
  • Registry
  • Request
  • Security
  • XoopsTpl
  • Yaml

Interfaces

  • AttributeInterface
  • Overview
  • Namespace
  • Class
  • Tree

Interface AttributeInterface

AttributeInterface - standard access to attributes

Direct known implementers

Xoops\Core\Registry, Xoops\Core\Session\Manager, Xoops\Core\Text\Sanitizer\ConfigurationAbstract, Xoops\Html\Attributes

Indirect known implementers

AwesomeButton, FormDhtmlTextArea, Xoops\Form\ColorPicker, Xoops\Form\DateSelect, Xoops\Form\DateTime, Xoops\Form\DhtmlTextArea, Xoops\Form\Editor, Xoops\Form\Element, Xoops\Form\ElementTray, Xoops\Form\File, Xoops\Form\GroupCheckbox, Xoops\Form\GroupFormCheckbox, FormTextArea, Xoops\Form\Hidden, Xoops\Form\Label, Xoops\Form\Mail, Xoops\Form\OptionElement, Xoops\Form\Password, Xoops\Form\Radio, Xoops\Form\RadioYesNo, Xoops\Form\Raw, Xoops\Form\Select, Xoops\Form\SelectCountry, PublisherFormDateTime, Xoops\Form\SelectEditor, Xoops\Form\SelectGroup, Xoops\Form\SelectLanguage, Xoops\Form\SelectLocale, Xoops\Form\SelectMatchOption, Xoops\Form\SelectTheme, Xoops\Form\SelectTimeZone, Xoops\Form\SelectUser, Xoops\Form\Tab, Xoops\Form\TabTray, Xoops\Core\Text\Sanitizer\Configuration, Xoops\Form\Text, Xoops\Form\TextArea, Xoops\Form\Token, Xoops\Form\Url, Xoops\Html\Img, XoopsEditor, XoopsFormButton, XoopsFormButtonTray, XoopsFormCaptcha, XoopsFormCheckBox, Xoops\Core\Text\Sanitizer\DefaultConfiguration, XoopsFormColorPicker, XoopsFormDateTime, XoopsFormDhtmlTextArea, XoopsFormEditor, XoopsFormElement, XoopsFormElementTray, XoopsFormFile, XoopsFormHidden, XoopsFormHiddenToken, XoopsFormLabel, Xoops\Form\Button, XoopsFormPassword, XoopsFormRadio, XoopsFormRadioYN, XoopsFormSelect, XoopsFormSelectCheckGroup, XoopsFormSelectCountry, XoopsFormSelectEditor, XoopsFormSelectGroup, XoopsFormSelectLang, XoopsFormSelectMatchOption, Xoops\Form\ButtonTray, XoopsFormSelectTheme, XoopsFormSelectTimezone, XoopsFormSelectUser, XoopsFormText, XoopsFormTextArea, XoopsFormTextDateSelect, XoopsFormTinymce, XoopsFormTinymce4, Xoops\Form\Captcha, Xoops\Form\Checkbox
Namespace: Xoops\Core
Package: AttributeInterface
Category: Xoops\Core
Copyright: 2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Richard Griffith richard@geekwright.com
Link: http://xoops.org
Located at oops_lib/Xoops/Core/AttributeInterface.php
Methods summary
public mixed
# get( string $name, mixed $default = null )

Retrieve an attribute value.

Retrieve an attribute value.

Parameters

$name
Name of the attribute
$default
A default value returned if the requested attribute is not set.

Returns

mixed
The value of the session variable, or $default if not set.
public
# set( string $name, mixed $value )

Set an attribute value.

Set an attribute value.

Parameters

$name
Name of the attribute option
$value
Value of the attribute option
public boolean
# has( string $name )

Determine if an attribute exists.

Determine if an attribute exists.

Parameters

$name
An attribute name.

Returns

boolean
TRUE if the given attribute exists, otherwise FALSE.
public mixed
# remove( string $name )

Remove an attribute.

Remove an attribute.

Parameters

$name
An attribute name.

Returns

mixed

An attribute value, if the named attribute existed and has been removed, otherwise NULL.

public array
# clear( )

Remove all attributes, return previous values.

Remove all attributes, return previous values.

Returns

array
old attributes values
API documentation generated by ApiGen