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

  • TableLoad
  • Tables
  • Overview
  • Namespace
  • Class
  • Tree

Class TableLoad

Xmf\Database\TableLoad

load a database table

Namespace: Xmf\Database
Package: Xmf
Category: Xmf\Database\TableLoad
Copyright: 2013 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Richard Griffith richard@geekwright.com
Version: Release: 1.0
Link: http://xoops.org
Located at oops_lib/Xmf/Database/TableLoad.php
Methods summary
public static integer
# loadTableFromArray( string $table, array $data )

loadTableFromArray

loadTableFromArray

Parameters

$table
name of table to load without prefix
$data

array of rows to insert Each element of the outer array represents a single table row. Each row is an associative array in 'column' => 'value' format.

Returns

integer
number of rows inserted
public static integer
# loadTableFromYamlFile( string $table, string $yamlFile )

loadTableFromYamlFile

loadTableFromYamlFile

Parameters

$table
name of table to load without prefix
$yamlFile
name of file containing data dump in YAML format

Returns

integer
number of rows inserted
public static integer
# truncateTable( string $table )

truncateTable - empty a database table

truncateTable - empty a database table

Parameters

$table
name of table to truncate

Returns

integer
number of affected rows
public static integer
# rowCount( string $table, CriteriaElement $criteria = null )

rowCount - get count of rows in a table

rowCount - get count of rows in a table

Parameters

$table
name of table to count
$criteria
optional criteria

Returns

integer
number of rows
API documentation generated by ApiGen