Commit c5eb4480 authored by jhodgdon's avatar jhodgdon

Issue #2607870 by Lars Toomre: Some docblock fixes for PHP type 'integer'

(cherry picked from commit e0516e39)
parent 10ec478e
......@@ -471,10 +471,10 @@ private function tokenizeFormula($formula) {
*
* @param array $element_stack
* Array of plural formula values and operators create by parseArithmetic().
* @param integer $n
* @param int $n
* The @count number for which we are determining the right plural position.
*
* @return integer
* @return int
* Number of the plural string to be used for the given plural value.
*
* @see parseArithmetic()
......
......@@ -90,7 +90,7 @@ abstract class Connection {
/**
* An index used to generate unique temporary table names.
*
* @var integer
* @var int
*/
protected $temporaryNameIndex = 0;
......
......@@ -39,7 +39,7 @@ class Schema extends DatabaseSchema {
* Value will usually be set to a 63 chars limit but PostgreSQL allows
* to higher this value before compiling, so we need to check for that.
*
* @var integer
* @var int
*/
protected $maxIdentifierLength;
......
......@@ -243,7 +243,7 @@ public static function validateEntityAutocomplete(array &$element, FormStateInte
* Whether to trigger a form error if an element from $input (eg. an entity)
* is not found.
*
* @return integer|null
* @return int|null
* Value of a matching entity ID, or NULL if none.
*/
protected static function matchEntityByTitle($handler, $input, &$element, FormStateInterface $form_state, $strict) {
......
......@@ -41,7 +41,7 @@ class EntityReference extends DataReferenceBase {
/**
* The entity ID.
*
* @var integer|string
* @var int|string
*/
protected $id;
......
......@@ -84,7 +84,7 @@ public function getTag() {
*
* @param \Twig_Node $body
* The expression to check.
* @param integer $lineno
* @param int $lineno
* The source line.
*
* @throws \Twig_Error_Syntax
......
......@@ -23,7 +23,7 @@ class Timestamp extends IntegerData implements DateTimeInterface {
/**
* The data value as a UNIX timestamp.
*
* @var integer
* @var int
*/
protected $value;
......
......@@ -240,7 +240,7 @@ function performCommentOperation($comment, $operation, $approval = FALSE) {
* @param string $subject
* Comment subject to find.
*
* @return integer
* @return int
* Comment ID.
*/
function getUnapprovedComment($subject) {
......
......@@ -288,7 +288,7 @@ public function setCommentForm($enabled, $field_name = 'comment') {
/**
* Sets the value governing restrictions on anonymous comments.
*
* @param integer $level
* @param int $level
* The level of the contact information allowed for anonymous comments:
* - 0: No contact information allowed.
* - 1: Contact information allowed but not required.
......@@ -373,7 +373,7 @@ function performCommentOperation(CommentInterface $comment, $operation, $approva
* @param string $subject
* Comment subject to find.
*
* @return integer
* @return int
* Comment id.
*/
function getUnapprovedComment($subject) {
......
......@@ -37,15 +37,15 @@ protected function setUp() {
* Performs various assertions on a single contact form entity.
*
* @param string $id
* The contact form ID.
* The contact form ID.
* @param string $expected_label
* The expected label.
* The expected label.
* @param string[] $expected_recipients
* The recipient e-mail addresses the form should have.
* The recipient e-mail addresses the form should have.
* @param string $expected_reply
* The expected reply message.
* @param integer $expected_weight
* The contact form's expected weight.
* The expected reply message.
* @param int $expected_weight
* The contact form's expected weight.
*/
protected function assertEntity($id, $expected_label, array $expected_recipients, $expected_reply, $expected_weight) {
/** @var \Drupal\contact\ContactFormInterface $entity */
......
......@@ -187,7 +187,7 @@ public function synchronizeItems(array &$values, array $unchanged_items, $sync_l
*
* @param array $items
* An array of field items.
* @param integer $delta
* @param int $delta
* The delta identifying the item to be processed.
* @param array $columns
* An array of column names to be synchronized.
......
......@@ -48,7 +48,7 @@ class ContentTranslationSyncUnitTest extends KernelTestBase {
/**
* The field cardinality.
*
* @var integer
* @var int
*/
protected $cardinality;
......
......@@ -36,7 +36,7 @@ class EntityReferenceFileUploadTest extends WebTestBase {
/**
* Node id.
*
* @var integer
* @var int
*/
protected $nodeId;
......
......@@ -53,9 +53,9 @@ protected function setUp() {
* The entity ID in the form ENTITY_TYPE.FIELD_NAME.
* @param string $expected_type
* The expected field type.
* @param boolean $expected_translatable
* @param bool $expected_translatable
* Whether or not the field is expected to be translatable.
* @param integer $expected_cardinality
* @param int $expected_cardinality
* The expected cardinality of the field.
*/
protected function assertEntity($id, $expected_type, $expected_translatable, $expected_cardinality) {
......
......@@ -145,11 +145,11 @@ public function import(Row $row, array $old_destination_id_values = array()) {
* Tries to move or copy a file.
*
* @param string $source
* The source path or URI.
* The source path or URI.
* @param string $destination
* The destination path or URI.
* @param integer $replace
* FILE_EXISTS_REPLACE (default) or FILE_EXISTS_RENAME.
* The destination path or URI.
* @param int $replace
* (optional) FILE_EXISTS_REPLACE (default) or FILE_EXISTS_RENAME.
*
* @return bool
* TRUE on success, FALSE on failure.
......@@ -170,9 +170,9 @@ protected function writeFile($source, $destination, $replace = FILE_EXISTS_REPLA
*
* @param \Drupal\migrate\Row $row
*
* @return integer
* Either FILE_EXISTS_REPLACE (default) or FILE_EXISTS_RENAME, depending
* on the current configuration.
* @return int
* Either FILE_EXISTS_REPLACE (default) or FILE_EXISTS_RENAME, depending
* on the current configuration.
*/
protected function getOverwriteMode(Row $row) {
if (!empty($this->configuration['rename'])) {
......
......@@ -50,18 +50,18 @@ protected function setUp() {
/**
* Asserts a file entity.
*
* @param integer $fid
* The file ID.
* @param int $fid
* The file ID.
* @param string $name
* The expected file name.
* @param integer $size
* The expected file size.
* The expected file name.
* @param int $size
* The expected file size.
* @param string $uri
* The expected file URI.
* The expected file URI.
* @param string $type
* The expected MIME type.
* @param integer $uid
* The expected file owner ID.
* The expected MIME type.
* @param int $uid
* The expected file owner ID.
*/
protected function assertEntity($fid, $name, $size, $uri, $type, $uid) {
/** @var \Drupal\file\FileInterface $file */
......
......@@ -53,22 +53,22 @@ protected function setUp() {
/**
* Tests a single file entity.
*
* @param integer $id
* The file ID.
* @param int $id
* The file ID.
* @param string $name
* The expected file name.
* The expected file name.
* @param string $uri
* The expected URI.
* The expected URI.
* @param string $mime
* The expected MIME type.
* @param integer $size
* The expected file size.
* @param integer $created
* The expected creation time.
* @param integer $changed
* The expected modification time.
* @param integer $uid
* The expected owner ID.
* The expected MIME type.
* @param int $size
* The expected file size.
* @param int $created
* The expected creation time.
* @param int $changed
* The expected modification time.
* @param int $uid
* The expected owner ID.
*/
protected function assertEntity($id, $name, $uri, $mime, $size, $created, $changed, $uid) {
/** @var \Drupal\file\FileInterface $file */
......
......@@ -86,8 +86,8 @@ public function testHelp() {
/**
* Verifies the logged in user has access to the various help nodes.
*
* @param integer $response
* An HTTP response code.
* @param int $response
* (optional) An HTTP response code. Defaults to 200.
*/
protected function verifyHelp($response = 200) {
$this->drupalGet('admin/index');
......
......@@ -63,14 +63,14 @@ class ConfigurableLanguage extends ConfigEntityBase implements ConfigurableLangu
/**
* The direction of language, either DIRECTION_LTR or DIRECTION_RTL.
*
* @var integer
* @var int
*/
protected $direction = self::DIRECTION_LTR;
/**
* The weight of the language, used in lists of languages.
*
* @var integer
* @var int
*/
protected $weight = 0;
......
......@@ -17,7 +17,7 @@ abstract class StringBase implements StringInterface {
/**
* The string identifier.
*
* @var integer
* @var int
*/
public $lid;
......
......@@ -19,28 +19,28 @@ abstract class LocaleUpdateBase extends WebTestBase {
/**
* Timestamp for an old translation.
*
* @var integer
* @var int
*/
protected $timestampOld;
/**
* Timestamp for a medium aged translation.
*
* @var integer
* @var int
*/
protected $timestampMedium;
/**
* Timestamp for a new translation.
*
* @var integer
* @var int
*/
protected $timestampNew;
/**
* Timestamp for current time.
*
* @var integer
* @var int
*/
protected $timestampNow;
......
......@@ -901,8 +901,8 @@ private function getStandardMenuLink() {
/**
* Verifies the logged in user has the desired access to various menu pages.
*
* @param integer $response
* The expected HTTP response code. Defaults to 200.
* @param int $response
* (optional) The expected HTTP response code. Defaults to 200.
*/
private function verifyAccess($response = 200) {
// View menu help page.
......
......@@ -96,7 +96,7 @@ abstract class TestBase {
/**
* Incrementing identifier for verbose output filenames.
*
* @var integer
* @var int
*/
protected $verboseId = 0;
......
......@@ -92,7 +92,7 @@ protected function createUser(array $permissions = array(), $name = NULL, $admin
* (optional) The role ID (machine name). Defaults to a random name.
* @param string $name
* (optional) The label for the role. Defaults to a random string.
* @param integer $weight
* @param int $weight
* (optional) The weight for the role. Defaults NULL so that entity_create()
* sets the weight to maximum + 1.
*
......@@ -119,7 +119,7 @@ protected function createAdminRole($rid = NULL, $name = NULL, $weight = NULL) {
* (optional) The role ID (machine name). Defaults to a random name.
* @param string $name
* (optional) The label for the role. Defaults to a random string.
* @param integer $weight
* @param int $weight
* (optional) The weight for the role. Defaults NULL so that entity_create()
* sets the weight to maximum + 1.
*
......
......@@ -66,7 +66,7 @@ protected function addConnection() {
/**
* Returns the connection ID of the current test connection.
*
* @return integer
* @return int
*/
protected function getConnectionID() {
return (int) Database::getConnection($this->target, $this->key)->query('SELECT CONNECTION_ID()')->fetchField();
......@@ -75,7 +75,7 @@ protected function getConnectionID() {
/**
* Asserts that a connection ID exists.
*
* @param integer $id
* @param int $id
* The connection ID to verify.
*/
protected function assertConnection($id) {
......@@ -86,7 +86,7 @@ protected function assertConnection($id) {
/**
* Asserts that a connection ID does not exist.
*
* @param integer $id
* @param int $id
* The connection ID to verify.
*/
protected function assertNoConnection($id) {
......
......@@ -24,7 +24,7 @@ class MockMenuBlock {
/**
* The number of menu levels deep to render.
*
* @var integer
* @var int
*/
protected $depth;
......
......@@ -82,14 +82,14 @@ class Vocabulary extends ConfigEntityBundleBase implements VocabularyInterface {
* - TAXONOMY_HIERARCHY_SINGLE: Single parent.
* - TAXONOMY_HIERARCHY_MULTIPLE: Multiple parents.
*
* @var integer
* @var int
*/
protected $hierarchy = TAXONOMY_HIERARCHY_DISABLED;
/**
* The weight of this vocabulary in relation to other vocabularies.
*
* @var integer
* @var int
*/
protected $weight = 0;
......
......@@ -118,9 +118,9 @@ public function testTermWithDepthFilter() {
/**
* Changes the tid filter to given term and depth.
*
* @param integer $tid
* @param int $tid
* The term ID to filter on.
* @param integer $depth
* @param int $depth
* The depth to search.
* @param array $expected
* The expected views result.
......
......@@ -17,7 +17,7 @@ interface VocabularyInterface extends ConfigEntityInterface {
/**
* Returns the vocabulary hierarchy.
*
* @return integer
* @return int
* The vocabulary hierarchy.
*/
public function getHierarchy();
......@@ -25,7 +25,7 @@ public function getHierarchy();
/**
* Sets the vocabulary hierarchy.
*
* @param integer $hierarchy
* @param int $hierarchy
* The hierarchy type of vocabulary.
* Possible values:
* - TAXONOMY_HIERARCHY_DISABLED: No parents.
......
......@@ -17,7 +17,7 @@ interface UserDataInterface {
*
* @param string $module
* The name of the module the data is associated with.
* @param integer $uid
* @param int $uid
* (optional) The user account ID the data is associated with.
* @param string $name
* (optional) The name of the data key.
......@@ -41,7 +41,7 @@ public function get($module, $uid = NULL, $name = NULL);
*
* @param string $module
* The name of the module the data is associated with.
* @param integer $uid
* @param int $uid
* The user account ID the data is associated with.
* @param string $name
* The name of the data key.
......@@ -58,7 +58,7 @@ public function set($module, $uid, $name, $value);
* @param string|array $module
* (optional) The name of the module the data is associated with. Can also
* be an array to delete the data of multiple modules.
* @param integer|array $uid
* @param int|array $uid
* (optional) The user account ID the data is associated with. If omitted,
* all data for $module is deleted. Can also be an array of IDs to delete
* the data of multiple user accounts.
......
......@@ -29,7 +29,7 @@ class ResultRow {
/**
* An incremental number which represents the row in the entire result.
*
* @var integer
* @var int
*/
public $index;
......
......@@ -30,7 +30,7 @@ class SortArrayTest extends UnitTestCase {
* The first input array for the SortArray::sortByWeightElement() method.
* @param array $b
* The second input array for the SortArray::sortByWeightElement().
* @param integer $expected
* @param int $expected
* The expected output from calling the method.
*/
public function testSortByWeightElement($a, $b, $expected) {
......@@ -106,7 +106,7 @@ public function providerSortByWeightElement() {
* The first input array for the SortArray::sortByWeightProperty() method.
* @param array $b
* The second input array for the SortArray::sortByWeightProperty().
* @param integer $expected
* @param int $expected
* The expected output from calling the method.
*/
public function testSortByWeightProperty($a, $b, $expected) {
......@@ -182,7 +182,7 @@ public function providerSortByWeightProperty() {
* The first input item for comparison.
* @param array $b
* The second item for comparison.
* @param integer $expected
* @param int $expected
* The expected output from calling the method.
*/
public function testSortByTitleElement($a, $b, $expected) {
......@@ -251,7 +251,7 @@ public function providerSortByTitleElement() {
* The first input item for comparison.
* @param array $b
* The second item for comparison.
* @param integer $expected
* @param int $expected
* The expected output from calling the method.
*/
public function testSortByTitleProperty($a, $b, $expected) {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment