/**
* Create a new block with specified parameters on a user, IP or IP range.
*
- * @param array $options Parameters of the block:
- * address string|User Target user name, User object, IP address or IP range
- * by int User ID of the blocker
- * reason string Reason of the block
- * timestamp string The time at which the block comes into effect
- * byText string Username of the blocker (for foreign users)
- * hideName bool Hide the target user name
+ * @param array $options Parameters of the block, with supported options:
+ * - address: (string|User) Target user name, User object, IP address or IP range
+ * - by: (int) User ID of the blocker
+ * - reason: (string) Reason of the block
+ * - timestamp: (string) The time at which the block comes into effect
+ * - byText: (string) Username of the blocker (for foreign users)
+ * - hideName: (bool) Hide the target user name
*/
public function __construct( array $options = [] ) {
$defaults = [
/**
* Create a new block with specified parameters on a user, IP or IP range.
*
- * @param array $options Parameters of the block:
- * originalBlocks Block[] Blocks that this block is composed from
+ * @param array $options Parameters of the block, with options supported by
+ * `AbstractBlock::__construct`, and also:
+ * - originalBlocks: (Block[]) Blocks that this block is composed from
*/
public function __construct( array $options = [] ) {
parent::__construct( $options );
/**
* Create a new block with specified option parameters on a user, IP or IP range.
*
- * @param array $options Parameters of the block:
- * user int Override target user ID (for foreign users)
- * auto bool Is this an automatic block?
- * expiry string Timestamp of expiration of the block or 'infinity'
- * anonOnly bool Only disallow anonymous actions
- * createAccount bool Disallow creation of new accounts
- * enableAutoblock bool Enable automatic blocking
- * blockEmail bool Disallow sending emails
- * allowUsertalk bool Allow the target to edit its own talk page
- * sitewide bool Disallow editing all pages and all contribution
- * actions, except those specifically allowed by
- * other block flags
+ * @param array $options Parameters of the block, with options supported by
+ * `AbstractBlock::__construct`, and also:
+ * - user: (int) Override target user ID (for foreign users)
+ * - auto: (bool) Is this an automatic block?
+ * - expiry: (string) Timestamp of expiration of the block or 'infinity'
+ * - anonOnly: (bool) Only disallow anonymous actions
+ * - createAccount: (bool) Disallow creation of new accounts
+ * - enableAutoblock: (bool) Enable automatic blocking
+ * - blockEmail: (bool) Disallow sending emails
+ * - allowUsertalk: (bool) Allow the target to edit its own talk page
+ * - sitewide: (bool) Disallow editing all pages and all contribution actions,
+ * except those specifically allowed by other block flags
*
* @since 1.26 $options array
*/
/**
* Create a new block with specified parameters on a user, IP or IP range.
*
- * @param array $options Parameters of the block:
- * systemBlock string Indicate that this block is automatically
- * created by MediaWiki rather than being stored
- * in the database. Value is a string to return
- * from self::getSystemBlockType().
+ * @param array $options Parameters of the block, with options supported by
+ * `AbstractBlock::__construct`, and also:
+ * - systemBlock: (string) Indicate that this block is automatically created by
+ * MediaWiki rather than being stored in the database. Value is a string to
+ * return from self::getSystemBlockType().
*/
public function __construct( array $options = [] ) {
parent::__construct( $options );