PhpPresentation::getProperties() - Code Metrics - Inspection of "Merge pull request #390 from Progi1984/issue382" - PHPOffice/PHPPresentation - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( d9e4d8...cd1d80 )

by Franck

created 2019-06-09 20:12 UTC

PhpPresentation::getProperties() A

↳ Parent: PhpPresentation

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	1

<?php
/**
 * This file is part of PHPPresentation - A pure PHP library for reading and writing
 * presentations documents.
 *
 * PHPPresentation is free software distributed under the terms of the GNU Lesser
 * General Public License version 3 as published by the Free Software Foundation.
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code. For the full list of
 * contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
 *
 * @link        https://github.com/PHPOffice/PHPPresentation
 * @copyright   2009-2015 PHPPresentation contributors
 * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
 */

namespace PhpOffice\PhpPresentation;

use PhpOffice\PhpPresentation\Slide;
use PhpOffice\PhpPresentation\Slide\Iterator;
use PhpOffice\PhpPresentation\Slide\SlideMaster;

/**
 * PhpPresentation
 */
class PhpPresentation
{
    /**
     * Document properties
     *
     * @var \PhpOffice\PhpPresentation\DocumentProperties
     */
    protected $documentProperties;

    /**
     * Presentation properties
     *
     * @var \PhpOffice\PhpPresentation\PresentationProperties
     */
    protected $presentationProps;

    /**
     * Document layout
     *
     * @var \PhpOffice\PhpPresentation\DocumentLayout
     */
    protected $layout;

    /**
     * Collection of Slide objects
     *
     * @var \PhpOffice\PhpPresentation\Slide[]
     */
    protected $slideCollection = array();

    /**
     * Active slide index
     *
     * @var int
     */
    protected $activeSlideIndex = 0;

    /**
     * Collection of Master Slides
     * @var \ArrayObject|\PhpOffice\PhpPresentation\Slide\SlideMaster[]
     */
    protected $slideMasters;

    /**
     * Create a new PhpPresentation with one Slide
     */
    public function __construct()
    {
        // Set empty Master & SlideLayout
        $this->createMasterSlide()->createSlideLayout();

        // Initialise slide collection and add one slide
        $this->createSlide();
        $this->setActiveSlideIndex();

        // Set initial document properties & layout
        $this->setDocumentProperties(new DocumentProperties());
        $this->setPresentationProperties(new PresentationProperties());
        $this->setLayout(new DocumentLayout());
    }

    /**
     * Get properties
     *
     * @return \PhpOffice\PhpPresentation\DocumentProperties
     * @deprecated for getDocumentProperties
     */
    public function getProperties()
    {
        return $this->getDocumentProperties();
    }

    /**
     * Set properties
     *
     * @param  \PhpOffice\PhpPresentation\DocumentProperties $value
     * @deprecated for setDocumentProperties
     * @return PhpPresentation
     */
    public function setProperties(DocumentProperties $value)
    {
        return $this->setDocumentProperties($value);
    }

    /**
     * Get properties
     *
     * @return \PhpOffice\PhpPresentation\DocumentProperties
     */
    public function getDocumentProperties()
    {
        return $this->documentProperties;
    }

    /**
     * Set properties
     *
     * @param  \PhpOffice\PhpPresentation\DocumentProperties $value
     * @return PhpPresentation
     */
    public function setDocumentProperties(DocumentProperties $value)
    {
        $this->documentProperties = $value;

        return $this;
    }

    /**
     * Get presentation properties
     *
     * @return \PhpOffice\PhpPresentation\PresentationProperties
     */
    public function getPresentationProperties()
    {
        return $this->presentationProps;
    }

    /**
     * Set presentation properties
     *
     * @param  \PhpOffice\PhpPresentation\PresentationProperties $value
     * @return PhpPresentation
     */
    public function setPresentationProperties(PresentationProperties $value)
    {
        $this->presentationProps = $value;
        return $this;
    }

    /**
     * Get layout
     *
     * @return \PhpOffice\PhpPresentation\DocumentLayout
     */
    public function getLayout()
    {
        return $this->layout;
    }

    /**
     * Set layout
     *
     * @param  \PhpOffice\PhpPresentation\DocumentLayout $value
     * @return PhpPresentation
     */
    public function setLayout(DocumentLayout $value)
    {
        $this->layout = $value;

        return $this;
    }

    /**
     * Get active slide
     *
     * @return \PhpOffice\PhpPresentation\Slide
     */
    public function getActiveSlide()
    {
        return $this->slideCollection[$this->activeSlideIndex];
    }

    /**
     * Create slide and add it to this presentation
     *
     * @return \PhpOffice\PhpPresentation\Slide
     * @throws \Exception
     */
    public function createSlide()
    {
        $newSlide = new Slide($this);
        $this->addSlide($newSlide);
        return $newSlide;
    }

    /**
     * Add slide
     *
     * @param  \PhpOffice\PhpPresentation\Slide $slide
     * @throws \Exception
     * @return \PhpOffice\PhpPresentation\Slide
     */
    public function addSlide(Slide $slide = null)
    {
        $this->slideCollection[] = $slide;

        return $slide;
    }

    /**
     * Remove slide by index
     *
     * @param  int $index Slide index
     * @throws \Exception
     * @return PhpPresentation
     */
    public function removeSlideByIndex($index = 0)
    {
        if ($index > count($this->slideCollection) - 1) {
            throw new \Exception("Slide index is out of bounds.");
        }
        array_splice($this->slideCollection, $index, 1);

        return $this;
    }

    /**
     * Get slide by index
     *
     * @param  int $index Slide index
     * @return \PhpOffice\PhpPresentation\Slide
     * @throws \Exception
     */
    public function getSlide($index = 0)
    {
        if ($index > count($this->slideCollection) - 1) {
            throw new \Exception("Slide index is out of bounds.");
        }
        return $this->slideCollection[$index];
    }

    /**
     * Get all slides
     *
     * @return \PhpOffice\PhpPresentation\Slide[]
     */
    public function getAllSlides()
    {
        return $this->slideCollection;
    }

    /**
     * Get index for slide
     *
     * @param  \PhpOffice\PhpPresentation\Slide\AbstractSlide $slide
     * @return int
     * @throws \Exception
     */
    public function getIndex(Slide\AbstractSlide $slide)
    {
        $index = null;
        foreach ($this->slideCollection as $key => $value) {
            if ($value->getHashCode() == $slide->getHashCode()) {
                $index = $key;
                break;
            }
        }
        return $index;
    }

    /**
     * Get slide count
     *
     * @return int
     */
    public function getSlideCount()
    {
        return count($this->slideCollection);
    }

    /**
     * Get active slide index
     *
     * @return int Active slide index
     */
    public function getActiveSlideIndex()
    {
        return $this->activeSlideIndex;
    }

    /**
     * Set active slide index
     *
     * @param  int $index Active slide index
     * @throws \Exception
     * @return \PhpOffice\PhpPresentation\Slide
     */
    public function setActiveSlideIndex($index = 0)
    {
        if ($index > count($this->slideCollection) - 1) {
            throw new \Exception("Active slide index is out of bounds.");
        }
        $this->activeSlideIndex = $index;

        return $this->getActiveSlide();
    }

    /**
     * Add external slide
     *
     * @param  \PhpOffice\PhpPresentation\Slide $slide External slide to add
     * @throws \Exception
     * @return \PhpOffice\PhpPresentation\Slide
     */
    public function addExternalSlide(Slide $slide)
    {
        $slide->rebindParent($this);

        $this->addMasterSlide($slide->getSlideLayout()->getSlideMaster());

        return $this->addSlide($slide);
    }

    /**
     * Get slide iterator
     *
     * @return \PhpOffice\PhpPresentation\Slide\Iterator
     */
    public function getSlideIterator()
    {
        return new Iterator($this);
    }

    /**
     * Create a masterslide and add it to this presentation
     *
     * @return \PhpOffice\PhpPresentation\Slide\SlideMaster
     * @throws \Exception
     */
    public function createMasterSlide()
    {
        $newMasterSlide = new SlideMaster($this);
        $this->addMasterSlide($newMasterSlide);
        return $newMasterSlide;
    }

    /**
     * Add masterslide
     *
     * @param  \PhpOffice\PhpPresentation\Slide\SlideMaster $slide
     * @return \PhpOffice\PhpPresentation\Slide\SlideMaster
     * @throws \Exception
     */
    public function addMasterSlide(SlideMaster $slide = null)
    {
        $this->slideMasters[] = $slide;

        return $slide;
    }

    /**
     * Copy presentation (!= clone!)
     *
     * @return PhpPresentation
     * @throws \Exception
     */
    public function copy()
    {
        $copied = clone $this;

        $slideCount = count($this->slideCollection);
        for ($i = 0; $i < $slideCount; ++$i) {
            $this->slideCollection[$i] = $this->slideCollection[$i]->copy();
            $this->slideCollection[$i]->rebindParent($this);
        }

        return $copied;
    }

    /**
     * Mark a document as final
     * @param bool $state
     * @return PresentationProperties
     * @deprecated for getPresentationProperties()->markAsFinal()
     */
    public function markAsFinal($state = true)
    {
        return $this->getPresentationProperties()->markAsFinal($state);
    }

    /**
     * Return if this document is marked as final
     * @return bool
     * @deprecated for getPresentationProperties()->isMarkedAsFinal()
     */
    public function isMarkedAsFinal()
    {
        return $this->getPresentationProperties()->isMarkedAsFinal();
    }

    /**
     * Set the zoom of the document (in percentage)
     * @param float $zoom
     * @return PresentationProperties
     * @deprecated for getPresentationProperties()->setZoom()
     */
    public function setZoom($zoom = 1.0)
    {
        return $this->getPresentationProperties()->setZoom($zoom);
    }

    /**
     * Return the zoom (in percentage)
     * @return float
     * @deprecated for getPresentationProperties()->getZoom()
     */
    public function getZoom()
    {
        return $this->getPresentationProperties()->getZoom();
    }

    /**
     * @return \ArrayObject|Slide\SlideMaster[]
     */
    public function getAllMasterSlides()
    {
        return $this->slideMasters;
    }

    /**
     * @param \ArrayObject|Slide\SlideMaster[] $slideMasters
     * @return $this
     */
    public function setAllMasterSlides($slideMasters = array())
    {
        if ($slideMasters instanceof \ArrayObject || is_array($slideMasters)) {
            $this->slideMasters = $slideMasters;
        }
        return $this;
    }
}


1		<?php
2		/**
3		* This file is part of PHPPresentation - A pure PHP library for reading and writing
4		* presentations documents.
5		*
6		* PHPPresentation is free software distributed under the terms of the GNU Lesser
7		* General Public License version 3 as published by the Free Software Foundation.
8		*
9		* For the full copyright and license information, please read the LICENSE
10		* file that was distributed with this source code. For the full list of
11		* contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
12		*
13		* @link https://github.com/PHPOffice/PHPPresentation
14		* @copyright 2009-2015 PHPPresentation contributors
15		* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
16		*/
17
18		namespace PhpOffice\PhpPresentation;
19
20		use PhpOffice\PhpPresentation\Slide;
21		use PhpOffice\PhpPresentation\Slide\Iterator;
22		use PhpOffice\PhpPresentation\Slide\SlideMaster;
23
24		/**
25		* PhpPresentation
26		*/
27		class PhpPresentation
28		{
29		/**
30		* Document properties
31		*
32		* @var \PhpOffice\PhpPresentation\DocumentProperties
33		*/
34		protected $documentProperties;
35
36		/**
37		* Presentation properties
38		*
39		* @var \PhpOffice\PhpPresentation\PresentationProperties
40		*/
41		protected $presentationProps;
42
43		/**
44		* Document layout
45		*
46		* @var \PhpOffice\PhpPresentation\DocumentLayout
47		*/
48		protected $layout;
49
50		/**
51		* Collection of Slide objects
52		*
53		* @var \PhpOffice\PhpPresentation\Slide[]
54		*/
55		protected $slideCollection = array();
56
57		/**
58		* Active slide index
59		*
60		* @var int
61		*/
62		protected $activeSlideIndex = 0;
63
64		/**
65		* Collection of Master Slides
66		* @var \ArrayObject\|\PhpOffice\PhpPresentation\Slide\SlideMaster[]
67		*/
68		protected $slideMasters;
69
70		/**
71		* Create a new PhpPresentation with one Slide
72		*/
73	222	public function __construct()
74		{
75		// Set empty Master & SlideLayout
76	222	$this->createMasterSlide()->createSlideLayout();
77
78		// Initialise slide collection and add one slide
79	222	$this->createSlide();
80	222	$this->setActiveSlideIndex();
81
82		// Set initial document properties & layout
83	222	$this->setDocumentProperties(new DocumentProperties());
84	222	$this->setPresentationProperties(new PresentationProperties());
85	222	$this->setLayout(new DocumentLayout());
86	222	}
87
88		/**
89		* Get properties
90		*
91		* @return \PhpOffice\PhpPresentation\DocumentProperties
92		* @deprecated for getDocumentProperties
93		*/
94	1	public function getProperties()
95		{
96	1	return $this->getDocumentProperties();
97		}
98
99		/**
100		* Set properties
101		*
102		* @param \PhpOffice\PhpPresentation\DocumentProperties $value
103		* @deprecated for setDocumentProperties
104		* @return PhpPresentation
105		*/
106	1	public function setProperties(DocumentProperties $value)
107		{
108	1	return $this->setDocumentProperties($value);
109		}
110
111		/**
112		* Get properties
113		*
114		* @return \PhpOffice\PhpPresentation\DocumentProperties
115		*/
116	186	public function getDocumentProperties()
117		{
118	186	return $this->documentProperties;
119		}
120
121		/**
122		* Set properties
123		*
124		* @param \PhpOffice\PhpPresentation\DocumentProperties $value
125		* @return PhpPresentation
126		*/
127	222	public function setDocumentProperties(DocumentProperties $value)
128		{
129	222	$this->documentProperties = $value;
130
131	222	return $this;
132		}
133
134		/**
135		* Get presentation properties
136		*
137		* @return \PhpOffice\PhpPresentation\PresentationProperties
138		*/
139	183	public function getPresentationProperties()
140		{
141	183	return $this->presentationProps;
142		}
143
144		/**
145		* Set presentation properties
146		*
147		* @param \PhpOffice\PhpPresentation\PresentationProperties $value
148		* @return PhpPresentation
149		*/
150	222	public function setPresentationProperties(PresentationProperties $value)
151		{
152	222	$this->presentationProps = $value;
153	222	return $this;
154		}
155
156		/**
157		* Get layout
158		*
159		* @return \PhpOffice\PhpPresentation\DocumentLayout
160		*/
161	179	public function getLayout()
162		{
163	179	return $this->layout;
164		}
165
166		/**
167		* Set layout
168		*
169		* @param \PhpOffice\PhpPresentation\DocumentLayout $value
170		* @return PhpPresentation
171		*/
172	222	public function setLayout(DocumentLayout $value)
173		{
174	222	$this->layout = $value;
175
176	222	return $this;
177		}
178
179		/**
180		* Get active slide
181		*
182		* @return \PhpOffice\PhpPresentation\Slide
183		*/
184	222	public function getActiveSlide()
185		{
186	222	return $this->slideCollection[$this->activeSlideIndex];
187		}
188
189		/**
190		* Create slide and add it to this presentation
191		*
192		* @return \PhpOffice\PhpPresentation\Slide
193		* @throws \Exception
194		*/
195	222	public function createSlide()
196		{
197	222	$newSlide = new Slide($this);
198	222	$this->addSlide($newSlide);
199	222	return $newSlide;
200		}
201
202		/**
203		* Add slide
204		*
205		* @param \PhpOffice\PhpPresentation\Slide $slide
206		* @throws \Exception
207		* @return \PhpOffice\PhpPresentation\Slide
208		*/
209	222	public function addSlide(Slide $slide = null)
210		{
211	222	$this->slideCollection[] = $slide;
212
213	222	return $slide;
214		}
215
216		/**
217		* Remove slide by index
218		*
219		* @param int $index Slide index
220		* @throws \Exception
221		* @return PhpPresentation
222		*/
223	16	public function removeSlideByIndex($index = 0)
224		{
225	16	if ($index > count($this->slideCollection) - 1) {
226	1	throw new \Exception("Slide index is out of bounds.");
227		}
228	15	array_splice($this->slideCollection, $index, 1);
229
230	15	return $this;
231		}
232
233		/**
234		* Get slide by index
235		*
236		* @param int $index Slide index
237		* @return \PhpOffice\PhpPresentation\Slide
238		* @throws \Exception
239		*/
240	193	public function getSlide($index = 0)
241		{
242	193	if ($index > count($this->slideCollection) - 1) {
243	1	throw new \Exception("Slide index is out of bounds.");
244		}
245	192	return $this->slideCollection[$index];
246		}
247
248		/**
249		* Get all slides
250		*
251		* @return \PhpOffice\PhpPresentation\Slide[]
252		*/
253	184	public function getAllSlides()
254		{
255	184	return $this->slideCollection;
256		}
257
258		/**
259		* Get index for slide
260		*
261		* @param \PhpOffice\PhpPresentation\Slide\AbstractSlide $slide
262		* @return int
263		* @throws \Exception
264		*/
265	115	public function getIndex(Slide\AbstractSlide $slide)
266		{
267	115	$index = null;
268	115	foreach ($this->slideCollection as $key => $value) {
269	115	if ($value->getHashCode() == $slide->getHashCode()) {
270	115	$index = $key;
271	115	break;
272		}
273		}
274	115	return $index;
275		}
276
277		/**
278		* Get slide count
279		*
280		* @return int
281		*/
282	196	public function getSlideCount()
283		{
284	196	return count($this->slideCollection);
285		}
286
287		/**
288		* Get active slide index
289		*
290		* @return int Active slide index
291		*/
292	1	public function getActiveSlideIndex()
293		{
294	1	return $this->activeSlideIndex;
295		}
296
297		/**
298		* Set active slide index
299		*
300		* @param int $index Active slide index
301		* @throws \Exception
302		* @return \PhpOffice\PhpPresentation\Slide
303		*/
304	222	public function setActiveSlideIndex($index = 0)
305		{
306	222	if ($index > count($this->slideCollection) - 1) {
307	1	throw new \Exception("Active slide index is out of bounds.");
308		}
309	222	$this->activeSlideIndex = $index;
310
311	222	return $this->getActiveSlide();
312		}
313
314		/**
315		* Add external slide
316		*
317		* @param \PhpOffice\PhpPresentation\Slide $slide External slide to add
318		* @throws \Exception
319		* @return \PhpOffice\PhpPresentation\Slide
320		*/
321	1	public function addExternalSlide(Slide $slide)
322		{
323	1	$slide->rebindParent($this);
324
325	1	$this->addMasterSlide($slide->getSlideLayout()->getSlideMaster());
326
327	1	return $this->addSlide($slide);
328		}
329
330		/**
331		* Get slide iterator
332		*
333		* @return \PhpOffice\PhpPresentation\Slide\Iterator
334		*/
335	1	public function getSlideIterator()
336		{
337	1	return new Iterator($this);
338		}
339
340		/**
341		* Create a masterslide and add it to this presentation
342		*
343		* @return \PhpOffice\PhpPresentation\Slide\SlideMaster
344		* @throws \Exception
345		*/
346	222	public function createMasterSlide()
347		{
348	222	$newMasterSlide = new SlideMaster($this);
349	222	$this->addMasterSlide($newMasterSlide);
350	222	return $newMasterSlide;
351		}
352
353		/**
354		* Add masterslide
355		*
356		* @param \PhpOffice\PhpPresentation\Slide\SlideMaster $slide
357		* @return \PhpOffice\PhpPresentation\Slide\SlideMaster
358		* @throws \Exception
359		*/
360	222	public function addMasterSlide(SlideMaster $slide = null)
361		{
362	222	$this->slideMasters[] = $slide;
363
364	222	return $slide;
365		}
366
367		/**
368		* Copy presentation (!= clone!)
369		*
370		* @return PhpPresentation
371		* @throws \Exception
372		*/
373	1	public function copy()
374		{
375	1	$copied = clone $this;
376
377	1	$slideCount = count($this->slideCollection);
378	1	for ($i = 0; $i < $slideCount; ++$i) {
379	1	$this->slideCollection[$i] = $this->slideCollection[$i]->copy();
380	1	$this->slideCollection[$i]->rebindParent($this);
381		}
382
383	1	return $copied;
384		}
385
386		/**
387		* Mark a document as final
388		* @param bool $state
389		* @return PresentationProperties
390		* @deprecated for getPresentationProperties()->markAsFinal()
391		*/
392	1	public function markAsFinal($state = true)
393		{
394	1	return $this->getPresentationProperties()->markAsFinal($state);
395		}
396
397		/**
398		* Return if this document is marked as final
399		* @return bool
400		* @deprecated for getPresentationProperties()->isMarkedAsFinal()
401		*/
402	1	public function isMarkedAsFinal()
403		{
404	1	return $this->getPresentationProperties()->isMarkedAsFinal();
405		}
406
407		/**
408		* Set the zoom of the document (in percentage)
409		* @param float $zoom
410		* @return PresentationProperties
411		* @deprecated for getPresentationProperties()->setZoom()
412		*/
413	1	public function setZoom($zoom = 1.0)
414		{
415	1	return $this->getPresentationProperties()->setZoom($zoom);
416		}
417
418		/**
419		* Return the zoom (in percentage)
420		* @return float
421		* @deprecated for getPresentationProperties()->getZoom()
422		*/
423	1	public function getZoom()
424		{
425	1	return $this->getPresentationProperties()->getZoom();
426		}
427
428		/**
429		* @return \ArrayObject\|Slide\SlideMaster[]
430		*/
431	222	public function getAllMasterSlides()
432		{
433	222	return $this->slideMasters;
434		}
435
436		/**
437		* @param \ArrayObject\|Slide\SlideMaster[] $slideMasters
438		* @return $this
439		*/
440	4	public function setAllMasterSlides($slideMasters = array())
441		{
442	4	if ($slideMasters instanceof \ArrayObject \|\| is_array($slideMasters)) {
443	4	$this->slideMasters = $slideMasters;
444		}
445	4	return $this;
446		}
447		}
448

PHPOffice / PHPPresentation

Push — develop ( d9e4d8...cd1d80 )

PhpPresentation::getProperties() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like