Skip to content

Commit 2e2931b

Browse files
Geolim4Geolim4
committed
Updatyed lists in events.md
1 parent 2f0d62e commit 2e2931b

File tree

1 file changed

+116
-116
lines changed

1 file changed

+116
-116
lines changed

‎docs/EVENTS.md‎

Lines changed: 116 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -38,139 +38,139 @@ EventManager::getInstance()->unbindEventCallback('onCacheGetItem', 'myCallbackNa
3838
List of active events:
3939

4040
- onCacheGetItem(*Callable* **$callback**)
41-
- **Callback arguments**
42-
- *ExtendedCacheItemPoolInterface* **$itemPool**
43-
- *ExtendedCacheItemInterface* **$item**
44-
- **Scope**
45-
- ItemPool
46-
- **Description**
47-
- Allow you to manipulate an item just before it gets returned by the getItem() method.
48-
- **Risky Circular Methods**
49-
- *ExtendedCacheItemPoolInterface::getItem()*
50-
- *ExtendedCacheItemPoolInterface::getItems()*
51-
- *ExtendedCacheItemPoolInterface::getItemsByTag()*
52-
- *ExtendedCacheItemPoolInterface::getItemsAsJsonString()*
41+
- **Callback arguments**
42+
- *ExtendedCacheItemPoolInterface* **$itemPool**
43+
- *ExtendedCacheItemInterface* **$item**
44+
- **Scope**
45+
- ItemPool
46+
- **Description**
47+
- Allow you to manipulate an item just before it gets returned by the getItem() method.
48+
- **Risky Circular Methods**
49+
- *ExtendedCacheItemPoolInterface::getItem()*
50+
- *ExtendedCacheItemPoolInterface::getItems()*
51+
- *ExtendedCacheItemPoolInterface::getItemsByTag()*
52+
- *ExtendedCacheItemPoolInterface::getItemsAsJsonString()*
5353

5454
- onCacheDeleteItem(*Callable* **$callback**)
55-
- **Callback arguments**
56-
- *ExtendedCacheItemPoolInterface* **$itemPool**
57-
- *ExtendedCacheItemInterface* **$item**
58-
- **Scope**
59-
- ItemPool
60-
- **Description**
61-
- Allow you to manipulate an item after being deleted. :exclamation: **Caution** The provided item is in pool detached-state.
62-
- **Risky Circular Methods**
63-
- *ExtendedCacheItemPoolInterface::deleteItem()*
64-
- *ExtendedCacheItemPoolInterface::getItem()*
65-
- *ExtendedCacheItemPoolInterface::getItems()*
66-
- *ExtendedCacheItemPoolInterface::getItemsByTag()*
67-
- *ExtendedCacheItemPoolInterface::getItemsAsJsonString()*
55+
- **Callback arguments**
56+
- *ExtendedCacheItemPoolInterface* **$itemPool**
57+
- *ExtendedCacheItemInterface* **$item**
58+
- **Scope**
59+
- ItemPool
60+
- **Description**
61+
- Allow you to manipulate an item after being deleted. :exclamation: **Caution** The provided item is in pool detached-state.
62+
- **Risky Circular Methods**
63+
- *ExtendedCacheItemPoolInterface::deleteItem()*
64+
- *ExtendedCacheItemPoolInterface::getItem()*
65+
- *ExtendedCacheItemPoolInterface::getItems()*
66+
- *ExtendedCacheItemPoolInterface::getItemsByTag()*
67+
- *ExtendedCacheItemPoolInterface::getItemsAsJsonString()*
6868

6969
- onCacheSaveItem(*Callable* **$callback**)
70-
- **Callback arguments**
71-
- *ExtendedCacheItemPoolInterface* **$itemPool**
72-
- *ExtendedCacheItemInterface* **$item**
73-
- **Scope**
74-
- ItemPool
75-
- **Description**
76-
- Allow you to manipulate an item just before it gets saved by the driver.
77-
- **Risky Circular Methods**
78-
- *ExtendedCacheItemPoolInterface::commit()*
79-
- *ExtendedCacheItemPoolInterface::save()*
70+
- **Callback arguments**
71+
- *ExtendedCacheItemPoolInterface* **$itemPool**
72+
- *ExtendedCacheItemInterface* **$item**
73+
- **Scope**
74+
- ItemPool
75+
- **Description**
76+
- Allow you to manipulate an item just before it gets saved by the driver.
77+
- **Risky Circular Methods**
78+
- *ExtendedCacheItemPoolInterface::commit()*
79+
- *ExtendedCacheItemPoolInterface::save()*
8080

8181
- onCacheSaveDeferredItem(*Callable* **$callback**)
82-
- **Callback arguments**
83-
- *ExtendedCacheItemPoolInterface* **$itemPool**
84-
- *ExtendedCacheItemInterface* **$item**
85-
- **Scope**
86-
- ItemPool
87-
- **Description**
88-
- Allow you to manipulate an item just before it gets pre-saved by the driver.
89-
- **Risky Circular Methods**
90-
- *ExtendedCacheItemPoolInterface::saveDeferred()*
82+
- **Callback arguments**
83+
- *ExtendedCacheItemPoolInterface* **$itemPool**
84+
- *ExtendedCacheItemInterface* **$item**
85+
- **Scope**
86+
- ItemPool
87+
- **Description**
88+
- Allow you to manipulate an item just before it gets pre-saved by the driver.
89+
- **Risky Circular Methods**
90+
- *ExtendedCacheItemPoolInterface::saveDeferred()*
9191

9292
- onCacheCommitItem(*Callable* **$callback**)
93-
- **Callback arguments**
94-
- *ExtendedCacheItemPoolInterface* **$itemPool**
95-
- *ExtendedCacheItemInterface[]* **$items**
96-
- **Scope**
97-
- ItemPool
98-
- **Description**
99-
- Allow you to manipulate a set of items just before they gets pre-saved by the driver.
100-
- **Risky Circular Methods**
101-
- *ExtendedCacheItemPoolInterface::commit()*
93+
- **Callback arguments**
94+
- *ExtendedCacheItemPoolInterface* **$itemPool**
95+
- *ExtendedCacheItemInterface[]* **$items**
96+
- **Scope**
97+
- ItemPool
98+
- **Description**
99+
- Allow you to manipulate a set of items just before they gets pre-saved by the driver.
100+
- **Risky Circular Methods**
101+
- *ExtendedCacheItemPoolInterface::commit()*
102102

103103
- onCacheClearItem(*Callable* **$callback**)
104-
- **Callback arguments**
105-
- *ExtendedCacheItemPoolInterface* **$itemPool**
106-
- *ExtendedCacheItemInterface[]* **$items**
107-
- **Scope**
108-
- ItemPool
109-
- **Description**
110-
- Allow you to manipulate a set of item just before they gets cleared by the driver.
111-
- **Risky Circular Methods**
112-
- *ExtendedCacheItemPoolInterface::clear()*
113-
- *ExtendedCacheItemPoolInterface::clean()*
114-
115-
- onCacheWriteFileOnDisk(*Callable* **$callback**)
116-
- **Callback arguments**
117-
- *ExtendedCacheItemPoolInterface* **$itemPool**
118-
- *string* **$file**
119-
- *bool* **$secureFileManipulation**
120-
- **Scope**
121-
- ItemPool
122-
- **Description**
123-
- Allow you to get notified when a file is written on disk.
124-
- **Risky Circular Methods**
125-
- *ExtendedCacheItemPoolInterface::writefile()*
104+
- **Callback arguments**
105+
- *ExtendedCacheItemPoolInterface* **$itemPool**
106+
- *ExtendedCacheItemInterface[]* **$items**
107+
- **Scope**
108+
- ItemPool
109+
- **Description**
110+
- Allow you to manipulate a set of item just before they gets cleared by the driver.
111+
- **Risky Circular Methods**
112+
- *ExtendedCacheItemPoolInterface::clear()*
113+
- *ExtendedCacheItemPoolInterface::clean()*
114+
115+
- onCacheWriteFileOnDisk(*Callable* **$callback**)
116+
- **Callback arguments**
117+
- *ExtendedCacheItemPoolInterface* **$itemPool**
118+
- *string* **$file**
119+
- *bool* **$secureFileManipulation**
120+
- **Scope**
121+
- ItemPool
122+
- **Description**
123+
- Allow you to get notified when a file is written on disk.
124+
- **Risky Circular Methods**
125+
- *ExtendedCacheItemPoolInterface::writefile()*
126126

127127
- onCacheGetItemInSlamBatch(*Callable* **$callback**)
128-
- **Callback arguments**
129-
- *ExtendedCacheItemPoolInterface* **$itemPool**
130-
- *ItemBatch* **$driverData**
131-
- *int* **$cacheSlamsSpendSeconds**
132-
- **Scope**
133-
- ItemPool
134-
- **Description**
135-
- Allow you to get notified each time a batch loop is looping
136-
- **Risky Circular Methods**
137-
- *ExtendedCacheItemPoolInterface::deleteItem()*
138-
- *ExtendedCacheItemPoolInterface::getItem()*
139-
- *ExtendedCacheItemPoolInterface::getItems()*
140-
- *ExtendedCacheItemPoolInterface::getItemsByTag()*
141-
- *ExtendedCacheItemPoolInterface::getItemsAsJsonString()*
128+
- **Callback arguments**
129+
- *ExtendedCacheItemPoolInterface* **$itemPool**
130+
- *ItemBatch* **$driverData**
131+
- *int* **$cacheSlamsSpendSeconds**
132+
- **Scope**
133+
- ItemPool
134+
- **Description**
135+
- Allow you to get notified each time a batch loop is looping
136+
- **Risky Circular Methods**
137+
- *ExtendedCacheItemPoolInterface::deleteItem()*
138+
- *ExtendedCacheItemPoolInterface::getItem()*
139+
- *ExtendedCacheItemPoolInterface::getItems()*
140+
- *ExtendedCacheItemPoolInterface::getItemsByTag()*
141+
- *ExtendedCacheItemPoolInterface::getItemsAsJsonString()*
142142

143143
- onCacheItemSet(*Callable* **$callback**)
144-
- **Callback arguments**
145-
- *ExtendedCacheItemInterface* **$item**
146-
- *mixed* **$value**
147-
- **Scope**
148-
- Item
149-
- **Description**
150-
- Allow you to get the value set to an item.
151-
- **Risky Circular Methods**
152-
- *ExtendedCacheItemInterface::get()*
144+
- **Callback arguments**
145+
- *ExtendedCacheItemInterface* **$item**
146+
- *mixed* **$value**
147+
- **Scope**
148+
- Item
149+
- **Description**
150+
- Allow you to get the value set to an item.
151+
- **Risky Circular Methods**
152+
- *ExtendedCacheItemInterface::get()*
153153

154154
- onCacheItemExpireAt(*Callable* **$callback**)
155-
- **Callback arguments**
156-
- *ExtendedCacheItemInterface* **$item**
157-
- *\DateTimeInterface* **$expiration**
158-
- **Scope**
159-
- Item
160-
- **Description**
161-
- Allow you to get/set the expiration date of an item.
162-
- **Risky Circular Methods**
163-
- *ExtendedCacheItemInterface::expiresAt()*
155+
- **Callback arguments**
156+
- *ExtendedCacheItemInterface* **$item**
157+
- *\DateTimeInterface* **$expiration**
158+
- **Scope**
159+
- Item
160+
- **Description**
161+
- Allow you to get/set the expiration date of an item.
162+
- **Risky Circular Methods**
163+
- *ExtendedCacheItemInterface::expiresAt()*
164164

165165
- onCacheItemExpireAfter(*Callable* **$callback**)
166-
- **Callback arguments**
167-
- *ExtendedCacheItemInterface* **$item**
168-
- *int | \DateInterval* **$time**
169-
- **Scope**
170-
- Item
171-
- **Description**
172-
- Allow you to get the "expire after" time of an item. If `$time` is a DateInterval you also set it.
173-
- **Risky Circular Methods**
174-
- *ExtendedCacheItemInterface::expiresAt()*
166+
- **Callback arguments**
167+
- *ExtendedCacheItemInterface* **$item**
168+
- *int | \DateInterval* **$time**
169+
- **Scope**
170+
- Item
171+
- **Description**
172+
- Allow you to get the "expire after" time of an item. If `$time` is a DateInterval you also set it.
173+
- **Risky Circular Methods**
174+
- *ExtendedCacheItemInterface::expiresAt()*
175175

176176
This is an exhaustive list and it will be updated as soon as new events will be added to the Core.

0 commit comments

Comments
 (0)