Download the PHP package vulcanphp/hyper-core without Composer

HyperCore

Core Classes and Functionalities for Hyper MVT Framework

Introduction

HyperCore is the backbone of the Hyper MVT Framework, providing essential core classes, utility functions, and helper methods to streamline web development. This document details all available classes and functions within the HyperCore.

Core Classes

Application

• Class: application
• Description: Application container that manages the overall lifecycle of your application.

Database

• Class: database
• Description: PDO database container for managing database connections and operations.
• Example:

Debugger

• Class: debugger
• Description: Error tracer and log viewer for debugging and logging application errors.

Request

• Class: request
• Description: HTTP request class for handling and processing incoming requests.

Response

• Class: response
• Description: HTTP response class for managing outgoing responses.

Middleware

• Class: middleware
• Description: Middleware class for handling HTTP request routing.
• Example:

Router

• Class: router
• Description: Router class for defining and handling application routes.
• Example:

Model

• Class: model
• Description: Model class for handling database interactions with ORM and form handling.
• Example:

Query

• Class: query
• Description: PHP PDO query builder for constructing and executing database queries.
• Example:

Session

• Class: session
• Description: Session class for managing user sessions.

Template

• Class: template
• Description: Template engine class for rendering views.
• Example:

Translator

• Class: translator
• Description: Google Translator class for translating text.

Utility Classes

Cache

• Class: cache
• Description: Cache class for caching data.
• Example:

Collect

• Class: collect
• Description: Collection class for handling data collections.

Form

• Class: form
• Description: Form builder class for constructing and managing forms.
• Example:

Hash

• Class: hash
• Description: Class for hashing and encryption.

Image

• Class: image
• Description: Image helper class for managing image operations.
• Example:

Paginator

• Class: paginator
• Description: Paginator class for handling pagination.
• Example:

Ping

• Class: ping
• Description: HTTP ping/cURL helper class.
• Example:

Uploader

• Class: uploader
• Description: File uploader class for managing file uploads.
• Example:

Validator

• Class: validator
• Description: HTTP input validator class.
• Example:

Helper Classes

Form

• Class: form
• Description: Trait for model to extract form fields from model object properties.
• Example:

Mail

• Class: mail
• Description: PHP built-in mail class.
• Example:

ORM

• Class: orm
• Description: Object-Relational Mapper for database interactions.
• Example:

Uploader

• Class: uploader
• Description: Uploader helper for managing model uploads.
• Example:

Vite

• Class: vite
• Description: Vite helper class for asset management.

Shortcut Functions

Application

• Function: app()
• Description: Returns the application instance.

Request

• Function: request()
• Description: Returns the request instance.

Response

• Function: response()
• Description: Returns the response instance.

Redirect

• Function: redirect()
• Description: Redirects to a different URL and returns void.

Session

• Function: session()
• Description: Returns the session instance.

Router

• Function: router()
• Description: Returns the router instance.

Database

• Function: database()
• Description: Returns the database instance.

Query

• Function: query()
• Description: Returns the query builder instance.

Template

• Function: template()
• Description: Returns a new template instance.

URLs

• Functions:
  • url(string $path = ''): string - Returns the URL for the given path.
  • public_url(string $path = ''): string - Returns the public URL for the given path.
  • asset_url(string $path = ''): string - Returns the asset URL for the given path.
  • media_url(string $path = ''): string - Returns the media URL for the given path.
  • request_url() - Returns the current requested URL.
  • route_url() - Returns the route URL.

Directories

• Functions:
  • app_dir() - Returns the application directory.
  • root_dir() - Returns the root directory.

Debugging

• Functions:
  • dump() - Dumps data for inspection.
  • dd() - Dumps data and stops execution.
  • debugger() - Shows any error details and logs application steps.

Environment

• Function: env()
• Description: Gets an environment variable.

CSRF

• Functions:
  • csrf_token() - Returns the CSRF token.
  • csrf() - Returns the CSRF token with an HTML hidden input.

User

• Function: user()
• Description: Returns the logged-in user.

Collections

• Function: collect()
• Description: Returns a new collect class instance.

Cache

• Function: cache()
• Description: Returns a new cache class instance.

Translation

• Function: __()
• Description: Translates text.

Vite

• Function: vite()
• Description: Returns a new vite class instance.

Templates

• Function: template_exists()
• Description: Checks if a template exists.

Site Settings

• Functions:
  • setting(string $layer, string $key, $default): mixed - Returns the value for this setting.
  • settings() - Returns the settings drawer.

Conclusion

HyperCore provides a comprehensive set of core functionalities, utility methods, and helper classes to make web development with the Hyper MVT Framework efficient and enjoyable. Whether you are handling HTTP requests, managing databases, or working with templates, HyperCore has you covered.