Surfnet\StepupSelfService\SelfServiceBundle\Service\ApplicationHelper

Complexity

Total Complexity

2

Size/Duplication

Total Lines	26
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getApplicationVersion()	0	5	1

<?php

declare(strict_types = 1);

/**
 * Copyright 2020 SURFnet B.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Surfnet\StepupSelfService\SelfServiceBundle\Service;

use Surfnet\StepupSelfService\SelfServiceBundle\Assert;

class ApplicationHelper

Missing doc comment for class ApplicationHelper

{
    private $kernelProjectDir;

Private member variable "kernelProjectDir" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @param string $kernelProjectDir

Missing parameter comment

     */
    public function __construct($kernelProjectDir)
    {
        Assert::string($kernelProjectDir, 'Kernel project directory must have a string value');
        $this->kernelProjectDir = $kernelProjectDir;
    }

    /**
     * In stepup application, the installation path includes the software version. This is the version that can be
     * read on the `/info` endpoint.
     *
     * For development builds, this will probably simply be Stepup-SelfService
     *
     * @return string
     */
    public function getApplicationVersion(): string
    {
        // The buildPath (version string) is the installation directory of the project. And is derived from the
        // kernel.project_dir (which is the app folder).
        return basename(realpath($this->kernelProjectDir));
    }
}