From cd3e35008548e5ce81e000d6d5b5a4b20456a679 Mon Sep 17 00:00:00 2001
From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com>
Date: Mon, 15 Apr 2024 09:09:55 -0300
Subject: [PATCH 01/10] Docs folder standardization and other fixes
---
README.md | 2 +-
docs/internals.md | 2 +-
psalm.xml | 2 +-
psalm80.xml | 2 +-
src/Memcached.php | 4 ++--
5 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index d024637..1ae9d7e 100644
--- a/README.md
+++ b/README.md
@@ -30,7 +30,7 @@ a distributed applications (e.g. with several servers, load balancers, etc.).
The package could be installed with composer:
-```
+```shell
composer require yiisoft/cache-memcached
```
diff --git a/docs/internals.md b/docs/internals.md
index 40fe5c5..e07cdc1 100644
--- a/docs/internals.md
+++ b/docs/internals.md
@@ -13,7 +13,7 @@ docker run --rm --name yiisoft-cache-memcached-cache --detach --publish 11211:11
Memcached must be accessible by address `127.0.0.1`. If you use PHP via docker container, run PHP container in network
of memcached container. Use `docker run` command argument for it:
-```
+```dockerfile
--network container:yiisoft-cache-memcached-cache
```
diff --git a/psalm.xml b/psalm.xml
index b48c894..c338142 100644
--- a/psalm.xml
+++ b/psalm.xml
@@ -3,7 +3,7 @@
errorLevel="1"
findUnusedBaselineEntry="true"
findUnusedCode="false"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
xmlns="https://getpsalm.org/schema/config"
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
>
diff --git a/psalm80.xml b/psalm80.xml
index d091d59..2c7c1f8 100644
--- a/psalm80.xml
+++ b/psalm80.xml
@@ -3,7 +3,7 @@
errorLevel="1"
findUnusedBaselineEntry="true"
findUnusedCode="false"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
xmlns="https://getpsalm.org/schema/config"
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
>
diff --git a/src/Memcached.php b/src/Memcached.php
index 5ab6de2..f282f11 100644
--- a/src/Memcached.php
+++ b/src/Memcached.php
@@ -20,7 +20,7 @@
/**
* Memcached implements a cache application component based on
- * [memcached](http://pecl.php.net/package/memcached) PECL extension.
+ * [memcached](https://pecl.php.net/package/memcached) PECL extension.
*
* Memcached can be configured with a list of memcached servers passed to the constructor.
* By default, Memcached assumes there is a memcached server running on localhost at port 11211.
@@ -251,7 +251,7 @@ private function normalizeServers(array $servers): array
) {
throw new InvalidArgumentException(
'Each entry in servers parameter is supposed to be an array'
- . ' containing hostname (string), port (int), and, optionally, weight (int) of the server.',
+ . ' containing hostname (string), port (int), and, optionally, weight (int) of the server.',
);
}
/**
From e3662ddca53cf8be848e79dbca432955565c8c20 Mon Sep 17 00:00:00 2001
From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com>
Date: Mon, 15 Apr 2024 11:32:09 -0300
Subject: [PATCH 02/10] Update internals.md
---
docs/internals.md | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/docs/internals.md b/docs/internals.md
index e07cdc1..0585da7 100644
--- a/docs/internals.md
+++ b/docs/internals.md
@@ -55,3 +55,9 @@ use either newest or any specific version of PHP:
Use [ComposerRequireChecker](https://github.com/maglnet/ComposerRequireChecker) to detect transitive
[Composer](https://getcomposer.org/) dependencies.
+
+To run the checker, execute the following command:
+
+```shell
+./vendor/bin/composer-require-checker
+```
From a7c837cd12f4f9197886262c2b99439029a22c50 Mon Sep 17 00:00:00 2001
From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com>
Date: Mon, 15 Apr 2024 11:52:57 -0300
Subject: [PATCH 03/10] Update internals.md
---
docs/internals.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/internals.md b/docs/internals.md
index 0585da7..7d237a2 100644
--- a/docs/internals.md
+++ b/docs/internals.md
@@ -42,7 +42,7 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static
./vendor/bin/psalm
```
-## Code style
+## Rector
Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or
use either newest or any specific version of PHP:
From cbf8014e57679c8caa2be71ffbbe63f45ad99f06 Mon Sep 17 00:00:00 2001
From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com>
Date: Mon, 15 Apr 2024 12:29:29 -0300
Subject: [PATCH 04/10] Update internals.md
---
docs/internals.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/internals.md b/docs/internals.md
index 7d237a2..fa49c67 100644
--- a/docs/internals.md
+++ b/docs/internals.md
@@ -6,7 +6,7 @@ For greater ease it is recommended to use docker containers.
Run container with memcached directly via command:
-```shell
+```dockerfile
docker run --rm --name yiisoft-cache-memcached-cache --detach --publish 11211:11211 memcached:1.6.23
```
From ec1a9b4fcdae45f59db338f2025945f987cac21f Mon Sep 17 00:00:00 2001
From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com>
Date: Wed, 17 Apr 2024 10:06:02 -0300
Subject: [PATCH 05/10] IRC link fix
---
README.md | 2 +-
composer.json | 2 +-
psalm.xml | 2 +-
psalm80.xml | 2 +-
4 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 1ae9d7e..116af4d 100644
--- a/README.md
+++ b/README.md
@@ -126,7 +126,7 @@ This package can be used as a cache handler for the [Yii Caching Library](https:
## Documentation
-- [Internals](docs/internals.md)
+More information can be found in the [Internals](docs/internals.md).
## License
diff --git a/composer.json b/composer.json
index 4a57f31..3a6363b 100644
--- a/composer.json
+++ b/composer.json
@@ -15,7 +15,7 @@
"issues": "https://github.com/yiisoft/cache-memcached/issues?state=open",
"forum": "https://www.yiiframework.com/forum/",
"wiki": "https://www.yiiframework.com/wiki/",
- "irc": "irc://irc.freenode.net/yii",
+ "irc": "ircs://irc.libera.chat:6697/yii",
"chat": "https://t.me/yii3en",
"source": "https://github.com/yiisoft/cache-memcached"
},
diff --git a/psalm.xml b/psalm.xml
index c338142..b48c894 100644
--- a/psalm.xml
+++ b/psalm.xml
@@ -3,7 +3,7 @@
errorLevel="1"
findUnusedBaselineEntry="true"
findUnusedCode="false"
- xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://getpsalm.org/schema/config"
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
>
diff --git a/psalm80.xml b/psalm80.xml
index 2c7c1f8..d091d59 100644
--- a/psalm80.xml
+++ b/psalm80.xml
@@ -3,7 +3,7 @@
errorLevel="1"
findUnusedBaselineEntry="true"
findUnusedCode="false"
- xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://getpsalm.org/schema/config"
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
>
From 621687bcfaca555fbc107306f19d461fd9a00d98 Mon Sep 17 00:00:00 2001
From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com>
Date: Thu, 18 Apr 2024 13:39:27 -0300
Subject: [PATCH 06/10] Docs folder standardization and other fixes
---
LICENSE.md | 8 ++++----
README.md | 34 ++++++++++++++++++++++++++++------
docs/internals.md | 22 ++--------------------
3 files changed, 34 insertions(+), 30 deletions(-)
diff --git a/LICENSE.md b/LICENSE.md
index bc5674f..5fbe395 100644
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -1,17 +1,17 @@
-Copyright © 2008 by Yii Software (https://www.yiiframework.com/)
+Copyright © 2008-present by Yii Software ()
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
- * Redistributions of source code must retain the above copyright
+* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright
+* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
- * Neither the name of Yii Software nor the names of its
+* Neither the name of Yii Software nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
diff --git a/README.md b/README.md
index 116af4d..7945b5c 100644
--- a/README.md
+++ b/README.md
@@ -34,6 +34,23 @@ The package could be installed with composer:
composer require yiisoft/cache-memcached
```
+## Development environment
+
+For greater ease it is recommended to use docker containers.
+
+Run container with memcached directly via command:
+
+```dockerfile
+docker run --rm --name yiisoft-cache-memcached-cache --detach --publish 11211:11211 memcached:1.6.23
+```
+
+Memcached must be accessible by address `127.0.0.1`. If you use PHP via docker container, run PHP container in network
+of memcached container. Use `docker run` command argument for it:
+
+```dockerfile
+--network container:yiisoft-cache-memcached-cache
+```
+
## Configuration
Creating an instance:
@@ -126,14 +143,12 @@ This package can be used as a cache handler for the [Yii Caching Library](https:
## Documentation
-More information can be found in the [Internals](docs/internals.md).
-
-## License
+- More information can be found in the [Internals.](docs/internals.md)
-The Yii Cache Library - Memcached Handler is free software. It is released under the terms of the BSD License.
-Please see [`LICENSE`](./LICENSE.md) for more information.
+## Support
-Maintained by [Yii Software](https://www.yiiframework.com/).
+If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
+You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## Support the project
@@ -146,3 +161,10 @@ Maintained by [Yii Software](https://www.yiiframework.com/).
[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)
+
+## License
+
+The Yii Access is free software. It is released under the terms of the BSD License.
+Please see [`LICENSE`](./LICENSE.md) for more information.
+
+Maintained by [Yii Software](https://www.yiiframework.com/).
diff --git a/docs/internals.md b/docs/internals.md
index fa49c67..8dc4049 100644
--- a/docs/internals.md
+++ b/docs/internals.md
@@ -1,22 +1,5 @@
# Internals
-## Development environment
-
-For greater ease it is recommended to use docker containers.
-
-Run container with memcached directly via command:
-
-```dockerfile
-docker run --rm --name yiisoft-cache-memcached-cache --detach --publish 11211:11211 memcached:1.6.23
-```
-
-Memcached must be accessible by address `127.0.0.1`. If you use PHP via docker container, run PHP container in network
-of memcached container. Use `docker run` command argument for it:
-
-```dockerfile
---network container:yiisoft-cache-memcached-cache
-```
-
## Unit testing
The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
@@ -51,10 +34,9 @@ use either newest or any specific version of PHP:
./vendor/bin/rector
```
-## Dependencies
+## Composer require checker
-Use [ComposerRequireChecker](https://github.com/maglnet/ComposerRequireChecker) to detect transitive
-[Composer](https://getcomposer.org/) dependencies.
+This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`.
To run the checker, execute the following command:
From d4b34384856b2367da23043385c9344fa4896451 Mon Sep 17 00:00:00 2001
From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com>
Date: Thu, 18 Apr 2024 18:58:23 -0300
Subject: [PATCH 07/10] Update LICENSE.md
---
LICENSE.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/LICENSE.md b/LICENSE.md
index 5fbe395..6a920d6 100644
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -1,4 +1,4 @@
-Copyright © 2008-present by Yii Software ()
+Copyright © 2008 by Yii Software ()
All rights reserved.
Redistribution and use in source and binary forms, with or without
From db76ab2b695e58b4dad7a687dda47c249f4b5ae7 Mon Sep 17 00:00:00 2001
From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com>
Date: Sat, 20 Apr 2024 07:48:00 -0300
Subject: [PATCH 08/10] Update README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 7945b5c..ea3e87a 100644
--- a/README.md
+++ b/README.md
@@ -164,7 +164,7 @@ You may also check out other [Yii Community Resources](https://www.yiiframework.
## License
-The Yii Access is free software. It is released under the terms of the BSD License.
+The Yii Cache Library - Memcached Handler is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
From 119e55c4fd00e12e57333e85f3640e58c3963431 Mon Sep 17 00:00:00 2001
From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com>
Date: Sun, 21 Apr 2024 06:22:51 -0300
Subject: [PATCH 09/10] Update README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index ea3e87a..e7dd05c 100644
--- a/README.md
+++ b/README.md
@@ -143,7 +143,7 @@ This package can be used as a cache handler for the [Yii Caching Library](https:
## Documentation
-- More information can be found in the [Internals.](docs/internals.md)
+- [Internals](docs/internals.md)
## Support
From ae76b95f151e3ae6e8ca282b133ab1e929cf289a Mon Sep 17 00:00:00 2001
From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com>
Date: Wed, 24 Apr 2024 10:11:39 -0300
Subject: [PATCH 10/10] Update README.md
Co-authored-by: Alexander Makarov
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index e7dd05c..048329f 100644
--- a/README.md
+++ b/README.md
@@ -47,7 +47,7 @@ docker run --rm --name yiisoft-cache-memcached-cache --detach --publish 11211:11
Memcached must be accessible by address `127.0.0.1`. If you use PHP via docker container, run PHP container in network
of memcached container. Use `docker run` command argument for it:
-```dockerfile
+```shell
--network container:yiisoft-cache-memcached-cache
```