Completed
Pull Request — master (#6)
by
unknown
03:51
created

OSRef::getReferenceEllipsoid()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 4
ccs 2
cts 2
cp 1
rs 10
cc 1
eloc 2
nc 1
nop 0
crap 1
1
<?php
2
/**
3
 * PHPCoord
4
 * @package PHPCoord
5
 * @author Jonathan Stott
6
 * @author Doug Wright
7
 */
8
namespace PHPCoord;
9
10
/**
11
 * Ordnance Survey grid reference
12
 * References are accurate to 1m
13
 * @author Jonathan Stott
14
 * @author Doug Wright
15
 * @package PHPCoord
16
 */
17
class OSRef extends TransverseMercator
18
{
19
20
    const GRID_LETTERS = "VWXYZQRSTULMNOPFGHJKABCDE";
21
22 2
    public function getReferenceEllipsoid()
23
    {
24 2
        return RefEll::airy1830();
25
    }
26
27 4
    public function getScaleFactor()
28
    {
29 4
        return 0.9996012717;
30
    }
31
32 4
    public function getOriginNorthing()
33
    {
34 4
        return -100000;
35
    }
36
37 4
    public function getOriginEasting()
38
    {
39 4
        return 400000;
40
    }
41
42 4
    public function getOriginLatitude()
43
    {
44 4
        return 49;
45
    }
46
47 4
    public function getOriginLongitude()
48
    {
49 4
        return -2;
50
    }
51
52
    /**
53
     * Create a new object representing a OSGB reference.
54
     *
55
     * @param int $x
56
     * @param int $y
57
     * @param int $z
58
     */
59 12
    public function __construct($x, $y, $z = 0)
60
    {
61 12
        parent::__construct($x, $y, $z, RefEll::airy1830());
62 12
    }
63
64
    /**
65
     * Take a string formatted as a six-figure OS grid reference (e.g.
66
     * "TG514131") and return a reference to an OSRef object that represents
67
     * that grid reference.
68
     *
69
     * @param string $ref
70
     * @return OSRef
71
     */
72 2
    public static function fromSixFigureReference($ref)
73
    {
74
75
        //first (major) letter is the 500km grid sq, origin at -1000000, -500000
76 2
        $majorEasting = strpos(self::GRID_LETTERS, $ref[0]) % 5  * 500000 - 1000000;
77 2
        $majorNorthing = (floor(strpos(self::GRID_LETTERS, $ref[0]) / 5)) * 500000 - 500000;
78
79
        //second (minor) letter is 100km grid sq, origin at 0,0 of this square
80 2
        $minorEasting = strpos(self::GRID_LETTERS, $ref[1]) % 5  * 100000;
81 2
        $minorNorthing = (floor(strpos(self::GRID_LETTERS, $ref[1]) / 5)) * 100000;
82
83 2
        $easting = $majorEasting + $minorEasting + (substr($ref, 2, 3) * 100);
84 2
        $northing = $majorNorthing + $minorNorthing + (substr($ref, 5, 3) * 100);
85
86 2
        return new OSRef($easting, $northing);
87
    }
88
89
    /**
90
     * Convert this grid reference into a string using a standard six-figure
91
     * grid reference including the two-character designation for the 100km
92
     * square. e.g. TG514131.
93
     * @return string
94
     */
95 3 View Code Duplication
    public function toSixFigureReference()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
96
    {
97
98 3
        $easting = str_pad($this->x, 6, 0, STR_PAD_LEFT);
99 3
        $northing = str_pad($this->y, 6, 0, STR_PAD_LEFT);
100
101
102 3
        $adjustedX = $this->x + 1000000;
103 3
        $adjustedY = $this->y + 500000;
104 3
        $majorSquaresEast = floor($adjustedX / 500000);
105 3
        $majorSquaresNorth = floor($adjustedY / 500000);
106 3
        $majorLetterIndex = (int)(5 * $majorSquaresNorth + $majorSquaresEast);
107 3
        $majorLetter = substr(self::GRID_LETTERS, $majorLetterIndex, 1);
108
109
        //second (minor) letter is 100km grid sq, origin at 0,0 of this square
110 3
        $minorSquaresEast = $easting[0] % 5;
111 3
        $minorSquaresNorth = $northing[0] % 5;
112 3
        $minorLetterIndex = (int)(5 * $minorSquaresNorth + $minorSquaresEast);
113 3
        $minorLetter = substr(self::GRID_LETTERS, $minorLetterIndex, 1);
114
115 3
        return $majorLetter . $minorLetter . substr($easting, 1, 3) . substr($northing, 1, 3);
116
    }
117
    
118
    /**
119
     * Convert this grid reference into a string using a standard eight-figure
120
     * grid reference including the two-character designation for the 100km
121
     * square. e.g. TG51411311.
122
     * @return string
123
     */
124 1 View Code Duplication
    public function toEightFigureReference()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
125
        {
126
127 1
        $easting = str_pad($this->x, 6, 0, STR_PAD_LEFT);
128 1
        $northing = str_pad($this->y, 6, 0, STR_PAD_LEFT);
129
130
131 1
        $adjustedX = $this->x + 1000000;
132 1
        $adjustedY = $this->y + 500000;
133 1
        $majorSquaresEast = floor($adjustedX / 500000);
134 1
        $majorSquaresNorth = floor($adjustedY / 500000);
135 1
        $majorLetterIndex = (int)(5 * $majorSquaresNorth + $majorSquaresEast);
136 1
        $majorLetter = substr(self::GRID_LETTERS, $majorLetterIndex, 1);
137
138
        //second (minor) letter is 100km grid sq, origin at 0,0 of this square
139 1
        $minorSquaresEast = $easting[0] % 5;
140 1
        $minorSquaresNorth = $northing[0] % 5;
141 1
        $minorLetterIndex = (int)(5 * $minorSquaresNorth + $minorSquaresEast);
142 1
        $minorLetter = substr(self::GRID_LETTERS, $minorLetterIndex, 1);
143
144 1
        return $majorLetter . $minorLetter . substr($easting, 1, 4) . substr($northing, 1, 4);
145
    }
146
147
    /**
148
     * Convert this grid reference into a string using a standard ten-figure
149
     * grid reference including the two-character designation for the 100km
150
     * square. e.g. TG5141213112.
151
     * @return string
152
     */
153 1 View Code Duplication
    public function toTenFigureReference()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
154
    {
155
156 1
        $easting = str_pad($this->x, 6, 0, STR_PAD_LEFT);
157 1
        $northing = str_pad($this->y, 6, 0, STR_PAD_LEFT);
158
159
160 1
        $adjustedX = $this->x + 1000000;
161 1
        $adjustedY = $this->y + 500000;
162 1
        $majorSquaresEast = floor($adjustedX / 500000);
163 1
        $majorSquaresNorth = floor($adjustedY / 500000);
164 1
        $majorLetterIndex = (int)(5 * $majorSquaresNorth + $majorSquaresEast);
165 1
        $majorLetter = substr(self::GRID_LETTERS, $majorLetterIndex, 1);
166
167
        //second (minor) letter is 100km grid sq, origin at 0,0 of this square
168 1
        $minorSquaresEast = $easting[0] % 5;
169 1
        $minorSquaresNorth = $northing[0] % 5;
170 1
        $minorLetterIndex = (int)(5 * $minorSquaresNorth + $minorSquaresEast);
171 1
        $minorLetter = substr(self::GRID_LETTERS, $minorLetterIndex, 1);
172
173 1
        return $majorLetter . $minorLetter . substr($easting, 1, 5) . substr($northing, 1, 5);
174
    }
175
176
    /**
177
     * Convert this grid reference into a latitude and longitude
178
     * @return LatLng
179
     */
180 2 View Code Duplication
    public function toLatLng()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
181
    {
182 2
        $N = $this->y;
183 2
        $E = $this->x;
184 2
        $N0 = $this->getOriginNorthing();
185 2
        $E0 = $this->getOriginEasting();
186 2
        $phi0 = $this->getOriginLatitude();
187 2
        $lambda0 = $this->getOriginLongitude();
188
189 2
        return $this->convertToLatitudeLongitude($N, $E, $N0, $E0, $phi0, $lambda0);
190
    }
191
192
    /**
193
     * String version of coordinate.
194
     * @return string
195
     */
196 5
    public function __toString()
197
    {
198 5
        return "({$this->x}, {$this->y})";
199
    }
200
}
201