Elgg / Elgg

engine/classes/Elgg/EntityDirLocator.php

<?php
namespace Elgg;

/**
 * Locate the relative path of an entity's data dir.
 *
 * This returns paths like: '1/27/'.
 *
 * @note This class does not require the Elgg engine to be loaded and is suitable for
 *       being used directly.
 *
 * @access private
 *
 * @package Elgg.Core
 */
class EntityDirLocator {

	/**
	 * Number of entries per matrix dir. DO NOT CHANGE!
	 */
	const BUCKET_SIZE = 5000;

	/**
	 * Find an entity's data dir.
	 *
	 * @param int $guid GUID of the entity.
	 *
	 * @throws \InvalidArgumentException
	 */
	public function __construct($guid) {
		$guid = (int) $guid;

		if (!$guid || $guid < 1) {
			// Don't throw a ClassException to keep this class completely atomic.
			throw new \InvalidArgumentException("GUIDs must be integers > 0.");
		}

		$this->guid = $guid;

The property guid does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

	}
	
	/**
	 * Construct a file path matrix for an entity.
	 * As of 1.9.0 matrixes are based on GUIDs and separated into dirs of 5000 entries
	 * with the dir name being the lower bound for the GUID.
	 *
	 * @return string The path with trailing '/' where the entity's data will be stored relative to the data dir.
	 */
	public function getPath() {
		$bound = $this->getLowerBucketBound($this->guid);
		return "$bound/$this->guid/";
	}

	/**
	 * String casting magic method.
	 *
	 * @return string
	 */
	public function __toString() {
		return $this->getPath();
	}

	/**
	 * Return the lower bound for a guid with a bucket size
	 *
	 * @param int $guid        The guid to get a bound for. Must be > 0.
	 * @param int $bucket_size The size of the bucket. (The number of entities per dir.)
	 * @return int
	 */
	private static function getLowerBucketBound($guid, $bucket_size = null) {
		if (!$bucket_size || $bucket_size < 1) {

The expression $bucket_size of type null|integer is loosely compared to false; this is ambiguous if the integer can be 0. You might want to explicitly use === null instead.

			$bucket_size = self::BUCKET_SIZE;
		}
		if ($guid < 1) {
			return false;

The expression return false returns the type false which is incompatible with the documented return type integer.

		}
		return (int) max(floor($guid / $bucket_size) * $bucket_size, 1);
	}
}