Gitonomy\Git\Repository::getDescription PHP Méthode

getDescription() public méthode

Returns description of repository from description file in git directory.
public getDescription ( ) : string
Résultat string The description
    public function getDescription()
    {
        $file = $this->gitDir . '/description';
        $exists = is_file($file);
        if (null !== $this->logger && true === $this->debug) {
            if (false === $exists) {
                $this->logger->debug(sprintf('no description file in repository ("%s")', $file));
            } else {
                $this->logger->debug(sprintf('reading description file in repository ("%s")', $file));
            }
        }
        if (false === $exists) {
            return static::DEFAULT_DESCRIPTION;
        }
        return file_get_contents($this->gitDir . '/description');
    }