import

Author: temp

.gitignore

@@ -0,0 +1 @@
+vendor

README.md

@@ -0,0 +1,50 @@
+Blocking Component
+==================
+The Locking Component provides methods to manager content based blocking.
+
+```php
+<?php
+
+use Brainbits\Blocking\Blocker;
+use Brainbits\Blocking\Adapter\FilesystemAdapter;
+use Brainbits\Blocking\Owner\SessionOwner;
+
+$adapter   = new FilesystemAdapter('/where/to/store/blocks' /* path to directory on filesystem */);
+$owner     = new SessionOwner($session /* symfony session */);
+$validator = new ExpiredValidator(300 /* block will expire after 300 seconds */);
+
+$blocker = new Blocker($adapter, $owner, $validator);
+
+$identifier = new Identifer('myContent', 123);
+
+$block = $blocker->block($identifier);
+$result = $blocker->unblock($identifier);
+$result = $blocker->isBlocked($identifier);
+$block = $blocker->getBlock($identifier);
+```
+
+Blocking Adapters
+-----------------
+Blocking adapters are used to store the block information.
+
+A file based blocking adapter is provided.
+It writes block-files to the filesystem, based on the blocking identifier.
+
+Blocking Identifiers
+--------------------
+Blocking identifiers are used to identify the content that is being blocked.
+
+A general purpose blocking identifier is provided, that uses content type and
+content id to create an identifier string.
+
+Blocking Owners
+---------------
+Blocking owners are used to identify the user that created the block.
+
+A symfony session based owner class is provided.
+
+Blocking Validators
+-------------------
+Blocking validators test wether or not an existing block is still valid.
+
+A validator that checks a block via last modification time is provided.

composer.json

@@ -0,0 +1,22 @@
+{
+    "name": "brainbits/blocking",
+    "description": "Object blocking",
+    "keywords": [],
+    "homepage": "http://brainbits.net",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Stephan Wentz",
+            "email": "swentz@brainbits.net"
+        }
+    ],
+    "require": {
+        "php": ">=5.4.0",
+        "mikey179/vfsStream": "1.1.*",
+        "symfony/http-foundation": "2.1.*"
+    },
+    "autoload": {
+        "psr-0": { "Brainbits": "src/" }
+    },
+    "minimum-stability": "stable"
+}

composer.lock

@@ -0,0 +1,60 @@
+<?php
+/**
+ * This file is part of the brainbits block package.
+ *
+ * @copyright 2012 brainbits GmbH (http://www.brainbits.net)
+ * @license   http://www.makeweb.de/LICENCE     Dummy Licence
+ */
+
+namespace Brainbits\Blocking\Adapter;
+
+use Brainbits\Blocking\Identifier\IdentifierInterface;
+use Brainbits\Blocking\BlockInterface;
+
+/**
+ * Block adapter interface
+ *
+ * @author  Stephan Wentz <sw@brainbits.net>
+ */
+interface AdapterInterface
+{
+    /**
+     * Write block
+     *
+     * @param BlockInterface $block
+     * @return boolean
+     */
+    public function write(BlockInterface $block);
+
+    /**
+     * Touch block
+     *
+     * @param BlockInterface $block
+     * @return boolean
+     */
+    public function touch(BlockInterface $block);
+
+    /**
+     * Remove block
+     *
+     * @param BlockInterface $block
+     * @return boolean
+     */
+    public function remove(BlockInterface $block);
+
+    /**
+     * Is a block set?
+     *
+     * @param BlockInterface $block
+     * @return boolean
+     */
+    public function exists(IdentifierInterface $identifier);
+
+    /**
+     * Return block
+     *
+     * @param BlockInterface $block
+     * @return BlockInterface
+     */
+    public function get(IdentifierInterface $identifier);
+}

src/Brainbits/Blocking/Adapter/AdapterInterface.php

@@ -0,0 +1,116 @@
+<?php
+/**
+ * This file is part of the brainbits block package.
+ *
+ * @copyright 2012 brainbits GmbH (http://www.brainbits.net)
+ * @license   http://www.makeweb.de/LICENCE     Dummy Licence
+ */
+
+namespace Brainbits\Blocking\Adapter;
+
+use Brainbits\Blocking\Identifier\IdentifierInterface;
+use Brainbits\Blocking\BlockInterface;
+use Brainbits\Blocking\Block;
+
+/**
+ * File block adapter
+ * Uses files for storing block information
+ *
+ * @author  Stephan Wentz <sw@brainbits.net>
+ */
+class FileAdapter implements AdapterInterface
+{
+    /**
+     * @var string
+     */
+    protected $root;
+
+    /**
+     * @param string $root
+     */
+    public function __construct($root)
+    {
+        $this->root = $root;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function write(BlockInterface $block)
+    {
+        file_put_contents(
+            $this->getFilename($block->getIdentifier()),
+            serialize($block)
+        );
+
+        return true;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function touch(BlockInterface $block)
+    {
+        $filename = $this->getFilename($block->getIdentifier());
+        touch($filename);
+        $updatedAt = new \DateTime();
+        $updatedAt->setTimestamp(filemtime($filename));
+        $block->setUpdatedAt($updatedAt);
+
+        return true;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function remove(BlockInterface $block)
+    {
+        if (!$this->exists($block->getIdentifier()))
+        {
+            return false;
+        }
+
+        unlink($this->getFilename($block->getIdentifier()));
+
+        return true;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function exists(IdentifierInterface $identifier)
+    {
+        return file_exists($this->getFilename($identifier));
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function get(IdentifierInterface $identifier)
+    {
+        if (!$this->exists($identifier))
+        {
+            return null;
+        }
+
+        $filename = $this->getFilename($identifier);
+        $content = file_get_contents($filename);
+        $updatedAt = new \DateTime();
+        $updatedAt->setTimestamp(filemtime($filename));
+        $block = unserialize($content);
+        $block->setUpdatedAt($updatedAt);
+
+        return $block;
+    }
+
+    /**
+     * Return assembled filename
+     *
+     * @param IdentifierInterface $identifier
+     * @return string
+     */
+    protected function getFilename(IdentifierInterface $identifier)
+    {
+        return $this->root . '/' . $identifier;
+    }
+}