Desmond\functions\docs\FileContents

Complexity

Total Complexity

4

Size/Duplication

Total Lines	24
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	id()	0	4	1
A	synopsis()	0	4	1
A	usage()	0	4	1
A	examples()	0	6	1

<?php
namespace Desmond\functions\docs;
use Desmond\functions\Doc;

class FileContents implements Doc
{
    public function id()
    {
        return 'file-contents';
    }

    public function synopsis()
    {
        return 'Reads a file\'s contents into a string and returns it.';
    }

    public function usage()
    {
        return '(file-contents <String>)';
    }

    public function examples()
    {
        return [
            '(file-contents "path/to/file.dsmnd")'
        ];
    }
}