archived-web-php/download-docs.php

<?php

use phpweb\I18n\Languages;

$_SERVER['BASE_PAGE'] = 'download-docs.php';
include_once __DIR__ . '/include/prepend.inc';

if (!empty($_GET['active_langs'])) {
    echo serialize(Languages::ACTIVE_ONLINE_LANGUAGES);
    exit;
}

$SIDEBAR_DATA = '
<div class="panel">
    <div class="headline">Online documentation</div>
    <div class="body">
        <p>
            You can read the
            <a href="/docs.php">documentation online</a>
            in various languages. The Documentation HOWTO,
            and archive manuals are also available
            from our <a href="/docs.php">documentation page</a>.
        </p>
    </div>
</div>

<div class="panel">
    <div class="headline">Other formats</div>
    <div class="body">
        <p>
            The manual is also available via *nix style man pages. To
            install and use:
        </p>
        <ul class="toc">
            <li>Install: <code>pear install doc.php.net/pman</code></li>
            <li>Upgrade: <code>pear upgrade doc.php.net/pman</code></li>
            <li>Example usage: <code>pman strlen</code></li>
        </ul>
    </div>
</div>
';

site_header("Download documentation", ["current" => "docs"]);

// Format to look for
$formats = [
    "Single HTML file" => "html.gz",
    "Many HTML files" => "tar.gz",
    "HTML Help file" => "chm",
    "HTML Help file (with user notes)" => "chm",
];
?>

<h1>Download documentation</h1>

<p>
 The PHP manual is available in a selection of languages and
 formats. Pick a language and format from the table below to start
 downloading.
</p>

<h2>Notes to read before you download</h2>

<ul>
 <li>
  The English version should be considered the most accurate, since
  translations are based on that version. Most of the translations
  are not complete, and contain English parts.
 </li>
 <li>
  If you are looking for PHP 5 documentation, please read
  <a href="/manual/php5.php">this explanation</a>.
 </li>
 <li>
  If you are looking for PHP 4 documentation, please read
  <a href="/manual/php4.php">this explanation</a>.
 </li>
</ul>

<p class="warn">
  If you are using Windows XP SP2 or later and you are going to download the
  documentation in CHM format, you <strong>need</strong> to &quot;unblock&quot;
  the file after downloading it by right-clicking on it in Windows Explorer and
  selecting the &quot;Properties&quot; menu item, then clicking on the
  &quot;Unblock&quot; button (on Windows Vista this is within the
  &quot;Security&quot; options).  Failure to unblock the documentation file may
  result in error messages including &quot;Navigation to the webpage was
  canceled&quot; due to Windows security restrictions.
</p>

<?php
$files = []; $found_formats = [];
$filepath = $filename = '';

// Go through all possible manual languages
foreach (Languages::LANGUAGES as $langcode => $language) {
    if (isset(Languages::INACTIVE_ONLINE_LANGUAGES[$langcode]) && $MYSITE !== 'http://docs.php.net/') {
       continue;
    }

    // Go through all possible manual formats
    foreach ($formats as $formatname => $extension) {

        $filepath = $_SERVER['DOCUMENT_ROOT'] . '/distributions/manual/';
        if ($formatname === 'HTML Help file (with user notes)') {
            $filename = "php_enhanced_$langcode.$extension";
        } else {
            $filename = "php_manual_$langcode.$extension";
        }

        $filepath .= $filename;

        // File named after the language and format exists
        if (file_exists($filepath)) {

            // Mirror selection download URL
            $link_to = "/distributions/manual/$filename";

            // Try to get size and changed date
            $size = @filesize($filepath);
            $changed = @filemtime($filepath);

            // Size available, collect information
            if ($size !== false) {
                $files[$langcode][$formatname] = [
                    $link_to,
                    (int) ($size / 1024),
                    date("j M Y", $changed),
                    $extension,
                ];
                $found_formats[$formatname] = 1;
            }
        }
    }
}
/* {{{ FIXME: Special handling for the extended html help format since it doesn't follow the "naming rules"
 * (mostly copy&paste from the loop above)
 * Feb 20, 2009: Commenting this out as we currently don't build or work on it

$formats['<a href="/docs-echm.php">Extended HTML Help</a>'] = "zip"; // Add a link to the xchm docs in the table header
$actual_file = $_SERVER['DOCUMENT_ROOT'] . "/distributions/manual/php_manual_chm.zip";
if (file_exists($actual_file)) {
    $link_to = "/get/php_manual_chm.zip/from/a/mirror";
    $size    = @filesize($actual_file);
    $changed = @filemtime($actual_file);
    if ($size !== FALSE) {
        $files["en"]["zip"] = array(
            $link_to,
            (int) ($size/1024),
            date("j M Y", $changed),
            "zip"
        );
        $found_formats["xchm"] = "zip";
    }
}
}}} */

if (count($found_formats) == 0) {
    echo "<p class=\"tip\">This site has no documentation files for download.</p>";
} else {

    echo '<table border="0" cellpadding="4" cellspacing="2" class="standard">' . "\n" .
         "<tr>\n  <th>&nbsp;</th>\n";

    // Print out the name of the formats
    foreach ($formats as $formatname => $extension) {
        if (!isset($found_formats[$formatname])) { continue; }
        echo "  <th valign=\"bottom\">$formatname</th>\n";
    }

    echo " </tr>\n";

    foreach ($files as $langcode => $lang_files) {

        // See if current language is the preferred one
        if ($langcode == $LANG) { $preflang = true; }
        else { $preflang = false; }

        // Highlight manual in preferred language
        if ($preflang) {
            $cellclass = ' class="highlight"';
        } else {
            $cellclass = "";
        }

        echo "<tr>\n<th class=\"subl\">" . Languages::LANGUAGES[$langcode] . "</th>\n";

        foreach ($formats as $formatname => $extension) {

            // Skip if no file found
            if (!isset($found_formats[$formatname])) { continue; }

            echo "<td align=\"center\"$cellclass>";
            if (!isset($lang_files[$formatname])) {
                echo "&nbsp;";
            } else {

                $fileinfo = $lang_files[$formatname];
                echo "<a href=\"$fileinfo[0]\"";

                // Only print out tooltip, if explicit information is not printed
                if (!isset($_GET['sizes']) && !$preflang) {
                    echo " title=\" Size: $fileinfo[1]Kb -- Date: $fileinfo[2]\"";
                }

                // End link tag
                echo ">$fileinfo[3]</a>";

                // Sizes required to be printed out (URL parameter or preferred language)
                if (isset($_GET['sizes']) || $preflang) {
                    echo "<br><small>Size: $fileinfo[1]Kb<br>Date: $fileinfo[2]</small>";
                }
            }

            // End table cell
            echo "</td>\n";

        }

        // End table row
        echo "</tr>\n";
    }
    echo "</table>\n";
}
?>

<?php site_footer(['sidebar' => $SIDEBAR_DATA]);