Documentation

Maillist_Siteuser_Siteuser_Model extends Siteuser_Model
in package

HostCMS

Maillist

Maillist_Siteuser_Siteuser_Model

Properties

$address : mixed
$cart : string: Backend property
$city : mixed
$company : mixed
$config : mixed: ORM config
$counterparty : string: Backend property
$country : mixed
$favorite : string: Backend property
$fax : mixed
$icq : mixed
$img_list_affiliates : string: Backend property
$img_list_cashes : string: Backend property
$img_list_people_companies : string: Backend property
$name : mixed
$patronymic : mixed
$phone : mixed
$postcode : mixed
$representative : string: Backend property
$subscribed : int: Backend property
$surname : mixed
$timeline : string: Backend property
$type : int: Backend property
$website : mixed
$_allowedTags : array<string|int, mixed>: Allowed tags. If list of tags is empty, all tags will show.
$_attachSessionToIp : mixed: Attach session to IP
$_attributes : array<string|int, mixed>: Entity Attributes
$_belongsTo : array<string|int, mixed>: Belongs to relations
$_changeCopiedName : bool: Change copied name is necessary, default FALSE
$_changedColumns : array<string|int, mixed>: List of changed columns
$_dataValues : array<string|int, mixed>: data-values, e.g. dataMyValue
$_forbiddenTags : array<string|int, mixed>: Forbidden tags. If list of tags is empty, all tags will be shown.
$_hasMany : array<string|int, mixed>: One-to-many or many-to-many relations
$_hasOne : array<string|int, mixed>: One-to-one relations
$_hasRevisions : mixed: Has revisions
$_marksDeleted : mixed: Marks deleted entity
$_modelColumns : array<string|int, mixed>: List of columns in model with values
$_modelName : string: Name of the model
$_nameColumn : string: Column consist item's name
$_oldFields : mixed
$_preloadValues : array<string|int, mixed>: List of preloaded values those will set for new object which does not have primary key
$_primaryKey : string: Primary key
$_propertyValues : array<string|int, mixed>: Values of all properties of user
$_queryBuilder : Core_QueryBuilder_Select: Select query builder
$_shortcodeTags : array<string|int, mixed>: List of Shortcodes tags
$_showXmlCompanies : bool: Show siteuser companies data in XML
$_showXmlMaillists : bool: Show maillists data in XML
$_showXmlPeople : bool: Show siteuser people data in XML
$_showXmlProperties : mixed: Show properties in XML
$_skipColumns : array<string|int, mixed>: List of skipped columns from table
$_sorting : array<string|int, mixed>: Default sorting for models <code> protected $_sorting = array( 'tablename.sorting' => 'ASC' ); </code>
$_tableColumns : array<string|int, mixed>: List of columns in table
$_tableName : string: Name of the table
$_typicalForbiddenTags : array<string|int, mixed>: Typical forbidden tags.
$_xmlSortPropertiesValues : mixed: Sort properties values in XML

Methods

__call() : mixed: Triggered when invoking inaccessible methods in an object context
__construct() : mixed: Constructor.
__isset() : mixed
__set() : self: Run when writing data to inaccessible properties
activate() : self: Change activity status to ON
add() : self: Add related object. If main object does not save, it will save.
addAllowedTag() : self: Add tag to allowed tags list
addAllowedTags() : self: Add tags to allowed tags list
addAttribute() : self: Add entity attribute
addEntities() : self: Add children entities
addEntity() : self: Add a children entity
addForbiddenTag() : self: Add tag to forbidden tags list
addForbiddenTags() : self: Add tags to forbidden tags list
addFriend() : self: Add user to friend list
addXmlTag() : self: Add external tag for entity
applyMarksDeleted() : self: Apply markDeleted flag if is set
attachSessionToIp() : mixed
changeActive() : Siteuser_Model: Change site user status
changeCopiedName() : self: Set if change copied name is necessary
changed() : bool: Check model has been changed.
check() : self: Check model values. If model has incorrect value, one will correct or call exception.
chunk() : bool: Retrieve a small chunk and feeds each one into $callback for processing. It stops looping when $callback returns FALSE
clear() : self: Clear object
clearEntities() : self: Clear enities
clearEntitiesAfterGetXml() : self: Clear all entities after XML generation
clearXmlTags() : mixed: Clear external XML tags for entity.
copy() : new: Copy object
counterpartyBackend() : string: Backend callback method
create() : self: Insert new object data into database
createDir() : self: Create directory for item
delete() : self: Delete object from database
deleteAll() : self: Delete all object
factory() : mixed: Create and return an object of model
find() : self: Find object in database and load one. Use clear() before find() with conditions!
findAll() : array<string|int, mixed>: Find all objects
getAllowedMaillists() : array<string|int, mixed>: Список доступных пользователю рассылок 'Maillists'
getAllowedTags() : array<string|int, mixed>: Get allowed tags list
getBonuses() : array<string|int, mixed>: Get siteuser bonuses
getByLoginAndEmail() : Siteuser_Model|null: Get user by login and email
getByLoginAndPassword() : Siteuser_Model|null: Get user by login and password
getChangedData() : array<string|int, mixed>: Get changed columns with values
getClassName() : string: Get Model CallsName
getCount() : int|false: Get count object
getCurrent() : Siteuser_Model|null: Get current user
getDatabaseDriver() : string: Get name of Database Driver
getDataValues() : array<string|int, mixed>: Get dataValues
getDirHref() : string: Get object directory href
getDirPath() : string: Get object directory path
getEntities() : array<string|int, mixed>: Get children entities
getFieldIDs() : array<string|int, mixed>: Get visible field's IDs
getFields() : array<string|int, mixed>: Get field's values
getFirst() : null|Core_ORM: Get fist entity, ordered by primary key
getForbiddenTags() : array<string|int, mixed>: Get forbidden tags list
getLast() : null|Core_ORM: Get last entity, ordered by primary key
getLastActivity() : int: Return number of seconds since last activity
getMarksDeleted() : string: Get column name for marks deleted
getModelName() : string: Get model name, e.g. 'book' for 'Book_Model'
getName() : string: Get entity name
getNameColumn() : string: Get Name Column
getPath() : string: Get path for files
getPrimaryKey() : mixed: Get primary key value
getPrimaryKeyName() : string: Get primary key name
getPropertyValues() : array<string|int, mixed>: Values of all properties of element
getRelatedSite() : Site_Model|null: Get Related Site
getRelations() : array<string|int, mixed>: Get $this->_relations
getStdObject() : stdObject: Get stdObject for entity and children entities
getTableColumns() : array<string|int, mixed>: Get tableColumns
getTableColums() : array<string|int, mixed>: Get table columns. Fix wrong method name
getTableName() : string: Get table name
getTransactions() : array<string|int, mixed>: Get all shop's transactions
getTransactionsAmount() : float: Get amount of all shop transactions
getTrashDescription() : string: Get entity description
getXml() : string: Get XML for entity and children entities
getXmlTagName() : string: Get tag name
getXmlTags() : array<string|int, mixed>: Get external XML tags for entity.
html() : self: Set HTML type
indexing() : Search_Page: Search indexation
isCallable() : bool: Verify that the contents of a variable can be called as a function
isEmptyPrimaryKey() : bool: Check is primary key NULL
isOnline() : bool: Is user online
loginBackend() : string: Backend callback method
markDeleted() : self: Mark entity as deleted
merge() : self: Merge siteuser with another one
queryBuilder() : Core_QueryBuilder_Select: Get query builder for select
remove() : self: Remove related object. If main object does not save, it will save.
removeAllowedTag() : self: Remove tag from allowed tags list
removeForbiddenTag() : self: Remove tag from forbidden tags list
removeFriend() : self: Remove user from friend list
save() : Maillist_Siteuser_Siteuser_Model: Save object. Use self::update() or self::create()
setCheck() : self: Set _check flag
setCurrent() : self: Set user as current
setDatabaseDriver() : mixed: Set name of Database Driver
setMarksDeleted() : self: Set column name for marks deleted
setRelations() : self: Set $this->_relations
setXmlTagName() : self: Set name of XML node
showRepresentativesInLine() : mixed: Show representatives in line
showXmlCompanies() : self: Show siteuser companies in XML
showXmlMaillists() : self: Show maillist in XML
showXmlPeople() : self: Show siteuser people in XML
showXmlProperties() : self: Show properties in XML
text() : self: Set TEXT type
toArray() : array<string|int, mixed>: Convert Object to Array
undelete() : self: Turn off deleted status
unsetCurrent() : self: Unset current user from session
unsubscribe() : self: Unsubscribe siteuser
update() : self: Update object data into database
updateLastActivity() : self: Update last activity
_getCopiedName() : mixed: Get the name of a new copied object
_isTagAvailable() : bool: Is $tagName Available
_prepareData() : self: Prepare entity and children entities
_preparePropertyValue() : mixed: Prepare Property Value
getDatabase() : Core_DataBase: Get Database

$address


    public
        mixed
    $address
     = \NULL

$cart

Backend property


    public
        string
    $cart
     = 0

$city


    public
        mixed
    $city
     = \NULL

$company


    public
        mixed
    $company
     = \NULL

$config

ORM config


    public
    static    mixed
    $config
     = \NULL

$counterparty

Backend property


    public
        string
    $counterparty
     = \NULL

$country


    public
        mixed
    $country
     = \NULL

$favorite

Backend property


    public
        string
    $favorite
     = 0

$fax


    public
        mixed
    $fax
     = \NULL

$icq


    public
        mixed
    $icq
     = \NULL

$img_list_affiliates

Backend property


    public
        string
    $img_list_affiliates
     = 0

$img_list_cashes

Backend property


    public
        string
    $img_list_cashes
     = 0

$img_list_people_companies

Backend property


    public
        string
    $img_list_people_companies
     = \NULL

$name


    public
        mixed
    $name
     = \NULL

$patronymic


    public
        mixed
    $patronymic
     = \NULL

$phone


    public
        mixed
    $phone
     = \NULL

$postcode


    public
        mixed
    $postcode
     = \NULL

$representative

Backend property


    public
        string
    $representative
     = 0

$subscribed

Backend property


    public
        int
    $subscribed
     = 0

$surname


    public
        mixed
    $surname
     = \NULL

$timeline

Backend property


    public
        string
    $timeline
     = 0

$type

Backend property


    public
        int
    $type
     = 0

$website


    public
        mixed
    $website
     = \NULL

$_allowedTags

Allowed tags. If list of tags is empty, all tags will show.


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

$_attachSessionToIp

Attach session to IP


    protected
        mixed
    $_attachSessionToIp

$_attributes

Entity Attributes


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

$_belongsTo

Belongs to relations


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


// Belongs to relation for Comment-Book:
protected $_belongsTo = array('book' => array());


// Equivalence belongs to relation for Comment-Book with detailed conditions:
// book - Model name
// foreign_key - Foreign key
// primary_key - Primary key in the parent table
protected $_belongsTo = array('book' => array(
		'foreign_key' => 'book_id'
	));

$_changeCopiedName

Change copied name is necessary, default FALSE


    protected
        bool
    $_changeCopiedName
     = \FALSE

$_changedColumns

List of changed columns


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

$_dataValues

data-values, e.g. dataMyValue


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

$_forbiddenTags

Forbidden tags. If list of tags is empty, all tags will be shown.


    protected
        array<string|int, mixed>
    $_forbiddenTags
     = array('deleted', 'user_id')

$_hasMany

One-to-many or many-to-many relations


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

One-to-many relation // Relation one-to-many for Book-Comments: protected $_hasMany = array('comment' => array());


// Equivalence relation one-to-many for Book-Comments with detailed conditions:
// comment - Model name
// foreign_key - Foreign key
protected $_hasMany = array('comment' => array(
'foreign_key' => 'book_id'
	));

Many-to-many relation // Relation many-to-many for Book-Comments through model 'books_comment': protected $_hasMany = array('comment' => array( 'through' => 'books_comment' ));


// Relation many-to-many for Book-Comments through model 'books_comment' with detailed conditions:
protected $_hasMany = array('comment' => array(
'foreign_key' => 'book_id',
'through' => 'books_comment',
'dependent_key' => 'comment_id'
	));

$_hasOne

One-to-one relations


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


// Relation one-to-one for Book-Comment:
protected $_hasOne = array('comment' => array());


// Equivalence relation one-to-one for Book-Comment with detailed conditions:
// comment - Model name
// foreign_key - Foreign key
protected $_hasOne = array('comment' => array(
'foreign_key' => 'book_id'
	));

$_hasRevisions

Has revisions


    protected
        mixed
    $_hasRevisions
     = \FALSE

$_marksDeleted

Marks deleted entity


    protected
        mixed
    $_marksDeleted
     = 'deleted'

$_modelColumns

List of columns in model with values


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

$_modelName

Name of the model


    protected
        string
    $_modelName
     = 'maillist_siteuser_siteuser'

$_nameColumn

Column consist item's name


    protected
        string
    $_nameColumn
     = 'name'

$_oldFields


    protected
    static    mixed
    $_oldFields
     = array('name', 'surname', 'patronymic', 'company', 'phone', 'website', 'country', 'city', 'address')

$_preloadValues

List of preloaded values those will set for new object which does not have primary key


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

$_primaryKey

Primary key


    protected
        string
    $_primaryKey
     = 'id'

$_propertyValues

Values of all properties of user


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

$_queryBuilder

Select query builder


    protected
        Core_QueryBuilder_Select
    $_queryBuilder
     = \NULL

$_shortcodeTags

List of Shortcodes tags


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

$_showXmlCompanies

Show siteuser companies data in XML


    protected
        bool
    $_showXmlCompanies
     = \TRUE

$_showXmlMaillists

Show maillists data in XML


    protected
        bool
    $_showXmlMaillists
     = \FALSE

$_showXmlPeople

Show siteuser people data in XML


    protected
        bool
    $_showXmlPeople
     = \TRUE

$_showXmlProperties

Show properties in XML


    protected
        mixed
    $_showXmlProperties
     = \FALSE

$_skipColumns

List of skipped columns from table


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

$_sorting

Default sorting for models <code> protected $_sorting = array( 'tablename.sorting' => 'ASC' ); </code>


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

$_tableColumns

List of columns in table


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

$_tableName

Name of the table


    protected
        string
    $_tableName
     = 'siteusers'

$_typicalForbiddenTags

Typical forbidden tags.


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

$_xmlSortPropertiesValues

Sort properties values in XML


    protected
        mixed
    $_xmlSortPropertiesValues
     = \TRUE

__call()

Triggered when invoking inaccessible methods in an object context


    public
                    __call(string $name, array<string|int, mixed> $arguments) : mixed

Parameters

$name : string: method name
$arguments : array<string|int, mixed>: arguments

__construct()

Constructor.


    public
                    __construct([string $primaryKey = NULL ]) : mixed

Parameters

$primaryKey : string = NULL

__isset()


    public
                    __isset(mixed $property) : mixed

Parameters

$property : mixed

__set()

Run when writing data to inaccessible properties


    public
                    __set(string $property, string $value) : self

Parameters

$property : string: property name
$value : string: property value

Return values

self

activate()

Change activity status to ON


    public
                    activate() : self

Return values

self

add()

Add related object. If main object does not save, it will save.


    public
                    add(Core_ORM $model[, string $relation = NULL ]) : self

Parameters

$model : Core_ORM
$relation : string = NULL

Return values

self

addAllowedTag()

Add tag to allowed tags list


    public
                    addAllowedTag(string $tag) : self

Parameters

$tag : string: tag

Return values

self

addAllowedTags()

Add tags to allowed tags list


    public
                    addAllowedTags(array<string|int, mixed> $aTags) : self

Parameters

$aTags : array<string|int, mixed>: array of tags

Return values

self

addAttribute()

Add entity attribute


    public
                    addAttribute(string $name, string $value) : self

Parameters

$name : string
$value : string

Return values

self

addEntities()

Add children entities


    public
                    addEntities(array<string|int, mixed> $aChildrenEntities) : self

Parameters

$aChildrenEntities : array<string|int, mixed>

Return values

self

addEntity()

Add a children entity


    public
                    addEntity(Core_Entity $oChildrenEntity) : self

Parameters

$oChildrenEntity : Core_Entity

Return values

self

addForbiddenTag()

Add tag to forbidden tags list


    public
                    addForbiddenTag(string $tag) : self

Parameters

$tag : string: tag

Return values

self

addForbiddenTags()

Add tags to forbidden tags list


    public
                    addForbiddenTags(array<string|int, mixed> $aTags) : self

Parameters

$aTags : array<string|int, mixed>: array of tags

Return values

self

addFriend()

Add user to friend list


    public
                    addFriend(Siteuser_Model $oSiteuser_Friend) : self

Parameters

$oSiteuser_Friend : Siteuser_Model: site user

Return values

self

addXmlTag()

Add external tag for entity


    public
                    addXmlTag(string $tagName, string $tagValue[, array<string|int, mixed> $attributes = array() ]) : self

Parameters

$tagName : string: tag name
$tagValue : string: tag value
$attributes : array<string|int, mixed> = array(): attributes

Return values

self

applyMarksDeleted()

Apply markDeleted flag if is set


    public
                    applyMarksDeleted() : self

Return values

self

attachSessionToIp()


    public
                    attachSessionToIp(mixed $bAttachSessionToIp) : mixed

Parameters

$bAttachSessionToIp : mixed

changeActive()

Change site user status


    public
                    changeActive() : Siteuser_Model

Return values

Siteuser_Model

changeCopiedName()

Set if change copied name is necessary


    public
                    changeCopiedName(bool $changeCopiedName) : self

Parameters

$changeCopiedName : bool: mode

Return values

self

changed()

Check model has been changed.


    public
                    changed() : bool

Return values

bool

check()

Check model values. If model has incorrect value, one will correct or call exception.


    public
                    check([bool $exception = FALSE ]) : self


$object = Core_ORM::factory('Book', 1);
$object->value = 123;
$object->check(TRUE)->save();

Parameters

$exception : bool = FALSE: Call exception (TRUE) or correct value (FALSE). Default FALSE.

Return values

self

chunk()

Retrieve a small chunk and feeds each one into $callback for processing. It stops looping when $callback returns FALSE


    public
                    chunk(int $count, callable $callback[, bool $bCache = TRUE ]) : bool

Parameters

$count : int: chunk size
$callback : callable
$bCache : bool = TRUE: use cache

Return values

bool

clear()

Clear object


    public
                    clear() : self

Return values

self

clearEntities()

Clear enities


    public
                    clearEntities() : self

Return values

self

clearEntitiesAfterGetXml()

Clear all entities after XML generation


    public
                    clearEntitiesAfterGetXml([bool $clear = TRUE ]) : self

Parameters

$clear : bool = TRUE: mode

Return values

self

clearXmlTags()

Clear external XML tags for entity.


    public
                    clearXmlTags() : mixed

copy()

Copy object


    public
                    copy() : new

Return values

new —

copied object

counterpartyBackend()

Backend callback method


    public
                    counterpartyBackend(Admin_Form_Field $oAdmin_Form_Field, Admin_Form_Controller $oAdmin_Form_Controller) : string

Parameters

$oAdmin_Form_Field : Admin_Form_Field
$oAdmin_Form_Controller : Admin_Form_Controller

Return values

string

create()

Insert new object data into database


    public
                    create() : self

Return values

self

createDir()

Create directory for item


    public
                    createDir() : self

Return values

self

delete()

Delete object from database


    public
                    delete([mixed $primaryKey = NULL ]) : self


// Delete object with lazy load
Core_ORM::factory('Book', 1)->delete();


// Delete object without load
Core_ORM::factory('Book')->delete(1);

Parameters

$primaryKey : mixed = NULL: primary key for deleting object

Return values

self

deleteAll()

Delete all object


    public
                    deleteAll([bool $bCache = TRUE ][, int $limit = 100 ]) : self

Parameters

$bCache : bool = TRUE: use cache
$limit : int = 100: default 100 Core_ORM::factory('Book')->Comments->deleteAll();

Return values

self

factory()

Create and return an object of model


    public
            static        factory( $modelName[,  $primaryKey = NULL ]) : mixed

Parameters

$modelName :: Model name
$primaryKey : = NULL: Primary key

find()

Find object in database and load one. Use clear() before find() with conditions!


    public
                    find([mixed $primaryKey = NULL ][, bool $bCache = TRUE ]) : self

Parameters

$primaryKey : mixed = NULL: default NULL
$bCache : bool = TRUE: use cache // Find an object and load (without lazy load) // If an object is not found, primary key sets NULL $oBook = Core_ORM::factory('Book')->find(1);

Return values

self

findAll()

Find all objects


    public
                    findAll([bool $bCache = TRUE ]) : array<string|int, mixed>

Parameters

$bCache : bool = TRUE: use cache, default TRUE // Find objects $aBooks = Core_ORM::factory('Book')->findAll(); foreach ($aBooks as $oBook) { var_dump($oBook->id); }

Return values

array<string|int, mixed>

getAllowedMaillists()

Список доступных пользователю рассылок 'Maillists'


    public
                    getAllowedMaillists() : array<string|int, mixed>

Return values

array<string|int, mixed>

getAllowedTags()

Get allowed tags list


    public
                    getAllowedTags() : array<string|int, mixed>

Return values

array<string|int, mixed>

getBonuses()

Get siteuser bonuses


    public
                    getBonuses(Shop_Model $oShop) : array<string|int, mixed>

Parameters

$oShop : Shop_Model

Return values

array<string|int, mixed>

getByLoginAndEmail()

Get user by login and email


    public
                    getByLoginAndEmail(string $login, string $email) : Siteuser_Model|null

Parameters

$login : string: login
$email : string: email

Return values

Siteuser_Model|null

getByLoginAndPassword()

Get user by login and password


    public
                    getByLoginAndPassword(string $login, string $password) : Siteuser_Model|null

Parameters

$login : string: login
$password : string: password

Return values

Siteuser_Model|null

getChangedData()

Get changed columns with values


    public
                    getChangedData() : array<string|int, mixed>

Return values

array<string|int, mixed>

getClassName()

Get Model CallsName


    public
            static        getClassName( $modelName) : string

Parameters

$modelName :: Model name

Return values

string

getCount()

Get count object


    public
                    getCount([bool $bCache = TRUE ][, string $fieldName = '*' ][, bool $distinct = FALSE ]) : int|false

Parameters

$bCache : bool = TRUE: use cache, default TRUE
$fieldName : string = '*': default '*'
$distinct : bool = FALSE: default FALSE

Return values

int|false —


$iCount = Core_ORM::factory('Book')->getCount();
var_dump($iCount);

getCurrent()

Get current user


    public
                    getCurrent([ $bCheckSite = FALSE ]) : Siteuser_Model|null

Parameters

$bCheckSite : = FALSE: Check siteuser's site and current site

Return values

Siteuser_Model|null

getDatabaseDriver()

Get name of Database Driver


    public
            static        getDatabaseDriver() : string

Return values

string

getDataValues()

Get dataValues


    public
                    getDataValues() : array<string|int, mixed>

Return values

array<string|int, mixed>

getDirHref()

Get object directory href


    public
                    getDirHref() : string

Return values

string

getDirPath()

Get object directory path


    public
                    getDirPath() : string

Return values

string

getEntities()

Get children entities


    public
                    getEntities() : array<string|int, mixed>

Return values

array<string|int, mixed>

getFieldIDs()

Get visible field's IDs


    public
                    getFieldIDs() : array<string|int, mixed>

Return values

array<string|int, mixed>

getFields()

Get field's values


    public
                    getFields() : array<string|int, mixed>

Return values

array<string|int, mixed>

getFirst()

Get fist entity, ordered by primary key


    public
                    getFirst([bool $bCache = TRUE ]) : null|Core_ORM

Parameters

$bCache : bool = TRUE: use cache, default TRUE

Return values

null|Core_ORM —


$mObject = Core_ORM::factory('Book')->getFirst();
if (!is_null($mObject))
{
	echo $mObject;
}

getForbiddenTags()

Get forbidden tags list


    public
                    getForbiddenTags() : array<string|int, mixed>

Return values

array<string|int, mixed>

getLast()

Get last entity, ordered by primary key


    public
                    getLast([bool $bCache = TRUE ]) : null|Core_ORM

Parameters

$bCache : bool = TRUE: use cache, default TRUE

Return values

null|Core_ORM —


$mObject = Core_ORM::factory('Book')->getLast();
if (!is_null($mObject))
{
	echo $mObject;
}

getLastActivity()

Return number of seconds since last activity


    public
                    getLastActivity() : int

Return values

int

getMarksDeleted()

Get column name for marks deleted


    public
                    getMarksDeleted() : string

Return values

string

getModelName()

Get model name, e.g. 'book' for 'Book_Model'


    public
                    getModelName() : string

Return values

string

getName()

Get entity name


    public
                    getName() : string

Return values

string

getNameColumn()

Get Name Column


    public
                    getNameColumn() : string

Return values

string

getPath()

Get path for files


    public
                    getPath() : string

Return values

string

getPrimaryKey()

Get primary key value


    public
                    getPrimaryKey() : mixed

getPrimaryKeyName()

Get primary key name


    public
                    getPrimaryKeyName() : string

Return values

string

getPropertyValues()

Values of all properties of element


    public
                    getPropertyValues([bool $bCache = TRUE ][, array<string|int, mixed> $aPropertiesId = array() ][, bool $bSorting = FALSE ]) : array<string|int, mixed>

Parameters

$bCache : bool = TRUE: cache mode
$aPropertiesId : array<string|int, mixed> = array(): array of properties' IDs
$bSorting : bool = FALSE: sort results, default FALSE

Return values

array<string|int, mixed> —

Property_Value

getRelatedSite()

Get Related Site


    public
                    getRelatedSite() : Site_Model|null

Return values

Site_Model|null

getRelations()

Get $this->_relations


    public
                    getRelations() : array<string|int, mixed>

Return values

array<string|int, mixed>

getStdObject()

Get stdObject for entity and children entities


    public
                    getStdObject([mixed $attributePrefix = '_' ]) : stdObject

Parameters

$attributePrefix : mixed = '_'

Return values

stdObject

getTableColumns()

Get tableColumns


    public
                    getTableColumns() : array<string|int, mixed>

Return values

array<string|int, mixed>

getTableColums()

Get table columns. Fix wrong method name


    public
                    getTableColums() : array<string|int, mixed>

Return values

array<string|int, mixed>

getTableName()

Get table name


    public
                    getTableName() : string

Return values

string

getTransactions()

Get all shop's transactions


    public
                    getTransactions(Shop_Model $oShop) : array<string|int, mixed>

Parameters

$oShop : Shop_Model: shop

Return values

array<string|int, mixed>

getTransactionsAmount()

Get amount of all shop transactions


    public
                    getTransactionsAmount(Shop_Model $oShop) : float

Parameters

$oShop : Shop_Model: shop

Return values

float

getTrashDescription()

Get entity description


    public
                    getTrashDescription() : string

Return values

string

getXml()

Get XML for entity and children entities


    public
                    getXml() : string

Return values

string

getXmlTagName()

Get tag name


    public
                    getXmlTagName() : string

Return values

string

getXmlTags()

Get external XML tags for entity.


    public
                    getXmlTags() : array<string|int, mixed>

Return values

array<string|int, mixed>

html()

Set HTML type


    public
                    html() : self

Return values

self

indexing()

Search indexation


    public
                    indexing() : Search_Page

Return values

Search_Page

isCallable()

Verify that the contents of a variable can be called as a function


    public
                    isCallable(string $methodName) : bool

Parameters

$methodName : string: method name

Return values

bool

isEmptyPrimaryKey()

Check is primary key NULL


    public
                    isEmptyPrimaryKey() : bool

Return values

bool

isOnline()

Is user online


    public
                    isOnline() : bool

Return values

bool

loginBackend()

Backend callback method


    public
                    loginBackend() : string

Return values

string

markDeleted()

Mark entity as deleted


    public
                    markDeleted() : self

Return values

self

merge()

Merge siteuser with another one


    public
                    merge(Siteuser_Model $oObject) : self

Parameters

$oObject : Siteuser_Model: siteuser

Return values

self

queryBuilder()

Get query builder for select


    public
                    queryBuilder() : Core_QueryBuilder_Select

Return values

Core_QueryBuilder_Select

remove()

Remove related object. If main object does not save, it will save.


    public
                    remove(Core_ORM $model[, string $relation = NULL ]) : self

Parameters

$model : Core_ORM
$relation : string = NULL

Return values

self

removeAllowedTag()

Remove tag from allowed tags list


    public
                    removeAllowedTag(string $tag) : self

Parameters

$tag : string: tag

Return values

self

removeForbiddenTag()

Remove tag from forbidden tags list


    public
                    removeForbiddenTag(string $tag) : self

Parameters

$tag : string: tag

Return values

self

removeFriend()

Remove user from friend list


    public
                    removeFriend(Siteuser_Model $oSiteuser_Friend) : self

Parameters

$oSiteuser_Friend : Siteuser_Model: site user

Return values

self

save()

Save object. Use self::update() or self::create()


    public
                    save() : Maillist_Siteuser_Siteuser_Model

Return values

Maillist_Siteuser_Siteuser_Model

setCheck()

Set _check flag


    public
                    setCheck(bool $check) : self

Parameters

$check : bool: mode

Return values

self

setCurrent()

Set user as current


    public
                    setCurrent([int $expires = 2678400 ]) : self

Parameters

$expires : int = 2678400: cookie lifetime

Return values

self

setDatabaseDriver()

Set name of Database Driver


    public
            static        setDatabaseDriver(string $name) : mixed

Parameters

$name : string: driver's name

setMarksDeleted()

Set column name for marks deleted


    public
                    setMarksDeleted([mixed $marksDeleted = 'deleted' ]) : self

Parameters

$marksDeleted : mixed = 'deleted'

Return values

self

setRelations()

Set $this->_relations


    public
                    setRelations(array<string|int, mixed> $relations) : self

Parameters

$relations : array<string|int, mixed>: Array with new relations

Return values

self

setXmlTagName()

Set name of XML node


    public
                    setXmlTagName(string $tagName) : self

Parameters

$tagName : string: new tag name for node

Return values

self

showRepresentativesInLine()

Show representatives in line


    public
                    showRepresentativesInLine([int $imageSize = 20 ]) : mixed

Parameters

$imageSize : int = 20

showXmlCompanies()

Show siteuser companies in XML


    public
                    showXmlCompanies([bool $showXmlCompanies = TRUE ]) : self

Parameters

$showXmlCompanies : bool = TRUE

Return values

self

showXmlMaillists()

Show maillist in XML


    public
                    showXmlMaillists([bool $showXmlMaillists = TRUE ]) : self

Parameters

$showXmlMaillists : bool = TRUE

Return values

self

showXmlPeople()

Show siteuser people in XML


    public
                    showXmlPeople([bool $showXmlPeople = TRUE ]) : self

Parameters

$showXmlPeople : bool = TRUE

Return values

self

showXmlProperties()

Show properties in XML


    public
                    showXmlProperties([mixed $showXmlProperties = TRUE ][, mixed $xmlSortPropertiesValues = TRUE ]) : self

Parameters

$showXmlProperties : mixed = TRUE: array of allowed properties ID or boolean
$xmlSortPropertiesValues : mixed = TRUE

Return values

self

text()

Set TEXT type


    public
                    text() : self

Return values

self

toArray()

Convert Object to Array


    public
                    toArray() : array<string|int, mixed>

Return values

array<string|int, mixed>

undelete()

Turn off deleted status


    public
                    undelete() : self

Return values

self

unsetCurrent()

Unset current user from session


    public
                    unsetCurrent() : self

Return values

self

unsubscribe()

Unsubscribe siteuser


    public
                    unsubscribe() : self

Return values

self

update()

Update object data into database


    public
                    update() : self

Return values

self

updateLastActivity()

Update last activity


    public
                    updateLastActivity() : self

Return values

self

_getCopiedName()

Get the name of a new copied object


    protected
                    _getCopiedName() : mixed

_isTagAvailable()

Is $tagName Available


    protected
                    _isTagAvailable( $tagName) : bool

Parameters

$tagName :: Tag Name

Return values

bool

_prepareData()

Prepare entity and children entities


    protected
                    _prepareData() : self

Return values

self

_preparePropertyValue()

Prepare Property Value


    protected
                    _preparePropertyValue(Property_Value_Model $oProperty_Value) : mixed

Parameters

$oProperty_Value : Property_Value_Model

getDatabase()

Get Database


    protected
                    getDatabase() : Core_DataBase

Return values

Core_DataBase

Maillist_Siteuser_Siteuser_Model extends Siteuser_Model in package HostCMS Maillist

Tags

Table of Contents

Properties

Methods

Properties

$address

$cart

$city

$company

$config

$counterparty

$country

$favorite

$fax

$icq

$img_list_affiliates

$img_list_cashes

$img_list_people_companies

$name

$patronymic

$phone

$postcode

$representative

$subscribed

$surname

$timeline

$type

$website

$_allowedTags

$_attachSessionToIp

Tags

$_attributes

$_belongsTo

$_changeCopiedName

$_changedColumns

$_dataValues

$_forbiddenTags

$_hasMany

$_hasOne

$_hasRevisions

$_marksDeleted

$_modelColumns

$_modelName

$_nameColumn

$_oldFields

$_preloadValues

$_primaryKey

$_propertyValues

$_queryBuilder

$_shortcodeTags

$_showXmlCompanies

$_showXmlMaillists

$_showXmlPeople

$_showXmlProperties

$_skipColumns

$_sorting

$_tableColumns

$_tableName

$_typicalForbiddenTags

$_xmlSortPropertiesValues

Methods

__call()

Parameters

__construct()

Parameters

__isset()

Parameters

__set()

Parameters

Return values

activate()

Tags

Return values

add()

Parameters

Tags

Return values

addAllowedTag()

Parameters

Maillist_Siteuser_Siteuser_Model extends Siteuser_Model
in package

HostCMS

Maillist