XCube
The foundational Core of XoopsCube Legacy
 
Loading...
Searching...
No Matches
XCube_AbstractProperty Class Reference

[Abstract] The base class which implements XCube_PropertyInterface, for all properties. More...

Inheritance diagram for XCube_AbstractProperty:
XCube_PropertyInterface XCube_BoolProperty XCube_FileProperty XCube_FloatProperty XCube_IntProperty XCube_StringProperty XCube_TextProperty XCube_ImageFileProperty

Public Member Functions

 __construct ( $name)
 Constructor.
 
 set ( $value)
 Sets $value as raw value to this property. And the value is casted by the property's type'.
 
 get ( $index=null)
 Gets the value of this property.
 
 isArray ()
 Gets a value indicating whether this object expresses Array.
 
 isNull ()
 Gets a value indicating whether this object is null.
 
 toNumber ()
 Gets a value as integer.
 
 toString ()
 Gets a value as string.
 
 toHTML ()
 Gets a value as encoded HTML code.
 
 hasFetchControl ()
 Gets a value indicating whether this object has a fetch control.
 
- Public Member Functions inherited from XCube_PropertyInterface
 get ()
 [Abstract] Gets the value of this property.
 
 setValue ( $arg0=null, $arg1=null)
 
 getValue ( $arg0=null)
 
 fetch (&$form)
 

Data Fields

 $mName
 string
 
 $mValue
 string
 

Detailed Description

[Abstract] The base class which implements XCube_PropertyInterface, for all properties.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $name)

Constructor.

Parameters
string$name- A name of this property.

Reimplemented from XCube_PropertyInterface.

Reimplemented in XCube_FileProperty, and XCube_ImageFileProperty.

Member Function Documentation

◆ get()

get ( $index = null)

Gets the value of this property.

Parameters
null$index
Returns
mixed

◆ hasFetchControl()

hasFetchControl ( )

Gets a value indicating whether this object has a fetch control.

Returns
bool

Reimplemented from XCube_PropertyInterface.

Reimplemented in XCube_FileProperty.

◆ isArray()

isArray ( )

Gets a value indicating whether this object expresses Array.

Returns
bool
Remarks
This class is a base class for none-array properties, so a sub-class of this does not override this method.

Reimplemented from XCube_PropertyInterface.

◆ isNull()

isNull ( )

Gets a value indicating whether this object is null.

Returns
bool

Reimplemented from XCube_PropertyInterface.

Reimplemented in XCube_FileProperty.

◆ set()

set ( $value)

Sets $value as raw value to this property. And the value is casted by the property's type'.

Parameters
mixed$value

Reimplemented from XCube_PropertyInterface.

Reimplemented in XCube_BoolProperty, XCube_FloatProperty, XCube_IntProperty, XCube_StringProperty, and XCube_TextProperty.

◆ toHTML()

toHTML ( )

Gets a value as encoded HTML code.

Returns
string - HTML
Deprecated

Reimplemented from XCube_PropertyInterface.

◆ toNumber()

toNumber ( )

Gets a value as integer.

Returns
int

Reimplemented from XCube_PropertyInterface.

Reimplemented in XCube_FileProperty, XCube_StringProperty, and XCube_TextProperty.

◆ toString()

toString ( )

Gets a value as string.

Returns
string

Reimplemented from XCube_PropertyInterface.

Reimplemented in XCube_FileProperty.


The documentation for this class was generated from the following file: