Initial release

Moved package to the individual repository

Author: Anton Shevchuk

LICENSE LICENSE.mdLICENSE renamed to LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Bluz Framework
+Copyright (c) Bluz Framework
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -0,0 +1,59 @@
+# Container Component
+## Achievements
+
+[![PHP >= 8.0+](https://img.shields.io/packagist/php-v/bluzphp/container.svg?style=flat)](https://php.net/)
+
+[![Latest Stable Version](https://img.shields.io/packagist/v/bluzphp/container.svg?label=version&style=flat)](https://packagist.org/packages/bluzphp/container)
+
+[![Build Status](https://img.shields.io/scrutinizer/build/g/bluzphp/container)](https://scrutinizer-ci.com/g/bluzphp/container/build-status/master)
+
+[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/bluzphp/container.svg?style=flat)](https://scrutinizer-ci.com/g/bluzphp/container/)
+
+[![Total Downloads](https://img.shields.io/packagist/dt/bluzphp/container.svg?style=flat)](https://packagist.org/packages/bluzphp/container)
+
+[![License](https://img.shields.io/packagist/l/bluzphp/container.svg?style=flat)](https://packagist.org/packages/bluzphp/container)
+
+## Usage
+
+Example of the Registry class:
+
+```
+namespace Bluz\Registry;
+
+use Bluz\Container;
+
+class Registry {
+    use Container\Container;
+    use Container\JsonSerialize;
+    use Container\RegularAccess;
+}
+```
+
+### Methods
+
+Trait `Container\Container`:
+
+* `setFromArray(array $data)`
+* `toArray()`
+* `resetArray()`
+
+Methods of the `Container\ArrayAccess` (implementation of the interface `ArrayAccess`):
+* `offsetSet($offset, $value)`
+* `offsetExists($offset)`
+* `offsetUnset($offset)`
+* `offsetGet($offset)`
+
+Methods of the  `Container\MagicAccess`:
+* `__set($key, $value)`
+* `__get($key)`
+* `__isset($key)`
+* `__unset($key)`
+
+Methods of the `Container\RegularAccess`:
+* `set($key, $value)`
+* `get($key)` - implementation of the PSR-11: Container interface
+* `has($key)` - implementation of the PSR-11: Container interface
+* `remove($key)`
+
+Methods of the `Container\JsonSerialize`
+* `jsonSerialize()` - implementation of the interface `JsonSerializable`

composer.json

@@ -0,0 +1,35 @@
+{
+    "name": "bluzphp/container",
+    "description": "Container package",
+    "type": "library",
+    "require": {
+        "php": ">=8.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "~9.5",
+        "php-coveralls/php-coveralls": "~2.5",
+        "squizlabs/php_codesniffer": "~3.7",
+        "phploc/phploc": "~7.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Bluz\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Bluz\\Tests\\": "tests/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Bluz Framework Contributors",
+            "homepage": "https://github.com/bluzphp/framework/graphs/contributors"
+        }
+    ],
+    "support": {
+        "issues": "https://github.com/bluzphp/framework/issues",
+        "wiki": "https://github.com/bluzphp/framework/wiki"
+    },
+    "license": "MIT"
+}

phpunit.xml.dist

@@ -0,0 +1,23 @@
+<?xml version="1.0"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         stopOnFailure="false"
+         colors="true"
+         verbose="true"
+         bootstrap="./tests/_bootstrap.php" >
+  <coverage processUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">./src/</directory>
+    </include>
+    <exclude>
+      <directory suffix=".php">./vendor/</directory>
+    </exclude>
+  </coverage>
+  <testsuites>
+    <testsuite name="Container Test Suite">
+      <directory>./tests/</directory>
+    </testsuite>
+  </testsuites>
+</phpunit>

src/Container/ArrayAccess.php

@@ -0,0 +1,79 @@
+<?php
+
+/**
+ * Bluz Framework Component
+ *
+ * @copyright Bluz PHP Team
+ * @link      https://github.com/bluzphp/framework
+ */
+
+declare(strict_types=1);
+
+namespace Bluz\Container;
+
+use InvalidArgumentException;
+
+/**
+ * Container implements ArrayAccess
+ *
+ * @package  Bluz\Common
+ * @author   Anton Shevchuk
+ * @see      ArrayAccess
+ *
+ * @method   void  doSetContainer(string $key, mixed $value)
+ * @method   mixed doGetContainer(string $key)
+ * @method   bool  doContainsContainer(string $key)
+ * @method   void  doDeleteContainer(string $key)
+ */
+trait ArrayAccess
+{
+    /**
+     * Offset to set
+     *
+     * @param  mixed $offset
+     * @param  mixed $value
+     *
+     * @throws InvalidArgumentException
+     */
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
+        if (null === $offset) {
+            throw new InvalidArgumentException('Class `Common\Container\ArrayAccess` support only associative arrays');
+        }
+        $this->doSetContainer($offset, $value);
+    }
+
+    /**
+     * Offset to retrieve
+     *
+     * @param  mixed $offset
+     *
+     * @return mixed
+     */
+    public function offsetGet(mixed $offset): mixed
+    {
+        return $this->doGetContainer($offset);
+    }
+
+    /**
+     * Whether a offset exists
+     *
+     * @param  mixed $offset
+     *
+     * @return bool
+     */
+    public function offsetExists(mixed $offset): bool
+    {
+        return $this->doContainsContainer($offset);
+    }
+
+    /**
+     * Offset to unset
+     *
+     * @param mixed $offset
+     */
+    public function offsetUnset(mixed $offset): void
+    {
+        $this->doDeleteContainer($offset);
+    }
+}

src/Container/Container.php

@@ -0,0 +1,115 @@
+<?php
+
+/**
+ * Bluz Framework Component
+ *
+ * @copyright Bluz PHP Team
+ * @link      https://github.com/bluzphp/framework
+ */
+
+declare(strict_types=1);
+
+namespace Bluz\Container;
+
+/**
+ * Container of data for object
+ *
+ * @package  Bluz\Common
+ * @author   Anton Shevchuk
+ * @link     https://github.com/bluzphp/framework/wiki/Trait-Container
+ */
+trait Container
+{
+    /**
+     * @var array Container of elements
+     */
+    protected array $container = [];
+
+    /**
+     * Set key/value pair
+     *
+     * @param string $key
+     * @param  mixed  $value
+     *
+     * @return void
+     */
+    protected function doSetContainer(string $key, mixed $value): void
+    {
+        $this->container[$key] = $value;
+    }
+
+    /**
+     * Get value by key
+     *
+     * @param string $key
+     *
+     * @return mixed
+     */
+    protected function doGetContainer(string $key): mixed
+    {
+        if ($this->doContainsContainer($key)) {
+            return $this->container[$key];
+        }
+        return null;
+    }
+
+    /**
+     * Check contains key in container
+     *
+     * @param string $key
+     *
+     * @return bool
+     */
+    protected function doContainsContainer(string $key): bool
+    {
+        return array_key_exists($key, $this->container);
+    }
+
+    /**
+     * Delete value by key
+     *
+     * @param string $key
+     *
+     * @return void
+     */
+    protected function doDeleteContainer(string $key): void
+    {
+        unset($this->container[$key]);
+    }
+
+    /**
+     * Sets all data in the row from an array
+     *
+     * @param  array $data
+     *
+     * @return void
+     */
+    public function setFromArray(array $data): void
+    {
+        foreach ($data as $key => $value) {
+            $this->container[$key] = $value;
+        }
+    }
+
+    /**
+     * Returns the column/value data as an array
+     *
+     * @return array
+     */
+    public function toArray(): array
+    {
+        return $this->container;
+    }
+
+    /**
+     * Reset container array
+     *
+     * @return void
+     */
+    public function resetArray(): void
+    {
+        foreach ($this->container as &$value) {
+            $value = null;
+        }
+    }
+}

src/Container/JsonSerialize.php

@@ -0,0 +1,32 @@
+<?php
+
+/**
+ * Bluz Framework Component
+ *
+ * @copyright Bluz PHP Team
+ * @link      https://github.com/bluzphp/framework
+ */
+
+declare(strict_types=1);
+
+namespace Bluz\Container;
+
+/**
+ * Container implements JsonSerializable interface
+ *
+ * @package  Bluz\Common
+ * @author   Anton Shevchuk
+ * @see      JsonSerializable
+ */
+trait JsonSerialize
+{
+    /**
+     * Specify data which should be serialized to JSON
+     *
+     * @return array
+     */
+    public function jsonSerialize(): mixed
+    {
+        return $this->toArray();
+    }
+}