Orr-projects

CodeIgniter + Grocery CRUD + Login-GroceryCrud + Bootstrap + Orr-projects is an Application Development Framework

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Java SE Downloads - NetBeans + JDK Bundle - Oracle http://www.oracle.com/technetwork/articles/javase/jdk-netbeans-jsp-142931.html
Clone or download https://github.com/Theptarin/Orr-projects

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you have to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

Dropwizard - The web framework used
Maven - Dependency Management
ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Billie Thompson - Initial work - PurpleBooth

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Hat tip to anyone who's code was used
Inspiration
etc

Testing

CRUD Examples http://127.0.0.1/Orr-projects/index.php/examples/
Bootstrap Examples http://getbootstrap.com/getting-started/

Checking

application -- config --- database.php

Codeing

PHP Style Guide https://codeigniter.com/user_guide/general/styleguide.html

Function

default_as : Default value of the field.

Requirement

MySQL
CodeIgniter

How to "Install"

There are 3 files that you need to drag into your project:

application/controllers/Login.php
application/models/Login_model.php
application/views/login.php

Configure it (optional)

You can edit the views/login.php as you wish (but if you leave as is it's out-of-the-box responsive and working) -AND- you can look into the controllers/Login.php file because on the top of the file there are a couple of configuration (and translations) than you can manage easily.

That's it.

How it works

It use an SQL table named "crud_users" with "username","password" and "permissions" fields. It will be created automagically if doesn't exists AND an admin user will be created too, so you can log in immediately! The "permissions" field can store anything (VARCHAR 255) like a json_encode() array or just a keyword or a number, so you can manage the permissions of that user.

Users Permissions Management

From V2.0 there is a complete and cool GRID Permissions Management for EACH table. You can create infinite groups. You have the ability to choose 'ID Only, Read List, Read Single, Add, Edit and Delete' permission for each table of your database.

There is a WIKI page with the instruction on how it works: https://github.com/portapipe/Login-GroceryCrud/wiki/Table-Permission-Management-(GRID)

If you want to create your custom user management system you can go here: https://github.com/portapipe/Login-GroceryCrud/wiki/Manage-the-users

Advanced tools

A model file comes with the release and contains some basics stuff:

isLogged() - Return true if the player is logged, false if is not (here you can add a redirect("/login") )
logout(redirect=true) - log out the user and make an instant redirect to the login page (pass 'false' as argument to not redirect)
permission() - return the user's permission field of the database or the username if the permission field doesn't exists
permissions(), getPermission() and getPermissions() are aliases of permission()
id() - return the user-id of the logged user
name() username() - return the username of the user

TO USE IT you just need to load the library into your controllers files like that:

$this->load->model("login_model");

and use it like:

if($this->login_model->isLogged()){
    $name = $this->login_model->name();
    echo "HI $name! You are Logged IN!";
}else{
    redirect("/login");
}

Pretty easy, uh?

Example: Self-Made Custom Permissions for GroceryCrud

If you need a pre-made permissions system with full control of every permission take a look here

Note: I'm using some names like 'admin' or 'author' for the example but you can use really anything you want!

In this example you have a blog website. You need an "admin" user, an "author" user and a "revisioner" user.

The "admin" users will have any permission, so create the basic CRUD page with any permission you want to give them, like the ability to manage any user. The "author" users can add and see their own articles, so we must show them just their work. We can use a $crud->where('author',$this->login_model->id()) and force the field 'author' in the add page to be the author's ID and non-editable by the user. Finally the "revisioner" users can edit and delete any articles BUT can't add a new one, so we can unset the add button with $crud->unset_add() and we are done.

$permission = $this->login_model->permission();
if($permission=="admin"){
    echo "Hey, you're the boss, you can do anything!";
}

if($permission=="author"){
    $crud->where('author',$this->login_model->id());
    $crud->callback_before_insert(array($this,'useAuthorID'));
}
function useAuthorID($post_array) {
    $post_array['author'] = $this->login_model->id();
    return $post_array;
}   

if($permission=="revisioner"){
    $crud->unset_add();
}

if($permission==""){
    echo "I think you shouldn't be here...";
    //and we can force a login to the user with
    //$this->login_model->logout();
}

josephjlee / orr-projects Goto Github PK

orr-projects's Introduction