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

(cherry picked from commit e0516e391a)
8.1.x
Jennifer Hodgdon 2015-12-08 09:48:23 -08:00
parent 10ec478e91
commit c5eb4480bb
32 changed files with 83 additions and 83 deletions

View File

@ -471,10 +471,10 @@ class PoHeader {
* *
* @param array $element_stack * @param array $element_stack
* Array of plural formula values and operators create by parseArithmetic(). * 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. * 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. * Number of the plural string to be used for the given plural value.
* *
* @see parseArithmetic() * @see parseArithmetic()

View File

@ -90,7 +90,7 @@ abstract class Connection {
/** /**
* An index used to generate unique temporary table names. * An index used to generate unique temporary table names.
* *
* @var integer * @var int
*/ */
protected $temporaryNameIndex = 0; protected $temporaryNameIndex = 0;

View File

@ -39,7 +39,7 @@ class Schema extends DatabaseSchema {
* Value will usually be set to a 63 chars limit but PostgreSQL allows * 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. * to higher this value before compiling, so we need to check for that.
* *
* @var integer * @var int
*/ */
protected $maxIdentifierLength; protected $maxIdentifierLength;

View File

@ -243,7 +243,7 @@ class EntityAutocomplete extends Textfield {
* Whether to trigger a form error if an element from $input (eg. an entity) * Whether to trigger a form error if an element from $input (eg. an entity)
* is not found. * is not found.
* *
* @return integer|null * @return int|null
* Value of a matching entity ID, or NULL if none. * Value of a matching entity ID, or NULL if none.
*/ */
protected static function matchEntityByTitle($handler, $input, &$element, FormStateInterface $form_state, $strict) { protected static function matchEntityByTitle($handler, $input, &$element, FormStateInterface $form_state, $strict) {

View File

@ -41,7 +41,7 @@ class EntityReference extends DataReferenceBase {
/** /**
* The entity ID. * The entity ID.
* *
* @var integer|string * @var int|string
*/ */
protected $id; protected $id;

View File

@ -84,7 +84,7 @@ class TwigTransTokenParser extends \Twig_TokenParser {
* *
* @param \Twig_Node $body * @param \Twig_Node $body
* The expression to check. * The expression to check.
* @param integer $lineno * @param int $lineno
* The source line. * The source line.
* *
* @throws \Twig_Error_Syntax * @throws \Twig_Error_Syntax

View File

@ -23,7 +23,7 @@ class Timestamp extends IntegerData implements DateTimeInterface {
/** /**
* The data value as a UNIX timestamp. * The data value as a UNIX timestamp.
* *
* @var integer * @var int
*/ */
protected $value; protected $value;

View File

@ -240,7 +240,7 @@ class CommentNonNodeTest extends WebTestBase {
* @param string $subject * @param string $subject
* Comment subject to find. * Comment subject to find.
* *
* @return integer * @return int
* Comment ID. * Comment ID.
*/ */
function getUnapprovedComment($subject) { function getUnapprovedComment($subject) {

View File

@ -288,7 +288,7 @@ abstract class CommentTestBase extends WebTestBase {
/** /**
* Sets the value governing restrictions on anonymous comments. * Sets the value governing restrictions on anonymous comments.
* *
* @param integer $level * @param int $level
* The level of the contact information allowed for anonymous comments: * The level of the contact information allowed for anonymous comments:
* - 0: No contact information allowed. * - 0: No contact information allowed.
* - 1: Contact information allowed but not required. * - 1: Contact information allowed but not required.
@ -373,7 +373,7 @@ abstract class CommentTestBase extends WebTestBase {
* @param string $subject * @param string $subject
* Comment subject to find. * Comment subject to find.
* *
* @return integer * @return int
* Comment id. * Comment id.
*/ */
function getUnapprovedComment($subject) { function getUnapprovedComment($subject) {

View File

@ -44,7 +44,7 @@ class MigrateContactCategoryTest extends MigrateDrupal6TestBase {
* The recipient e-mail addresses the form should have. * The recipient e-mail addresses the form should have.
* @param string $expected_reply * @param string $expected_reply
* The expected reply message. * The expected reply message.
* @param integer $expected_weight * @param int $expected_weight
* The contact form's expected weight. * The contact form's expected weight.
*/ */
protected function assertEntity($id, $expected_label, array $expected_recipients, $expected_reply, $expected_weight) { protected function assertEntity($id, $expected_label, array $expected_recipients, $expected_reply, $expected_weight) {

View File

@ -187,7 +187,7 @@ class FieldTranslationSynchronizer implements FieldTranslationSynchronizerInterf
* *
* @param array $items * @param array $items
* An array of field items. * An array of field items.
* @param integer $delta * @param int $delta
* The delta identifying the item to be processed. * The delta identifying the item to be processed.
* @param array $columns * @param array $columns
* An array of column names to be synchronized. * An array of column names to be synchronized.

View File

@ -48,7 +48,7 @@ class ContentTranslationSyncUnitTest extends KernelTestBase {
/** /**
* The field cardinality. * The field cardinality.
* *
* @var integer * @var int
*/ */
protected $cardinality; protected $cardinality;

View File

@ -36,7 +36,7 @@ class EntityReferenceFileUploadTest extends WebTestBase {
/** /**
* Node id. * Node id.
* *
* @var integer * @var int
*/ */
protected $nodeId; protected $nodeId;

View File

@ -53,9 +53,9 @@ class MigrateFieldTest extends MigrateDrupal7TestBase {
* The entity ID in the form ENTITY_TYPE.FIELD_NAME. * The entity ID in the form ENTITY_TYPE.FIELD_NAME.
* @param string $expected_type * @param string $expected_type
* The expected field type. * The expected field type.
* @param boolean $expected_translatable * @param bool $expected_translatable
* Whether or not the field is expected to be 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. * The expected cardinality of the field.
*/ */
protected function assertEntity($id, $expected_type, $expected_translatable, $expected_cardinality) { protected function assertEntity($id, $expected_type, $expected_translatable, $expected_cardinality) {

View File

@ -148,8 +148,8 @@ class EntityFile extends EntityContentBase {
* The source path or URI. * The source path or URI.
* @param string $destination * @param string $destination
* The destination path or URI. * The destination path or URI.
* @param integer $replace * @param int $replace
* FILE_EXISTS_REPLACE (default) or FILE_EXISTS_RENAME. * (optional) FILE_EXISTS_REPLACE (default) or FILE_EXISTS_RENAME.
* *
* @return bool * @return bool
* TRUE on success, FALSE on failure. * TRUE on success, FALSE on failure.
@ -170,7 +170,7 @@ class EntityFile extends EntityContentBase {
* *
* @param \Drupal\migrate\Row $row * @param \Drupal\migrate\Row $row
* *
* @return integer * @return int
* Either FILE_EXISTS_REPLACE (default) or FILE_EXISTS_RENAME, depending * Either FILE_EXISTS_REPLACE (default) or FILE_EXISTS_RENAME, depending
* on the current configuration. * on the current configuration.
*/ */

View File

@ -50,17 +50,17 @@ class MigrateFileTest extends MigrateDrupal6TestBase implements MigrateDumpAlter
/** /**
* Asserts a file entity. * Asserts a file entity.
* *
* @param integer $fid * @param int $fid
* The file ID. * The file ID.
* @param string $name * @param string $name
* The expected file name. * The expected file name.
* @param integer $size * @param int $size
* The expected file size. * The expected file size.
* @param string $uri * @param string $uri
* The expected file URI. * The expected file URI.
* @param string $type * @param string $type
* The expected MIME type. * The expected MIME type.
* @param integer $uid * @param int $uid
* The expected file owner ID. * The expected file owner ID.
*/ */
protected function assertEntity($fid, $name, $size, $uri, $type, $uid) { protected function assertEntity($fid, $name, $size, $uri, $type, $uid) {

View File

@ -53,7 +53,7 @@ class MigrateFileTest extends MigrateDrupal7TestBase {
/** /**
* Tests a single file entity. * Tests a single file entity.
* *
* @param integer $id * @param int $id
* The file ID. * The file ID.
* @param string $name * @param string $name
* The expected file name. * The expected file name.
@ -61,13 +61,13 @@ class MigrateFileTest extends MigrateDrupal7TestBase {
* The expected URI. * The expected URI.
* @param string $mime * @param string $mime
* The expected MIME type. * The expected MIME type.
* @param integer $size * @param int $size
* The expected file size. * The expected file size.
* @param integer $created * @param int $created
* The expected creation time. * The expected creation time.
* @param integer $changed * @param int $changed
* The expected modification time. * The expected modification time.
* @param integer $uid * @param int $uid
* The expected owner ID. * The expected owner ID.
*/ */
protected function assertEntity($id, $name, $uri, $mime, $size, $created, $changed, $uid) { protected function assertEntity($id, $name, $uri, $mime, $size, $created, $changed, $uid) {

View File

@ -86,8 +86,8 @@ class HelpTest extends WebTestBase {
/** /**
* Verifies the logged in user has access to the various help nodes. * Verifies the logged in user has access to the various help nodes.
* *
* @param integer $response * @param int $response
* An HTTP response code. * (optional) An HTTP response code. Defaults to 200.
*/ */
protected function verifyHelp($response = 200) { protected function verifyHelp($response = 200) {
$this->drupalGet('admin/index'); $this->drupalGet('admin/index');

View File

@ -63,14 +63,14 @@ class ConfigurableLanguage extends ConfigEntityBase implements ConfigurableLangu
/** /**
* The direction of language, either DIRECTION_LTR or DIRECTION_RTL. * The direction of language, either DIRECTION_LTR or DIRECTION_RTL.
* *
* @var integer * @var int
*/ */
protected $direction = self::DIRECTION_LTR; protected $direction = self::DIRECTION_LTR;
/** /**
* The weight of the language, used in lists of languages. * The weight of the language, used in lists of languages.
* *
* @var integer * @var int
*/ */
protected $weight = 0; protected $weight = 0;

View File

@ -17,7 +17,7 @@ abstract class StringBase implements StringInterface {
/** /**
* The string identifier. * The string identifier.
* *
* @var integer * @var int
*/ */
public $lid; public $lid;

View File

@ -19,28 +19,28 @@ abstract class LocaleUpdateBase extends WebTestBase {
/** /**
* Timestamp for an old translation. * Timestamp for an old translation.
* *
* @var integer * @var int
*/ */
protected $timestampOld; protected $timestampOld;
/** /**
* Timestamp for a medium aged translation. * Timestamp for a medium aged translation.
* *
* @var integer * @var int
*/ */
protected $timestampMedium; protected $timestampMedium;
/** /**
* Timestamp for a new translation. * Timestamp for a new translation.
* *
* @var integer * @var int
*/ */
protected $timestampNew; protected $timestampNew;
/** /**
* Timestamp for current time. * Timestamp for current time.
* *
* @var integer * @var int
*/ */
protected $timestampNow; protected $timestampNow;

View File

@ -901,8 +901,8 @@ class MenuTest extends MenuWebTestBase {
/** /**
* Verifies the logged in user has the desired access to various menu pages. * Verifies the logged in user has the desired access to various menu pages.
* *
* @param integer $response * @param int $response
* The expected HTTP response code. Defaults to 200. * (optional) The expected HTTP response code. Defaults to 200.
*/ */
private function verifyAccess($response = 200) { private function verifyAccess($response = 200) {
// View menu help page. // View menu help page.

View File

@ -96,7 +96,7 @@ abstract class TestBase {
/** /**
* Incrementing identifier for verbose output filenames. * Incrementing identifier for verbose output filenames.
* *
* @var integer * @var int
*/ */
protected $verboseId = 0; protected $verboseId = 0;

View File

@ -92,7 +92,7 @@ trait UserCreationTrait {
* (optional) The role ID (machine name). Defaults to a random name. * (optional) The role ID (machine name). Defaults to a random name.
* @param string $name * @param string $name
* (optional) The label for the role. Defaults to a random string. * (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() * (optional) The weight for the role. Defaults NULL so that entity_create()
* sets the weight to maximum + 1. * sets the weight to maximum + 1.
* *
@ -119,7 +119,7 @@ trait UserCreationTrait {
* (optional) The role ID (machine name). Defaults to a random name. * (optional) The role ID (machine name). Defaults to a random name.
* @param string $name * @param string $name
* (optional) The label for the role. Defaults to a random string. * (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() * (optional) The weight for the role. Defaults NULL so that entity_create()
* sets the weight to maximum + 1. * sets the weight to maximum + 1.
* *

View File

@ -66,7 +66,7 @@ class ConnectionUnitTest extends KernelTestBase {
/** /**
* Returns the connection ID of the current test connection. * Returns the connection ID of the current test connection.
* *
* @return integer * @return int
*/ */
protected function getConnectionID() { protected function getConnectionID() {
return (int) Database::getConnection($this->target, $this->key)->query('SELECT CONNECTION_ID()')->fetchField(); return (int) Database::getConnection($this->target, $this->key)->query('SELECT CONNECTION_ID()')->fetchField();
@ -75,7 +75,7 @@ class ConnectionUnitTest extends KernelTestBase {
/** /**
* Asserts that a connection ID exists. * Asserts that a connection ID exists.
* *
* @param integer $id * @param int $id
* The connection ID to verify. * The connection ID to verify.
*/ */
protected function assertConnection($id) { protected function assertConnection($id) {
@ -86,7 +86,7 @@ class ConnectionUnitTest extends KernelTestBase {
/** /**
* Asserts that a connection ID does not exist. * Asserts that a connection ID does not exist.
* *
* @param integer $id * @param int $id
* The connection ID to verify. * The connection ID to verify.
*/ */
protected function assertNoConnection($id) { protected function assertNoConnection($id) {

View File

@ -24,7 +24,7 @@ class MockMenuBlock {
/** /**
* The number of menu levels deep to render. * The number of menu levels deep to render.
* *
* @var integer * @var int
*/ */
protected $depth; protected $depth;

View File

@ -82,14 +82,14 @@ class Vocabulary extends ConfigEntityBundleBase implements VocabularyInterface {
* - TAXONOMY_HIERARCHY_SINGLE: Single parent. * - TAXONOMY_HIERARCHY_SINGLE: Single parent.
* - TAXONOMY_HIERARCHY_MULTIPLE: Multiple parents. * - TAXONOMY_HIERARCHY_MULTIPLE: Multiple parents.
* *
* @var integer * @var int
*/ */
protected $hierarchy = TAXONOMY_HIERARCHY_DISABLED; protected $hierarchy = TAXONOMY_HIERARCHY_DISABLED;
/** /**
* The weight of this vocabulary in relation to other vocabularies. * The weight of this vocabulary in relation to other vocabularies.
* *
* @var integer * @var int
*/ */
protected $weight = 0; protected $weight = 0;

View File

@ -118,9 +118,9 @@ class TaxonomyTermFilterDepthTest extends TaxonomyTestBase {
/** /**
* Changes the tid filter to given term and depth. * Changes the tid filter to given term and depth.
* *
* @param integer $tid * @param int $tid
* The term ID to filter on. * The term ID to filter on.
* @param integer $depth * @param int $depth
* The depth to search. * The depth to search.
* @param array $expected * @param array $expected
* The expected views result. * The expected views result.

View File

@ -17,7 +17,7 @@ interface VocabularyInterface extends ConfigEntityInterface {
/** /**
* Returns the vocabulary hierarchy. * Returns the vocabulary hierarchy.
* *
* @return integer * @return int
* The vocabulary hierarchy. * The vocabulary hierarchy.
*/ */
public function getHierarchy(); public function getHierarchy();
@ -25,7 +25,7 @@ interface VocabularyInterface extends ConfigEntityInterface {
/** /**
* Sets the vocabulary hierarchy. * Sets the vocabulary hierarchy.
* *
* @param integer $hierarchy * @param int $hierarchy
* The hierarchy type of vocabulary. * The hierarchy type of vocabulary.
* Possible values: * Possible values:
* - TAXONOMY_HIERARCHY_DISABLED: No parents. * - TAXONOMY_HIERARCHY_DISABLED: No parents.

View File

@ -17,7 +17,7 @@ interface UserDataInterface {
* *
* @param string $module * @param string $module
* The name of the module the data is associated with. * 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. * (optional) The user account ID the data is associated with.
* @param string $name * @param string $name
* (optional) The name of the data key. * (optional) The name of the data key.
@ -41,7 +41,7 @@ interface UserDataInterface {
* *
* @param string $module * @param string $module
* The name of the module the data is associated with. * 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. * The user account ID the data is associated with.
* @param string $name * @param string $name
* The name of the data key. * The name of the data key.
@ -58,7 +58,7 @@ interface UserDataInterface {
* @param string|array $module * @param string|array $module
* (optional) The name of the module the data is associated with. Can also * (optional) The name of the module the data is associated with. Can also
* be an array to delete the data of multiple modules. * 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, * (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 * all data for $module is deleted. Can also be an array of IDs to delete
* the data of multiple user accounts. * the data of multiple user accounts.

View File

@ -29,7 +29,7 @@ class ResultRow {
/** /**
* An incremental number which represents the row in the entire result. * An incremental number which represents the row in the entire result.
* *
* @var integer * @var int
*/ */
public $index; public $index;

View File

@ -30,7 +30,7 @@ class SortArrayTest extends UnitTestCase {
* The first input array for the SortArray::sortByWeightElement() method. * The first input array for the SortArray::sortByWeightElement() method.
* @param array $b * @param array $b
* The second input array for the SortArray::sortByWeightElement(). * The second input array for the SortArray::sortByWeightElement().
* @param integer $expected * @param int $expected
* The expected output from calling the method. * The expected output from calling the method.
*/ */
public function testSortByWeightElement($a, $b, $expected) { public function testSortByWeightElement($a, $b, $expected) {
@ -106,7 +106,7 @@ class SortArrayTest extends UnitTestCase {
* The first input array for the SortArray::sortByWeightProperty() method. * The first input array for the SortArray::sortByWeightProperty() method.
* @param array $b * @param array $b
* The second input array for the SortArray::sortByWeightProperty(). * The second input array for the SortArray::sortByWeightProperty().
* @param integer $expected * @param int $expected
* The expected output from calling the method. * The expected output from calling the method.
*/ */
public function testSortByWeightProperty($a, $b, $expected) { public function testSortByWeightProperty($a, $b, $expected) {
@ -182,7 +182,7 @@ class SortArrayTest extends UnitTestCase {
* The first input item for comparison. * The first input item for comparison.
* @param array $b * @param array $b
* The second item for comparison. * The second item for comparison.
* @param integer $expected * @param int $expected
* The expected output from calling the method. * The expected output from calling the method.
*/ */
public function testSortByTitleElement($a, $b, $expected) { public function testSortByTitleElement($a, $b, $expected) {
@ -251,7 +251,7 @@ class SortArrayTest extends UnitTestCase {
* The first input item for comparison. * The first input item for comparison.
* @param array $b * @param array $b
* The second item for comparison. * The second item for comparison.
* @param integer $expected * @param int $expected
* The expected output from calling the method. * The expected output from calling the method.
*/ */
public function testSortByTitleProperty($a, $b, $expected) { public function testSortByTitleProperty($a, $b, $expected) {