Gong PHP SDK

Classe per l'integrazione semplificata tra qualsiasi applicativo PHP 5+ e GONG

Per iniziare

Necessita solamente l'inclusione della classe e inzializzarla passando l'apikey generata dal sistema

Prerequisiti

Basta solo includere la classe

require "gong.php";

Installazione e primo utilizzo

require "gong.php";

$Gong 	= new Gong( '[your-api-key]' );

if($Gong->isReady()){
	
	var_dump($Gong->getAvalableCrawler()); 

	// Posso quindi inviare i pacchetti al server

}else{

	die('Error connecting to gong, check host and port');

}

Metodi

Elenco dei metodi esposti dalla classe

isReady()

Metodo per verificare che la classe sia pronta a ricevere pacchetti da inviare.

if($Gong->isReady()){
	// Ok
}else{
	// Non OK
}

getAvalableCrawler()

Metodo che ritorna la lista dei Crawler accettati dall'apikey passata.

var_dump($Gong->getAvalableCrawler()); 

pushData( $crawler , $logName , $packet )

Metodo per accodare un pacchetto alla coda dei dati da inviare a GONG. Il crawler deve essere uno di quelli associati all'apikey altrimenti il $packet verrà scartato. I dati $packet saranno aggregati a seconda della chiave $crawler-$logName

$packetToSend = array(
	'ip' => '192.168.1.1',
	'code' => 200,
	'path' => '/',
	'agent' => 'Mozilla 1.0'
);

$Gong->pushData( 'apache-2' , 'miodominio.it' , $packetToSend );

Ritorna true se il pacchetto è stato correttamente inserito nei dataset da inviare. Altrimenti false

send()

Metodo che invia i dati a GONG precedentemente raccolti tramite pushData(...). Ritorna false se fallisce altrimenti un report dei dati inviati

$packetToSend = array(
	'ip' => '192.168.1.1',
	'code' => 200,
	'path' => '/',
	'agent' => 'Mozilla 1.0'
);

$Gong->pushData( 'apache-2' , 'miodominio.it' 	, $packetToSend );
$Gong->pushData( 'apache-2' , 'miodominio.it' 	, $packetToSend );
$Gong->pushData( 'apache-2' , 'miodominio.it' 	, $packetToSend );
$Gong->pushData( 'apache-2' , 'miodominio.com' 	, $packetToSend );

$r = $Gong->send(); // Invio i dati

// $r contiene:

/*

array(2) {
  [0]=>
  array(3) {
    ["craler"]=> string(8) "apache-2"
    ["logName"]=> string(8) "miodominio-it"
    ["rows"]=> int(3) 
  }
  [1]=>
  array(3) {
    ["craler"]=> string(8) "apache-2"
    ["logName"]=> string(7) "miodominio-com"
    ["rows"]=> int(1) 
  }
}

 */

Dipendenze

Solo CURL

Contribuzione

Si prega di leggere CONTRIBUTING.md per i dettagli sul nostro codice di condotta, e il processo per la presentazione di richieste di pull a noi.

Versionamento

Noi usiamo SemVer per il versionamento.

Autori

• Pasqui Andrea - Initial work

Licenze

Questo progetto è concesso in licenza con la licenza MIT - guarda la LICENSE.md per maggiorni dettagli