Commite83b2ff

committed

[symfony#2586] Documented setRedrawFrequenty()

1 parentb57f2ab commite83b2ffCopy full SHA for e83b2ff

File tree

+12

-10

lines changed

+12

-10

lines changed

Lines changed: 12 additions & 10 deletions

Original file line number	Diff line number	Diff line change
`@@ -56,18 +56,20 @@ To see other available options, check the API documentation for`
`56`	`56`
`57`	`57`	`..caution::`
`58`	`58`
`59`		`- For performance reasons, be careful to not set the total number of steps`
`60`		`- to a high number. For example, if you're iterating over a large number`
`61`		`- of items, consider a smaller "step" number that updates on only some`
`62`		`- iterations::`
	`59`	`+ For performance reasons, be careful if you set the total number of steps`
	`60`	`+ to a high number. For example, if you're iterating over a large number of`
	`61`	`+ items, consider setting the redraw frequency to a higher value by calling`
	`62`	+:method:`Symfony\\Component\\Console\\Helper\\ProgressHelper::setRedrawFrequency`,
	`63`	`+ so it updates on only some iterations::`
	`64`	`+`
	`65`	`+ $progress->start($output, 50000);`
	`66`	`+`
	`67`	`+ // update every 100 iterations`
	`68`	`+ $progress->setRedrawFrequency(100);`
`63`	`69`
`64`		`- $progress->start($output, 500);`
`65`	`70`	`$i = 0;`
`66`	`71`	`while ($i++ < 50000) {`
`67`	`72`	`// ... do some work`
`68`	`73`
`69`		`- // advance every 100 iterations`
`70`		`- if ($i % 100 == 0) {`
`71`		`- $progress->advance();`
`72`		`- }`
`73`		`- }`
	`74`	`+ $progress->advance();`
	`75`	`+ }`

Comments

(0)