Inheritance diagram for User:

Description

A Shopify+ store staff account.

Immutable:: Cannot be modified via the API.

See also: https://shopify.dev/docs/admin-api/rest/reference/plus/user

Public Properties
const	PERM_APPLICATIONS = 'applications'

const	PERM_CUSTOMERS = 'customers'

const	PERM_DASHBOARD = 'dashboard'

const	PERM_FULL = 'full'

const	PERM_GIFT_CARDS = 'gift_cards'

const	PERM_LINKS = 'links'

const	PERM_MARKETING = 'marketing'

const	PERM_ORDERS = 'orders'

const	PERM_PAGES = 'pages'

const	PERM_PREFERENCES = 'preferences'

const	PERM_PRODUCTS = 'products'

const	PERM_REPORTS = 'reports'

const	PERM_THEMES = 'themes'

const	TYPE_COLLABORATOR = 'collaborator'

const	TYPE_INVITED = 'invited'

const	TYPE_REGULAR = 'regular'

const	TYPE_RESTRICTED = 'restricted'

Public Properties inherited from AbstractEntity
const	DIR = ''
	All subclasses must redeclare this to match their REST directory (without container). More...

const	TYPE = ''
	All subclasses must redeclare this to match their types. More...

Public Properties inherited from Data
const	MAP = []

const	PATCH = []

Public Methods
magic string	getBio ()

magic string	getEmail ()

magic string	getFirstName ()

magic string	getIm ()

magic string	getLastName ()

magic string	getLocale ()

magic string[]	getPermissions ()

magic string	getPhone ()

magic int	getReceiveAnnouncements ()
	`0\|1` More...

magic string	getUrl ()

magic string	getUserType ()

magic bool	hasPermissions ()

magic bool	isAccountOwner ()

Public Methods inherited from AbstractEntity
string	__toString ()

null string	getId ()

string[]	getPoolKeys ()

bool	hasId ()

$this	reload ()
	Fully reloads the entity from Shopify. More...

Public Methods inherited from Data
mixed	__call (string $method, array $args)

	__construct ($caller, array $data=[])

string	serialize ()
	Dehydrated JSON encode. More...

array	toArray ()

void	unserialize ($serialized)

Additional Inherited Members
Protected Properties inherited from Data
Api	$api

Pool	$pool

Public Static Methods inherited from AbstractEntity
static null self	load ($caller, string $id, array $query=[])

static self[]	loadAll ($caller, string $path, array $query=[])

Protected Methods inherited from AbstractEntity
null AbstractEntity	_container ()
	The container/owner object, if any. More...

mixed	_get (string $field)
	Lazy-loads missing fields. More...

void	_onDelete ()

void	_onSave ()

void	_reload (string $field)

Protected Methods inherited from Data
mixed	_hydrate (string $class, $item)
	A factory that also hydrates / caches entities. More...

array	_select ($subject, callable $filter,... $args)
	Magic method: `selectField(callable $filter)` More...

$this	_setData (array $data)
	Clears all diffs and sets all data, hydrating mapped fields. More...

$this	_setField (string $field, $value)
	Sets a value, hydrating if mapped, and clears the diff. More...

Methods

◆ getBio()

magic string getBio ( )

Returns: string

◆ getEmail()

magic string getEmail ( )

Returns: string

◆ getFirstName()

magic string getFirstName ( )

Returns: string

◆ getIm()

magic string getIm ( )

Returns: string

◆ getLastName()

magic string getLastName ( )

Returns: string

◆ getLocale()

magic string getLocale ( )

Returns: string

◆ getPermissions()

magic string [] getPermissions ( )

Returns: string[]

◆ getPhone()

magic string getPhone ( )

Returns: string

◆ getReceiveAnnouncements()

magic int getReceiveAnnouncements ( )

0|1

Returns: int

◆ getUrl()

magic string getUrl ( )

Returns: string

◆ getUserType()

magic string getUserType ( )

Returns: string

◆ hasPermissions()

magic bool hasPermissions ( )

Returns: bool

◆ isAccountOwner()

magic bool isAccountOwner ( )

Returns: bool