initial commit

Author: Flaviu Chelaru

.gitignore

@@ -0,0 +1,3 @@
+.idea/
+
+!**/.gitkeep

README.md

@@ -1,2 +1,55 @@
-# phalcon-nested-sets
-Nested Set Model implementation for Phalcon Framework
+Nested Set Behaviour
+--- 
+
+Phalcon implementation for tree / hierarchy through nested sets implementation.
+It will calculate edges and depth for a category on creation, update and delete.
+
+Moving "branches" is not supported (o sub-node with all it's sub-nodes) and won't be. This tool is meant to "react" to changes on a single record and keep the rest of the tree position in place.
+
+prerequisites
+---
+Your DB must have parent, left, right, depth columns. 
+Example:
+
+```SQL
+CREATE TABLE `categories` (
+	`id` INT(11) NOT NULL AUTO_INCREMENT,
+	`name` CHAR(50) NULL DEFAULT NULL,
+	`parent_id` INT(11) NULL DEFAULT NULL,
+	`_left` INT(11) NULL DEFAULT NULL,
+	`_right` INT(11) NULL DEFAULT NULL,
+	`_depth` INT(11) NULL DEFAULT NULL,
+	PRIMARY KEY (`id`)
+);
+```
+
+usage
+---
+
+```php
+
+class MyModel extends \Phalcon\Mvc\Model {
+    public function initialize() {
+        $this->addBehaviour(new \P4BGroup\NestedSets\Behaviour());
+    }
+}
+
+```
+
+references
+---
+* https://en.wikipedia.org/wiki/Nested_set_model
+* https://explainextended.com/2009/09/29/adjacency-list-vs-nested-sets-mysql/
+* https://medium.com/@Sumurai8/nested-sets-performant-attribute-calculation-on-collections-10289a30c0ab
+
+usage
+---
+this behaviour will automatically calculate the edges and depth of each node on save / delete
+
+Similar implementations on other frameworks
+---
+* https://github.com/etrepat/baum - laravel 
+* https://github.com/lazychaser/laravel-nestedset - laravel 
+* https://github.com/blt04/doctrine2-nestedset - doctrine
+* https://github.com/bartko-s/stefano-tree - zend / pdo
+* https://github.com/creocoder/yii2-nested-sets - yii

composer.json

@@ -0,0 +1,46 @@
+{
+  "name": "p4bgroup/phalcon-nested-sets",
+  "type": "library",
+  "description": "Phalcon Nested Set Models. Nested set models for Phalcon Framework",
+  "keywords": [
+    "phalcon",
+    "nested set",
+    "tree",
+    "hierarchy",
+    "mysql",
+    "sqlite",
+    "mssql",
+    "pdo"
+  ],
+  "license": "MIT",
+  "require": {
+    "php": ">= 7.2",
+    "ext-pdo": "*",
+    "ext-phalcon": "^3.4"
+  },
+  "require-dev": {
+    "phalcon/ide-stubs": "^3.4",
+    "phpmd/phpmd": "^2.6",
+    "phpunit/phpunit": "~8.4",
+    "roave/security-advisories": "dev-master",
+    "squizlabs/php_codesniffer": "^3.3"
+  },
+  "autoload": {
+    "psr-4": {
+      "P4BGroup\\NestedSets\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "P4BGroup\\NestedSets\\tests\\": "tests/"
+    }
+  },
+  "scripts": {
+    "test": [
+      "phpmd src,tests text cleancode,codesize,controversial,design,unusedcode,naming --ignore-violations-on-exit",
+      "phpcs --config-set ignore_errors_on_exit 1",
+      "phpcs --standard=PSR12 src tests",
+      "phpunit --configuration=phpunit.xml --teamcity"
+    ]
+  }
+}