Source code

Author: MekDrop

.editorconfig

@@ -0,0 +1,15 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = false
+charset = utf-8
+indent_style = tab
+trim_trailing_whitespace = true
+tab_width = 4
+
+[{package.json,.travis.yml}]
+indent_style = space
+indent_size = 2

.gitattributes

@@ -0,0 +1,5 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Declare files that will always have LF line endings on checkout.
+*.php text eol=lf

.gitignore

@@ -0,0 +1,3 @@
+/vendor/
+.idea
+composer.lock

.scrutinizer.yml

@@ -0,0 +1,61 @@
+checks:
+    php:
+        duplication: true
+        unused_methods: false
+        unused_parameters: true
+        argument_type_checks: false
+        verify_property_names: false
+        method_calls_on_non_object: true
+        fix_doc_comments: false
+        instanceof_class_exists: false
+        catch_class_exists: false
+        assignment_of_null_return: false
+        use_statement_alias_conflict: false
+tools:
+    php_sim:
+        enabled: true
+        min_mass: 50             # Defaults to 16
+coding_style:
+    php:
+        indentation:
+            general:
+                use_tabs: true
+                size: 4
+            switch:
+                indent_case: true
+        spaces:
+            around_operators:
+                concatenation: true
+            ternary_operator:
+                before_condition: false
+                after_condition: false
+                before_alternative: false
+                after_alternative: false
+        braces:
+            classes_functions:
+                class: end-of-line
+                function: end-of-line
+                closure: end-of-line
+            if:
+                opening: end-of-line
+            for:
+                opening: end-of-line
+            while:
+                opening: end-of-line
+            do_while:
+                opening: end-of-line
+            switch:
+                opening: end-of-line
+            try:
+                opening: end-of-line
+        upper_lower_casing:
+            keywords:
+                general: lower
+            constants:
+                true_false_null: lower
+build:
+    nodes:
+        analysis:
+            tests:
+                override:
+                    - php-scrutinizer-run

README.md

@@ -0,0 +1,46 @@
+[![License](https://img.shields.io/github/license/imponeer/toarray-interface.svg?maxAge=2592000)](LICENSE)
+[![GitHub release](https://img.shields.io/github/release/imponeer/toarray-interface.svg?maxAge=2592000)](https://github.com/imponeer/toarray-interface/releases) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/imponeer/toarray-interface/badges/quality-score.png)](https://scrutinizer-ci.com/g/imponeer/toarray-interface/)
+
+# ToArray Interface
+
+Some long time ago there were [RFC about adding __toArray method into PHP](https://wiki.php.net/rfc/object_cast_to_types). Sadly, this was rejected. [PHP-FIG](https://www.php-fig.org/psr/) doesn't have yet any project about that. And that's why today we have many classes in different frameworks that has toArray method. There are some composer packages that has toArray interface like [illuminate/contracts](https://packagist.org/packages/illuminate/contracts). However these packages are not very good choice if you need only one file with interface from there. In that case they have many things that you do not need. So, that's why we have created small composer library that could be used for such cases.
+
+So, basically this library is only for one thing - it gives interface that could be used when you need to know if object has possibility to be converted to array with `toArray` method.
+
+## Installation
+
+To install and use this package, we recommend to use [Composer](https://getcomposer.org):
+
+```bash
+composer require imponeer/toarray-interface
+```
+
+Otherwise you need to include manualy files from `src/` directory. 
+
+## Example
+
+```php5
+
+use Imponeer/ToArrayInterface;
+
+class DummyObject implements ToArrayInterface {
+
+   /**
+    * Converts object to array
+    *
+    * @return array
+    */
+   public function toArray() {
+      return array(
+      	'hash' => sha1(time())
+      );
+   }
+
+}
+
+$instance = new DummyObject();
+if ($instance instanceof ToArrayInterface) {
+	var_dump($instance->toArray());
+}
+
+```

composer.json

@@ -0,0 +1,24 @@
+{
+	"name": "imponeer/toarray-interface",
+	"description": "PHP library that provides toArray interface, that could be used everywhere where you need to convert object into array and make sure that to that toArray function is because of same interface",
+	"type": "library",
+	"license": "MIT",
+	"keywords": [
+		"toArray",
+		"interface"
+	],
+	"authors": [
+		{
+			"name": "Raimondas Rimkevičius",
+			"email": "github@mekdrop.name"
+		}
+	],
+	"autoload": {
+		"psr-4": {
+			"Imponeer\\": "src/"
+		}
+	},
+	"require": {
+		"php": ">=5.0"
+	}
+}

src/ToArrayInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Imponeer;
+
+/**
+ * Interface to define how object should be converted to array
+ */
+interface ToArrayInterface
+{
+
+	/**
+	 * Converts object to array
+	 *
+	 * @return array
+	 */
+	public function toArray();
+
+}