Add files

hubwriter · hubwriter · commit 3f8baedbcb86 · 2025-02-03T10:14:49.000Z
diff --git a/.DS_Store b/.DS_Store
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+/.idea
+.php_cs.cache
diff --git a/.htaccess b/.htaccess
@@ -0,0 +1,6 @@
+Options +FollowSymLinks
+RewriteEngine On
+
+RewriteCond %{REQUEST_FILENAME} !-d
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ index.php?page=$1 [L]
diff --git a/README.md b/README.md
@@ -1,2 +1,19 @@
-# simple-php-website
-A simple and minimal website built with PHP.
+# Simple PHP-based website
+
+This project is used in the GitHub documentation to guide users through the process of converting a project written on one language to another language - for example, from PHP to Python.
+
+The repository is derived from the public GitHub repository [banago/simple-php-website](https://github.com/banago/simple-php-website).
+
+## Installation
+
+To generate the website output from this project:
+
+1. Clone the project to your local computer.
+1. Install PHP on your computer.
+1. In a terminal, navigate to the project folder.
+1. Run `php -S localhost:8080`.
+1. In a web browser, go to http://localhost:8080.
+
+## License
+
+MIT
diff --git a/content/404.phtml b/content/404.phtml
@@ -0,0 +1 @@
+<p>404 - This page does not exist.</p>
diff --git a/content/about-us.phtml b/content/about-us.phtml
@@ -0,0 +1,2 @@
+<p>This is <b>about</b> page. Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.</p>
+<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).</p>
diff --git a/content/contact.phtml b/content/contact.phtml
@@ -0,0 +1,2 @@
+<p>This is <b>contact</b> page. Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.</p>
+<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).</p>
diff --git a/content/home.phtml b/content/home.phtml
@@ -0,0 +1,2 @@
+<p>This is <b>home</b> page. Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.</p>
+<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).</p>
diff --git a/content/products.phtml b/content/products.phtml
@@ -0,0 +1,2 @@
+<p>This is <b>product</b> page. Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.</p>
+<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).</p>
diff --git a/includes/config.php b/includes/config.php
@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * Used to store website configuration information.
+ *
+ * @var string or null
+ */
+function config($key = '')
+{
+    $config = [
+        'name' => 'Simple PHP Website',
+        'site_url' => '',
+        'pretty_uri' => false,
+        'nav_menu' => [
+            '' => 'Home',
+            'about-us' => 'About Us',
+            'products' => 'Products',
+            'contact' => 'Contact',
+        ],
+        'template_path' => 'template',
+        'content_path' => 'content',
+        'version' => 'v3.1',
+    ];
+
+    return isset($config[$key]) ? $config[$key] : null;
+}
diff --git a/includes/functions.php b/includes/functions.php
@@ -0,0 +1,82 @@
+<?php
+
+/**
+ * Displays site name.
+ */
+function site_name()
+{
+    echo config('name');
+}
+
+/**
+ * Displays site url provided in config.
+ */
+function site_url()
+{
+    echo config('site_url');
+}
+
+/**
+ * Displays site version.
+ */
+function site_version()
+{
+    echo config('version');
+}
+
+/**
+ * Website navigation.
+ */
+function nav_menu($sep = ' | ')
+{
+    $nav_menu = '';
+    $nav_items = config('nav_menu');
+    
+    foreach ($nav_items as $uri => $name) {
+        $query_string = str_replace('page=', '', $_SERVER['QUERY_STRING'] ?? '');
+        $class = $query_string == $uri ? ' active' : '';
+        $url = config('site_url') . '/' . (config('pretty_uri') || $uri == '' ? '' : '?page=') . $uri;
+        
+        // Add nav item to list. See the dot in front of equal sign (.=)
+        $nav_menu .= '<a href="' . $url . '" title="' . $name . '" class="item ' . $class . '">' . $name . '</a>' . $sep;
+    }
+
+    echo trim($nav_menu, $sep);
+}
+
+/**
+ * Displays page title. It takes the data from
+ * URL, it replaces the hyphens with spaces and
+ * it capitalizes the words.
+ */
+function page_title()
+{
+    $page = isset($_GET['page']) ? htmlspecialchars($_GET['page']) : 'Home';
+
+    echo ucwords(str_replace('-', ' ', $page));
+}
+
+/**
+ * Displays page content. It takes the data from
+ * the static pages inside the pages/ directory.
+ * When not found, display the 404 error page.
+ */
+function page_content()
+{
+    $page = isset($_GET['page']) ? $_GET['page'] : 'home';
+    $path = getcwd() . '/' . config('content_path') . '/' . $page . '.phtml';
+
+    if (! file_exists($path)) {
+        $path = getcwd() . '/' . config('content_path') . '/404.phtml';
+    }
+
+    echo file_get_contents($path);
+}
+
+/**
+ * Starts everything and displays the template.
+ */
+function init()
+{
+    require config('template_path') . '/template.php';
+}
diff --git a/index.php b/index.php
@@ -0,0 +1,10 @@
+<?php
+
+// Comment these lines to hide errors
+error_reporting(E_ALL);
+ini_set('display_errors', 1);
+
+require 'includes/config.php';
+require 'includes/functions.php';
+
+init();
diff --git a/template/style.css b/template/style.css
@@ -0,0 +1,30 @@
+
+.wrap { 
+    padding: 25px; 
+    text-align: center; 
+    box-shadow: 0 4px 25px -4px #9da5ab; 
+}
+article { 
+    padding: 25px 0; 
+    line-height: 150%; 
+    text-align: left; 
+}
+
+nav .item {
+    text-decoration: none;
+}
+nav .active {
+    border-bottom: 1px solid;   
+}
+
+@media only screen and (min-width: 768px) {
+    article { 
+        padding: 40px; 
+    }
+    .wrap { 
+        max-width: 750px; 
+        margin: 50px auto;
+        padding: 30px 40px;
+    }
+}
+    
diff --git a/template/template.php b/template/template.php
@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8" />
+    <meta http-equiv="x-ua-compatible" content="ie=edge"/>
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"/>
+    <title><?php page_title(); ?> | <?php site_name(); ?></title>
+    <link href="<?php site_url(); ?>/template/style.css" rel="stylesheet" type="text/css" /> 
+</head>
+<body>
+<div class="wrap">
+
+    <header>
+        <h1><?php site_name(); ?></h1>
+        <nav class="menu">
+            <?php nav_menu(); ?>
+        </nav>
+    </header>
+
+    <article>
+        <h2><?php page_title(); ?></h2>
+        <?php page_content(); ?>
+    </article>
+
+    <footer>
+        <small>&copy;<?php echo date('Y'); ?> <?php site_name(); ?>.<br><?php site_version(); ?></small>
+    </footer>
+
+</div>
+</body>
+</html>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+<p>This is <b>about</b> page. Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.</p>
	`2`	+<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).</p>
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+<p>This is <b>contact</b> page. Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.</p>
	`2`	+<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).</p>
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+<p>This is <b>home</b> page. Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.</p>
	`2`	+<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).</p>
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+<p>This is <b>product</b> page. Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.</p>
	`2`	+<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).</p>