Skip to content

Commit

Permalink
[Docs] update docs with node examples (#4269)
Browse files Browse the repository at this point in the history
  • Loading branch information
TomasVotruba committed Sep 22, 2020
1 parent 8759d0e commit a73fc88
Show file tree
Hide file tree
Showing 137 changed files with 3,297 additions and 2,196 deletions.
File renamed without changes.
3,631 changes: 2,183 additions & 1,448 deletions docs/nodes_overview.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/rector_rules_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4861,7 +4861,7 @@ Remove null coalescing operator ??=
### `DowngradeTypedPropertyRector`

- class: [`Rector\DowngradePhp74\Rector\Property\DowngradeTypedPropertyRector`](/rules/downgrade-php74/src/Rector/Property/DowngradeTypedPropertyRector.php)
- [test fixtures](/rules/downgrade-php74/tests/Rector/Property/NoDocBlockDowngradeTypedPropertyRector/Fixture)
- [test fixtures](/rules/downgrade-php74/tests/Rector/Property/DowngradeTypedPropertyRector/Fixture)

Changes property type definition from type definitions to `@var` annotations.

Expand Down
4 changes: 3 additions & 1 deletion phpstan.neon
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ parameters:

- '#Method (.*?) specified in iterable type Symfony\\Component\\Process\\Process#'
- '#Cannot cast PhpParser\\Node\\Expr\\Error\|PhpParser\\Node\\Identifier to string#'
- '#Cognitive complexity for "Rector\\Utils\\NodeDocumentationGenerator\\Command\\DumpNodesCommand\:\:execute\(\)" is \d+, keep it under 9#'
- '#Cognitive complexity for "Rector\\Utils\\NodeDocumentationGenerator\\Command\\DumpNodesCommand\:\:(.*?)" is \d+, keep it under 9#'

- '#Parameter \#1 \$node of method Rector\\PostRector\\Collector\\NodesToAddCollector\:\:wrapToExpression\(\) expects PhpParser\\Node\\Expr\|PhpParser\\Node\\Stmt, PhpParser\\Node given#'
- '#Access to an undefined property PhpParser\\Node\\Expr\:\:\$class#'
Expand Down Expand Up @@ -468,3 +468,5 @@ parameters:

# Temprory ignored
- '#Do not use scalar or array as constructor parameter\. Use ParameterProvider service instead#'

- '#Method Rector\\Utils\\NodeDocumentationGenerator\\NodeCodeSampleProvider\:\:getNodeClasses\(\) should return array<class\-string\> but returns array<int, string\>#'
9 changes: 9 additions & 0 deletions utils/node-documentation-generator/snippet/alias.php.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\TraitUseAdaptation\Alias;

$traitFullyQualified = new FullyQualified('TraitName');

return new Alias($traitFullyQualified, 'method', Class_::MODIFIER_PUBLIC, 'aliasedMethod');
8 changes: 8 additions & 0 deletions utils/node-documentation-generator/snippet/arg.php.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?php

use PhpParser\Node\Arg;
use PhpParser\Node\Expr\Variable;

$variable = new Variable('variableName');

return new Arg($variable);
13 changes: 13 additions & 0 deletions utils/node-documentation-generator/snippet/array.php.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

use PhpParser\Node\Expr\Array_;
use PhpParser\Node\Expr\ArrayItem;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Scalar\String_;

$value = new Variable('Tom');
$key = new String_('name');

$arrayItem = new ArrayItem($value, $key);

return new Array_([$arrayItem]);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\AssignOp\BitwiseAnd;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new BitwiseAnd($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\AssignOp\BitwiseOr;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new BitwiseOr($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\AssignOp\BitwiseXor;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new BitwiseXor($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\AssignOp\Coalesce;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Coalesce($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\AssignOp\Concat;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Concat($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\AssignOp\Div;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Div($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\AssignOp\Minus;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Minus($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\AssignOp\Mod;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Mod($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\AssignOp\Mul;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Mul($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\AssignOp\Plus;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Plus($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\AssignOp\Pow;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Pow($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\AssignOp\ShiftLeft;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new ShiftLeft($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\AssignOp\ShiftRight;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new ShiftRight($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\BitwiseAnd;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new BitwiseAnd($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\BitwiseOr;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new BitwiseOr($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\BitwiseXor;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new BitwiseXor($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\BooleanAnd;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new BooleanAnd($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\Coalesce;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Coalesce($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\Concat;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Concat($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\Div;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Div($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\Equal;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Equal($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\Greater;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Greater($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\GreaterOrEqual;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new GreaterOrEqual($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\Identical;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Identical($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\LogicalAnd;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new LogicalAnd($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\LogicalOr;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new LogicalOr($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\LogicalXor;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new LogicalXor($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\Minus;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Minus($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\Mod;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Mod($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\Mul;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Mul($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\NotEqual;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new NotEqual($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\NotIdentical;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new NotIdentical($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\Plus;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Plus($left, $right);
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

use PhpParser\Node\Expr\BinaryOp\Pow;
use PhpParser\Node\Scalar\LNumber;

$left = new LNumber(5);
$right = new LNumber(10);

return new Pow($left, $right);

0 comments on commit a73fc88

Please sign in to comment.