https://github.com/keyboardcowboy/perseus
My Basic PHP Library
https://github.com/keyboardcowboy/perseus
Last synced: 26 days ago
JSON representation
My Basic PHP Library
- Host: GitHub
- URL: https://github.com/keyboardcowboy/perseus
- Owner: KeyboardCowboy
- Created: 2012-07-12T06:39:48.000Z (almost 14 years ago)
- Default Branch: 3.x-dev
- Last Pushed: 2014-03-17T22:07:19.000Z (about 12 years ago)
- Last Synced: 2025-03-22T06:28:41.667Z (about 1 year ago)
- Language: PHP
- Size: 1.1 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Perseus PHP Library
[https://github.com/KeyboardCowboy/perseus](https://github.com/KeyboardCowboy/perseus)
The Perseus PHP library is a collection of useful PHP tools around a central
System manager to handle user sessions and common site-building frameworks.
## Version 3.x
Version 3 introduces the Twig theming system and PHP namespaces.
### Requirements
- PHP 5.3.0 or greater
### Included Libraries
- Krumo 2.0 for debugging
- Twig for theming
### Structure
- Extensions
Place third party service extensions here. **This is the only directory that
should be altered.**
- includes
Various libraries and helper functions to assist Perseus.
- Services
Extendable tools such as MySQL connectors and PHP Mailers that Perseus
natively implements.
- settings.default
Copy this directory to your site root and remove the '.default' part of the
name. The config.php file is for your private site configuration and the
settings.php is for custom site settings. Each file has instructions inside.
- System
The core of Perseus. These classes manage Perseus's core functionality.
- test
A testing class to ensure all Perseus's tools work well together.
- theme
Templates and processors to handle all markup. May be overridden with your
own theme files.
### Classes
#### Service Classes
Service classes are primary purpose of Perseus. They are extendable classes
for performing specific functions such as generating forms or connecting to a
MySQL database. They extend the Service class and are instantiated via
the System class in the following manner:
`$object = $system->newService('ServiceType', $settings);`
Where `ServiceType` is the name of the service such as Form or MySQL.
- CSV
- Form
- MySQL
- PhpMail
- XMLParser
#### System Classes
Perseus uses system classes for internal use such as debugging and installing.
- Debug
- Exception
- Installer
- System