Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #38

Merged
merged 2 commits into from
Oct 6, 2021
Merged

Update README.md #38

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c053dd1
Update README.md
shule727 Oct 4, 2021
c06b18f
change we to you
shule727 Oct 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Purgatory
=========

Purgatory is extension which makes it possible for Symfony applications to handle enormous load using minimal infrastructure.
Purgatory is an extension which makes it possible for Symfony applications to handle enormous load using minimal infrastructure.
Infrastructure meant to be used with this bundle along with Symfony application is a HTTP caching reverse proxy.

This bundle implements an easy and maintainable way to invalidate cache on an endpoints based on changes in Doctrine entities.
This bundle implements an easy and maintainable way to invalidate cache on endpoints based on changes in Doctrine entities.

Installation
------------
Expand Down Expand Up @@ -49,7 +49,7 @@ purgatory:
Usage
-----

Suppose we have a simple entity and controller.
Suppose you have a simple entity and controller.

```php
namespace App\Entity;
Expand Down Expand Up @@ -118,8 +118,8 @@ class PostController extends AbstractController
}
```

When we send request on an endpoint for first time, reverse proxy saves the response and serves the same response until
it expires (1 hour in this example). If the state of an entity changes in the meantime, content on our website stays the
When a request is sent to an endpoint for first time, reverse proxy saves the response and serves the same response until
it expires (1 hour in this example). If the state of an entity changes in the meantime, content on the website stays the
same until cache expires.

Purgatory has an annotation which defines rules for cache invalidation when a state of an object changes.
Expand All @@ -142,13 +142,13 @@ Parameters:
- defines an associative array where keys are route parameters and values are property names.
- `properties`
- list of properties which are required to change in order to purge the endpoint.
- if omitted, change of any property purges the cache
- if omitted, change of any property purges the cache.
- `if`
- an expression which has to be true in order to purge the endpoint with specified parameters.

Workflow
--------
When property of `Post` entity is changed and flushed to database, Purgatory goes through PurgeOn annotations where changed property is in list of properties, checks the `if` expression, injects the parameters and purges the route.
When property of `Post` entity is changed and flushed to a database, Purgatory goes through PurgeOn annotations where changed property is in list of properties, checks the `if` expression, injects the parameters and purges the route.

Custom Purger
---------
Expand Down Expand Up @@ -211,7 +211,7 @@ Examples
Endpoint which fetches all properties of a single post.

Use `PurgeOn` with FQCN and map route parameters with property of an entity.
On change of any property of a post, endpoint with entity id injected as route parameter `postId` gets invalidated.
On change of any property of a `Post`, endpoint with entity `id` injected as route parameter `postId` gets invalidated.
```php
/**
* @Route("/{postId<\d+>}", methods={"GET"})
Expand All @@ -221,7 +221,7 @@ On change of any property of a post, endpoint with entity id injected as route p
```
Endpoint which fetches all featured Posts.

Use `PurgeOn` and specify a single property - cache invalidation happens every time when property `featured` changes on any of the posts.
Use `PurgeOn` and specify a single property - cache invalidation happens every time property `featured` changes on any of the `Posts`.

```php
/**
Expand All @@ -232,7 +232,7 @@ Use `PurgeOn` and specify a single property - cache invalidation happens every t
```
Endpoint which fetches a list of all popular posts with more than 3000 upvotes.

Use `PurgeOn` with a condition - cache invalidation happens every time when any of the properties on a Post with more than 3000 upvotes changes.
Use `PurgeOn` with a condition - cache invalidation happens every time property `upvotes` on a `Post` with more than 3000 upvotes changes.
```php
/**
* @Route("/popular", methods={"GET"})
Expand All @@ -247,7 +247,7 @@ Debugging
php bin/console purgatory:debug Post
```
Purgatory debug command groups all defined purging rules and dumps it on the screen.
Its argument is an entity name or entity and property
Its argument is an entity name or entity and property.
```bash
php bin/console purgatory:debug Post::upvotes
```
Expand Down