uptime/uptime

Missing php uptime package inspired by python module uptime

Installs: 162

Dependents: 0

Stars: 6

Watchers: 2

Forks: 1

Open Issues: 2

Language: PHP

0.1.0 2014-08-11 22:56 UTC

README

Build Status Coverage Status Scrutinizer Code Quality Latest Stable Version Total Downloads License

The missing PHP uptime package inspired by python module uptime.

This package aims to provides a cross platform PHP API — OO and functional — that tells you how long your system has been up and when it booted. This turns out to be surprisingly non-straightforward across systems, but not impossible on any major platform.

Supported Platforms

Group Systems :ok: BSD FreeBSD, OpenBSD, NetBSD, BSD :ok: Linux Linux, Cygwin, Linux-armv71, Linux2, Unix, SunOS :ok: Darwin Darwin, Mac, OSX :ok: Windows Windows, Win32, Winnt :ok: OpenVMS OpenVMS :octocat: NetWare ?

Composer Installation

{
  "require": {
    "uptime/uptime": "~0.1"
  }
}

Through terminal: composer require uptime/uptime:~0.1 :8ball:

Quick Guide

Besides classes, this package registers two global functions: uptime and boottime.

$seconds   = uptime();   # <float||int> uptime in seconds
$timestamp = boottime(); # <string> server boottime timestamp

For more complex manipulations you can use the OO interface:

use Uptime\System;

$system = new System();           # <Uptime\System #>

$uptime = $system->getUptime();   # <Uptime\Uptime implements \DateInterval #> {}

$uptime->d                        # <int> days
$uptime->h                        # <int> hours
$uptime->m                        # <int> minutes
$uptime->s                        # <float||int> seconds

$boottime = $system->getBoottime(); # <Uptime\Boottime implements \DateTime #> {}
$boottime->format('Ymd H:i:s');    # <string> formatted date

echo 'Uptime: ' . $uptime . '. Boottime: ' . $boottime; # yes we have __toString

Uptime will guess your current OS by parsing PHP_OS constant value. In case you're using any exotic platform that is known to be compatible with one of the supported systems, you can bypass OS detection by informing your system identifier manually (case insensitive):

$seconds   = uptime('JunOS');   # <float||int> server uptime in seconds
$timestamp = boottime('JunOS'); # <string> server boottime timestamp

You can bypass automatic system detection using the Uptime\System class too:

use Uptime\System;

$system = new System('JunOS'); # <Uptime\System #>
$system = new System('Amiga'); # throws <Uptime\UnsupportedSystemException #> {}
                               # patches welcome ;)

Notes

  • Returned values will be as precise as your platform allows to, usually microseconds but it can be seconds;
  • Some platforms need a better way to get uptime and boottime;
  • For some platforms shell_exec function needs to be enabled;

Extending Platform Support

  1. Check PHP_OS constant value;
  2. Map your platform or system identifier on Uptime\System\SystemTable::$map;
  3. Create a new runtime under src/Runtime/<NewSystemGroup>/*, if necessary;
  4. Add new tests to test/Runtime/<NewSystemGroup>/*, if necessary;
  5. Pull request;

Features & Roadmap

  • Functional API
  • OO API
  • Add a facade
  • Write guide and manual
  • Better cross platform tests
  • Try to avoid child processes
  • Maybe C extension

Copyright

Copyright (c) 2014 Márcio Almada. Distributed under the terms of an MIT-style license. See LICENSE for details.