Completed
Push — dev ( c5a23f...f84598 )
by James Ekow Abaka
09:41
created

Helper::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 1
1
<?php
2
/*
3
 * Ntentan Framework
4
 * Copyright (c) 2010-2012 James Ekow Abaka Ainooson
5
 * 
6
 * Permission is hereby granted, free of charge, to any person obtaining
7
 * a copy of this software and associated documentation files (the
8
 * "Software"), to deal in the Software without restriction, including
9
 * without limitation the rights to use, copy, modify, merge, publish,
10
 * distribute, sublicense, and/or sell copies of the Software, and to
11
 * permit persons to whom the Software is furnished to do so, subject to
12
 * the following conditions:
13
 * 
14
 * The above copyright notice and this permission notice shall be
15
 * included in all copies or substantial portions of the Software.
16
 * 
17
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
21
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
22
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
23
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
24
 */
25
26
namespace ntentan\honam\engines\php;
27
28
29
use ntentan\honam\TemplateRenderer;
30
31
/**
32
 * Base class for helpers. Helpers are little utilities that make it possible to
33
 * perform repetitively routine tasks in views.
34
 */
35
class Helper
36
{
37
    /**
38
     * The base url of the app. Used by helpers which need to build full URLS.
39
     * This variable is used in the Helper::makeFullUrl method.
40
     * @var string
41
     */
42
    private $baseUrl;
43
44
    protected $templateRenderer;
45
46
    public function __construct(TemplateRenderer $templateRenderer)
47
    {
48
        $this->templateRenderer = $templateRenderer;
49
    }
50
51
52
    /**
53
     * A sort of constructor or entry point for helpers.
54
     * @param mixed $arguments
55
     * @return Helper
56
     */
57
    public function help($arguments)
58
    {
59
        return $this;
60
    }
61
    
62
    /**
63
     * Set the base url used in the helpers.
64
     * @param string $url The new base url
65
     */
66
    public function setBaseUrl($url)
67
    {
68
        $this->baseUrl = $url;
69
    }
70
    
71
    /**
72
     * Generate a full url by concatenating the base url with a path.
73
     * 
74
     * @param string $url
75
     * @return string
76
     */
77
    protected function makeFullUrl($url)
78
    {
79
        return $this->baseUrl . "$url";
80
    }
81
82
}
83