Documentation

Dms_Document_Version_Attachment_Dataset extends Admin_Form_Dataset_Entity
in package

Dms_Document_Version_Attachment_Dataset.

Tags
subpackage

Dms

version
7.x
copyright

© 2005-2024, https://www.hostcms.ru

Table of Contents

Properties

$_Admin_Form_Controller  : Admin_Form_Controller
Form controller
$_changedActions  : array<string|int, mixed>
List of changed actions
$_changedFields  : array<string|int, mixed>
List of changed fields
$_conditions  : mixed
Array of conditions array ( array('where' => array('a', '=', 'b')), array('where' => array('c', '=', 'd')) )
$_count  : int
Items count
$_entity  : object
Entity of dataset
$_externalFields  : array<string|int, mixed>
Array of external fields from additional tables
$_limit  : int
Limit
$_loaded  : bool
Load status
$_objects  : null|array<string|int, mixed>
Dataset objects list
$_offset  : int
Offset
$_orders  : mixed
Array of orders

Methods

__construct()  : mixed
Constructor.
_sortAsc()  : int
User-defined comparison functions.
_sortDesc()  : int
User-defined comparison functions.
addCondition()  : Admin_Form_Dataset
Add condition for the selection of elements
addExternalField()  : self
Add external field name
addUserConditions()  : self
Add user condition
changeAction()  : self
Change the data for the action Admin_Form_Action
changeField()  : self
Change the data for the field Admin_Form_Field
controller()  : self
Set controller
getActionChanges()  : string
Get changed field
getConditions()  : array<string|int, mixed>
Get conditions
getCount()  : int
Get items count
getEntity()  : object
Get entity
getFieldChanges()  : string
Get changed field
getObject()  : object
Get object
getObjects()  : array<string|int, mixed>
Get objects
issetExternalField()  : bool
Check if external field exists
limit()  : self
Set limit
load()  : array<string|int, mixed>
Load objects
loaded()  : self
Set load status
offset()  : self
Set offset
orderBy()  : self
Add orderBy
setCount()  : self
Set items count
_allJoinsNotUsed()  : bool
Check if not use join or use without where conditions
_getFoundRows()  : int
Get FOUND_ROWS
_getTotalCountByCount()  : int
Get total count by COUNT(*)
_issetGroupBy()  : bool
Check if entity conditions consist of groupBy
_issetHaving()  : bool
Check if entity conditions consist of having
_issetHavingOrGroupBy()  : bool
Check if entity conditions consist of having/groupBy
_setConditions()  : mixed
Apply conditions for the selection of elements

Properties

$_changedActions

List of changed actions

protected array<string|int, mixed> $_changedActions = array()

$_changedFields

List of changed fields

protected array<string|int, mixed> $_changedFields = array()

$_conditions

Array of conditions array ( array('where' => array('a', '=', 'b')), array('where' => array('c', '=', 'd')) )

protected mixed $_conditions = array()

$_count

Items count

protected int $_count = \NULL

$_entity

Entity of dataset

protected object $_entity = \NULL

$_externalFields

Array of external fields from additional tables

protected array<string|int, mixed> $_externalFields = array()

$_limit

Limit

protected int $_limit = \NULL

$_loaded

Load status

protected bool $_loaded = \FALSE

$_objects

Dataset objects list

protected null|array<string|int, mixed> $_objects = \NULL

$_offset

Offset

protected int $_offset = 0

$_orders

Array of orders

protected mixed $_orders = array()

Methods

__construct()

Constructor.

public __construct(Core_Entity $oCore_Entity) : mixed
Parameters
$oCore_Entity : Core_Entity

entity

Tags
hostcms-event

Admin_Form_Dataset_Entity.onAfterConstruct

_sortAsc()

User-defined comparison functions.

public static _sortAsc(mixed $m, mixed $n) : int
Parameters
$m : mixed
$n : mixed
Return values
int

_sortDesc()

User-defined comparison functions.

public static _sortDesc(mixed $m, mixed $n) : int
Parameters
$m : mixed
$n : mixed
Return values
int

addCondition()

Add condition for the selection of elements

public addCondition(array<string|int, mixed> $condition) : Admin_Form_Dataset
Parameters
$condition : array<string|int, mixed>

condition

Return values
Admin_Form_Dataset

addExternalField()

Add external field name

public addExternalField(string $fieldName) : self
Parameters
$fieldName : string

name of the field

Return values
self

addUserConditions()

Add user condition

public addUserConditions() : self
Return values
self

changeAction()

Change the data for the action Admin_Form_Action

public changeAction(string $name, string $property, string $value) : self
Parameters
$name : string

action name

$property : string

action's property name

$value : string

action's property value

Return values
self

changeField()

Change the data for the field Admin_Form_Field

public changeField(string $name, string $property, string $value) : self
Parameters
$name : string

field name

$property : string

field's property name

$value : string

field's property value

Return values
self

getActionChanges()

Get changed field

public getActionChanges(string $name) : string
Parameters
$name : string

field name

Return values
string

getConditions()

Get conditions

public getConditions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCount()

Get items count

public getCount() : int
Return values
int

getEntity()

Get entity

public getEntity() : object
Return values
object

getFieldChanges()

Get changed field

public getFieldChanges(string $name) : string
Parameters
$name : string

field name

Return values
string

getObject()

Get object

public getObject(int $primaryKey) : object
Parameters
$primaryKey : int

ID

Return values
object

getObjects()

Get objects

public getObjects() : array<string|int, mixed>
Return values
array<string|int, mixed>

issetExternalField()

Check if external field exists

public issetExternalField(string $fieldName) : bool
Parameters
$fieldName : string

name of the field

Return values
bool

limit()

Set limit

public limit(int $limit) : self
Parameters
$limit : int

limit

Return values
self

load()

Load objects

public load() : array<string|int, mixed>
Return values
array<string|int, mixed>

loaded()

Set load status

public loaded(bool $loaded) : self
Parameters
$loaded : bool

status

Return values
self

offset()

Set offset

public offset(int $offset) : self
Parameters
$offset : int

offset

Return values
self

orderBy()

Add orderBy

public orderBy(string $column[, string $direction = 'ASC' ][, bool $binary = FALSE ]) : self
Parameters
$column : string

column

$direction : string = 'ASC'

sorting direction

$binary : bool = FALSE

binary option

Return values
self

setCount()

Set items count

public setCount(int $count) : self
Parameters
$count : int
Return values
self

_allJoinsNotUsed()

Check if not use join or use without where conditions

protected _allJoinsNotUsed() : bool
Return values
bool

_getFoundRows()

Get FOUND_ROWS

protected _getFoundRows() : int
Return values
int

_getTotalCountByCount()

Get total count by COUNT(*)

protected _getTotalCountByCount() : int
Return values
int

_issetGroupBy()

Check if entity conditions consist of groupBy

protected _issetGroupBy() : bool
Return values
bool

_issetHaving()

Check if entity conditions consist of having

protected _issetHaving() : bool
Return values
bool

_issetHavingOrGroupBy()

Check if entity conditions consist of having/groupBy

protected _issetHavingOrGroupBy() : bool
Return values
bool

_setConditions()

Apply conditions for the selection of elements

protected _setConditions() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results