Completed
Pull Request — 1.0.x (#1420)
by Andreas
10:22 queued 01:18
created

DocumentManagerHelper::getName()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 4
ccs 0
cts 4
cp 0
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
crap 2
1
<?php
2
/*
3
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14
 *
15
 * This software consists of voluntary contributions made by many individuals
16
 * and is licensed under the MIT license. For more information, see
17
 * <http://www.doctrine-project.org>.
18
 */
19
20
namespace Doctrine\ODM\MongoDB\Tools\Console\Helper;
21
22
use Doctrine\ODM\MongoDB\DocumentManager;
23
use Symfony\Component\Console\Helper\Helper;
24
25
/**
26
 * Symfony console component helper for accessing a DocumentManager instance.
27
 *
28
 * @since  1.0
29
 * @author Bulat Shakirzyanov <[email protected]>
30
 */
31
class DocumentManagerHelper extends Helper
32
{
33
    protected $dm;
34
35
    /**
36
     * Constructor.
37
     *
38
     * @param DocumentManager $dm
39
     */
40
    public function __construct(DocumentManager $dm)
41
    {
42
        $this->dm = $dm;
43
    }
44
45
    /**
46
     * Get the DocumentManager instance.
47
     *
48
     * @return DocumentManager
49
     */
50
    public function getDocumentManager()
51
    {
52
        return $this->dm;
53
    }
54
55
    /**
56
     * Get the canonical name of this helper.
57
     *
58
     * @see \Symfony\Component\Console\Helper\HelperInterface::getName()
59
     * @return string
60
     */
61
    public function getName()
62
    {
63
        return 'documentManager';
64
    }
65
}
66