Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | List of all members
mod_forum\local\entities\author Class Reference

Author class. More...

Public Member Functions

 __construct (int $id, int $pictureitemid, string $firstname, string $lastname, string $fullname, string $email, bool $deleted, string $middlename=null, string $firstnamephonetic=null, string $lastnamephonetic=null, string $alternatename=null, string $imagealt=null)
 Constructor. More...
 
 get_alternate_name ()
 Return the alternate name. More...
 
 get_email ()
 Return the email. More...
 
 get_first_name ()
 Return the first name. More...
 
 get_first_name_phonetic ()
 Return the first name phonetic. More...
 
 get_full_name ()
 Return the full name. More...
 
 get_id ()
 Return the id. More...
 
 get_image_alt ()
 Return the image alt. More...
 
 get_last_name ()
 Return the last name. More...
 
 get_last_name_phonetic ()
 Return the last name phonetic. More...
 
 get_middle_name ()
 Return the middle name. More...
 
 get_picture_item_id ()
 Return the picture item id. More...
 
 is_deleted ()
 Is the author deleted? More...
 

Detailed Description

Author class.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

mod_forum\local\entities\author::__construct ( int  $id,
int  $pictureitemid,
string  $firstname,
string  $lastname,
string  $fullname,
string  $email,
bool  $deleted,
string  $middlename = null,
string  $firstnamephonetic = null,
string  $lastnamephonetic = null,
string  $alternatename = null,
string  $imagealt = null 
)

Constructor.

Parameters
int$idID
int$pictureitemidPicture item id
string$firstnameFirst name
string$lastnameLast name
string$fullnameFull name
string$emailEmail
string | null$middlenameMiddle name
string | null$firstnamephoneticPhonetic spelling of first name
string | null$lastnamephoneticPhonetic spelling of last name
string | null$alternatenameAltername name
string | null$imagealtImage alt

Member Function Documentation

◆ get_alternate_name()

mod_forum\local\entities\author::get_alternate_name ( )

Return the alternate name.

Return values
string|null

◆ get_email()

mod_forum\local\entities\author::get_email ( )

Return the email.

Return values
string

◆ get_first_name()

mod_forum\local\entities\author::get_first_name ( )

Return the first name.

Return values
string

◆ get_first_name_phonetic()

mod_forum\local\entities\author::get_first_name_phonetic ( )

Return the first name phonetic.

Return values
string|null

◆ get_full_name()

mod_forum\local\entities\author::get_full_name ( )

Return the full name.

Return values
string

◆ get_id()

mod_forum\local\entities\author::get_id ( )

Return the id.

Return values
int

◆ get_image_alt()

mod_forum\local\entities\author::get_image_alt ( )

Return the image alt.

Return values
string|null

◆ get_last_name()

mod_forum\local\entities\author::get_last_name ( )

Return the last name.

Return values
string

◆ get_last_name_phonetic()

mod_forum\local\entities\author::get_last_name_phonetic ( )

Return the last name phonetic.

Return values
string|null

◆ get_middle_name()

mod_forum\local\entities\author::get_middle_name ( )

Return the middle name.

Return values
string|null

◆ get_picture_item_id()

mod_forum\local\entities\author::get_picture_item_id ( )

Return the picture item id.

Return values
int

◆ is_deleted()

mod_forum\local\entities\author::is_deleted ( )

Is the author deleted?

Return values
bool

The documentation for this class was generated from the following file: