Plentymarkets interface documentation

User

Contracts

UserRepositoryContract

Namespace

Plenty\Modules\User\Contracts

Methods

public getAll():Illuminate\Database\Eloquent\Collection

Return type: `Collection`

Get all users

public getCurrentUser():Plenty\Modules\User\Models\User

Return type: `User`

Get current user

public getUserById($userId):Plenty\Modules\User\Models\User

Return type: `User`

Get user by given user id

**Parameters**
Name	Type	Description
`$userId`	int

public getUserByEmail($email):Plenty\Modules\User\Models\User

Return type: `User`

Get user by given user id

**Parameters**
Name	Type	Description
`$email`	string

public getUserByStatus($status):Illuminate\Database\Eloquent\Collection

Return type: `Collection`

Get all users by given status

**Parameters**
Name	Type	Description
`$status`	int

public getAllPinUsers($clientName = null, $clientSecret = null):Illuminate\Database\Eloquent\Collection

Return type: `Collection`

Get all users with a pin

**Parameters**
Name	Type	Description
`$clientName`	string
`$clientSecret`	string

public findByName($name):Illuminate\Database\Eloquent\Collection

Return type: `Collection`

**Parameters**
Name	Type	Description
`$name`	string

public setBackendPluginSet($userId, $setId):bool

Sets the selected PluginSet for a given user's backend

**Parameters**
Name	Type	Description
`$userId`	int
`$setId`	int

public getBackendPluginSet($userId):Plenty\Modules\Plugin\PluginSet\Models\PluginSet

Return type: `PluginSet`

Gets the selected PluginSet for a given user's backend

**Parameters**
Name	Type	Description
`$userId`	int

Models

User

Namespace

Plenty\Modules\User\Models

Properties
Name	Type	Description
id	int
user	string
realName	string
lang	string
ipLimit	string
ustatus	bool
memberId	int
timestamp	string
email	string
timezone	string
googleEmail	string
skype	string
ical	string
psConfig	bool
psItem	bool
psEbay	bool
psStock	bool
psCustomer	bool
psOrder	bool
psStats	bool
psData	bool
pcConfig	bool
pcContent	bool
pcNewsletter	bool
pcLayout	bool
pcDialog	bool
pcStats	bool
pcData	bool
pcBlog	bool
signature	string
color	string
eks	bool
payments	bool
acceptAgb	int
api	bool
image	string
delOrder	bool
delArticle	bool
delRecord	bool
plentystat	bool
plentyconnect	bool
webspaceAccess	bool
accessControlList	string
plentymarketsShippingOrderId	bool
plentymarketsShippingItem	bool
plentymarketsShippingAuto	bool
plentymarketsShippingLabel	bool
plentymarketsShippingConfig	bool
warehouseId	int
calendar	bool
orderStatus	string
warehouseRepairId	int
project	bool
ticket	bool
order	bool
blog	bool
lead	bool
customer	bool
totalVacationDays	float
roleId	int
salutation	string
dataLang	string
disabled	bool
scheduler	bool
item	bool
incomingItems	bool
backendPluginSetId	int	The ID of the user’s selected backend set

Methods

public toArray()

Returns this model as an array.

Plentymarkets interface documentation

User

Contracts

UserRepositoryContract

Namespace

Methods

Return type: Collection

Return type: User

Return type: User

Return type: User

Return type: Collection

Return type: Collection

Return type: Collection

Return type: PluginSet

Models

User

Namespace

Methods

Is this page helpful?

Is this page helpful?

Return type: `Collection`

Return type: `User`

Return type: `User`

Return type: `User`

Return type: `Collection`

Return type: `Collection`

Return type: `Collection`

Return type: `PluginSet`