Bugfish Framework
Documentation
Introducing the Bugfish PHP Framework: a robust toolkit designed to empower web developers with extensive functionality, flexibility, and top-notch security standards. With Bugfish, you gain access to a suite of classes and functions that not only streamline development but also enhance performance, ensuring your web applications operate at peak efficiency. Join the Bugfish PHP Framework community today and unleash the full potential of your web development projects.
Feel free to support this project by adding this banner to the project where you are using our framework!
I wish you the best.
Bugfish
PHP Functions
Discover a collection of indispensable PHP functions crafted for seamless integration across various projects. Witness how these functions expedite and refine coding processes within web development. Comprehensive documentation for each function is provided below. To incorporate these functions seamlessly, include the PHP files within the designated _functions subfolder in the overarching _framework folder. This strategic approach optimizes coding efficiency and enhances web project performance.
| Name | License |
|---|---|
| PHP Function Library | GPLv3 |
PHP Classes
These classes, located in /_framework/classes/x_*, are crucial for their functionality, efficiency, and thorough testing across various websites. They enhance development and save time.
Note: Some classes require a database connection. They will install necessary tables automatically if configured correctly. Not all classes require MySQL; refer to the documentation for specific requirements. If MySQL is needed, provide a valid x_class_mysql object to the class.
| Name | Description | License |
|---|---|---|
| x_class_2fa | The TwoFactorAuthenticator class in PHP generates and verifies Time-Based One-Time Password (TOTP) codes for two-factor authentication (2FA). It offers methods for generating random secret keys, creating 2FA codes, and validating them, enhancing security in PHP applications. | GPLv3 |
| x_class_api | Facilitates the creation of simple and secure API requests. This class needs PHP Module CURL to work properly. It supports token-authentication on API Requests and more. | GPLv3 |
| x_class_benchmark | Lets you benchmark resource consumption for sites on your website. PHP values related to benchmarking will be saved in a database per URL and overwritten if the URL is refreshed to monitor consumption even after changes. | GPLv3 |
| x_class_block | Facilitates session-based user counting and block operations. Easily block users from various areas if they make bad decisions and raise their counter. | GPLv3 |
| x_class_comment | Enables commenting functionality, suitable for guestbooks or website comment sections. Can also act as a simple chat or logging tool. | GPLv3 |
| x_class_csrf | Provides robust CSRF protection for web forms, supporting external actions. Includes functions to control everything related to CSRF keys, saving you time and adding basic security to your website. | GPLv3 |
| x_class_curl | Efficiently handles Curl requests and logs them for web operations. This class makes it easier to build PHP Curl requests. PHP Module CURL is needed to run this class. | GPLv3 |
| x_class_crypt | Provides file and string encryption capabilities. Encrypt and decrypt strings/files using a simple encryption method. | GPLv3 |
| x_class_debug | Aids in debugging and offers development notifications and functions. Check if PHP modules are enabled or get benchmarks for your website. | GPLv3 |
| x_class_eventbox | Simplifies the display of user notifications and messages on a web page. | GPLv3 |
| x_class_hitcounter | Counts website visitors per page URL with configurable options to handle various cases. | GPLv3 |
| x_class_ipbl | Implements IP blacklisting. Allows you to raise counters for IPs and block certain areas if an IP is acting suspiciously. Can help prevent brute-force attacks if implemented correctly. | GPLv3 |
| x_class_log | Provides a class for logging operations, allowing you to make log entries for almost every possibility. | GPLv3 |
| x_class_lang | Manages language translation for multi-language websites with functions and parameters for adding and managing translation keys. | GPLv3 |
| x_class_mail | Handles mail sending operations with a subclass for sending operation items. Depends on x_class_phpmailer. |
GPLv3 |
| x_class_mail_item | Together with x_class_mail simplifies single object transmissions. Depends on x_class_phpmailer. |
GPLv3 |
| x_class_mail_template | Creates mail templates with substitutions and footer/header options, compatible with x_class_mail. Simplifies the preparation of email templates. |
GPLv3 |
| x_class_mysql | Provides MySQL database handling capabilities with additional features. Most classes need an x_class_mysql object to run properly. Includes a database logging system to store errors and more. |
GPLv3 |
| x_class_mysql_item | Provides MySQL database handling capabilities for single database table elements. | GPLv3 |
| x_class_phpmailer | Manages email sending operations within the framework. Note: This class is from PHPMailer, not created by Bugfish. | LGPL-2.1 |
| x_class_perm | Controls user permissions and management functionalities. Ideal for implementing a permission system. | GPLv3 |
| x_class_perm_item | Controls user permissions, including single-item permission objects. Ideal for implementing a permission system. | GPLv3 |
| x_class_referer | Logs visitor referrers with configuration functions to control how referrers are saved in the database. | GPLv3 |
| x_class_redis | Offers control over Redis functionality. Caches content on a Redis server to improve website speed. Requires PHP Module REDIS. | GPLv3 |
| x_class_table | Simplifies the creation of dynamic HTML tables with PHP editing capabilities. | GPLv3 |
| x_class_user | Creates various types of user logins with full functionality for password recovery, mail editing, and token operations. A comprehensive login/authentication and token system. | GPLv3 |
| x_class_var | Controls setup variables for websites and includes a function for creating forms to change these values. Ideal for managing constants. | GPLv3 |
| x_class_zip | Enables file compression and decompression, compatible with x_class_crypt for direct encryption and decryption. Requires PHP Module ZIP. |
GPLv3 |
| x_class_version | Retrieves version and author information about the currently included framework. | GPLv3 |
CSS Classes
Introducing the "Bugfish CSS Framework" – a solution for efficient web design. Simplify your development process with a comprehensive collection of pre-built classes designed to expedite the creation of responsive web layouts. To use it, include the CSS files located in the css folder.
| Name | License |
|---|---|
| CSS Classes Library | GPLv3 |
JavaScript Functions
Access a comprehensive array of JavaScript functions designed for integration across diverse projects, enhancing coding speed and efficiency in web development. Detailed documentation for each function is provided below. To incorporate these functions, include the JavaScript file in the _javascript subfolder within the central _framework folder. This implementation optimizes your coding process and elevates your web project's performance.
Find the JavaScript function file in: /_framework/javascript/*.js
| Name | License |
|---|---|
| JavaScript Function Library | GPLv3 |