Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
Avatar Class Reference
Inheritance diagram for Avatar:
CourseAvatar LicenseAvatar InstituteAvatar StudygroupAvatar

Public Member Functions

 getAvatarDirectoryUrl ()
 
 getAvatarDirectoryPath ()
 
 getCustomAvatarUrl ($size, $ext= 'png')
 
 getCustomAvatarPath ($size, $ext= 'png', $retina=false)
 
 getFilename ($size, $ext= 'png')
 
 getURL ($size, $ext= 'png')
 
 is_customized ()
 
 getImageTag ($size=Avatar::MEDIUM, $opt=[])
 
 createFromUpload ($userfile)
 
 createFrom ($filename)
 
 reset ()
 
 getDefaultTitle ()
 

Static Public Member Functions

static getAvatar ($id)
 
static getNobody ()
 
static getDimension ($size)
 
static error_handler ($errno, $errstr, $errfile, $errline)
 

Data Fields

const ORIGINAL = 'original'
 
const NORMAL = 'normal'
 
const MEDIUM = 'medium'
 
const SMALL = 'small'
 
const MAX_FILE_SIZE = 10485760
 
const NOBODY = 'nobody'
 

Protected Member Functions

 __construct ($user_id, $username=null)
 
 getCssClass ($size)
 
 checkAvatarVisibility ()
 
 sanitizeOrientation ($filename)
 

Protected Attributes

 $user_id
 
 $username
 

Constructor & Destructor Documentation

__construct (   $user_id,
  $username = null 
)
protected

Constructs a new Avatar object belonging to a user with the given id.

Parameters
stringthe user's id
stringthe user's username (optional)
Returns
void

Member Function Documentation

checkAvatarVisibility ( )
protected

Return if avatar is visible to the current user. Also set the user_id of avatar to nobody if not visible to current user.

Returns
boolean: true if visible
createFrom (   $filename)

Creates thumbnails from an image.

Parameters
stringfilename of the image to create thumbnails from
Returns
void
createFromUpload (   $userfile)

Creates all the different sized thumbnails for an uploaded file.

Parameters
stringthe key of the uploaded file, see documentation about $_FILES
Returns
void
Exceptions
severalExceptions if the uploaded file does not satisfy the requirements
static error_handler (   $errno,
  $errstr,
  $errfile,
  $errline 
)
static
static getAvatar (   $id)
static

Returns an avatar object of the appropriate class.

Parameters
stringthe user's id
stringthe user's username (optional)
Returns
Avatar the user's avatar.
getAvatarDirectoryPath ( )
getAvatarDirectoryUrl ( )
getCssClass (   $size)
protected

Returns the CSS class to use for this avatar image.

Parameters
stringone of the constants Avatar::(NORMAL|MEDIUM|SMALL)
Returns
string CSS class to use for the avatar
getCustomAvatarPath (   $size,
  $ext = 'png',
  $retina = false 
)
getCustomAvatarUrl (   $size,
  $ext = 'png' 
)
getDefaultTitle ( )

Return the default title of the avatar.

Returns
string the default title
static getDimension (   $size)
static

Return the dimension of a size

Parameters
stringthe dimension of a size
Returns
array a tupel of integers [width, height]
getFilename (   $size,
  $ext = 'png' 
)

Returns the file name of a user's avatar.

Parameters
stringone of the constants Avatar::(NORMAL|MEDIUM|SMALL)
stringan optional extension of the avatar
Returns
string the absolute file path to the avatar
getImageTag (   $size = Avatar::MEDIUM,
  $opt = [] 
)

Constructs a desired HTML image tag for an Avatar. Additional html attributes may also be specified using the $opt parameter.

Parameters
stringone of the constants Avatar::(NORMAL|MEDIUM|SMALL)
arrayarray of attributes to add to the HTML image tag
Returns
string returns the HTML image tag
static getNobody ( )
static

Returns an avatar object for "nobody".

Returns
Avatar the user's avatar.
getURL (   $size,
  $ext = 'png' 
)

Returns the URL of a user's picture.

Parameters
stringone of the constants Avatar::(NORMAL|MEDIUM|SMALL)
stringan optional extension of the user's picture
Returns
string the URL to the user's picture
is_customized ( )

Returns whether a user has uploaded a custom picture.

Returns
boolean returns TRUE if the user customized her picture, FALSE otherwise.
reset ( )

Removes all uploaded pictures of a user.

sanitizeOrientation (   $filename)
protected

Corrects the orientation of images from iOS/OS X devices which might lead to a rotated image. EXIF information is checked and when the orientation is set by EXIF data, we rotate the image accordingly.

Parameters
string$filenameFilename of the image to correct

Field Documentation

$user_id
protected
$username
protected
const MAX_FILE_SIZE = 10485760

This constant represents the maximal size of a user picture in bytes.

const MEDIUM = 'medium'

This constant stands for a medium size of a user picture.

const NOBODY = 'nobody'

This constant holds the username and ID of the "nobody" avatar.

const NORMAL = 'normal'

This constant stands for the maximal size of a user picture.

const ORIGINAL = 'original'

This constant stands for the maximal size of a user picture.

const SMALL = 'small'

This constant stands for an icon size of a user picture.


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