PHP Manual Integration

/**
 * V3 manual format loader.
 *
 * Loads structured manual documentation from a single pre-built PHP file.
 */
class V3Manual implements ManualInterface

/**
 * V2 manual format loader.
 * Loads pre-formatted manual documentation from SQLite databases.
 */
class V2Manual implements ManualInterface

>>> doc --update-manual
Downloading manual v3.0...
Installed manual v3.0 to ~/.local/share/psysh/php_manual.php

>>> doc --update-manual=fr
Downloading manual v3.0...
Installed manual v3.0 to ~/.local/share/psysh/php_manual.php

psysh --manual-update
psysh --manual-update=de

// Determine the manual filename
$manualFilename = $this->format === 'php' ? 'php_manual.php' : 'php_manual.sqlite';

>>> doc array_map

Function [ <internal:standard> function array_map ] {

  - Parameters [2] {
    Parameter #0 [ <required> callable $callback ]
    Parameter #1 [ <required> array $array ]
  }
}

Description:
  Applies the callback to the elements of the given arrays

  array_map(callable $callback, array $array, array ...$arrays): array

Parameters:
  callback - A callable to run for each element in each array
  array    - An array to run through the callback function
  arrays   - Supplementary arrays

Return Values:
  Returns an array containing all the elements of array after
  applying the callback function to each one.

>>> doc PDO
>>> doc DateTime::format
>>> doc Exception::getMessage

>>> doc foreach
>>> doc try
>>> doc switch

return [
    'updateManualCheck' => 'monthly', // or 'daily', 'weekly'
];

private ?string $updateManualCheck = null;

/**
 * Get manual metadata (version, language, build date, etc).
 */
public function getMeta(): array;

[
    'version' => '3.0.1',
    'lang' => 'en',
    'format' => 'php',
    'built_at' => 1709251200,
    'git_timestamp' => 1709164800,
]

You have a legacy SQLite manual: ~/.local/share/psysh/php_manual.sqlite

Download the current manual format? [Y/n]

// Validate that the file returned an object with the expected interface
if (!is_object($data)) {
    throw new InvalidManualException(
        sprintf('Manual file "%s" must return an object, got %s', $filePath, gettype($data)),
        $filePath
    );
}

// Verify the manual format version is v3.x
$meta = $data->getMeta();
if (!isset($meta['version']) || !preg_match('/^3\./', (string) $meta['version'])) {
    $version = $meta['version'] ?? 'unknown';
    throw new InvalidManualException(
        sprintf('Manual file "%s" must be v3.x format, got version %s', $filePath, $version),
        $filePath
    );
}

Invalid manual file detected: ~/.local/share/psysh/php_manual.php

Remove this file and continue? [Y/n]

// .psysh.php
return [
    'manualDbFile' => '/custom/path/php_manual.php',
];

/**
 * Set the PHP manual database file.
 *
 * @param string $filename Manual file path
 */
public function setManualDbFile(string $filename)
{
    $this->manualDbFile = (string) $filename;
}

return [
    'dataDir' => '/path/to/data',
];

# Download manual first
php bin/psysh --update-manual

# Build PHAR (includes manual)
php build.php