Browse Source

added doc comment to Console::getScreensize()

tags/2.0.0-beta
Carsten Brandt 12 years ago
parent
commit
9d46f8e4fc
  1. 3
      framework/yii/helpers/base/Console.php

3
framework/yii/helpers/base/Console.php

@ -574,6 +574,9 @@ class Console
/** /**
* Usage: list($w, $h) = ConsoleHelper::getScreenSize(); * Usage: list($w, $h) = ConsoleHelper::getScreenSize();
* *
* @param bool $refresh whether to force checking and not re-use cached size value.
* This is useful to detect changing window size while the application is running but may
* not get up to date values on every terminal.
* @return array|boolean An array of ($width, $height) or false when it was not able to determine size. * @return array|boolean An array of ($width, $height) or false when it was not able to determine size.
*/ */
public static function getScreenSize($refresh = false) public static function getScreenSize($refresh = false)

Loading…
Cancel
Save