Org\Heigl\Hyphenator\Dictionary\DictionaryRegistry

Complexity

Total Complexity

14

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	add()	0	8	2
A	getDictionaryWithKey()	0	8	2
A	getHyphenationPattterns()	0	4	1
A	getHyphenationPatterns()	0	9	2
A	rewind()	0	4	1
A	current()	0	4	1
A	key()	0	4	1
A	count()	0	4	1
A	next()	0	4	1
A	valid()	0	8	2

<?php
/**
 * Copyright (c) 2008-2011 Andreas Heigl<andreas@heigl.org>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @category   Hyphenation
 * @package    Org\Heigl\Hyphenator
 * @subpackage Dictionary
 * @author     Andreas Heigl <andreas@heigl.org>
 * @copyright  2008-2011 Andreas Heigl<andreas@heigl.org>
 * @license    http://www.opensource.org/licenses/mit-license.php MIT-License
 * @version    2.0.1
 * @link       http://github.com/heiglandreas/Hyphenator
 * @since      01.11.2011
 */

namespace Org\Heigl\Hyphenator\Dictionary;

/**
 * This class provides a registry for storing multiple dictionaries
 *
 * @category   Hyphenation
 * @package    Org\Heigl\Hyphenator
 * @subpackage Dictionary
 * @author     Andreas Heigl <andreas@heigl.org>
 * @copyright  2008-2011 Andreas Heigl<andreas@heigl.org>
 * @license    http://www.opensource.org/licenses/mit-license.php MIT-License
 * @version    2.0.1
 * @link       http://github.com/heiglandreas/Hyphenator
 * @since      01.11.2011
 */
class DictionaryRegistry implements \Iterator, \Countable
{
    /**
     * Storage for the Dictionaries.
     *
     * @var Dictionary[] $registry
     */
    protected $registry = array();

    /**
     * Add an item to the registry.
     *
     * @param Dictionary $dict The Dictionary to add to the registry
     *
     * @return DictionaryRegistry
     */
    public function add(Dictionary $dict)
    {
        if (! in_array($dict, $this->registry)) {
            $this->registry[] = $dict;
        }

        return $this;
    }

    /**
     * Get a dictionary entry by its key
     *
     * @param mixed $key The key to retrieve the Dictionary for
     *
     * @return Dictionary|null
     */
    public function getDictionaryWithKey($key)
    {
        if (array_key_exists($key, $this->registry)) {
            return $this->registry[$key];
        }

        return null;
    }

    /**
     * Get an array of hyphenation-patterns for a given word.
     *
     * @deprecated use getHyphenationPatterns() instead
     *
     * @param string $word The word to get the patterns for.
     *
     * @return array
     */
    public function getHyphenationPattterns($word)
    {
        return $this->getHyphenationPatterns($word);
    }

    /**
     * Get an array of hyphenation-patterns for a given word.
     *
     * @param string $word The word to get the patterns for.
     *
     * @return array
     */
    public function getHyphenationPatterns($word)
    {
        $pattern = array(array());
        foreach ($this as $dictionary) {
            $pattern[] = $dictionary->getPatternsForWord($word);
        }

        return array_merge(...$pattern);
    }

    /**
     * Implementation of \Iterator
     *
     * @see \Iterator::rewind()
     *
     * @return void
     */
    public function rewind()
    {
        reset($this->registry);
    }

    /**
     * Get the current object
     *
     * @see \Iterator::current()
     *
     * @return \Org\Heigl\Hyphenator\Dictionary\Dictionary
     */
    public function current()
    {
        return current($this->registry);

The expression current($this->registry); of type Org\Heigl\Hyphenator\Dictionary\Dictionary|false adds false to the return on line 142 which is incompatible with the return type documented by Org\Heigl\Hyphenator\Dictionary\DictionaryRegistry::current of type Org\Heigl\Hyphenator\Dictionary\Dictionary. It seems like you forgot to handle an error condition.

    }

    /**
     * Get the current key
     *
     * @see \Iterator::key()
     *
     * @return mixed
     */
    public function key()
    {
        return key($this->registry);
    }

    /**
     * Get the number of items in the registry
     *
     * @see \Countable::count()
     *
     * @return int
     */
    public function count()
    {
        return count($this->registry);
    }

    /**
     * Push the internal pointer forward one step
     *
     * @see \Iterator::next()
     *
     * @return void
     */
    public function next()
    {
        next($this->registry);
    }

    /**
     * Check whether the current pointer is in a valid place
     *
     * @see \Iterator::valid()
     *
     * @return boolean
     */
    public function valid()
    {
        if (false === current($this->registry)) {
            return false;
        }

        return true;
    }
}