MetaFox

User extends User

in package

• MetaFox

implements User, PrivacyList, IsActivitySubscriptionInterface, ActivityFeedSource, IsPrivacyItemInterface, PostBy, LdapAuthenticatable, IsNotifiable, HasUserProfile, UserHasValuePermission, CanResetPassword, HasGlobalSearch, HasTimelineAlbum, HasApprove, HasFeature Uses Notifiable, HasApiTokens, HasRoles, HasNestedAttributes, HasFactory, AuthenticatesWithLdap, UserHasValuePermissionTrait, CanResetPasswordTrait, HasUser, MustVerify

Class User.

Tags

mixin

Builder

SuppressWarnings

(PHPMD.CouplingBetweenObjects)

SuppressWarnings

(PHPMD.CamelCasePropertyName)

Table of Contents

Interfaces

User

Interface User.

PrivacyList

Interface Entity.

IsActivitySubscriptionInterface

ActivityFeedSource

Interface ActivityFeedSource.

IsPrivacyItemInterface

PostBy

LdapAuthenticatable

IsNotifiable

Interface IsNotifiable.

HasUserProfile

Interface HasUserProfile.

UserHasValuePermission

CanResetPassword

HasGlobalSearch

Interface HasGlobalSearch.

HasTimelineAlbum

Interface HasTimelineAlbum

HasApprove

Interface HasApprove

HasFeature

Interface HasFeature.

Constants

ENTITY_TYPE  = 'user'

USER_AVATAR_SIGN_UP  = 'user_signup_avatar'

USER_UPDATE_AVATAR_ENTITY_TYPE  = 'user_update_avatar'

USER_UPDATE_COVER_ENTITY_TYPE  = 'user_update_cover'

USER_UPDATE_INFORMATION_ENTITY_TYPE  = 'user_update_information'

USER_UPDATE_RELATIONSHIP_ENTITY_TYPE  = 'user_update_relationship'

DEFAULT_TAB_ABOUT  = 'about'

DEFAULT_TAB_HOME  = 'home'

Properties

$approve_status  : string

$created_at  : string

$email  : string

$email_verified_at  : mixed|null

$first_name  : string|null

$full_name  : string

$full_name_raw  : string

$id  : int

$incrementing  : mixed

$is_approved  : int

$is_featured  : bool

$is_invisible  : bool

$last_name  : string|null

$nestedAttributes  : array<string|int, mixed>

$password  : string

$phone_number  : string

$phone_number_verified_at  : mixed|null

$profile  : UserProfile

$total_friend  : int

$updated_at  : string

$user_name  : string

$userActivity  : UserActivity

$verified_at  : mixed|null

$casts  : array<string, string>

The attributes that should be cast to native types.

$fillable  : array<string|int, string>

The attributes that are mass assignable.

$guard_name  : string

This is use for roles, permissions. Please do not remove this.

$hidden  : array<string|int, string>

The attributes that should be hidden for arrays.

$nestedAttributesFor  : array<string|int, mixed>

Defined nested attributes.

Methods

canBeBlocked()  : bool

Determine if resource can be blocked.

checkContentShareable()  : bool

checkPostBy()  : bool

customProfile()  : array<string|int, mixed>

entityId()  : int

entityType()  : string

factory()  : UserFactory

fill()  : static

Fill the model with an array of attributes.

findForPassport()  : User|null

Find the user instance for the given username.

getApprovedMessage()  : string|null

getDeclinedMessage()  : string|null

getDefaultTabMenu()  : string

getDescriptionAttribute()  : mixed

getEmailOptionForPasswordReset()  : array<string|int, mixed>|null

getFullNameAttribute()  : string

getFullNameRawAttribute()  : string

getItemPrivacy()  : int|null

getNestedAttributesFor()  : array<string|int, mixed>

Get accept nested attributes.

getOwnerAttribute()  : mixed

getOwnerEntityAttribute()  : mixed

getPendingMessage()  : string|null

getPhoneNumberOptionForPasswordReset()  : array<string|int, mixed>|null

getPrivacyPostBy()  : int

Get privacy base on owner's requirement Page => 0 (public) Group => privacy_item User => 1 (friend).

getProfileAttribute()  : mixed

getRepresentativePrivacy()  : int|null

getRepresentativePrivacyDetail()  : array<string|int, mixed>|null

getResetMethods()  : array<string|int, mixed>

getRole()  : Role|null

getSharedFeedAvatarTypeIdAttribute()  : string

getSharedFeedCoverTypeIdAttribute()  : string

getSmallestRoleId()  : int

getTotalCommentAttribute()  : int

getTotalReplyAttribute()  : int

getUserAttribute()  : mixed

getUserDescription()  : string

getUserEntityAttribute()  : mixed

hasAdminRole()  : bool

hasContentPrivacy()  : bool

hasEmailAddress()  : bool

Check if the user has an associated email address.

hasFeedDetailPage()  : bool

hasNamedNotification()  : null|string

hasPendingMode()  : bool

hasPermissionValue()  : bool

hasPhoneNumber()  : bool

Check if the user has an associated phone number.

hasRemoveFeed()  : bool

hasRole()  : bool

hasStaffRole()  : bool

hasSuperAdminRole()  : bool

hasValuePermissionViaRole()  : bool

hasVerified()  : bool

Determine if the user has verified their account.

isApproved()  : bool

isDeleted()  : bool

isGuest()  : bool

isNotApproved()  : bool

isPendingMode()  : bool|null

isTaggingAllowed()  : bool

markAsVerified()  : void

Mark the user as verified.

mustVerify()  : bool

Check whether the user needs to verify their registered email / phone number.

mustVerifyEmailAddress()  : bool

Check whether the user needs to verify their email address.

mustVerifyPhoneNumber()  : bool

Check whether the user needs to verify their phone number.

notificationEmail()  : string

notificationFullName()  : string

notificationPhoneNumber()  : string

notificationUserName()  : string

notify()  : void

Send the given notification.

notifyNow()  : void

Send the given notification immediately.

owner()  : mixed

ownerEntity()  : mixed

ownerId()  : int

ownerType()  : string

preferredLocale()  : string|null

profile()  : HasOne

resetTokens()  : HasMany

revokeAllTokens()  : void

routeNotificationFor()  : mixed

Get the notification routing information for the given driver.

save()  : bool

Save the model to the database.

sendPasswordResetNotification()  : void

Send the password reset notification.

sendPasswordResetToken()  : void

shouldVerifyEmailAddress()  : bool

Check whether the user should to verify their email address.

shouldVerifyPhoneNumber()  : bool

Check whether the user should to verify their phone number.

syncHasManyRelationAttribute()  : bool

Save the hasMany nested relation attributes to the database.

syncHasOneRelationAttribute()  : bool

toActivityFeed()  : FeedAction|null

toActivitySubscription()  : array<string|int, int>

This method must return [$userId, $ownerId] $userId: who subscribe $ownerId: whom subscribe from When $owner post content on profile, $userId can see $owner feed.

toApprovedNotification()  : array<string|int, mixed>

toDeclinedContentLink()  : string|null

toDeclinedContentUrl()  : string|null

toLink()  : string|null

toOGDescription()  : string|null

toPaymentSettingUrl()  : string

toPrivacyItem()  : array<string|int, mixed>

Result [ [$userId, $itemId, $itemType, $privacyType] ] $userId: to Insert into privacy_data $itemId: $itemType, $privacyType: to find privacy_id.

toPrivacyLists()  : array<string|int, mixed>

toRouter()  : string|null

toSearchable()  : array<string|int, mixed>|null

toSitemapUrl()  : string|null

toTitle()  : string

toUrl()  : string|null

toUserResource()  : array<string, mixed>

transformRole()  : string

user()  : mixed

userActivity()  : HasOne

userEntity()  : mixed

userId()  : int

userType()  : string

validateForPassportPasswordGrant()  : bool

validatePassword()  : bool

allowDestroyNestedAttributes()  : bool

Check can we delete nested data.

newFactory()  : UserFactory

normalizeRoles()  : array<string|int, mixed>