laswitchtech/php-updater

Updater Library for PHP Applications. Using GitHub Repository as the source.

v1.0.0 2023-07-19 15:27 UTC

Requires

• laswitchtech/php-configurator: ^1.0
• laswitchtech/php-logger: ^1.2

MIT

• Louis Ouellet

README

phpUpdater

Description

phpUpdater is a Library for PHP Applications. Using GitHub Repository as the source, it allows you to use releases as updates for your application.

Features

• Support for private repositories
• Easy to use
• Provides Backup and restore functionnalities
• Simple upgrade method
• Integration with phpDB

Why you might need it?

Can I use this?

Sure!

License

This software is distributed under the MIT license. Please read LICENSE for information on the software availability and distribution.

Requirements

• PHP >= 5.5.0
• GitHub Repository
• GitHub Access Token

To Do

• Add support for public repositories

Security

Please disclose any vulnerabilities found responsibly – report security issues to the maintainers privately.

Installation

Using Composer:

composer require laswitchtech/php-database

How do I use it?

Here is a full example:

<?php

// Import phpUpdater class into the global namespace
// These must be at the top of your script, not inside a function
use LaswitchTech\phpUpdater\phpUpdater;

// Load Composer's autoloader
require 'vendor/autoload.php';

// Configure phpUpdater, you can also use a config file
$phpUpdater->config("owner","GITHUB_USERNAME")->config("repository","GITHUB_REPOSITORY")->config("token","GITHUB_ACCESS_TOKEN");

// Initialize Updater
$phpUpdater = new phpUpdater();

// Backup
$phpUpdater->backup();

// Restore
$phpUpdater->restore();

// Upgrade
$phpUpdater->upgrade();