API - XOOPS 2.5.11 Beta 2
By monxoops.fr
XoopsModelSync Class Reference
Inheritance diagram for XoopsModelSync:
Collaboration diagram for XoopsModelSync:

Public Member Functions

 cleanOrphan ($table_link='', $field_link='', $field_object='')
 
 synchronization ()
 
- Public Member Functions inherited from XoopsModelAbstract
 __construct ($args=null, $handler=null)
 
 setHandler ($handler)
 
 setVars ($args)
 

Additional Inherited Members

- Data Fields inherited from XoopsModelAbstract
 $handler
 

Detailed Description

Object synchronization handler class.

Author
Taiwen Jiang phppp.nosp@m.@use.nosp@m.rs.so.nosp@m.urce.nosp@m.forge.nosp@m..net

XoopsModelAbstract Usage of methods provided by XoopsModelSync:

Step #1: set linked table and adjoint fields through XoopsPersistableObjectHandler: $handler->table_link = $handler->db->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

Member Function Documentation

◆ cleanOrphan()

cleanOrphan (   $table_link = '',
  $field_link = '',
  $field_object = '' 
)

Clean orphan objects against linked objects

Parameters
string$table_linktable of linked object for JOIN; deprecated, for backward compatibility
string$field_linkfield of linked object for JOIN; deprecated, for backward compatibility
string$field_objectfield of current object for JOIN; deprecated, for backward compatibility
Returns
bool true on success

for MySQL 4.1+

Here is the caller graph for this function:

◆ synchronization()

synchronization ( )

Synchronizing objects

Deprecated:
Returns
bool true on success
Here is the call graph for this function:

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