Git Product home page Git Product logo

doctrine-orderable's Introduction

Orderable

author: Jo Carter [email protected]

version: 3.0

Introduction

Behaviour to make a doctrine model orderable/ sortable.

Adds a column called position to the model, and automatically handles adding and deleting of items within the list

Usage

Add as an external in lib/doctrine_extensions

In the schema.yml

actAs:
  Orderable:
    groupBy:      columnname       # optional parameter to order within a subset

In the code

To reorder an item:

  • $item->moveUp()
  • $item->moveDown()
  • $item->moveTop()
  • $item->moveBottom()

To find the maximum position:

  • $item->getMaxPosition()

To reset the order:

  • $item->resetOrder()

NOTE: Reset order is very useful to call if you add Orderable behaviour after there are already items in the database. It will add orders to the items based on their position in the DB (within the group as specified, specifically using created_at if it exists) It can also be used to correct ordering if items are maunually deleting from the database

Changelog

Version 3.0 - renamed 'ordr' to 'position' to reflect other Sortable/ Orderable extensions (and to avoid misspelling problems)

Version 2.0 - added resetOrder(), groupBy functions correctly

doctrine-orderable's People

Contributors

angelsk avatar

Stargazers

 avatar Ben Lancaster avatar

Watchers

Kolba avatar James Cloos avatar Jimmy Wong avatar  avatar Joe Harlow avatar

Forkers

angelsk

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.