koyabu/webapi

Koyabu API Framework

dev-main 2025-04-01 11:52 UTC

Requires

• php: 8.1.*
• ext-curl: *
• ext-json: *
• bacon/bacon-qr-code: ^3.0
• chillerlan/php-qrcode: v5.0.x-dev
• dompdf/dompdf: ^3.0
• google/apiclient: 2.17.0
• intervention/image: *
• midtrans/midtrans-php: ^2.5
• phpmailer/phpmailer: ^6.9
• phpoffice/phpspreadsheet: ^2.1
• pragmarx/google2fa: 9.x-dev

MIT

• stievenk
• richard

README

Installation

composer require koyabu/webapi

composer.json

If your get error about minimum-stability, edit your composer.json

{
    "minimum-stability": "dev",
    "prefer-stable": false
}

config.php

For configuration example you can see file: vendor/koyabu/webapi/config.sample.php

namespace Koyabu\Webapi;
require_once 'vendor/autoload.php';

$config['APPS_NAME'] = 'KOYABU PHP FRAMEWORK';
$config['HOME_DIR'] = __DIR__ . DIRECTORY_SEPARATOR;

$config['mysql'] = array(
    'host' => 'localhost',
    'user' => 'root',
    'pass' => '',
    'data' => 'test'
);
$API = new Koyabu($config);
?>

Dropbox Save, don't forget to setup your Dropbox secret key & token at $config['dropbox'], see example config.sample.php

$API = new Koyabu($config);
$filename = 'test.txt';
var_dump($API->save_dbx($filename));

MySQL/MariaDB Query

// INSERT
$params = array(
    'id' => $id,
    'name' => $name
);
$primary_index = 'id';
$API->save($params,$table_name,'INSERT',$primary_index);
$API->save($params,$table_name,'REPLACE',$primary_index);
$API->save($params,$table_name,'UPDATE',$primary_index);

Params = coloumn name => value name your array index with database table coloumn name. $primary_index default = id,

// DELETE
$params = array(
    'db_colname' => $value
)
$API->delete($params,$table_name);

Use $params index name same as table coloumn name and query will delete data where db_colname = $value

// Get Single Record
$value_id = 2;
$table_name = 'member';
$colname = 'id';

$result = $API->get($value_id,$table_name,$colname);
var_dump($result);

// Get single record with multiple filter
$value_id = 2;
$table_name = 'member';
$colname = array('gender' => 'male', 'category' => 'student', 'city' => 'Manado');

$result = $API->get($value_id,$table_name,$colname);
var_dump($result);

// Select with query
$qry = $API->select("select * from test");
while($result = $API->fetch()) {
    print_r($result);
}

$qry = $API->select("select * from test");
while($result = $API->fetch('row')) {
    print_r($result);
}

Check Table Exists

$return = $API->table_exists('table_name'); // return true if exists, false if not exists