Jingga/phpOMS
1
0
Fork 0
mirror of https://github.com/Karaka-Management/phpOMS.git synced 2026-02-04 11:48:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix doc align

Browse Source
This commit is contained in:
Dennis Eichhorn 2018-12-09 22:20:41 +01:00
parent f9bf85e702
commit e01d3e1e59
14 changed files with 49 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
DataStorage/Cache/Connection/ConnectionInterface.php
View File

@ -102,7 +102,7 @@ interface ConnectionInterface extends DataStorageConnectionInterface
* *
* @param mixed $key Unique cache key * @param mixed $key Unique cache key
* @param mixed $value Cache value * @param mixed $value Cache value
* @param int $expire Valid duration (in s) * @param int $expire Valid duration (in s)
* *
* @return bool * @return bool
* *

2
DataStorage/Database/DataMapperAbstract.php
View File

@ -1162,7 +1162,7 @@ class DataMapperAbstract implements DataMapperInterface
* The reference is stored in the main model * The reference is stored in the main model
* *
* @param string $propertyName Property name to initialize * @param string $propertyName Property name to initialize
* @param array $obj Object to update * @param array $obj Object to update
* @param int $relations Create all relations as well * @param int $relations Create all relations as well
* @param int $depth Depth of relations to update (default = 1 = none) * @param int $depth Depth of relations to update (default = 1 = none)
* *

8
DataStorage/Database/Query/Builder.php
View File

@ -347,7 +347,7 @@ class Builder extends BuilderAbstract
/** /**
* Set raw query. * Set raw query.
* *
* @param string $raw Raw query * @param string $raw Raw query
* *
* @return Builder * @return Builder
* *
@ -371,7 +371,7 @@ class Builder extends BuilderAbstract
* Tests if a string contains a non read only component in case the builder is read only. * Tests if a string contains a non read only component in case the builder is read only.
* If the builder is not read only it will always return true * If the builder is not read only it will always return true
* *
* @param string $raw Raw query * @param string $raw Raw query
* *
* @return bool * @return bool
* *
@ -923,7 +923,7 @@ class Builder extends BuilderAbstract
/** /**
* Values to insert. * Values to insert.
* *
* @param mixed $value Values * @param mixed $value Values
* *
* @return Builder * @return Builder
* *
@ -964,7 +964,7 @@ class Builder extends BuilderAbstract
/** /**
* Values to insert. * Values to insert.
* *
* @param mixed $set Values * @param mixed $set Values
* *
* @return Builder * @return Builder
* *

2
Message/RequestAbstract.php
View File

@ -196,7 +196,7 @@ abstract class RequestAbstract implements MessageInterface
/** /**
* Get data. * Get data.
* *
* @param mixed $key Data key * @param mixed $key Data key
* @param string $delim Data delimiter * @param string $delim Data delimiter
* *
* @return array * @return array

38
Module/ModuleAbstract.php
View File

@ -238,10 +238,10 @@ abstract class ModuleAbstract
/** /**
* Create a model * Create a model
* *
* @param RequestAbstract $request Request * @param RequestAbstract $request Request
* @param mixed $obj Response object * @param mixed $obj Response object
* @param string $mapper Object mapper * @param string $mapper Object mapper
* @param string $trigger Trigger for the event manager * @param string $trigger Trigger for the event manager
* *
* @return void * @return void
* *
@ -261,11 +261,11 @@ abstract class ModuleAbstract
/** /**
* Update a model * Update a model
* *
* @param RequestAbstract $request Request * @param RequestAbstract $request Request
* @param mixed $old Response object old * @param mixed $old Response object old
* @param mixed $new Response object new * @param mixed $new Response object new
* @param string|\Closure $mapper Object mapper * @param string|\Closure $mapper Object mapper
* @param string $trigger Trigger for the event manager * @param string $trigger Trigger for the event manager
* *
* @return void * @return void
* *
@ -289,10 +289,10 @@ abstract class ModuleAbstract
/** /**
* Delete a model * Delete a model
* *
* @param RequestAbstract $request Request * @param RequestAbstract $request Request
* @param mixed $obj Response object * @param mixed $obj Response object
* @param string $mapper Object mapper * @param string $mapper Object mapper
* @param string $trigger Trigger for the event manager * @param string $trigger Trigger for the event manager
* *
* @return void * @return void
* *
@ -312,12 +312,12 @@ abstract class ModuleAbstract
/** /**
* Create a model relation * Create a model relation
* *
* @param RequestAbstract $request Request * @param RequestAbstract $request Request
* @param mixed $rel1 Response object relation1 * @param mixed $rel1 Response object relation1
* @param mixed $rel2 Response object relation2 * @param mixed $rel2 Response object relation2
* @param string $mapper Object mapper * @param string $mapper Object mapper
* @param string $field Relation field * @param string $field Relation field
* @param string $trigger Trigger for the event manager * @param string $trigger Trigger for the event manager
* *
* @return void * @return void
* *

6
Stdlib/Base/Iban.php
View File

@ -274,9 +274,9 @@ class Iban implements \Serializable
/** /**
* Constructs the object * Constructs the object
* @link http://php.net/manual/en/serializable.unserialize.php * @link http://php.net/manual/en/serializable.unserialize.php
* @param string $serialized <p> * @param string $serialized <p>
* The string representation of the object. * The string representation of the object.
* </p> * </p>
* @return void * @return void
* @since 5.1.0 * @since 5.1.0
*/ */

6
Stdlib/Base/Location.php
View File

@ -326,9 +326,9 @@ class Location implements \JsonSerializable, \Serializable
/** /**
* Constructs the object * Constructs the object
* @link http://php.net/manual/en/serializable.unserialize.php * @link http://php.net/manual/en/serializable.unserialize.php
* @param string $serialized <p> * @param string $serialized <p>
* The string representation of the object. * The string representation of the object.
* </p> * </p>
* @return void * @return void
* @since 5.1.0 * @since 5.1.0
*/ */

14
Stdlib/Queue/PriorityQueue.php
View File

@ -65,8 +65,8 @@ class PriorityQueue implements \Countable, \Serializable
/** /**
* Insert element into queue. * Insert element into queue.
* *
* @param mixed $data Queue element * @param mixed $data Queue element
* @param float $priority Priority of this element * @param float $priority Priority of this element
* *
* @return int * @return int
* *
@ -94,7 +94,7 @@ class PriorityQueue implements \Countable, \Serializable
/** /**
* Get insert position * Get insert position
* *
* @param float $priority Priority of new element * @param float $priority Priority of new element
* *
* @return int * @return int
* *
@ -119,7 +119,7 @@ class PriorityQueue implements \Countable, \Serializable
/** /**
* Get insert position * Get insert position
* *
* @param float $priority Priority of new element * @param float $priority Priority of new element
* *
* @return int * @return int
* *
@ -133,7 +133,7 @@ class PriorityQueue implements \Countable, \Serializable
/** /**
* Get insert position * Get insert position
* *
* @param float $priority Priority of new element * @param float $priority Priority of new element
* *
* @return int * @return int
* *
@ -147,7 +147,7 @@ class PriorityQueue implements \Countable, \Serializable
/** /**
* Get insert position * Get insert position
* *
* @param float $priority Priority of new element * @param float $priority Priority of new element
* *
* @return int * @return int
* *
@ -170,7 +170,7 @@ class PriorityQueue implements \Countable, \Serializable
/** /**
* Get insert position * Get insert position
* *
* @param float $priority Priority of new element * @param float $priority Priority of new element
* *
* @return int * @return int
* *

6
System/File/Ftp/Directory.php
View File

@ -344,9 +344,9 @@ class Directory extends FileAbstract implements DirectoryInterface
/** /**
* Offset to retrieve * Offset to retrieve
* @link http://php.net/manual/en/arrayaccess.offsetget.php * @link http://php.net/manual/en/arrayaccess.offsetget.php
* @param mixed $offset <p> * @param mixed $offset <p>
* The offset to retrieve. * The offset to retrieve.
* </p> * </p>
* @return mixed Can return all value types. * @return mixed Can return all value types.
* @since 5.0.0 * @since 5.0.0
*/ */

4
System/File/Ftp/File.php
View File

@ -296,7 +296,7 @@ class File extends FileAbstract implements FileInterface
/** /**
* Gets the directory name of a file. * Gets the directory name of a file.
* *
* @param string $path Path of the file to get the directory name for. * @param string $path Path of the file to get the directory name for.
* *
* @return string Returns the directory name of the file. * @return string Returns the directory name of the file.
* *
@ -310,7 +310,7 @@ class File extends FileAbstract implements FileInterface
/** /**
* Gets the directory path of a file. * Gets the directory path of a file.
* *
* @param string $path Path of the file to get the directory name for. * @param string $path Path of the file to get the directory name for.
* *
* @return string Returns the directory name of the file. * @return string Returns the directory name of the file.
* *

4
System/File/Local/File.php
View File

@ -243,7 +243,7 @@ final class File extends FileAbstract implements FileInterface
/** /**
* Gets the directory name of a file. * Gets the directory name of a file.
* *
* @param string $path Path of the file to get the directory name for. * @param string $path Path of the file to get the directory name for.
* *
* @return string Returns the directory name of the file. * @return string Returns the directory name of the file.
* *
@ -257,7 +257,7 @@ final class File extends FileAbstract implements FileInterface
/** /**
* Gets the directory path of a file. * Gets the directory path of a file.
* *
* @param string $path Path of the file to get the directory name for. * @param string $path Path of the file to get the directory name for.
* *
* @return string Returns the directory name of the file. * @return string Returns the directory name of the file.
* *

2
Utils/StringUtils.php
View File

@ -46,7 +46,7 @@ final class StringUtils
* *
* The validation is done case sensitive. * The validation is done case sensitive.
* *
* @param string $haystack Haystack * @param string $haystack Haystack
* @param array<string> $needles Needles to check if any of them are part of the haystack * @param array<string> $needles Needles to check if any of them are part of the haystack
* *
* @example StringUtils::contains('This string', ['This', 'test']); // true * @example StringUtils::contains('This string', ['This', 'test']); // true

2
Utils/TaskSchedule/TaskAbstract.php
View File

@ -76,7 +76,7 @@ abstract class TaskAbstract
* Comment * Comment
* *
* @param string $name Name of the task * @param string $name Name of the task
* @param string $cmd Command/script to run * @param string $cmd Command/script to run
* *
* @var string * @var string
* @since 1.0.0 * @since 1.0.0

2
Views/View.php
View File

@ -168,7 +168,7 @@ class View extends ViewAbstract
* @return string * @return string
* *
* @throws InvalidModuleException Throws this exception if no data for the defined module could be found. * @throws InvalidModuleException Throws this exception if no data for the defined module could be found.
* @throws InvalidThemeException Throws this exception if no data for the defined theme could be found. * @throws InvalidThemeException Throws this exception if no data for the defined theme could be found.
* *
* @since 1.0.0 * @since 1.0.0
*/ */