Download the PHP package soluble/flexstore without Composer
On this page you can find all versions of the php package soluble/flexstore. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download soluble/flexstore
More information about soluble/flexstore
Files in soluble/flexstore
Package flexstore
Short Description FlexStore
License MIT
Homepage https://github.com/belgattitude/soluble-flexstore
FAQ
Example:
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 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.
Informations about the package flexstore
soluble/flexstore
Introduction
Features
- Extensible datasource
- ColumModel alteration
- Renderers and formatters
- Custom writers
Requirements
- PHP engine 5.6+, 7.0+
Documentation
- Manual in progress and API documentation available.
Installation
Instant installation via composer.
Most modern frameworks will include Composer out of the box, but ensure the following file is included:
Quick start
API
Getting a store
Getting a store from a zend-db select.
Retrieving data on a store
Getting the ColumnModel
API
Store
Soluble\FlexStore\Store
| Methods | Return | Comment |
|---|---|---|
__construct(SourceInterface $source) |
Resultset\ResultsetInterface |
|
getData(Options $options=null) |
Resultset\ResultsetInterface |
|
getColumnModel() |
Column\ColumnModel |
|
getSource() |
Source\SourceInterface |
Options
Soluble\FlexStore\Options can be used to alter the data retrieval process.
| Methods | Return | Comment |
|---|---|---|
setLimit($limit, $offset=null) |
Options |
Fluent interface |
getLimit() |
integer |
|
getOffset() |
integer |
|
hasLimit() |
boolean |
|
hasOffset() |
boolean |
|
getHydrationOptions() |
HydrationOptions |
Resultset
The Store::getData() method returns a resultset implementing the Resultset\ResultsetInterface.
This interface is traversable, countable and implements the Iterator interface (foreach...)
| Methods | Return | Comment |
|---|---|---|
count() |
integer |
Number of results |
getFieldCount() |
integer |
Number of fields/columns |
toArray() |
array |
|
current() |
ArrayObject |
The current row |
getDataSource() |
Source\SourceInterface |
The underlying source |
ColumnModel
ColumnModel allows to alter the way columns will be retrieved or displayed.
It must be called before the Store::getData() method.
Basic information
| Methods | Return | Comment |
|---|---|---|
getColumns($include_excluded=false) |
ArrayObject |
|
get(string $column) |
Column |
|
exists(string $column) |
boolean |
Sorting columns
Changing the order of the retrieved columns.
| Methods | Return | Comment |
|---|---|---|
sort(array $sorted_columns) |ColumnModel` |
Fluent |
Getting or setting exclusions
Excluded columns are not retrieved by the Store::getData() method.
| Methods | Return | Comment |
|---|---|---|
exclude(array|string $columns) |
ColumnModel |
Fluent |
includeOnly(array|string $columns) |
ColumnModel |
All others will be excluded |
getExcluded() |
array |
Adding virtual columns
Adding a column that does not exists in the underlying source. The value of this column is generally computed by a renderer.
| Methods | Return | Comment |
|---|---|---|
add(Column $column, string $after_column=null) |ColumnModel` |
Fluent |
Searching columns
You can search the column model for columns matching a specific pattern.
| Methods | Return | Comment |
|---|---|---|
search() |
ColumnModel\Search |
see operations on the search object |
Metadata
Metadata are currently retrieved automatically (this will probably change ...)
| Methods | Return | Comment |
|---|---|---|
setMetadata(ColumnsMetadata $metadata) |
ColumnModel |
Search on ColumnModel
You can search the column model for columns matching a specific pattern and apply actions on the result.
| Methods | Return | Comment |
|---|---|---|
all() |
Search\Result |
|
findByType(string $type) |
Search\Result |
|
in(array $columns) |
Search\Result |
|
notIn(array $columns) |
Search\Result |
|
regexp(string $regexp) |
Search\Result |
|
findByType(string $type) |
Search\Result |
|
findVirtual() |
Search\Result |
With the associated Search\Result you can easily
Search on ColumnModel
You can search the column model for columns matching a specific pattern and apply actions on the result.
| Methods | Return | Comment |
|---|---|---|
setEditable(boolean $editable=true) |
Search\Result |
|
setExcluded(boolean $excluded=true) |
Search\Result |
|
setFilterable(boolean $filterable=true) |
Search\Result |
|
setGroupable(boolean $groupable=true) |
Search\Result |
|
setSortable(boolean $sortable=true) |
Search\Result |
|
setHidden(boolean $hidden=true) |
Search\Result |
|
setWidth(int|float|string $width) |
Search\Result |
Supported drivers
Contributing
Contribution are welcome see contribution guide
Coding standards
All versions of flexstore with dependencies
ext-intl Version *
soluble/metadata Version ^1.3
soluble/spreadsheet Version 0.*
zendframework/zend-paginator Version ^2.4.0 || ^3.0.0
soluble/dbwrapper Version ^1.3 || ^2.0
symfony/polyfill-iconv Version ^1.3.0