README

PHP Memory Info is a small PHP library for reading the current memory status on Linux systems.

It reads /proc/meminfo, normalizes the kernel field names, and returns a typed MemoryInfo object. Values are integers in bytes when the Linux kernel exposes the field; optional fields are null when absent.

Requirements

• Linux with a readable /proc/meminfo
• PHP 8.2 or newer
• Composer

Installation

composer require dev-hvmnd/memory-info

Quick Start

<?php

use DevHvmnd\MemoryInfo\MemoryDataReader;
use DevHvmnd\MemoryInfo\MemoryInfoReadException;

$reader = new MemoryDataReader();

try {
    $memoryInfo = $reader->getMemoryInfo();

    echo $memoryInfo->memTotal;
    echo $memoryInfo->memAvailable;
} catch (MemoryInfoReadException $exception) {
    // Handle missing /proc/meminfo, unreadable data, or unsupported field sets.
}

MemoryInfo exposes public readonly properties for the supported /proc/meminfo fields, for example memTotal, memAvailable, swapTotal, and committedAS.

If you already have /proc/meminfo contents, parse them directly:

$memoryInfo = (new MemoryInfoParser())->parse($contents);

Properties

The descriptions below are short summaries of the Linux /proc/meminfo fields. Kernel details can vary between Linux versions. Optional properties are null when the current kernel does not expose the matching field.

Behavior

• Values from /proc/meminfo are converted from kB to bytes.
• Additional kernel fields are accepted by the parser but ignored by MemoryInfo.
• Missing required fields raise MemoryInfoReadException.
• Missing optional fields are exposed as null.
• Invalid non-empty lines or values without numbers raise InvalidArgumentException from the parser.
• For tests or fixtures, pass a custom file path as the second MemoryDataReader constructor argument.

Development

Install dependencies:

composer install

Run the full check suite:

composer check

Run checks individually:

composer test
composer cs
composer analyse
composer rector

Apply Rector changes explicitly:

composer rector:fix

Continuous integration runs composer validate --strict and composer check on PHP 8.2, 8.3, 8.4, and 8.5.

If PHP is not installed locally, use the official PHP Docker image:

docker run --rm -v "$PWD":/app -w /app php:8.2-cli sh -lc '
  export DEBIAN_FRONTEND=noninteractive &&
  apt-get update &&
  apt-get install -y unzip &&
  php -r "copy(\"https://getcomposer.org/installer\", \"/tmp/composer-setup.php\");" &&
  php /tmp/composer-setup.php --install-dir=/tmp --filename=composer &&
  /tmp/composer install &&
  /tmp/composer validate --strict &&
  /tmp/composer check
'

The repository keeps composer.lock committed so development tooling is reproducible.

License

MIT