PHPOffice / PHPPresentation / 34265797969

94%

push

github

Presentation : Add moveSlide(), and say how a slide moves (#966)

* Documentation : Say how to move a slide, and name the parameter addSlide() takes

`addSlide()` has taken a position since #810, and the page documents it. Moving a slide that is
already in the deck is the other half of the same question, and no page said it: the API composes
it out of `getIndex()`, `removeSlideByIndex()` and `addSlide()`.

The new section says that, and names the caveat -- `$newIndex` counts in the collection without
the slide being moved, so in `A B C D` moving `A` to 2 gives `B C A D`, not `A` landing where it
stood before the removal.

The paragraph above it called the parameter `$position`; the signature calls it `$index`.

* Presentation : Add moveSlide(), and say how a slide moves

`addSlide()` has taken a position since #810, but a slide already in the deck could only be moved
by hand: read its index, remove it, add it back. Three calls a caller has to find and order
correctly, for one operation the reporter of #477 asked for by name.

`moveSlide(Slide $slide, int $index)` does it in one, splicing the slide out and back in a single
step. A union `Slide|int $slide` would let the caller pass either, but that is PHP 8.0 and the
floor is 7.4; `getSlide()` already turns an index into a slide, so one signature is enough.

The index counts in the collection without the slide being moved, which is the part worth writing
down: in `A B C D`, moving `A` to 2 gives `B C A D`, not `A` landing where it stood before the
removal.

The documentation gains the section, and the paragraph above it stops calling the parameter of
`addSlide()` `$position` -- the signature calls it `$index`.

7 of 7 new or added lines in 1 file covered. (100.0%)

11371 of 12081 relevant lines covered (94.12%)

72.38 hits per line