Skip to content

Commit be1d365

Browse files
committed
Add deprecation notice, see #243
1 parent a1c08d3 commit be1d365

File tree

3 files changed

+6
-0
lines changed

3 files changed

+6
-0
lines changed

resources/data/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# @deprecated v0.20.0-dev, see https://github.com/hydephp/framework/issues/243
2+
13
Info for Hyde Framework package developers:
24

35
As of now, this data directory only stores one data file, the filecache.json which contains an index of the default files and their checksums. This file is used as per https://github.com/hydephp/framework/issues/67 to let Hyde know if a default file has been modified by the user or if it is safe to overwrite. Note that the checksums use the md5 hash algorithm which is not cryptographically secure and should not be used for anything other than checking if a file has been modified.

resources/data/filecacheGenerator.php

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
<?php
22

33
/**
4+
* @deprecated v0.20.0-dev, see https://github.com/hydephp/framework/issues/243
5+
*
46
* @internal Internal devtool to generate a filecache.json file.
57
* @usage (cli from the data directory) php filecacheGenerator.php
68
*/

src/Services/FileCacheService.php

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
/**
88
* Helper methods to interact with the filecache.json file.
9+
*
10+
* @deprecated v0.20.0-dev, see https://github.com/hydephp/framework/issues/243
911
*/
1012
class FileCacheService
1113
{

0 commit comments

Comments
 (0)