MagicObject is a powerful library for developing applications in PHP with ease. It enables the dynamic creation of classes for various intended uses. Below are some of its key features:
- Dynamic Object Creation: Easily create objects at runtime.
- Setters and Getters: Simplify property management with automatic methods.
- Multi-Level Objects: Support for nested objects.
- Entity Access: Streamline interactions with entities.
- Filtering and Pagination: Built-in methods for managing data display.
- Native Query: Defining native queries for a function will increase flexibility and resource efficiency in accessing the database.
- Multiple Database Connection: MagicObject supports the configuration of multiple database connections, allowing applications to interact with different databases simultaneously.
- Database Dumping: Export database contents efficiently.
- Serialization/Deserialization: Handle JSON and YAML formats seamlessly.
- Data Importing: Import data even if source and destination schemas differ.
- File Reading: Read INI, YAML, and JSON configuration files.
- Environment Variable Access: Easily fetch environment variable values.
- Configuration Encryption: Secure application settings.
- HTTP Data Handling: Create objects from global request variables (POST, GET, etc.).
- Session Management: Integrate with PHP sessions.
- Object Labeling: Enhance object identification.
- Multi-Language Support: Facilitate localization.
- File Uploads: Handle file uploads efficiently.
- Annotations: Add metadata to objects for better structure.
- Debugging: Tools to debug and inspect objects.
This library provides a versatile toolkit for building robust PHP applications!
To install MagicObject, run:
composer require planetbiru/magic-object
If Composer is not installed, use:
php composer.phar require planetbiru/magic-object
To remove MagicObject:
composer remove planetbiru/magic-object
Or if Composer is not installed:
php composer.phar remove planetbiru/magic-object
o install Composer on your system or download the latest composer.phar, visit https://getcomposer.org/download/
To see available versions of MagicObject, visit https://packagist.org/packages/planetbiru/magic-object
MagicObject is designed for ease of use and can even be used with a code generator. An example of a code generator that successfully creates MagicObject code using only parameters is MagicAppBuilder. MagicObject offers many flexible ways to write code, allowing users to choose the approach that best suits their needs.
In addition to prioritizing ease of use, MagicObject is also optimized for efficiency in terms of both time and resource usage, enabling applications to run smoothly even on servers with minimal specifications. This reduces costs in both development and operational phases.
For large applications, MagicObject supports database and storage scaling. You can distribute user access across multiple servers and use Redis for session storage. MagicObject integrates with Redis for cloud-based session storage, which can be secured using a password.
Yaml File
result_per_page: 20
song_base_url: ${SONG_BASE_URL}
app_name: Music Production Manager
user_image:
width: 512
height: 512
album_image:
width: 512
height: 512
song_image:
width: 512
height: 512
database:
time_zone_system: Asia/Jakarta
default_charset: utf8
driver: ${APP_DATABASE_TYPE}
host: ${APP_DATABASE_SERVER}
port: ${APP_DATABASE_PORT}
username: ${APP_DATABASE_USER}
password: ${APP_DATABASE_PASSWORD}
database_name: ${APP_DATABASE_NAME}
database_schema: public
time_zone: ${APP_DATABASE_TIME_ZONE}
salt: ${APP_DATABASE_SALT}Configuration Object
Create class ConfigApp by extends MagicObject
<?php
namespace MusicProductionManager\Config;
use MagicObject\MagicObject;
class ConfigApp extends MagicObject
{
/**
* Constructor
*
* @param mixed $data Initial data
* @param bool $readonly Readonly flag
*/
public function __construct($data = null, $readonly = false)
{
if($data != null)
{
parent::__construct($data);
}
$this->readOnly($readonly);
}
}<?php
$cfg = new ConfigApp(null, true);
$cfg->loadYamlFile(dirname(__DIR__)."/.cfg/app.yml", true, true, true);
// to get database object,
$cfg->getDatabase()
//
// to get database.host
$cfg->getDatabase()->getHost()
// to get database.database_name
$cfg->getDatabase()->getDatabaseName()<?php
namespace MusicProductionManager\Data\Entity;
use MagicObject\MagicObject;
/**
* @Entity
* @JSON(property-naming-strategy=SNAKE_CASE, prettify=true)
* @Table(name="album")
* @Cache(enable="true")
* @package MusicProductionManager\Data\Entity
*/
class Album extends MagicObject
{
/**
* Album ID
*
* @Id
* @GeneratedValue(strategy=GenerationType.UUID)
* @NotNull
* @Column(name="album_id", type="varchar(50)", length=50, nullable=false)
* @Label(content="Album ID")
* @var string
*/
protected $albumId;
/**
* Name
*
* @Column(name="name", type="varchar(50)", length=50, nullable=true)
* @Label(content="Name")
* @var string
*/
protected $name;
/**
* Title
*
* @Column(name="title", type="text", nullable=true)
* @Label(content="Title")
* @var string
*/
protected $title;
/**
* Description
*
* @Column(name="description", type="longtext", nullable=true)
* @Label(content="Description")
* @var string
*/
protected $description;
/**
* Producer ID
*
* @Column(name="producer_id", type="varchar(40)", length=40, nullable=true)
* @Label(content="Producer ID")
* @var string
*/
protected $producerId;
/**
* Release Date
*
* @Column(name="release_date", type="date", nullable=true)
* @Label(content="Release Date")
* @var string
*/
protected $releaseDate;
/**
* Number Of Song
*
* @Column(name="number_of_song", type="int(11)", length=11, nullable=true)
* @Label(content="Number Of Song")
* @var integer
*/
protected $numberOfSong;
/**
* Duration
*
* @Column(name="duration", type="float", nullable=true)
* @Label(content="Duration")
* @var double
*/
protected $duration;
/**
* Image Path
*
* @Column(name="image_path", type="text", nullable=true)
* @Label(content="Image Path")
* @var string
*/
protected $imagePath;
/**
* Sort Order
*
* @Column(name="sort_order", type="int(11)", length=11, nullable=true)
* @Label(content="Sort Order")
* @var integer
*/
protected $sortOrder;
/**
* Time Create
*
* @Column(name="time_create", type="timestamp", length=19, nullable=true, updatable=false)
* @Label(content="Time Create")
* @var string
*/
protected $timeCreate;
/**
* Time Edit
*
* @Column(name="time_edit", type="timestamp", length=19, nullable=true)
* @Label(content="Time Edit")
* @var string
*/
protected $timeEdit;
/**
* Admin Create
*
* @Column(name="admin_create", type="varchar(40)", length=40, nullable=true, updatable=false)
* @Label(content="Admin Create")
* @var string
*/
protected $adminCreate;
/**
* Admin Edit
*
* @Column(name="admin_edit", type="varchar(40)", length=40, nullable=true)
* @Label(content="Admin Edit")
* @var string
*/
protected $adminEdit;
/**
* IP Create
*
* @Column(name="ip_create", type="varchar(50)", length=50, nullable=true, updatable=false)
* @Label(content="IP Create")
* @var string
*/
protected $ipCreate;
/**
* IP Edit
*
* @Column(name="ip_edit", type="varchar(50)", length=50, nullable=true)
* @Label(content="IP Edit")
* @var string
*/
protected $ipEdit;
/**
* Active
*
* @Column(name="active", type="tinyint(1)", length=1, default_value="1", nullable=true)
* @DefaultColumn(value="1")
* @var boolean
*/
protected $active;
/**
* As Draft
*
* @Column(name="as_draft", type="tinyint(1)", length=1, default_value="1", nullable=true)
* @DefaultColumn(value="1")
* @var boolean
*/
protected $asDraft;
}Usage
<?php
use MagicObject\Database\PicoDatabase;
use MagicObject\Database\PicoDatabaseCredentials;
use MusicProductionManager\Config\ConfigApp;
use MusicProductionManager\Data\Entity\Album;
require_once dirname(__DIR__)."/vendor/autoload.php";
$cfg = new ConfigApp(null, true);
$cfg->loadYamlFile(dirname(__DIR__)."/.cfg/app.yml", true, true, true);
$databaseCredentials = new PicoDatabaseCredentials($cfg->getDatabase());
$database = new PicoDatabase($databaseCredentials);
try {
$database->connect();
// Create a new Album instance
$album1 = new Album(null, $database);
$album1->setAlbumId("123456");
$album1->setName("Album 1");
$album1->setAdminCreate("USER1");
$album1->setDuration(300);
// Another way to create an object
// Create an object from stdClass or another object with matching properties (snake_case or camelCase)
$data = new stdClass;
// Snake case
$data->album_id = "123456";
$data->name = "Album 1";
$data->admin_create = "USER1";
$data->duration = 300;
// Or camel case
$data->albumId = "123456";
$data->name = "Album 1";
$data->adminCreate = "USER1";
$data->duration = 300;
$album1 = new Album($data, $database);
// Another way to create an object
// Create an object from an associative array with matching properties (snake_case or camelCase)
$data = array();
// Snake case
$data["album_id"] = "123456";
$data["name"] = "Album 1";
$data["admin_create"] = "USER1";
$data["duration"] = 300;
// Or camel case
$data["albumId"] = "123456";
$data["name"] = "Album 1";
$data["adminCreate"] = "USER1";
$data["duration"] = 300;
$album1 = new Album($data, $database);
// Get value from the form
// This method is not safe
$album1 = new Album($_POST, $database);
// We can use another method
$inputPost = new InputPost();
// We can apply filters
$inputPost->filterName(PicoFilterConstant::FILTER_SANITIZE_SPECIAL_CHARS);
$inputPost->filterDescription(PicoFilterConstant::FILTER_SANITIZE_SPECIAL_CHARS);
// If a property is not present in $inputPost, we can set a default value
// Note that the user can modify the form and add/update unwanted properties
$inputPost->checkboxActive(false);
$inputPost->checkboxAsDraft(true);
// We can remove any property data from the $inputPost object before applying it to the entity
// This property will not be saved to the database
$inputPost->setSortOrder(null);
$album1 = new Album($inputPost, $database);
// Insert into the database
$album1->insert();
// Insert or update the record
$album1->save();
// Update the record
// A NoRecordFoundException will be thrown if the ID is not found
$album1->update();
// Convert the object to JSON
$json = $album1->toString();
// Alternatively:
$json = $album1 . "";
// Send to the output buffer
// It is automatically converted to a string
echo $album1;
// Find one record by ID
$album2 = new Album(null, $database);
$album2->findOneByAlbumId("123456");
// Find multiple records
$album2 = new Album(null, $database);
$albums = $album2->findByAdminCreate("USER1");
$rows = $albums->getResult();
foreach ($rows as $albumSaved) {
// $albumSaved is an instance of Album
// We can update the data
$albumSaved->setAdminEdit("USER1");
$albumSaved->setTimeEdit(date('Y-m-d H:i:s'));
// This value will not be saved to the database because it does not have a corresponding column
$albumSaved->setAnyValue("ANY VALUE");
$albumSaved->update();
}
} catch (Exception $e) {
// Handle the exception (currently doing nothing)
}A tutorial is available here: https://github.com/Planetbiru/MagicObject/blob/main/tutorial.md
- Music Production Manager https://github.com/kamshory/MusicProductionManager
- AppBuilder https://github.com/Planetbiru/AppBuilder
- Koperasi-Simpan-Pinjam-Syariah https://github.com/kamshory/Koperasi-Simpan-Pinjam-Syariah
- Toserba Online https://toserba-online.top/
- Kamshory - https://github.com/kamshory/
- Kamshory - https://github.com/kamshory/