Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/faylina/witching_hour_chronicles_object-oriented

A witchy blog written in PHP - this is the object-oriented version.
https://github.com/faylina/witching_hour_chronicles_object-oriented

apache blog html-css mariadb mysql object-oriented-programming oop php8

Last synced: 12 days ago
JSON representation

A witchy blog written in PHP - this is the object-oriented version.

Awesome Lists containing this project

README 

        
# Witching Hour Chronicles (object-oriented version)



This is the object-oriented version of my first project written in PHP featuring a witchy blog.



# ----- Vision for this website -----



Witching Hour Chronicles is a simple blog-system for witchy blog posts. It tries to capture

the mysterious essence of the night and the occult with its design and uplifting posts.

At the same time, it is meant to be intuitive and practical, while offering comforting

security.



# ----- Goals -----



The goals of this project are to practice working with PHP, an Apache server and a mySQL database 

(MariaDB) and build a blog, a common element of the internet. 

Moreover, security aspects are a primary focus in this project.



# ----- Structure -----



FILE STRUCTURE

- The root directory contains the main scripts for the homepage and the dashboard, directories for 

the database, classes, layout, function libraries, debugging tools, log files and uploaded images.

- Each class has its own script inside the class directory.

- The CSS directory houses the stylesheets for the website and the debugging tools, as well as the

images that are required for the website itself.

- The include directory contains the function libraries used for this project, the debugging tools

and the project's configuration.

- The homepage script also contains the testing of the classes. 



WEBSITE STRUCTURE

- Since this project is object-oriented, most of its functions are contained in its classes.

- The User class contains, next to its native attributes for user data, also a method to fetch user 

data from the database as well as a virtual attribute to display the user's full name.

- The Category class stores the ID and category name of a category and has methods to check whether a 

category exists in the database, to fetch all categories from the database and to save a new category. 

- The Blog class contains objects of the classes User and Category, a delegation to display a user's 

full name and methods to display all blog post, to save a new blog post and to edit or delete an 

existing blog post. 

- All classes work with getters and setters.

- The homepage and the dashboard scripts contain the actual HTML and the display of the content, the URL 

and form processing, as well as the authentification flow. 



FLOW

- The homepage displays all blog posts and categories.

- The blog posts can be filtered by category by clicking on a category on the sidebar.

- The blog posts display the category they are in, their headline and content as well as the name 

of the author, their location and the time and date of when the post was published.

- It is possible to show all blog posts again after filtering. 

- The homepage also contains a login form. Only an author with valid credentials may log in, otherwise

the form throws an error.

- Once the user is logged in, the homepage displays links to the author's dashboard and a link to log out.

- Upon logging in successfully, the user is forwarded to the author's dashboard.

- The dashboard is not accessible for a not authenticated user.

- The dashboard contains links back to the homepage and to log out. Upon logging out, the user is 

redirected back to the homepage.

- The author is greeted by name on the dashboard.

- A new blog post can be submitted here. The form contains a list of existing categories to choose from.

A headline and the content of the blog post are required and an error is thrown if they are missing. It 

is optional to upload an image. The specifications for the image are listed, otherwise an error is thrown. 

The author can choose on which side of the blog post the image will be displayed.

- Also, the author can create a new category using the provided form in one of the sidebars. An error is 

thrown if the category already exists.

- Choosing the option in one of the sidebars, an existing blog post can be viewed by choosing its headline.

For that, the form to submit a new blog post is replaced by the view of the chosen blog post. The author can

return to writing a new blog post or use the sidebar to manipulate existing posts. 

- By choosing the option in the sidebar, the author can also edit an existing post. This is only possible,

if the user is also the author of the chosen post, otherwise a message will pop up. 

- The form to submit a new blog post is replaced by the edit form that is pre-filled with the existing post's

data. If the user chooses to replace the existing image with another, the old image is also deleted from the

server. 

- By choosing the option in the sidebar, the user can also delete an existing post. This is only possible,

if the user is also the author of the chosen post, otherwise a message will pop up. The author has to confirm

this decision before the post is deleted from the database, along with its image on the server. 

- The input of all forms is sanitized and validated before further processing.

- The passwords that are stored in the database are encrypted.



DEBUGGING TOOLS

- Different functions for debugging have been used in this project to better illustrate the program flow 

and help find potential errors.

- The output of those functions can be toggled on and off by setting the DEBUG constant in the config file 

to either True or False, so the user won’t have to see the output when the game is released out of the 

development stage.