alumnforce / coding-conventions Goto Github PK

<?php

namespace Stripe\Model\Configuration;

class Repository
{

/**
 * This class contains methods that give the information
 * about what env the application is working on.
 *
 * Usage:
 *     if ((new EnvironmentChecker())->inProduction()) {
 *         // Do your work knowing that you are in production
 *     } else {
 *         // Do your work knowing that you are in development
 *     }
 */
class EnvironmentChecker

<?php

/*
 * This file is part of AlumnForce.
 *
 * (c) XXXXX <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Stripe\Model\Configuration;

/**
 * @category  Stripe
 * @package   Stripe
 * @author    Nuno Maduro <[email protected]>
 * @copyright 2016 Mevia
 * @license   http://alumnforce.org Private
 */
class Repository

    /**
     * @return boolean <-- Good, if you can't use type-hints.
     */
    public function inProduction()
    {
        return APPLICATION_ENV === self::PRODUCTION;
    }

    public function inProduction(): boolean
    {
        return APPLICATION_ENV === self::PRODUCTION;
    }

    /**
     * Checks if the application is in production. <-- The method name is already understandable.
     *
     * @return boolean
     */
    public function inProduction()
    {
        return APPLICATION_ENV === self::PRODUCTION;
    }

    /**
     * @param $something // <-- No need for this since we have the type hint.
     *
     * @return boolean // <-- No need for this since we have the return hint.
     */
    public function inProduction(string $something): bool
    {
    }

     // For single line comment.

    /**
     * Multiline comments
     * should use
     * this format
     */

    /**
     * @var \Mevia\Tools\EnvironmentChecker // <-- If needed, fully qualified namespace always.
     */
    private $environmentChecker;

class CountryIsoTypeRepository implements CountryIsoTypeRepositoryContract
{
    private $app; // <-- No need for Phpdocs, the constructor is explicit.

    public function __construct(ApplicationContract $app)
    {
        $this->app = $app;
    }

    /**
     * Holds an instance of the EnvironmentChecker. <-- No need for this.
     *
     * @var \Mevia\Tools\EnvironmentChecker
     */
    private $environmentChecker;