Plentymarkets interface documentation
Console
Commands
GenerateShopBuilderPresetsEvent
Event
Namespace
Plenty\Console\Commands
Methods
public getPluginSet():Plenty\Modules\Plugin\PluginSet\Models\PluginSetReturn type: PluginSet
Get the plugin set which have been built
Models
Item
ItemImageSettings
Configuration of item images
Namespace
Plenty\Legacy\Models\Item
| Name | Type | Description |
|---|---|---|
cdnUrl |
||
maxAge |
||
imageExportPos |
||
defaultExport |
||
ftpImport |
||
ftpImportMatching |
||
neckermannExport |
||
attributeImageWidth |
||
attributeImageHeight |
||
name |
||
placeholder |
||
sizes |
||
aliases |
||
legacyPreviousSizes |
Methods
public toArray()Returns this model as an array.
Item
SalesPrice
SalesPriceSearchRepository
foo
Namespace
Plenty\Legacy\Repositories\Item\SalesPrice
Methods
public search($request):Plenty\Modules\Item\SalesPrice\Models\SalesPriceSearchResponseReturn type: SalesPriceSearchResponse
Name |
Type |
Description |
|
public searchAll($request):arrayName |
Type |
Description |
|
Variation
DetectSalesPriceService
To be written…
Namespace
Plenty\Legacy\Services\Item\Variation
Methods
public getQuantity():voidpublic setQuantity($quantity):Plenty\Legacy\Services\Item\Variation\DetectSalesPriceServiceReturn type: DetectSalesPriceService
Name |
Type |
Description |
|
public getCurrency():voidpublic setCurrency($currency):Plenty\Legacy\Services\Item\Variation\DetectSalesPriceServiceReturn type: DetectSalesPriceService
Name |
Type |
Description |
|
public getPlentyId():voidpublic setPlentyId($plentyId):Plenty\Legacy\Services\Item\Variation\DetectSalesPriceServiceReturn type: DetectSalesPriceService
Name |
Type |
Description |
|
public getOrderReferrer():voidpublic setOrderReferrer($orderReferrer):Plenty\Legacy\Services\Item\Variation\DetectSalesPriceServiceReturn type: DetectSalesPriceService
Name |
Type |
Description |
|
public getCustomerClass():voidpublic setCustomerClass($customerClass):Plenty\Legacy\Services\Item\Variation\DetectSalesPriceServiceReturn type: DetectSalesPriceService
Name |
Type |
Description |
|
public getType():voidpublic setType($type):Plenty\Legacy\Services\Item\Variation\DetectSalesPriceServiceReturn type: DetectSalesPriceService
Name |
Type |
Description |
|
public getCountryOfDelivery():voidpublic setCountryOfDelivery($countryOfDelivery):Plenty\Legacy\Services\Item\Variation\DetectSalesPriceServiceReturn type: DetectSalesPriceService
Name |
Type |
Description |
|
public getAccountType():voidpublic setAccountType($accountType):Plenty\Legacy\Services\Item\Variation\DetectSalesPriceServiceReturn type: DetectSalesPriceService
Name |
Type |
Description |
|
public getAccountId():voidpublic setAccountId($accountId):Plenty\Legacy\Services\Item\Variation\DetectSalesPriceServiceReturn type: DetectSalesPriceService
Name |
Type |
Description |
|
public detect():voidLog
Contracts
LoggerContract
The contract for the logger.
Namespace
Plenty\Log\Contracts
Methods
public report($code, $additionalInfo = null):voidReport information.
Name |
Type |
Description |
|
||
|
public debug($code, $additionalInfo = null):voidDetailed debug information.
Name |
Type |
Description |
|
||
|
public info($code, $additionalInfo = null):voidInteresting events.
Name |
Type |
Description |
|
||
|
public notice($code, $additionalInfo = null):voidNormal but significant events.
Name |
Type |
Description |
|
||
|
public warning($code, $additionalInfo = null):voidExceptional occurrences that are not errors.
Name |
Type |
Description |
|
||
|
public error($code, $additionalInfo = null):voidRuntime errors that do not require immediate action but should typically be logged and monitored.
Name |
Type |
Description |
|
||
|
public critical($code, $additionalInfo = null):voidCritical conditions.
Name |
Type |
Description |
|
||
|
public alert($code, $additionalInfo = null):voidAction must be taken immediately.
Name |
Type |
Description |
|
||
|
public emergency($code, $additionalInfo = null):voidSystem is unusable.
Name |
Type |
Description |
|
||
|
public logException($exception, $traceDepth = 3):voidLog exceptions.
Name |
Type |
Description |
|
||
|
The depth of the stack trace to be logged. Default is 3. |
public setReferenceType($referenceType):Plenty\Log\Contracts\LoggerContractReturn type: LoggerContract
The reference type.
Name |
Type |
Description |
|
public setReferenceValue($referenceValue):Plenty\Log\Contracts\LoggerContractReturn type: LoggerContract
The reference value.
Name |
Type |
Description |
|
public addReference($referenceType, $referenceValue):Plenty\Log\Contracts\LoggerContractReturn type: LoggerContract
Add reference.
Name |
Type |
Description |
|
||
|
public addPlaceholder($placeholderName, $placeholderValue):Plenty\Log\Contracts\LoggerContractReturn type: LoggerContract
Add code placeholder.
Name |
Type |
Description |
|
||
|
Models
Log
The log entity model
Namespace
Plenty\Log\Models
| Name | Type | Description |
|---|---|---|
id |
The ID of the log entry |
|
createdAt |
The date when the log entry was created |
|
integration |
The integration key used for the log entry. Used as a first level allocation. |
|
identifier |
The identifier used for the log entry. Used as a second level allocation. |
|
code |
The code for this current log entry. For log entries with level "debug", "info", "notice", "warning" and "report" this needs to have an translation in order to be stored. |
|
referenceType |
Deprecated field, see the <code>references</code> field instead. |
|
referenceValue |
Deprecated field, see the <code>references</code> field instead. |
|
level |
The level this current log entry belongs to. Notice! When storing log entries with level "report" the entries will actually be stored as level "info". The difference between "report" and "info" is that log entries with level "report" do not need prior activation. |
|
additionalInfo |
Additional information that need to also be stored. Can be an int, string or object. |
|
callerFunction |
||
callerLine |
||
references |
All the reference types and values correlated with this log entry. |
Methods
public toArray()Returns this model as an array.
Search
Contracts
LogRepositoryContract
Contract for logs.
Namespace
Plenty\Log\Search\Contracts
Methods
public search($page = 1, $itemsPerPage = 50, $filters = [], $sortBy = "createdAt", $sortOrder = "desc", $with = []):Plenty\Repositories\Models\FilteredPaginatedResultReturn type: FilteredPaginatedResult
Search logs with the given filters.
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
||
|
public get($id):Plenty\Log\Models\LogPlenty
Plugin
Application
The main application
Namespace
Plenty\Plugin
Methods
public register($providerClassName):voidRegister a service provider with the application.
Name |
Type |
Description |
|
the classname with namespace of the provider |
public bind($abstract, $concrete = null, $shared = false):voidRegister a binding with the container.
Name |
Type |
Description |
|
||
|
||
|
public singleton($abstract, $concrete = null):voidRegister a shared binding in the container.
Name |
Type |
Description |
|
||
|
public make($abstract, $parameters = []):voidName |
Type |
Description |
|
||
|
public makeWith($abstract, $parameters = []):voidName |
Type |
Description |
|
||
|
public abort($code, $message = "", $headers = []):voidThrow an HttpException with the given data.
Name |
Type |
Description |
|
||
|
||
|
public getWebstoreId():intReturns current webstoreId
public getPlentyId():intpublic isAdminPreview():boolpublic isTemplateSafeMode():boolpublic isBackendRequest():boolpublic getPluginSetId():intpublic getUrlPath($pluginName = ""):stringReturns the URL to the plugin resources
Name |
Type |
Description |
|
public getCdnDomain():stringReturns the URL from the cdn
public getPlentyHash():stringReturns the plentyHash
CachingRepository
caching repository
Namespace
Plenty\Plugin
Methods
public has($key):boolDetermine if an item exists in the cache.
Name |
Type |
Description |
|
public get($key, $default = null):voidRetrieve an item from the cache by key.
Name |
Type |
Description |
|
||
|
public many($keys):arrayRetrieve multiple items from the cache by key.
Name |
Type |
Description |
|
public pull($key, $default = null):voidRetrieve an item from the cache and delete it.
Name |
Type |
Description |
|
||
|
public put($key, $value, $minutes = null):voidStore an item in the cache.
Name |
Type |
Description |
|
||
|
||
|
public putMany($values, $minutes):voidStore multiple items in the cache for a given number of minutes.
Name |
Type |
Description |
|
||
|
public add($key, $value, $minutes):boolStore an item in the cache if the key does not exist.
Name |
Type |
Description |
|
||
|
||
|
public remember($key, $minutes, $callback):voidGet an item from the cache, or store the default value.
Name |
Type |
Description |
|
||
|
||
|
public forget($key):boolRemove an item from the cache.
Name |
Type |
Description |
|
public deleteByPrefix($prefix):voidName |
Type |
Description |
|
public static getPrefix():stringConfigRepository
configuration repository
Namespace
Plenty\Plugin
Methods
public has($key):boolDetermine if the given configuration value exists.
Name |
Type |
Description |
|
public get($key, $default = null):mixedGet the specified configuration value.
Name |
Type |
Description |
|
||
|
public set($key, $value = null):voidSet a given configuration value.
Name |
Type |
Description |
|
||
|
public prepend($key, $value):voidPrepend a value onto an array configuration value.
Name |
Type |
Description |
|
||
|
public push($key, $value):voidPush a value onto an array configuration value.
Name |
Type |
Description |
|
||
|
public static getPrefix():stringController
Controller
Namespace
Plenty\Plugin
Methods
public __construct():voidController constructor.
DataExchangeServiceProvider
Data Exchange service provider
Namespace
Plenty\Plugin
Methods
public getApplication():Plenty\Plugin\ApplicationReturn type: Application
public getEventDispatcher():Plenty\Plugin\Events\DispatcherReturn type: Dispatcher
RouteServiceProvider
Route service provider
Namespace
Plenty\Plugin
Methods
public getApplication():Plenty\Plugin\ApplicationReturn type: Application
public getEventDispatcher():Plenty\Plugin\Events\DispatcherReturn type: Dispatcher
ServiceProvider
Service provider for plugins
Namespace
Plenty\Plugin
Methods
public addGlobalMiddleware($middleware):voidAdd a new middleware to end of the stack if it does not already exist.
Name |
Type |
Description |
|
public getApplication():Plenty\Plugin\ApplicationReturn type: Application
public getEventDispatcher():Plenty\Plugin\Events\DispatcherReturn type: Dispatcher
SessionRepository
session repository
Namespace
Plenty\Plugin
Methods
public has($key):boolDetermine if the given session value exists.
Name |
Type |
Description |
|
public get($key, $default = null):voidGet the specified session value.
Name |
Type |
Description |
|
||
|
public set($key, $value = null):voidSet a given session value.
Name |
Type |
Description |
|
||
|
public prepend($key, $value):voidPrepend a value onto an array session value.
Name |
Type |
Description |
|
||
|
public push($key, $value):voidPush a value onto an array session value.
Name |
Type |
Description |
|
||
|
public static getPrefix():stringValidation
DummyAttribute
Dummy Attribute Class
Namespace
Plenty\Validation
Methods
public getAttributeName():stringReturns the attribute's name
public setAttributeName($attributeName):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
Sets the attribute's name
Name |
Type |
Description |
|
public accepted():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be yes, on, 1, or true. This is useful for validating "Terms of Service" acceptance.
public activeUrl():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a valid URL according to the checkdnsrr PHP function.
public dateAfter($fieldNameOrTimeStr):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a value after a given date. The dates will be passed into the strtotime PHP function.
Name |
Type |
Description |
|
public alphabetic():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be entirely alphabetic characters.
public alphaDash():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation may have alpha-numeric characters, as well as dashes and underscores.
public alphaNum():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be entirely alpha-numeric characters.
public isArray():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a PHP array.
public dateBefore($fieldNameOrTimeStr):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a value preceding the given date. The dates will be passed into the PHP strtotime function.
Name |
Type |
Description |
|
public between($min, $max):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must have a size between the given min and max. Strings, numerics, and files are evaluated in the same fashion as the size rule.
Name |
Type |
Description |
|
||
|
public boolean():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be able to be cast as a boolean. Accepted input are true, false, 1, 0, "1", and "0".
public confirmed():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must have a matching field of foo_confirmation. For example, if the field under validation is password, a matching password_confirmation field must be present in the input.
public date():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a valid date according to the strtotime PHP function.
public present():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
Validate that an attribute exists even if not filled.
public dateFormat($format):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must match the given format. The format will be evaluated using the PHP date_parse_from_format function.
Name |
Type |
Description |
|
public different($fieldName):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must have a different value than field.
Name |
Type |
Description |
|
public digits($count):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be numeric and must have an exact length of $count.
Name |
Type |
Description |
|
public digitsBetween($min, $max):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must have a length between the given min and max.
Name |
Type |
Description |
|
||
|
public email():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be formatted as an e-mail address.
public exists($table, $columns = []):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must exist on a given database table.
Name |
Type |
Description |
|
||
|
public image():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The file under validation must be an image (jpeg, png, bmp, gif, or svg)
public in($values):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be included in the given list of values.
Name |
Type |
Description |
|
public integer():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be an integer.
public ip():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be an IP address.
public json():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must a valid JSON string.
public max($value):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be less than or equal to a maximum value. Strings, numerics, and files are evaluated in the same fashion as the size rule.
Name |
Type |
Description |
|
public mimeTypes($types):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The file under validation must have a MIME type corresponding to one of the listed extensions.
Name |
Type |
Description |
|
public min($value):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must have a minimum value. Strings, numerics, and files are evaluated in the same fashion as the size rule.
Name |
Type |
Description |
|
public notIn($values):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must not be included in the given list of values.
Name |
Type |
Description |
|
public numeric():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be numeric.
public regex($pattern):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must match the given regular expression.
Name |
Type |
Description |
|
public required():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be present in the input data and not empty. A field is considered "empty" is one of the following conditions are true: The value is null.
public requiredIf($fieldName, $value):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be present if the anotherfield field is equal to any value.
Name |
Type |
Description |
|
||
|
public requiredUnless($fieldName, $value):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be present unless the anotherfield field is equal to any value.
Name |
Type |
Description |
|
||
|
public requiredWith($fieldNames):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be present only if any of the other specified fields are present.
Name |
Type |
Description |
|
public requiredWithAll($fieldNames):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
required_with_all
Name |
Type |
Description |
|
public requiredWithout($fieldNames):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be present only when any of the other specified fields are not present.
Name |
Type |
Description |
|
public requiredWithoutAll($fieldNames):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be present only when all of the other specified fields are not present.
Name |
Type |
Description |
|
public notLike($fieldName):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be not like the specified name.
Name |
Type |
Description |
|
public same($fieldName):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The given field must match the field under validation.
Name |
Type |
Description |
|
public size($value):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must have a size matching the given value. For string data, value corresponds to the number of characters.
Name |
Type |
Description |
|
public string():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a string.
public timezone():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a valid timezone identifier according to the timezone_identifiers_list PHP function.
public unique($table, $column, $except = null, $idColumn = null):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be unique on a given database table. If the column option is not specified, the field name will be used.
Name |
Type |
Description |
|
||
|
||
|
||
|
public url():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a valid URL according to PHP's filter_var function.
public sometimes():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
In some situations, you may wish to run validation checks against a field only if that field is present in the input array. To quickly accomplish this, add the sometimes rule.
public nullable():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation may be null. This is particularly useful when validating primitive such as strings and integers that can contain null values.
public generateRulesContent():voidReturns all rules connected to the attribute
public dateW3C($allowTimestamps = false):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a valid w3c formated date time string.
Name |
Type |
Description |
|
Allow timestamps as a valid format as well. |
public inTimestampRange():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a w3c formated date time string that is in the MySQL timestamp range (1970 to 2037).
public validOrderId():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a valid order ID for an order that is not deleted.
public validOrderItemId():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a valid order item ID for an order that is not deleted.
public customRule($rule, $params):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
Add custom Role
Name |
Type |
Description |
|
||
|
public validPlentyId():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a valid plentyId.
public validPlentyUrl():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field must be a valid URL.
public validPlentyDomain():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
Custom validation rule for checking the existence of a given domain.
public typeFromDb($table, $column, $attribute, $comparisonKey = "id"):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must have the type specified in the database.
Name |
Type |
Description |
|
The table with the data type |
|
|
The column with the data type |
|
|
The attribute in the validator with the key |
|
|
The column to in $table to compare $attribute to. Default is 'id'. |
public hexColor():voidThe field under validation must be a valid HEX color (like "#a3d" or "#a0787c").
public rgbColor():voidThe field under validation must be a valid RGB or RGBA color (like "rgb(0, 200, 150)" or "rgba(0, 200, 150, 0.52)").
public cssColor():voidThe field under validation must be a valid predefined CSS color (like "aquamarine" or "skyblue").
public color():voidThe field under validation must be a valid color (HEX like "#a0787c", RGB like "rgb(0, 200, 150)" or CSS like "aquamarine")
public uuid5():voidThe field under validation must be a valid UUID version 5.
public validDbType():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a valid data type used by the validation rule 'typeFromDb'.
public validCurrency():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a valid currency string (e.g. 'EUR').
public validBoardTaskReferenceValue():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a valid board task reference type (e.g. {@link BoardTaskReferenceType::CONTACT}).
public validPhoneNumber($option):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a valid phone number
Name |
Type |
Description |
|
public validMailAddress():Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be a valid mail address
public arrayKeysInList($acceptedKeysList):Plenty\Validation\DummyAttributeReturn type: DummyAttribute
The field under validation must be an array and must contain only the keys in the provided accepted list.
Name |
Type |
Description |
|
RulesCollection
RulesCollection represents a collection of rules connected to an attribute
Namespace
Plenty\Validation
Methods
public add($attributeName):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add attribute without type
Name |
Type |
Description |
|
public addConditional($attributeName, $required):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add attribute without type (with or without requirement)
Name |
Type |
Description |
|
||
|
public addInt($attributeName, $required = false):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add int attribute
Name |
Type |
Description |
|
||
|
public addNumeric($attributeName, $required = false):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add numeric attribute
Name |
Type |
Description |
|
||
|
public addDate($attributeName, $required = false):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add date attribute
Name |
Type |
Description |
|
||
|
public addBool($attributeName, $required = false):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add bool attribute
Name |
Type |
Description |
|
||
|
public addString($attributeName, $required = false):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add string attribute
Name |
Type |
Description |
|
||
|
public sometimes($attributeName, $condition):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add a rule for an attribute based on the result of the condition callback.
Name |
Type |
Description |
|
||
|
public arrayKeysInList($attributeName, $acceptedKeysList):Plenty\Validation\Contracts\AttributeValidator
Base Validator Class
Namespace
Plenty\Validation
| Name | Type | Description |
|---|---|---|
customMessageKey |
Methods
public static validateOrFail($data):voidValidate the given data against the rules of this validtor
Name |
Type |
Description |
|
public each($attributeName):Plenty\Validation\RulesCollectionReturn type: RulesCollection
Add conditions to each item of a list
Name |
Type |
Description |
|
public buildCustomMessages():arrayLoad translated custom message
public getAttributeValue($attribute):voidGet the value of the given attribute.
Name |
Type |
Description |
|
public defineAttributes():voidMust be implemented in each subclass. Define the attributes for the validator.
public add($attributeName):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add attribute without type
Name |
Type |
Description |
|
public addConditional($attributeName, $required):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add attribute without type (with or without requirement)
Name |
Type |
Description |
|
||
|
public addInt($attributeName, $required = false):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add int attribute
Name |
Type |
Description |
|
||
|
public addNumeric($attributeName, $required = false):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add numeric attribute
Name |
Type |
Description |
|
||
|
public addDate($attributeName, $required = false):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add date attribute
Name |
Type |
Description |
|
||
|
public addBool($attributeName, $required = false):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add bool attribute
Name |
Type |
Description |
|
||
|
public addString($attributeName, $required = false):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add string attribute
Name |
Type |
Description |
|
||
|
public sometimes($attributeName, $condition):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add a rule for an attribute based on the result of the condition callback.
Name |
Type |
Description |
|
||
|
public arrayKeysInList($attributeName, $acceptedKeysList):Plenty\Validation\Contracts\AttributeExceptions
ValidationException
Namespace
Plenty\Exceptions
| Name | Type | Description |
|---|---|---|
messageBag |
Methods
public getMessageBag():Illuminate\Support\MessageBagReturn type: MessageBag
public setMessageBag($messageBag):Plenty\Exceptions\ValidationExceptionReturn type: ValidationException
Name |
Type |
Description |
|
Plugin
Events
Dispatcher
Dispatcher
Namespace
Plenty\Plugin\Events
Methods
public isPublicEvent($event):boolName |
Type |
Description |
|
public listen($event, $listener, $priority):voidRegister an event listener with the dispatcher.
Name |
Type |
Description |
|
||
|
||
|
public hasListeners($event):boolDetermine if a given event has listeners.
Name |
Type |
Description |
|
public fire($event, $payload = []):voidFire an event and call the listeners.
Name |
Type |
Description |
|
||
|
public dispatch($event, $payload = []):voidFire an event and call the listeners.
Name |
Type |
Description |
|
||
|
public forget($event):voidRemove a set of listeners from the dispatcher.
Name |
Type |
Description |
|
public static getPrefix():stringHttp
Request
http request
Namespace
Plenty\Plugin\Http
Methods
public all():arrayGet all of the input and files for the request.
public merge($input):voidMerge new input into the current request's input array.
Name |
Type |
Description |
|
public replace($input):voidReplace the input for the current request.
Name |
Type |
Description |
|
public get($key, $default = null, $deep = false):voidName |
Type |
Description |
|
||
|
||
|
public getContent():stringReturns the request body content.
public getRequestUri():stringReturns the requested URI (path and query string).
public exists($key):boolDetermine if the request contains a given input item key.
Name |
Type |
Description |
|
public has($key):boolDetermine if the request contains a non-empty value for an input item.
Name |
Type |
Description |
|
public input($key = null, $default = null):voidRetrieve an input item from the request.
Name |
Type |
Description |
|
||
|
public only($keys):arrayGet a subset of the items from the input data.
Name |
Type |
Description |
|
public except($keys):arrayGet all of the input except for a specified array of items.
Name |
Type |
Description |
|
public query($key = null, $default = null):voidRetrieve a query string item from the request.
Name |
Type |
Description |
|
||
|
public hasHeader($key):boolDetermine if a header is set on the request.
Name |
Type |
Description |
|
public header($key = null, $default = null):voidRetrieve a header from the request.
Name |
Type |
Description |
|
||
|
public isJson():boolDetermine if the request is sending JSON.
public wantsJson():boolDetermine if the current request is asking for JSON in return.
public accepts($contentTypes):boolDetermines whether the current requests accepts a given content type.
Name |
Type |
Description |
|
public prefers($contentTypes):stringReturn the most suitable content type from the given array based on content negotiation.
Name |
Type |
Description |
|
public acceptsJson():boolDetermines whether a request accepts JSON.
public acceptsHtml():boolDetermines whether a request accepts HTML.
public format($default = "html"):stringGet the data format expected in the response.
Name |
Type |
Description |
|
public getUserInfo():stringGets the user info.
public getHttpHost():stringReturns the HTTP host being requested.
public getSchemeAndHttpHost():stringGets the scheme and HTTP host.
public getUri():stringGenerates a normalized URI (URL) for the Request.
public getUriForPath($path):stringGenerates a normalized URI for the given path.
Name |
Type |
Description |
|
A path to use instead of the current one |
public getQueryString():stringGenerates the normalized query string for the Request.
public getMethod():stringGets the request "intended" method.
public getLocale():stringGet the locale.
Response
Class to create different types of http response.
Namespace
Plenty\Plugin\Http
Methods
public getHeaders():voidGet the headers for the response.
public status():intGet the status code for the response.
public content():stringGet the content of the response.
public make($content = "", $status = 200, $headers = []):Plenty\Plugin\Http\ResponseReturn type: Response
Return a new response from the application.
Name |
Type |
Description |
|
||
|
||
|
public view($view, $data = [], $status = 200, $headers = []):Plenty\Plugin\Http\ResponseReturn type: Response
Return a new view response from the application.
Name |
Type |
Description |
|
||
|
||
|
||
|
public json($data = [], $status = 200, $headers = [], $options):Symfony\Component\HttpFoundation\ResponseReturn type: Response
Return a new JSON response from the application.
Name |
Type |
Description |
|
||
|
||
|
||
|
public jsonp($callback, $data = [], $status = 200, $headers = [], $options):Symfony\Component\HttpFoundation\ResponseReturn type: Response
Return a new JSONP response from the application.
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
public stream($callback, $status = 200, $headers = []):Symfony\Component\HttpFoundation\ResponseReturn type: Response
Return a new streamed response from the application.
Name |
Type |
Description |
|
||
|
||
|
public redirectTo($path, $status = 302, $headers = [], $secure = null):Symfony\Component\HttpFoundation\ResponseReturn type: Response
Create a new redirect response to the given path.
Name |
Type |
Description |
|
||
|
||
|
||
|
public redirectToRoute($route, $parameters = [], $status = 302, $headers = []):Symfony\Component\HttpFoundation\ResponseReturn type: Response
Create a new redirect response to a named route.
Name |
Type |
Description |
|
||
|
||
|
||
|
public redirectToAction($action, $parameters = [], $status = 302, $headers = []):Symfony\Component\HttpFoundation\ResponseReturn type: Response
Create a new redirect response to a controller action.
Name |
Type |
Description |
|
||
|
||
|
||
|
public redirectGuest($path, $status = 302, $headers = [], $secure = null):Symfony\Component\HttpFoundation\ResponseReturn type: Response
Create a new redirect response, while putting the current URL in the session.
Name |
Type |
Description |
|
||
|
||
|
||
|
public redirectToIntended($default = "/", $status = 302, $headers = [], $secure = null):Symfony\Component\HttpFoundation\ResponseReturn type: Response
Create a new redirect response to the previously intended location.
Name |
Type |
Description |
|
||
|
||
|
||
|
public sendHeaders():Plenty\Plugin\Http\ResponseReturn type: Response
Send the HTTP headers without sending the whole response.
public forceStatus($status = 200):Plenty\Plugin\Http\ResponseReturn type: Response
Force sending response with defined status instead of falling back to default handlers in case of 40* status codes.
Name |
Type |
Description |
|
public isStatusForced():boolCheck if response should be send instead of falling back to default handlers in case of 40* status codes.
Log
LoggerFactory
Logger factory
Namespace
Plenty\Plugin\Log
Methods
public getLogger($pluginNamespace, $identifier):Plenty\Log\Contracts\LoggerContractReturn type: LoggerContract
Name |
Type |
Description |
|
||
|
Routing
ApiRouter
Api router service
Namespace
Plenty\Plugin\Routing
Methods
public version($version, $second, $third = null):voidName |
Type |
Description |
|
||
|
||
|
public get($uri, $action):Plenty\Plugin\Routing\RouteReturn type: Route
Register a new GET route with the router.
Name |
Type |
Description |
|
||
|
public post($uri, $action):Plenty\Plugin\Routing\RouteReturn type: Route
Register a new POST route with the router.
Name |
Type |
Description |
|
||
|
public put($uri, $action):Plenty\Plugin\Routing\RouteReturn type: Route
Register a new PUT route with the router.
Name |
Type |
Description |
|
||
|
public patch($uri, $action):Plenty\Plugin\Routing\RouteReturn type: Route
Register a new PATCH route with the router.
Name |
Type |
Description |
|
||
|
public delete($uri, $action):Plenty\Plugin\Routing\RouteReturn type: Route
Register a new DELETE route with the router.
Name |
Type |
Description |
|
||
|
public options($uri, $action):Plenty\Plugin\Routing\RouteReturn type: Route
Register a new OPTIONS route with the router.
Name |
Type |
Description |
|
||
|
public any($uri, $action):Plenty\Plugin\Routing\RouteReturn type: Route
Register a new route responding to all verbs.
Name |
Type |
Description |
|
||
|
public resource($name, $controller, $options = []):voidRoute a resource to a controller.
Name |
Type |
Description |
|
||
|
||
|
public match($methods, $uri, $action):Plenty\Plugin\Routing\RouteRoute
Route
Namespace
Plenty\Plugin\Routing
Methods
public addMiddleware($middleware):Plenty\Plugin\Routing\RouteReturn type: Route
Add middlewares attached to the route.
Name |
Type |
Description |
|
public middleware($middleware = []):Plenty\Plugin\Routing\RouteReturn type: Route
Get or set the middlewares attached to the route.
Name |
Type |
Description |
|
public getMiddleware():arraypublic where($name, $expression = null):Plenty\Plugin\Routing\RouteRouter
Router service
Namespace
Plenty\Plugin\Routing
Methods
public static addRoute($route):voidName |
Type |
Description |
|
public get($uri, $action):Plenty\Plugin\Routing\RouteReturn type: Route
Register a new GET route with the router.
Name |
Type |
Description |
|
||
|
public post($uri, $action):Plenty\Plugin\Routing\RouteReturn type: Route
Register a new POST route with the router.
Name |
Type |
Description |
|
||
|
public put($uri, $action):Plenty\Plugin\Routing\RouteReturn type: Route
Register a new PUT route with the router.
Name |
Type |
Description |
|
||
|
public patch($uri, $action):Plenty\Plugin\Routing\RouteReturn type: Route
Register a new PATCH route with the router.
Name |
Type |
Description |
|
||
|
public delete($uri, $action):Plenty\Plugin\Routing\RouteReturn type: Route
Register a new DELETE route with the router.
Name |
Type |
Description |
|
||
|
public options($uri, $action):Plenty\Plugin\Routing\RouteReturn type: Route
Register a new OPTIONS route with the router.
Name |
Type |
Description |
|
||
|
public any($uri, $action):Plenty\Plugin\Routing\RouteReturn type: Route
Register a new route responding to all verbs.
Name |
Type |
Description |
|
||
|
public match($methods, $uri, $action):Plenty\Plugin\Routing\RouteReturn type: Route
Register a new route with the given verbs.
Name |
Type |
Description |
|
||
|
||
|
public middleware($name, $class):Plenty\Plugin\Routing\RouterReturn type: Router
Register a short-hand name for a middleware.
Name |
Type |
Description |
|
||
|
public prepareResponse($request, $response):Plenty\Plugin\Http\ResponseTemplates
Markdown
A simple markdown converter.
Namespace
Plenty\Plugin\Templates
Methods
public renderToHtml($markdownContent):stringName |
Type |
Description |
|
Twig
Twig engine
Namespace
Plenty\Plugin\Templates
Methods
public render($name, $context = []):stringRenders a template.
Name |
Type |
Description |
|
The template name |
|
|
An array of parameters to pass to the template |
public renderString($templateContent, $context = []):stringCompile and render a twig template from a string.
Name |
Type |
Description |
|
The template to render |
|
|
An array of parameters to pass to the template |
public addExtension($extension):voidRegisters an extension.
Name |
Type |
Description |
|
A Twig_ExtensionInterface instance |
Translation
Translator
translation service
Namespace
Plenty\Plugin\Translation
Methods
public get($id, $parameters = [], $locale = null):voidGet the translation for a given key.
Name |
Type |
Description |
|
||
|
||
|
public trans($id, $parameters = [], $locale = null):voidGet the translation for a given key.
Name |
Type |
Description |
|
||
|
||
|
Data
Contracts
PropertyDescriptor
describes properties of a Model
Namespace
Plenty\Plugin\Data\Contracts
Methods
public getPropertyInformation($modelClassName):arrayName |
Type |
Description |
|
Resources
Resource
Namespace
Plenty\Plugin\Data\Contracts
Methods
public load($resourceName, $options = []):Plenty\Plugin\Data\Model\ResourceInformationReturn type: ResourceInformation
Name |
Type |
Description |
|
||
|
public exists($resourceName):boolName |
Type |
Description |
|
ExternalAuth
Contracts
ExternalAccessRepositoryContract
Find and create ExternalAccess-datasets
Namespace
Plenty\Plugin\ExternalAuth\Contracts
Methods
public create($data):Plenty\Plugin\ExternalAuth\Models\ExternalAccessReturn type: ExternalAccess
Create a new ExternalAccess record
Name |
Type |
Description |
|
The data for the ExternalAccess record to be created with. Must be an associative array with the keys 'contactId', 'accessType', 'externalContactId' and optionally an external 'accessToken'. |
public findForTypeAndExternalId($type, $externalId):Plenty\Plugin\ExternalAuth\Models\ExternalAccessReturn type: ExternalAccess
Find
Name |
Type |
Description |
|
The type of the external access |
|
|
The external ID of the contact |
public findForTypeAndContactId($type, $contactId):Plenty\Plugin\ExternalAuth\Models\ExternalAccessReturn type: ExternalAccess
Name |
Type |
Description |
|
The type of the external access |
|
|
The (internal) ID of the contact |
Models
ExternalAccess
Information on a contact's external access tokens
Namespace
Plenty\Plugin\ExternalAuth\Models
| Name | Type | Description |
|---|---|---|
contactId |
The ID of the contact in question. Must be unique in combination with $accessType. |
|
accessType |
The type/provider of external access. Must be unique in combination with $contactId. |
|
externalContactId |
The ID of the contact at the external provider. |
|
accessToken |
The token for the external access. |
|
lastUpdate |
The Date when this record was updated the last time. |
Methods
public toArray()Returns this model as an array.
Contracts
AwsSesContract
Plugin AWS Simple Email Service
Namespace
Plenty\Plugin\Mail\Contracts
Methods
public sendEmail($email, $credentials):Plenty\Plugin\Mail\Models\EmailSenderResultReturn type: EmailSenderResult
Composes an email message and immediately queues it for sending via AWS SES
Name |
Type |
Description |
|
||
|
MailerContract
Plugin Mailer Service
Namespace
Plenty\Plugin\Mail\Contracts
Methods
public sendHtml($html, $recipients, $subject = "", $cc = [], $bcc = [], $replyTo = null, $attachments = []):voidSend an email containing html
Name |
Type |
Description |
|
The HTML-String for the email body |
|
|
Either a string containing a single email address or an array of strings containing multiple email addresses |
|
|
Optional. The subject of the message |
|
|
Optional. Array of strings containing email addresses which the message should be sent to as cc |
|
|
Optional. Array of strings containing email addresses which the message should be sent to as bcc |
|
|
Optional. ReplyToRecipient model with mailaddress and name attributes |
|
|
Optional. A list of StorageObject objects ( see Plenty\Modules\Plugin\Storage\Contracts\StorageRepositoryContract ) |
public sendFromTwig($twigPath, $data, $recipients, $subject = "", $altConfig = [], $cc = [], $bcc = [], $replyTo = null, $attachments = []):voidSend an email that will get rendered by twig
Name |
Type |
Description |
|
The path to the twig template file that should be used to render the mail. E.g.: 'PluginNamespace::mail.my_mail' |
|
|
An associative array of data that will be available to the twig template |
|
|
Either a string containing a single email address or an array of strings containing multiple email addresses |
|
|
Optional. The subject of the message |
|
|
Optional. Alternative email config. If present MUST be an associative array with the keys 'host', 'port', 'username', 'password' and 'encryption'. It CAN optionally have a key 'from' to set the sender-address to something else than specified in the system config. If 'from' is missing, the system-wide configured sender-address is used. |
|
|
Optional. Array of strings containing email addresses which the message should be sent to as cc |
|
|
Optional. Array of strings containing email addresses which the message should be sent to as bcc |
|
|
Optional. ReplyToRecipient model with mailaddress and name attributes |
|
|
Optional. A list of StorageObject objects ( see Plenty\Modules\Plugin\Storage\Contracts\StorageRepositoryContract ) |
public sendFromMime($mimeMessage, $recipients, $altConfig = [], $cc = [], $bcc = [], $replyTo = null, $attachments = []):voidSend given message as email
Name |
Type |
Description |
|
Complete email mime source header included |
|
|
Either a string containing a single email address or an array of strings containing multiple email addresses |
|
|
Optional. Alternative email config. If present MUST be an associative array with the keys 'host', 'port', 'username', 'password' and 'encryption'. It CAN optionally have a key 'from' to set the sender-address to something else than specified in the system config. If 'from' is missing, the system-wide configured sender-address is used. |
|
|
Optional. Array of strings containing email addresses which the message should be sent to as cc |
|
|
Optional. Array of strings containing email addresses which the message should be sent to as bcc |
|
|
Optional. ReplyToRecipient model with mailaddress and name attributes |
|
|
Optional. A list of StorageObject objects ( see Plenty\Modules\Plugin\Storage\Contracts\StorageRepositoryContract ) |
Models
AwsSesCredentials
the credential model for AWS SES client.
Namespace
Plenty\Plugin\Mail\Models
| Name | Type | Description |
|---|---|---|
region |
AWS region e.g. eu-west-1 |
|
accessKeyId |
User access key |
|
secretAccessKey |
User secret access key |
Methods
public toArray()Returns this model as an array.
the email model.
Namespace
Plenty\Plugin\Mail\Models
| Name | Type | Description |
|---|---|---|
bccAddresses |
BCC email address |
|
ccAddresses |
CC email address |
|
toAddresses |
To email address |
|
senderAddress |
Sender email address |
|
replyToAddresses |
Reply to email address |
|
subject |
Email subject |
|
htmlBody |
HTML email body |
|
plainTextBody |
Plain text email body |
|
rawMessage |
MIME message, if set subject, html and plainText are ignored |
Methods
public toArray()Returns this model as an array.
Templates
Extensions
Factories
TwigFactory
Twig Factory
Namespace
Plenty\Plugin\Templates\Factories
Methods
public register():voidpublic createSimpleFunction($name, $callable, $params = []):Plenty\Plugin\Templates\Extensions\Twig_SimpleFunctionReturn type: Twig_SimpleFunction
Name |
Type |
Description |
|
||
|
||
|
An array of parameters |
public createSimpleFilter($name, $callable, $params = []):Plenty\Plugin\Templates\Extensions\Twig_SimpleFilterReturn type: Twig_SimpleFilter
Name |
Type |
Description |
|
||
|
||
|
An array of parameters |
Repositories
Contracts
DeleteResponseContract
DeleteResponse Interface
Namespace
Plenty\Repositories\Contracts
Methods
public getAffectedRows():intpublic setAffectedRows($value):voidName |
Type |
Description |
|
public increment():intpublic decrement():intPaginationResponseContract
Contract for PaginationResponse
Namespace
Plenty\Repositories\Contracts
Methods
public getTotal():voidpublic setTotal($total):voidName |
Type |
Description |
|
public getPage():voidpublic setPage($page):voidName |
Type |
Description |
|
public getEntriesPerPage():voidpublic setEntriesPerPage($epp):voidName |
Type |
Description |
|
public getResult():voidpublic setResult($entries):voidName |
Type |
Description |
|
public toJson($options):stringConvert the object to its JSON representation.
Name |
Type |
Description |
|
public toArray():arrayGet the instance as an array.
Criteria
Models
FilteredPaginatedResult
Filtered paginated result
Namespace
Plenty\Repositories\Models
Methods
public getFilters():arraypublic setFilters($filters):voidName |
Type |
Description |
|
public toArray():arrayGet the instance as an array.
public paginate():Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
public getPage():intReturns the page number as received
public getCurrentPage():intReturns the normalized page number - checked if out of logical bounds ( not below 0, not greater than the last page ) and adjusted
public getTotalCount():intpublic isLastPage():boolpublic getItemIndexFrom():intpublic getItemIndexTo():intpublic getLastPage():intpublic getResult():arraypublic setResult($result):voidName |
Type |
Description |
|
public sumMetaData($metaColumn = "", $groupBy = "", $metaDataName = ""):voidName |
Type |
Description |
|
||
|
||
|
public rowCountMetaData($metaColumn = "", $groupBy = "", $metaDataName = ""):voidName |
Type |
Description |
|
||
|
||
|
public toJson($options):stringConvert the object to its JSON representation.
Name |
Type |
Description |
|
public jsonSerialize():voidSpecify data which should be serialized to JSON
PaginatedResult
paginated result
Namespace
Plenty\Repositories\Models
Methods
public paginate():Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
public getPage():intReturns the page number as received
public getCurrentPage():intReturns the normalized page number - checked if out of logical bounds ( not below 0, not greater than the last page ) and adjusted
public getTotalCount():intpublic isLastPage():boolpublic getItemIndexFrom():intpublic getItemIndexTo():intpublic getLastPage():intpublic getResult():arraypublic setResult($result):voidName |
Type |
Description |
|
public sumMetaData($metaColumn = "", $groupBy = "", $metaDataName = ""):voidName |
Type |
Description |
|
||
|
||
|
public rowCountMetaData($metaColumn = "", $groupBy = "", $metaDataName = ""):voidName |
Type |
Description |
|
||
|
||
|
public toArray():arrayGet the instance as an array.
public toJson($options):stringConvert the object to its JSON representation.
Name |
Type |
Description |
|
public jsonSerialize():voidSpecify data which should be serialized to JSON
Services
RequestPaginationOptionsProvider
Array pagination
Namespace
Plenty\Repositories\Services
Methods
public setCurrentItemsPerPage($currentItemsPerPage):Plenty\Repositories\Services\RequestPaginationOptionsProviderReturn type: RequestPaginationOptionsProvider
Name |
Type |
Description |
|
public setCurrentPage($currentPage):Plenty\Repositories\Services\RequestPaginationOptionsProviderReturn type: RequestPaginationOptionsProvider
Name |
Type |
Description |
|
public getCurrentItemsPerPage():intpublic getCurrentPage():intSimpleArrayPagination
Array pagination
Namespace
Plenty\Repositories\Services
Methods
public buildResult($page, $offset):Illuminate\Support\CollectionCriteria
Containers
CriteriaContainer
Register repository criteria
Namespace
Plenty\Repositories\Criteria\Containers
Methods
public add($repository, $criteria, $key):Plenty\Repositories\Criteria\Containers\CriteriaContainerReturn type: CriteriaContainer
Use this method to add criteria to a existing repository.
Name |
Type |
Description |
|
The repository that should use the criteria |
|
|
The criteria class name that should be used. |
|
|
The key that should match the given criteria. |
Contracts
CriteriableContract
Interface which provides the possibility to use Criteria filters.
Namespace
Plenty\Repositories\Criteria\Contracts
Methods
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
Validation
Contracts
Attribute
Common interface for attribute classes
Namespace
Plenty\Validation\Contracts
Methods
public getAttributeName():stringReturns the attribute's name
public setAttributeName($attributeName):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Sets the attribute's name
Name |
Type |
Description |
|
public accepted():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be yes, on, 1, or true. This is useful for validating "Terms of Service" acceptance.
public customRule($rule, $params):Plenty\Validation\Contracts\AttributeReturn type: Attribute
Add custom Role
Name |
Type |
Description |
|
||
|
public activeUrl():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid URL according to the checkdnsrr PHP function.
public dateAfter($fieldNameOrTimeStr):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a value after a given date. The dates will be passed into the strtotime PHP function. Instead of passing a date string to be evaluated by strtotime, you may specify another field to compare against the date
Name |
Type |
Description |
|
public alphabetic():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be entirely alphabetic characters.
public alphaDash():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation may have alpha-numeric characters, as well as dashes and underscores.
public alphaNum():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be entirely alpha-numeric characters.
public isArray():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a PHP array.
public dateBefore($fieldNameOrTimeStr):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a value preceding the given date. The dates will be passed into the PHP strtotime function.
Name |
Type |
Description |
|
public between($min, $max):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must have a size between the given min and max. Strings, numerics, and files are evaluated in the same fashion as the size rule.
Name |
Type |
Description |
|
||
|
public boolean():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be able to be cast as a boolean. Accepted input are true, false, 1, 0, "1", and "0".
public confirmed():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must have a matching field of foo_confirmation. For example, if the field under validation is password, a matching password_confirmation field must be present in the input.
public present():Plenty\Validation\Contracts\AttributeReturn type: Attribute
Validate that an attribute exists even if not filled.
public date():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid date according to the strtotime PHP function.
public dateFormat($format):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must match the given format. The format will be evaluated using the PHP date_parse_from_format function. You should use either date or date_format when validating a field, not both.
Name |
Type |
Description |
|
public dateW3C($allowTimestamps = false):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid w3c formated date time string.
Name |
Type |
Description |
|
Allow timestamps as a valid format as well. |
public inTimestampRange():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a w3c formated date time string that is in the MySQL timestamp range (1970 to 2037).
public validOrderId():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid order ID for an order that is not deleted.
public validOrderItemId():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid order item ID for an order that is not deleted.
public validPlentyId():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid plentyId.
public validPlentyUrl():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid plentyId.
public validPlentyDomain():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a unique domain.
public typeFromDb($table, $column, $attribute, $comparisonKey = "id"):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must have the type specified in the database.
Name |
Type |
Description |
|
The table with the data type |
|
|
The column with the data type |
|
|
The attribute in the validator with the key |
|
|
The column to in $table to compare $attribute to. Default is 'id'. |
public hexColor():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid HEX color (like "#a3d" or "#a0787c").
public rgbColor():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid RGB or RGBA color (like "rgb(0, 200, 150)" or "rgba(0, 200, 150, 0.52)").
public cssColor():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid predefined CSS color (like "aquamarine" or "skyblue").
public color():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid color (HEX like "#a0787c", RGB like "rgb(0, 200, 150)" or CSS like "aquamarine")
public uuid5():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid UUID version 5.
public validDbType():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid data type used by the validation rule 'typeFromDb'.
public validCurrency():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid currency string (e.g. 'EUR').
public different($fieldName):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must have a different value than field.
Name |
Type |
Description |
|
public digits($count):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be numeric and must have an exact length of $count.
Name |
Type |
Description |
|
public digitsBetween($min, $max):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must have a length between the given min and max.
Name |
Type |
Description |
|
||
|
public email():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be formatted as an e-mail address.
public exists($table, $columns = []):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must exist on a given database table.
Name |
Type |
Description |
|
||
|
public image():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The file under validation must be an image (jpeg, png, bmp, gif, or svg)
public in($values):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be included in the given list of values.
Name |
Type |
Description |
|
public integer():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be an integer.
public ip():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be an IP address.
public json():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must a valid JSON string.
public max($value):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be less than or equal to a maximum value. Strings, numerics, and files are evaluated in the same fashion as the size rule.
Name |
Type |
Description |
|
public mimeTypes($types):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The file under validation must have a MIME type corresponding to one of the listed extensions.
Name |
Type |
Description |
|
public min($value):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must have a minimum value. Strings, numerics, and files are evaluated in the same fashion as the size rule.
Name |
Type |
Description |
|
public notIn($values):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must not be included in the given list of values.
Name |
Type |
Description |
|
public numeric():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be numeric.
public regex($pattern):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must match the given regular expression.
Name |
Type |
Description |
|
public required():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be present in the input data and not empty. A field is considered "empty" is one of the following conditions are true: The value is null. The value is an empty string. The value is an empty array or empty Countable object. The value is an uploaded file with no path.
public requiredIf($fieldName, $value):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be present if the anotherfield field is equal to any value.
Name |
Type |
Description |
|
||
|
public requiredUnless($fieldName, $value):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be present unless the anotherfield field is equal to any value.
Name |
Type |
Description |
|
||
|
public requiredWith($fieldNames):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be present only if any of the other specified fields are present.
Name |
Type |
Description |
|
public requiredWithAll($fieldNames):Plenty\Validation\Contracts\AttributeReturn type: Attribute
required_with_all
Name |
Type |
Description |
|
public requiredWithout($fieldNames):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be present only when any of the other specified fields are not present.
Name |
Type |
Description |
|
public requiredWithoutAll($fieldNames):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be present only when all of the other specified fields are not present.
Name |
Type |
Description |
|
public notLike($fieldName):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be not like the specified name.
Name |
Type |
Description |
|
public same($fieldName):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The given field must match the field under validation.
Name |
Type |
Description |
|
public size($value):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must have a size matching the given value. For string data, value corresponds to the number of characters. For numeric data, value corresponds to a given integer value. For files, size corresponds to the file size in kilobytes.
Name |
Type |
Description |
|
public string():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a string.
public timezone():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid timezone identifier according to the timezone_identifiers_list PHP function.
public unique($table, $column, $except = null, $idColumn = null):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be unique on a given database table. If the column option is not specified, the field name will be used.
Name |
Type |
Description |
|
||
|
||
|
||
|
public url():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid URL according to PHP's filter_var function.
public sometimes():Plenty\Validation\Contracts\AttributeReturn type: Attribute
In some situations, you may wish to run validation checks against a field only if that field is present in the input array. To quickly accomplish this, add the sometimes rule.
public nullable():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation may be null. This is particularly useful when validating primitive such as strings and integers that can contain null values.
public validBoardTaskReferenceValue():Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be a valid board task reference type (e.g. {@link BoardTaskReferenceType::CONTACT}).
public arrayKeysInList($acceptedKeysList):Plenty\Validation\Contracts\AttributeReturn type: Attribute
The field under validation must be an array and must contain only the keys in the provided accepted list.
Name |
Type |
Description |
|
Illuminate
Support
MessageBag
Namespace
Illuminate\Support
Methods
public keys():arrayGet the keys present in the message bag.
public add($key, $message):Illuminate\Support\MessageBagReturn type: MessageBag
Add a message to the message bag.
Name |
Type |
Description |
|
||
|
public addIf($boolean, $key, $message):Illuminate\Support\MessageBagReturn type: MessageBag
Add a message to the message bag if the given conditional is "true".
Name |
Type |
Description |
|
||
|
||
|
public merge($messages):Illuminate\Support\MessageBagReturn type: MessageBag
Merge a new array of messages into the message bag.
Name |
Type |
Description |
|
public has($key):boolDetermine if messages exist for all of the given keys.
Name |
Type |
Description |
|
public hasAny($keys = []):boolDetermine if messages exist for any of the given keys.
Name |
Type |
Description |
|
public first($key = null, $format = null):stringGet the first message from the message bag for a given key.
Name |
Type |
Description |
|
||
|
public get($key, $format = null):arrayGet all of the messages from the message bag for a given key.
Name |
Type |
Description |
|
||
|
public all($format = null):arrayGet all of the messages for every key in the message bag.
Name |
Type |
Description |
|
public unique($format = null):arrayGet all of the unique messages for every key in the message bag.
Name |
Type |
Description |
|
public messages():arrayGet the raw messages in the message bag.
public getMessages():arrayGet the raw messages in the message bag.
public getMessageBag():Illuminate\Support\Illuminate\Support\MessageBagReturn type: MessageBag
Get the messages for the instance.
public getFormat():stringGet the default message format.
public setFormat($format = ":message"):Illuminate\Support\Illuminate\Support\MessageBagReturn type: MessageBag
Set the default message format.
Name |
Type |
Description |
|
public isEmpty():boolDetermine if the message bag has any messages.
public isNotEmpty():boolDetermine if the message bag has any messages.
public any():boolDetermine if the message bag has any messages.
public count():intGet the number of messages in the message bag.
public toArray():arrayGet the instance as an array.
public jsonSerialize():arrayConvert the object into something JSON serializable.
public toJson($options):stringConvert the object to its JSON representation.
Name |
Type |
Description |
|
Collection
Namespace
Illuminate\Support
Methods
public all():arrayGet all of the items in the collection.
public avg($callback = null):voidGet the average value of a given key.
Name |
Type |
Description |
|
public mode($key = null):arrayGet the mode of a given key.
Name |
Type |
Description |
|
public collapse():Illuminate\Support\CollectionReturn type: Collection
Collapse the collection of items into a single array.
public contains($key, $operator = null, $value = null):boolDetermine if an item exists in the collection.
Name |
Type |
Description |
|
||
|
||
|
public containsStrict($key, $value = null):boolDetermine if an item exists, using strict comparison.
Name |
Type |
Description |
|
||
|
public crossJoin($lists):Illuminate\Support\CollectionReturn type: Collection
Cross join with the given lists, returning all possible permutations.
Name |
Type |
Description |
|
public diff($items):Illuminate\Support\CollectionReturn type: Collection
Get the items in the collection that are not present in the given items.
Name |
Type |
Description |
|
public diffAssoc($items):Illuminate\Support\CollectionReturn type: Collection
Get the items in the collection whose keys and values are not present in the given items.
Name |
Type |
Description |
|
public diffKeys($items):Illuminate\Support\CollectionReturn type: Collection
Get the items in the collection whose keys are not present in the given items.
Name |
Type |
Description |
|
public except($keys):Illuminate\Support\CollectionReturn type: Collection
Get all items except for those with the specified keys.
Name |
Type |
Description |
|
public filter($callback = null):Illuminate\Support\CollectionReturn type: Collection
Run a filter over each of the items.
Name |
Type |
Description |
|
public first($callback = null, $default = null):voidGet the first item from the collection passing the given truth test.
Name |
Type |
Description |
|
||
|
public flip():Illuminate\Support\CollectionReturn type: Collection
Flip the items in the collection.
public forget($keys):Illuminate\Support\CollectionReturn type: Collection
Remove an item from the collection by key.
Name |
Type |
Description |
|
public get($key, $default = null):voidGet an item from the collection by key.
Name |
Type |
Description |
|
||
|
public groupBy($groupBy, $preserveKeys = false):Illuminate\Support\CollectionReturn type: Collection
Group an associative array by a field or using a callback.
Name |
Type |
Description |
|
||
|
public keyBy($keyBy):Illuminate\Support\CollectionReturn type: Collection
Key an associative array by a field or using a callback.
Name |
Type |
Description |
|
public has($key):boolDetermine if an item exists in the collection by key.
Name |
Type |
Description |
|
public implode($value, $glue = null):stringConcatenate values of a given key as a string.
Name |
Type |
Description |
|
||
|
public intersect($items):Illuminate\Support\CollectionReturn type: Collection
Intersect the collection with the given items.
Name |
Type |
Description |
|
public intersectByKeys($items):Illuminate\Support\CollectionReturn type: Collection
Intersect the collection with the given items by key.
Name |
Type |
Description |
|
public isEmpty():boolDetermine if the collection is empty or not.
public keys():Illuminate\Support\CollectionReturn type: Collection
Get the keys of the collection items.
public last($callback = null, $default = null):voidGet the last item from the collection.
Name |
Type |
Description |
|
||
|
public pluck($value, $key = null):Illuminate\Support\CollectionReturn type: Collection
Get the values of a given key.
Name |
Type |
Description |
|
||
|
public map($callback):Illuminate\Support\CollectionReturn type: Collection
Run a map over each of the items.
Name |
Type |
Description |
|
public mapToDictionary($callback):Illuminate\Support\CollectionReturn type: Collection
Run a dictionary map over the items.
Name |
Type |
Description |
|
public mapWithKeys($callback):Illuminate\Support\CollectionReturn type: Collection
Run an associative map over each of the items.
Name |
Type |
Description |
|
public merge($items):Illuminate\Support\CollectionReturn type: Collection
Merge the collection with the given items.
Name |
Type |
Description |
|
public combine($values):Illuminate\Support\CollectionReturn type: Collection
Create a collection by using this collection for keys and another for its values.
Name |
Type |
Description |
|
public union($items):Illuminate\Support\CollectionReturn type: Collection
Union the collection with the given items.
Name |
Type |
Description |
|
public nth($step, $offset):Illuminate\Support\CollectionReturn type: Collection
Create a new collection consisting of every n-th element.
Name |
Type |
Description |
|
||
|
public only($keys):Illuminate\Support\CollectionReturn type: Collection
Get the items with the specified keys.
Name |
Type |
Description |
|
public pop($count = 1):Illuminate\Support\CollectionReturn type: Collection
Get and remove the last N items from the collection.
Name |
Type |
Description |
|
public prepend($value, $key = null):Illuminate\Support\CollectionReturn type: Collection
Push an item onto the beginning of the collection.
Name |
Type |
Description |
|
||
|
public push($values):Illuminate\Support\CollectionReturn type: Collection
Push one or more items onto the end of the collection.
Name |
Type |
Description |
|
public pull($key, $default = null):voidGet and remove an item from the collection.
Name |
Type |
Description |
|
||
|
public put($key, $value):Illuminate\Support\CollectionReturn type: Collection
Put an item in the collection by key.
Name |
Type |
Description |
|
||
|
public random($number = null):Illuminate\Support\CollectionReturn type: Collection
Get one or a specified number of items randomly from the collection.
Name |
Type |
Description |
|
public reverse():Illuminate\Support\CollectionReturn type: Collection
Reverse items order.
public search($value, $strict = false):voidSearch the collection for a given value and return the corresponding key if successful.
Name |
Type |
Description |
|
||
|
public shift($count = 1):Illuminate\Support\CollectionReturn type: Collection
Get and remove the first N items from the collection.
Name |
Type |
Description |
|
public shuffle($seed = null):Illuminate\Support\CollectionReturn type: Collection
Shuffle the items in the collection.
Name |
Type |
Description |
|
public slice($offset, $length = null):Illuminate\Support\CollectionReturn type: Collection
Slice the underlying collection array.
Name |
Type |
Description |
|
||
|
public split($numberOfGroups):Illuminate\Support\CollectionReturn type: Collection
Split a collection into a certain number of groups.
Name |
Type |
Description |
|
public chunk($size):Illuminate\Support\CollectionReturn type: Collection
Chunk the collection into chunks of the given size.
Name |
Type |
Description |
|
public sort($callback = null):Illuminate\Support\CollectionReturn type: Collection
Sort through each item with a callback.
Name |
Type |
Description |
|
public splice($offset, $length = null, $replacement = []):Illuminate\Support\CollectionReturn type: Collection
Splice a portion of the underlying collection array.
Name |
Type |
Description |
|
||
|
||
|
public take($limit):Illuminate\Support\CollectionReturn type: Collection
Take the first or last {$limit} items.
Name |
Type |
Description |
|
public transform($callback):Illuminate\Support\CollectionReturn type: Collection
Transform each item in the collection using a callback.
Name |
Type |
Description |
|
public unique($key = null, $strict = false):Illuminate\Support\CollectionReturn type: Collection
Return only unique items from the collection array.
Name |
Type |
Description |
|
||
|
public values():Illuminate\Support\CollectionReturn type: Collection
Reset the keys on the underlying array.
public zip($items):Illuminate\Support\CollectionReturn type: Collection
Zip the collection together with one or more arrays.
Name |
Type |
Description |
|
public pad($size, $value):Illuminate\Support\CollectionReturn type: Collection
Pad collection to the specified length with a value.
Name |
Type |
Description |
|
||
|
public count():intCount the number of items in the collection.
public offsetExists($key):boolDetermine if an item exists at an offset.
Name |
Type |
Description |
|
public offsetGet($key):voidGet an item at a given offset.
Name |
Type |
Description |
|
public offsetSet($key, $value):voidSet the item at a given offset.
Name |
Type |
Description |
|
||
|
public offsetUnset($key):voidUnset the item at a given offset.
Name |
Type |
Description |
|
public static make($items = []):Illuminate\Support\CollectionReturn type: Collection
Create a new collection instance if the value isn't one already.
Name |
Type |
Description |
|
public static wrap($value):Illuminate\Support\CollectionReturn type: Collection
Wrap the given value in a collection if applicable.
Name |
Type |
Description |
|
public static unwrap($value):arrayGet the underlying items from the given collection if applicable.
Name |
Type |
Description |
|
public static times($number, $callback = null):Illuminate\Support\CollectionReturn type: Collection
Create a new collection by invoking the callback a given amount of times.
Name |
Type |
Description |
|
||
|
public average($callback = null):voidAlias for the "avg" method.
Name |
Type |
Description |
|
public each($callback):Illuminate\Support\CollectionReturn type: Collection
Execute a callback over each item.
Name |
Type |
Description |
|
public eachSpread($callback):Illuminate\Support\CollectionReturn type: Collection
Execute a callback over each nested chunk of items.
Name |
Type |
Description |
|
public every($key, $operator = null, $value = null):boolDetermine if all items pass the given truth test.
Name |
Type |
Description |
|
||
|
||
|
public firstWhere($key, $operator = null, $value = null):voidGet the first item by the given key value pair.
Name |
Type |
Description |
|
||
|
||
|
public isNotEmpty():boolDetermine if the collection is not empty.
public mapSpread($callback):Illuminate\Support\CollectionReturn type: Collection
Run a map over each nested chunk of items.
Name |
Type |
Description |
|
public mapToGroups($callback):Illuminate\Support\CollectionReturn type: Collection
Run a grouping map over the items.
Name |
Type |
Description |
|
public flatMap($callback):Illuminate\Support\CollectionReturn type: Collection
Map a collection and flatten the result by a single level.
Name |
Type |
Description |
|
public mapInto($class):Illuminate\Support\CollectionReturn type: Collection
Map the values into a new class.
Name |
Type |
Description |
|
public min($callback = null):voidGet the min value of a given key.
Name |
Type |
Description |
|
public max($callback = null):voidGet the max value of a given key.
Name |
Type |
Description |
|
public forPage($page, $perPage):Illuminate\Support\CollectionReturn type: Collection
"Paginate" the collection by slicing it into a smaller collection.
Name |
Type |
Description |
|
||
|
public partition($key, $operator = null, $value = null):Illuminate\Support\CollectionReturn type: Collection
Partition the collection into two arrays using the given callback or key.
Name |
Type |
Description |
|
||
|
||
|
public sum($callback = null):voidGet the sum of the given values.
Name |
Type |
Description |
|
public where($key, $operator = null, $value = null):Illuminate\Support\CollectionReturn type: Collection
Filter items by the given key value pair.
Name |
Type |
Description |
|
||
|
||
|
public whereStrict($key, $value):Illuminate\Support\CollectionReturn type: Collection
Filter items by the given key value pair using strict comparison.
Name |
Type |
Description |
|
||
|
public whereIn($key, $values, $strict = false):Illuminate\Support\CollectionReturn type: Collection
Filter items by the given key value pair.
Name |
Type |
Description |
|
||
|
||
|
public whereInStrict($key, $values):Illuminate\Support\CollectionReturn type: Collection
Filter items by the given key value pair using strict comparison.
Name |
Type |
Description |
|
||
|
public whereNotIn($key, $values, $strict = false):Illuminate\Support\CollectionReturn type: Collection
Filter items by the given key value pair.
Name |
Type |
Description |
|
||
|
||
|
public whereNotInStrict($key, $values):Illuminate\Support\CollectionReturn type: Collection
Filter items by the given key value pair using strict comparison.
Name |
Type |
Description |
|
||
|
public pipe($callback):voidPass the collection to the given callback and return the result.
Name |
Type |
Description |
|
public reduce($callback, $initial = null):voidReduce the collection to a single value.
Name |
Type |
Description |
|
||
|
public reject($callback = true):Illuminate\Support\CollectionReturn type: Collection
Create a collection of all elements that do not pass a given truth test.
Name |
Type |
Description |
|
public tap($callback):Illuminate\Support\CollectionReturn type: Collection
Pass the collection to the given callback and then return it.
Name |
Type |
Description |
|
public uniqueStrict($key = null):Illuminate\Support\CollectionReturn type: Collection
Return only unique items from the collection array using strict comparison.
Name |
Type |
Description |
|
public toArray():arrayGet the collection of items as a plain array.
public jsonSerialize():arrayConvert the object into something JSON serializable.
public toJson($options):stringGet the collection of items as JSON.
Name |
Type |
Description |
|
public static proxy($method):voidAdd a method to the list of proxied methods.
Name |
Type |
Description |
|
public when($value = null, $callback = null, $default = null):Illuminate\Support\CollectionReturn type: Collection
Apply the callback if the given "value" is (or resolves to) truthy.
Name |
Type |
Description |
|
||
|
||
|
public unless($value = null, $callback = null, $default = null):Illuminate\Support\CollectionReturn type: Collection
Apply the callback if the given "value" is (or resolves to) falsy.
Name |
Type |
Description |
|
||
|
||
|
public static macro($name, $macro):voidRegister a custom macro.
Name |
Type |
Description |
|
||
|
public static hasMacro($name):boolChecks if macro is registered.
Name |
Type |
Description |
|
Carbon
Carbon
Namespace
Carbon
| Name | Type | Description |
|---|---|---|
year |
||
yearIso |
||
month |
||
day |
||
hour |
||
minute |
||
second |
||
micro |
||
microsecond |
||
timestamp |
||
englishDayOfWeek |
||
shortEnglishDayOfWeek |
||
englishMonth |
||
shortEnglishMonth |
||
milliseconds |
||
millisecond |
||
milli |
||
week |
||
isoWeek |
||
weekYear |
||
isoWeekYear |
||
dayOfYear |
||
age |
||
offset |
||
offsetMinutes |
||
offsetHours |
||
timezone |
||
tz |
Methods
public copy():Carbon\CarbonReturn type: Carbon
Returns a present instance in the same timezone.
public setDateTime($year, $month, $day, $hour, $minute, $second, $microseconds):Carbon\CarbonReturn type: Carbon
Set the date and time all together.
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
||
|
||
|
public setTimeFromTimeString($time):Carbon\CarbonReturn type: Carbon
Set the time by time string.
Name |
Type |
Description |
|
public timezone($value):Carbon\CarbonReturn type: Carbon
Set the timezone or returns the timezone name if no arguments passed.
Name |
Type |
Description |
|
public setDateFrom($date = null):Carbon\CarbonReturn type: Carbon
Set the year, month, and date for this instance to that of the passed instance.
Name |
Type |
Description |
|
now if null |
public setTimeFrom($date = null):Carbon\CarbonReturn type: Carbon
Set the hour, minute, second and microseconds for this instance to that of the passed instance.
Name |
Type |
Description |
|
now if null |
public static getDays():arrayGet the days of the week
public static getWeekStartsAt():intGet the first day of week
public static setWeekStartsAt($day):voidName |
Type |
Description |
|
week start day (or 'auto' to get the first day of week from Carbon::getLocale() culture). |
public static getWeekEndsAt():intGet the last day of week
public static setWeekEndsAt($day):voidName |
Type |
Description |
|
week end day (or 'auto' to get the day before the first day of week from Carbon::getLocale() culture). |
public static getWeekendDays():arrayGet weekend days
public static setWeekendDays($days):voidName |
Type |
Description |
|
public static hasRelativeKeywords($time):boolDetermine if a time string will produce a relative date.
Name |
Type |
Description |
|
public static setUtf8($utf8):voidName |
Type |
Description |
|
public formatLocalized($format):stringFormat the instance with the current locale. You can set the current locale using setlocale() https://php.net/setlocale.
Name |
Type |
Description |
|
public startOfDay():Carbon\CarbonReturn type: Carbon
Resets the time to 23:59:59.999999 end of day
public startOfMonth():Carbon\CarbonReturn type: Carbon
Resets the date to the first day of the month and the time to 00:00:00
public endOfMonth():Carbon\CarbonReturn type: Carbon
Resets the date to end of the month and time to 23:59:59.999999
public startOfQuarter():Carbon\CarbonReturn type: Carbon
Resets the date to the first day of the quarter and the time to 00:00:00
public endOfQuarter():Carbon\CarbonReturn type: Carbon
Resets the date to end of the quarter and time to 23:59:59.999999
public startOfYear():Carbon\CarbonReturn type: Carbon
Resets the date to the first day of the year and the time to 00:00:00
public endOfYear():Carbon\CarbonReturn type: Carbon
Resets the date to end of the year and time to 23:59:59.999999
public startOfDecade():Carbon\CarbonReturn type: Carbon
Resets the date to the first day of the decade and the time to 00:00:00
public endOfDecade():Carbon\CarbonReturn type: Carbon
Resets the date to end of the decade and time to 23:59:59.999999
public startOfCentury():Carbon\CarbonReturn type: Carbon
Resets the date to the first day of the century and the time to 00:00:00
public endOfCentury():Carbon\CarbonReturn type: Carbon
Resets the date to end of the century and time to 23:59:59.999999
public startOfWeek($weekStartsAt = null):Carbon\CarbonReturn type: Carbon
Resets the date to the first day of week (defined in $weekStartsAt) and the time to 00:00:00
Name |
Type |
Description |
|
optional start allow you to specify the day of week to use to start the week |
public endOfWeek($weekEndsAt = null):Carbon\CarbonReturn type: Carbon
Resets the date to end of week (defined in $weekEndsAt) and time to 23:59:59.999999
Name |
Type |
Description |
|
optional start allow you to specify the day of week to use to end the week |
public startOfHour():Carbon\CarbonReturn type: Carbon
Modify to start of current hour, minutes and seconds become 0
public endOfHour():Carbon\CarbonReturn type: Carbon
Modify to end of current hour, minutes and seconds become 59
public startOfMinute():Carbon\CarbonReturn type: Carbon
Modify to start of current minute, seconds become 0
public endOfMinute():Carbon\CarbonReturn type: Carbon
Modify to end of current minute, seconds become 59
public eq($date):boolDetermines if the instance is equal to another
Name |
Type |
Description |
|
public equalTo($date):boolDetermines if the instance is equal to another
Name |
Type |
Description |
|
public ne($date):boolDetermines if the instance is not equal to another
Name |
Type |
Description |
|
public notEqualTo($date):boolDetermines if the instance is not equal to another
Name |
Type |
Description |
|
public gt($date):boolDetermines if the instance is greater (after) than another
Name |
Type |
Description |
|
public greaterThan($date):boolDetermines if the instance is greater (after) than another
Name |
Type |
Description |
|
public gte($date):boolDetermines if the instance is greater (after) than or equal to another
Name |
Type |
Description |
|
public greaterThanOrEqualTo($date):boolDetermines if the instance is greater (after) than or equal to another
Name |
Type |
Description |
|
public lt($date):boolDetermines if the instance is less (before) than another
Name |
Type |
Description |
|
public lessThan($date):boolDetermines if the instance is less (before) than another
Name |
Type |
Description |
|
public lte($date):boolDetermines if the instance is less (before) or equal to another
Name |
Type |
Description |
|
public lessThanOrEqualTo($date):boolDetermines if the instance is less (before) or equal to another
Name |
Type |
Description |
|
public between($date1, $date2, $equal = true):boolDetermines if the instance is between two others.
Name |
Type |
Description |
|
||
|
||
|
Indicates if an equal to comparison should be done |
public isWeekday():boolDetermines if the instance is a weekday.
public isWeekend():boolDetermines if the instance is a weekend day.
public isYesterday():boolDetermines if the instance is yesterday.
public isToday():boolDetermines if the instance is today.
public isTomorrow():boolDetermines if the instance is tomorrow.
public isFuture():boolDetermines if the instance is in the future, ie. greater (after) than now.
public isPast():boolDetermines if the instance is in the past, ie. less (before) than now.
public isLeapYear():boolDetermines if the instance is a leap year.
public isLongYear():boolDetermines if the instance is a long year (using calendar year).
public isSameAs($format, $date = null):boolCompares the formatted values of the two dates.
Name |
Type |
Description |
|
date formats to compare. |
|
|
instance to compare with or null to use current day. |
public isSameQuarter($date = null, $ofSameYear = true):boolChecks if the passed in date is in the same quarter as the instance quarter (and year if needed).
Name |
Type |
Description |
|
The instance to compare with or null to use current day. |
|
|
Check if it is the same month in the same year. |
public isSameMonth($date = null, $ofSameYear = true):boolChecks if the passed in date is in the same month as the instance´s month.
Name |
Type |
Description |
|
The instance to compare with or null to use the current date. |
|
|
Check if it is the same month in the same year. |
public isDayOfWeek($dayOfWeek):boolChecks if this day is a specific day of the week.
Name |
Type |
Description |
|
public isBirthday($date = null):boolCheck if its the birthday. Compares the date/month values of the two dates.
Name |
Type |
Description |
|
The instance to compare with or null to use current day. |
public isLastOfMonth():boolCheck if today is the last day of the Month
public static hasFormat($date, $format):boolChecks if the (date)time string is in a given format.
Name |
Type |
Description |
|
||
|
public toDateString():stringFormat the instance as date
public toFormattedDateString():stringFormat the instance as a readable date
public toTimeString($unitPrecision = "second"):stringFormat the instance as time
Name |
Type |
Description |
|
public toDateTimeString($unitPrecision = "second"):stringFormat the instance as date and time
Name |
Type |
Description |
|
public toDayDateTimeString():stringFormat the instance with day, date and time
public toAtomString():stringFormat the instance as ATOM
Format the instance as COOKIE
public toIso8601String():stringFormat the instance as ISO8601
public toRfc822String():stringFormat the instance as RFC822
public toIso8601ZuluString($unitPrecision = "second"):stringConvert the instance to UTC and return as Zulu ISO8601
Name |
Type |
Description |
|
public toRfc850String():stringFormat the instance as RFC850
public toRfc1036String():stringFormat the instance as RFC1036
public toRfc1123String():stringFormat the instance as RFC1123
public toRfc2822String():stringFormat the instance as RFC2822
public toRfc3339String($extended = false):stringFormat the instance as RFC3339
Name |
Type |
Description |
|
public toRssString():stringFormat the instance as RSS
public toW3cString():stringFormat the instance as W3C
public toRfc7231String():stringFormat the instance as RFC7231
public toArray():arrayGet default array representation.
public static resetToStringFormat():voidReset the format used to the default when type juggling a Carbon instance to a string
public static setToStringFormat($format):voidName |
Type |
Description |
|
public static instance($date):Carbon\CarbonReturn type: Carbon
Create a Carbon instance from a DateTime one.
Name |
Type |
Description |
|
public static parse($time = null, $tz = null):Carbon\CarbonReturn type: Carbon
Create a carbon instance from a string.
Name |
Type |
Description |
|
||
|
public static now($tz = null):Carbon\CarbonReturn type: Carbon
Get a Carbon instance for the current date and time.
Name |
Type |
Description |
|
public static today($tz = null):Carbon\CarbonReturn type: Carbon
Create a Carbon instance for today.
Name |
Type |
Description |
|
public static tomorrow($tz = null):Carbon\CarbonReturn type: Carbon
Create a Carbon instance for tomorrow.
Name |
Type |
Description |
|
public static yesterday($tz = null):Carbon\CarbonReturn type: Carbon
Create a Carbon instance for yesterday.
Name |
Type |
Description |
|
public static maxValue():Carbon\CarbonReturn type: Carbon
Create a Carbon instance for the greatest supported date.
public static minValue():Carbon\CarbonReturn type: Carbon
Create a Carbon instance for the lowest supported date.
public static create($year, $month = 1, $day = 1, $hour, $minute, $second, $tz = null):Carbon\CarbonReturn type: Carbon
Create a new Carbon instance from a specific date and time.
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
||
|
||
|
public static createSafe($year = null, $month = null, $day = null, $hour = null, $minute = null, $second = null, $tz = null):Carbon\CarbonReturn type: Carbon
Create a new safe Carbon instance from a specific date and time.
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
||
|
||
|
public static createFromDate($year = null, $month = null, $day = null, $tz = null):Carbon\CarbonReturn type: Carbon
Create a Carbon instance from just a date. The time portion is set to now.
Name |
Type |
Description |
|
||
|
||
|
||
|
public static createMidnightDate($year = null, $month = null, $day = null, $tz = null):Carbon\CarbonReturn type: Carbon
Create a Carbon instance from just a date. The time portion is set to midnight.
Name |
Type |
Description |
|
||
|
||
|
||
|
public static createFromTime($hour, $minute, $second, $tz = null):Carbon\CarbonReturn type: Carbon
Create a Carbon instance from just a time. The date portion is set to today.
Name |
Type |
Description |
|
||
|
||
|
||
|
public static createFromTimeString($time, $tz = null):Carbon\CarbonReturn type: Carbon
Create a Carbon instance from a time string. The date portion is set to today.
Name |
Type |
Description |
|
||
|
public diffInYears($date = null, $absolute = true):intGet the difference in years
Name |
Type |
Description |
|
||
|
Get the absolute of the difference |
public diffInMonths($date = null, $absolute = true):intGet the difference in months rounded down.
Name |
Type |
Description |
|
||
|
Get the absolute of the difference |
public diffInWeeks($date = null, $absolute = true):intGet the difference in weeks rounded down.
Name |
Type |
Description |
|
||
|
Get the absolute of the difference |
public diffInDays($date = null, $absolute = true):intGet the difference in days rounded down.
Name |
Type |
Description |
|
||
|
Get the absolute of the difference |
public diffInWeekdays($date = null, $absolute = true):intGet the difference in weekdays rounded down.
Name |
Type |
Description |
|
||
|
Get the absolute of the difference |
public diffInWeekendDays($date = null, $absolute = true):intGet the difference in weekend days using a filter rounded down.
Name |
Type |
Description |
|
||
|
Get the absolute of the difference |
public diffInHours($date = null, $absolute = true):intGet the difference in hours rounded down.
Name |
Type |
Description |
|
||
|
Get the absolute of the difference |
public diffInRealHours($date = null, $absolute = true):intGet the difference in hours rounded down using timestamps.
Name |
Type |
Description |
|
||
|
Get the absolute of the difference |
public diffInMinutes($date = null, $absolute = true):intGet the difference in minutes rounded down.
Name |
Type |
Description |
|
||
|
Get the absolute of the difference |
public diffInRealMinutes($date = null, $absolute = true):intGet the difference in minutes rounded down using timestamps.
Name |
Type |
Description |
|
||
|
Get the absolute of the difference |
public diffInSeconds($date = null, $absolute = true):intGet the difference in seconds rounded down.
Name |
Type |
Description |
|
||
|
Get the absolute of the difference |
public diffInRealSeconds($date = null, $absolute = true):intGet the difference in seconds using timestamps.
Name |
Type |
Description |
|
||
|
Get the absolute of the difference |
public secondsSinceMidnight():intThe number of seconds since midnight.
public secondsUntilEndOfDay():intThe number of seconds until 23:59:59.
public diffForHumans($other = null, $syntax = null, $short = false, $parts = 1, $options = null):stringGet the difference in a human readable format in the current locale from current instance to an other instance given (or now if null given).
Name |
Type |
Description |
|
if array passed, will be used as parameters array, see $syntax below; if null passed, now will be used as comparison reference; if any other type, it will be converted to date and used as reference. |
|
|
if array passed, parameters will be extracted from it, the array may contains: - 'syntax' entry (see below) - 'short' entry (see below) - 'parts' entry (see below) - 'options' entry (see below) - 'skip' entry, list of units to skip (array of strings or a single string, ` it can be the unit name (singular or plural) or its shortcut ` (y, m, w, d, h, min, s, ms, µs). - 'aUnit' entry, prefer "an hour" over "1 hour" if true - 'join' entry determines how to join multiple parts of the string ` - if $join is a string, it’s used as a joiner glue ` - if $join is a callable/closure, it get the list of string and should return a string ` - if $join is an array, the first item will be the default glue, and the second item ` will be used instead of the glue for the last item ` - if $join is true, it will be guessed from the locale ('list' translation file entry) ` - if $join is missing, a space will be used as glue - 'other' entry (see above) - 'minimumUnit' entry determines the smallest unit of time to display can be long or ` short form of the units, e.g. 'hour' or 'h' (default value: s) if int passed, it add modifiers: Possible values: - CarbonInterface::DIFF_ABSOLUTE no modifiers - CarbonInterface::DIFF_RELATIVE_TO_NOW add ago/from now modifier - CarbonInterface::DIFF_RELATIVE_TO_OTHER add before/after modifier Default value: CarbonInterface::DIFF_ABSOLUTE |
|
|
displays short format of time units |
|
|
maximum number of parts to display (default value: 1: single unit) |
|
|
human diff options |
public static macro($name, $macro):voidRegister a custom macro.
Name |
Type |
Description |
|
||
|
public static hasMacro($name):boolChecks if macro is registered globally.
Name |
Type |
Description |
|
public static getMidDayAt():intget midday/noon hour
public static setMidDayAt($hour):voidName |
Type |
Description |
|
midday hour |
public midDay():Carbon\CarbonReturn type: Carbon
Modify to midday, default to self::$midDayAt
public next($modifier = null):Carbon\CarbonReturn type: Carbon
Modify to the next occurrence of a given modifier such as a day of the week. If no modifier is provided, modify to the next occurrence of the current day of the week. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.
Name |
Type |
Description |
|
public nextWeekday():Carbon\CarbonReturn type: Carbon
Go backward to the previous weekend day.
public previous($modifier = null):Carbon\CarbonReturn type: Carbon
Modify to the previous occurrence of a given modifier such as a day of the week. If no dayOfWeek is provided, modify to the previous occurrence of the current day of the week. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.
Name |
Type |
Description |
|
public firstOfMonth($dayOfWeek = null):Carbon\CarbonReturn type: Carbon
Modify to the first occurrence of a given day of the week in the current month. If no dayOfWeek is provided, modify to the first day of the current month. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.
Name |
Type |
Description |
|
public lastOfMonth($dayOfWeek = null):Carbon\CarbonReturn type: Carbon
Modify to the last occurrence of a given day of the week in the current month. If no dayOfWeek is provided, modify to the last day of the current month. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.
Name |
Type |
Description |
|
public nthOfMonth($nth, $dayOfWeek):voidModify to the given occurrence of a given day of the week in the current month. If the calculated occurrence is outside the scope of the current month, then return false and no modifications are made.
Name |
Type |
Description |
|
||
|
public firstOfQuarter($dayOfWeek = null):Carbon\CarbonReturn type: Carbon
Modify to the first occurrence of a given day of the week in the current quarter. If no dayOfWeek is provided, modify to the first day of the current quarter. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.
Name |
Type |
Description |
|
day of the week default null |
public lastOfQuarter($dayOfWeek = null):Carbon\CarbonReturn type: Carbon
Modify to the last occurrence of a given day of the week in the current quarter. If no dayOfWeek is provided, modify to the last day of the current quarter. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.
Name |
Type |
Description |
|
day of the week default null |
public nthOfQuarter($nth, $dayOfWeek):voidModify to the given occurrence of a given day of the week in the current quarter. If the calculated occurrence is outside the scope of the current quarter, then return false and no modifications are made.
Name |
Type |
Description |
|
||
|
public firstOfYear($dayOfWeek = null):Carbon\CarbonReturn type: Carbon
Modify to the first occurrence of a given day of the week in the current year. If no dayOfWeek is provided, modify to the first day of the current year. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.
Name |
Type |
Description |
|
day of the week default null |
public lastOfYear($dayOfWeek = null):Carbon\CarbonReturn type: Carbon
Modify to the last occurrence of a given day of the week in the current year. If no dayOfWeek is provided, modify to the last day of the current year. Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.
Name |
Type |
Description |
|
day of the week default null |
public nthOfYear($nth, $dayOfWeek):voidModify to the given occurrence of a given day of the week in the current year. If the calculated occurrence is outside the scope of the current year, then return false and no modifications are made.
Name |
Type |
Description |
|
||
|
public average($date = null):Carbon\CarbonReturn type: Carbon
Modify the current instance to the average of a given instance (default now) and the current instance (second-precision).
Name |
Type |
Description |
|
public closest($date1, $date2):Carbon\CarbonReturn type: Carbon
Get the closest date from the instance (second-precision).
Name |
Type |
Description |
|
||
|
public farthest($date1, $date2):Carbon\CarbonReturn type: Carbon
Get the farthest date from the instance (second-precision).
Name |
Type |
Description |
|
||
|
public min($date = null):Carbon\CarbonReturn type: Carbon
Get the minimum instance between a given instance (default now) and the current instance.
Name |
Type |
Description |
|
public minimum($date = null):Carbon\CarbonReturn type: Carbon
Get the minimum instance between a given instance (default now) and the current instance.
Name |
Type |
Description |
|
public max($date = null):Carbon\CarbonReturn type: Carbon
Get the maximum instance between a given instance (default now) and the current instance.
Name |
Type |
Description |
|
public maximum($date = null):Carbon\CarbonReturn type: Carbon
Get the maximum instance between a given instance (default now) and the current instance.
Name |
Type |
Description |
|
public static useMonthsOverflow($monthsOverflow = true):voidName |
Type |
Description |
|
public static resetMonthsOverflow():voidpublic static shouldOverflowMonths():boolGet the month overflow global behavior (can be overridden in specific instances).
public static useYearsOverflow($yearsOverflow = true):voidName |
Type |
Description |
|
public static resetYearsOverflow():voidpublic static shouldOverflowYears():boolGet the month overflow global behavior (can be overridden in specific instances).
public static setHumanDiffOptions($humanDiffOptions):voidName |
Type |
Description |
|
public static enableHumanDiffOption($humanDiffOption):voidName |
Type |
Description |
|
public static disableHumanDiffOption($humanDiffOption):voidName |
Type |
Description |
|
public static getHumanDiffOptions():intReturn default humanDiff() options (merged flags as integer).
public serialize():stringReturn a serialized string of the instance.
public static fromSerialized($value):Carbon\CarbonReturn type: Carbon
Create an instance from a serialized string.
Name |
Type |
Description |
|
public jsonSerialize():voidPrepare the object for JSON serialization.
public static serializeUsing($callback):voidName |
Type |
Description |
|
public static createFromTimestamp($timestamp, $tz = null):Carbon\CarbonReturn type: Carbon
Create a Carbon instance from a timestamp and set the timezone (use default one if not specified).
Name |
Type |
Description |
|
||
|
public static createFromTimestampUTC($timestamp):Carbon\CarbonReturn type: Carbon
Create a Carbon instance from an timestamp keeping the timezone to UTC.
Name |
Type |
Description |
|
public static createFromTimestampMs($timestamp, $tz = null):Carbon\CarbonReturn type: Carbon
Create a Carbon instance from a timestamp in milliseconds.
Name |
Type |
Description |
|
||
|
public timestamp($unixTimestamp):Carbon\CarbonReturn type: Carbon
Set the instance's timestamp.
Name |
Type |
Description |
|
public isSunday():boolChecks if the instance day is sunday.
public isMonday():boolChecks if the instance day is monday.
public isTuesday():boolChecks if the instance day is tuesday.
public isWednesday():boolChecks if the instance day is wednesday.
public isThursday():boolChecks if the instance day is thursday.
public isFriday():boolChecks if the instance day is friday.
public isSaturday():boolChecks if the instance day is saturday.
public isSameYear($date = null):boolChecks if the given date is in the same year as the instance. If null passed, compare to now (with the same timezone).
Name |
Type |
Description |
|
public isCurrentYear():boolChecks if the instance is in the same year as the current moment.
public isNextYear():boolChecks if the instance is in the same year as the current moment next year.
public isLastYear():boolChecks if the instance is in the same year as the current moment last year.
public isNextWeek():boolChecks if the instance is in the same week as the current moment next week.
public isLastWeek():boolChecks if the instance is in the same week as the current moment last week.
public isSameDay($date = null):boolChecks if the given date is in the same day as the instance. If null passed, compare to now (with the same timezone).
Name |
Type |
Description |
|
public isCurrentMonth():boolChecks if the instance is in the same month as the current moment.
public isNextMonth():boolChecks if the instance is in the same month as the current moment next month.
public isLastMonth():boolChecks if the instance is in the same month as the current moment last month.
public isCurrentQuarter():boolChecks if the instance is in the same quarter as the current moment.
public isNextQuarter():boolChecks if the instance is in the same quarter as the current moment next quarter.
public isLastQuarter():boolChecks if the instance is in the same quarter as the current moment last quarter.
public year($value):CarbonSet current instance year to the given value.
Name |
Type |
Description |
|
public month($value):CarbonSet current instance month to the given value.
Name |
Type |
Description |
|
public day($value):CarbonSet current instance day to the given value.
Name |
Type |
Description |
|
public hour($value):CarbonSet current instance hour to the given value.
Name |
Type |
Description |
|
public minute($value):CarbonSet current instance minute to the given value.
Name |
Type |
Description |
|
public second($value):CarbonSet current instance second to the given value.
Name |
Type |
Description |
|
public addYears($value = 1):CarbonAdd years (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public addYear():CarbonAdd one year to the instance (using date interval).
public subYears($value = 1):CarbonSub years (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public subYear():CarbonSub one year to the instance (using date interval).
public addYearsWithOverflow($value = 1):CarbonAdd years (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
Name |
Type |
Description |
|
public addYearWithOverflow():CarbonAdd one year to the instance (using date interval) with overflow explicitly allowed.
public subYearsWithOverflow($value = 1):CarbonSub years (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
Name |
Type |
Description |
|
public subYearWithOverflow():CarbonSub one year to the instance (using date interval) with overflow explicitly allowed.
public addYearsNoOverflow($value = 1):CarbonAdd years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
Name |
Type |
Description |
|
public addYearNoOverflow():CarbonAdd one year to the instance (using date interval) with overflow explicitly forbidden.
public subYearsNoOverflow($value = 1):CarbonSub years (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
Name |
Type |
Description |
|
public subYearNoOverflow():CarbonSub one year to the instance (using date interval) with overflow explicitly forbidden.
public addMonths($value = 1):CarbonAdd months (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public addMonth():CarbonAdd one month to the instance (using date interval).
public subMonths($value = 1):CarbonSub months (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public subMonth():CarbonSub one month to the instance (using date interval).
public addMonthsWithOverflow($value = 1):CarbonAdd months (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
Name |
Type |
Description |
|
public addMonthWithOverflow():CarbonAdd one month to the instance (using date interval) with overflow explicitly allowed.
public subMonthsWithOverflow($value = 1):CarbonSub months (the $value count passed in) to the instance (using date interval) with overflow explicitly allowed.
Name |
Type |
Description |
|
public subMonthWithOverflow():CarbonSub one month to the instance (using date interval) with overflow explicitly allowed.
public addMonthsNoOverflow($value = 1):CarbonAdd months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
Name |
Type |
Description |
|
public addMonthNoOverflow():CarbonAdd one month to the instance (using date interval) with overflow explicitly forbidden.
public subMonthsNoOverflow($value = 1):CarbonSub months (the $value count passed in) to the instance (using date interval) with overflow explicitly forbidden.
Name |
Type |
Description |
|
public subMonthNoOverflow():CarbonSub one month to the instance (using date interval) with overflow explicitly forbidden.
public addDays($value = 1):CarbonAdd days (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public addDay():CarbonAdd one day to the instance (using date interval).
public subDays($value = 1):CarbonSub days (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public subDay():CarbonSub one day to the instance (using date interval).
public addHours($value = 1):CarbonAdd hours (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public addHour():CarbonAdd one hour to the instance (using date interval).
public subHours($value = 1):CarbonSub hours (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public subHour():CarbonSub one hour to the instance (using date interval).
public addMinutes($value = 1):CarbonAdd minutes (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public addMinute():CarbonAdd one minute to the instance (using date interval).
public subMinutes($value = 1):CarbonSub minutes (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public subMinute():CarbonSub one minute to the instance (using date interval).
public addSeconds($value = 1):CarbonAdd seconds (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public addSecond():CarbonAdd one second to the instance (using date interval).
public subSeconds($value = 1):CarbonSub seconds (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public subSecond():CarbonSub one second to the instance (using date interval).
public addCenturies($value = 1):CarbonAdd centuries (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public addCentury():CarbonAdd one century to the instance (using date interval).
public subCenturies($value = 1):CarbonSub centuries (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public subCentury():CarbonSub one century to the instance (using date interval).
public addQuarters($value = 1):CarbonAdd quarters (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public addQuarter():CarbonAdd one quarter to the instance (using date interval).
public subQuarters($value = 1):CarbonSub quarters (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public subQuarter():CarbonSub one quarter to the instance (using date interval).
public addWeeks($value = 1):CarbonAdd weeks (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public addWeek():CarbonAdd one week to the instance (using date interval).
public subWeeks($value = 1):CarbonSub weeks (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public subWeek():CarbonSub one week to the instance (using date interval).
public addWeekdays($value = 1):CarbonAdd weekdays (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public addWeekday():CarbonAdd one weekday to the instance (using date interval).
public subWeekdays($value = 1):CarbonSub weekdays (the $value count passed in) to the instance (using date interval).
Name |
Type |
Description |
|
public subWeekday():CarbonSub one weekday to the instance (using date interval).
public addRealSeconds($value = 1):CarbonAdd seconds (the $value count passed in) to the instance (using timestamp).
Name |
Type |
Description |
|
public addRealSecond():CarbonAdd one second to the instance (using timestamp).
public subRealSeconds($value = 1):CarbonSub seconds (the $value count passed in) to the instance (using timestamp).
Name |
Type |
Description |
|
public subRealSecond():CarbonSub one second to the instance (using timestamp).
public addRealMinutes($value = 1):CarbonAdd minutes (the $value count passed in) to the instance (using timestamp).
Name |
Type |
Description |
|
public addRealMinute():CarbonAdd one minute to the instance (using timestamp).
public subRealMinutes($value = 1):CarbonSub minutes (the $value count passed in) to the instance (using timestamp).
Name |
Type |
Description |
|
public subRealMinute():CarbonSub one minute to the instance (using timestamp).
public addRealHours($value = 1):CarbonAdd hours (the $value count passed in) to the instance (using timestamp).
Name |
Type |
Description |
|
public addRealHour():CarbonAdd one hour to the instance (using timestamp).
public subRealHours($value = 1):CarbonSub hours (the $value count passed in) to the instance (using timestamp).
Name |
Type |
Description |
|
public subRealHour():CarbonSub one hour to the instance (using timestamp).