Skip to content

Commit bae2881

Browse files
Overworked README.md and composer.json.
1 parent 8ee4ea3 commit bae2881

2 files changed

Lines changed: 9 additions & 5 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ This library provides a performance-improved, and convenient way to deal with PH
55

66
* **Performance:** Reflection is slow if you instantiate it continuously. If you rely on reflection heavily to inspect the same type of classes in one request over and over again, then caching of the created Reflection classes helps a lot.
77

8-
* **Convenience:** Instead of dealing with the object graph of Reflection classes, a facade offers convenient methods to retrieve PHP Reflection classes, and getting/setting (non-public) properties of an object.
8+
* **Convenience:** Instead of dealing with the object graph of Reflection classes, a facade offers convenient methods to
9+
10+
* retrieve PHP Reflection classes,
11+
* getting/setting static and non-static properties of an object or class,
12+
* invoking static and non-static methods of an object or class.
913

1014

1115
## Installation
@@ -19,7 +23,7 @@ $ composer require scaleupstack/reflection
1923

2024
## Usage
2125

22-
The public API of this package is presented via the `Reflection` class. All methods of the `Reflection` class are static. (In fact, it is not possible to instantiate it.)
26+
The public API of this package is available via the `ScaleUpStack\Reflection\Reflection` class. All methods of the `Reflection` class are static. (In fact, it is not possible to instantiate it.)
2327

2428
* Namespace
2529

@@ -48,7 +52,7 @@ The public API of this package is presented via the `Reflection` class. All meth
4852

4953
Please note that `classByObject()` returns a `\ReflectionClass` and not a `\ReflectionObject`.
5054

51-
* Methods to access the values of object or static class properties:
55+
* Methods to access static and non-static properties:
5256

5357
```php
5458
Reflection::getPropertyValue(object $object, string $propertyName) : mixed
@@ -68,7 +72,7 @@ The public API of this package is presented via the `Reflection` class. All meth
6872

6973
## Current State
7074

71-
This library is work-in-progress, but the public API should be very stable.
75+
This library is stable.
7276

7377
Handling of some Reflection features that could (perhaps?) benefit from caching (e.g. getting the parent class) are not implemented yet. But I do not strive for completeness. If you are missing some features, just create a pull request or ask for it, explaining your context/needs.
7478

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "scaleupstack/reflection",
3-
"description": "A performance-improved, and convenient way to deal with PHP Reflection classes.",
3+
"description": "A performance-improved and convenient way to deal with PHP Reflection.",
44
"type": "library",
55
"keywords": [
66
"reflection",

0 commit comments

Comments
 (0)