Overview

Packages

  • LegiScan
    • API
    • Cache
    • Common
    • Exceptions
    • Utility
  • PHP

Classes

  • LegiScan_Bulk
  • LegiScan_Process
  • LegiScan_Pull
  • LegiScan_Push
  • Overview
  • Package
  • Class

Class LegiScan_Bulk

LegiScan API Bulk Dataset Class

Worker class that processes a LegiScan dataset archive and imports / updates the local database, passing the individual JSON payloads to their corresponding handlers in LegiScan_Process. Used by LegiScan_Import in the legiscan-bulk.php utility.

Package: LegiScan\API
Copyright: 2010-2020 LegiScan LLC
License: https://opensource.org/licenses/BSD-2-Clause
Author: LegiScan API Team api@legiscan.com
See: LegiScan_Import
See: LegiScan_Process
Link: https://api.legiscan.com/dl/
Link: https://legiscan.com/datasets
Located at LegiScan.php
Methods summary
public
# __construct( )

Class constructor, initilizes necessary LegiScan_Process instances

Class constructor, initilizes necessary LegiScan_Process instances

public mixed[]
# importDataset( string $zipfile, mixed[] $params )

Process LegiScan session dataset ZIP archive and import into database LegiScan_Import

Process LegiScan session dataset ZIP archive and import into database LegiScan_Import

Parameters

$zipfile
Path to a zip archive from LegiScan datasets or subscriber snapshot
$params
Additional parameters to control behavior and output

Returns

mixed[]
Array with hash and counts for the number of objects imported
Properties summary
protected LegiScan_Process $logic

Instance of LegiScan_Process

Instance of LegiScan_Process

#
LegiScan API Client API documentation generated by ApiGen