class Pile extends ConcreteObject (View source)

Class Pile.

Essentially a user's scrapbook, a pile is an object used for clumping bits of content together around a user account. Piles currently only contain blocks but they could also contain collections. Any bit of content inside a user's pile can be reordered, etc... although no public interface makes use of much of this functionality.

\@package Concrete\Core\Page\Stack\Pile

Properties

$error from ConcreteObject
int $pID
int $uID
bool $isDefault
string $name
string $state
string $timestamp

Methods

loadError($error)

No description

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

static 
camelcase($file)

No description

static 
uncamelcase($string)

No description

bool
isDefault()

No description

string
getPileName()

No description

string
getPileState()

No description

static Pile
create($name)

No description

static Pile
get(int $pID)

No description

static Pile
getOrCreate(string $name)

No description

bool
inPile(Collection|Block $obj)

No description

int
getPileID()

No description

static Pile
getDefault()

No description

static Pile
createDefaultPile()

No description

static array
getMyPiles()

No description

bool
isMyPile()

No description

int
getUserID()

No description

bool
delete()

Delete a pile.

int
getPileLength()

No description

array
getPileContentObjects(string $display = 'display_order')

No description

mixed
add(Page|Block|PileContent $obj, int $quantity = 1)

No description

mixed
getPileContentID(Page $obj)

No description

remove(Page|Block|PileContent $obj, int $quantity = 1)

No description

bool
rescanDisplayOrder()

No description

Details

loadError($error)

Parameters

$error

isError()

getError()

setPropertiesFromArray($arr)

Parameters

$arr

static camelcase($file)

Parameters

$file

static uncamelcase($string)

Parameters

$string

bool isDefault()

Return Value

bool

string getPileName()

Return Value

string

string getPileState()

Return Value

string

static Pile create($name)

Parameters

$name

Return Value

Pile

static Pile get(int $pID)

Parameters

int $pID

Return Value

Pile

static Pile getOrCreate(string $name)

Parameters

string $name

Return Value

Pile

bool inPile(Collection|Block $obj)

Parameters

Collection|Block $obj

Return Value

bool

int getPileID()

Return Value

int

static Pile getDefault()

Return Value

Pile

static Pile createDefaultPile()

Return Value

Pile

static array getMyPiles()

Return Value

array

bool isMyPile()

Return Value

bool

int getUserID()

Return Value

int

bool delete()

Delete a pile.

Return Value

bool

int getPileLength()

Return Value

int

array getPileContentObjects(string $display = 'display_order')

Parameters

string $display

Return Value

array

mixed add(Page|Block|PileContent $obj, int $quantity = 1)

Parameters

Page|Block|PileContent $obj
int $quantity

Return Value

mixed

mixed getPileContentID(Page $obj)

Parameters

Page $obj

Return Value

mixed

remove(Page|Block|PileContent $obj, int $quantity = 1)

Parameters

Page|Block|PileContent $obj
int $quantity

bool rescanDisplayOrder()

Return Value

bool