Fix docblocks

This commit is contained in:
Dennis Eichhorn 2017-11-05 15:56:40 +01:00
parent ce80ffadc6
commit d1eac07521
13 changed files with 53 additions and 32 deletions

View File

@ -51,7 +51,7 @@ class Metrics {
* @latex r = com^{2} \times (1 - cov)^{3} + com * @latex r = com^{2} \times (1 - cov)^{3} + com
* *
* @param int $complexity Complexity * @param int $complexity Complexity
* @param int $coverage Coverage * @param float $coverage Coverage
* *
* @return int * @return int
* *

View File

@ -229,6 +229,7 @@ class Builder extends BuilderAbstract
* Constructor. * Constructor.
* *
* @param ConnectionAbstract $connection Database connection * @param ConnectionAbstract $connection Database connection
* @param bool $readOnly Query is read only
* *
* @since 1.0.0 * @since 1.0.0
*/ */
@ -352,6 +353,8 @@ class Builder extends BuilderAbstract
* *
* @return Builder * @return Builder
* *
* @throws \Exception
*
* @since 1.0.0 * @since 1.0.0
*/ */
public function raw(string $raw) : Builder public function raw(string $raw) : Builder
@ -420,7 +423,7 @@ class Builder extends BuilderAbstract
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function distinct(...$columns) : Builder public function distinct() : Builder
{ {
$this->distinct = true; $this->distinct = true;
@ -551,6 +554,8 @@ class Builder extends BuilderAbstract
* Where and sub condition. * Where and sub condition.
* *
* @param Where $where Where sub condition * @param Where $where Where sub condition
* @param mixed $operator Operator
* @param mixed $values Values
* *
* @return Builder * @return Builder
* *
@ -565,6 +570,8 @@ class Builder extends BuilderAbstract
* Where or sub condition. * Where or sub condition.
* *
* @param Where $where Where sub condition * @param Where $where Where sub condition
* @param mixed $operator Operator
* @param mixed $values Values
* *
* @return Builder * @return Builder
* *
@ -853,6 +860,8 @@ class Builder extends BuilderAbstract
* *
* @return Builder * @return Builder
* *
* @throws \Exception
*
* @since 1.0.0 * @since 1.0.0
*/ */
public function insert(...$columns) : Builder public function insert(...$columns) : Builder
@ -958,10 +967,12 @@ class Builder extends BuilderAbstract
/** /**
* Update columns. * Update columns.
* *
* @param array $columns Column names to update * @param array $tables Column names to update
* *
* @return Builder * @return Builder
* *
* @throws \Exception
*
* @since 1.0.0 * @since 1.0.0
*/ */
public function update(...$tables) : Builder public function update(...$tables) : Builder
@ -1130,16 +1141,20 @@ class Builder extends BuilderAbstract
/** /**
* Get bind parameter type. * Get bind parameter type.
* *
* @param mixed $value Value to bind
*
* @return mixed * @return mixed
* *
* @throws \Exception
*
* @since 1.0.0 * @since 1.0.0
*/ */
public static function getBindParamType($value) public static function getBindParamType($value)
{ {
if (is_int($value)) { if (is_int($value)) {
return PDO::PARAM_INT; return \PDO::PARAM_INT;
} elseif (is_string($value) || is_float($value)) { } elseif (is_string($value) || is_float($value)) {
return PDO::PARAM_STR; return \PDO::PARAM_STR;
} }
throw new \Exception(); throw new \Exception();

View File

@ -172,7 +172,7 @@ class Grammar extends GrammarAbstract
* Compile select. * Compile select.
* *
* @param Builder $query Builder * @param Builder $query Builder
* @param array $columns Columns * @param array $table Table
* *
* @return string * @return string
* *

View File

@ -197,7 +197,7 @@ class FileLogger implements LoggerInterface
* *
* @param string $id the ID by which this time measurement gets identified * @param string $id the ID by which this time measurement gets identified
* *
* @return int The time measurement in ms * @return float The time measurement in ms
* *
* @since 1.0.0 * @since 1.0.0
*/ */

View File

@ -165,7 +165,7 @@ class LUDecomposition
for ($k = 0; $k < $this->n; ++$k) { for ($k = 0; $k < $this->n; ++$k) {
for ($i = $k + 1; $i < $this->n; ++$i) { for ($i = $k + 1; $i < $this->n; ++$i) {
for ($j = 0; $j < $nx; ++$j) { for ($j = 0; $j < $nx; ++$j) {
$X->A[$i][$j] -= $X->A[$k][$j] * $this->LU[$i][$k]; $X[$i][$j] -= $X[$k][$j] * $this->LU[$i][$k];
} }
} }
} }
@ -173,11 +173,11 @@ class LUDecomposition
// Solve U*X = Y; // Solve U*X = Y;
for ($k = $this->n - 1; $k >= 0; --$k) { for ($k = $this->n - 1; $k >= 0; --$k) {
for ($j = 0; $j < $nx; ++$j) { for ($j = 0; $j < $nx; ++$j) {
$X->A[$k][$j] /= $this->LU[$k][$k]; $X[$k][$j] /= $this->LU[$k][$k];
} }
for ($i = 0; $i < $k; ++$i) { for ($i = 0; $i < $k; ++$i) {
for ($j = 0; $j < $nx; ++$j) { for ($j = 0; $j < $nx; ++$j) {
$X->A[$i][$j] -= $X->A[$k][$j] * $this->LU[$i][$k]; $X[$i][$j] -= $X[$k][$j] * $this->LU[$i][$k];
} }
} }
} }

View File

@ -32,7 +32,7 @@ class EmailAbstract
* @var string * @var string
* @since 1.0.0 * @since 1.0.0
*/ */
private $host = ''; protected $host = '';
/** /**
* Port. * Port.
@ -40,7 +40,7 @@ class EmailAbstract
* @var int * @var int
* @since 1.0.0 * @since 1.0.0
*/ */
private $port = 25; protected $port = 25;
/** /**
* Use ssl. * Use ssl.
@ -48,7 +48,7 @@ class EmailAbstract
* @var bool * @var bool
* @since 1.0.0 * @since 1.0.0
*/ */
private $ssl = false; protected $ssl = false;
/** /**
* Mailbox base. * Mailbox base.
@ -56,7 +56,7 @@ class EmailAbstract
* @var string * @var string
* @since 1.0.0 * @since 1.0.0
*/ */
private $mailbox = ''; protected $mailbox = '';
/** /**
* Timeout. * Timeout.
@ -64,7 +64,7 @@ class EmailAbstract
* @var int * @var int
* @since 1.0.0 * @since 1.0.0
*/ */
private $timeout = 30; protected $timeout = 30;
/** /**
* Construct * Construct
@ -92,21 +92,21 @@ class EmailAbstract
/** /**
* Decode * Decode
* *
* @param string $host Content to decode * @param string $content Content to decode
* @param int $encoding Encoding type * @param int $encoding Encoding type
* *
* @return string
*
* @since 1.0.0 * @since 1.0.0
*/ */
public static function decode(string $content, int $encoding) public static function decode(string $content, int $encoding)
{ {
if ($encoding == 3) { if ($encoding == 3) {
return imap_base64($content); return imap_base64($content);
} elseif ($encoding == 1) {
return imap_8bit($content);
} else { } else {
if ($encoding == 1) { return imap_qprint($content);
return imap_8bit($content);
} else {
return imap_qprint($content);
}
} }
} }

View File

@ -15,8 +15,6 @@ declare(strict_types = 1);
namespace phpOMS\Message; namespace phpOMS\Message;
use phpOMS\Utils\ArrayUtils;
/** /**
* Response abstract class. * Response abstract class.
* *

View File

@ -20,6 +20,7 @@ use phpOMS\System\File\Local\File;
use phpOMS\System\File\Local\Directory; use phpOMS\System\File\Local\Directory;
use phpOMS\System\File\Local\LocalStorage; use phpOMS\System\File\Local\LocalStorage;
use phpOMS\Utils\IO\Zip\Zip; use phpOMS\Utils\IO\Zip\Zip;
use phpOMS\Utils\StringUtils;
/** /**
* Package Manager model. * Package Manager model.
@ -128,13 +129,11 @@ class PackageManager
/** /**
* Hash array of files * Hash array of files
* *
* @param array $files Files to hash
*
* @return string Hash value of files * @return string Hash value of files
* *
* @since 1.0.0 * @since 1.0.0
*/ */
private function hashFiles(array $files) : string private function hashFiles() : string
{ {
$files = Directory::list($this->extractPath . '/package'); $files = Directory::list($this->extractPath . '/package');
$state = \sodium_crypto_generichash_init(); $state = \sodium_crypto_generichash_init();
@ -155,6 +154,8 @@ class PackageManager
* *
* @return void * @return void
* *
* @throws \Exception
*
* @since 1.0.0 * @since 1.0.0
*/ */
public function install() /* : void */ public function install() /* : void */
@ -172,6 +173,8 @@ class PackageManager
/** /**
* Move files * Move files
*
* @param mixed $components Component data
* *
* @return void * @return void
* *
@ -186,6 +189,8 @@ class PackageManager
/** /**
* Copy files * Copy files
*
* @param mixed $components Component data
* *
* @return void * @return void
* *
@ -204,6 +209,8 @@ class PackageManager
/** /**
* Delete files * Delete files
*
* @param mixed $components Component data
* *
* @return void * @return void
* *
@ -218,6 +225,8 @@ class PackageManager
/** /**
* Execute commands * Execute commands
*
* @param mixed $components Component data
* *
* @return void * @return void
* *
@ -245,6 +254,9 @@ class PackageManager
/** /**
* Authenticate package * Authenticate package
*
* @param string $signedHash Hash to authenticate
* @param string $rawHash Hash to compare against
* *
* @return bool * @return bool
* *

View File

@ -66,7 +66,7 @@ interface ContainerInterface
* *
* @param string $path Path of the resource * @param string $path Path of the resource
* *
* @return string Permissions (e.g. 0644); * @return int Permissions (e.g. 0644);
* *
* @since 1.0.0 * @since 1.0.0
*/ */

View File

@ -17,8 +17,6 @@ namespace phpOMS\System\File\Ftp;
use phpOMS\System\File\ContainerInterface; use phpOMS\System\File\ContainerInterface;
use phpOMS\System\File\DirectoryInterface; use phpOMS\System\File\DirectoryInterface;
use phpOMS\System\File\PathException;
use phpOMS\Utils\StringUtils;
use phpOMS\System\File\Local\FileAbstract; use phpOMS\System\File\Local\FileAbstract;
use phpOMS\System\File\Local\Directory as DirectoryLocal; use phpOMS\System\File\Local\Directory as DirectoryLocal;

View File

@ -19,7 +19,6 @@ use phpOMS\Localization\ISO4217CharEnum;
use phpOMS\Message\Http\Rest; use phpOMS\Message\Http\Rest;
use phpOMS\Message\Http\Request; use phpOMS\Message\Http\Request;
use phpOMS\Message\Http\RequestMethod; use phpOMS\Message\Http\RequestMethod;
use phpOMS\Localization\Localization;
use phpOMS\Uri\Http; use phpOMS\Uri\Http;
/** /**

View File

@ -162,7 +162,7 @@ class GS
public function unserialize($raw) public function unserialize($raw)
{ {
$split = explode($raw); $split = explode($raw, '*');
$this->setFunctionalGroupHeader(trim($split[0])); $this->setFunctionalGroupHeader(trim($split[0]));
$this->setFunctionalIdentifierCode(trim($split[1])); $this->setFunctionalIdentifierCode(trim($split[1]));

View File

@ -16,7 +16,6 @@ declare(strict_types = 1);
namespace phpOMS\Utils\IO\Zip; namespace phpOMS\Utils\IO\Zip;
use phpOMS\System\File\FileUtils; use phpOMS\System\File\FileUtils;
use phpOMS\Utils\StringUtils;
/** /**
* Zip class for handling zip files. * Zip class for handling zip files.