WIKINDX API trunk

BIBLIOGRAPHYCOMMON
in package

Common methods for user bibliographies

Table of Contents

Properties

$bailOut  : mixed
boolean

Methods

__construct()  : mixed
BIBLIOGRAPHYCOMMON
checkValidBibliography()  : bool
check this user can edit and delete bibliographies
createEditBibInit()  : string
Display bibs settings for creating and editing Called from e.g., MYWIKINDX and ADMINBIBS
createUserBib()  : array<string|int, mixed>
create or edit a user/group bibliography Called from e.g., MYWIKINDX and ADMINBIBS
deleteBib()  : mixed
Delete bibliography
displayBib()  : string
Display bibliography being browsed
editBibGet()  : array<string|int, mixed>
Populate $formData with bib details if editing
getBibDetails()  : string
Display bibliography details and owner's details
getBibsArray()  : array<string|int, mixed>
Get an array of all available bibliographies inc. the MASTER bibliography grouped for different types
getGroupBibs()  : array<string|int, mixed>
Get group bibliographies
getOtherBibs()  : array<string|int, mixed>
Get other users' bibliographies (typically available to superadmin only)
getUserBibs()  : array<string|int, mixed>
Get user bibliographies
limitBibSelectBox()  : string
Create the select box for limiting browsing, insert citation to a single bibliography
transferArrows()  : array<string|int, mixed>
Make the bibliography select transfer arrows to transfer bibliographies between select boxes with onclick
userBibCondition()  : bool
Set a SQL condition clause if we are browsing a user bibliography to ensure that listed, selected or searched resources come only from that user bibliography.

Properties

Methods

checkValidBibliography()

check this user can edit and delete bibliographies

public checkValidBibliography(string $bibId[, bool $admin = false ]) : bool
Parameters
$bibId : string
$admin : bool = false

= FALSE

Return values
bool

createEditBibInit()

Display bibs settings for creating and editing Called from e.g., MYWIKINDX and ADMINBIBS

public createEditBibInit(string $formHeader, array<string|int, mixed> $groups, array<string|int, mixed> $users[, array<string|int, mixed> $formData = [] ][, int $bibId = 0 ][, bool $admin = false ][, mixed $message = false ]) : string
Parameters
$formHeader : string
$groups : array<string|int, mixed>
$users : array<string|int, mixed>
$formData : array<string|int, mixed> = []

= []

$bibId : int = 0

= 0

$admin : bool = false

= FALSE

$message : mixed = false
Return values
string

createUserBib()

create or edit a user/group bibliography Called from e.g., MYWIKINDX and ADMINBIBS

public createUserBib([int $bibId = 0 ]) : array<string|int, mixed>
Parameters
$bibId : int = 0

= 0

Return values
array<string|int, mixed>

deleteBib()

Delete bibliography

public deleteBib(int $bibId) : mixed
Parameters
$bibId : int

displayBib()

Display bibliography being browsed

public displayBib([bool $hint = false ]) : string
Parameters
$hint : bool = false

Default is FALSE

Return values
string

editBibGet()

Populate $formData with bib details if editing

public editBibGet(int $bibId[, bool $admin = false ]) : array<string|int, mixed>
Parameters
$bibId : int
$admin : bool = false

= FALSE

Return values
array<string|int, mixed>

getBibDetails()

Display bibliography details and owner's details

public getBibDetails([mixed $bibId = false ]) : string
Parameters
$bibId : mixed = false

Default FALSE

Return values
string

getBibsArray()

Get an array of all available bibliographies inc. the MASTER bibliography grouped for different types

public getBibsArray([bool $populated = false ][, bool $otherBibs = false ][, bool $owned = false ]) : array<string|int, mixed>
Parameters
$populated : bool = false

Default = FALSE

$otherBibs : bool = false

Default = FALSE

$owned : bool = false

Default FALSE (TRUE if we want only group bibs this user owns)

Return values
array<string|int, mixed>

getGroupBibs()

Get group bibliographies

public getGroupBibs([bool $populated = false ][, bool $owned = false ]) : array<string|int, mixed>
Parameters
$populated : bool = false

Default = FALSE

$owned : bool = false

Default FALSE (TRUE if we want only group bibs this user owns)

Return values
array<string|int, mixed>

getOtherBibs()

Get other users' bibliographies (typically available to superadmin only)

public getOtherBibs([bool $populated = false ]) : array<string|int, mixed>
Parameters
$populated : bool = false

Default = FALSE

Return values
array<string|int, mixed>

getUserBibs()

Get user bibliographies

public getUserBibs([bool $populated = false ]) : array<string|int, mixed>
Parameters
$populated : bool = false

Default = FALSE

Return values
array<string|int, mixed>

limitBibSelectBox()

Create the select box for limiting browsing, insert citation to a single bibliography

public limitBibSelectBox(string $listType[, string $queryString = '' ]) : string
Parameters
$listType : string
$queryString : string = ''

= ''

Return values
string

transferArrows()

Make the bibliography select transfer arrows to transfer bibliographies between select boxes with onclick

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

(toRightImage, toLeftImage)

userBibCondition()

Set a SQL condition clause if we are browsing a user bibliography to ensure that listed, selected or searched resources come only from that user bibliography.

public userBibCondition([int $joinField = false ]) : bool
Parameters
$joinField : int = false

The resource ID field on which to join the user_bibliography_resource table. Default is FALSE

Return values
bool —

TRUE if a bibliography condition was set


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results