SegmentedExporter::getFormattedFilename() - Code Metrics - Inspection of "Merge pull request #1 from pascalbaljetmedia/hls-s..." - protonemedia/laravel-ffmpeg - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a002fc...0420c5 )

by Pascal

created 2016-09-19 18:19 UTC

SegmentedExporter::getFormattedFilename() A

↳ Parent: SegmentedExporter

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	1

<?php

namespace Pbmedia\LaravelFFMpeg;

class SegmentedExporter extends MediaExporter
{
    protected $filter;

    protected $playlistPath;

    protected $segmentLength = 10;

    protected $saveMethod = 'saveStream';

    public function setPlaylistPath(string $playlistPath): MediaExporter
    {
        $this->playlistPath = $playlistPath;

        return $this;
    }

    public function setSegmentLength(int $segmentLength): MediaExporter
    {
        $this->segmentLength = $segmentLength;

        return $this;
    }

    public function getFilter(): SegmentedFilter
    {
        if ($this->filter) {
            return $this->filter;
        }

        return $this->filter = new SegmentedFilter(
            $this->getPlaylistFilename(),
            $this->segmentLength
        );
    }

    public function saveStream(string $playlistPath): MediaExporter
    {
        $this->setPlaylistPath($playlistPath);

        $this->media->addFilter(
            $this->getFilter()
        );

        $this->media->save(
            $this->getFormat(),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $this->getSegmentFullPath()
        );

        return $this;
    }

    public function getSegmentFullPath(): string
    {
        return implode(DIRECTORY_SEPARATOR, [
            pathinfo($this->playlistPath, PATHINFO_DIRNAME),
            $this->getSegmentFilename(),
        ]);
    }

    public function getPlaylistPath(): string
    {
        return $this->playlistPath;
    }

    public function getPlaylistName(): string
    {
        return pathinfo($this->getPlaylistPath(), PATHINFO_FILENAME);
    }

    public function getPlaylistFilename(): string
    {
        return $this->getFormattedFilename('.m3u8');
    }

    public function getSegmentFilename(): string
    {
        return $this->getFormattedFilename('_%05d.ts');
    }

    protected function getFormattedFilename(string $suffix = ''): string
    {
        return implode([
            $this->getPlaylistName(),
            '_',
            $this->getFormat()->getKiloBitrate(),
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        ]) . $suffix;
    }
}


1			<?php
2
3			namespace Pbmedia\LaravelFFMpeg;
4
5			class SegmentedExporter extends MediaExporter
6			{
7			protected $filter;
8
9			protected $playlistPath;
10
11			protected $segmentLength = 10;
12
13			protected $saveMethod = 'saveStream';
14
15			public function setPlaylistPath(string $playlistPath): MediaExporter
16			{
17			$this->playlistPath = $playlistPath;
18
19			return $this;
20			}
21
22			public function setSegmentLength(int $segmentLength): MediaExporter
23			{
24			$this->segmentLength = $segmentLength;
25
26			return $this;
27			}
28
29			public function getFilter(): SegmentedFilter
30			{
31			if ($this->filter) {
32			return $this->filter;
33			}
34
35			return $this->filter = new SegmentedFilter(
36			$this->getPlaylistFilename(),
37			$this->segmentLength
38			);
39			}
40
41			public function saveStream(string $playlistPath): MediaExporter
42			{
43			$this->setPlaylistPath($playlistPath);
44
45			$this->media->addFilter(
46			$this->getFilter()
47			);
48
49			$this->media->save(
50			$this->getFormat(),
			0 ignored issues – show Documentation introduced 2016-09-19 18:26 UTC by Report Bug Copy Issue Report `$this->getFormat()` is of type `object<FFMpeg\Format\FormatInterface>`, but the function expects a `object<Pbmedia\LaravelFFMpeg\FormatInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
51			$this->getSegmentFullPath()
52			);
53
54			return $this;
55			}
56
57			public function getSegmentFullPath(): string
58			{
59			return implode(DIRECTORY_SEPARATOR, [
60			pathinfo($this->playlistPath, PATHINFO_DIRNAME),
61			$this->getSegmentFilename(),
62			]);
63			}
64
65			public function getPlaylistPath(): string
66			{
67			return $this->playlistPath;
68			}
69
70			public function getPlaylistName(): string
71			{
72			return pathinfo($this->getPlaylistPath(), PATHINFO_FILENAME);
73			}
74
75			public function getPlaylistFilename(): string
76			{
77			return $this->getFormattedFilename('.m3u8');
78			}
79
80			public function getSegmentFilename(): string
81			{
82			return $this->getFormattedFilename('_%05d.ts');
83			}
84
85			protected function getFormattedFilename(string $suffix = ''): string
86			{
87			return implode([
88			$this->getPlaylistName(),
89			'_',
90			$this->getFormat()->getKiloBitrate(),
			0 ignored issues – show Bug introduced 2016-09-19 18:26 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `FFMpeg\Format\FormatInterface` as the method `getKiloBitrate()` does only exist in the following implementations of said interface: `FFMpeg\Format\Video\DefaultVideo`, `FFMpeg\Format\Video\Ogg`, `FFMpeg\Format\Video\WMV`, `FFMpeg\Format\Video\WMV3`, `FFMpeg\Format\Video\WebM`, `FFMpeg\Format\Video\X264`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
91			]) . $suffix;
92			}
93			}
94

protonemedia / laravel-ffmpeg

Push — master ( a002fc...0420c5 )

SegmentedExporter::getFormattedFilename() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like