mirror of
https://github.com/Karaka-Management/phpOMS.git
synced 2026-01-11 09:48:40 +00:00
docblock param alignment
This commit is contained in:
parent
e1ef45da2a
commit
11c7b0e626
|
|
@ -1380,7 +1380,7 @@ class FinanceFormulas
|
|||
/**
|
||||
* Relative market share by share
|
||||
*
|
||||
* @param float $ownShare Own market share
|
||||
* @param float $ownShare Own market share
|
||||
* @param float $competitorShare Largest competitor market share
|
||||
*
|
||||
* @return float
|
||||
|
|
@ -1395,7 +1395,7 @@ class FinanceFormulas
|
|||
/**
|
||||
* Relative market share by sales
|
||||
*
|
||||
* @param float $ownSales Own sales
|
||||
* @param float $ownSales Own sales
|
||||
* @param float $competitorSales Largest competitor sales
|
||||
*
|
||||
* @return float
|
||||
|
|
|
|||
|
|
@ -137,9 +137,9 @@ class ClassicalDecomposition
|
|||
/**
|
||||
* Calculate detrended series
|
||||
*
|
||||
* @param array $data Data to analyze
|
||||
* @param array $data Data to analyze
|
||||
* @param array $trendCycleComponent Trend cycle component
|
||||
* @param int $mode Detrend mode
|
||||
* @param int $mode Detrend mode
|
||||
*
|
||||
* @return array Detrended series / seasonal normalized data
|
||||
*
|
||||
|
|
@ -163,7 +163,7 @@ class ClassicalDecomposition
|
|||
*
|
||||
* By using averaging methods some initial data get's incorporated into the average which reduces the data points.
|
||||
*
|
||||
* @param int $dataSize Original data size
|
||||
* @param int $dataSize Original data size
|
||||
* @param int $trendCycleComponents Trend cycle component size
|
||||
*
|
||||
* @return int New data start index
|
||||
|
|
@ -181,7 +181,7 @@ class ClassicalDecomposition
|
|||
* Average of the detrended values for every month, quarter, day etc.
|
||||
*
|
||||
* @param array $detrendedSeries Detrended series
|
||||
* @param int $order Seasonal period (e.g. 4 = quarterly, 12 = monthly, 7 = weekly pattern in daily data)
|
||||
* @param int $order Seasonal period (e.g. 4 = quarterly, 12 = monthly, 7 = weekly pattern in daily data)
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
|
|
@ -208,10 +208,10 @@ class ClassicalDecomposition
|
|||
/**
|
||||
* Calculate the remainder component or error
|
||||
*
|
||||
* @param array $data Raw data
|
||||
* @param array $data Raw data
|
||||
* @param array $trendCycleComponent Trend cycle component
|
||||
* @param array $seasonalComponent Seasonal component
|
||||
* @param int $mode Detrend mode
|
||||
* @param array $seasonalComponent Seasonal component
|
||||
* @param int $mode Detrend mode
|
||||
*
|
||||
* @return array All remainders or absolute errors
|
||||
*
|
||||
|
|
|
|||
|
|
@ -49,8 +49,8 @@ class Metrics
|
|||
*
|
||||
* @latex r = com^{2} \times (1 - cov)^{3} + com
|
||||
*
|
||||
* @param int $complexity Complexity
|
||||
* @param float $coverage Coverage
|
||||
* @param int $complexity Complexity
|
||||
* @param float $coverage Coverage
|
||||
*
|
||||
* @return int
|
||||
*
|
||||
|
|
|
|||
|
|
@ -32,9 +32,9 @@ class MarketShareEstimation
|
|||
*
|
||||
* @latex r = \sqrt[s]{\frac{1}{m \times \sum_{n=1}^N{\frac{1}{n^{s}}}}}
|
||||
*
|
||||
* @param int $participants The amount of existing participants in the market or compentitors (N)
|
||||
* @param float $marketShare The absolute own market share (m)
|
||||
* @param float $modifier Distribution modifier (s)
|
||||
* @param int $participants The amount of existing participants in the market or compentitors (N)
|
||||
* @param float $marketShare The absolute own market share (m)
|
||||
* @param float $modifier Distribution modifier (s)
|
||||
*
|
||||
* @return int Returns the rank
|
||||
*
|
||||
|
|
@ -55,9 +55,9 @@ class MarketShareEstimation
|
|||
*
|
||||
* @latex m = \frac{\frac{1}{r^{s}}}{\sum_{n=1}^N{\frac{1}{n^{s}}}}
|
||||
*
|
||||
* @param int $participants The amount of existing participants in the market or compentitors (N)
|
||||
* @param int $rank The absolute own rank in the market (r)
|
||||
* @param float $modifier Distribution modifier (s)
|
||||
* @param int $participants The amount of existing participants in the market or compentitors (N)
|
||||
* @param int $rank The absolute own rank in the market (r)
|
||||
* @param float $modifier Distribution modifier (s)
|
||||
*
|
||||
* @return float Returns the Market share
|
||||
*
|
||||
|
|
|
|||
|
|
@ -115,7 +115,7 @@ interface CacheInterface
|
|||
*
|
||||
* @param mixed $key Unique cache key
|
||||
* @param mixed $value Cache value
|
||||
* @param int $expire Valid duration (in s)
|
||||
* @param int $expire Valid duration (in s)
|
||||
*
|
||||
* @return bool
|
||||
*
|
||||
|
|
|
|||
|
|
@ -721,7 +721,7 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
* The reference is stored in the main model
|
||||
*
|
||||
* @param string $propertyName Property name to initialize
|
||||
* @param array $obj Object to create
|
||||
* @param array $obj Object to create
|
||||
*
|
||||
* @return mixed
|
||||
*
|
||||
|
|
@ -778,7 +778,7 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
* The reference is stored in the main model
|
||||
*
|
||||
* @param string $propertyName Property name to initialize
|
||||
* @param array $obj Object to create
|
||||
* @param array $obj Object to create
|
||||
*
|
||||
* @return mixed
|
||||
*
|
||||
|
|
@ -963,8 +963,8 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
*
|
||||
* Deletes old entries and creates new ones
|
||||
*
|
||||
* @param array $objsIds Object ids to insert
|
||||
* @param mixed $objId Model to reference
|
||||
* @param array $objsIds Object ids to insert
|
||||
* @param mixed $objId Model to reference
|
||||
*
|
||||
* @return mixed
|
||||
*
|
||||
|
|
@ -1073,7 +1073,7 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
* Update object in db.
|
||||
*
|
||||
* @param Object $obj Model to update
|
||||
* @param mixed $objId Model id
|
||||
* @param mixed $objId Model id
|
||||
* @param \ReflectionClass $reflectionClass Reflection class
|
||||
*
|
||||
* @return mixed
|
||||
|
|
@ -1136,7 +1136,7 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
/**
|
||||
* Update object in db.
|
||||
*
|
||||
* @param mixed $obj Object reference (gets filled with insert id)
|
||||
* @param mixed $obj Object reference (gets filled with insert id)
|
||||
* @param int $relations Create all relations as well
|
||||
*
|
||||
* @return mixed
|
||||
|
|
@ -1180,7 +1180,7 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
* @param \ReflectionClass $reflectionClass Reflection class
|
||||
* @param Object $obj Object to create
|
||||
* @param mixed $objId Id to set
|
||||
* @param int $relations Delete all relations as well
|
||||
* @param int $relations Delete all relations as well
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
@ -1298,8 +1298,8 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
* Delete object in db.
|
||||
*
|
||||
* @param Object $obj Model to delete
|
||||
* @param mixed $objId Model id
|
||||
* @param int $relations Delete all relations as well
|
||||
* @param mixed $objId Model id
|
||||
* @param int $relations Delete all relations as well
|
||||
* @param \ReflectionClass $reflectionClass Reflection class
|
||||
*
|
||||
* @return mixed
|
||||
|
|
@ -1353,7 +1353,7 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
/**
|
||||
* Delete object in db.
|
||||
*
|
||||
* @param mixed $obj Object reference (gets filled with insert id)
|
||||
* @param mixed $obj Object reference (gets filled with insert id)
|
||||
* @param int $relations Create all relations as well
|
||||
*
|
||||
* @return mixed
|
||||
|
|
@ -1522,8 +1522,8 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
/**
|
||||
* Populate data.
|
||||
*
|
||||
* @param mixed $obj Object to add the relations to
|
||||
* @param int $depth Relation depth
|
||||
* @param mixed $obj Object to add the relations to
|
||||
* @param int $depth Relation depth
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
@ -1567,7 +1567,7 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
/**
|
||||
* Populate data.
|
||||
*
|
||||
* @param array $obj Object to add the relations to
|
||||
* @param array $obj Object to add the relations to
|
||||
* @param int $depth Relation depth
|
||||
*
|
||||
* @return void
|
||||
|
|
@ -1588,8 +1588,8 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
/**
|
||||
* Populate data.
|
||||
*
|
||||
* @param mixed $obj Object to add the relations to
|
||||
* @param int $depth Relation depth
|
||||
* @param mixed $obj Object to add the relations to
|
||||
* @param int $depth Relation depth
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
@ -1633,7 +1633,7 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
/**
|
||||
* Populate data.
|
||||
*
|
||||
* @param array $obj Object to add the relations to
|
||||
* @param array $obj Object to add the relations to
|
||||
* @param int $depth Relation depth
|
||||
*
|
||||
* @return void
|
||||
|
|
@ -1654,8 +1654,8 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
/**
|
||||
* Populate data.
|
||||
*
|
||||
* @param mixed $obj Object to add the relations to
|
||||
* @param int $depth Relation depth
|
||||
* @param mixed $obj Object to add the relations to
|
||||
* @param int $depth Relation depth
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
@ -1699,8 +1699,8 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
/**
|
||||
* Populate data.
|
||||
*
|
||||
* @param array $obj Object to add the relations to
|
||||
* @param int $depth Relation depth
|
||||
* @param array $obj Object to add the relations to
|
||||
* @param int $depth Relation depth
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
@ -1810,7 +1810,7 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
* @param mixed $primaryKey Key
|
||||
* @param int $relations Load relations
|
||||
* @param mixed $fill Object to fill
|
||||
* @param int $depth Relation depth
|
||||
* @param int $depth Relation depth
|
||||
*
|
||||
* @return mixed
|
||||
*
|
||||
|
|
@ -1894,7 +1894,7 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
*
|
||||
* @param mixed $primaryKey Key
|
||||
* @param int $relations Load relations
|
||||
* @param int $depth Relation depth
|
||||
* @param int $depth Relation depth
|
||||
*
|
||||
* @return mixed
|
||||
*
|
||||
|
|
@ -1935,11 +1935,11 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
/**
|
||||
* Get object.
|
||||
*
|
||||
* @param mixed $refKey Key
|
||||
* @param string $ref The field that defines the for
|
||||
* @param int $relations Load relations
|
||||
* @param mixed $fill Object to fill
|
||||
* @param int $depth Relation depth
|
||||
* @param mixed $refKey Key
|
||||
* @param string $ref The field that defines the for
|
||||
* @param int $relations Load relations
|
||||
* @param mixed $fill Object to fill
|
||||
* @param int $depth Relation depth
|
||||
*
|
||||
* @return mixed
|
||||
*
|
||||
|
|
@ -1986,10 +1986,10 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
/**
|
||||
* Get object.
|
||||
*
|
||||
* @param mixed $refKey Key
|
||||
* @param string $ref The field that defines the for
|
||||
* @param int $relations Load relations
|
||||
* @param mixed $fill Object to fill
|
||||
* @param mixed $refKey Key
|
||||
* @param string $ref The field that defines the for
|
||||
* @param int $relations Load relations
|
||||
* @param mixed $fill Object to fill
|
||||
*
|
||||
* @return mixed
|
||||
*
|
||||
|
|
@ -2024,9 +2024,9 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
/**
|
||||
* Get object.
|
||||
*
|
||||
* @param int $relations Load relations
|
||||
* @param int $depth Relation depth
|
||||
* @param string $lang Language
|
||||
* @param int $relations Load relations
|
||||
* @param int $depth Relation depth
|
||||
* @param string $lang Language
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
|
|
@ -2052,9 +2052,9 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
/**
|
||||
* Get object.
|
||||
*
|
||||
* @param int $relations Load relations
|
||||
* @param int $depth Relation depth
|
||||
* @param string $lang Language
|
||||
* @param int $relations Load relations
|
||||
* @param int $depth Relation depth
|
||||
* @param string $lang Language
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
|
|
@ -2102,8 +2102,8 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
* @param int $limit Newest limit
|
||||
* @param Builder $query Pre-defined query
|
||||
* @param int $relations Load relations
|
||||
* @param int $depth Relation depth
|
||||
* @param string $lang Language
|
||||
* @param int $depth Relation depth
|
||||
* @param string $lang Language
|
||||
*
|
||||
* @return mixed
|
||||
*
|
||||
|
|
@ -2149,7 +2149,7 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
*
|
||||
* @param Builder $query Query
|
||||
* @param int $relations Relations
|
||||
* @param int $depth Relation depth
|
||||
* @param int $depth Relation depth
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
|
|
@ -2328,8 +2328,8 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
/**
|
||||
* Get object.
|
||||
*
|
||||
* @param mixed $refKey Key
|
||||
* @param string $ref Ref
|
||||
* @param mixed $refKey Key
|
||||
* @param string $ref Ref
|
||||
*
|
||||
* @return mixed
|
||||
*
|
||||
|
|
@ -2354,8 +2354,8 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
/**
|
||||
* Get object.
|
||||
*
|
||||
* @param mixed $refKey Key
|
||||
* @param string $ref Ref
|
||||
* @param mixed $refKey Key
|
||||
* @param string $ref Ref
|
||||
*
|
||||
* @return mixed
|
||||
*
|
||||
|
|
@ -2535,8 +2535,8 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
* Add initialized object to local cache
|
||||
*
|
||||
* @param string $mapper Mapper name
|
||||
* @param mixed $id Object id
|
||||
* @param object $obj Model to cache locally
|
||||
* @param mixed $id Object id
|
||||
* @param object $obj Model to cache locally
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
@ -2555,7 +2555,7 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
* Check if a object is initialized
|
||||
*
|
||||
* @param string $mapper Mapper name
|
||||
* @param mixed $id Object id
|
||||
* @param mixed $id Object id
|
||||
*
|
||||
* @return bool
|
||||
*
|
||||
|
|
@ -2570,7 +2570,7 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
* Get initialized object
|
||||
*
|
||||
* @param string $mapper Mapper name
|
||||
* @param mixed $id Object id
|
||||
* @param mixed $id Object id
|
||||
*
|
||||
* @return mixed
|
||||
*
|
||||
|
|
@ -2585,7 +2585,7 @@ class DataMapperAbstract implements DataMapperInterface
|
|||
* Remove initialized object
|
||||
*
|
||||
* @param string $mapper Mapper name
|
||||
* @param mixed $id Object id
|
||||
* @param mixed $id Object id
|
||||
*
|
||||
* @return mixed
|
||||
*
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ class InvalidConnectionConfigException extends \InvalidArgumentException
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param \Exception $previous Previous exception
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ class InvalidDatabaseTypeException extends \InvalidArgumentException
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param \Exception $previous Previous exception
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ class InvalidMapperException extends \RuntimeException
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param \Exception $previous Previous exception
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -219,7 +219,7 @@ class Builder extends BuilderAbstract
|
|||
* Constructor.
|
||||
*
|
||||
* @param ConnectionAbstract $connection Database connection
|
||||
* @param bool $readOnly Query is read only
|
||||
* @param bool $readOnly Query is read only
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
@ -462,9 +462,9 @@ class Builder extends BuilderAbstract
|
|||
* Where.
|
||||
*
|
||||
* @param Where|string|\Closure|array $columns Columns
|
||||
* @param string|array $operator Operator
|
||||
* @param mixed $values Values
|
||||
* @param string|array $boolean Boolean condition
|
||||
* @param string|array $operator Operator
|
||||
* @param mixed $values Values
|
||||
* @param string|array $boolean Boolean condition
|
||||
*
|
||||
* @return Builder
|
||||
*
|
||||
|
|
@ -524,7 +524,7 @@ class Builder extends BuilderAbstract
|
|||
/**
|
||||
* Get table name of system
|
||||
*
|
||||
* @param mixed $expression System expression
|
||||
* @param mixed $expression System expression
|
||||
* @param string $systemIdentifier System identifier
|
||||
*
|
||||
* @return string|null
|
||||
|
|
@ -543,9 +543,9 @@ class Builder extends BuilderAbstract
|
|||
/**
|
||||
* Where and sub condition.
|
||||
*
|
||||
* @param Where|string|\Closure|array $where Where sub condition
|
||||
* @param mixed $operator Operator
|
||||
* @param mixed $values Values
|
||||
* @param Where|string|\Closure|array $where Where sub condition
|
||||
* @param mixed $operator Operator
|
||||
* @param mixed $values Values
|
||||
*
|
||||
* @return Builder
|
||||
*
|
||||
|
|
@ -559,9 +559,9 @@ class Builder extends BuilderAbstract
|
|||
/**
|
||||
* Where or sub condition.
|
||||
*
|
||||
* @param Where|string|\Closure|array $where Where sub condition
|
||||
* @param mixed $operator Operator
|
||||
* @param mixed $values Values
|
||||
* @param Where|string|\Closure|array $where Where sub condition
|
||||
* @param mixed $operator Operator
|
||||
* @param mixed $values Values
|
||||
*
|
||||
* @return Builder
|
||||
*
|
||||
|
|
@ -576,8 +576,8 @@ class Builder extends BuilderAbstract
|
|||
* Where in.
|
||||
*
|
||||
* @param Where|string|\Closure|array $column Column
|
||||
* @param mixed $values Values
|
||||
* @param string $boolean Boolean condition
|
||||
* @param mixed $values Values
|
||||
* @param string $boolean Boolean condition
|
||||
*
|
||||
* @return Builder
|
||||
*
|
||||
|
|
@ -594,7 +594,7 @@ class Builder extends BuilderAbstract
|
|||
* Where null.
|
||||
*
|
||||
* @param Where|string|\Closure|array $column Column
|
||||
* @param string $boolean Boolean condition
|
||||
* @param string $boolean Boolean condition
|
||||
*
|
||||
* @return Builder
|
||||
*
|
||||
|
|
@ -611,7 +611,7 @@ class Builder extends BuilderAbstract
|
|||
* Where not null.
|
||||
*
|
||||
* @param Where|string|\Closure|array $column Column
|
||||
* @param string $boolean Boolean condition
|
||||
* @param string $boolean Boolean condition
|
||||
*
|
||||
* @return Builder
|
||||
*
|
||||
|
|
@ -944,8 +944,8 @@ class Builder extends BuilderAbstract
|
|||
/**
|
||||
* Values to insert.
|
||||
*
|
||||
* @param mixed $set Values
|
||||
* @param string $type Data type to insert
|
||||
* @param mixed $set Values
|
||||
* @param string $type Data type to insert
|
||||
*
|
||||
* @return Builder
|
||||
*
|
||||
|
|
|
|||
|
|
@ -182,7 +182,7 @@ class Grammar extends GrammarAbstract
|
|||
/**
|
||||
* Compile select.
|
||||
*
|
||||
* @param Builder $query Builder
|
||||
* @param Builder $query Builder
|
||||
* @param array $table Table
|
||||
*
|
||||
* @return string
|
||||
|
|
@ -268,9 +268,9 @@ class Grammar extends GrammarAbstract
|
|||
/**
|
||||
* Compile where element.
|
||||
*
|
||||
* @param array $element Element data
|
||||
* @param Builder $query Query builder
|
||||
* @param bool $first Is first element (usefull for nesting)
|
||||
* @param array $element Element data
|
||||
* @param Builder $query Query builder
|
||||
* @param bool $first Is first element (usefull for nesting)
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ class TableException extends \PDOException
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param \Exception $previous Previous exception
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ class LockException extends \RuntimeException
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param \Exception $previous Previous exception
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -66,8 +66,8 @@ class HttpSession implements SessionInterface
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param int $liftetime Session life time
|
||||
* @param string|int|bool $sid Session id
|
||||
* @param int $liftetime Session life time
|
||||
* @param string|int|bool $sid Session id
|
||||
* @param int $inactivityInterval Interval for session activity
|
||||
*
|
||||
* @throws LockException Throws this exception if the session is alrady locked for further interaction.
|
||||
|
|
|
|||
|
|
@ -54,10 +54,10 @@ class EventManager
|
|||
/**
|
||||
* Attach new event
|
||||
*
|
||||
* @param string $group Name of the event (unique)
|
||||
* @param string $group Name of the event (unique)
|
||||
* @param \Closure $callback Callback for the event
|
||||
* @param bool $remove Remove event after triggering it?
|
||||
* @param bool $reset Reset event after triggering it? Remove must be false!
|
||||
* @param bool $remove Remove event after triggering it?
|
||||
* @param bool $reset Reset event after triggering it? Remove must be false!
|
||||
*
|
||||
* @return bool
|
||||
*
|
||||
|
|
@ -78,8 +78,8 @@ class EventManager
|
|||
* Trigger event
|
||||
*
|
||||
* @param string $group Name of the event
|
||||
* @param string $id Sub-requirement for event
|
||||
* @param mixed $data Data to pass to the callback
|
||||
* @param string $id Sub-requirement for event
|
||||
* @param mixed $data Data to pass to the callback
|
||||
*
|
||||
* @return bool Returns true on sucessfully triggering the event, false if the event couldn't be triggered which also includes sub-requirements missing.
|
||||
*
|
||||
|
|
@ -180,7 +180,7 @@ class EventManager
|
|||
* Add sub-requirement for event
|
||||
*
|
||||
* @param string $group Name of the event
|
||||
* @param string $id ID of the sub-requirement
|
||||
* @param string $id ID of the sub-requirement
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
|
|||
|
|
@ -95,9 +95,9 @@ class L11nManager
|
|||
* One module can only be loaded once. Once the module got loaded it's not
|
||||
* possible to load more language files later on.
|
||||
*
|
||||
* @param string $language Language iso code
|
||||
* @param string $from Module name
|
||||
* @param string $file File to import language from
|
||||
* @param string $language Language iso code
|
||||
* @param string $from Module name
|
||||
* @param string $file File to import language from
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
@ -141,7 +141,7 @@ class L11nManager
|
|||
* @param string $code Country code
|
||||
* @param string $module Module name
|
||||
* @param string $theme Theme
|
||||
* @param mixed $translation Text
|
||||
* @param mixed $translation Text
|
||||
*
|
||||
* @return string In case the language element couldn't be found 'ERROR' will be returned
|
||||
*
|
||||
|
|
@ -176,7 +176,7 @@ class L11nManager
|
|||
* @param string $code Country code
|
||||
* @param string $module Module name
|
||||
* @param string $theme Theme
|
||||
* @param mixed $translation Text
|
||||
* @param mixed $translation Text
|
||||
*
|
||||
* @return string In case the language element couldn't be found 'ERROR' will be returned
|
||||
*
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ class ZeroDevisionException extends \UnexpectedValueException
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param \Exception $previous Previous exception
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -248,9 +248,9 @@ class Functions
|
|||
* @example The relative fiscal month (August) in a company where the fiscal year starts in July.
|
||||
* @example 2 = getRelativeDegree(8, 12, 7);
|
||||
*
|
||||
* @param int $value Value to get degree
|
||||
* @param int $value Value to get degree
|
||||
* @param int $length Circle size
|
||||
* @param int $start Start value
|
||||
* @param int $start Start value
|
||||
*
|
||||
* @return int Lowest value is 0 and highest value is length - 1
|
||||
*
|
||||
|
|
|
|||
|
|
@ -76,7 +76,7 @@ class Polygon implements D2ShapeInterface
|
|||
/**
|
||||
* Point polygon relative position
|
||||
*
|
||||
* @param array $point Point location
|
||||
* @param array $point Point location
|
||||
* @param array $polygon Polygon definition
|
||||
*
|
||||
* @return int -1 inside polygon 0 on vertice 1 outside
|
||||
|
|
@ -134,7 +134,7 @@ class Polygon implements D2ShapeInterface
|
|||
/**
|
||||
* Is point on vertex?
|
||||
*
|
||||
* @param array $point Point location
|
||||
* @param array $point Point location
|
||||
* @param array $polygon Polygon definition
|
||||
*
|
||||
* @return bool
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ class InvalidDimensionException extends \UnexpectedValueException
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param mixed $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param mixed $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param \Exception $previous Previous exception
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -60,10 +60,10 @@ class Average
|
|||
/**
|
||||
* Moving average of dataset
|
||||
*
|
||||
* @param array $x Dataset
|
||||
* @param int $order Periods to use for average
|
||||
* @param array $weight Weight for moving average
|
||||
* @param bool $symmetric Cyclic moving average
|
||||
* @param array $x Dataset
|
||||
* @param int $order Periods to use for average
|
||||
* @param array $weight Weight for moving average
|
||||
* @param bool $symmetric Cyclic moving average
|
||||
*
|
||||
* @return array Moving average of data
|
||||
*
|
||||
|
|
@ -87,11 +87,11 @@ class Average
|
|||
/**
|
||||
* Moving average of element in dataset
|
||||
*
|
||||
* @param array $x Dataset
|
||||
* @param int $t Current period
|
||||
* @param int $order Periods to use for average
|
||||
* @param array $weight Weight for moving average
|
||||
* @param bool $symmetric Cyclic moving average
|
||||
* @param array $x Dataset
|
||||
* @param int $t Current period
|
||||
* @param int $order Periods to use for average
|
||||
* @param array $weight Weight for moving average
|
||||
* @param bool $symmetric Cyclic moving average
|
||||
*
|
||||
* @return float Moving average
|
||||
*
|
||||
|
|
|
|||
|
|
@ -27,9 +27,9 @@ class Forecasts
|
|||
/**
|
||||
* Get forecast/prediction interval.
|
||||
*
|
||||
* @param float $forecast Forecast value
|
||||
* @param float $forecast Forecast value
|
||||
* @param float $standardDeviation Standard Deviation of forecast
|
||||
* @param float $interval Forecast multiplier for prediction intervals
|
||||
* @param float $interval Forecast multiplier for prediction intervals
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
|
|
|
|||
|
|
@ -52,9 +52,9 @@ class Header extends HeaderAbstract
|
|||
/**
|
||||
* Set header.
|
||||
*
|
||||
* @param string $key Header key (case insensitive)
|
||||
* @param string $header Header value
|
||||
* @param bool $overwrite Overwrite if already existing
|
||||
* @param string $key Header key (case insensitive)
|
||||
* @param string $header Header value
|
||||
* @param bool $overwrite Overwrite if already existing
|
||||
*
|
||||
* @return bool
|
||||
*
|
||||
|
|
|
|||
|
|
@ -67,10 +67,10 @@ class EmailAbstract
|
|||
/**
|
||||
* Construct
|
||||
*
|
||||
* @param string $host Host
|
||||
* @param int $port Host port
|
||||
* @param int $timeout Timeout
|
||||
* @param bool $ssl Use ssl
|
||||
* @param string $host Host
|
||||
* @param int $port Host port
|
||||
* @param int $timeout Timeout
|
||||
* @param bool $ssl Use ssl
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
@ -90,8 +90,8 @@ class EmailAbstract
|
|||
/**
|
||||
* Decode
|
||||
*
|
||||
* @param string $content Content to decode
|
||||
* @param int $encoding Encoding type
|
||||
* @param string $content Content to decode
|
||||
* @param int $encoding Encoding type
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
|
|
@ -479,7 +479,7 @@ class EmailAbstract
|
|||
* Check message to delete
|
||||
*
|
||||
* @param int $length Amount of message overview
|
||||
* @param int $start Start index of the overview for pagination
|
||||
* @param int $start Start index of the overview for pagination
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
|
|
|
|||
|
|
@ -27,10 +27,10 @@ class Imap extends EmailAbstract
|
|||
/**
|
||||
* Construct
|
||||
*
|
||||
* @param string $host Host
|
||||
* @param int $port Host port
|
||||
* @param int $timeout Timeout
|
||||
* @param bool $ssl Use ssl
|
||||
* @param string $host Host
|
||||
* @param int $port Host port
|
||||
* @param int $timeout Timeout
|
||||
* @param bool $ssl Use ssl
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -27,10 +27,10 @@ class Nntp extends EmailAbstract
|
|||
/**
|
||||
* Construct
|
||||
*
|
||||
* @param string $host Host
|
||||
* @param int $port Host port
|
||||
* @param int $timeout Timeout
|
||||
* @param bool $ssl Use ssl
|
||||
* @param string $host Host
|
||||
* @param int $port Host port
|
||||
* @param int $timeout Timeout
|
||||
* @param bool $ssl Use ssl
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -27,10 +27,10 @@ class Pop3 extends EmailAbstract
|
|||
/**
|
||||
* Construct
|
||||
*
|
||||
* @param string $host Host
|
||||
* @param int $port Host port
|
||||
* @param int $timeout Timeout
|
||||
* @param bool $ssl Use ssl
|
||||
* @param string $host Host
|
||||
* @param int $port Host port
|
||||
* @param int $timeout Timeout
|
||||
* @param bool $ssl Use ssl
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -138,7 +138,7 @@ class Head implements RenderableInterface
|
|||
/**
|
||||
* Set page title.
|
||||
*
|
||||
* @param int $type Asset type
|
||||
* @param int $type Asset type
|
||||
* @param string $uri Asset uri
|
||||
*
|
||||
* @return void
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ class InvalidModuleException extends \UnexpectedValueException
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param \Exception $previous Previous exception
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ class InvalidThemeException extends \UnexpectedValueException
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param \Exception $previous Previous exception
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -35,8 +35,8 @@ class InstallerAbstract
|
|||
/**
|
||||
* Register module in database.
|
||||
*
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
@ -88,9 +88,9 @@ class InstallerAbstract
|
|||
/**
|
||||
* Install module.
|
||||
*
|
||||
* @param string $modulePath Route Path
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
* @param string $modulePath Route Path
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
@ -106,8 +106,8 @@ class InstallerAbstract
|
|||
/**
|
||||
* Activate after install.
|
||||
*
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
@ -124,7 +124,7 @@ class InstallerAbstract
|
|||
* Re-init module.
|
||||
*
|
||||
* @param string $modulePath Route Path
|
||||
* @param InfoManager $info Module info
|
||||
* @param InfoManager $info Module info
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
@ -139,7 +139,7 @@ class InstallerAbstract
|
|||
* Init routes.
|
||||
*
|
||||
* @param string $modulePath Path to the module
|
||||
* @param InfoManager $info Module info
|
||||
* @param InfoManager $info Module info
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
|
|||
|
|
@ -95,8 +95,8 @@ class ModuleManager
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param ApplicationAbstract $app Application
|
||||
* @param string $modulePath Path to modules
|
||||
* @param ApplicationAbstract $app Application
|
||||
* @param string $modulePath Path to modules
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ class PackageManager
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $path Package source path e.g. path after download.
|
||||
* @param string $path Package source path e.g. path after download.
|
||||
* @param string $basePath Path of the application
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
@ -254,7 +254,7 @@ class PackageManager
|
|||
* Authenticate package
|
||||
*
|
||||
* @param string $signedHash Hash to authenticate
|
||||
* @param string $rawHash Hash to compare against
|
||||
* @param string $rawHash Hash to compare against
|
||||
*
|
||||
* @return bool
|
||||
*
|
||||
|
|
|
|||
|
|
@ -32,8 +32,8 @@ class StatusAbstract
|
|||
/**
|
||||
* Deactivate module.
|
||||
*
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
@ -63,8 +63,8 @@ class StatusAbstract
|
|||
/**
|
||||
* Deactivate module in database.
|
||||
*
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
@ -95,8 +95,8 @@ class StatusAbstract
|
|||
/**
|
||||
* Deactivate module.
|
||||
*
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
@ -126,8 +126,8 @@ class StatusAbstract
|
|||
/**
|
||||
* Deactivate module in database.
|
||||
*
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
|
|||
|
|
@ -30,8 +30,8 @@ class UninstallerAbstract
|
|||
/**
|
||||
* Install module.
|
||||
*
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
|
|||
|
|
@ -30,8 +30,8 @@ class UpdaterAbstract
|
|||
/**
|
||||
* Install module.
|
||||
*
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
* @param DatabasePool $dbPool Database instance
|
||||
* @param InfoManager $info Module info
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
|
|
|
|||
|
|
@ -143,7 +143,7 @@ abstract class Enum
|
|||
*
|
||||
* This only works for binary flags.
|
||||
*
|
||||
* @param int $flags Set flags
|
||||
* @param int $flags Set flags
|
||||
* @param int $checkForFlag Check if this flag is part of the set flags
|
||||
*
|
||||
* @return bool
|
||||
|
|
|
|||
|
|
@ -30,8 +30,8 @@ class InvalidEnumName extends \UnexpectedValueException
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param \Exception $previous Previous exception
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -30,8 +30,8 @@ class InvalidEnumValue extends \UnexpectedValueException
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param mixed $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param mixed $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param \Exception $previous Previous exception
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -99,7 +99,7 @@ class BinaryTree extends Tree
|
|||
/**
|
||||
* Set right node of node.
|
||||
*
|
||||
* @param Node $base Base node
|
||||
* @param Node $base Base node
|
||||
* @param Node $right Right node
|
||||
*
|
||||
* @return BinaryTree
|
||||
|
|
@ -120,7 +120,7 @@ class BinaryTree extends Tree
|
|||
/**
|
||||
* Perform action on tree in in-order.
|
||||
*
|
||||
* @param Node $node Tree node
|
||||
* @param Node $node Tree node
|
||||
* @param \Closure $callback Task to perform on node
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
@ -135,9 +135,9 @@ class BinaryTree extends Tree
|
|||
/**
|
||||
* Get nodes in vertical order.
|
||||
*
|
||||
* @param Node $node Tree node
|
||||
* @param int $horizontalDistance Horizontal distance
|
||||
* @param Node[] &$order Ordered nodes by horizontal distance
|
||||
* @param Node $node Tree node
|
||||
* @param int $horizontalDistance Horizontal distance
|
||||
* @param Node[] &$order Ordered nodes by horizontal distance
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
@ -163,7 +163,7 @@ class BinaryTree extends Tree
|
|||
/**
|
||||
* Perform action on tree in vertical-order.
|
||||
*
|
||||
* @param Node $node Tree node
|
||||
* @param Node $node Tree node
|
||||
* @param \Closure $callback Task to perform on node
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -120,7 +120,7 @@ class Tree extends Graph
|
|||
/**
|
||||
* Perform task on tree nodes in level order.
|
||||
*
|
||||
* @param Node $node Tree node
|
||||
* @param Node $node Tree node
|
||||
* @param \Closure $callback Task to perform
|
||||
*
|
||||
* @return void
|
||||
|
|
@ -154,8 +154,8 @@ class Tree extends Graph
|
|||
/**
|
||||
* Get all nodes of a specific level.
|
||||
*
|
||||
* @param int $level Level to retrieve
|
||||
* @param Node $node Tree node
|
||||
* @param int $level Level to retrieve
|
||||
* @param Node $node Tree node
|
||||
*
|
||||
* @return Node[]
|
||||
*
|
||||
|
|
@ -207,7 +207,7 @@ class Tree extends Graph
|
|||
/**
|
||||
* Perform action on tree in pre-order.
|
||||
*
|
||||
* @param Node $node Tree node
|
||||
* @param Node $node Tree node
|
||||
* @param \Closure $callback Task to perform on node
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
@ -230,7 +230,7 @@ class Tree extends Graph
|
|||
/**
|
||||
* Perform action on tree in post-order.
|
||||
*
|
||||
* @param Node $node Tree node
|
||||
* @param Node $node Tree node
|
||||
* @param \Closure $callback Task to perform on node
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -108,9 +108,9 @@ interface ContainerInterface
|
|||
/**
|
||||
* Copy resource to different location.
|
||||
*
|
||||
* @param string $from Path of the resource to copy
|
||||
* @param string $to Path of the resource to copy to
|
||||
* @param bool $overwrite Overwrite/replace existing file
|
||||
* @param string $from Path of the resource to copy
|
||||
* @param string $to Path of the resource to copy to
|
||||
* @param bool $overwrite Overwrite/replace existing file
|
||||
*
|
||||
* @return bool True on success and false on failure
|
||||
*
|
||||
|
|
@ -121,9 +121,9 @@ interface ContainerInterface
|
|||
/**
|
||||
* Move resource to different location.
|
||||
*
|
||||
* @param string $from Path of the resource to move
|
||||
* @param string $to Path of the resource to move to
|
||||
* @param bool $overwrite Overwrite/replace existing file
|
||||
* @param string $from Path of the resource to move
|
||||
* @param string $to Path of the resource to move to
|
||||
* @param bool $overwrite Overwrite/replace existing file
|
||||
*
|
||||
* @return bool True on success and false on failure
|
||||
*
|
||||
|
|
@ -134,8 +134,8 @@ interface ContainerInterface
|
|||
/**
|
||||
* Get size of resource.
|
||||
*
|
||||
* @param string $path Path of the resource
|
||||
* @param bool $recursive Should include sub-sub-resources
|
||||
* @param string $path Path of the resource
|
||||
* @param bool $recursive Should include sub-sub-resources
|
||||
*
|
||||
* @return int
|
||||
*
|
||||
|
|
@ -179,7 +179,7 @@ interface ContainerInterface
|
|||
/**
|
||||
* Make name/path operating system safe.
|
||||
*
|
||||
* @param string $path Path of the resource
|
||||
* @param string $path Path of the resource
|
||||
* @param string $replace Replace invalid chars with
|
||||
*
|
||||
* @return string
|
||||
|
|
@ -253,8 +253,8 @@ interface ContainerInterface
|
|||
/**
|
||||
* Copy resource to different location.
|
||||
*
|
||||
* @param string $to Path of the resource to copy to
|
||||
* @param bool $overwrite Overwrite/replace existing file
|
||||
* @param string $to Path of the resource to copy to
|
||||
* @param bool $overwrite Overwrite/replace existing file
|
||||
*
|
||||
* @return bool True on success and false on failure
|
||||
*
|
||||
|
|
@ -265,8 +265,8 @@ interface ContainerInterface
|
|||
/**
|
||||
* Move resource to different location.
|
||||
*
|
||||
* @param string $to Path of the resource to move to
|
||||
* @param bool $overwrite Overwrite/replace existing file
|
||||
* @param string $to Path of the resource to move to
|
||||
* @param bool $overwrite Overwrite/replace existing file
|
||||
*
|
||||
* @return bool True on success and false on failure
|
||||
*
|
||||
|
|
|
|||
|
|
@ -30,9 +30,9 @@ interface FileInterface extends ContainerInterface
|
|||
/**
|
||||
* Save content to file.
|
||||
*
|
||||
* @param string $path File path to save the content to
|
||||
* @param string $path File path to save the content to
|
||||
* @param string $content Content to save in file
|
||||
* @param int $mode Mode (overwrite, append)
|
||||
* @param int $mode Mode (overwrite, append)
|
||||
*
|
||||
* @return bool
|
||||
*
|
||||
|
|
@ -45,7 +45,7 @@ interface FileInterface extends ContainerInterface
|
|||
*
|
||||
* Creates new file if it doesn't exist or overwrites existing file.
|
||||
*
|
||||
* @param string $path File path to save the content to
|
||||
* @param string $path File path to save the content to
|
||||
* @param string $content Content to save in file
|
||||
*
|
||||
* @return bool
|
||||
|
|
@ -59,7 +59,7 @@ interface FileInterface extends ContainerInterface
|
|||
*
|
||||
* Creates new file if it doesn't exist or appends existing file.
|
||||
*
|
||||
* @param string $path File path to save the content to
|
||||
* @param string $path File path to save the content to
|
||||
* @param string $content Content to save in file
|
||||
*
|
||||
* @return bool
|
||||
|
|
@ -73,7 +73,7 @@ interface FileInterface extends ContainerInterface
|
|||
*
|
||||
* Creates new file if it doesn't exist or prepends existing file.
|
||||
*
|
||||
* @param string $path File path to save the content to
|
||||
* @param string $path File path to save the content to
|
||||
* @param string $content Content to save in file
|
||||
*
|
||||
* @return bool
|
||||
|
|
@ -108,7 +108,7 @@ interface FileInterface extends ContainerInterface
|
|||
* Save content to file.
|
||||
*
|
||||
* @param string $content Content to save in file
|
||||
* @param int $mode Mode (overwrite, append)
|
||||
* @param int $mode Mode (overwrite, append)
|
||||
*
|
||||
* @return bool
|
||||
*
|
||||
|
|
|
|||
|
|
@ -97,7 +97,7 @@ class Directory extends FileAbstract implements DirectoryInterface
|
|||
/**
|
||||
* List all files by extension directory.
|
||||
*
|
||||
* @param string $path Path
|
||||
* @param string $path Path
|
||||
* @param string $extension Extension
|
||||
*
|
||||
* @return array
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ class PathException extends \UnexpectedValueException
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param \Exception $previous Previous exception
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ class PermissionException extends \RuntimeException
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param \Exception $previous Previous exception
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@ final class Storage
|
|||
/**
|
||||
* Register storage environment.
|
||||
*
|
||||
* @param string $name Name of the environment
|
||||
* @param string $name Name of the environment
|
||||
* @param string|StorageAbstract|mixed $class Class to register. This can be either a namespace path, a anonymous class or storage implementation.
|
||||
*
|
||||
* @return bool
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ class InvalidUriException extends \UnexpectedValueException
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param \Exception $previous Previous exception
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -111,9 +111,9 @@ class ArrayUtils
|
|||
/**
|
||||
* Get element of array by path
|
||||
*
|
||||
* @param string $path Path to element
|
||||
* @param array $data Array
|
||||
* @param string $delim Delimiter for path
|
||||
* @param string $path Path to element
|
||||
* @param array $data Array
|
||||
* @param string $delim Delimiter for path
|
||||
*
|
||||
* @return mixed
|
||||
*
|
||||
|
|
@ -163,7 +163,7 @@ class ArrayUtils
|
|||
/**
|
||||
* Check if any of the needles are in the array
|
||||
*
|
||||
* @param mixed $needles Needles for search
|
||||
* @param mixed $needles Needles for search
|
||||
* @param array $haystack Haystack for search
|
||||
*
|
||||
* @return bool
|
||||
|
|
@ -184,7 +184,7 @@ class ArrayUtils
|
|||
/**
|
||||
* Check if all of the needles are in the array
|
||||
*
|
||||
* @param mixed $needles Needles for search
|
||||
* @param mixed $needles Needles for search
|
||||
* @param array $haystack Haystack for search
|
||||
*
|
||||
* @return bool
|
||||
|
|
@ -332,8 +332,8 @@ class ArrayUtils
|
|||
* Sum of array elements
|
||||
*
|
||||
* @param array $array Array to sum
|
||||
* @param int $start Start index
|
||||
* @param int $count Amount of elements to sum
|
||||
* @param int $start Start index
|
||||
* @param int $count Amount of elements to sum
|
||||
*
|
||||
* @return int|float
|
||||
*
|
||||
|
|
|
|||
|
|
@ -165,7 +165,7 @@ abstract class C128Abstract
|
|||
/**
|
||||
* Set barcode margins
|
||||
*
|
||||
* @param int $margin Barcode margin
|
||||
* @param int $margin Barcode margin
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -66,8 +66,8 @@ class C25 extends C128Abstract
|
|||
* Constructor
|
||||
*
|
||||
* @param string $content Content to encrypt
|
||||
* @param int $width Barcode width
|
||||
* @param int $height Barcode height
|
||||
* @param int $width Barcode width
|
||||
* @param int $height Barcode height
|
||||
* @param int $orientation Orientation of the barcode
|
||||
*
|
||||
* @todo : add mirror parameter
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ class ColorUtils
|
|||
/**
|
||||
* Convert int to rgb
|
||||
*
|
||||
* @param int $rgbInt Value to convert
|
||||
* @param int $rgbInt Value to convert
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
|
|
|
|||
|
|
@ -98,7 +98,7 @@ final class Dictionary
|
|||
/**
|
||||
* Fill dictionary.
|
||||
*
|
||||
* @param array $entry Source data to generate dictionary from
|
||||
* @param array $entry Source data to generate dictionary from
|
||||
* @param string $value Dictionary value
|
||||
*
|
||||
* @return void
|
||||
|
|
|
|||
|
|
@ -289,7 +289,7 @@ class Repository
|
|||
/**
|
||||
* Remove file(s) from repository
|
||||
*
|
||||
* @param string|array $files Files to remove
|
||||
* @param string|array $files Files to remove
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ class InvalidJsonException extends \UnexpectedValueException
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param string $message Exception message
|
||||
* @param int $code Exception code
|
||||
* @param \Exception $previous Previous exception
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -28,8 +28,8 @@ interface ArchiveInterface
|
|||
* Create archive.
|
||||
*
|
||||
* @param string $sources Files and directories to compress
|
||||
* @param string $destination Output destination
|
||||
* @param bool $overwrite Overwrite if destination is existing
|
||||
* @param string $destination Output destination
|
||||
* @param bool $overwrite Overwrite if destination is existing
|
||||
*
|
||||
* @return bool
|
||||
*
|
||||
|
|
@ -40,8 +40,8 @@ interface ArchiveInterface
|
|||
/**
|
||||
* Unpack archive.
|
||||
*
|
||||
* @param string $source File to decompress
|
||||
* @param string $destination Output destination
|
||||
* @param string $source File to decompress
|
||||
* @param string $destination Output destination
|
||||
*
|
||||
* @return bool
|
||||
*
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@ abstract class TaskAbstract
|
|||
* Constructor
|
||||
*
|
||||
* @param string $name Id/name of the task (on linux the same as the executable script)
|
||||
* @param string $cmd Command to create the task
|
||||
* @param string $cmd Command to create the task
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user