PHP_Typography\Hyphenator\Cache

Complexity

Total Complexity

5

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__sleep()	0	5	1
A	set_hyphenator()	0	4	1
A	get_hyphenator()	0	7	2
A	has_changed()	0	3	1

<?php
/**
 *  This file is part of PHP-Typography.
 *
 *  Copyright 2017 Peter Putzer.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *  ***
 *
 *  @package mundschenk-at/php-typography
 *  @license http://www.gnu.org/licenses/gpl-2.0.html
 */

namespace PHP_Typography\Hyphenator;

use PHP_Typography\Hyphenator;

/**
 * Per-language cache of Hyphenator instances.
 *
 * @since 5.2.0
 *
 * @author Peter Putzer <github@mundschenk.at>
 */
class Cache {

	/**
	 * An array of Hyphenator instances indexed by language.
	 *
	 * @var array
	 */
	protected $cache = [];

	/**
	 * A flag that indicated that the cache has changed since creation/deserialization.
	 *
	 * @var bool
	 */
	protected $changed = false;

	/**
	 * Ignore the "changed" flag during serialization.
	 *
	 * @return array
	 */
	public function __sleep() {
		return [
			'cache',
		];
	}

	/**
	 * Caches a Hyphenator instance.
	 *
	 * @param string     $lang       A language code.
	 * @param Hyphenator $hyphenator The object to cache.
	 */
	public function set_hyphenator( $lang, Hyphenator $hyphenator ) {
		$this->cache[ $lang ] = $hyphenator;
		$this->changed        = true;
	}

	/**
	 * Retrieves a cached Hyphenator.
	 *
	 * @param string $lang A language code.
	 *
	 * @return Hyphenator|null
	 */
	public function get_hyphenator( $lang ) {
		if ( isset( $this->cache[ $lang ] ) ) {
			return $this->cache[ $lang ];
		}

		return null;
	}

	/**
	 * Determines whether the cache (not its content) has been modified since
	 * instance creatino (or deserialization).
	 *
	 * @return bool
	 */
	public function has_changed() {
		return $this->changed;
	}
}