revi-archive/phorge-arcanist
1
0
Fork 0
mirror of https://we.phorge.it/source/arcanist.git synced 2025-03-13 21:05:01 +01:00
Code Issues Releases Wiki Activity

Compare commits

base: revi-archive:master
Branches Tags
revi-archive:master
revi-archive:stable
revi-archive:legacy-2019
revi-archive:experimental
revi-archive:wilds
revi-archive:2024.35
revi-archive:2024.19
revi-archive:2023.49
revi-archive:2023.32
revi-archive:2023.23
revi-archive:2023.17
revi-archive:2022.37
..
compare: revi-archive:2024.19
Branches Tags
revi-archive:master
revi-archive:stable
revi-archive:legacy-2019
revi-archive:experimental
revi-archive:wilds
revi-archive:2024.35
revi-archive:2024.19
revi-archive:2023.49
revi-archive:2023.32
revi-archive:2023.23
revi-archive:2023.17
revi-archive:2022.37

No commits in common. "master" and "2024.19" have entirely different histories.
master ... 2024.19

135 changed files with 953 additions and 974 deletions
Show stats Expand all files Collapse all files

26
src/channel/PhutilChannel.php
View file

@ -65,8 +65,8 @@ abstract class PhutilChannel extends Phobject {
*
* The default implementation accepts bytes.
*
* @param wild $bytes Data to write to the channel, normally bytes.
* @return $this
* @param wild Data to write to the channel, normally bytes.
* @return this
*
* @task io
*/
@ -90,8 +90,8 @@ abstract class PhutilChannel extends Phobject {
* Wait for any activity on a list of channels. Convenience wrapper around
* @{method:waitForActivity}.
*
* @param list<PhutilChannel> $channels A list of channels to wait for.
* @param dict $options (optional) Options, see above.
* @param list<PhutilChannel> A list of channels to wait for.
* @param dict Options, see above.
* @return void
*
* @task wait
@ -119,9 +119,8 @@ abstract class PhutilChannel extends Phobject {
* NOTE: Extra streams must be //streams//, not //sockets//, because this
* method uses `stream_select()`, not `socket_select()`.
*
* @param list<PhutilChannel> $reads List of channels to wait for reads on.
* @param list<PhutilChannel> $writes List of channels to wait for writes on.
* @param dict $options (optional) Options, see above.
* @param list<PhutilChannel> List of channels to wait for reads on.
* @param list<PhutilChannel> List of channels to wait for writes on.
* @return void
*
* @task wait
@ -246,8 +245,8 @@ abstract class PhutilChannel extends Phobject {
* Set a channel name. This is primarily intended to allow you to debug
* channel code more easily, by naming channels something meaningful.
*
* @param string $name Channel name.
* @return $this
* @param string Channel name.
* @return this
*
* @task impl
*/
@ -314,7 +313,7 @@ abstract class PhutilChannel extends Phobject {
/**
* Read from the channel's underlying I/O.
*
* @param int $length Maximum number of bytes to read.
* @param int Maximum number of bytes to read.
* @return string Bytes, if available.
*
* @task impl
@ -325,7 +324,7 @@ abstract class PhutilChannel extends Phobject {
/**
* Write to the channel's underlying I/O.
*
* @param string $bytes Bytes to write.
* @param string Bytes to write.
* @return int Number of bytes written.
*
* @task impl
@ -362,9 +361,8 @@ abstract class PhutilChannel extends Phobject {
* block once the buffer reaches this size until the in-process buffer is
* consumed.
*
* @param int|null $size Maximum read buffer size, or `null` for a limitless
* buffer.
* @return $this
* @param int|null Maximum read buffer size, or `null` for a limitless buffer.
* @return this
* @task impl
*/
public function setReadBufferSize($size) {

2
src/channel/PhutilChannelChannel.php
View file

@ -53,12 +53,10 @@ abstract class PhutilChannelChannel extends PhutilChannel {
protected function readBytes($length) {
$this->throwOnRawByteOperations();
return ''; // Never returned but makes static code analyzers happy
}
protected function writeBytes($bytes) {
$this->throwOnRawByteOperations();
return -1; // Never returned but makes static code analyzers happy
}
protected function getReadSockets() {

6
src/channel/PhutilExecChannel.php
View file

@ -57,7 +57,7 @@ final class PhutilExecChannel extends PhutilChannel {
* because @{class:ExecFuture} closes stdin by default when futures start.
* If stdin has been closed, you will be unable to write on the channel.
*
* @param ExecFuture $future Future to use as an underlying I/O source.
* @param ExecFuture Future to use as an underlying I/O source.
* @task construct
*/
public function __construct(ExecFuture $future) {
@ -162,8 +162,8 @@ final class PhutilExecChannel extends PhutilChannel {
* You can set a handler which does nothing to effectively ignore and discard
* any output on stderr.
*
* @param callable $handler Handler to invoke when stderr data is received.
* @return $this
* @param callable Handler to invoke when stderr data is received.
* @return this
*/
public function setStderrHandler($handler) {
$this->stderrHandler = $handler;

12
src/channel/PhutilProtocolChannel.php
View file

@ -46,8 +46,8 @@ abstract class PhutilProtocolChannel extends PhutilChannelChannel {
/**
* Write a message to the channel.
*
* @param wild $message Some message.
* @return $this
* @param wild Some message.
* @return this
*
* @task io
*/
@ -61,8 +61,8 @@ abstract class PhutilProtocolChannel extends PhutilChannelChannel {
* Add a message to the queue. While you normally do not need to do this,
* you can use it to inject out-of-band messages.
*
* @param wild $message Some message.
* @return $this
* @param wild Some message.
* @return this
*
* @task io
*/
@ -78,7 +78,7 @@ abstract class PhutilProtocolChannel extends PhutilChannelChannel {
/**
* Encode a message for transmission.
*
* @param wild $message Some message.
* @param wild Some message.
* @return string The message serialized into a wire format for
* transmission.
*
@ -100,7 +100,7 @@ abstract class PhutilProtocolChannel extends PhutilChannelChannel {
* a parser in this method, and store parser state on the object to be able
* to process incoming data in small chunks.
*
* @param string $data One or more bytes from the underlying channel.
* @param string One or more bytes from the underlying channel.
* @return list<wild> Zero or more parsed messages.
*
* @task protocol

7
src/channel/PhutilSocketChannel.php
View file

@ -33,10 +33,9 @@ final class PhutilSocketChannel extends PhutilChannel {
* `stream_socket_server()` or similar, not a //plain// socket from
* `socket_create()` or similar.
*
* @param socket $read_socket Socket (stream socket, not plain socket). If
* only one socket is provided, it is used for reading and
* writing.
* @param socket $write_socket (optional) Write socket.
* @param socket Socket (stream socket, not plain socket). If only one
* socket is provided, it is used for reading and writing.
* @param socket? Optional write socket.
*
* @task construct
*/

2
src/conduit/ConduitClient.php
View file

@ -206,7 +206,7 @@ final class ConduitClient extends Phobject {
* This implicit port behavior is similar to what browsers do, so it is less
* likely to get us into trouble with webserver configurations.
*
* @param bool $with_explicit_port True to include the port explicitly.
* @param bool True to include the port explicitly.
* @return string String describing the host for the request.
*/
private function newHostString($with_explicit_port) {

10
src/configuration/ArcanistConfigurationManager.php
View file

@ -50,8 +50,8 @@ final class ArcanistConfigurationManager extends Phobject {
* arguments ("runtime").
* The precedence is runtime > local > project > user > system
*
* @param key $key Key to read.
* @param wild $default (optional) Default value if key is not found.
* @param key Key to read.
* @param wild Default value if key is not found.
* @return wild Value, or default value if not found.
*
* @task config
@ -71,7 +71,7 @@ final class ArcanistConfigurationManager extends Phobject {
* The map is ordered by the canonical sources precedence, which is:
* runtime > local > project > user > system
*
* @param key $key Key to read
* @param key Key to read
* @return array Mapping of source => value read. Sources with no value are
* not in the array.
*
@ -135,8 +135,8 @@ final class ArcanistConfigurationManager extends Phobject {
* Sets a runtime config value that takes precedence over any static
* config values.
*
* @param key $key Key to set.
* @param value $value The value of the key.
* @param key Key to set.
* @param value The value of the key.
*
* @task config
*/

1
src/configuration/ArcanistSettings.php
View file

@ -236,6 +236,7 @@ final class ArcanistSettings extends Phobject {
throw new Exception(
pht(
'Use "arc alias" to configure aliases, not "arc set-config".'));
break;
}

2
src/console/PhutilConsole.php
View file

@ -56,7 +56,7 @@ final class PhutilConsole extends Phobject {
/**
* Set the active console.
*
* @param PhutilConsole $console
* @param PhutilConsole
* @return void
* @task construct
*/

14
src/console/PhutilInteractiveEditor.php
View file

@ -31,7 +31,7 @@ final class PhutilInteractiveEditor extends Phobject {
/**
* Constructs an interactive editor, using the text of a document.
*
* @param string $content Document text.
* @param string Document text.
* @return $this
*
* @task create
@ -171,7 +171,7 @@ final class PhutilInteractiveEditor extends Phobject {
* opens. By default, the cursor will be positioned at the start of the
* content.
*
* @param int $offset Line number where the cursor should be positioned.
* @param int Line number where the cursor should be positioned.
* @return $this
*
* @task config
@ -198,7 +198,7 @@ final class PhutilInteractiveEditor extends Phobject {
* Set the document name. Depending on the editor, this may be exposed to
* the user and can give them a sense of what they're editing.
*
* @param string $name Document name.
* @param string Document name.
* @return $this
*
* @task config
@ -228,7 +228,7 @@ final class PhutilInteractiveEditor extends Phobject {
/**
* Set the text content to be edited.
*
* @param string $content New content.
* @param string New content.
* @return $this
*
* @task config
@ -255,7 +255,7 @@ final class PhutilInteractiveEditor extends Phobject {
* Set the fallback editor program to be used if the env variable $EDITOR
* is not available and there is no `editor` binary in PATH.
*
* @param string $editor Command-line editing program (e.g. 'emacs', 'vi')
* @param string Command-line editing program (e.g. 'emacs', 'vi')
* @return $this
*
* @task config
@ -270,7 +270,7 @@ final class PhutilInteractiveEditor extends Phobject {
* Set the preferred editor program. If set, this will override all other
* sources of editor configuration, like $EDITOR.
*
* @param string $editor Command-line editing program (e.g. 'emacs', 'vi')
* @param string Command-line editing program (e.g. 'emacs', 'vi')
* @return $this
*
* @task config
@ -284,7 +284,7 @@ final class PhutilInteractiveEditor extends Phobject {
* Set the message that identifies the task for which the editor is being
* launched, displayed to the user prior to it being launched.
*
* @param string $task_message The message to display to the user.
* @param string The message to display to the user.
* @return $this
*
* @task config

6
src/console/format.php
View file

@ -94,9 +94,9 @@ function phutil_console_prompt($prompt, $history = '') {
* Soft wrap text for display on a console, respecting UTF8 character boundaries
* and ANSI color escape sequences.
*
* @param string $text Text to wrap.
* @param int $indent (optional) Indent level. Defaults to 0.
* @param bool $with_prefix (Optional) True to also indent the first line.
* @param string Text to wrap.
* @param int Optional indent level.
* @param bool True to also indent the first line.
* @return string Wrapped text.
*/
function phutil_console_wrap($text, $indent = 0, $with_prefix = true) {

4
src/console/view/PhutilConsoleTable.php
View file

@ -219,7 +219,7 @@ final class PhutilConsoleTable extends PhutilConsoleView {
/**
* Get the width of a specific column, including padding.
*
* @param string $key
* @param string
* @return int
*/
protected function getWidth($key) {
@ -265,7 +265,7 @@ final class PhutilConsoleTable extends PhutilConsoleView {
/**
* Format cells into an entire row.
*
* @param list<string> $columns
* @param list<string>
* @return string
*/
protected function formatRow(array $columns) {

6
src/console/view/PhutilConsoleView.php
View file

@ -22,7 +22,7 @@ abstract class PhutilConsoleView extends Phobject {
/**
* Draw a view to the console.
*
* @return $this
* @return this
* @task draw
*/
final public function draw() {
@ -57,7 +57,7 @@ abstract class PhutilConsoleView extends Phobject {
/**
* Reduce a view to a list of simple, unnested parts.
*
* @param wild $view Any drawable view.
* @param wild Any drawable view.
* @return list<wild> List of unnested drawables.
* @task draw
*/
@ -84,7 +84,7 @@ abstract class PhutilConsoleView extends Phobject {
/**
* @param list<wild> $parts List of views, one per line.
* @param list<wild> List of views, one per line.
* @return wild Each view rendered on a separate line.
*/
final protected function drawLines(array $parts) {

2
src/differential/ArcanistDifferentialCommitMessage.php
View file

@ -111,7 +111,7 @@ final class ArcanistDifferentialCommitMessage extends Phobject {
/**
* Extract the revision ID from a commit message.
*
* @param string $corpus Raw commit message.
* @param string Raw commit message.
* @return int|null Revision ID, if the commit message contains one.
*/
private function parseRevisionIDFromRawCorpus($corpus) {

32
src/error/PhutilErrorHandler.php
View file

@ -88,7 +88,7 @@ final class PhutilErrorHandler extends Phobject {
* can use @{class:PhutilProxyException} to nest exceptions; after PHP 5.3
* all exceptions are nestable.
*
* @param Exception|Throwable $ex Exception to unnest.
* @param Exception|Throwable Exception to unnest.
* @return Exception|Throwable|null Previous exception, if one exists.
* @task exutil
*/
@ -106,7 +106,7 @@ final class PhutilErrorHandler extends Phobject {
/**
* Find the most deeply nested exception from a possibly-nested exception.
*
* @param Exception|Throwable $ex A possibly-nested exception.
* @param Exception|Throwable A possibly-nested exception.
* @return Exception|Throwable Deepest exception in the nest.
* @task exutil
*/
@ -126,7 +126,7 @@ final class PhutilErrorHandler extends Phobject {
* Adds an error trap. Normally you should not invoke this directly;
* @{class:PhutilErrorTrap} registers itself on construction.
*
* @param PhutilErrorTrap $trap Trap to add.
* @param PhutilErrorTrap Trap to add.
* @return void
* @task trap
*/
@ -140,7 +140,7 @@ final class PhutilErrorHandler extends Phobject {
* Removes an error trap. Normally you should not invoke this directly;
* @{class:PhutilErrorTrap} deregisters itself on destruction.
*
* @param PhutilErrorTrap $trap Trap to remove.
* @param PhutilErrorTrap Trap to remove.
* @return void
* @task trap
*/
@ -179,11 +179,11 @@ final class PhutilErrorHandler extends Phobject {
* This handler converts E_NOTICE messages from uses of undefined variables
* into @{class:RuntimeException}s.
*
* @param int $num Error code.
* @param string $str Error message.
* @param string $file File where the error occurred.
* @param int $line Line on which the error occurred.
* @param wild $ctx (optional) Error context information.
* @param int Error code.
* @param string Error message.
* @param string File where the error occurred.
* @param int Line on which the error occurred.
* @param wild Error context information.
* @return void
* @task internal
*/
@ -278,7 +278,7 @@ final class PhutilErrorHandler extends Phobject {
* ##set_exception_handler()##. You should not call this function directly;
* to print exceptions, pass the exception object to @{function:phlog}.
*
* @param Exception|Throwable $ex Uncaught exception object.
* @param Exception|Throwable Uncaught exception object.
* @return void
* @task internal
*/
@ -304,7 +304,7 @@ final class PhutilErrorHandler extends Phobject {
/**
* Output a stacktrace to the PHP error log.
*
* @param trace $trace A stacktrace, e.g. from debug_backtrace();
* @param trace A stacktrace, e.g. from debug_backtrace();
* @return void
* @task internal
*/
@ -319,7 +319,7 @@ final class PhutilErrorHandler extends Phobject {
/**
* Format a stacktrace for output.
*
* @param trace $trace A stacktrace, e.g. from debug_backtrace();
* @param trace A stacktrace, e.g. from debug_backtrace();
* @return string Human-readable trace.
* @task internal
*/
@ -382,9 +382,9 @@ final class PhutilErrorHandler extends Phobject {
* dispatched to the listener; this method also prints them to the PHP error
* log.
*
* @param const $event Event type constant.
* @param wild $value Event value.
* @param dict $metadata Event metadata.
* @param const Event type constant.
* @param wild Event value.
* @param dict Event metadata.
* @return void
* @task internal
*/
@ -560,7 +560,7 @@ final class PhutilErrorHandler extends Phobject {
* all of the places an exception came from, even if it came from multiple
* origins and has been aggregated or proxied.
*
* @param Exception|Throwable $ex Exception to retrieve a trace for.
* @param Exception|Throwable Exception to retrieve a trace for.
* @return list<wild> List of stack frames.
*/
public static function getExceptionTrace($ex) {

22
src/error/phlog.php
View file

@ -5,8 +5,8 @@
* forwards it to registered listeners. This is essentially a more powerful
* version of `error_log()`.
*
* @param wild $value Any value you want printed to the error log or other
* registered logs/consoles.
* @param wild Any value you want printed to the error log or other registered
* logs/consoles.
* @param ... Other values to be logged.
* @return wild Passed $value.
*/
@ -52,15 +52,15 @@ function phlog($value/* , ... */) {
* you don't want to display these, test for `@` being in effect by checking if
* `error_reporting() === 0` before displaying the error.
*
* @param const $event A PhutilErrorHandler constant, like
* PhutilErrorHandler::ERROR, which indicates the event type
* (e.g. error, exception, user message).
* @param wild $value The event value, like the Exception object for an
* exception event, an error string for an error event, or some
* user object for user messages.
* @param dict $metadata A dictionary of metadata about the event. The keys
* 'file', 'line' and 'trace' are always available. Other keys
* may be present, depending on the event type.
* @param const A PhutilErrorHandler constant, like PhutilErrorHandler::ERROR,
* which indicates the event type (e.g. error, exception,
* user message).
* @param wild The event value, like the Exception object for an exception
* event, an error string for an error event, or some user object
* for user messages.
* @param dict A dictionary of metadata about the event. The keys 'file',
* 'line' and 'trace' are always available. Other keys may be
* present, depending on the event type.
* @return void
*/
function phutil_error_listener_example($event, $value, array $metadata) {

6
src/filesystem/FileFinder.php
View file

@ -31,8 +31,8 @@ final class FileFinder extends Phobject {
/**
* Create a new FileFinder.
*
* @param string $root Root directory to find files beneath.
* @return $this
* @param string Root directory to find files beneath.
* @return this
* @task create
*/
public function __construct($root) {
@ -106,7 +106,7 @@ final class FileFinder extends Phobject {
/**
* @task config
* @param string $mode Either "php", "shell", or the empty string.
* @param string Either "php", "shell", or the empty string.
*/
public function setForceMode($mode) {
$this->forceMode = $mode;

13
src/filesystem/FileList.php
View file

@ -26,8 +26,8 @@ final class FileList extends Phobject {
/**
* Build a new FileList from an array of paths, e.g. from $argv.
*
* @param list $paths List of relative or absolute file paths.
* @return $this
* @param list List of relative or absolute file paths.
* @return this
* @task create
*/
public function __construct($paths) {
@ -46,11 +46,10 @@ final class FileList extends Phobject {
* Determine if a path is one of the paths in the list. Note that an empty
* file list is considered to contain every file.
*
* @param string $path Relative or absolute system file path.
* @param bool $allow_parent_directory (optional) If true, consider the
* path to be contained in the list if the list contains a
* parent directory. If false, require that the path be part
* of the list explicitly.
* @param string Relative or absolute system file path.
* @param bool If true, consider the path to be contained in the list if
* the list contains a parent directory. If false, require
* that the path be part of the list explicitly.
* @return bool If true, the file is in the list.
* @task test
*/

132
src/filesystem/Filesystem.php
View file

@ -25,8 +25,8 @@ final class Filesystem extends Phobject {
* Read a file in a manner similar to file_get_contents(), but throw detailed
* exceptions on failure.
*
* @param string $path File path to read. This file must exist and be
* readable, or an exception will be thrown.
* @param string File path to read. This file must exist and be readable,
* or an exception will be thrown.
* @return string Contents of the specified file.
*
* @task file
@ -79,9 +79,9 @@ final class Filesystem extends Phobject {
* detailed exceptions on failure. If the file already exists, it will be
* overwritten.
*
* @param string $path File path to write. This file must be writable and
* its parent directory must exist.
* @param string $data Data to write.
* @param string File path to write. This file must be writable and its
* parent directory must exist.
* @param string Data to write.
*
* @task file
*/
@ -106,8 +106,8 @@ final class Filesystem extends Phobject {
* file without needing locking; any given read of the file is guaranteed to
* be self-consistent and not see partial file contents.
*
* @param string $path file path to write
* @param string $data data to write
* @param string file path to write
* @param string data to write
*
* @return boolean indicating whether the file was changed by this function.
*/
@ -159,10 +159,10 @@ final class Filesystem extends Phobject {
* exists, e.g. "example.bak", "example.bak.1", "example.bak.2", etc. (Don't
* rely on this exact behavior, of course.)
*
* @param string $base Suggested filename, like "example.bak". This name
* will be used if it does not exist, or some similar name
* will be chosen if it does.
* @param string $data Data to write to the file.
* @param string Suggested filename, like "example.bak". This name will
* be used if it does not exist, or some similar name will
* be chosen if it does.
* @param string Data to write to the file.
* @return string Path to a newly created and written file which did not
* previously exist, like "example.bak.3".
* @task file
@ -207,9 +207,9 @@ final class Filesystem extends Phobject {
* Append to a file without having to deal with file handles, with
* detailed exceptions on failure.
*
* @param string $path File path to write. This file must be writable or
* its parent directory must exist and be writable.
* @param string $data Data to write.
* @param string File path to write. This file must be writable or its
* parent directory must exist and be writable.
* @param string Data to write.
*
* @task file
*/
@ -253,9 +253,9 @@ final class Filesystem extends Phobject {
/**
* Copy a file, preserving file attributes (if relevant for the OS).
*
* @param string $from File path to copy from. This file must exist and be
* @param string File path to copy from. This file must exist and be
* readable, or an exception will be thrown.
* @param string $to File path to copy to. If a file exists at this path
* @param string File path to copy to. If a file exists at this path
* already, it wll be overwritten.
*
* @task file
@ -301,7 +301,7 @@ final class Filesystem extends Phobject {
/**
* Remove a file or directory.
*
* @param string $path File to a path or directory to remove.
* @param string File to a path or directory to remove.
* @return void
*
* @task file
@ -327,8 +327,8 @@ final class Filesystem extends Phobject {
/**
* Rename a file or directory.
*
* @param string $old Old path.
* @param string $new New path.
* @param string Old path.
* @param string New path.
*
* @task file
*/
@ -351,7 +351,7 @@ final class Filesystem extends Phobject {
* Internal. Recursively remove a file or an entire directory. Implements
* the core function of @{method:remove} in a way that works on Windows.
*
* @param string $path File to a path or directory to remove.
* @param string File to a path or directory to remove.
* @return void
*
* @task file
@ -381,9 +381,9 @@ final class Filesystem extends Phobject {
/**
* Change the permissions of a file or directory.
*
* @param string $path Path to the file or directory.
* @param int $umask Permission umask. Note that umask is in octal, so
* you should specify it as, e.g., `0777', not `777'.
* @param string Path to the file or directory.
* @param int Permission umask. Note that umask is in octal, so you
* should specify it as, e.g., `0777', not `777'.
* @return void
*
* @task file
@ -405,7 +405,7 @@ final class Filesystem extends Phobject {
/**
* Get the last modified time of a file
*
* @param string $path Path to file
* @param string Path to file
* @return int Time last modified
*
* @task file
@ -432,7 +432,7 @@ final class Filesystem extends Phobject {
* Read random bytes from /dev/urandom or equivalent. See also
* @{method:readRandomCharacters}.
*
* @param int $number_of_bytes Number of bytes to read.
* @param int Number of bytes to read.
* @return string Random bytestring of the provided length.
*
* @task file
@ -530,7 +530,7 @@ final class Filesystem extends Phobject {
* output (a-z, 0-9) so it's appropriate for use in URIs and other contexts
* where it needs to be human readable.
*
* @param int $number_of_characters Number of characters to read.
* @param int Number of characters to read.
* @return string Random character string of the provided length.
*
* @task file
@ -563,8 +563,8 @@ final class Filesystem extends Phobject {
*
* This method uses less-entropic random sources under older versions of PHP.
*
* @param int $min Minimum value, inclusive.
* @param int $max Maximum value, inclusive.
* @param int Minimum value, inclusive.
* @param int Maximum value, inclusive.
*/
public static function readRandomInteger($min, $max) {
if (!is_int($min)) {
@ -612,9 +612,9 @@ final class Filesystem extends Phobject {
* Identify the MIME type of a file. This returns only the MIME type (like
* text/plain), not the encoding (like charset=utf-8).
*
* @param string $path Path to the file to examine.
* @param string $default (optional) default mime type to return if the
* file's mime type can not be identified.
* @param string Path to the file to examine.
* @param string Optional default mime type to return if the file's mime
* type can not be identified.
* @return string File mime type.
*
* @task file
@ -693,12 +693,11 @@ final class Filesystem extends Phobject {
* Create a directory in a manner similar to mkdir(), but throw detailed
* exceptions on failure.
*
* @param string $path Path to directory. The parent directory must exist
* and be writable.
* @param int $umask Permission umask. Note that umask is in octal, so
* you should specify it as, e.g., `0777', not `777'.
* @param boolean $recursive (optional) Recursively create directories.
* Defaults to false.
* @param string Path to directory. The parent directory must exist and
* be writable.
* @param int Permission umask. Note that umask is in octal, so you
* should specify it as, e.g., `0777', not `777'.
* @param boolean Recursively create directories. Default to false.
* @return string Path to the created directory.
*
* @task directory
@ -753,13 +752,11 @@ final class Filesystem extends Phobject {
* responsible for removing it (e.g., with Filesystem::remove())
* when you are done with it.
*
* @param string $prefix (optional) directory prefix.
* @param int $umask (optional) Permissions to create the directory
* with. By default, these permissions are very restrictive
* (0700).
* @param string $root_directory (optional) Root directory. If not
* provided, the system temporary directory (often "/tmp")
* will be used.
* @param string Optional directory prefix.
* @param int Permissions to create the directory with. By default,
* these permissions are very restrictive (0700).
* @param string Optional root directory. If not provided, the system
* temporary directory (often "/tmp") will be used.
* @return string Path to newly created temporary directory.
*
* @task directory
@ -817,9 +814,8 @@ final class Filesystem extends Phobject {
/**
* List files in a directory.
*
* @param string $path Path, absolute or relative to PWD.
* @param bool $include_hidden If false, exclude files beginning with
* a ".".
* @param string Path, absolute or relative to PWD.
* @param bool If false, exclude files beginning with a ".".
*
* @return array List of files and directories in the specified
* directory, excluding `.' and `..'.
@ -854,8 +850,8 @@ final class Filesystem extends Phobject {
* Return all directories between a path and the specified root directory
* (defaulting to "/"). Iterating over them walks from the path to the root.
*
* @param string $path Path, absolute or relative to PWD.
* @param string $root (optional) The root directory.
* @param string Path, absolute or relative to PWD.
* @param string The root directory.
* @return list<string> List of parent paths, including the provided path.
* @task directory
*/
@ -928,7 +924,7 @@ final class Filesystem extends Phobject {
/**
* Checks if a path is specified as an absolute path.
*
* @param string $path
* @param string
* @return bool
*/
public static function isAbsolutePath($path) {
@ -944,8 +940,8 @@ final class Filesystem extends Phobject {
* default PWD), following parent symlinks and removing artifacts. If the
* path is itself a symlink it is left unresolved.
*
* @param string $path Path, absolute or relative to PWD.
* @return string $relative_to (optional) Canonical, absolute path.
* @param string Path, absolute or relative to PWD.
* @return string Canonical, absolute path.
*
* @task path
*/
@ -1013,8 +1009,8 @@ final class Filesystem extends Phobject {
* symlinks and removing artifacts. Both paths must exists for the relation
* to obtain. A path is always a descendant of itself as long as it exists.
*
* @param string $path Child path, absolute or relative to PWD.
* @param string $root Root path, absolute or relative to PWD.
* @param string Child path, absolute or relative to PWD.
* @param string Root path, absolute or relative to PWD.
* @return bool True if resolved child path is in fact a descendant of
* resolved root path and both exist.
* @task path
@ -1035,8 +1031,8 @@ final class Filesystem extends Phobject {
* guaranteed that you can use resolvePath() to restore a path to its
* canonical format.
*
* @param string $path Path, absolute or relative to PWD.
* @param string $pwd (optional) Working directory to make files readable
* @param string Path, absolute or relative to PWD.
* @param string Optionally, working directory to make files readable
* relative to.
* @return string Human-readable path.
*
@ -1064,7 +1060,7 @@ final class Filesystem extends Phobject {
* file_exists() in that it returns true for symlinks. This method does not
* attempt to resolve paths before testing them.
*
* @param string $path Test for the existence of this path.
* @param string Test for the existence of this path.
* @return bool True if the path exists in the filesystem.
* @task path
*/
@ -1077,7 +1073,7 @@ final class Filesystem extends Phobject {
* Determine if an executable binary (like `git` or `svn`) exists within
* the configured `$PATH`.
*
* @param string $binary Binary name, like `'git'` or `'svn'`.
* @param string Binary name, like `'git'` or `'svn'`.
* @return bool True if the binary exists and is executable.
* @task exec
*/
@ -1090,8 +1086,8 @@ final class Filesystem extends Phobject {
* Locates the full path that an executable binary (like `git` or `svn`) is at
* the configured `$PATH`.
*
* @param string $binary Binary name, like `'git'` or `'svn'`.
* @return string|null The full binary path if it is present, or null.
* @param string Binary name, like `'git'` or `'svn'`.
* @return string The full binary path if it is present, or null.
* @task exec
*/
public static function resolveBinary($binary) {
@ -1133,8 +1129,8 @@ final class Filesystem extends Phobject {
* resolvePath() only resolves symlinks in parent directories, not the
* path itself.
*
* @param string $u First path to test for equivalence.
* @param string $v Second path to test for equivalence.
* @param string First path to test for equivalence.
* @param string Second path to test for equivalence.
* @return bool True if both paths are equivalent, i.e. reference the same
* entity in the filesystem.
* @task path
@ -1175,7 +1171,7 @@ final class Filesystem extends Phobject {
* Assert that something (e.g., a file, directory, or symlink) exists at a
* specified location.
*
* @param string $path Assert that this path exists.
* @param string Assert that this path exists.
* @return void
*
* @task assert
@ -1227,7 +1223,7 @@ final class Filesystem extends Phobject {
/**
* Assert that nothing exists at a specified location.
*
* @param string $path Assert that this path does not exist.
* @param string Assert that this path does not exist.
* @return void
*
* @task assert
@ -1244,7 +1240,7 @@ final class Filesystem extends Phobject {
/**
* Assert that a path represents a file, strictly (i.e., not a directory).
*
* @param string $path Assert that this path is a file.
* @param string Assert that this path is a file.
* @return void
*
* @task assert
@ -1261,7 +1257,7 @@ final class Filesystem extends Phobject {
/**
* Assert that a path represents a directory, strictly (i.e., not a file).
*
* @param string $path Assert that this path is a directory.
* @param string Assert that this path is a directory.
* @return void
*
* @task assert
@ -1278,7 +1274,7 @@ final class Filesystem extends Phobject {
/**
* Assert that a file or directory exists and is writable.
*
* @param string $path Assert that this path is writable.
* @param string Assert that this path is writable.
* @return void
*
* @task assert
@ -1295,7 +1291,7 @@ final class Filesystem extends Phobject {
/**
* Assert that a file or directory exists and is readable.
*
* @param string $path Assert that this path is readable.
* @param string Assert that this path is readable.
* @return void
*
* @task assert

4
src/filesystem/FilesystemException.php
View file

@ -11,8 +11,8 @@ final class FilesystemException extends Exception {
/**
* Create a new FilesystemException, providing a path and a message.
*
* @param string $path Path that caused the failure.
* @param string $message Description of the failure.
* @param string Path that caused the failure.
* @param string Description of the failure.
*/
public function __construct($path, $message) {
$this->path = $path;

23
src/filesystem/PhutilDeferredLog.php
View file

@ -55,9 +55,9 @@ final class PhutilDeferredLog extends Phobject {
*
* $log = new PhutilDeferredLog('/some/file.log', '[%T] %u');
*
* @param string|null $file The file the entry should be written to, or null
* to create a log object which does not write anywhere.
* @param string $format The log entry format.
* @param string|null The file the entry should be written to, or null to
* create a log object which does not write anywhere.
* @param string The log entry format.
* @task log
*/
public function __construct($file, $format) {
@ -85,8 +85,8 @@ final class PhutilDeferredLog extends Phobject {
* When the log is written, the "%T" and "%u" variables will be replaced with
* the values you provide.
*
* @param dict $map Map of variables to values.
* @return $this
* @param dict Map of variables to values.
* @return this
* @task log
*/
public function setData(array $map) {
@ -98,9 +98,8 @@ final class PhutilDeferredLog extends Phobject {
/**
* Get existing log data.
*
* @param string $key Log data key.
* @param wild $default (optional) Default to return if data does not
* exist.
* @param string Log data key.
* @param wild Default to return if data does not exist.
* @return wild Data, or default if data does not exist.
* @task log
*/
@ -115,9 +114,9 @@ final class PhutilDeferredLog extends Phobject {
*
* NOTE: You can not change the file after the log writes.
*
* @param string|null $file File where the entry should be written to, or
* null to prevent writes.
* @return $this
* @param string|null File where the entry should be written to, or null to
* prevent writes.
* @return this
* @task log
*/
public function setFile($file) {
@ -166,7 +165,7 @@ final class PhutilDeferredLog extends Phobject {
* A log object will never write more than once, so it is safe to call this
* method even if the object's destructor later runs.
*
* @return $this
* @return this
* @task write
*/
public function write() {

4
src/filesystem/PhutilFileLock.php
View file

@ -29,7 +29,7 @@ final class PhutilFileLock extends PhutilLock {
/**
* Create a new lock on a lockfile. The file need not exist yet.
*
* @param string $lockfile The lockfile to use.
* @param string The lockfile to use.
* @return PhutilFileLock New lock object.
*
* @task construct
@ -59,7 +59,7 @@ final class PhutilFileLock extends PhutilLock {
* If the lock is already held, this method throws. You can test the lock
* status with @{method:isLocked}.
*
* @param float $wait Seconds to block waiting for the lock.
* @param float Seconds to block waiting for the lock.
* @return void
*
* @task lock

16
src/filesystem/PhutilLock.php
View file

@ -41,7 +41,7 @@ abstract class PhutilLock extends Phobject {
* Build a new lock, given a lock name. The name should be globally unique
* across all locks.
*
* @param string $name Globally unique lock name.
* @param string Globally unique lock name.
* @task construct
*/
protected function __construct($name) {
@ -55,7 +55,7 @@ abstract class PhutilLock extends Phobject {
/**
* Acquires the lock, or throws @{class:PhutilLockException} if it fails.
*
* @param float $wait Seconds to block waiting for the lock.
* @param float Seconds to block waiting for the lock.
* @return void
* @task impl
*/
@ -88,7 +88,7 @@ abstract class PhutilLock extends Phobject {
/**
* Get a named lock, if it has been registered.
*
* @param string $name Lock name.
* @param string Lock name.
* @task registry
*/
protected static function getLock($name) {
@ -99,7 +99,7 @@ abstract class PhutilLock extends Phobject {
/**
* Register a lock for cleanup when the process exits.
*
* @param PhutilLock $lock Lock to register.
* @param PhutilLock Lock to register.
* @task registry
*/
protected static function registerLock(PhutilLock $lock) {
@ -144,9 +144,9 @@ abstract class PhutilLock extends Phobject {
* If the lock is already held by this process, this method throws. You can
* test the lock status with @{method:isLocked}.
*
* @param float $wait (optional) Seconds to block waiting for the lock. By
* default, do not block.
* @return $this
* @param float Seconds to block waiting for the lock. By default, do not
* block.
* @return this
*
* @task lock
*/
@ -186,7 +186,7 @@ abstract class PhutilLock extends Phobject {
* Release the lock. Throws an exception on failure, e.g. if the lock is not
* currently held.
*
* @return $this
* @return this
*
* @task lock
*/

16
src/filesystem/TempFile.php
View file

@ -27,13 +27,11 @@ final class TempFile extends Phobject {
/**
* Create a new temporary file.
*
* @param string $filename (optional) Filename hint. This is useful if you
* intend to edit the file with an interactive editor, so the
* user's editor shows "commit-message" instead of
* "p3810hf-1z9b89bas".
* @param string $root_directory (optional) Root directory to hold the file.
* If omitted, the system temporary directory (often "/tmp")
* will be used by default.
* @param string? Filename hint. This is useful if you intend to edit the
* file with an interactive editor, so the user's editor shows
* "commit-message" instead of "p3810hf-1z9b89bas".
* @param string? Root directory to hold the file. If omitted, the system
* temporary directory (often "/tmp") will be used by default.
* @task create
*/
public function __construct($filename = null, $root_directory = null) {
@ -62,8 +60,8 @@ final class TempFile extends Phobject {
* Normally, the file is deleted when this object passes out of scope. You
* can set it to be preserved instead.
*
* @param bool $preserve True to preserve the file after object destruction.
* @return $this
* @param bool True to preserve the file after object destruction.
* @return this
* @task config
*/
public function setPreserveFile($preserve) {

4
src/filesystem/linesofalarge/LinesOfALarge.php
View file

@ -56,8 +56,8 @@ abstract class LinesOfALarge extends Phobject implements Iterator {
* without looking for delimiters. You can use this to stream a large file or
* the output of a command which returns a large amount of data.
*
* @param string|null $character A one-byte delimiter character.
* @return $this
* @param string|null A one-byte delimiter character.
* @return this
* @task config
*/
final public function setDelimiter($character) {

2
src/filesystem/linesofalarge/LinesOfALargeExecFuture.php
View file

@ -34,7 +34,7 @@ final class LinesOfALargeExecFuture extends LinesOfALarge {
/**
* To construct, pass an @{class:ExecFuture}.
*
* @param ExecFuture $future Future to wrap.
* @param ExecFuture Future to wrap.
* @return void
* @task construct
*/

2
src/filesystem/linesofalarge/LinesOfALargeFile.php
View file

@ -29,7 +29,7 @@ final class LinesOfALargeFile extends LinesOfALarge {
/**
* To construct, pass the path to a file.
*
* @param string $file_name File path to read.
* @param string File path to read.
* @return void
* @task construct
*/

20
src/future/FutureIterator.php
View file

@ -52,7 +52,7 @@ final class FutureIterator
/**
* Create a new iterator over a list of futures.
*
* @param list $futures List of @{class:Future}s to resolve.
* @param list List of @{class:Future}s to resolve.
* @task basics
*/
public function __construct(array $futures) {
@ -90,7 +90,7 @@ final class FutureIterator
* set of futures to run mostly in parallel, but some futures depend on
* others.
*
* @param Future $future @{class:Future} to add to iterator
* @param Future @{class:Future} to add to iterator
* @task basics
*/
public function addFuture(Future $future) {
@ -133,9 +133,9 @@ final class FutureIterator
* This will echo "Still working..." once per second as long as futures are
* resolving. By default, FutureIterator never yields null.
*
* @param float $interval Maximum number of seconds to block waiting on
* futures before yielding null.
* @return $this
* @param float Maximum number of seconds to block waiting on futures before
* yielding null.
* @return this
*
* @task config
*/
@ -154,8 +154,8 @@ final class FutureIterator
* // Run no more than 4 futures simultaneously.
* }
*
* @param int $max Maximum number of simultaneous jobs allowed.
* @return $this
* @param int Maximum number of simultaneous jobs allowed.
* @return this
*
* @task config
*/
@ -417,9 +417,9 @@ final class FutureIterator
/**
* Wait for activity on one of several sockets.
*
* @param list $read_list List of sockets expected to become readable.
* @param list $write_list List of sockets expected to become writable.
* @param float $timeout (optional) Timeout, in seconds.
* @param list List of sockets expected to become readable.
* @param list List of sockets expected to become writable.
* @param float Timeout, in seconds.
* @return void
*/
private function waitForSockets(

2
src/future/FutureProxy.php
View file

@ -8,7 +8,7 @@ abstract class FutureProxy extends Future {
private $proxied;
public function __construct(?Future $proxied = null) {
public function __construct(Future $proxied = null) {
if ($proxied) {
$this->setProxiedFuture($proxied);
}

45
src/future/exec/ExecFuture.php
View file

@ -119,8 +119,8 @@ final class ExecFuture extends PhutilExecutableFuture {
*
* NOTE: Setting this to 0 means "no buffer", not "unlimited buffer".
*
* @param int $limit Maximum size of the stdout read buffer.
* @return $this
* @param int Maximum size of the stdout read buffer.
* @return this
* @task config
*/
public function setStdoutSizeLimit($limit) {
@ -133,8 +133,8 @@ final class ExecFuture extends PhutilExecutableFuture {
* Set a maximum size for the stderr read buffer.
* See @{method:setStdoutSizeLimit} for discussion.
*
* @param int $limit Maximum size of the stderr read buffer.
* @return $this
* @param int Maximum size of the stderr read buffer.
* @return this
* @task config
*/
public function setStderrSizeLimit($limit) {
@ -153,9 +153,8 @@ final class ExecFuture extends PhutilExecutableFuture {
* TODO: We should probably release the read buffer limit during
* @{method:resolve}, or otherwise detect this. For now, be careful.
*
* @param int|null $read_buffer_size Maximum buffer size, or `null` for
* unlimited.
* @return $this
* @param int|null Maximum buffer size, or `null` for unlimited.
* @return this
*/
public function setReadBufferSize($read_buffer_size) {
$this->readBufferSize = $read_buffer_size;
@ -234,13 +233,13 @@ final class ExecFuture extends PhutilExecutableFuture {
/**
* Write data to stdin of the command.
*
* @param string $data Data to write.
* @param bool $keep_pipe (optional) If true, keep the pipe open for writing.
* By default, the pipe will be closed as soon as possible so
* that commands which listen for EOF will execute. If you want
* to keep the pipe open past the start of command execution, do
* an empty write with `$keep_pipe = true` first.
* @return $this
* @param string Data to write.
* @param bool If true, keep the pipe open for writing. By default, the pipe
* will be closed as soon as possible so that commands which
* listen for EOF will execute. If you want to keep the pipe open
* past the start of command execution, do an empty write with
* `$keep_pipe = true` first.
* @return this
* @task interact
*/
public function write($data, $keep_pipe = false) {
@ -268,7 +267,7 @@ final class ExecFuture extends PhutilExecutableFuture {
* future resolves. This is almost certainly only useful if you need the
* buffer memory for some reason.
*
* @return $this
* @return this
* @task interact
*/
public function discardBuffers() {
@ -309,9 +308,9 @@ final class ExecFuture extends PhutilExecutableFuture {
* The subprocess will be sent a `TERM` signal, and then a `KILL` signal a
* short while later if it fails to exit.
*
* @param int $seconds Maximum number of seconds this command may execute for
* before it is signaled.
* @return $this
* @param int Maximum number of seconds this command may execute for before
* it is signaled.
* @return this
* @task config
*/
public function setTimeout($seconds) {
@ -524,13 +523,13 @@ final class ExecFuture extends PhutilExecutableFuture {
* Reads some bytes from a stream, discarding output once a certain amount
* has been accumulated.
*
* @param resource $stream Stream to read from.
* @param int $limit Maximum number of bytes to return from $stream. If
* @param resource Stream to read from.
* @param int Maximum number of bytes to return from $stream. If
* additional bytes are available, they will be read and
* discarded.
* @param string $description Human-readable description of stream, for
* exception message.
* @param int $length Maximum number of bytes to read.
* @param string Human-readable description of stream, for exception
* message.
* @param int Maximum number of bytes to read.
* @return string The data read from the stream.
* @task internal
*/

17
src/future/exec/PhutilExecutableFuture.php
View file

@ -60,10 +60,9 @@ abstract class PhutilExecutableFuture extends Future {
* // Env will have ONLY "X".
* $exec->setEnv(array('X' => 'y'), $wipe_process_env = true);
*
* @param map<string, string> $env Dictionary of environmental variables.
* @param bool $wipe_process_env (optional) Pass `true` to replace the
* existing environment.
* @return $this
* @param map<string, string> Dictionary of environmental variables.
* @param bool Optionally, pass `true` to replace the existing environment.
* @return this
*
* @task config
*/
@ -87,9 +86,9 @@ abstract class PhutilExecutableFuture extends Future {
/**
* Set the value of a specific environmental variable for this command.
*
* @param string $key Environmental variable name.
* @param string|null $value New value, or null to remove this variable.
* @return $this
* @param string Environmental variable name.
* @param string|null New value, or null to remove this variable.
* @return this
* @task config
*/
final public function updateEnv($key, $value) {
@ -160,8 +159,8 @@ abstract class PhutilExecutableFuture extends Future {
* the subprocess will execute). If not set, the default value is the parent's
* current working directory.
*
* @param string $cwd Directory to execute the subprocess in.
* @return $this
* @param string Directory to execute the subprocess in.
* @return this
* @task config
*/
final public function setCWD($cwd) {

8
src/future/exec/execx.php
View file

@ -7,7 +7,7 @@
*
* list ($stdout, $stderr) = execx('ls %s', $file);
*
* @param string $cmd sprintf()-style command pattern to execute.
* @param string sprintf()-style command pattern to execute.
* @param ... Arguments to sprintf pattern.
* @return array List of stdout and stderr.
*/
@ -27,7 +27,7 @@ function execx($cmd /* , ... */) {
* Error flows can often be simplified by using @{function:execx} instead,
* which throws an exception when it encounters an error.
*
* @param string $cmd sprintf()-style command pattern to execute.
* @param string sprintf()-style command pattern to execute.
* @param ... Arguments to sprintf pattern.
* @return array List of return code, stdout, and stderr.
*/
@ -41,7 +41,7 @@ function exec_manual($cmd /* , ... */) {
/**
* Wrapper for @{class:PhutilExecPassthru}.
*
* @param string $cmd sprintf()-style command pattern to execute.
* @param string sprintf()-style command pattern to execute.
* @param ... Arguments to sprintf pattern.
* @return int Return code.
*/
@ -55,7 +55,7 @@ function phutil_passthru($cmd /* , ... */) {
* Return a human-readable signal name (like "SIGINT" or "SIGKILL") for a given
* signal number.
*
* @param int $signo Signal number.
* @param int Signal number.
* @return string Human-readable signal name.
*/
function phutil_get_signal_name($signo) {

54
src/future/http/BaseHTTPFuture.php
View file

@ -37,10 +37,10 @@ abstract class BaseHTTPFuture extends Future {
* instantiate it; instead, build a new @{class:HTTPFuture} or
* @{class:HTTPSFuture}.
*
* @param string $uri Fully-qualified URI to send a request to.
* @param mixed $data (optional) String or array to include in the request.
* Strings will be transmitted raw; arrays will be encoded and
* sent as 'application/x-www-form-urlencoded'.
* @param string Fully-qualified URI to send a request to.
* @param mixed String or array to include in the request. Strings will be
* transmitted raw; arrays will be encoded and sent as
* 'application/x-www-form-urlencoded'.
* @task create
*/
final public function __construct($uri, $data = array()) {
@ -58,8 +58,8 @@ abstract class BaseHTTPFuture extends Future {
* out. You can determine if a status is a timeout status by calling
* isTimeout() on the status object.
*
* @param float $timeout Maximum timeout, in seconds.
* @return $this
* @param float Maximum timeout, in seconds.
* @return this
* @task config
*/
public function setTimeout($timeout) {
@ -83,8 +83,8 @@ abstract class BaseHTTPFuture extends Future {
* Select the HTTP method (e.g., "GET", "POST", "PUT") to use for the request.
* By default, requests use "GET".
*
* @param string $method HTTP method name.
* @return $this
* @param string HTTP method name.
* @return this
* @task config
*/
final public function setMethod($method) {
@ -124,8 +124,8 @@ abstract class BaseHTTPFuture extends Future {
* Set the URI to send the request to. Note that this is also a constructor
* parameter.
*
* @param string $uri URI to send the request to.
* @return $this
* @param string URI to send the request to.
* @return this
* @task config
*/
public function setURI($uri) {
@ -151,8 +151,8 @@ abstract class BaseHTTPFuture extends Future {
* must be a string (in which case it will be sent raw) or an array (in which
* case it will be encoded and sent as 'application/x-www-form-urlencoded').
*
* @param mixed $data Data to send with the request.
* @return $this
* @param mixed Data to send with the request.
* @return this
* @task config
*/
public function setData($data) {
@ -179,9 +179,9 @@ abstract class BaseHTTPFuture extends Future {
* Add an HTTP header to the request. The same header name can be specified
* more than once, which will cause multiple headers to be sent.
*
* @param string $name Header name, like "Accept-Language".
* @param string $value Header value, like "en-us".
* @return $this
* @param string Header name, like "Accept-Language".
* @param string Header value, like "en-us".
* @return this
* @task config
*/
public function addHeader($name, $value) {
@ -200,8 +200,8 @@ abstract class BaseHTTPFuture extends Future {
*
* In either case, an array with all (or all matching) headers is returned.
*
* @param string|null $filter (optional) Filter, which selects only headers
* with that name if provided.
* @param string|null Optional filter, which selects only headers with that
* name if provided.
* @return array List of all (or all matching) headers.
* @task config
*/
@ -228,9 +228,9 @@ abstract class BaseHTTPFuture extends Future {
* HTTP status code outside the 2xx range (notwithstanding other errors such
* as connection or transport issues).
*
* @param array|null $status_codes List of expected HTTP status codes.
* @param array|null List of expected HTTP status codes.
*
* @return $this
* @return this
* @task config
*/
public function setExpectStatus($status_codes) {
@ -251,9 +251,9 @@ abstract class BaseHTTPFuture extends Future {
/**
* Add a HTTP basic authentication header to the request.
*
* @param string $username Username to authenticate with.
* @param PhutilOpaqueEnvelope $password Password to authenticate with.
* @return $this
* @param string Username to authenticate with.
* @param PhutilOpaqueEnvelope Password to authenticate with.
* @return this
* @task config
*/
public function setHTTPBasicAuthCredentials(
@ -316,7 +316,7 @@ abstract class BaseHTTPFuture extends Future {
/**
* Parse a raw HTTP response into a <status, body, headers> tuple.
*
* @param string $raw_response Raw HTTP response.
* @param string Raw HTTP response.
* @return tuple Valid resolution tuple.
* @task internal
*/
@ -393,7 +393,7 @@ abstract class BaseHTTPFuture extends Future {
/**
* Parse an HTTP header block.
*
* @param string $head_raw Raw HTTP headers.
* @param string Raw HTTP headers.
* @return list List of HTTP header tuples.
* @task internal
*/
@ -423,9 +423,9 @@ abstract class BaseHTTPFuture extends Future {
/**
* Find value of the first header with given name.
*
* @param list $headers List of headers from `resolve()`.
* @param string $search Case insensitive header name.
* @return string|null Value of the header or null if not found.
* @param list List of headers from `resolve()`.
* @param string Case insensitive header name.
* @return string Value of the header or null if not found.
* @task resolve
*/
public static function getHeader(array $headers, $search) {

44
src/future/http/HTTPSFuture.php
View file

@ -39,9 +39,8 @@ final class HTTPSFuture extends BaseHTTPFuture {
* cURL needs this to be a file, it doesn't seem to be able to handle a string
* which contains the cert. So we make a temporary file and store it there.
*
* @param string $certificate The multi-line, possibly lengthy, SSL
* certificate to use.
* @return $this
* @param string The multi-line, possibly lengthy, SSL certificate to use.
* @return this
*/
public function setCABundleFromString($certificate) {
$temp = new TempFile();
@ -53,8 +52,8 @@ final class HTTPSFuture extends BaseHTTPFuture {
/**
* Set the SSL certificate to use for this session, given a path.
*
* @param string $path The path to a valid SSL certificate for this session
* @return $this
* @param string The path to a valid SSL certificate for this session
* @return this
*/
public function setCABundleFromPath($path) {
$this->cabundle = $path;
@ -74,9 +73,9 @@ final class HTTPSFuture extends BaseHTTPFuture {
* Set whether Location headers in the response will be respected.
* The default is true.
*
* @param boolean $follow true to follow any Location header present in the
* response, false to return the request directly
* @return $this
* @param boolean true to follow any Location header present in the response,
* false to return the request directly
* @return this
*/
public function setFollowLocation($follow) {
$this->followLocation = $follow;
@ -96,7 +95,7 @@ final class HTTPSFuture extends BaseHTTPFuture {
* Set the fallback CA certificate if one is not specified
* for the session, given a path.
*
* @param string $path The path to a valid SSL certificate
* @param string The path to a valid SSL certificate
* @return void
*/
public static function setGlobalCABundleFromPath($path) {
@ -106,7 +105,7 @@ final class HTTPSFuture extends BaseHTTPFuture {
* Set the fallback CA certificate if one is not specified
* for the session, given a string.
*
* @param string $certificate The certificate
* @param string The certificate
* @return void
*/
public static function setGlobalCABundleFromString($certificate) {
@ -128,8 +127,8 @@ final class HTTPSFuture extends BaseHTTPFuture {
* Load contents of remote URI. Behaves pretty much like
* `@file_get_contents($uri)` but doesn't require `allow_url_fopen`.
*
* @param string $uri
* @param float $timeout (optional)
* @param string
* @param float
* @return string|false
*/
public static function loadContent($uri, $timeout = null) {
@ -187,11 +186,11 @@ final class HTTPSFuture extends BaseHTTPFuture {
/**
* Attach a file to the request.
*
* @param string $key HTTP parameter name.
* @param string $data File content.
* @param string $name File name.
* @param string $mime_type File mime type.
* @return $this
* @param string HTTP parameter name.
* @param string File content.
* @param string File name.
* @param string File mime type.
* @return this
*/
public function attachFileData($key, $data, $name, $mime_type) {
if (isset($this->files[$key])) {
@ -627,7 +626,7 @@ final class HTTPSFuture extends BaseHTTPFuture {
* Discard any buffered data. Normally, you call this after reading the
* data with @{method:read}.
*
* @return $this
* @return this
*/
public function discardBuffers() {
if ($this->isDownload()) {
@ -771,9 +770,8 @@ final class HTTPSFuture extends BaseHTTPFuture {
/**
* Detect strings which will cause cURL to do horrible, insecure things.
*
* @param string $string Possibly dangerous string.
* @param bool $is_query_string True if this string is being used as part
* of a query string.
* @param string Possibly dangerous string.
* @param bool True if this string is being used as part of a query string.
* @return void
*/
private function checkForDangerousCURLMagic($string, $is_query_string) {
@ -830,8 +828,8 @@ final class HTTPSFuture extends BaseHTTPFuture {
*
* You must write the entire body before starting the request.
*
* @param string $raw_body Raw body.
* @return $this
* @param string Raw body.
* @return this
*/
public function write($raw_body) {
$this->rawBody = $raw_body;

2
src/future/http/status/HTTPFutureHTTPResponseStatus.php
View file

@ -11,8 +11,6 @@ final class HTTPFutureHTTPResponseStatus extends HTTPFutureResponseStatus {
array $headers,
$expect = null) {
// As $body can be null (T15930), make sure this code deals with a string
$body = phutil_string_cast($body);
// NOTE: Avoiding PhutilUTF8StringTruncator here because this isn't lazy
// and responses may be large.
if (strlen($body) > 512) {

3
src/future/oauth/PhutilOAuth1Future.php
View file

@ -225,12 +225,11 @@ final class PhutilOAuth1Future extends FutureProxy {
private function signString($string) {
$consumer_secret = null;
$key = '';
if ($this->consumerSecret) {
$consumer_secret = $this->consumerSecret->openEnvelope();
$key .= urlencode($consumer_secret).'&';
}
$key = urlencode($consumer_secret).'&';
if ($this->tokenSecret !== null) {
$key .= urlencode($this->tokenSecret);
}

1
src/future/postmark/PhutilPostmarkFuture.php
View file

@ -3,7 +3,6 @@
final class PhutilPostmarkFuture extends FutureProxy {
private $future;
private $clientID;
private $accessToken;
private $method;
private $parameters;

3
src/hardpoint/ArcanistHardpointTask.php
View file

@ -105,8 +105,7 @@ final class ArcanistHardpointTask
$result = $generator->current();
if ($result instanceof Future) {
$result =
ArcanistHardpointFutureList::newFromFutures(array($result));
$result = new ArcanistHardpointFutureList($result);
}
if ($result instanceof ArcanistHardpointFutureList) {

4
src/hgdaemon/ArcanistHgClientChannel.php
View file

@ -50,7 +50,7 @@ final class ArcanistHgClientChannel extends PhutilProtocolChannel {
* For a detailed description of the cmdserver protocol, see
* @{class:ArcanistHgServerChannel}.
*
* @param pair<string,string> $argv The <channel, data> pair to encode.
* @param pair<string,string> The <channel, data> pair to encode.
* @return string Encoded string for transmission to the client.
*
* @task protocol
@ -88,7 +88,7 @@ final class ArcanistHgClientChannel extends PhutilProtocolChannel {
* '5',
* );
*
* @param string $data Bytes from the server.
* @param string Bytes from the server.
* @return list<list<string>> Zero or more complete commands.
*
* @task protocol

9
src/hgdaemon/ArcanistHgProxyClient.php
View file

@ -41,7 +41,7 @@ final class ArcanistHgProxyClient extends Phobject {
* Build a new client. This client is bound to a working copy. A server
* must already be running on this working copy for the client to work.
*
* @param string $working_copy Path to a Mercurial working copy.
* @param string Path to a Mercurial working copy.
*
* @task construct
*/
@ -56,8 +56,8 @@ final class ArcanistHgProxyClient extends Phobject {
/**
* When connecting, do not expect the "capabilities" message.
*
* @param bool $skip True to skip the "capabilities" message.
* @return $this
* @param bool True to skip the "capabilities" message.
* @return this
*
* @task config
*/
@ -73,8 +73,7 @@ final class ArcanistHgProxyClient extends Phobject {
/**
* Execute a command (given as a list of arguments) via the command server.
*
* @param list<string> $argv A list of command arguments, like "log", "-l",
* "5".
* @param list<string> A list of command arguments, like "log", "-l", "5".
* @return tuple<int, string, string> Return code, stdout and stderr.
*
* @task exec

26
src/hgdaemon/ArcanistHgProxyServer.php
View file

@ -52,7 +52,7 @@ final class ArcanistHgProxyServer extends Phobject {
* Build a new server. This server is bound to a working copy. The server
* is inactive until you @{method:start} it.
*
* @param string $working_copy Path to a Mercurial working copy.
* @param string Path to a Mercurial working copy.
*
* @task construct
*/
@ -67,8 +67,8 @@ final class ArcanistHgProxyServer extends Phobject {
/**
* Disable status messages to stdout. Controlled with `--quiet`.
*
* @param bool $quiet True to disable status messages.
* @return $this
* @param bool True to disable status messages.
* @return this
*
* @task config
*/
@ -85,8 +85,8 @@ final class ArcanistHgProxyServer extends Phobject {
* You can use `--client-limit 1` with `--xprofile` and `--do-not-daemonize`
* to profile the server.
*
* @param int $limit Client limit, or 0 to disable limit.
* @return $this
* @param int Client limit, or 0 to disable limit.
* @return this
*
* @task config
*/
@ -100,8 +100,8 @@ final class ArcanistHgProxyServer extends Phobject {
* Configure an idle time limit. After this many seconds idle, the server
* will exit. Controlled with `--idle-limit`.
*
* @param int $limit Idle limit, or 0 to disable limit.
* @return $this
* @param int Idle limit, or 0 to disable limit.
* @return this
*
* @task config
*/
@ -117,8 +117,8 @@ final class ArcanistHgProxyServer extends Phobject {
* if the clients are also configured not to expect the message, but slightly
* improves performance. Controlled with --skip-hello.
*
* @param bool $skip True to skip the "capabilities" message.
* @return $this
* @param bool True to skip the "capabilities" message.
* @return this
*
* @task config
*/
@ -132,8 +132,8 @@ final class ArcanistHgProxyServer extends Phobject {
* Configure whether the server runs in the foreground or daemonizes.
* Controlled by --do-not-daemonize. Primarily useful for debugging.
*
* @param bool $do_not_daemonize True to run in the foreground.
* @return $this
* @param bool True to run in the foreground.
* @return this
*
* @task config
*/
@ -252,8 +252,8 @@ final class ArcanistHgProxyServer extends Phobject {
* process all commands we've received here before returning to the main
* server loop.
*
* @param ArcanistHgClientChannel $client The client to update.
* @param ArcanistHgServerChannel $hg The Mercurial server.
* @param ArcanistHgClientChannel The client to update.
* @param ArcanistHgServerChannel The Mercurial server.
*
* @task server
*/

4
src/hgdaemon/ArcanistHgServerChannel.php
View file

@ -80,7 +80,7 @@ final class ArcanistHgServerChannel extends PhutilProtocolChannel {
* -l\0
* 5
*
* @param list<string> $argv List of command arguments.
* @param list<string> List of command arguments.
* @return string Encoded string for transmission to the server.
*
* @task protocol
@ -116,7 +116,7 @@ final class ArcanistHgServerChannel extends PhutilProtocolChannel {
*
* array('o', '<data...>');
*
* @param string $data Bytes from the server.
* @param string Bytes from the server.
* @return list<pair<string,string>> Zero or more complete messages.
*
* @task protocol

8
src/init/lib/PhutilLibraryConflictException.php
View file

@ -30,10 +30,10 @@ final class PhutilLibraryConflictException extends Exception {
/**
* Create a new library conflict exception.
*
* @param string $library The name of the library which conflicts with an
* existing library.
* @param string $old_path The path of the already-loaded library.
* @param string $new_path The path of the attempting-to-load library.
* @param string The name of the library which conflicts with an existing
* library.
* @param string The path of the already-loaded library.
* @param string The path of the attempting-to-load library.
*
* @task construct
*/

29
src/internationalization/PhutilLocale.php
View file

@ -30,14 +30,11 @@ abstract class PhutilLocale extends Phobject {
* For locales like "English (Great Britain)", missing translations can be
* sourced from "English (US)".
*
* Languages with no other fallback use en_US because that's better
* than proto-English for untranslated strings.
*
* @return string|null Locale code of fallback locale, or null if there is
* no fallback locale.
*/
public function getFallbackLocaleCode() {
return 'en_US';
return null;
}
@ -45,8 +42,8 @@ abstract class PhutilLocale extends Phobject {
* Select a gender variant for this locale. By default, locales use a simple
* rule with two gender variants, listed in "<male, female>" order.
*
* @param const $variant `PhutilPerson` gender constant.
* @param list<wild> $translations List of variants.
* @param const `PhutilPerson` gender constant.
* @param list<wild> List of variants.
* @return string Variant for use.
*/
public function selectGenderVariant($variant, array $translations) {
@ -62,8 +59,8 @@ abstract class PhutilLocale extends Phobject {
* Select a plural variant for this locale. By default, locales use a simple
* rule with two plural variants, listed in "<singular, plural>" order.
*
* @param int $variant Plurality of the value.
* @param list<wild> $translations List of variants.
* @param int Plurality of the value.
* @param list<wild> List of variants.
* @return string Variant for use.
*/
public function selectPluralVariant($variant, array $translations) {
@ -121,10 +118,10 @@ abstract class PhutilLocale extends Phobject {
* from @{method:shouldPostProcessTranslations}. Activating this callback
* incurs a performance penalty.
*
* @param string $raw_pattern The raw input pattern.
* @param string $translated_pattern The selected translation pattern.
* @param list<wild> $args The raw input arguments.
* @param string $result_text The translated string.
* @param string The raw input pattern.
* @param string The selected translation pattern.
* @param list<wild> The raw input arguments.
* @param string The translated string.
* @return string Post-processed translation string.
*/
public function didTranslateString(
@ -195,7 +192,7 @@ abstract class PhutilLocale extends Phobject {
/**
* Load a specific locale using a locale code.
*
* @param string $locale_code Locale code.
* @param string Locale code.
* @return PhutilLocale Locale object.
*/
public static function loadLocale($locale_code) {
@ -216,9 +213,9 @@ abstract class PhutilLocale extends Phobject {
/**
* Recursively check locale fallbacks for cycles.
*
* @param map<string, PhutilLocale> $map Map of locales.
* @param PhutilLocale $locale Current locale.
* @param map<string, string> $seen Map of visited locales.
* @param map<string, PhutilLocale> Map of locales.
* @param PhutilLocale Current locale.
* @param map<string, string> Map of visited locales.
* @return void
*/
private static function checkLocaleFallback(

2
src/internationalization/PhutilTranslation.php
View file

@ -59,7 +59,7 @@ abstract class PhutilTranslation extends Phobject {
* This will compile primary and fallback translations into a single
* translation map.
*
* @param string $locale_code Locale code, like "en_US".
* @param string Locale code, like "en_US".
* @return map<string, wild> Map of all avialable translations.
*/
public static function getTranslationMapForLocale($locale_code) {

10
src/internationalization/PhutilTranslator.php
View file

@ -64,7 +64,7 @@ final class PhutilTranslator extends Phobject {
* '%s owns %s.' => '%2$s is owned by %1$s.',
* );
*
* @param array $translations Identifier in key, translation in value.
* @param array Identifier in key, translation in value.
* @return PhutilTranslator Provides fluent interface.
*/
public function setTranslations(array $translations) {
@ -212,8 +212,8 @@ final class PhutilTranslator extends Phobject {
/**
* Translate date formatted by `$date->format()`.
*
* @param string $format Format accepted by `DateTime::format()`.
* @param DateTime $date
* @param string Format accepted by `DateTime::format()`.
* @param DateTime
* @return string Formatted and translated date.
*/
public function translateDate($format, DateTime $date) {
@ -243,8 +243,8 @@ final class PhutilTranslator extends Phobject {
* translations of '.' (decimal point) and ',' (thousands separator). Both
* these translations must be 1 byte long with PHP < 5.4.0.
*
* @param float $number
* @param int $decimals (optional)
* @param float
* @param int
* @return string
*/
public function formatNumber($number, $decimals = 0) {

69
src/internationalization/__tests__/PhutilPhtTestCase.php
View file

@ -29,4 +29,73 @@ final class PhutilPhtTestCase extends PhutilTestCase {
$this->assertEqual('5 piv', pht('%d beer(s)', 5));
}
public function getDateTranslations() {
// The only purpose of this function is to provide a static list of
// translations which can come from PhutilTranslator::translateDate() to
// allow translation extractor getting them.
return array(
'D' => array(
pht('Sun'),
pht('Mon'),
pht('Tue'),
pht('Wed'),
pht('Thu'),
pht('Fri'),
pht('Sat'),
),
'l' => array(
pht('Sunday'),
pht('Monday'),
pht('Tuesday'),
pht('Wednesday'),
pht('Thursday'),
pht('Friday'),
pht('Saturday'),
),
'S' => array(
pht('st'),
pht('nd'),
pht('rd'),
pht('th'),
),
'F' => array(
pht('January'),
pht('February'),
pht('March'),
pht('April'),
pht('May'),
pht('June'),
pht('July'),
pht('August'),
pht('September'),
pht('October'),
pht('November'),
pht('December'),
),
'M' => array(
pht('Jan'),
pht('Feb'),
pht('Mar'),
pht('Apr'),
pht('May'),
pht('Jun'),
pht('Jul'),
pht('Aug'),
pht('Sep'),
pht('Oct'),
pht('Nov'),
pht('Dec'),
),
'a' => array(
pht('am'),
pht('pm'),
),
'A' => array(
pht('AM'),
pht('PM'),
),
);
}
}

9
src/internationalization/locales/PhutilPortugueseBrazilLocale.php
View file

@ -13,13 +13,4 @@ final class PhutilPortugueseBrazilLocale extends PhutilLocale {
return pht('Portuguese (Brazil)');
}
public function getFallbackLocaleCode() {
// Phabricator does not support bidirectional
// fallbacks (pt_BR -> pt and pt -> pt_BR simultaneously)
// since Translatewiki calls pt_PT "Portugese" without a country
// it makes slightly more sense to fall back in this direction
// than the other one
return 'pt_PT';
}
}

10
src/internationalization/locales/PhutilPortuguesePortugalLocale.php
View file

@ -13,14 +13,4 @@ final class PhutilPortuguesePortugalLocale extends PhutilLocale {
return pht('Portuguese (Portugal)');
}
public function getFallbackLocaleCode() {
// Ideally this would be pt_BR but Phabricator does not support
// bidirectional fallbacks (pt_BR -> pt and pt -> pt_BR simultaneously)
// since Translatewiki calls pt_PT "Portugese" without a country
// it makes slightly more sense to fall back in the other direction
// In the mean time return `en_US` so users don't see Proto-English
// unncecessarily
return 'en_US';
}
}

9
src/internationalization/locales/PhutilSimplifiedChineseLocale.php
View file

@ -13,13 +13,4 @@ final class PhutilSimplifiedChineseLocale extends PhutilLocale {
return pht('Chinese (Simplified)');
}
public function getFallbackLocaleCode() {
// Ideally this would be zh_Hant but Phabricator does not support
// bidirectional fallbacks
// (zh_Hant -> zh_Hans and zh_Hans -> zh_Hant simultaneously)
// arbitrarily choose to fall back in the other direction instead
// In the mean time return `en_US` so users don't see Proto-English
return 'en_US';
}
}

4
src/internationalization/locales/PhutilTraditionalChineseLocale.php
View file

@ -13,8 +13,4 @@ final class PhutilTraditionalChineseLocale extends PhutilLocale {
return pht('Chinese (Traditional)');
}
public function getFallbackLocaleCode() {
return 'zh_Hans';
}
}

6
src/internationalization/locales/PhutilUSEnglishLocale.php
View file

@ -13,10 +13,4 @@ final class PhutilUSEnglishLocale extends PhutilLocale {
return pht('English (US)');
}
public function getFallbackLocaleCode() {
// The default fallback is en_US, explicitly return null here
// to avoid a fallback loop
return null;
}
}

10
src/internationalization/pht.php
View file

@ -6,9 +6,8 @@
* `PhutilTranslator::getInstance()->setTranslations()` and language rules set
* by `PhutilTranslator::getInstance()->setLocale()`.
*
* @param string $text Translation identifier with `sprintf()` placeholders.
* @param mixed $variant (optional) Value to select the variant from (e.g.
* singular or plural). Defaults to null.
* @param string Translation identifier with `sprintf()` placeholders.
* @param mixed Value to select the variant from (e.g. singular or plural).
* @param ... Next values referenced from $text.
* @return string Translated string with substituted values.
*/
@ -21,7 +20,7 @@ function pht($text, $variant = null /* , ... */) {
/**
* Count all elements in an array, or something in an object.
*
* @param array|Countable $countable A countable object.
* @param array|Countable A countable object.
* @return PhutilNumber Returns the number of elements in the input
* parameter.
*/
@ -39,8 +38,7 @@ function phutil_count($countable) {
* This function does nothing and only serves as a marker for the static
* extractor so it knows particular arguments may vary on gender.
*
* @param PhutilPerson $person Something implementing
* @{interface:PhutilPerson}.
* @param PhutilPerson Something implementing @{interface:PhutilPerson}.
* @return PhutilPerson The argument, unmodified.
*/
function phutil_person(PhutilPerson $person) {

14
src/land/engine/ArcanistLandEngine.php
View file

@ -1420,8 +1420,7 @@ abstract class ArcanistLandEngine
* and min is the earliest ancestor. This is done so that non-landing commits
* that are descendants of the latest revision will only be rebased once.
*
* @param ArcanistLandCommitSet $set The current commit set to cascade.
* @param string $into_commit The commit hash that was landed into.
* @param ArcanistLandCommitSet The current commit set to cascade.
*/
abstract protected function cascadeState(
ArcanistLandCommitSet $set,
@ -1435,7 +1434,7 @@ abstract class ArcanistLandEngine
* Prunes the given sets of commits. This should be called after the sets
* have been merged.
*
* @param array $sets The list of ArcanistLandCommitSet to prune, in order of
* @param array The list of ArcanistLandCommitSet to prune, in order of
* min to max commit set, where min is the earliest ancestor and max
* is the latest descendant.
*/
@ -1446,10 +1445,9 @@ abstract class ArcanistLandEngine
* should only be called after all changes have been merged, pruned, and
* pushed.
*
* @param string $into_commit The commit hash that was landed into.
* @param ArcanistRepositoryLocalState $state The local state that was
* captured at the beginning of the land process. This may include stashed
* changes.
* @param string The commit hash that was landed into.
* @param ArcanistRepositoryLocalState The local state that was captured
* at the beginning of the land process. This may include stashed changes.
*/
abstract protected function reconcileLocalState(
$into_commit,
@ -1459,7 +1457,7 @@ abstract class ArcanistLandEngine
* Display information to the user about how to proceed since the land
* process was not fully completed. The merged branch has not been pushed.
*
* @param string $into_commit The commit hash that was landed into.
* @param string The commit hash that was landed into.
*/
abstract protected function didHoldChanges($into_commit);

4
src/lexer/PhutilLexer.php
View file

@ -233,8 +233,8 @@ abstract class PhutilLexer extends Phobject {
/**
* Lex an input string into tokens.
*
* @param string $input Input string.
* @param string $initial_state (optional) Initial lexer state.
* @param string Input string.
* @param string Initial lexer state.
* @return list List of lexer tokens.
* @task tokens
*/

2
src/lexer/PhutilShellLexer.php
View file

@ -21,7 +21,7 @@ final class PhutilShellLexer extends PhutilLexer {
* "\"",
* );
*
* @param string $string Shell command string.
* @param string Shell command string.
* @return array Parsed argument vector.
*/
public function splitArguments($string) {

7
src/lint/ArcanistLintMessage.php
View file

@ -184,7 +184,7 @@ final class ArcanistLintMessage extends Phobject {
}
/**
* @param dict $locations Keys 'path', 'line', 'char', 'original'.
* @param dict Keys 'path', 'line', 'char', 'original'.
*/
public function setOtherLocations(array $locations) {
assert_instances_of($locations, 'array');
@ -272,9 +272,8 @@ final class ArcanistLintMessage extends Phobject {
* less strict in linters themselves, since they often parse command line
* output or XML and will end up with string representations of numbers.
*
* @param mixed $value Integer or digit string.
* @param mixed $caller
* @return int|null Integer, or null if $value is null
* @param mixed Integer or digit string.
* @return int Integer.
*/
private function validateInteger($value, $caller) {
if ($value === null) {

15
src/lint/engine/ArcanistLintEngine.php
View file

@ -291,8 +291,7 @@ abstract class ArcanistLintEngine extends Phobject {
/**
* @param dict<string path, dict<string version, list<dict message>>>
* $results
* @return $this
* @return this
*/
final public function setCachedResults(array $results) {
$this->cachedResults = $results;
@ -420,9 +419,9 @@ abstract class ArcanistLintEngine extends Phobject {
* construction of the result so it doesn't need to be built multiple
* times.
*
* @param string $key Resource identifier.
* @param wild $default (optional) Default value to return if resource
* does not exist.
* @param string Resource identifier.
* @param wild Optionally, default value to return if resource does not
* exist.
* @return wild Resource, or default value if not present.
*/
public function getLinterResource($key, $default = null) {
@ -435,9 +434,9 @@ abstract class ArcanistLintEngine extends Phobject {
*
* See @{method:getLinterResource} for a description of this mechanism.
*
* @param string $key Resource identifier.
* @param wild $value Resource.
* @return $this
* @param string Resource identifier.
* @param wild Resource.
* @return this
*/
public function setLinterResource($key, $value) {
$this->linterResources[$key] = $value;

12
src/lint/linter/ArcanistBaseXHPASTLinter.php
View file

@ -101,7 +101,7 @@ abstract class ArcanistBaseXHPASTLinter extends ArcanistFutureLinter {
/**
* Build futures on this linter, for use and to share with other linters.
*
* @param list<string> $paths Paths to build futures for.
* @param list<string> Paths to build futures for.
* @return list<ExecFuture> Futures.
* @task sharing
*/
@ -122,7 +122,7 @@ abstract class ArcanistBaseXHPASTLinter extends ArcanistFutureLinter {
/**
* Release futures on this linter which are no longer in use elsewhere.
*
* @param list<string> $paths Paths to release futures for.
* @param list<string> Paths to release futures for.
* @return void
* @task sharing
*/
@ -152,7 +152,7 @@ abstract class ArcanistBaseXHPASTLinter extends ArcanistFutureLinter {
/**
* Get a path's tree from the responsible linter.
*
* @param string $path Path to retrieve tree for.
* @param string Path to retrieve tree for.
* @return XHPASTTree|null Tree, or null if unparseable.
* @task sharing
*/
@ -188,7 +188,7 @@ abstract class ArcanistBaseXHPASTLinter extends ArcanistFutureLinter {
/**
* Get a path's parse exception from the responsible linter.
*
* @param string $path Path to retrieve exception for.
* @param string Path to retrieve exception for.
* @return Exception|null Parse exception, if available.
* @task sharing
*/
@ -209,8 +209,8 @@ abstract class ArcanistBaseXHPASTLinter extends ArcanistFutureLinter {
* Returns all descendant nodes which represent a function call to one of the
* specified functions.
*
* @param XHPASTNode $root Root node.
* @param list<string> $function_names Function names.
* @param XHPASTNode Root node.
* @param list<string> Function names.
* @return AASTNodeList
*/
protected function getFunctionCalls(XHPASTNode $root, array $function_names) {

2
src/lint/linter/ArcanistChmodLinter.php
View file

@ -117,7 +117,7 @@ final class ArcanistChmodLinter extends ArcanistLinter {
/**
* Returns the path's shebang.
*
* @param string $path
* @param string
* @return string|null
*/
private function getShebang($path) {

30
src/lint/linter/ArcanistExternalLinter.php
View file

@ -104,8 +104,8 @@ abstract class ArcanistExternalLinter extends ArcanistFutureLinter {
* Override default flags with custom flags. If not overridden, flags provided
* by @{method:getDefaultFlags} are used.
*
* @param list<string> $flags New flags.
* @return $this
* @param list<string> New flags.
* @return this
* @task bin
*/
final public function setFlags(array $flags) {
@ -116,8 +116,8 @@ abstract class ArcanistExternalLinter extends ArcanistFutureLinter {
/**
* Set the binary's version requirement.
*
* @param string $version Version requirement.
* @return $this
* @param string Version requirement.
* @return this
* @task bin
*/
final public function setVersionRequirement($version) {
@ -151,8 +151,8 @@ abstract class ArcanistExternalLinter extends ArcanistFutureLinter {
/**
* Override the default binary with a new one.
*
* @param string $bin New binary.
* @return $this
* @param string New binary.
* @return this
* @task bin
*/
final public function setBinary($bin) {
@ -200,8 +200,8 @@ abstract class ArcanistExternalLinter extends ArcanistFutureLinter {
/**
* Set the interpreter, overriding any default.
*
* @param string $interpreter New interpreter.
* @return $this
* @param string New interpreter.
* @return this
* @task bin
*/
final public function setInterpreter($interpreter) {
@ -223,10 +223,10 @@ abstract class ArcanistExternalLinter extends ArcanistFutureLinter {
* you're able to detect a more specific condition.) Otherwise, return a list
* of messages.
*
* @param string $path Path to the file being linted.
* @param int $err Exit code of the linter.
* @param string $stdout Stdout of the linter.
* @param string $stderr Stderr of the linter.
* @param string Path to the file being linted.
* @param int Exit code of the linter.
* @param string Stdout of the linter.
* @param string Stderr of the linter.
* @return list<ArcanistLintMessage>|false List of lint messages, or false
* to indicate parser failure.
* @task parse
@ -298,7 +298,7 @@ abstract class ArcanistExternalLinter extends ArcanistFutureLinter {
* of the configured binary to the required version, and if the binary's
* version is not supported, throw an exception.
*
* @param string $version Version string to check.
* @param string Version string to check.
* @return void
*/
final protected function checkBinaryVersion($version) {
@ -415,7 +415,7 @@ abstract class ArcanistExternalLinter extends ArcanistFutureLinter {
*
* This method is expected to return an already escaped string.
*
* @param string $path Path to the file being linted
* @param string Path to the file being linted
* @return string The command-ready file argument
*/
protected function getPathArgumentForLinterFuture($path) {
@ -572,7 +572,7 @@ abstract class ArcanistExternalLinter extends ArcanistFutureLinter {
*
* If the code is not recognized, you should throw an exception.
*
* @param string $code Code specified in configuration.
* @param string Code specified in configuration.
* @return string Normalized code to use in severity map.
*/
protected function getLintCodeFromLinterConfigurationKey($code) {

2
src/lint/linter/ArcanistFutureLinter.php
View file

@ -47,7 +47,7 @@ abstract class ArcanistFutureLinter extends ArcanistLinter {
* This is invoked after a block of futures resolve, and allows linters to
* discard or clean up any shared resources they no longer need.
*
* @param map<string, Future> $futures Map of paths to resolved futures.
* @param map<string, Future> Map of paths to resolved futures.
* @return void
*/
protected function didResolveLinterFutures(array $futures) {

14
src/lint/linter/ArcanistLinter.php
View file

@ -131,8 +131,8 @@ abstract class ArcanistLinter extends Phobject {
*
* This ID is assigned automatically by the @{class:ArcanistLintEngine}.
*
* @param string $id Unique linter ID.
* @return $this
* @param string Unique linter ID.
* @return this
* @task state
*/
final public function setLinterID($id) {
@ -168,7 +168,7 @@ abstract class ArcanistLinter extends Phobject {
* Linters which are not parallelizable should normally ignore this callback
* and implement @{method:lintPath} instead.
*
* @param list<string> $paths A list of paths to be linted
* @param list<string> A list of paths to be linted
* @return void
* @task exec
*/
@ -185,7 +185,7 @@ abstract class ArcanistLinter extends Phobject {
* Linters which are parallelizable may want to ignore this callback and
* implement @{method:willLintPaths} and @{method:didLintPaths} instead.
*
* @param string $path Path to lint.
* @param string Path to lint.
* @return void
* @task exec
*/
@ -202,7 +202,7 @@ abstract class ArcanistLinter extends Phobject {
* Linters which are not paralleizable should normally ignore this callback
* and implement @{method:lintPath} instead.
*
* @param list<string> $paths A list of paths which were linted.
* @param list<string> A list of paths which were linted.
* @return void
* @task exec
*/
@ -288,7 +288,7 @@ abstract class ArcanistLinter extends Phobject {
* Filter out paths which this linter doesn't act on (for example, because
* they are binaries and the linter doesn't apply to binaries).
*
* @param list<string> $paths
* @param list<string>
* @return list<string>
*/
private function filterPaths(array $paths) {
@ -617,7 +617,7 @@ abstract class ArcanistLinter extends Phobject {
*
* If the code is not recognized, you should throw an exception.
*
* @param string $code Code specified in configuration.
* @param string Code specified in configuration.
* @return string Normalized code to use in severity map.
*/
protected function getLintCodeFromLinterConfigurationKey($code) {

5
src/lint/linter/ArcanistScriptAndRegexLinter.php
View file

@ -324,8 +324,7 @@ final class ArcanistScriptAndRegexLinter extends ArcanistLinter {
/**
* Get the line and character of the message from the regex match.
*
* @param dict $match Captured groups from regex.
* @param string $path
* @param dict Captured groups from regex.
* @return pair<int|null,int|null> Line and character of the message.
*
* @task parse
@ -363,7 +362,7 @@ final class ArcanistScriptAndRegexLinter extends ArcanistLinter {
* a nonempty severity name group like 'error', or a group called 'severity'
* with a valid name.
*
* @param dict $match Captured groups from regex.
* @param dict Captured groups from regex.
* @return const @{class:ArcanistLintSeverity} constant.
*
* @task parse

4
src/lint/linter/ArcanistXHPASTLinter.php
View file

@ -29,8 +29,8 @@ final class ArcanistXHPASTLinter extends ArcanistBaseXHPASTLinter {
* This is primarily useful for unit tests in which it is desirable to test
* linter rules in isolation. By default, all linter rules will be enabled.
*
* @param list<ArcanistXHPASTLinterRule> $rules
* @return $this
* @param list<ArcanistXHPASTLinterRule>
* @return this
*/
public function setRules(array $rules) {
assert_instances_of($rules, 'ArcanistXHPASTLinterRule');

4
src/lint/linter/__tests__/ArcanistLinterTestCase.php
View file

@ -305,8 +305,8 @@ abstract class ArcanistLinterTestCase extends PhutilTestCase {
/**
* Compare properties of @{class:ArcanistLintMessage} instances.
*
* @param wild $x
* @param wild $y
* @param wild
* @param wild
* @return bool
*/
private static function compareLintMessageProperty($x, $y) {

8
src/lint/linter/standards/ArcanistLinterStandard.php
View file

@ -35,7 +35,7 @@ abstract class ArcanistLinterStandard extends Phobject {
/**
* Checks whether the linter standard supports a specified linter.
*
* @param ArcanistLinter $linter The linter which is being configured.
* @param ArcanistLinter The linter which is being configured.
* @return bool True if the linter standard supports the specified
* linter, otherwise false.
*/
@ -68,8 +68,8 @@ abstract class ArcanistLinterStandard extends Phobject {
/**
* Load a linter standard by key.
*
* @param string $key
* @param ArcanistLinter $linter
* @param string
* @param ArcanistLinter
* @return ArcanistLinterStandard
*/
final public static function getStandard($key, ArcanistLinter $linter) {
@ -100,7 +100,7 @@ abstract class ArcanistLinterStandard extends Phobject {
/**
* Load all linter standards which support a specified linter.
*
* @param ArcanistLinter $linter
* @param ArcanistLinter
* @return list<ArcanistLinterStandard>
*/
final public static function loadAllStandardsForLinter(

25
src/lint/linter/xhpast/ArcanistXHPASTLintNamingHook.php
View file

@ -17,7 +17,7 @@ abstract class ArcanistXHPASTLintNamingHook extends Phobject {
* The constructor is final because @{class:ArcanistXHPASTLinter} is
* responsible for hook instantiation.
*
* @return $this
* @return this
* @task internals
*/
final public function __construct() {
@ -45,13 +45,12 @@ abstract class ArcanistXHPASTLintNamingHook extends Phobject {
* }
* return $default;
*
* @param string $type The symbol type.
* @param string $name The symbol name.
* @param string|null $default The default result from the main rule
* engine.
* @param string The symbol type.
* @param string The symbol name.
* @param string|null The default result from the main rule engine.
* @return string|null Null to accept the name, or a message to reject it
* with. You should return the default value if you
* don't want to specifically provide an override.
* with. You should return the default value if you don't
* want to specifically provide an override.
* @task override
*/
abstract public function lintSymbolName($type, $name, $default);
@ -62,7 +61,7 @@ abstract class ArcanistXHPASTLintNamingHook extends Phobject {
/**
* Returns true if a symbol name is UpperCamelCase.
*
* @param string $symbol Symbol name.
* @param string Symbol name.
* @return bool True if the symbol is UpperCamelCase.
* @task util
*/
@ -73,7 +72,7 @@ abstract class ArcanistXHPASTLintNamingHook extends Phobject {
/**
* Returns true if a symbol name is lowerCamelCase.
*
* @param string $symbol Symbol name.
* @param string Symbol name.
* @return bool True if the symbol is lowerCamelCase.
* @task util
*/
@ -84,7 +83,7 @@ abstract class ArcanistXHPASTLintNamingHook extends Phobject {
/**
* Returns true if a symbol name is UPPERCASE_WITH_UNDERSCORES.
*
* @param string $symbol Symbol name.
* @param string Symbol name.
* @return bool True if the symbol is UPPERCASE_WITH_UNDERSCORES.
* @task util
*/
@ -95,7 +94,7 @@ abstract class ArcanistXHPASTLintNamingHook extends Phobject {
/**
* Returns true if a symbol name is lowercase_with_underscores.
*
* @param string $symbol Symbol name.
* @param string Symbol name.
* @return bool True if the symbol is lowercase_with_underscores.
* @task util
*/
@ -108,7 +107,7 @@ abstract class ArcanistXHPASTLintNamingHook extends Phobject {
* the "__" magic-method signifier, to make a symbol appropriate for testing
* with methods like @{method:isLowerCamelCase}.
*
* @param string $symbol Symbol name.
* @param string Symbol name.
* @return string Stripped symbol.
* @task util
*/
@ -143,7 +142,7 @@ abstract class ArcanistXHPASTLintNamingHook extends Phobject {
* the "$", to make a symbol appropriate for testing with methods like
* @{method:isLowercaseWithUnderscores}.
*
* @param string $symbol Symbol name.
* @param string Symbol name.
* @return string Stripped symbol.
* @task util
*/

12
src/lint/linter/xhpast/ArcanistXHPASTLinterRule.php
View file

@ -144,7 +144,7 @@ abstract class ArcanistXHPASTLinterRule extends Phobject {
*
* TODO: Improve this and move it to XHPAST proper?
*
* @param string $string The "semantic string" of a single value.
* @param string The "semantic string" of a single value.
* @return mixed `true` or `false` if the value could be evaluated
* statically; `null` if static evaluation was not possible.
*/
@ -168,7 +168,7 @@ abstract class ArcanistXHPASTLinterRule extends Phobject {
* Returns all descendant nodes which represent an anonymous function
* declaration.
*
* @param XHPASTNode $root Root node.
* @param XHPASTNode Root node.
* @return AASTNodeList
*/
protected function getAnonymousClosures(XHPASTNode $root) {
@ -187,7 +187,7 @@ abstract class ArcanistXHPASTLinterRule extends Phobject {
/**
* TODO
*
* @param XHPASTNode $variable
* @param XHPASTNode
* @return string
*/
protected function getConcreteVariableString(XHPASTNode $variable) {
@ -205,8 +205,8 @@ abstract class ArcanistXHPASTLinterRule extends Phobject {
* Returns all descendant nodes which represent a function call to one of the
* specified functions.
*
* @param XHPASTNode $root Root node.
* @param list<string> $function_names Function names.
* @param XHPASTNode Root node.
* @param list<string> Function names.
* @return AASTNodeList
*/
protected function getFunctionCalls(XHPASTNode $root, array $function_names) {
@ -228,7 +228,7 @@ abstract class ArcanistXHPASTLinterRule extends Phobject {
/**
* Get class/method modifiers.
*
* @param XHPASTNode $node A node of type `n_CLASS_DECLARATION` or
* @param XHPASTNode A node of type `n_CLASS_DECLARATION` or
* `n_METHOD_DECLARATION`.
* @return map<string, bool> Class/method modifiers.
*/

22
src/moduleutils/PhutilLibraryMapBuilder.php
View file

@ -29,7 +29,7 @@ final class PhutilLibraryMapBuilder extends Phobject {
/**
* Create a new map builder for a library.
*
* @param string $root Path to the library root.
* @param string Path to the library root.
*
* @task map
*/
@ -40,8 +40,8 @@ final class PhutilLibraryMapBuilder extends Phobject {
/**
* Control subprocess parallelism limit. Use `--limit` to set this.
*
* @param int $limit Maximum number of subprocesses to run in parallel.
* @return $this
* @param int Maximum number of subprocesses to run in parallel.
* @return this
*
* @task map
*/
@ -103,8 +103,8 @@ final class PhutilLibraryMapBuilder extends Phobject {
/**
* Get the path to some file in the library.
*
* @param string $path (optional) A library-relative path. If omitted,
* returns the library root path.
* @param string A library-relative path. If omitted, returns the library
* root path.
* @return string An absolute path.
*
* @task path
@ -188,8 +188,8 @@ final class PhutilLibraryMapBuilder extends Phobject {
/**
* Write a symbol map to disk cache.
*
* @param dict $symbol_map Symbol map of relative paths to symbols.
* @param dict $source_map Source map (like @{method:loadSourceFileMap}).
* @param dict Symbol map of relative paths to symbols.
* @param dict Source map (like @{method:loadSourceFileMap}).
* @return void
*
* @task symbol
@ -212,7 +212,7 @@ final class PhutilLibraryMapBuilder extends Phobject {
/**
* Drop the symbol cache, forcing a clean rebuild.
*
* @return void
* @return this
*
* @task symbol
*/
@ -224,7 +224,7 @@ final class PhutilLibraryMapBuilder extends Phobject {
* Build a future which returns a `extract-symbols.php` analysis of a source
* file.
*
* @param string $file Relative path to the source file to analyze.
* @param string Relative path to the source file to analyze.
* @return Future Analysis future.
*
* @task symbol
@ -321,7 +321,7 @@ final class PhutilLibraryMapBuilder extends Phobject {
* Convert the symbol analysis of all the source files in the library into
* a library map.
*
* @param dict $symbol_map Symbol analysis of all source files.
* @param dict Symbol analysis of all source files.
* @return dict Library map.
* @task source
*/
@ -381,7 +381,7 @@ final class PhutilLibraryMapBuilder extends Phobject {
/**
* Write a finalized library map.
*
* @param dict $library_map Library map structure to write.
* @param dict Library map structure to write.
* @return void
*
* @task source

5
src/object/Phobject.php
View file

@ -73,9 +73,8 @@ abstract class Phobject implements Iterator {
* useful message if the constant is not defined and allows the constant to
* be limited to a maximum length.
*
* @param string $key Name of the constant.
* @param int|null $byte_limit (optional) Maximum number of bytes permitted
* in the value.
* @param string Name of the constant.
* @param int|null Maximum number of bytes permitted in the value.
* @return string Value of the constant.
*/
public function getPhobjectClassConstant($key, $byte_limit = null) {

4
src/parser/ArcanistDiffParser.php
View file

@ -1329,8 +1329,8 @@ final class ArcanistDiffParser extends Phobject {
* return an incorrect value. Such cases are expected to be
* recovered by later rename detection codepaths.
*
* @param string $paths Text from a diff line after "diff --git ".
* @return string|null Filename being altered, or null for a rename.
* @param string Text from a diff line after "diff --git ".
* @return string Filename being altered, or null for a rename.
*/
public static function extractGitCommonFilename($paths) {
$matches = null;

8
src/parser/PhutilEditorConfig.php
View file

@ -41,7 +41,7 @@ final class PhutilEditorConfig extends Phobject {
/**
* Constructor.
*
* @param string $root The root directory.
* @param string The root directory.
*/
public function __construct($root) {
$this->root = $root;
@ -50,8 +50,8 @@ final class PhutilEditorConfig extends Phobject {
/**
* Get the specified EditorConfig property for the specified path.
*
* @param string $path
* @param string $key
* @param string
* @param string
* @return wild
*/
public function getProperty($path, $key) {
@ -100,7 +100,7 @@ final class PhutilEditorConfig extends Phobject {
* the future).
* - Invalid glob patterns will be silently ignored.
*
* @param string $path
* @param string
* @return map<string, wild>
*/
public function getProperties($path) {

23
src/parser/PhutilJSON.php
View file

@ -16,7 +16,7 @@ final class PhutilJSON extends Phobject {
* Encode an object in JSON and pretty-print it. This generates a valid JSON
* object with human-readable whitespace and indentation.
*
* @param dict $object An object to encode in JSON.
* @param dict An object to encode in JSON.
* @return string Pretty-printed object representation.
*/
public function encodeFormatted($object) {
@ -27,7 +27,7 @@ final class PhutilJSON extends Phobject {
/**
* Encode a list in JSON and pretty-print it, discarding keys.
*
* @param list<wild> $list List to encode in JSON.
* @param list<wild> List to encode in JSON.
* @return string Pretty-printed list representation.
*/
public function encodeAsList(array $list) {
@ -41,8 +41,8 @@ final class PhutilJSON extends Phobject {
/**
* Pretty-print a JSON object.
*
* @param dict $object Object to format.
* @param int $depth Current depth, for indentation.
* @param dict Object to format.
* @param int Current depth, for indentation.
* @return string Pretty-printed value.
* @task internal
*/
@ -51,7 +51,7 @@ final class PhutilJSON extends Phobject {
$object = (array)$object;
}
if (empty($object) || !is_iterable($object)) {
if (empty($object)) {
return '{}';
}
@ -84,8 +84,8 @@ final class PhutilJSON extends Phobject {
/**
* Pretty-print a JSON list.
*
* @param list $array List to format.
* @param int $depth Current depth, for indentation.
* @param list List to format.
* @param int Current depth, for indentation.
* @return string Pretty-printed value.
* @task internal
*/
@ -115,8 +115,8 @@ final class PhutilJSON extends Phobject {
/**
* Pretty-print a JSON value.
*
* @param dict $value Value to format.
* @param int $depth Current depth, for indentation.
* @param dict Value to format.
* @param int Current depth, for indentation.
* @return string Pretty-printed value.
* @task internal
*/
@ -131,8 +131,7 @@ final class PhutilJSON extends Phobject {
return $this->encodeFormattedObject($value, $depth);
} else {
if (defined('JSON_UNESCAPED_SLASHES')) {
// If we have PHP >= 5.4.0 && the JSON extension is installed (as of
// PHP 8.0.0, it is a core PHP extension), disable escaping of slashes
// If we have a new enough version of PHP, disable escaping of slashes
// when pretty-printing values. Escaping slashes can defuse an attack
// where the attacker embeds "</script>" inside a JSON string, but that
// isn't relevant when rendering JSON for human viewers.
@ -147,7 +146,7 @@ final class PhutilJSON extends Phobject {
/**
* Render a string corresponding to the current indent depth.
*
* @param int $depth Current depth.
* @param int Current depth.
* @return string Indentation.
* @task internal
*/

2
src/parser/PhutilLanguageGuesser.php
View file

@ -9,7 +9,7 @@ final class PhutilLanguageGuesser extends Phobject {
/**
* Guess which computer programming language a file is written in.
*
* @param string $source Source text of the file.
* @param string Source text of the file.
* @return mixed Language string, or null if unable to guess.
*/
public static function guessLanguage($source) {

6
src/parser/PhutilQueryStringParser.php
View file

@ -33,7 +33,7 @@ final class PhutilQueryStringParser extends Phobject {
*
* For a more basic parse, see @{method:parseQueryStringToPairList}.
*
* @param string $query_string Query string.
* @param string Query string.
* @return map<string, wild> Parsed dictionary.
*/
public function parseQueryString($query_string) {
@ -68,7 +68,7 @@ final class PhutilQueryStringParser extends Phobject {
* Use @{method:parseQueryString} to produce a more sophisticated parse which
* applies array rules and returns a dictionary.
*
* @param string $query_string Query string.
* @param string Query string.
* @return list<pair<string, string>> List of parsed parameters.
*/
public function parseQueryStringToPairList($query_string) {
@ -110,7 +110,7 @@ final class PhutilQueryStringParser extends Phobject {
*
* @param string $key
* @param string $val
* @param array &$input_arr
* @param array $input_arr
*/
private function parseQueryKeyToArr($key, $val, array &$input_arr) {
if (preg_match('/^[^\[\]]+(?:\[[^\[\]]*\])+$/', $key)) {

12
src/parser/PhutilSimpleOptions.php
View file

@ -31,7 +31,7 @@ final class PhutilSimpleOptions extends Phobject {
* 'eyes' => '2',
* );
*
* @param string $input Input option list.
* @param string Input option list.
* @return dict Parsed dictionary.
* @task parse
*/
@ -130,8 +130,8 @@ final class PhutilSimpleOptions extends Phobject {
*
* legs=4, eyes=2
*
* @param dict $options Input dictionary.
* @param string $escape (optional) Additional characters to escape.
* @param dict Input dictionary.
* @param string Additional characters to escape.
* @return string Unparsed option list.
*/
public function unparse(array $options, $escape = '') {
@ -161,9 +161,9 @@ final class PhutilSimpleOptions extends Phobject {
* case insensitive, so "legs=4" has the same meaning as "LEGS=4". If you
* set it to be case sensitive, the keys have different meanings.
*
* @param bool $case_sensitive True to make the parser case sensitive, false
* to make it case-insensitive.
* @return $this
* @param bool True to make the parser case sensitive, false (default) to
* make it case-insensitive.
* @return this
* @task config
*/
public function setCaseSensitive($case_sensitive) {

2
src/parser/PhutilTypeSpec.php
View file

@ -336,6 +336,7 @@ final class PhutilTypeSpec extends Phobject {
$obj->subtypes[] = $r;
return $obj;
}
break;
case 'map_type':
$obj = new PhutilTypeSpec();
$obj->type = 'map';
@ -354,6 +355,7 @@ final class PhutilTypeSpec extends Phobject {
} else {
return $tokens[0];
}
break;
case 'maybe_comment':
if ($production == 'yes') {
$tokens[0]->comment = $tokens[1];

4
src/parser/__tests__/ArcanistBundleTestCase.php
View file

@ -11,10 +11,8 @@ final class ArcanistBundleTestCase extends PhutilTestCase {
}
private function loadDiff($old, $new) {
// This unit test must parse 'diff' output in a language independent way,
// so we need LC_ALL=C.
list($err, $stdout) = exec_manual(
'LC_ALL=C diff --unified=65535 --label %s --label %s -- %s %s',
'diff --unified=65535 --label %s --label %s -- %s %s',
'file 9999-99-99',
'file 9999-99-99',
$this->getResourcePath($old),

1
src/parser/__tests__/ArcanistDiffParserTestCase.php
View file

@ -610,6 +610,7 @@ EOTEXT
break;
default:
throw new Exception(pht('No test block for diff file %s.', $diff_file));
break;
}
}

12
src/parser/aast/api/AASTNode.php
View file

@ -42,7 +42,7 @@ abstract class AASTNode extends Phobject {
return $this->parentNode;
}
final public function setParentNode(?AASTNode $node = null) {
final public function setParentNode(AASTNode $node = null) {
$this->parentNode = $node;
return $this;
}
@ -51,7 +51,7 @@ abstract class AASTNode extends Phobject {
return $this->previousSibling;
}
final public function setPreviousSibling(?AASTNode $node = null) {
final public function setPreviousSibling(AASTNode $node = null) {
$this->previousSibling = $node;
return $this;
}
@ -60,7 +60,7 @@ abstract class AASTNode extends Phobject {
return $this->nextSibling;
}
final public function setNextSibling(?AASTNode $node = null) {
final public function setNextSibling(AASTNode $node = null) {
$this->nextSibling = $node;
return $this;
}
@ -363,7 +363,7 @@ abstract class AASTNode extends Phobject {
* Determines whether the current node appears //after// a specified node in
* the tree.
*
* @param AASTNode $node
* @param AASTNode
* @return bool
*/
final public function isAfter(AASTNode $node) {
@ -375,7 +375,7 @@ abstract class AASTNode extends Phobject {
* Determines whether the current node appears //before// a specified node in
* the tree.
*
* @param AASTNode $node
* @param AASTNode
* @return bool
*/
final public function isBefore(AASTNode $node) {
@ -386,7 +386,7 @@ abstract class AASTNode extends Phobject {
/**
* Determines whether a specified node is a descendant of the current node.
*
* @param AASTNode $node
* @param AASTNode
* @return bool
*/
final public function containsDescendant(AASTNode $node) {

29
src/parser/argument/PhutilArgumentParser.php
View file

@ -95,7 +95,7 @@ final class PhutilArgumentParser extends Phobject {
*
* $args = new PhutilArgumentParser($argv);
*
* @param list $argv Argument vector to parse, generally the $argv global.
* @param list Argument vector to parse, generally the $argv global.
* @task parse
*/
public function __construct(array $argv) {
@ -111,11 +111,10 @@ final class PhutilArgumentParser extends Phobject {
* @{method:getUnconsumedArgumentVector}. Doing a partial parse can make it
* easier to share common flags across scripts or workflows.
*
* @param list $specs List of argument specs, see
* @param list List of argument specs, see
* @{class:PhutilArgumentSpecification}.
* @param bool $initial_only (optional) Require flags appear before any
* non-flag arguments.
* @return $this
* @param bool Require flags appear before any non-flag arguments.
* @return this
* @task parse
*/
public function parsePartial(array $specs, $initial_only = false) {
@ -123,7 +122,7 @@ final class PhutilArgumentParser extends Phobject {
}
/**
* @return $this
* @return this
*/
private function parseInternal(
array $specs,
@ -311,9 +310,9 @@ final class PhutilArgumentParser extends Phobject {
* user-friendly error. You can also use @{method:printUsageException} to
* render the exception in a user-friendly way.
*
* @param list $specs List of argument specs, see
* @param list List of argument specs, see
* @{class:PhutilArgumentSpecification}.
* @return $this
* @return this
* @task parse
*/
public function parseFull(array $specs) {
@ -347,9 +346,9 @@ final class PhutilArgumentParser extends Phobject {
* Parse and consume a list of arguments, raising a user-friendly error if
* anything remains. See also @{method:parseFull} and @{method:parsePartial}.
*
* @param list $specs List of argument specs, see
* @param list List of argument specs, see
* @{class:PhutilArgumentSpecification}.
* @return $this
* @return this
* @task parse
*/
public function parse(array $specs) {
@ -368,9 +367,9 @@ final class PhutilArgumentParser extends Phobject {
*
* See @{class:PhutilArgumentWorkflow} for details on using workflows.
*
* @param list $workflows List of argument specs, see
* @param list List of argument specs, see
* @{class:PhutilArgumentSpecification}.
* @return $this
* @return this
* @task parse
*/
public function parseWorkflows(array $workflows) {
@ -392,7 +391,7 @@ final class PhutilArgumentParser extends Phobject {
*
* See @{class:PhutilArgumentWorkflow} for details on using workflows.
*
* @param list $workflows List of @{class:PhutilArgumentWorkflow}s.
* @param list List of @{class:PhutilArgumentWorkflow}s.
* @return PhutilArgumentWorkflow|no Returns the chosen workflow if it is
* not executable, or executes it and
* exits with a return code if it is.
@ -491,7 +490,7 @@ final class PhutilArgumentParser extends Phobject {
if ($workflow->isExecutable()) {
$workflow->setArgv($this);
$err = $workflow->execute($this);
exit($err ?? 0);
exit($err);
} else {
return $workflow;
}
@ -506,7 +505,7 @@ final class PhutilArgumentParser extends Phobject {
* --xprofile <file> Write out an XHProf profile.
* --help Show help.
*
* @return $this
* @return this
*
* @phutil-external-symbol function xhprof_enable
*/

2
src/parser/argument/PhutilArgumentSpecification.php
View file

@ -34,7 +34,7 @@ final class PhutilArgumentSpecification extends Phobject {
* wildcard setWildcard()
* repeat setRepeatable()
*
* @param dict $spec Dictionary of quick parameter definitions.
* @param dict Dictionary of quick parameter definitions.
* @return PhutilArgumentSpecification Constructed argument specification.
*/
public static function newQuickSpec(array $spec) {

2
src/parser/xhpast/__tests__/PHPASTParserTestCase.php
View file

@ -82,7 +82,7 @@ final class PHPASTParserTestCase extends PhutilTestCase {
case 'pass':
$this->assertEqual(0, $err, pht('Exit code for "%s".', $name));
if (!phutil_nonempty_string($expect)) {
if (!strlen($expect)) {
// If there's no "expect" data in the test case, that's OK.
break;
}

8
src/parser/xhpast/api/XHPASTNode.php
View file

@ -31,6 +31,7 @@ final class XHPASTNode extends AASTNode {
switch ($this->getTypeName()) {
case 'n_STATEMENT':
return $this->getChildByIndex(0)->evalStatic();
break;
case 'n_STRING_SCALAR':
return phutil_string_cast($this->getStringLiteralValue());
case 'n_HEREDOC':
@ -60,18 +61,22 @@ final class XHPASTNode extends AASTNode {
default:
throw new Exception(pht('Unrecognized symbol name.'));
}
break;
case 'n_UNARY_PREFIX_EXPRESSION':
$operator = $this->getChildOfType(0, 'n_OPERATOR');
$operand = $this->getChildByIndex(1);
switch ($operator->getSemanticString()) {
case '-':
return -$operand->evalStatic();
break;
case '+':
return $operand->evalStatic();
break;
default:
throw new Exception(
pht('Unexpected operator in static expression.'));
}
break;
case 'n_ARRAY_LITERAL':
$result = array();
$values = $this->getChildOfType(0, 'n_ARRAY_VALUE_LIST');
@ -235,7 +240,7 @@ final class XHPASTNode extends AASTNode {
switch ($c) {
case 'x':
$u = isset($value[$ii + 1]) ? $value[$ii + 1] : null;
if ($u === null || !preg_match('/^[a-f0-9]/i', $u)) {
if (!preg_match('/^[a-f0-9]/i', $u)) {
// PHP treats \x followed by anything which is not a hex digit
// as a literal \x.
$out .= '\\\\'.$c;
@ -287,6 +292,7 @@ final class XHPASTNode extends AASTNode {
* To prevent any possible ambiguity, the returned namespace will always be
* prefixed with the namespace separator.
*
* @param XHPASTNode The input node.
* @return string|null The namespace which contains the input node, or
* `null` if no such node exists.
*/

2
src/parser/xhpast/api/__tests__/XHPASTNodeTestCase.php
View file

@ -73,7 +73,7 @@ final class XHPASTNodeTestCase extends PhutilTestCase {
* }
* ```
*
* @param string $file The path to the test file.
* @param string The path to the test file.
* @return pair<XHPASTTree, map> The first element of the pair is the
* `XHPASTTree` contained within the test file.
* The second element of the pair is the

2
src/parser/xhpast/bin/PhutilXHPASTBinary.php
View file

@ -71,7 +71,7 @@ final class PhutilXHPASTBinary extends Phobject {
/**
* Constructs an @{class:ExecFuture} for XHPAST.
*
* @param wild $data Data to pass to the future.
* @param wild Data to pass to the future.
* @return ExecFuture
*/
public static function getParserFuture($data) {

2
src/phage/bootloader/PhagePHPAgentBootloader.php
View file

@ -89,7 +89,7 @@ final class PhagePHPAgentBootloader extends PhageAgentBootloader {
$boot_length = strlen($boot_sequence->toString());
$boot_sequence->addText($main_sequence->toString());
if ($boot_length > 8192) {
if (strlen($boot_length) > 8192) {
throw new Exception(pht('Stage 1 bootloader is too large!'));
}

11
src/progress/PhutilConsoleProgressSink.php
View file

@ -5,6 +5,7 @@ final class PhutilConsoleProgressSink
private $lastUpdate;
private $isTTY;
private $width;
private $lineWidth;
protected function publishProgress() {
@ -81,6 +82,16 @@ final class PhutilConsoleProgressSink
return $this->isTTY;
}
private function getWidth() {
if ($this->width === null) {
$width = phutil_console_get_terminal_width();
$width = min(nonempty($width, 78), 78);
$this->width = $width;
}
return $this->width;
}
private function overwriteLine($line) {
$head = "\r";
$tail = '';

29
src/readableserializer/PhutilReadableSerializer.php
View file

@ -19,7 +19,7 @@ final class PhutilReadableSerializer extends Phobject {
* representation of the value; use @{method:printShort} or
* @{method:printShallow} to summarize values.
*
* @param wild $value Any value.
* @param wild Any value.
* @return string Human-readable representation of the value.
* @task print
*/
@ -43,7 +43,7 @@ final class PhutilReadableSerializer extends Phobject {
/**
* Print a concise, human readable representation of a value.
*
* @param wild $value Any value.
* @param wild Any value.
* @return string Human-readable short representation of the value.
* @task print
*/
@ -86,11 +86,9 @@ final class PhutilReadableSerializer extends Phobject {
*
* To print any number of member variables, pass null for `$max_members`.
*
* @param wild $value Any value.
* @param int $max_depth (optional) Maximum depth to print for nested arrays
* and objects. Defaults to 2.
* @param int $max_members (optional) Maximum number of values to print at
* each level. Defaults to 25.
* @param wild Any value.
* @param int Maximum depth to print for nested arrays and objects.
* @param int Maximum number of values to print at each level.
* @return string Human-readable shallow representation of the value.
* @task print
*/
@ -109,12 +107,11 @@ final class PhutilReadableSerializer extends Phobject {
/**
* Implementation for @{method:printShallow}.
*
* @param wild $value Any value.
* @param int $max_depth Maximum depth to print for nested arrays and
* objects.
* @param int $max_members Maximum number of values to print at each level.
* @param int $depth Current depth.
* @param string $indent Indentation string.
* @param wild Any value.
* @param int Maximum depth to print for nested arrays and objects.
* @param int Maximum number of values to print at each level.
* @param int Current depth.
* @param string Indentation string.
* @return string Human-readable shallow representation of the value.
* @task internal
*/
@ -173,9 +170,9 @@ final class PhutilReadableSerializer extends Phobject {
* Adds indentation to the beginning of every line starting from
* `$first_line`.
*
* @param string $value Printed value.
* @param string $indent String to indent with.
* @param int $first_line Index of first line to indent.
* @param string Printed value.
* @param string String to indent with.
* @param int Index of first line to indent.
* @return string
* @task internal
*/

22
src/repository/api/ArcanistGitAPI.php
View file

@ -82,8 +82,8 @@ final class ArcanistGitAPI extends ArcanistRepositoryAPI {
/**
* Tests if a child commit is descendant of a parent commit.
* If child and parent are the same, it returns false.
* @param $child Child commit SHA.
* @param $parent Parent commit SHA.
* @param Child commit SHA.
* @param Parent commit SHA.
* @return bool True if the child is a descendant of the parent.
*/
private function isDescendant($child, $parent) {
@ -404,7 +404,7 @@ final class ArcanistGitAPI extends ArcanistRepositoryAPI {
/**
* Translates a symbolic commit (like "HEAD^") to a commit identifier.
* @param string_symbol $symbolic_commit commit.
* @param string_symbol commit.
* @return string the commit SHA.
*/
private function resolveCommit($symbolic_commit) {
@ -457,9 +457,9 @@ final class ArcanistGitAPI extends ArcanistRepositoryAPI {
}
/**
* @param $base the base revision
* @param $head (optional) head revision. If this is null, the generated diff
* will include the working copy
* @param the base revision
* @param head revision. If this is null, the generated diff will include the
* working copy
*/
public function getFullGitDiff($base, $head = null) {
$options = $this->getDiffFullOptions();
@ -491,10 +491,10 @@ final class ArcanistGitAPI extends ArcanistRepositoryAPI {
}
/**
* @param string $path Path to generate a diff for.
* @param bool $detect_moves_and_renames (optional) If true, detect moves
* and renames. Otherwise, ignore moves/renames; this is useful
* because it prompts git to generate real diff text.
* @param string Path to generate a diff for.
* @param bool If true, detect moves and renames. Otherwise, ignore
* moves/renames; this is useful because it prompts git to
* generate real diff text.
*/
public function getRawDiffText($path, $detect_moves_and_renames = true) {
$options = $this->getDiffFullOptions($detect_moves_and_renames);
@ -1452,7 +1452,7 @@ final class ArcanistGitAPI extends ArcanistRepositoryAPI {
* Follow the chain of tracking branches upstream until we reach a remote
* or cycle locally.
*
* @param string $start Ref to start from.
* @param string Ref to start from.
* @return ArcanistGitUpstreamPath Path to an upstream.
*/
public function getPathToUpstream($start) {

15
src/repository/api/ArcanistMercurialAPI.php
View file

@ -732,9 +732,8 @@ final class ArcanistMercurialAPI extends ArcanistRepositoryAPI {
* cause a conflict but this is something the user has to address.
* 3. Strip the original commit.
*
* @param array $child_nodes The list of child changesets off the original
* commit.
* @param file $tmp_file The file containing the new commit message.
* @param array The list of child changesets off the original commit.
* @param file The file containing the new commit message.
*/
private function amendNonHeadCommit($child_nodes, $tmp_file) {
list($current) = $this->execxLocal(
@ -1054,7 +1053,7 @@ final class ArcanistMercurialAPI extends ArcanistRepositoryAPI {
* included with Arcanist. This will not enable other extensions, e.g.
* "evolve".
*
* @param string $extension The name of the extension to enable.
* @param string The name of the extension to enable.
* @return string A new command pattern that includes the necessary flags to
* enable the specified extension.
*/
@ -1087,10 +1086,10 @@ final class ArcanistMercurialAPI extends ArcanistRepositoryAPI {
* Produces the arguments that should be passed to Mercurial command
* execution that enables a desired extension.
*
* @param string $extension The name of the extension to enable.
* @param string $pattern The command pattern that will be run with the
* extension enabled.
* @param array ... Parameters for the command pattern argument.
* @param string The name of the extension to enable.
* @param string The command pattern that will be run with the extension
* enabled.
* @param array Parameters for the command pattern argument.
* @return array An array where the first item is a Mercurial command
* pattern that includes the necessary flag for enabling the
* desired extension, and all remaining items are parameters

14
src/repository/api/ArcanistRepositoryAPI.php
View file

@ -269,7 +269,7 @@ abstract class ArcanistRepositoryAPI extends Phobject {
* Drops caches after changes to the working copy. By default, some queries
* against the working copy are cached. They
*
* @return $this
* @return this
* @task status
*/
final public function reloadWorkingCopy() {
@ -429,7 +429,7 @@ abstract class ArcanistRepositoryAPI extends Phobject {
/**
* Try to read a scratch file, if it exists and is readable.
*
* @param string $path Scratch file name.
* @param string Scratch file name.
* @return mixed String for file contents, or false for failure.
* @task scratch
*/
@ -457,8 +457,8 @@ abstract class ArcanistRepositoryAPI extends Phobject {
* Try to write a scratch file, if there's somewhere to put it and we can
* write there.
*
* @param string $path Scratch file name to write.
* @param string $data Data to write.
* @param string Scratch file name to write.
* @param string Data to write.
* @return bool True on success, false on failure.
* @task scratch
*/
@ -489,7 +489,7 @@ abstract class ArcanistRepositoryAPI extends Phobject {
/**
* Try to remove a scratch file.
*
* @param string $path Scratch file name to remove.
* @param string Scratch file name to remove.
* @return bool True if the file was removed successfully.
* @task scratch
*/
@ -512,7 +512,7 @@ abstract class ArcanistRepositoryAPI extends Phobject {
/**
* Get a human-readable description of the scratch file location.
*
* @param string $path Scratch file name.
* @param string Scratch file name.
* @return mixed String, or false on failure.
* @task scratch
*/
@ -531,7 +531,7 @@ abstract class ArcanistRepositoryAPI extends Phobject {
/**
* Get the path to a scratch file, if possible.
*
* @param string $path Scratch file name.
* @param string Scratch file name.
* @return mixed File path, or false on failure.
* @task scratch
*/

6
src/repository/api/ArcanistSubversionAPI.php
View file

@ -40,12 +40,6 @@ final class ArcanistSubversionAPI extends ArcanistRepositoryAPI {
$argv[0] = 'svn '.$argv[0];
$future = newv('ExecFuture', $argv);
// For historical reasons we run Subversion commands keeping env.
// But, let's keep English, to have a reliable parser.
// https://we.phorge.it/T15872
$future->updateEnv('LC_ALL', 'C');
$future->setCWD($this->getPath());
return $future;
}

2
src/repository/marker/ArcanistMarkerRef.php
View file

@ -174,7 +174,7 @@ final class ArcanistMarkerRef
return $this->getHardpoint(self::HARDPOINT_WORKINGCOPYSTATEREF);
}
public function attachRemoteRef(?ArcanistRemoteRef $ref = null) {
public function attachRemoteRef(ArcanistRemoteRef $ref = null) {
return $this->attachHardpoint(self::HARDPOINT_REMOTEREF, $ref);
}

4
src/repository/marker/ArcanistMercurialRepositoryMarkerQuery.php
View file

@ -7,11 +7,11 @@ final class ArcanistMercurialRepositoryMarkerQuery
return $this->newMarkers();
}
protected function newRemoteRefMarkers(?ArcanistRemoteRef $remote = null) {
protected function newRemoteRefMarkers(ArcanistRemoteRef $remote = null) {
return $this->newMarkers($remote);
}
private function newMarkers(?ArcanistRemoteRef $remote = null) {
private function newMarkers(ArcanistRemoteRef $remote = null) {
$api = $this->getRepositoryAPI();
// In native Mercurial it is difficult to identify remote markers, and

8
src/repository/parser/ArcanistMercurialParser.php
View file

@ -17,7 +17,7 @@ final class ArcanistMercurialParser extends Phobject {
* can get less detailed information with @{method:parseMercurialStatus}. In
* particular, this will parse copy sources as per "hg status -C".
*
* @param string $stdout The stdout from running an "hg status" command.
* @param string The stdout from running an "hg status" command.
* @return dict Map of paths to status dictionaries.
* @task parse
*/
@ -96,7 +96,7 @@ final class ArcanistMercurialParser extends Phobject {
* can get more detailed information by invoking
* @{method:parseMercurialStatusDetails}.
*
* @param string $stdout The stdout from running an "hg status" command.
* @param string The stdout from running an "hg status" command.
* @return dict Map of paths to ArcanistRepositoryAPI status flags.
* @task parse
*/
@ -110,7 +110,7 @@ final class ArcanistMercurialParser extends Phobject {
* Parse the output of "hg log". This also parses "hg outgoing", "hg parents",
* and other similar commands. This assumes "--style default".
*
* @param string $stdout The stdout from running an "hg log" command.
* @param string The stdout from running an "hg log" command.
* @return list List of dictionaries with commit information.
* @task parse
*/
@ -194,7 +194,7 @@ final class ArcanistMercurialParser extends Phobject {
/**
* Parse the output of "hg branches".
*
* @param string $stdout The stdout from running an "hg branches" command.
* @param string The stdout from running an "hg branches" command.
* @return list A list of dictionaries with branch information.
* @task parse
*/

4
src/repository/state/ArcanistGitLocalState.php
View file

@ -159,4 +159,8 @@ final class ArcanistGitLocalState
$api->execxLocal('stash drop');
}
private function getDisplayStashRef($stash_ref) {
return substr($stash_ref, 0, 12);
}
}

2
src/repository/state/ArcanistRepositoryLocalState.php
View file

@ -211,7 +211,7 @@ abstract class ArcanistRepositoryLocalState
/**
* Restores changes that were previously stashed by {@method:saveStash()}.
*
* @param wild $ref A reference object referring to which previously stashed
* @param wild A reference object referring to which previously stashed
* changes to restore, from invoking {@method:saveStash()}.
*/
protected function restoreStash($ref) {

24
src/symbols/PhutilClassMapQuery.php
View file

@ -60,8 +60,8 @@ final class PhutilClassMapQuery extends Phobject {
* Set the ancestor class or interface name to load the concrete descendants
* of.
*
* @param string $class Ancestor class or interface name.
* @return $this
* @param string Ancestor class or interface name.
* @return this
* @task config
*/
public function setAncestorClass($class) {
@ -79,10 +79,10 @@ final class PhutilClassMapQuery extends Phobject {
*
* You must provide a method here to use @{method:setExpandMethod}.
*
* @param string $unique_method Name of the unique key method.
* @param bool $filter_null (optional) If true, then classes which return
* `null` will be filtered from the results.
* @return $this
* @param string Name of the unique key method.
* @param bool If true, then classes which return `null` will be filtered
* from the results.
* @return this
* @task config
*/
public function setUniqueMethod($unique_method, $filter_null = false) {
@ -125,8 +125,8 @@ final class PhutilClassMapQuery extends Phobject {
* If a class map uses this pattern, it must also provide a unique key for
* each instance with @{method:setUniqueMethod}.
*
* @param string $expand_method Name of the expansion method.
* @return $this
* @param string Name of the expansion method.
* @return this
* @task config
*/
public function setExpandMethod($expand_method) {
@ -141,8 +141,8 @@ final class PhutilClassMapQuery extends Phobject {
* The map will be sorted using @{function:msort} and passing this method
* name.
*
* @param string $sort_method Name of the sorting method.
* @return $this
* @param string Name of the sorting method.
* @return this
* @task config
*/
public function setSortMethod($sort_method) {
@ -154,8 +154,8 @@ final class PhutilClassMapQuery extends Phobject {
/**
* Provide a method to filter the map.
*
* @param string $filter_method Name of the filtering method.
* @return $this
* @param string Name of the filtering method.
* @return this
* @task config
*/
public function setFilterMethod($filter_method) {

Some files were not shown because too many files have changed in this diff Show more