Properly declare all properties on classes

[tw2113]

We have a number of classes available, whether internal or public for users, and that's wonderful. However, we have not always properly declared the properties that we set in the __construct() methods or elsewhere in the class. We should work to change that fact.

Example from BP_Groups_Group:

/**
 * ID of the group.
 *
 * @since 1.6.0
 * @var int
 */
public $id;

public function __construct( $id = null, $args = array() ) {
	$this->args = wp_parse_args( $args, array(
		'populate_extras' => false,
	) );

	if ( !empty( $id ) ) {
		$this->id = $id;
		$this->populate();
	}
}

[DJPaul]

Indeed

[tw2113]

CHECK FOR MULTIPLE SPOTS

class-bp-activity-activity.php

{$bp->activity->table_name}
buddypress()->activity->table_name_meta
$bp->profile->table_name_data

class-bp-activity-component.php

buddypress()->plugin_dir
$bp->table_prefix
$bp->pages->activity->slug
buddypress()->my_account_menu_id
$bp->bp_options_title
$bp->bp_options_avatar

class-bp-activity-feed.php

Need to decide on visibility of properties

class-bp-activity-list-table

buddypress()->profile->name

[tw2113]

Some appear to be a part of BuddyPress::setup_globals(); which has a nice long note about protecting things and keeping part of the galaxy at peace.

[tw2113]

​https://gist.github.com/tw2113/b41f25858d0434e794284edd8db7c954

[tw2113]

Declare the types based on class instead of array.

[espellcaste]

@tw2113 This seems to be an interesting problem we could solve. Can you leave an update what's left on this one?

[tw2113]

Honestly probably most of it. I doubt I ever committed anything officially, instead just relied on the diff files above for extra review.

[espellcaste]

@tw2113 Can I ask how you generated this list here: ​https://gist.github.com/tw2113/b41f25858d0434e794284edd8db7c954 ?

And thank you for your feedback, I'll take from here. :)

[tw2113]

I most likely did a grep/ack/ag code search on the trunk branch and extracted out the results.

Trac ticket: ​https://buddypress.trac.wordpress.org/ticket/7018

@imath Initially, I was updating the types (i.e., bool => boolean) per case/situation, but I'll introduce a future pull request with a change in the project. In this way, we account for everything.

[espellcaste]

In 13399:

Properly declare missing properties to several classes.

Closes ​https://github.com/buddypress/buddypress/pull/54
See #7018

[espellcaste]

In 13400:

Set missing properties to the BuddyPress class.

See #7018

[espellcaste]

In 13404:

Properly declare missing properties to classes in the Members component.

See #7018

[imath]

In 13453:

Properly declare the BP_Nouveau_Customizer_Group_Nav $group prop

See #8820
See #7018

[arafatjamil01]

I have applied the patch from svn for all the Declarations. Everything looks good.

[imath]

There are still a lot of work about this ticket, let's carry on during next release cycle.

[espellcaste]

In 13662:

Properly declare the BP_Groups_Component $table_name prop.

See #7018

[espellcaste]

I think we got all of them. But I'll review the code base before resolving this ticket.

[espellcaste]

Resolving ticket since I can't find instances to be update now.