Download the PHP package dimonka2/flatform without Composer

On this page you can find all versions of the php package dimonka2/flatform. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of dimonka2/flatform

Informations about the package flatform

Laravel Flatform

Packagist Packagist [Packagist]()

HTML control rendering helper for Laravel and Livewire

Features

Install

composer require dimonka2/flatform

Publish provider:

$ php artisan vendor:publish --provider="dimonka2\flatform\FlatformServiceProvider"

Configure

Coming soon

Using in the blade

Following text creates text inputs with labels

Depending on styles the code above will generate something like:

Included elements, inputs and components

Documentation

Coming soon

TableComponent

In order to create a Livewire TableComponent you cave to create a class in your Livewire folder that is derived from TableComponent class. See following sample code:

This component will generate a table with a user list with 4 columns.

Table component properties and functions

Class: dimonka2\flatform\Livewire\TableComponent

Property Default Usage
idField 'id' ID field that needs to be is equal to key column name field. This field is required to be properly setup if you use Table Select or Table Details functions
selectAll false Indicates whether user has clicked 'Select all' checkbox
search null Current search string
searchDebounce 500 Search input bounce time, see Livewire documentation
order "" Currently ordered column name. The format could be a name as a string or an array like ['fieldName' => 'DESC]
length 10 Currently selected number of elements per page
class ??
expanded [] Array of expanded row IDs
filtered [] Array of filter values
selected [] Array of selected row IDs
info // make it false to exclude info column
table Contains the current instance of Table definition
rowsReady null Indicates that table rows are queried and prepared for rendering
scrollUp true Scrolls page up to the table header after paginator click
Table component has also few functions, that can be called, defined or overridden: Function Defined Parameters Usage
getTable() yes This is the main function that returns Table class that describes the table properties. This function has to return class dimonka2\flatform\Form\Components\Table\Table
getQuery() no Enables defining table query as a separate function, it has to return Builder class
getSelect() no Enables defining table Select as a separate function
getDetails() no Enables defining table Details as a separate function
getActions() no Enables defining table Actions as a separate function
getFilters() no Enables defining table Filters as a separate function
getView() yes $viewName By overriding this function you may replace default table views by your own views blades
getLengthOptions() yes Enables to override length option: number of items per page in filter dropdown

Table definition properties

Class: dimonka2\flatform\Form\Components\Table\Table

Property Default Usage
actions null Define table actions as sub array
columns [] Sub array with table column definitions. See Table Column properties section
details null Enables table row details as sub array options. See Table Details properties section
filters null Enables table query filters as sub array options. See Table Filter properties section
lengthOptions [10, 20, 30, 50, 100] Number of items per page in filter dropdown
evenOddClasses ['even', 'odd'] Array with even/odd classes
query null Laravel Builder query that might contain any kind of joins, whereExists, with or Counts
search null Setting this property to false will disable and hide table search functionality
select null Enables and define row select options as sub array options. See Table Select properties section
rows null Sub array with table rows definitions. You can define content of rows and columns without setting up query property
formatters [] Lookup array for custom column formatters
formatFunction null TD element format closure function
links null Setting this property to false will hide pagination links
rowRenderCallback null Callback required for a Livewire table to separate table from rows rendering, currently unused. Closure parameters: ($row, $html, $details = false)
rowPreRenderCallback null Allows to update row definition before it is rendered to HTML. Closure parameters ($row, array $def): array
order null Default ordered column. Can be defined as a column name or as false to disable table ordering

Table Column properties

Property Default Usage
name null Field name, this name is queried from the query via select, also the row data will use field name as a key
title null Column title used in a header. Title might be in Flatform rendering format
search false Setting this property to true will include this column in text search query
sort ASC Setting to false will disable sort by this column, setting column to "DESC" will make DESC as default (first) sort order
system false Setting this property to true means a virtual (calculated) field without adding it to select query statement with disabled sort and search. Useful for calculated fields and menu elements
class null Class will be added to column's TD and TH tag class attribute
titleClass null Class will be added to column's TH tag class attribute
tdClass null Class will be added to column's TD tag class attribute
hide false true denotes that this column will not be rendered
raw null This option might be used when you need a calculated value and it used as DB:raw select statement
noSelect null Setting this to true denotes a special case for some columns are in a select statement and there is no need to add an extra select, like “count()”
as see usage This property specifies field alias and how this column will be mapped to the Model attributes. If this field is undefined for a column fields with table name like users.name will have a replacement of dot to '' e.g. `usersname`
format null Column format: callable (IColumnFormat), Flatform language definition or container
_format null Quick column format: 'number','link', 'check', 'str' or an array with additional parameters
width null Column width style. Column width will be added to the header style and each TD tag style

Table Details properties

Table Details is a pull down row that may contain any additional details connected to the row including even Livewire components.

Property Default Usage
expander Flatform expander You may override default table expander by defining this property. See default expander setup in TableDetails::default_expander
callback null Closure function that should return the content of the row details, defined as function ($row){}
disabled false Setting this option to true will disable details
title null Detail column title
class null Style classes that will be applied to the expander TD element
trClass null Style classes that will be applied to the details TR element
tdClass null Style classes that will be applied to the details TD element
width null Expander column width style

Example of table with details:

Table Select properties

Table Select is an additional checkbox in most left column that enables to select table rows. Property Default Usage
checkbox Flatform checkbox Definition of the checkbox in flatform format
headerCheckbox Flatform checkbox Definition of the checkbox in header that works as "select all" in flatform format
column ???
disabled false Setting this option to true will disable Table Select
width null Checkbox column width style
selectCallback null Callback function used internally by the TableComponent to determine whether the row is selected
class null Style classes that will be applied to the selected row TR element

Example of table with Select that will highlight selected rows using class table-primary:

Table Action properties

Table actions should be defined together with TableSelect as they currently rendered for selected items.

Property Default Usage
name Action unique name. This can be ignored. See example.
position null array where action is rendered: selection, dropdown, row, row-dd
title action title or label
disabled false Setting this option to true will disable this action
callback Action callback. This can be ignored. See example.
attributes All other elements. Those attributes are populated automatically from the unspecified action properties

Example of table with Table Select and Actions:

Table Filter properties

Filter is a basic Flatform input control that is associated with persistent input and a closure function that can be attached to filter query based on the user input. Property Default Usage
name Filter name, assigned to input. This name is used to map filter input. Name has to be unique.
title Filter control title or label
type Filter type: checkbox, select, text
disabled false Disables filter
value Default value
list Item list for select, might be a closure
filterFunction Filter callback in format: function($query, $data) {}

All versions of flatform with dependencies

PHP Build Version
Package Version
Requires php Version ^7 | ^8
laravelcollective/html Version ^6 | ^7
livewire/livewire Version ^1 | ^2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package dimonka2/flatform contains the following files

Loading the files please wait ....