2017 © Pedro Peláez
 

project minimin

A modular php interface for server management.

image

pxgamer/minimin

A modular php interface for server management.

  • Thursday, December 7, 2017
  • by PXgamer
  • Repository
  • 0 Watchers
  • 0 Stars
  • 5 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 1 Open issues
  • 8 Versions
  • 0 % Grown

The README.md

minimin

Latest Version on Packagist ![Software License][ico-license] Build Status Style CI ![Code Coverage][ico-code-quality] Total Downloads, (*1)

A modular php interface for server management., (*2)

Structure

public/
src/
tests/
vendor/

Install

Via Composer, (*3)

``` bash $ composer create-project pxgamer/minimin, (*4)


## Usage

### Basic Plugin format

Classes accessible to plugins:
- Smarter (this will need to have a custom template directory added using `addTemplateDir()`)
- System\* (`nezamy/route` classes)
- Any classes that they import/require

Packages should follow the folder structure below:
```text
/
    src/
        /Templates
            /{PluginName}
        App.php
        Plugin.php
    composer.json

For reference, view the minimin-package-example plugin on Github., (*5)

App.php, (*6)

<?php

namespace {vendor}\{plugin};

use pxgamer\Minimin\Smarter;

class App
{
    // When initialised by the Minimin class, it will pass the $route to the plugin App constructor
    public function __construct($route)
    {
        // ... Run plugin commands
        $Smarter = Smarter::get();
        $Smarter->addTemplateDir(__DIR__ . '/Templates/');
    }
}

Plugin.php, (*7)

<?php

namespace {vendor}\{plugin};

class Plugin
{
    public static function info()
    {
        /** This function MUST return the following values:
         *  - app_namespace
         *  - name
         *  - link
         *  - description
         */

        $object = (object)[
            'app_namespace' => '\\{vendor}\\{plugin}', // The namespace of the plugin
            'name' => 'Cron Tasks', // The name of the plugin, may contain spaces
            'link' => 'cron-tasks', // The link that will be used (e.g. `cron-tasks` will be `/cron-tasks`)
            'description' => 'A cron task manager for servers.' // The description of the plugin
        ];

        return $object;
    }
}

Example data/plugins.json format

[
  {
    "app_namespace": "\\pxgamer\\CronTasks",
    "name": "Cron Tasks",
    "link": "cron-tasks",
    "description": "A cron task manager for servers."
  }
]

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details., (*8)

Security

If you discover any security related issues, please email owzie123@gmail.com instead of using the issue tracker., (*9)

Credits

License

The MIT License (MIT). Please see License File for more information., (*10)

The Versions

07/12 2017

dev-feature/laravel-conversion

dev-feature/laravel-conversion

A modular php interface for server management.

  Sources   Download

MIT

The Requires

 

The Development Requires

07/12 2017

dev-develop

dev-develop

A modular php interface for server management.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar PXgamer

07/12 2017

dev-master

9999999-dev

A modular php interface for server management.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar PXgamer

07/12 2017

v1.0.4

1.0.4.0

A modular php interface for server management.

  Sources   Download

MIT

The Requires

 

The Development Requires

07/12 2017

v1.0.3

1.0.3.0

A modular php interface for server management.

  Sources   Download

MIT

The Requires

 

The Development Requires

02/11 2017

v1.0.2

1.0.2.0

A modular php interface for server management.

  Sources   Download

MIT

The Requires

 

by Avatar PXgamer

02/11 2017

v1.0.1

1.0.1.0

A modular php interface for server management.

  Sources   Download

MIT

The Requires

 

by Avatar PXgamer

23/03 2017

v1.0.0

1.0.0.0

A modular php interface for server management.

  Sources   Download

MIT

The Requires

 

by Avatar PXgamer