Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carbonorm/carbonphp
CarbonPHP [C6] is a PHP Library ^8.2 ⊃ { MySQL ORM ∪ WebSockets ∪ Sessions }
https://github.com/carbonorm/carbonphp
javascript mysql orm pdo-mysql php react typescript
Last synced: about 1 month ago
JSON representation
CarbonPHP [C6] is a PHP Library ^8.2 ⊃ { MySQL ORM ∪ WebSockets ∪ Sessions }
- Host: GitHub
- URL: https://github.com/carbonorm/carbonphp
- Owner: CarbonORM
- License: mit
- Created: 2017-10-15T14:28:31.000Z (about 7 years ago)
- Default Branch: lts
- Last Pushed: 2024-05-17T02:32:41.000Z (8 months ago)
- Last Synced: 2024-05-18T01:03:09.878Z (8 months ago)
- Topics: javascript, mysql, orm, pdo-mysql, php, react, typescript
- Language: PHP
- Homepage: https://CarbonPHP.com
- Size: 186 MB
- Stars: 10
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Welcome to CarbonPHP
Our full documentation is available at our [GitHub Wiki](https://github.com/CarbonORM/CarbonPHP/wiki) or with runnable examples at [Carbonorm.dev](https://carbonorm.dev/).
## Installation
`composer require carbonorm/carbonphp`
This command will install the [latest release](https://github.com/CarbonORM/CarbonPHP/releases) of CarbonPHP using Composer. If you do not already have Composer installed,
you may do so by following the instructions at [getcomposer.org](https://getcomposer.org/download/). Composer is PHP's
[package manager](https://en.wikipedia.org/wiki/Package_manager), and is required to use CarbonPHP. [Packagist](https://packagist.org/packages/carbonorm/carbonphp)
is the official repository for Composer packages, and is where download statistics are gathered from. The old repository location `composer require richardtmiles/carbonphp` will still work with composer/packagist, but it is reccomended to move to the new location. The total number # of downloads above is duplicated to refect the two ways to download via composer.
### Wordpress
Alternatively, you may install [CarbonPHP as a WordPress Plugin](https://github.com/CarbonORM/CarbonWordPress). This
will allow you to use CarbonPHP's features with a guided user interface.
# CarbonPHP Tool Kit and Performance Library
CarbonPHP has grown into the [CarbonORM Public Organization](https://github.com/CarbonORM/). There you can find
documentation over the front end process of using the ORM. C6 now refers to any of Carbon* prefixed CarbonORM packages.
[CarbonORM.dev](http://carbonorm.dev/)
CarbonPHP has reached a stable level of trust in its own features through PHPUnit Tests +
GitHub Actions but is still in active development. CarbonPHP is being used in production environments. Anyone, or team,
who attempts using this code
will find support on GitHub through issues and forums. We generally expect any issue you many encountered to be minor.
If you edit the codebase, please consider submitting those changes on GitHub! C6
uses [Semantic Versioning 2.0.0](https://semver.org).
Generally: MAJOR version when you make incompatible API changes, MINOR version when you add functionality in a backwards
compatible manner, and PATCH version when you make backwards compatible bug fixes. Changes to function/class/etc will be
called out in the Changelog with every minor release. Please read the changelog or code changes carefully when updating.
Refer to the guide at [carbonphp.com](https://carbonphp.com)
## Introduction - { MySQL ORM ∪ WebSockets ∪ $_SESSION Management ∪ PDO Database Management }
CarbonPHP is a PHP 8.2+ library to simplify the building of custom, dynamic web applications. Its main focus is to make
webapps run ridiculously fast, with performance and high-traffic scalability being the absolute highest concern.
CarbonPHP
has clocked in with impressive statistics, sometimes doubling the traffic that small servers with MySQL-intensive sites
can handle.
C6 works as a standalone backbone for your dev needs or in the corporation with other popular frameworks
like [WordPress](https://developer.wordpress.org)
or [Laravel](https://laravel.com).
CarbonPHP's other goals include portability; allowing your webapps to be installed on servers with different operating
systems (Windows, Mac, and Linux Support). Full MySQL ORM REST generator, and php written database tools designed around
the MySQL. Windows PHP currently lacks a library capable of forking. Should your development require a Windows
computers look into [WSL](https://learn.microsoft.com/en-us/windows/wsl/install). I hope to contribute a php library
written in C (PHP is written in C) to support this task, however time is a factor. Should you feel compelled to help in
this goal please contact me at [email protected]. Please see the documentation at Carbonphp.com for more
information.
For the rest of us who live outside windows Hell C6 has a Websocket Library Class for Standard use and WordPress use.
## Quick Start
### Existing projects
composer require carbonorm/carbonphp
## Standards
C6 should follow the [PHP Standards Recommendations](https://www.php-fig.org/psr/) listed below.
[PSR-4](https://www.php-fig.org/psr/psr-4/)
[PSR-12](https://www.php-fig.org/psr/psr-12/)
[SEMVAR](https://semver.org)
## Requirements
CarbonPHP currently requires PHP 8.2 or later. We try to stay up-to-date
with [PHP's Supported Versions](https://www.php.net/supported-versions.php).
It makes use of return type object notation, and should not be ported back to earlier PHP versions.
CarbonPHP will always try to stay upto date with the latest version of PHP.
Use of an opcode cache such as XCache is highly recommended, as Carbon is able to run entirely without stat()
calls when paired with an opcode cache. Also recommended (but optional) is a RAM-caching engine such as memcached.
PHP8, if not already supported, will receive support WITH C6's FIRST Backwards Compatible Release. Plans to drop 7.4
are currently scheduled for the summer of 2022.
## Documentation
All function should have PHPDoc-style documentation in the code. [CarbonPHP.com](https://carbonphp.com/) also has full
explanations of the codebase.
ssed to MVC. Please ensure your namespace mappings are correct!";
### RESTFUL ORM
CarbonPHP's largest feature is the MySQL ORM. By running a customizable CLI command our program
will analyze your database schema and generate powerful classes used to manipulate your tables. The auto generated files
may be used in conjunction for an incredibly pleasing RESTFUL semantics structure. Below are examples for using the REST
ORM. You
can [see the generated source here](https://github.com/RichardTMiles/CarbonPHP/blob/master/carbonphp/tables/Carbon_Users.php).
```PHP
'Athlete',
Users::USER_IP => '127.0.0.1',
Users::USER_SPORT => 'GOLF',
Users::USER_EMAIL_CONFIRMED => 1,
Users::USER_USERNAME => Config::ADMIN_USERNAME,
Users::USER_PASSWORD => Config::ADMIN_PASSWORD,
Users::USER_EMAIL => '[email protected]',
Users::USER_FIRST_NAME => 'Richard',
Users::USER_LAST_NAME => 'Miles',
Users::USER_GENDER => 'Male'
]);
```
Joining across multiple tables.
```PHP
Users::Get($user, $uid, [
Users::SELECT => [
Users::USER_USERNAME,
Carbon_Locations::STATE
],
Users::JOIN => [
Users::INNER => [
Carbon_Location_References::TABLE_NAME => [
Users::USER_ID => Carbon_Location_References::ENTITY_REFERENCE
],
Carbon_Locations::TABLE_NAME => [
Carbon_Locations::ENTITY_ID => Carbon_Location_References::LOCATION_REFERENCE
]
]
],
Users::PAGINATION => [
Users::LIMIT => 1,
Users::ORDER => [Users::USER_USERNAME => Users::ASC]
]
]);
```
Using the ORM from the Frontend. This example showcases multiple table joins, as well as the use of aggregate function(
s)
GROUP_CONCAT.
```typescript
const {axios} = this.props;
axios.get('/rest/' + C6.carbon_users.TABLE_NAME, {
params: {
[C6.SELECT]: [
C6.carbon_users.USER_USERNAME,
C6.carbon_users.USER_FIRST_NAME,
C6.carbon_users.USER_LAST_NAME,
C6.carbon_users.USER_ID,
[C6.GROUP_CONCAT, C6.carbon_features.FEATURE_CODE],
[C6.GROUP_CONCAT, C6.carbon_groups.GROUP_NAME]
],
[C6.JOIN]: {
[C6.LEFT]: {
[C6.carbon_user_groups.TABLE_NAME]: [
C6.carbon_users.USER_ID,
C6.carbon_user_groups.USER_ID
],
[C6.carbon_groups.TABLE_NAME]: [
C6.carbon_user_groups.GROUP_ID,
C6.carbon_groups.ENTITY_ID
],
[C6.carbon_feature_group_references.TABLE_NAME]: [
C6.carbon_groups.ENTITY_ID,
C6.carbon_feature_group_references.GROUP_ENTITY_ID
],
[C6.carbon_features.TABLE_NAME]: [
C6.carbon_features.FEATURE_ENTITY_ID,
C6.carbon_feature_group_references.FEATURE_ENTITY_ID
]
}
},
[C6.PAGINATION]: {
[C6.LIMIT]: 100
}
}
}).then(response => this.setState({users: (response.data.rest || [])}));
```
# Builtin Command Line Interface
Much like laravel's artisan, any file that invokes CarbonPHP from the command line will execute the CLI Interface. I
plan to make a system in place for user commands in Beta. See all available commands with:
php index.php help
## Support
Support for CarbonPHP is offered at https://github.com/RichardTMiles/CarbonPHP.
## Legal
Use of CarbonPHP implies agreement with its software license, available in the LICENSE file. This license is subject to
change from release to release, so before upgrading to a new version of C6, please review its license.
## Credits
CarbonPHP was created by Richard Tyler Miles, the BDFL, and inspired
by [Tom Frost's](https://github.com/TomFrost) [Hydrogen](https://github.com/TomFrost/Hydrogen).
Contributors can be found on the [contributors](https://github.com/CarbonORM/CarbonPHP/graphs/contributors) page.
## TODO - Double down on apache configs
https://gist.github.com/RichardTMiles/ae5718aff63ab4633457b6285c825aa2
This will be in CarbonWordPress and modified for general use in CarbonPHP.