Documentation

Catalogs extends Webservice
in package

PHP library to access FDSN Webservices and request Catalogs

Table of Contents

Constants

basePath  = 'https://%s/fdsnws/event/1'
defaultFdsnServer  = 'webservices.ms.ingv.it'
fdsnSupportedVersion  = '^1.6'

Properties

$arrayOfResults  : array<string|int, mixed>
$fdsn_server  : string
$version  : string
$webserviceFullPath  : string
$DOMResults  : DOMDocument
$xmlResults  : string

Methods

__construct()  : mixed
DOMCatalogs()  : DOMDocument
Get Catalogs parsed in a DOM Document
fetch()  : int
Fetch catalogs (xml document) from selected FDSN server
getIterator()  : array<string|int, mixed>
Iterate over catalogis found
numRows()  : int
Return the number of elems found
rawXMLCatalogs()  : string
Get RAW Catalogs XML String
version()  : string
Get FDSN running version
getFetch()  : string
Fetch data from selected FDSN server
fdsnSupportedVersion()  : bool
Check if FDSN server version is supported
parse()  : int
Parse XML Catalogs and store it into a DOM Document AND all values found into an Iterable array

Constants

basePath

public Base basePath = 'https://%s/fdsnws/event/1'

URL to compile with FDSN server url

defaultFdsnServer

public Default defaultFdsnServer = 'webservices.ms.ingv.it'

server url

fdsnSupportedVersion

public Max fdsnSupportedVersion = '^1.6'

supported version

Properties

$arrayOfResults

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

$webserviceFullPath

protected string $webserviceFullPath

$DOMResults

private DOMDocument $DOMResults

Methods

__construct()

public __construct([string $fdsn_server = self::defaultFdsnServer ]) : mixed
Parameters
$fdsn_server : string = self::defaultFdsnServer

DOMCatalogs()

Get Catalogs parsed in a DOM Document

public DOMCatalogs() : DOMDocument
Return values
DOMDocument —

Get Catalogs parsed in a DOMDocument

fetch()

Fetch catalogs (xml document) from selected FDSN server

public fetch() : int
Return values
int —

number of catalogs found

getIterator()

Iterate over catalogis found

public getIterator() : array<string|int, mixed>
Return values
array<string|int, mixed> —

array of \Fdsn\DataStructure\Catalog obj

numRows()

Return the number of elems found

public numRows() : int
Return values
int —

The number of elems found

rawXMLCatalogs()

Get RAW Catalogs XML String

public rawXMLCatalogs() : string
Return values
string —

Get RAW Catalogs XML String

version()

Get FDSN running version

public version() : string
Return values
string —

FDSN running version (trimmed by newline)

getFetch()

Fetch data from selected FDSN server

protected getFetch(string $url) : string
Parameters
$url : string
Return values
string —

downloaded string

fdsnSupportedVersion()

Check if FDSN server version is supported

private fdsnSupportedVersion() : bool
Return values
bool

parse()

Parse XML Catalogs and store it into a DOM Document AND all values found into an Iterable array

private parse(string $xmlResponse) : int
Parameters
$xmlResponse : string

xml document got by API request

Return values
int —

number of catalogs found


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results