Class \Scrivo\IdLabel

Object id's can be labeled in Scrivo, these labels then can be used as constants in the template code. For instance suppose that the contact page in a site has id 12349 then this id can be labeled "CONTACT". When loading the page the label can be used instead of the id, thus allowing for clearer program code. For example:

\Scrivo\CachedData::load($context, 12349); vs \Scrivo\CachedData::load($context, $context->labels->CONTACT);

Also deletion of labeled objects is not allowed: defining a label means that the object has a special function in a project, deleting is likely to cause an inconsistent project state.

You can retrieve a labelled id by referring to its label as a member of of an IdLabel object. A Scrivo Context object contains an IdLabel object with all labelled ids for the contexts instance.

$cfg = new Scrivo\Config(); $context = new Scrivo\Context($cfg, \Scrivo\User::PRIMARY_ADMIN_ID); \Scrivo\CachedData::load($context, $context->labels->CONTACT);

You can add and delete values using the set member:

// Set an id-label pair $context->labels->set($context, 123, \Scrivo\String("CONTACT")); // Update an id-label pair $context->labels->set($context, 123, \Scrivo\String("CONTACT_B")); // Delete an id-label pair $context->labels->set($context, 123);

Implements
Defined in: IdLabel.php.