Skip to content

Commit 63220ae

Browse files
obenlandobenland
authored
Docs: Move method docs to most basic class (#1633)
1 parent 79045e7 commit 63220ae

File tree

2 files changed

+44
-43
lines changed

2 files changed

+44
-43
lines changed

‎includes/activity/class-base-object.php‎

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -20,49 +20,6 @@
2020
* 'Base_' for this reason.
2121
*
2222
* @see https://www.w3.org/TR/activitystreams-core/#object
23-
*
24-
* @method string|null get_actor() Gets one or more entities that performed or are expected to perform the activity.
25-
* @method string|null get_attributed_to() Gets the entity attributed as the original author.
26-
* @method array|null get_attachment() Gets the attachment property of the object.
27-
* @method array|null get_cc() Gets the secondary recipients of the object.
28-
* @method string|null get_content() Gets the content property of the object.
29-
* @method array|null get_icon() Gets the icon property of the object.
30-
* @method string|null get_id() Gets the object's unique global identifier.
31-
* @method array|null get_image() Gets the image property of the object.
32-
* @method array|string|null get_in_reply_to() Gets the objects this object is in reply to.
33-
* @method string|null get_name() Gets the natural language name of the object.
34-
* @method Base_Object|string|null get_object() Gets the direct object of the activity.
35-
* @method string|null get_published() Gets the date and time the object was published in ISO 8601 format.
36-
* @method string|null get_summary() Gets the natural language summary of the object.
37-
* @method array|null get_tag() Gets the tag property of the object.
38-
* @method array|string|null get_to() Gets the primary recipients of the object.
39-
* @method string get_type() Gets the type of the object.
40-
* @method string|null get_updated() Gets the date and time the object was updated in ISO 8601 format.
41-
* @method string|null get_url() Gets the URL of the object.
42-
*
43-
* @method string|array add_cc( string|array $cc ) Adds one or more entities to the secondary audience of the object.
44-
* @method string|array add_to( string|array $to ) Adds one or more entities to the primary audience of the object.
45-
*
46-
* @method Base_Object set_actor( string|array $actor ) Sets one or more entities that performed the activity.
47-
* @method Base_Object set_attachment( array $attachment ) Sets the attachment property of the object.
48-
* @method Base_Object set_attributed_to( string $attributed_to ) Sets the entity attributed as the original author.
49-
* @method Base_Object set_cc( array|string $cc ) Sets the secondary recipients of the object.
50-
* @method Base_Object set_content( string $content ) Sets the content property of the object.
51-
* @method Base_Object set_content_map( array $content_map ) Sets the content property of the object.
52-
* @method Base_Object set_icon( array $icon ) Sets the icon property of the object.
53-
* @method Base_Object set_id( string $id ) Sets the object's unique global identifier.
54-
* @method Base_Object set_image( array $image ) Sets the image property of the object.
55-
* @method Base_Object set_name( string $name ) Sets the natural language name of the object.
56-
* @method Base_Object set_origin( string $origin ) Sets the origin property of the object.
57-
* @method Base_Object set_published( string $published ) Sets the date and time the object was published in ISO 8601 format.
58-
* @method Base_Object set_sensitive( bool $sensitive ) Sets the sensitive property of the object.
59-
* @method Base_Object set_summary( string $summary ) Sets the natural language summary of the object.
60-
* @method Base_Object set_summary_map( array|null $summary_map ) Sets the summary property of the object.
61-
* @method Base_Object set_target( string $target ) Sets the target property of the object.
62-
* @method Base_Object set_to( array|string $to ) Sets the primary recipients of the object.
63-
* @method Base_Object set_type( string $type ) Sets the type of the object.
64-
* @method Base_Object set_updated( string $updated ) Sets the date and time the object was updated in ISO 8601 format.
65-
* @method Base_Object set_url( string $url ) Sets the URL of the object.
6623
*/
6724
class Base_Object extends Generic_Object {
6825
/**

‎includes/activity/class-generic-object.php‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,50 @@
1818
* conform to the ActivityStreams vocabulary.
1919
*
2020
* @since 5.3.0
21+
*
22+
* @method string|null get_actor() Gets one or more entities that performed or are expected to perform the activity.
23+
* @method string[]|null get_also_known_as() Gets the also known as property of the object.
24+
* @method string|null get_attributed_to() Gets the entity attributed as the original author.
25+
* @method array[]|null get_attachment() Gets the attachment property of the object.
26+
* @method string[]|null get_cc() Gets the secondary recipients of the object.
27+
* @method string|null get_content() Gets the content property of the object.
28+
* @method string[]|null get_icon() Gets the icon property of the object.
29+
* @method string|null get_id() Gets the object's unique global identifier.
30+
* @method string[]|null get_image() Gets the image property of the object.
31+
* @method string[]|string|null get_in_reply_to() Gets the objects this object is in reply to.
32+
* @method string|null get_name() Gets the natural language name of the object.
33+
* @method Base_Object|string|null get_object() Gets the direct object of the activity.
34+
* @method string|null get_published() Gets the date and time the object was published in ISO 8601 format.
35+
* @method string|null get_summary() Gets the natural language summary of the object.
36+
* @method array[]|null get_tag() Gets the tag property of the object.
37+
* @method string[]|string|null get_to() Gets the primary recipients of the object.
38+
* @method string get_type() Gets the type of the object.
39+
* @method string|null get_updated() Gets the date and time the object was updated in ISO 8601 format.
40+
* @method string|null get_url() Gets the URL of the object.
41+
*
42+
* @method string|string[] add_cc( string|array $cc ) Adds one or more entities to the secondary audience of the object.
43+
* @method string|string[] add_to( string|array $to ) Adds one or more entities to the primary audience of the object.
44+
*
45+
* @method Base_Object set_actor( string|array $actor ) Sets one or more entities that performed the activity.
46+
* @method Base_Object set_attachment( array $attachment ) Sets the attachment property of the object.
47+
* @method Base_Object set_attributed_to( string $attributed_to ) Sets the entity attributed as the original author.
48+
* @method Base_Object set_cc( array|string $cc ) Sets the secondary recipients of the object.
49+
* @method Base_Object set_content( string $content ) Sets the content property of the object.
50+
* @method Base_Object set_content_map( array $content_map ) Sets the content property of the object.
51+
* @method Base_Object set_icon( array $icon ) Sets the icon property of the object.
52+
* @method Base_Object set_id( string $id ) Sets the object's unique global identifier.
53+
* @method Base_Object set_image( array $image ) Sets the image property of the object.
54+
* @method Base_Object set_name( string $name ) Sets the natural language name of the object.
55+
* @method Base_Object set_origin( string $origin ) Sets the origin property of the object.
56+
* @method Base_Object set_published( string $published ) Sets the date and time the object was published in ISO 8601 format.
57+
* @method Base_Object set_sensitive( bool $sensitive ) Sets the sensitive property of the object.
58+
* @method Base_Object set_summary( string $summary ) Sets the natural language summary of the object.
59+
* @method Base_Object set_summary_map( array|null $summary_map ) Sets the summary property of the object.
60+
* @method Base_Object set_target( string $target ) Sets the target property of the object.
61+
* @method Base_Object set_to( array|string $to ) Sets the primary recipients of the object.
62+
* @method Base_Object set_type( string $type ) Sets the type of the object.
63+
* @method Base_Object set_updated( string $updated ) Sets the date and time the object was updated in ISO 8601 format.
64+
* @method Base_Object set_url( string $url ) Sets the URL of the object.
2165
*/
2266
#[\AllowDynamicProperties]
2367
class Generic_Object {

0 commit comments

Comments
 (0)