Oc\GeoCache\Enum\WaypointType

Complexity

Total Complexity

4

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	guess()	0	21	4

<?php

namespace Oc\GeoCache\Enum;

use Oc\GeoCache\Exception\UnknownWaypointTypeException;

/**
 * Class WaypointType
 *
 * @package Oc\GeoCache\Enum

Unexpected tag type @package in doc block

 */
final class WaypointType
{
    /**
     * Opencaching waypoint.
     *
     * @var string
     */
    const OC = 'oc';

    /**
     * Geocaching waypoint.
     *
     * @var string
     */
    const GC = 'gc';

    /**
     * Guesses the waypoint type by given waypoint.
     *
     * @param string $waypoint
     *
     * @return string
     *
     * @throws UnknownWaypointTypeException Thrown when the waypoint type could not be guessed

UnknownWaypointTypeException => \Oc\GeoCache\Exception\UnknownWaypointTypeException

@throws tag comment must end with a full stop

     */
    public static function guess($waypoint)
    {
        $waypointType = null;

        if (stripos($waypoint, self::OC) === 0) {
            $waypointType = self::OC;
        } elseif (stripos($waypoint, self::GC) === 0) {
            $waypointType = self::GC;
        }

        if ($waypointType === null) {
            throw new UnknownWaypointTypeException(
                sprintf(
                    'Could not guess the waypoint type of the waypoint "%s"',
                    $waypoint
                )
            );
        }

        return $waypointType;
    }
}