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.
	get_alternate_name ()
	Return the alternate name.
	get_email ()
	Return the email.
	get_first_name ()
	Return the first name.
	get_first_name_phonetic ()
	Return the first name phonetic.
	get_full_name ()
	Return the full name.
	get_id ()
	Return the id.
	get_image_alt ()
	Return the image alt.
	get_last_name ()
	Return the last name.
	get_last_name_phonetic ()
	Return the last name phonetic.
	get_middle_name ()
	Return the middle name.
	get_picture_item_id ()
	Return the picture item id.
	is_deleted ()
	Is the author deleted?

Detailed Description

Author class.

Copyright

2019 Ryan Wyllie ryan@.nosp@m.mood.nosp@m.le.co.nosp@m.m

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	$id	ID
int	$pictureitemid	Picture item id
string	$firstname	First name
string	$lastname	Last name
string	$fullname	Full name
string	$email	Email
string | null	$middlename	Middle name
string | null	$firstnamephonetic	Phonetic spelling of first name
string | null	$lastnamephonetic	Phonetic spelling of last name
string | null	$alternatename	Altername name
string | null	$imagealt	Image 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:

• mod/forum/classes/local/entities/author.php