Skip to content

Improve #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 19, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/App/Helper/ConstraintPayloadDocHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class ConstraintPayloadDocHelper
* @param TypeDoc $doc
* @param Constraint $constraint
*/
public function appendPayloadDoc(TypeDoc $doc, Constraint $constraint)
public function appendPayloadDoc(TypeDoc $doc, Constraint $constraint) : void
{
if (!$this->hasPayloadDoc($constraint)) {
return;
Expand Down
4 changes: 2 additions & 2 deletions src/App/Helper/DocTypeHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public function guess(array $constraintList) : TypeDoc
*
* @return TypeDoc|null
*/
protected function getDocFromTypeConstraintOrPayloadDocIfExist(array $constraintList)
protected function getDocFromTypeConstraintOrPayloadDocIfExist(array $constraintList) : ?TypeDoc
{
$doc = null;
// Check if a Type constraint exist or if a constraint have a type documentation
Expand Down Expand Up @@ -87,7 +87,7 @@ protected function getDocFromTypeConstraintOrPayloadDocIfExist(array $constraint
*
* @return TypeDoc|null
*/
private function normalizeType(string $type)
private function normalizeType(string $type) : ?TypeDoc
{
if ('scalar' === $type) {
return new ScalarDoc();
Expand Down
10 changes: 5 additions & 5 deletions src/App/Helper/MinMaxHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class MinMaxHelper
* @param TypeDoc $doc
* @param Constraint $constraint
*/
public function append(TypeDoc $doc, Constraint $constraint)
public function append(TypeDoc $doc, Constraint $constraint) : void
{
if ($doc instanceof StringDoc) {
$this->appendStringDoc($doc, $constraint);
Expand All @@ -32,7 +32,7 @@ public function append(TypeDoc $doc, Constraint $constraint)
* @param StringDoc $doc
* @param Constraint $constraint
*/
private function appendStringDoc(StringDoc $doc, Constraint $constraint)
private function appendStringDoc(StringDoc $doc, Constraint $constraint) : void
{
if ($constraint instanceof Assert\Length) {
if (null !== $constraint->min) {
Expand All @@ -54,7 +54,7 @@ private function appendStringDoc(StringDoc $doc, Constraint $constraint)
* @param NumberDoc $doc
* @param Constraint $constraint
*/
private function appendNumberDoc(NumberDoc $doc, Constraint $constraint)
private function appendNumberDoc(NumberDoc $doc, Constraint $constraint) : void
{
$this->appendNumberMinMax($doc, $constraint);

Expand All @@ -69,7 +69,7 @@ private function appendNumberDoc(NumberDoc $doc, Constraint $constraint)
* @param CollectionDoc $doc
* @param Constraint $constraint
*/
private function appendCollectionDoc(CollectionDoc $doc, Constraint $constraint)
private function appendCollectionDoc(CollectionDoc $doc, Constraint $constraint) : void
{
if ($constraint instanceof Assert\Choice) {
if (null !== $constraint->min) {
Expand Down Expand Up @@ -112,7 +112,7 @@ private function appendCollectionDoc(CollectionDoc $doc, Constraint $constraint)
* @param NumberDoc $doc
* @param Constraint $constraint
*/
private function appendNumberMinMax(NumberDoc $doc, Constraint $constraint)
private function appendNumberMinMax(NumberDoc $doc, Constraint $constraint) : void
{
if ($constraint instanceof Assert\Range) {
if (null !== $constraint->min) {
Expand Down
2 changes: 1 addition & 1 deletion src/App/Helper/StringDocHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class StringDocHelper
*
* @throws \ReflectionException
*/
public function append(TypeDoc $doc, Constraint $constraint)
public function append(TypeDoc $doc, Constraint $constraint) : void
{
// If format already defined or type is defined and is not a string nor scalar => give up
if (!$doc instanceof StringDoc) {
Expand Down
10 changes: 5 additions & 5 deletions src/App/Helper/TypeGuesser.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class TypeGuesser
*
* @return TypeDoc|null
*/
public function guessTypeFromConstraintList(array $constraintList)
public function guessTypeFromConstraintList(array $constraintList) : ?TypeDoc
{
$doc = $abstractTypeFound = null;
foreach ($constraintList as $constraint) {
Expand Down Expand Up @@ -50,7 +50,7 @@ public function guessTypeFromConstraintList(array $constraintList)
*
* @return TypeDoc|null
*/
protected function guessTypeFromConstraint(Constraint $constraint)
protected function guessTypeFromConstraint(Constraint $constraint) : ?TypeDoc
{
if (null !== ($type = $this->guessPrimaryTypeFromConstraint($constraint))) {
return $type;
Expand Down Expand Up @@ -86,7 +86,7 @@ private function isAbstractType(TypeDoc $doc) : bool
*
* @return null|ArrayDoc|BooleanDoc|ObjectDoc|ScalarDoc|StringDoc
*/
private function guessPrimaryTypeFromConstraint(Constraint $constraint)
private function guessPrimaryTypeFromConstraint(Constraint $constraint) : ?TypeDoc
{
static $stringConstraintClassList = [
Assert\Length::class, // << Applied on string only
Expand Down Expand Up @@ -140,7 +140,7 @@ private function guessPrimaryTypeFromConstraint(Constraint $constraint)
*
* @return ScalarDoc|StringDoc
*/
private function guessDateTimeType(Assert\DateTime $constraint)
private function guessDateTimeType(Assert\DateTime $constraint) : TypeDoc
{
if ('U' === $constraint->format) {
return new ScalarDoc();// Don't know if value will be an number as string or as integer
Expand All @@ -154,7 +154,7 @@ private function guessDateTimeType(Assert\DateTime $constraint)
*
* @return ArrayDoc|ObjectDoc
*/
private function guestCollectionType(Assert\Collection $constraint)
private function guestCollectionType(Assert\Collection $constraint) : TypeDoc
{
// If only integer => array, else object
$integerKeyList = array_filter(array_keys($constraint->fields), 'is_int');
Expand Down
2 changes: 1 addition & 1 deletion src/Infra/Transformer/ConstraintToParamsDocTransformer.php
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ class_uses($object)
return count(array_intersect($actualClassList, $classList)) > 0;
}

private function addToAllowedValueListIfNotExist(TypeDoc $doc, $value)
private function addToAllowedValueListIfNotExist(TypeDoc $doc, $value) : void
{
if (!in_array($value, $doc->getAllowedValueList(), true)) {
$doc->addAllowedValue($value);
Expand Down