Completed
Push — V6 ( 8b3c5f...89d552 )
by Georges
02:27
created

Api::getChangelog()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 50
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 4
c 1
b 0
f 0
nc 1
nop 0
dl 0
loc 50
rs 9.3333
1
<?php
2
/**
3
 *
4
 * This file is part of phpFastCache.
5
 *
6
 * @license MIT License (MIT)
7
 *
8
 * For full copyright and license information, please see the docs/CREDITS.txt file.
9
 *
10
 * @author Khoa Bui (khoaofgod)  <[email protected]> http://www.phpfastcache.com
11
 * @author Georges.L (Geolim4)  <[email protected]>
12
 *
13
 */
14
15
namespace phpFastCache;
16
17
/**
18
 * Class Api
19
 * @package phpFastCache
20
 */
21
class Api
22
{
23
    protected static $version = '1.2.3';
24
25
    /**
26
     * This method will returns the current
27
     * API version, the API version will be
28
     * updated by following the semantic versioning
29
     * based on changes of:
30
     * - ExtendedCacheItemPoolInterface
31
     * - ExtendedCacheItemInterface
32
     *
33
     * @see  http://semver.org/
34
     * @return string
35
     */
36
    public static function getVersion()
37
    {
38
        return self::$version;
39
    }
40
41
    /**
42
     * Return the API changelog, as a string.
43
     * @return string
44
     */
45
    public static function getChangelog()
46
    {
47
        return <<<CHANGELOG
48
- 1.2.3
49
-- Implemented additional saving method form multiple items:
50
   ExtendedCacheItemPoolInterface::saveMultiple()
51
52
- 1.2.2
53
-- Implemented additional tags methods such as:
54
   ExtendedCacheItemPoolInterface::getItemsByTagsAll()
55
   ExtendedCacheItemPoolInterface::incrementItemsByTagsAll()
56
   ExtendedCacheItemPoolInterface::decrementItemsByTagsAll()
57
   ExtendedCacheItemPoolInterface::deleteItemsByTagsAll()
58
   ExtendedCacheItemPoolInterface::appendItemsByTagsAll()
59
   ExtendedCacheItemPoolInterface::prependItemsByTagsAll()
60
61
- 1.2.1
62
-- Implemented Event manager methods such as:
63
   ExtendedCacheItemInterface::setEventManager()
64
   ExtendedCacheItemPoolInterface::setEventManager()
65
66
- 1.2.0
67
-- Implemented Item advanced time methods such as:
68
   ExtendedCacheItemInterface::setExpirationDate() (Alias of CacheItemInterface::ExpireAt() for more code logic)
69
   ExtendedCacheItemInterface::getCreationDate() * 
70
   ExtendedCacheItemInterface::getModificationDate() *
71
   ExtendedCacheItemInterface::setCreationDate(\DateTimeInterface) *
72
   ExtendedCacheItemInterface::setModificationDate() *
73
   * Require configuration directive "itemDetailedDate" to be enabled
74
75
- 1.1.2
76
-- Implemented [de|a]ttaching methods to improve memory management
77
   ExtendedCacheItemPoolInterface::detachItem()
78
   ExtendedCacheItemPoolInterface::detachAllItems()
79
   ExtendedCacheItemPoolInterface::attachItem()
80
   ExtendedCacheItemPoolInterface::isAttached()
81
82
- 1.1.1
83
-- Implemented JsonSerializable interface to ExtendedCacheItemInterface
84
85
- 1.1.0
86
-- Implemented JSON methods such as:
87
   ExtendedCacheItemPoolInterface::getItemsAsJsonString()
88
   ExtendedCacheItemPoolInterface::getItemsByTagsAsJsonString()
89
   ExtendedCacheItemInterface::getDataAsJsonString()
90
91
- 1.0.0
92
-- First initial version
93
CHANGELOG;
94
    }
95
}