Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MNT Update @methods on class docblocks #734

Merged
merged 1 commit into from
Dec 14, 2023
Merged

MNT Update @methods on class docblocks #734

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/Model/Blog.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@
/**
* Blog Holder
*
* @method HasManyList Tags() List of tags in this blog
* @method HasManyList Categories() List of categories in this blog
* @method ManyManyList Editors() List of editors
* @method ManyManyList Writers() List of writers
* @method ManyManyList Contributors() List of contributors
* @method HasManyList<BlogCategory> Categories()
* @method ManyManyList<Member> Contributors()
* @method ManyManyList<Member> Editors()
* @method HasManyList<BlogTag> Tags()
* @method ManyManyList<Member> Writers()
*/
class Blog extends Page implements PermissionProvider
{
Expand Down
3 changes: 2 additions & 1 deletion src/Model/BlogCategory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@
* A blog category for generalising blog posts.
*
*
* @method Blog Blog()
*
* @property string $Title
* @property string $URLSegment
* @property int $BlogID
* @method Blog Blog()
* @method SilverStripe\ORM\ManyManyList<BlogPost> BlogPosts()
*/
class BlogCategory extends DataObject implements CategorisationObject
{
Expand Down
2 changes: 2 additions & 0 deletions src/Model/BlogMemberExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
/**
* This class is responsible for add Blog specific behaviour to Members.
*
* @method SilverStripe\ORM\ManyManyList<BlogPost> BlogPosts()
* @method Image BlogProfileImage()
*/
class BlogMemberExtension extends DataExtension
{
Expand Down
10 changes: 4 additions & 6 deletions src/Model/BlogPost.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,15 @@
/**
* An individual blog post.
*
* @method ManyManyList Categories()
* @method ManyManyList Tags()
* @method ManyManyList Authors()
* @method Blog Parent()
* @method Image FeaturedImage()
*
* @property string $PublishDate
* @property string $AuthorNames
* @property string $Summary
* @property int $ParentID
* @property int $FeaturedImageID
* @method ManyManyList<Member> Authors()
* @method ManyManyList<BlogCategory> Categories()
* @method Image FeaturedImage()
* @method ManyManyList<BlogTag> Tags()
*/
class BlogPost extends Page
{
Expand Down
5 changes: 2 additions & 3 deletions src/Model/BlogTag.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,11 @@
/**
* A blog tag for keyword descriptions of a blog post.
*
*
* @method Blog Blog()
*
* @property string $Title
* @property string $URLSegment
* @property int $BlogID
* @method Blog Blog()
* @method SilverStripe\ORM\ManyManyList<BlogPost> BlogPosts()
*/
class BlogTag extends DataObject implements CategorisationObject
{
Expand Down