diff --git a/LICENSE.md b/LICENSE.md index bc5674f..6a920d6 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,17 +1,17 @@ -Copyright © 2008 by Yii Software (https://www.yiiframework.com/) +Copyright © 2008 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 d024637..048329f 100644 --- a/README.md +++ b/README.md @@ -30,10 +30,27 @@ a distributed applications (e.g. with several servers, load balancers, etc.). The package could be installed with composer: -``` +```shell 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: + +```shell +--network container:yiisoft-cache-memcached-cache +``` + ## Configuration Creating an instance: @@ -128,12 +145,10 @@ This package can be used as a cache handler for the [Yii Caching Library](https: - [Internals](docs/internals.md) -## License +## Support -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/). +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 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/). 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/docs/internals.md b/docs/internals.md index 40fe5c5..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: - -```shell -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: - -``` ---network container:yiisoft-cache-memcached-cache -``` - ## Unit testing The package is tested with [PHPUnit](https://phpunit.de/). To run tests: @@ -42,7 +25,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: @@ -51,7 +34,12 @@ use either newest or any specific version of PHP: ./vendor/bin/rector ``` -## Dependencies +## Composer require checker + +This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`. -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 +``` 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.', ); } /**