jaredchu/jc-firebase-php

Firebase PHP RESTful library

v1.2.1 2020-02-16 04:47 UTC

Requires

• php: >=5.5
• firebase/php-jwt: ^4.0
• jaredchu/jc-request: ^1.0
• netresearch/jsonmapper: ^1.1

Requires (Dev)

• phpunit/phpunit: ^4.0 || ^5.0

MIT

• Jared Chu

• restful
• firebase

README

PHP library access Firebase RESTful API

Installation

$ composer require jaredchu/jc-firebase-php

Usage

Generate a private key in JSON format.

Check Firebase credential

use JC\Firebase\JCFirebase;

$firebaseURI = "https://<DATABASE_NAME>.firebaseio.com";
$jsonKeyFile = "path/to/serviceAccountKey.json";

$firebase = new JCFirebase::fromKeyFile( $firebaseURI, $jsonKeyFile );
if( $firebase->isValid() ){
    //do something
}

GET - Reading Data

$response = $firebase->get('user');
echo $response->success;
echo $response->body;

PUT - Writing Data

$response = $firebase->put('user', array('data' => array('first_name'=>'Jared','last_name'=>'Chu')));
echo $response->status_code;
echo $response->body;

POST - Pushing Data

$response = $firebase->post('log', array('data' => array('code'=>401,'message'=>'Not Authorized')));
echo $response->status_code;
echo $response->body;

PATCH - Updating Data

$response = $firebase->patch('user', array('data' => array('first_name'=>'Jared',
                             'last_name'=>'Leto','age'=>27)));
echo $response->status_code;
echo $response->body;

DELETE - Removing Data

$response = $firebase->delete('user/first_name');
echo $response->status_code;
echo $response->body;

Modeling

Create Firebase connector

use JC\Firebase\JCFirebase;

$firebaseURI = "https://<DATABASE_NAME>.firebaseio.com";
$jsonKeyFile = "path/to/serviceAccountKey.json";

$firebase = new JCFirebase::fromKeyFile( $firebaseURI, $jsonKeyFile );

Extend your Model with FirebaseModel

class Log extends FirebaseModel {
	/**
	 * @var integer
	 */
	public $code;
	/**
	 * @var string
	 */
	public $message;
}

Get record

$log = Log::findByKey( $key, $firebase );
echo $log->key;
echo $log->code;
echo $log->message;

$logs = Log::findAll( $firebase );
foreach ($logs as $log){
    echo $log->key;
    echo $log->code;
    echo $log->message;
}

Create record

$log          = new Log( $firebase );
$log->code    = 200;
$log->message = 'Success';
$log->save();

Update record

$log = Log::findByKey( $key, $firebase );
$log->code    = 400;
$log->message = 'Bad Request';
$log->save();

Delete record

$log = Log::findByKey( $key, $firebase );
$log->delete();

Contributing

1. Fork it!
2. Create your feature branch: $ git checkout -b feature/your-new-feature
3. Commit your changes: $ git commit -am 'Add some feature'
4. Push to the branch: $ git push origin feature/your-new-feature
5. Submit a pull request.

License

MIT License

Support on Beerpay

Hey dude! Help me out for a couple of 🍻!