Elgg  Version 4.3
Functions | Variables
Elgg\Traits\Entity Namespace Reference

Functions

 setProfileData (string $profile_field_name, $value, int $access_id=ACCESS_PRIVATE)
 Store profile data. More...
 
 getProfileData (string $profile_field_name)
 Get profile data. More...
 
 getAllProfileAnnotations ()
 Returns all profile annotations. More...
 
 deleteProfileData (string $profile_field_name)
 Remove profile data. More...
 

Variables

trait ProfileData
 Adds methods to save profile data to an ElggEntity. More...
 

Function Documentation

Elgg\Traits\Entity\deleteProfileData ( string  $profile_field_name)

Remove profile data.

Parameters
string$profile_field_namethe profile field name to remove
Returns
bool

Definition at line 134 of file ProfileData.php.

Elgg\Traits\Entity\getAllProfileAnnotations ( )
protected

Returns all profile annotations.

Returns
array

Definition at line 101 of file ProfileData.php.

Elgg\Traits\Entity\getProfileData ( string  $profile_field_name)

Get profile data.

Parameters
string$profile_field_nameprofile field name
Returns
null|mixed null if no profile data was found

Definition at line 58 of file ProfileData.php.

Elgg\Traits\Entity\setProfileData ( string  $profile_field_name,
  $value,
int  $access_id = ACCESS_PRIVATE 
)

Store profile data.

Parameters
string$profile_field_nameprofile field name
mixed$valueprofile data
int$access_idaccess of the profile data
Returns
void

Definition at line 27 of file ProfileData.php.

Variable Documentation

trait Elgg::Traits::Entity\ProfileData
Initial value:
{
protected $_profile_data = []

Adds methods to save profile data to an ElggEntity.

Data is stored in Annotations (and Metadata for BC reasons)

Since
3.1

Definition at line 11 of file ProfileData.php.