Paper Class Reference

Inheritance diagram for Paper:

Public Member Functions
	Paper ($data)
	getId ()
	getCCVId ()
	getBibTexId ()
	getCategory ()
	getDescription ()
	getTags ()
	getTitle ()
	getStatus ()
	getAccessId ()
	getCreatedBy ()
	getAccess ()
	isPublished ()
	getUrl ()
	getAuthors ($evaluate=true, $cache=true)
	getAuthorNames ()
	generateOldSyncCache ()
	syncAuthors ($massSync=false)
	belongsToProject ($project)
	getProjects ()
	getTopProjects ()
	getProjectNames ()
	getJournal ()
	getUniversities ()
	isGrandRelated ()
	getDate ()
	getYear ()
	getType ()
	getCCVType ()
	getStructure ()
	getVenue ()
	getData ($field=null)
	isDeleted ()
	getCitationFormat ()
	getCitation ($showStatus=true, $showPeerReviewed=true, $hyperlink=true, $wrapAuthors=false)
	formatCitation ($matches, $showStatus=true, $showPeerReviewed=true, $hyperlink=true, $wrapAuthors=false)
	getCompleteness ()
	create ()
	update ()
	delete ()
	toArray ()
	toBibTeX ()
	exists ()
	getCacheId ()
Static Public Member Functions
static	newFromId ($id)
static	newFromCCVId ($ccv_id)
static	newFromBibTeXId ($bibtex_id, $title="")
static	newFromIds ($ids, $onlyPublic=true)
static	newFromTitle ($title, $category="%", $type="%", $status="%")
static	getByIds ($ids)
static	countByCategory ($category='all')
static	getAllPapers ($project='all', $category='all', $grand='grand', $onlyPublic=true, $access='Public', $start=0, $count=9999999999)
static	getAllPapersDuring ($project='all', $category='all', $grand='grand', $startRange=false, $endRange=false, $strict=true, $onlyPublic=true)
static	generateIllegalAuthorsCache ()
static	generateProductProjectsCache ()
static	generateProductTagsCache ()
static	getAllTags ()
static	generateTopProductsCache ()
static	structure ()
static	getAllAuthors ()
static	getPublicationTypes ()
static	getCategoryTypes ($category)
static	getAllMiscTypes ($category="%")
Public Attributes
	$id
	$category
	$description
	$tags
	$title
	$type
	$projects = array()
	$date
	$venue
	$status
	$authors
	$data = array()
	$lastModified
	$authorsWaiting
	$projectsWaiting
	$deleted
	$access_id = 0
	$access = "Forum"
	$created_by = 0
	$ccv_id
	$bibtex_id
Static Public Attributes
static	$structure = null
static	$illegalAuthorsCache = array()
static	$oldSyncCache = array()
static	$cache = array()
static	$dataCache = array()
static	$productProjectsCache = array()
static	$productTagsCache = array()
static	$topProductsCache = array()

Member Function Documentation

Paper::belongsToProject ( $ project )

Returns whether or not this Paper belongs to the specified Project

Parameters:

Project

$project The project to check

Returns:: boolean Whether or not this Paper belongs to the specifed Project

static Paper::countByCategory ( $ category = 'all' ) [static]

Returns the number of Products there are of the specified type

Parameters:

string

$category The category of Product. If 'all' then look at all products

Returns:: integer The number of Products there are of the specified type

Paper::create ( )

Creates a new record in the DB for this BackboneModel

Returns:: boolean Returns whether or not the creation was successful or not

Reimplemented from BackboneModel.

Paper::delete ( )

Deletes the record in the DB for this BackboneModel

Returns:: boolean Returns whether or not the deletion was successful or not

Reimplemented from BackboneModel.

Paper::exists ( )

Returns whether or not this BackboneModel exists or not

Returns:: boolean Returns whether or not this BackboneModel exists or not

Reimplemented from BackboneModel.

Paper::generateOldSyncCache ( )

Generates a cache so that when a sync is being done it knows what the previous state was

Paper::getAccess ( )

Returns the access level of this Paper (either 'Public' or 'Forum')

Returns:: string The access level of this Paper

Paper::getAccessId ( )

Returns the id of the Person who has access to this Paper (0 if everyone)

Returns:: integer The id of the Person who has access to this Paper

static Paper::getAllAuthors ( ) [static]

Returns an array of all the unique authors in the DB

Returns:: array All the unique authors in the DB

static Paper::getAllPapers	(	$	project = `'all'`,
		$	category = `'all'`,
		$	grand = `'grand'`,
		$	onlyPublic = `true`,
		$	access = `'Public'`,
		$	start = `0`,
		$	count = `9999999999`
	)			`[static]`

Returns all of the Products in the database

Parameters:

	Project	$project Specifies which project the returned Products should be associated with
	string	$category Specifies which category the returned Products should be of('Publication', 'Artifact' etc.)
	string	$grand Whether to include grand-only, non-grand-only or both
	boolean	$onlyPublic Whether or not to only include Products with access_id = 0
	string	$access Whether to include 'Forum' or 'Public' access
	integer	$start The index to start at
	integer	$count The max number of Products to return

Returns:: array All of the Products

static Paper::getAllPapersDuring	(	$	project = `'all'`,
		$	category = `'all'`,
		$	grand = `'grand'`,
		$	startRange = `false`,
		$	endRange = `false`,
		$	strict = `true`,
		$	onlyPublic = `true`
	)			`[static]`

Returns all of the Papers in the database

Parameters:

	Project	$project Specifies which project the returned papers should be associated with
	string	$category Specifies which category the returned papers should be of('Publication', 'Artifact' etc.)
	string	$grand Whether to include grand-only, non-grand-only or both
	string	$startRange The start date
	string	$endRange The end date
	boolean	$strict whether to stick with the date range for everything(true), or show anything 'to appear' as well (false)
	boolean	$onlyPublic Whether or not to only include Papers with access_id = 0

Returns:: array All of the Papers

Paper::getAuthors	(	$	evaluate = `true`,
		$	cache = `true`
	)

Returns an array of authors who wrote this Paper

Parameters:

	boolean	$evaluate Whether or not to ignore the cache
	boolean	$cache Whether or not to cache the authors

Returns:: array The authors who wrote this Paper

Paper::getBibTexId ( )

Returns the bibtex id of this Paper

Returns:: string The bibtex id of this Paper

static Paper::getByIds ( $ ids ) [static]

Returns all the Products with the given ids

Parameters:

array

$ids The array of ids

Returns:: array The array of Products

Paper::getCacheId ( )

Returns the id of this BackboneModel's cache

Returns:: string Returns the id of this BackboneModel's cache

Reimplemented from BackboneModel.

Paper::getCategory ( )

Returns the category of this Paper

Returns:: string The category of this Paper

Paper::getCCVId ( )

Returns the ccv id of this Paper

Returns:: string The ccv id of this Paper

Paper::getCCVType ( )

Returns the 'CCV' type of this Paper

Returns:: string The 'CCV' type of this Paper

Paper::getCitation	(	$	showStatus = `true`,
		$	showPeerReviewed = `true`,
		$	hyperlink = `true`,
		$	wrapAuthors = `false`
	)

Return a string with a citation-like format

Parameters:

	boolean	$showStatus Whether or not to show the publication status
	boolean	$showPeerReviewed Whether or not to show the peer reviewed status
	boolean	$hyperlink Whether or not to use hyperlinks in the citation

Returns:: string The citation text

Paper::getCompleteness ( )

Checks appropriate type of paper for requred venue, pages and publisher fields. If paper falls under category that requires these fields, it checks them for completeness, otherwise returns them as complete.

Returns:: array An associative array describing the completeness of this Paper

Paper::getCreatedBy ( )

Returns the id of the Person who created this Paper

Returns:: integer The id of the Person who created this Paper

Paper::getData ( $ field = null )

Returns the domain specific data for this Paper

Returns:: array The domain specific data for this Paper

Paper::getDate ( )

Returns the date of this Paper

Returns:: string The date of this Paper

Paper::getDescription ( )

Returns the abstract or description of this Paper

Returns:: string The abstract or description of this Paper

Paper::getId ( )

Returns the id of this Paper

Returns:: integer The id of this Paper

Reimplemented from BackboneModel.

Paper::getJournal ( )

Returns the journal entry in the db that matches up with this Product

Returns:: array The journal entry in the db that matches up with this Product

Paper::getProjects ( )

Returns an array of Projects which this Paper is related to

Returns:: array The Projects which this Paper is related to

Paper::getStatus ( )

Returns the status of this Paper

Returns:: string The status of this Paper

Paper::getTags ( )

Returns the tags for this Product

Returns:: Array The tags for this Product

Paper::getTitle ( )

Returns the title of this Paper

Returns:: string The title of this Paper

Paper::getTopProjects ( )

Returns an array of Projects that have selected this Product as a top Product

Returns:: array The Projects that have selected this Product as a top Product

Paper::getType ( )

Returns the type of this Paper

Returns:: strig The type of this Paper

Paper::getUniversities ( )

Returns the Universities which are associated with this Paper

Returns:: array The Universities which are associated with this Paper

Paper::getUrl ( )

Returns the url of this Paper's page

Returns:: string The url of this Paper's page

Paper::getVenue ( )

Returns the venue for this Paper (legacy stuff)

Returns:: string The venue for this Paper

Paper::getYear ( )

Returns the year of this Paper

Returns:: string The year of this Paper

Paper::isDeleted ( )

Returns whether or not this Paper is deleted

Returns:: boolean Whether or not this Paper is deleted

Paper::isGrandRelated ( )

Returns whether or not this Paper is related to this network (has projects)

Returns:: boolean Whether or not this Paper is related to this network

Paper::isPublished ( )

Returns whether or not this Paper is published or not

Returns:: boolean Whether or not this Paper is published or not

static Paper::newFromBibTeXId	(	$	bibtex_id,
		$	title = `""`
	)			`[static]`

Returns a new Paper from the given bibtex_id

Parameters:

	integer	$bibtex_id The id of the Paper
	string	$title The optional title for string comparison

Returns:: Paper The Paper with the given bibtex_id

static Paper::newFromCCVId ( $ ccv_id ) [static]

Returns a new Paper from the given ccv_id

Parameters:

integer

$ccv_id The id of the Paper

Returns:: Paper The Paper with the given ccv_id

static Paper::newFromId ( $ id ) [static]

Returns a new Paper from the given id

Parameters:

integer

$id The id of the Paper

Returns:: Paper The Paper with the given id

static Paper::newFromIds	(	$	ids,
		$	onlyPublic = `true`
	)			`[static]`

Returns an array of new Papers from the given array of ids

Parameters:

	array	$ids The array of ids
	boolean	$onlyPublic Whether or not to only include Papers with access_id = 0

Returns:: array The array of Papers

static Paper::structure ( ) [static]

Returns a php version of the Products.xml structure

Returns:: array The array containing all the structure in Products.xml

Paper::syncAuthors ( $ massSync = false )

Synchronizes the `grand_products` table and the `grand_product_authors` table for this Paper

Parameters:

boolean

$massSync Whether or not to run this for a massSynchronization, or just for this Paper

Returns:: array If $massSync=true, returns the sql statements required to update the DB

Paper::toArray ( )

Generates and returns an array version of this BackboneModel

Returns:: array Returns an array version of this BackboneModel

Reimplemented from BackboneModel.

Paper::toBibTeX ( )

Exports this Paper as a BibTeX

Returns:: string This Paper's BibTeX

Paper::update ( )

Updates the record in the DB for this BackboneModel

Returns:: boolean Returns whether or not the update was successful or not

Reimplemented from BackboneModel.

The documentation for this class was generated from the following file:

extensions/GrandObjects/Paper.php

Paper Class Reference

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Member Function Documentation