SilverCart\Model\Order\NumberRange
Abstract for a range of numbers (ordernumbers, customernumbers, invoicenumbers, etc.).
- Author: Sebastian Diel <sdiel@pixeltricks.de>
- Copyright: 2017 pixeltricks GmbH
- License: see license file in modules root directory
Synopsis
class NumberRange
extends DataObject
{
- // members
- private static array $db = ;
- private static array $defaults = ;
- private static array $casting = ;
- private static string $table_name = 'SilvercartNumberRange';
- private static bool $enable_table_lock = true;
- // methods
- public string singular_name()
- public string plural_name()
- public array fieldLabels()
- public array summaryFields()
- public array excludeFromScaffolding()
- public FieldList getCMSFields()
- public bool canDelete()
- public string getActualNumber()
- public string getEndNumber()
- public string getStartNumber()
- public string getNewNumber()
- public string reserveNewNumber()
- public string useReservedNumber()
- public static NumberRange|null getByIdentifier()
- public static string reserveNewNumberByIdentifier()
- public static string useReservedNumberByIdentifier()
- // Inherited methods from ExtensibleDataObject
- protected void beforeRequireDefaultRecords()
- protected void beforeUpdateCMSActions()
- protected void beforeUpdateFieldLabels()
- protected void beforeUpdateProvidePermissions()
- public array defaultFieldLabels()
- public static void reset_field_labels()
- protected array scaffoldFieldLabels()
Hierarchy
Members
private
- $casting
—
array
some virtual attributes (not in db) - $db
—
array
DB attributes - $defaults
—
array
default values for some attributes - $enable_table_lock
—
SilverCart\Model\Order\bool
Enable table lock when getting new numbers? - $table_name
—
string
DB table name
protected
- $defaultFieldLabels
—
array
Default field labels.
Methods
public
- canDelete() — Remove permission to delete for all members.
- excludeFromScaffolding() — Returns an array of field/relation names (db, has_one, has_many, many_many, belongs_many_many) to exclude from form scaffolding in backend.
- fieldLabels() — Field labels for display in tables.
- getActualNumber() — Builds the actual number with prefix, count and suffix
- getByIdentifier() — returns a number range by identifier.
- getCMSFields() — customizes the backends fields
- getEndNumber() — Builds the end number with prefix, count and suffix
- getNewNumber() — increments and returns the actual number.
- getStartNumber() — Builds the start number with prefix, count and suffix
- plural_name() — Returns the translated plural name of the object. If no translation exists the class name will be returned.
- reserveNewNumber() — reserves a new number or returns an already reserved one.
- reserveNewNumberByIdentifier() — reserves a new number or returns an already reserved one by identifier.
- singular_name() — Returns the translated singular name of the object. If no translation exists the class name will be returned.
- summaryFields() — i18n for summary fields
- useReservedNumber() — returns a reserverd number and deletes the number from session.
- useReservedNumberByIdentifier() — returns a reserverd number and deletes the number from session by identifier.
Inherited from SilverCart\ORM\ExtensibleDataObject
protected
- beforeRequireDefaultRecords() — Allows user code to hook into DataObject::requireDefaultRecords() prior to requireDefaultRecords being called on extensions.
- beforeUpdateCMSActions() — Allows user code to hook into DataObject::getCMSActions prior to updateCMSActions being called on extensions.
- beforeUpdateFieldLabels() — Allows user code to hook into DataObject::fieldLabels() prior to updateFieldLabels being called on extensions.
- beforeUpdateProvidePermissions() — Allows user code to hook into DataObject::updateProvidePermissions() prior to providePermissions being called on extensions.
- scaffoldFieldLabels() — Returns the default field labels for this DataObject.
public
- defaultFieldLabels() — Returns the default field labels.
- reset_field_labels() — Resets the field label cache.