Merge branch 'develop'

CHANGELOG.md

@@ -79,4 +79,8 @@
 
 ## `2.1.0` at `2023-03-10`
 
-* Replaced ApplicationModel with ApplicationInterface.
+* Replaced ApplicationModel with ApplicationInterface.
+
+## `2.1.1` at `2023-05-14`
+
+* Added interfaces for Arrayable, Importable, SensitiveDataArrayable objects.

composer.json

@@ -2,7 +2,7 @@
     "name": "piggly/php-api-client",
     "description": "A client starter-kit used to interact with any REST API.",
     "minimum-stability": "stable",
-    "version": "2.1.0",
+    "version": "2.1.1",
     "keywords": [
         "piggly",
         "api",

src/Interfaces/Arrayable.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Piggly\ApiClient\Interfaces;
+
+/**
+ * Object that can be converted to array.
+ *
+ * @since 2.1.1
+ * @category Interfaces
+ * @package Piggly\ApiClient
+ * @subpackage Piggly\ApiClient\Interfaces
+ * @author Caique Araujo <caique@piggly.com.br>
+ * @author Piggly Lab <dev@piggly.com.br>
+ * @copyright 2023 Piggly Lab
+ */
+interface Arrayable
+{
+	/**
+	 * Convert object to array.
+	 *
+	 * @return array
+	 * @since 2.1.1
+	 */
+	public function toArray(): array;
+}

src/Interfaces/Importable.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Pgly\PagarMe\Api\Interfaces;
+
+/**
+ * Object that can be imported from an array.
+ *
+ * @since 2.1.1
+ * @category Interfaces
+ * @package Piggly\ApiClient
+ * @subpackage Piggly\ApiClient\Interfaces
+ * @author Caique Araujo <caique@piggly.com.br>
+ * @author Piggly Lab <dev@piggly.com.br>
+ * @copyright 2023 Piggly Lab
+ */
+interface Importable
+{
+	/**
+	 * Import data from an array.
+	 *
+	 * @param array $data
+	 * @return mixed
+	 * @since 2.1.1
+	 */
+	public static function import(array $data);
+}

src/Interfaces/SensitiveDataArrayable.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Piggly\ApiClient\Interfaces;
+
+/**
+ * Object that can be converted to array.
+ *
+ * @since 2.1.1
+ * @category Interfaces
+ * @package Piggly\ApiClient
+ * @subpackage Piggly\ApiClient\Interfaces
+ * @author Caique Araujo <caique@piggly.com.br>
+ * @author Piggly Lab <dev@piggly.com.br>
+ * @copyright 2023 Piggly Lab
+ */
+interface SensitiveDataArrayable
+{
+	/**
+	 * Convert object to a censored array.
+	 * It must hide sensitive data.
+	 *
+	 * @return array
+	 * @since 2.1.1
+	 */
+	public function toCensoredArray(): array;
+}