WIKINDX API trunk

PUBLISHER
in package

PUBLISHER

Common routines for dealing with publishers

Table of Contents

Methods

__construct()  : mixed
PUBLISHER
browseMenuArray()  : array<string|int, mixed>
Return array of menu items to browse publishers from under the Resource|Browse menu.
checkExists()  : mixed
Does this publisher already exist in the database?
editMenuArray()  : array<string|int, mixed>
Return array of menu items to edit publishers from under the Resource|Edit menu.
grabAll()  : mixed
Get publishers from publisher. Return associative array of id => type
insert()  : int
Inserts a new publisher into the database.
removeHanging()  : mixed
Remove resource-less or collection-less publishers
transferArrows()  : array<string|int, mixed>
Make the publisher select transfer arrows to transfer publishers between select boxes with onclick

Methods

__construct()

PUBLISHER

public __construct() : mixed

browseMenuArray()

Return array of menu items to browse publishers from under the Resource|Browse menu.

public browseMenuArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

Empty if no publishers

checkExists()

Does this publisher already exist in the database?

public checkExists(string $name, string $location) : mixed

Name must match and location must match if not NULL

Parameters
$name : string
$location : string
Return values
mixed

FALSE|publisher ID

editMenuArray()

Return array of menu items to edit publishers from under the Resource|Edit menu.

public editMenuArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

Empty if no publishers

grabAll()

Get publishers from publisher. Return associative array of id => type

public grabAll([string $type = false ][, int $userBib = false ][, array<string|int, mixed> $typeArray = false ]) : mixed
Parameters
$type : string = false

Default is FALSE

$userBib : int = false

Default is FALSE

$typeArray : array<string|int, mixed> = false

Default is FALSE

Return values
mixed

FALSE|array of publishers

insert()

Inserts a new publisher into the database.

public insert(array<string|int, mixed> $v[, bool &$alreadyExisted = false ][, array<string|int, mixed> &$errs = [] ]) : int

Requires write permissions.

Parameters
$v : array<string|int, mixed>
$alreadyExisted : bool = false

Reference, default is FALSE

$errs : array<string|int, mixed> = []

Reference, default is empty array

Return values
int

New publisher ID

removeHanging()

Remove resource-less or collection-less publishers

public removeHanging() : mixed

transferArrows()

Make the publisher select transfer arrows to transfer publishers between select boxes with onclick

public transferArrows() : array<string|int, mixed>
Return values
array<string|int, mixed>

(toRightImage, toLeftImage)


        
On this page

Search results