GuestAvatar

class OC\Avatar\GuestAvatar
This class represents a guest user’s avatar.
Source:lib/private/Avatar/GuestAvatar.php#35
Parent:OC\Avatar\Avatar

Properties

Methods

public OC\Avatar\GuestAvatar::__construct($userDisplayName, $logger)
GuestAvatar constructor.
Source:

lib/private/Avatar/GuestAvatar.php#49

Parameters:
  • $userDisplayName (string) The guest user display name
  • $logger (Psr\Log\LoggerInterface) The logger
public OC\Avatar\GuestAvatar::exists()
Tests if the user has an avatar.
Source:lib/private/Avatar/GuestAvatar.php#59
Returns:bool Guests always have an avatar.
public OC\Avatar\GuestAvatar::getDisplayName()
Returns the guest user display name.
Source:lib/private/Avatar/GuestAvatar.php#68
Returns:string
public OC\Avatar\GuestAvatar::set($data)
Setting avatars isn’t implemented for guests.
Source:

lib/private/Avatar/GuestAvatar.php#78

Parameters:
Returns:

void

public OC\Avatar\GuestAvatar::remove()
Removing avatars isn’t implemented for guests.
Source:lib/private/Avatar/GuestAvatar.php#85
public OC\Avatar\GuestAvatar::getFile($size)
Generates an avatar for the guest.
Source:

lib/private/Avatar/GuestAvatar.php#95

Parameters:
  • $size (int) The desired image size.
Returns:

\OCP\Files\SimpleFS\InMemoryFile

public OC\Avatar\GuestAvatar::userChanged($feature, $oldValue, $newValue)
Updates the display name if changed.
Source:

lib/private/Avatar/GuestAvatar.php#108

Parameters:
  • $feature (string) The changed feature
  • $oldValue (mixed) The previous value
  • $newValue (mixed) The new value
Returns:

void

public OC\Avatar\GuestAvatar::isCustomAvatar()
Guests don’t have custom avatars.
Source:lib/private/Avatar/GuestAvatar.php#119
Returns:bool