CirrusSearch\MetaStore\MetaSaneitizeJobStore Class Reference

Inheritance diagram for CirrusSearch\MetaStore\MetaSaneitizeJobStore:

Collaboration diagram for CirrusSearch\MetaStore\MetaSaneitizeJobStore:

Public Member Functions
	__construct (Index $index)
	create ( $jobName, $idOffset, $cluster=null)
	get ( $jobName)
	update (\Elastica\Document $jobInfo)
	TODO: Might be more comfortable with something that wraps the document and guarantees something sane is provided here.
	delete ( $jobName)
	buildIndexProperties ()

Static Public Member Functions
static	docId ( $jobName)

Public Attributes
const	METASTORE_TYPE = "sanitize"

Member Function Documentation

buildIndexProperties()

CirrusSearch\MetaStore\MetaSaneitizeJobStore::buildIndexProperties

(

)

Returns

array

Implements CirrusSearch\MetaStore\MetaStore.

create()

CirrusSearch\MetaStore\MetaSaneitizeJobStore::create	(		$jobName,
			$idOffset,
			$cluster = null )

Parameters

string	$jobName
int	$idOffset	The starting page id of the job
string | null	$cluster	target cluster for this job (null for all writable clusters)

Returns

\Elastica\Document

delete()

CirrusSearch\MetaStore\MetaSaneitizeJobStore::delete

(

$jobName

)

Parameters

string

$jobName

docId()

static CirrusSearch\MetaStore\MetaSaneitizeJobStore::docId ( $jobName )

static

Parameters

string

$jobName

Returns

string the job id

get()

CirrusSearch\MetaStore\MetaSaneitizeJobStore::get

(

$jobName

)

Parameters

string

$jobName

Returns

\Elastica\Document|null

update()

CirrusSearch\MetaStore\MetaSaneitizeJobStore::update

(

\Elastica\Document

$jobInfo

)

TODO: Might be more comfortable with something that wraps the document and guarantees something sane is provided here.

Parameters

\Elastica\Document

$jobInfo

---

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

• includes/MetaStore/MetaSaneitizeJobStore.php