AppserverIo\Doppelgaenger\ContractContext

Complexity

Total Complexity

7

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	open()	0	13	2
A	isOngoing()	0	4	1
A	close()	0	19	4

<?php

/**
 * \AppserverIo\Doppelgaenger\ContractContext
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Bernhard Wick <bw@appserver.io>
 * @copyright 2015 TechDivision GmbH - <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/doppelgaenger
 * @link      http://www.appserver.io/
 */

namespace AppserverIo\Doppelgaenger;

/**
 * This class will keep track if there is any contract evaluation going on currently.
 * This is used to prevent endless loops of contracts using userland functions which are contracted themselves
 *
 * @author    Bernhard Wick <bw@appserver.io>
 * @copyright 2015 TechDivision GmbH - <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/doppelgaenger
 * @link      http://www.appserver.io/
 */
class ContractContext
{

    /**
     * @var int $contractDepth At which depth are we in the middle of an ongoing contract evaluation?
     */
    private static $contractDepth = 0;

    /**
     * @const int MAX_NESTING_DEPTH The maximum depth we allow.
     */
    const MAX_NESTING_DEPTH = 20;

    /**
     * Will open a contract context for any current ongoing verification.
     * Will return true if successful (you are the only ongoing contract) and
     * false if there already is something going on.
     *
     * @return bool
     */
    public static function open()
    {
        if (self::$contractDepth < self::MAX_NESTING_DEPTH) {
            // increment the contract depth
            self::$contractDepth++;

            return true;

Blank line found at end of control structure

        } else {
            // we reached max nesting level, tell them we were not able to open the contract
            return false;
        }
    }

    /**
     * Is there an ongoing contract beyond the maximal depth?
     *
     * @return bool
     */
    public static function isOngoing()
    {
        return !(self::$contractDepth <= self::MAX_NESTING_DEPTH);
    }

    /**
     * Will close an open contract context for the ongoing verification.
     * Will return true if contract was successfully closed and
     * false if there was no contract at all.
     *
     * @throws \Exception
     *
     * @return bool
     */
    public static function close()
    {
        if (self::$contractDepth <= self::MAX_NESTING_DEPTH && self::$contractDepth > 0) {
            // Decrement the used depth
            self::$contractDepth--;

            return true;

Blank line found at end of control structure

        } else {
            // Did we reach a place where the sun does not shine (metaphorically speaking ;-)
            if (self::$contractDepth < 0) {
                // Reset the used up contract depth and fail
                self::$contractDepth = 0;
                throw new \Exception('Contract depth surveillance ran out of bounds!');
            }

            return false;
        }
    }
}