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

  • Joint
  • Read
  • Stats
  • Sync
  • Write
  • Overview
  • Namespace
  • Class
  • Tree

Class Sync

Object synchronization handler class.

Usage of methods provided by XoopsModelSync:

Step #1: set linked table and joint fields through XoopsPersistableObjectHandler: $handler->table_link = $handler->db2->prefix("the_linked_table"); full name of the linked table that is used for the query $handler->field_link = "the_linked_field"; name of field in linked table that will be used to link the linked table with current table $handler->field_object = "the_object_field"; name of field in current table that will be used to link the linked table with current table; linked field name will be used if the field name is not set Step #2: perform query

Xoops\Core\Kernel\XoopsModelAbstract
Extended by Xoops\Core\Kernel\Model\Sync
Namespace: Xoops\Core\Kernel\Model
Package: Xoops\Core\Kernel
Category: Xoops\Core\Kernel\Model\Sync
Copyright: 2000-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Taiwen Jiang phppp@users.sourceforge.net
Since: 2.3.0
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Kernel/Model/Sync.php
Methods summary
public boolean
# cleanOrphan( string $table_link = '', string $field_link = '', string $field_object = '' )

Clean orphan objects in this handler (child table) that are not in parent table

Clean orphan objects in this handler (child table) that are not in parent table

The parameters can be defined in the handler. Naming should be updated to reflect standard relational terminology.

Parameters

$table_link
parent table
$field_link
primary key (parent table)
$field_object
foreign key (child table)

Returns

boolean
true on success
Methods inherited from Xoops\Core\Kernel\XoopsModelAbstract
setHandler(), setVars()
Properties inherited from Xoops\Core\Kernel\XoopsModelAbstract
$handler
API documentation generated by ApiGen