/script/lib/PHP/Depend/Util/UuidBuilder.php

<?php

/**
 * This file is part of PHP_Depend.
 *
 * PHP Version 5
 *
 * Copyright (c) 2008-2010, Manuel Pichler <mapi@pdepend.org>.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in
 * the documentation and/or other materials provided with the
 * distribution.
 *
 * * Neither the name of Manuel Pichler nor the names of his
 * contributors may be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * 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.
 *
 * @category   PHP
 * @package    PHP_Depend
 * @subpackage Util
 * @author     Manuel Pichler <mapi@pdepend.org>
 * @copyright  2008-2010 Manuel Pichler. All rights reserved.
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @version    SVN: $Id$
 * @link       http://www.pdepend.org/
 * @since      0.9.12
 */



/**
 * This class provides methods to generate unique, but reproducable identifiers
 * for nodes generated during the parsing process.
 *
 * @category   PHP
 * @package    PHP_Depend
 * @subpackage Util
 * @author     Manuel Pichler <mapi@pdepend.org>
 * @copyright  2008-2010 Manuel Pichler. All rights reserved.
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @version    Release: 0.9.19
 * @link       http://www.pdepend.org/
 * @since      0.9.12
 */

class PHP_Depend_Util_UuidBuilder

{



    /**
     * Generates an identifier for the given file instance.
     *
     * @param PHP_Depend_Code_File $file The context source file instance.
     *
     * @return string
     */

    public function forFile(PHP_Depend_Code_File $file)

    {

        return $this->hash($file->getFileName());

    }



    /**
     * Generates an identifier for the given function instance.
     *
     * @param PHP_Depend_Code_Function $function The context function instance.
     *
     * @return string
     */

    public function forFunction(PHP_Depend_Code_Function $function)

    {

        return $this->forOffsetItem($function, 'function');

    }



    /**
     * Generates an identifier for the given class or interface instance.
     *
     * @param PHP_Depend_Code_AbstractClassOrInterface $class A class instance.
     *
     * @return string
     */

    public function forClassOrInterface(PHP_Depend_Code_AbstractClassOrInterface $class)

    {

        return $this->forOffsetItem($class, 'class');

    }



    /**
     * Generates an identifier for the given source item.
     *
     * @param PHP_Depend_Code_AbstractItem $item   The context source item.
     * @param string                       $prefix The item type identifier.
     *
     * @return string
     */

    protected function forOffsetItem(PHP_Depend_Code_AbstractItem $item, $prefix)

    {

        $fileHash = $item->getSourceFile()->getUUID();

        $itemHash = $this->hash($prefix . ':' . $item->getName());

        

        $offset = $this->getOffsetInFile($fileHash, $itemHash);

        

        return sprintf('%s-%s-%s', $fileHash, $itemHash, $offset);

    }



    /**
     * Generates an identifier for the given method instance.
     *
     * @param PHP_Depend_Code_Method $method A method instance.
     *
     * @return string
     */

    public function forMethod(PHP_Depend_Code_Method $method)

    {

        return sprintf('%s-%s', $method->getParent()->getUUID(), $this->hash($method->getName()));

    }



    /**
     * Creates a base 36 hash for the given string.
     *
     * @param string $string The raw input identifier/string.
     *
     * @return string
     */

    protected function hash($string)

    {

        return substr(base_convert(md5($string), 16, 36), 0, 11);

    }



    /**
     * Returns the node offset/occurence of the given <b>$string</b> within a
     * file.
     *
     * @param string $file   The file identifier.
     * @param string $string The node identifier.
     *
     * @return string
     */

    protected function getOffsetInFile($file, $string)

    {

        if (isset($this->_offsetInFile[$file][$string]))

        {

            $this->_offsetInFile[$file][$string] ++;

        }

        else

        {

            $this->_offsetInFile[$file][$string] = 0;

        }

        return sprintf('%02s', base_convert($this->_offsetInFile[$file][$string], 10, 36));

    }

}