Documentation

EasyBlogTableField extends EasyBlogTable
in package

Table of Contents

Properties

$group_id  : mixed
$help  : mixed
$id  : mixed
$options  : mixed
$ordering  : mixed
$params  : mixed
$required  : mixed
$state  : mixed
$title  : mixed
$type  : mixed
$_supportNullValue  : mixed

Methods

__construct()  : mixed
Constructor for this class.
bind()  : mixed
Bind the table properties
check()  : mixed
Ensure that the field has proper values
delete()  : mixed
Override parent's logics
getClassForm()  : mixed
Retrieve the custom class value
getDBO()  : mixed
Retrieves the database object
getDisplay()  : mixed
Retrieve the display value
getFieldClassValue()  : mixed
Retrieve the custom class value
getForm()  : mixed
Retrieves the form
getGroupTitle()  : mixed
Retrieves the title of the group
getHelp()  : mixed
Retrieve the custom field's help
getInstance()  : mixed
Tired of fixing conflicts with JTable::getInstance . We'll overload their method here.
getParams()  : mixed
Generic method to retrive raw json params from the table
getTitle()  : mixed
Retrieve the custom field title
moveOrder()  : mixed
Move ordering
publish()  : mixed
Publishes a field group
removeRequired()  : mixed
reset()  : void
Method to reset class properties to the defaults set in the class definition. It will ignore the primary key as well as any private class properties.
setRequired()  : mixed
store()  : mixed
Override parent's implementation of store
toArray()  : mixed
Converts a table layer into an array
unpublish()  : mixed
Unpublishes a field group

Properties

$group_id

public mixed $group_id = \null

$help

public mixed $help = ''

$id

public mixed $id = \null

$options

public mixed $options = \null

$ordering

public mixed $ordering = \null

$params

public mixed $params = \null

$required

public mixed $required = \null

$state

public mixed $state = \null

$title

public mixed $title = ''

$type

public mixed $type = \null

$_supportNullValue

protected mixed $_supportNullValue = true

Methods

__construct()

Constructor for this class.

public __construct(object &$db) : mixed
Parameters
$db : object
Tags
@return

bind()

Bind the table properties

public bind(mixed $src[, mixed $ignore = [] ]) : mixed
Parameters
$src : mixed
$ignore : mixed = []
Tags
since
1.1.0
access

public

check()

Ensure that the field has proper values

public check() : mixed
Tags
since
5.0
access

public

delete()

Override parent's logics

public delete([mixed $pk = null ]) : mixed
Parameters
$pk : mixed = null
Tags
since
4.0
access

public

getClassForm()

Retrieve the custom class value

public getClassForm(EasyBlogPost $post[, mixed $elementName = 'fields' ]) : mixed
Parameters
$post : EasyBlogPost
$elementName : mixed = 'fields'
Tags
since
5.2
access

public

getDBO()

Retrieves the database object

public getDBO() : mixed
Tags
since
6.0.0
access

public

getDisplay()

Retrieve the display value

public getDisplay(EasyBlogPost &$post) : mixed
Parameters
$post : EasyBlogPost
Tags
since
4.0
access

public

getFieldClassValue()

Retrieve the custom class value

public getFieldClassValue(mixed $fieldId, mixed $postId) : mixed
Parameters
$fieldId : mixed
$postId : mixed
Tags
since
5.2
access

public

getForm()

Retrieves the form

public getForm(EasyBlogPost $post[, mixed $elementName = 'fields' ]) : mixed
Parameters
$post : EasyBlogPost
$elementName : mixed = 'fields'
Tags
since
4.0
access

public

getGroupTitle()

Retrieves the title of the group

public getGroupTitle() : mixed
Tags
since
4.0
access

public

getHelp()

Retrieve the custom field's help

public getHelp() : mixed
Tags
since
4.0
access

public

getInstance()

Tired of fixing conflicts with JTable::getInstance . We'll overload their method here.

public static getInstance(string $type[, string $prefix = 'JTable' ][, array<string|int, mixed> $config = [] ]) : mixed
Parameters
$type : string

The type (name) of the JTable class to get an instance of.

$prefix : string = 'JTable'

An optional prefix for the table class name.

$config : array<string|int, mixed> = []

An optional array of configuration values for the JTable object.

Tags
link
http://docs.joomla.org/JTable/getInstance
since
11.1
Return values
mixed —

A JTable object if found or boolean false if one could not be found.

getParams()

Generic method to retrive raw json params from the table

public final getParams() : mixed
Tags
since
1.1.0
access

public

getTitle()

Retrieve the custom field title

public getTitle() : mixed
Tags
since
4.0
access

public

moveOrder()

Move ordering

public moveOrder(mixed $direction) : mixed
Parameters
$direction : mixed
Tags
since
5.3.0
access

public

publish()

Publishes a field group

public publish([mixed $pks = null ][, mixed $state = 1 ][, mixed $userId = 0 ]) : mixed
Parameters
$pks : mixed = null
$state : mixed = 1
$userId : mixed = 0
Tags
since
4.0
access

public

removeRequired()

public removeRequired() : mixed

reset()

Method to reset class properties to the defaults set in the class definition. It will ignore the primary key as well as any private class properties.

public reset() : void
Tags
link
http://docs.joomla.org/JTable/reset
since
11.1

setRequired()

public setRequired() : mixed

store()

Override parent's implementation of store

public store([mixed $updateNulls = false ]) : mixed
Parameters
$updateNulls : mixed = false
Tags
since
5.3.0
access

public

toArray()

Converts a table layer into an array

public toArray() : mixed
Tags
since
1.1.0
access

public

unpublish()

Unpublishes a field group

public unpublish() : mixed
Tags
since
4.0
access

public


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results