Transaction::getCommitMsg() - Code Metrics - teqneers/PHP-Stream-Wrapper-for-Git - Measure and Improve Code Quality continuously with Scrutinizer

Transaction::getCommitMsg() A
last analyzed 2018-03-19 14:46 UTC

↳ Parent: Transaction

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php
/*
 * Copyright (C) 2017 by TEQneers GmbH & Co. KG
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

/**
 * Git Stream Wrapper for PHP
 *
 * @category   TQ
 * @package    TQ_VCS
 * @subpackage VCS
 * @copyright  Copyright (C) 2018 by TEQneers GmbH & Co. KG
 */

namespace TQ\Vcs\Repository;

/**
 * Encapsulates arguments passed to and from a transactional piece of code
 *
 * @author     Stefan Gehrig <gehrigteqneers.de>
 * @category   TQ
 * @package    TQ_VCS
 * @subpackage VCS
 * @copyright  Copyright (C) 2018 by TEQneers GmbH & Co. KG
 */
class Transaction
{
    /**
     * The VCS repository
     *
     * @var RepositoryInterface
     */
    protected $repository;

    /**
     * The commit message
     *
     * @var string|null
     */
    protected $commitMsg;

    /**
     * The author
     *
     * @var string|null
     */
    protected $author;

    /**
     * The return value of the transactional callback
     *
     * @var mixed
     */
    protected $result;

    /**
     * The commit hash
     *
     * @var string|null
     */
    protected $commitHash;

    /**
     * Creates a new transactional parameter
     *
     * @param   RepositoryInterface  $repository     The VCS repository
     */
    public function __construct(RepositoryInterface $repository)
    {
        $this->repository   = $repository;
    }

    /**
     * Returns the VCS repository
     *
     * @return  RepositoryInterface
     */
    public function getRepository()
    {
        return $this->repository;
    }

    /**
     * Returns the full file system path to the VCS repository
     *
     * @return  string
     */
    public function getRepositoryPath()
    {
        return $this->getRepository()->getRepositoryPath();
    }

    /**
     * Resolves a path relative to the repository into an absolute path
     *
     * @param   string  $path   The relative path to convert to an absolute  path
     * @return  string
     */
    public function resolvePath($path)
    {
        return $this->getRepository()->resolveFullPath($path);
    }

    /**
     * Returns the commit message that will be used when committing the transaction
     *
     * @return  string|null
     */
    public function getCommitMsg()
    {
        return $this->commitMsg;
    }

    /**
     * Sets  the commit message that will be used when committing the transaction
     *
     * @param   string|null $commitMsg      The commit message
     * @return  Transaction
     */
    public function setCommitMsg($commitMsg)
    {
        if ($commitMsg === null) {
            $this->commitMsg    = null;
        } else {
            $this->commitMsg    = (string)$commitMsg;
        }
        return $this;
    }

    /**
     * Returns the author that will be used when committing the transaction
     *
     * @return  string|null
     */
    public function getAuthor()
    {
        return $this->author;
    }

    /**
     * Sets  the author that will be used when committing the transaction
     *
     * @param   string|null     $author      The author
     * @return  Transaction
     */
    public function setAuthor($author)
    {
        if ($author === null) {
            $this->author    = null;
        } else {
            $this->author    = (string)$author;
        }
        return $this;
    }

    /**
     * Returns the return value of the closure executed in the transactional scope
     *
     * @return  mixed
     */
    public function getResult()
    {
        return $this->result;
    }

    /**
     * Sets the return value of the closure executed in the transactional scope
     *
     * @param   mixed $result       The return value
     * @return  Transaction
     */
    public function setResult($result)
    {
        $this->result   = $result;
        return $this;
    }

    /**
     * Returns the hash identifying the commit
     *
     * @return  string|null
     */
    public function getCommitHash()
    {
        return $this->commitHash;
    }

    /**
     * Sets the hash identifying the commit
     *
     * @param   string  $commitHash     The commit hash
     * @return  Transaction
     */
    public function setCommitHash($commitHash)
    {
        $this->commitHash   = $commitHash;
        return $this;
    }
}


1		<?php
2		/*
3		* Copyright (C) 2017 by TEQneers GmbH & Co. KG
4		*
5		* Permission is hereby granted, free of charge, to any person obtaining a copy
6		* of this software and associated documentation files (the "Software"), to deal
7		* in the Software without restriction, including without limitation the rights
8		* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9		* copies of the Software, and to permit persons to whom the Software is
10		* furnished to do so, subject to the following conditions:
11		*
12		* The above copyright notice and this permission notice shall be included in
13		* all copies or substantial portions of the Software.
14		*
15		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17		* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18		* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19		* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20		* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21		* THE SOFTWARE.
22		*/
23
24		/**
25		* Git Stream Wrapper for PHP
26		*
27		* @category TQ
28		* @package TQ_VCS
29		* @subpackage VCS
30		* @copyright Copyright (C) 2018 by TEQneers GmbH & Co. KG
31		*/
32
33		namespace TQ\Vcs\Repository;
34
35		/**
36		* Encapsulates arguments passed to and from a transactional piece of code
37		*
38		* @author Stefan Gehrig <gehrigteqneers.de>
39		* @category TQ
40		* @package TQ_VCS
41		* @subpackage VCS
42		* @copyright Copyright (C) 2018 by TEQneers GmbH & Co. KG
43		*/
44		class Transaction
45		{
46		/**
47		* The VCS repository
48		*
49		* @var RepositoryInterface
50		*/
51		protected $repository;
52
53		/**
54		* The commit message
55		*
56		* @var string\|null
57		*/
58		protected $commitMsg;
59
60		/**
61		* The author
62		*
63		* @var string\|null
64		*/
65		protected $author;
66
67		/**
68		* The return value of the transactional callback
69		*
70		* @var mixed
71		*/
72		protected $result;
73
74		/**
75		* The commit hash
76		*
77		* @var string\|null
78		*/
79		protected $commitHash;
80
81		/**
82		* Creates a new transactional parameter
83		*
84		* @param RepositoryInterface $repository The VCS repository
85		*/
86	8	public function __construct(RepositoryInterface $repository)
87		{
88	8	$this->repository = $repository;
89	8	}
90
91		/**
92		* Returns the VCS repository
93		*
94		* @return RepositoryInterface
95		*/
96	6	public function getRepository()
97		{
98	6	return $this->repository;
99		}
100
101		/**
102		* Returns the full file system path to the VCS repository
103		*
104		* @return string
105		*/
106	4	public function getRepositoryPath()
107		{
108	4	return $this->getRepository()->getRepositoryPath();
109		}
110
111		/**
112		* Resolves a path relative to the repository into an absolute path
113		*
114		* @param string $path The relative path to convert to an absolute path
115		* @return string
116		*/
117	2	public function resolvePath($path)
118		{
119	2	return $this->getRepository()->resolveFullPath($path);
120		}
121
122		/**
123		* Returns the commit message that will be used when committing the transaction
124		*
125		* @return string\|null
126		*/
127	4	public function getCommitMsg()
128		{
129	4	return $this->commitMsg;
130		}
131
132		/**
133		* Sets the commit message that will be used when committing the transaction
134		*
135		* @param string\|null $commitMsg The commit message
136		* @return Transaction
137		*/
138	6	public function setCommitMsg($commitMsg)
139		{
140	6	if ($commitMsg === null) {
141		$this->commitMsg = null;
142		} else {
143	6	$this->commitMsg = (string)$commitMsg;
144		}
145	6	return $this;
146		}
147
148		/**
149		* Returns the author that will be used when committing the transaction
150		*
151		* @return string\|null
152		*/
153	4	public function getAuthor()
154		{
155	4	return $this->author;
156		}
157
158		/**
159		* Sets the author that will be used when committing the transaction
160		*
161		* @param string\|null $author The author
162		* @return Transaction
163		*/
164		public function setAuthor($author)
165		{
166		if ($author === null) {
167		$this->author = null;
168		} else {
169		$this->author = (string)$author;
170		}
171		return $this;
172		}
173
174		/**
175		* Returns the return value of the closure executed in the transactional scope
176		*
177		* @return mixed
178		*/
179	6	public function getResult()
180		{
181	6	return $this->result;
182		}
183
184		/**
185		* Sets the return value of the closure executed in the transactional scope
186		*
187		* @param mixed $result The return value
188		* @return Transaction
189		*/
190	6	public function setResult($result)
191		{
192	6	$this->result = $result;
193	6	return $this;
194		}
195
196		/**
197		* Returns the hash identifying the commit
198		*
199		* @return string\|null
200		*/
201	6	public function getCommitHash()
202		{
203	6	return $this->commitHash;
204		}
205
206		/**
207		* Sets the hash identifying the commit
208		*
209		* @param string $commitHash The commit hash
210		* @return Transaction
211		*/
212	6	public function setCommitHash($commitHash)
213		{
214	6	$this->commitHash = $commitHash;
215	6	return $this;
216		}
217		}
218

teqneers / PHP-Stream-Wrapper-for-Git

Transaction::getCommitMsg() A last analyzed 2018-03-19 14:46 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Transaction::getCommitMsg() A
last analyzed 2018-03-19 14:46 UTC