Fwk\Db\Workers\AbstractWorker

Complexity

Total Complexity

6

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Dependencies

0

Importance

Changes	9
Bugs	3	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getRegistry()	0	5	1
A	setRegistry()	0	4	1
A	getEntity()	0	5	1
A	removeFromWorking()	0	7	2

<?php
/**
 * Fwk
 *
 * Copyright (c) 2011-2012, Julien Ballestracci <julien@nitronet.org>.
 * All rights reserved.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * PHP Version 5.3
 * 
 * @category   Database
 * @package    Fwk\Db
 * @subpackage Workers
 * @author     Julien Ballestracci <julien@nitronet.org>
 * @copyright  2011-2012 Julien Ballestracci <julien@nitronet.org>
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link       http://www.phpfwk.com
 */
namespace Fwk\Db\Workers;

use Fwk\Db\Registry\Registry;

/**
 * Base utility class for Workers
 * 
 * @category Workers
 * @package  Fwk\Db
 * @author   Julien Ballestracci <julien@nitronet.org>
 * @license  http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link     http://www.phpfwk.com
 */
abstract class AbstractWorker
{
    /**
     * Object to delete
     *
     * @var mixed
     */
    protected $entity;

    /**
     * Defined Registry to work with
     * 
     * @var Registry
     */
    protected $registry;

    /**
     * Prevent many workers to work on the same entity
     *
     * @var array
     */
    protected static $working = array();

    /**
     * Constructor
     * 
     * @param mixed $entity The object involved with this worker
     * 
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct($entity)
    {
        $this->entity   = $entity;
    }

    /**
     * Return the registry to be used by this worker
     * 
     * @return Registry
     */
    public function getRegistry()
    {

        return $this->registry;
    }

    /**
     * Defines the Registry to work with.
     * 
     * @param Registry $registry The registry to be used by this worker
     * 
     * @return void
     */
    public function setRegistry(Registry $registry)
    {
        $this->registry = $registry;
    }

    /**
     * Return the defined entity
     * 
     * @return mixed
     */
    public function getEntity()
    {

        return $this->entity;
    }

    /**
     * Unmark the entity from the working scope
     *
     * @param object $entity The entity
     *
     * @return void
     */
    protected function removeFromWorking($entity)
    {
        $id = array_search($entity, static::$working, true);
        if ($id !== false) {
            unset(static::$working[$id]);
        }
    }
}