Skip to content

Commit 59dc9b0

Browse files
committed
Perpl not Perpel
1 parent bb5320b commit 59dc9b0

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Perpel
1+
# Perpl ORM
22

3-
Perpel is a fork of the unmaintained [Propel2](https://github.com/propelorm/Propel2), an open-source Object-Relational Mapping (ORM) for PHP. It adds several improvements and fixes, including proper versioning.
3+
Perpl is a fork of the unmaintained [Propel2](https://github.com/propelorm/Propel2), an open-source Object-Relational Mapping (ORM) for PHP. It adds several improvements and fixes, including proper versioning.
44

55
[![Github actions Status](https://github.com/propelorm/Propel2/workflows/CI/badge.svg?branch=master)](https://github.com/propelorm/Propel2/actions?query=workflow%3ACI+branch%3Amaster)
66
[![codecov](https://codecov.io/gh/propelorm/Propel2/branch/master/graph/badge.svg?token=L1thFB9nOG)](https://codecov.io/gh/propelorm/Propel2)
@@ -13,10 +13,10 @@ Perpel is a fork of the unmaintained [Propel2](https://github.com/propelorm/Prop
1313

1414
# Installation
1515

16-
- Replace the `require` declaration for Propel with Perpel:
16+
- Replace the `require` declaration for Propel with Perpl:
1717
```diff
1818
"require": {
19-
+ "perpelorm/perpel": ">=2.0",
19+
+ "perplorm/perpl": ">=2.0",
2020
- "propel/propel": "dev-main as 2.0.x-dev",
2121
},
2222
```
@@ -43,7 +43,7 @@ $ vendor/bin/propel --config-dir <path/to/config> model:build
4343

4444
# Features
4545

46-
Motivation for Perpel was to make features available around code-style, typing, performance and usability.
46+
Motivation for Perpl was to make features available around code-style, typing, performance and usability.
4747

4848
## Type-preserving queries
4949

@@ -80,7 +80,7 @@ This cannot be added automatically for existing classes. While IDEs seem to figu
8080
These changes mostly improve internal readability/soundness of core Propel code. They mostly allow for easier and safe maintenance, but occasionally lead to performance improvements, for example when repetitive operations on strings are replaced by proper data structures.
8181

8282
Some notable changes:
83-
- columns in queries are turned to objects, which leads to more readable code and makes tons of string operations obsolete (~30-50% faster query build time, see [#24](https://github.com/mringler/perpel/pull/24))
83+
- columns in queries are turned to objects, which leads to more readable code and makes tons of string operations obsolete (~30-50% faster query build time, see [#24](https://github.com/mringler/perpl/pull/24))
8484
- fixes some confusing names (Criteria vs Criterion)
8585
- spreads out some "one size fits none" overloads, i.e. `Criteria::map` becomes `Criteria::columnFilters` and `Criteria::updateValues`
8686

@@ -104,11 +104,11 @@ Previously, this required to register the individual parts under an arbitrary na
104104

105105
## Read multiple behaviors from same repository
106106

107-
Propel restricts reading behaviors from repositories to one per repo. This allows to read multiple behaviors (see [#25](https://github.com/mringler/perpel/pull/25) for details).
107+
Propel restricts reading behaviors from repositories to one per repo. This allows to read multiple behaviors (see [#25](https://github.com/mringler/perpl/pull/25) for details).
108108

109109
# Breaking Changes
110110

111-
Perpel is fully backwards compatible with Propel2, with few exceptions. They mostly affect the low-level Criteria interface. Impact for regular users should be slim to none.
111+
Perpl is fully backwards compatible with Propel2, with few exceptions. They mostly affect the low-level Criteria interface. Impact for regular users should be slim to none.
112112

113113
## Set update value and add filter use dedicated methods
114114

@@ -186,7 +186,7 @@ Obscure names, replaced functionality, unclear use-case - removing those methods
186186

187187
The methods are still available, but only through magic `__call()`. They do not appear on the query object interface and thus are not suggested by autocomplete. Using them will trigger a deprecation warning. The method docs in `src/Propel/Runtime/ActiveQuery/DeprecatedCriteriaMethods.php` describe how to replace them.
188188

189-
A full list of deprecated methods can be found in [#28](https://github.com/mringler/perpel/pull/28). Notable mentions are `Criteria::addCond()` and `Criteria::combine()`, which are replaced by `Criteria::combineFilters()` (see above), and `Criteria::addSelectQuery()`, which is replaced by the aptly-named `Criteria::addSubquery()`.
189+
A full list of deprecated methods can be found in [#28](https://github.com/mringler/perpl/pull/28). Notable mentions are `Criteria::addCond()` and `Criteria::combine()`, which are replaced by `Criteria::combineFilters()` (see above), and `Criteria::addSelectQuery()`, which is replaced by the aptly-named `Criteria::addSubquery()`.
190190

191191
# Outlook
192192

composer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "perpelorm/perpel",
2+
"name": "perplorm/perpl",
33
"type": "library",
4-
"description": "Perpel is an improved and still maintained fork of Propel2, an open-source Object-Relational Mapping (ORM) for PHP.",
4+
"description": "Perpl is an improved and still maintained fork of Propel2, an open-source Object-Relational Mapping (ORM) for PHP.",
55
"keywords": [
66
"ORM",
77
"persistence",

0 commit comments

Comments
 (0)