PHP Class MenaraSolutions\Geographer\Divisible

Inheritance: implements MenaraSolutions\Geographer\Contracts\IdentifiableInterface, implements ArrayAccess, use trait MenaraSolutions\Geographer\Traits\HasManager, use trait MenaraSolutions\Geographer\Traits\ExposesFields, use trait MenaraSolutions\Geographer\Traits\HasCollection

Show file Open project: menarasolutions/geographer Class Usage Examples

Protected Properties

Property	Type	Description
$exposed	array
$manager	MenaraSolutions\Geographer\Contracts\ManagerInterface
$memberClass	string
$members	MenaraSolutions\Geographer\Collections\MemberCollection
$meta	array
$parentClass	string
$parentCode	string
$standard	string

Public Methods

Method	Description
__construct ( array $meta = [], string $parentCode = null, MenaraSolutions\Geographer\Contracts\ManagerInterface $manager = null )	Country constructor.
build ( integer \| string $id, MenaraSolutions\Geographer\Contracts\ManagerInterface $config = null ) : City
expectsLongNames ( ) : boolean
getCodes ( ) : array
getLongName ( ) : string
getMembers ( ) : MemberCollection
getMeta ( ) : array
getName ( string $locale = null ) : string	Best effort name
getParentCode ( ) : string \| integer
getShortName ( ) : string
parent ( ) : Divisible
translate ( string $locale = null ) : string

Protected Methods

Method	Description
loadMembers ( MemberCollection $collection = null ) : void

Method Details

__construct() public method

Country constructor.

public __construct ( array $meta = [], string $parentCode = null, MenaraSolutions\Geographer\Contracts\ManagerInterface $manager = null )
$meta	array
$parentCode	string
$manager	MenaraSolutions\Geographer\Contracts\ManagerInterface

build() public static method

public static build ( integer \| string $id, MenaraSolutions\Geographer\Contracts\ManagerInterface $config = null ) : City
$id	integer \| string
$config	MenaraSolutions\Geographer\Contracts\ManagerInterface
return	City

expectsLongNames() public method

public expectsLongNames ( ) : boolean
return	boolean

getCodes() public method

public getCodes ( ) : array
return	array

getLongName() public method

public getLongName ( ) : string
return	string

getMembers() public method

public getMembers ( ) : MemberCollection
return	MenaraSolutions\Geographer\Collections\MemberCollection

getMeta() public method

public getMeta ( ) : array
return	array

getName() public method

Best effort name

public getName ( string $locale = null ) : string
$locale	string
return	string

getParentCode() public method

public getParentCode ( ) : string \| integer
return	string \| integer

getShortName() public method

public getShortName ( ) : string
return	string

loadMembers() protected method

protected loadMembers ( MemberCollection $collection = null ) : void
$collection	MenaraSolutions\Geographer\Collections\MemberCollection
return	void

parent() public method

public parent ( ) : Divisible
return	Divisible

translate() public method

public translate ( string $locale = null ) : string
$locale	string
return	string

Property Details

$exposed protected property

protected array $exposed
return	array

$manager protected property

protected ManagerInterface,MenaraSolutions\Geographer\Contracts $manager
return	MenaraSolutions\Geographer\Contracts\ManagerInterface

$memberClass protected property

protected string $memberClass
return	string

$members protected property

protected MemberCollection,MenaraSolutions\Geographer\Collections $members
return	MenaraSolutions\Geographer\Collections\MemberCollection

$meta protected property

protected array $meta
return	array

$parentClass protected static property

protected static string $parentClass
return	string

$parentCode protected property

protected string $parentCode
return	string

$standard protected property

protected string $standard
return	string