Skip to content

Commit 34423e2

Browse files
author
Pe Ell
authored
Merge pull request #16 from cybercog/feature/readme-and-license
Updated license info and readme
2 parents 1388fd9 + 9da9720 commit 34423e2

File tree

73 files changed

+93
-86
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+93
-86
lines changed

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
All notable changes to `laravel-eloquent-flag` will be documented in this file.
44

5-
## 3.0.0 - [Unreleased]
5+
## 3.0.0 - 2017-01-07
66

77
### Added
88

@@ -14,13 +14,13 @@ All notable changes to `laravel-eloquent-flag` will be documented in this file.
1414

1515
- Each Flag trait was spliced on 2 additional traits: `Has{Name}Flag` = `Has{Name}FlagScope` + `Has{Name}FlagHelpers`.
1616
- Kept Flag trait was spliced on 3 additional traits, because events were pulled out to `HasKeptFlagBehavior` trait.
17-
- Flags `Classic\Accepted`, `Classic\Active` & `Classic\Approved` methods were changed. Details in the [UPGRADING.md](UPGRADING.md).
17+
- Flags `Classic\Accepted`, `Classic\Active` & `Classic\Approved` methods were changed. Details in the [Upgrade Guide](UPGRADE.md).
1818

19-
## 2.1.0 - 2016-01-04
19+
## 2.1.0 - 2017-01-04
2020

2121
- `is_closed` inverse boolean flag added.
2222

23-
## 2.0.0 - 2016-01-04
23+
## 2.0.0 - 2017-01-04
2424

2525
### Breaking changes
2626

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2016, CyberCog LLC (http://cybercog.ru).
3+
Copyright (c) 2017, Anton Komarev <a.komarev@cybercog.su>
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
# Laravel Eloquent Flag
1+
![cog-laravel-eloquent-flag-3](https://cloud.githubusercontent.com/assets/1849174/21735581/feb857cc-d47b-11e6-80fa-126be1a1d871.png)
22

3-
[![Build Status](https://img.shields.io/travis/cybercog/laravel-eloquent-flag/master.svg?style=flat-square)](https://travis-ci.org/cybercog/laravel-eloquent-flag)
4-
[![StyleCI](https://styleci.io/repos/69245607/shield)](https://styleci.io/repos/69245607)
5-
[![Releases](https://img.shields.io/github/release/cybercog/laravel-eloquent-flag.svg?style=flat-square)](https://github.com/cybercog/laravel-eloquent-flag/releases)
6-
[![License](https://img.shields.io/github/license/cybercog/laravel-eloquent-flag.svg?style=flat-square)](https://github.com/cybercog/laravel-eloquent-flag/blob/master/LICENSE)
3+
<p align="center">
4+
<a href="https://travis-ci.org/cybercog/laravel-eloquent-flag"><img src="https://img.shields.io/travis/cybercog/laravel-eloquent-flag/master.svg?style=flat-square" alt="Build Status"></a>
5+
<a href="https://styleci.io/repos/69245607"><img src="https://styleci.io/repos/69245607/shield" alt="StyleCI"></a>
6+
<a href="https://github.com/cybercog/laravel-eloquent-flag/releases"><img src="https://img.shields.io/github/release/cybercog/laravel-eloquent-flag.svg?style=flat-square" alt="Releases"></a>
7+
<a href="https://github.com/cybercog/laravel-eloquent-flag/blob/master/LICENSE"><img src="https://img.shields.io/github/license/cybercog/laravel-eloquent-flag.svg?style=flat-square" alt="License"></a>
8+
</p>
79

8-
Eloquent flagged attributes behavior. Add commonly used flags to models very quick and easy.
10+
## Introduction
911

10-
![cog-laravel-eloquent-flag](https://cloud.githubusercontent.com/assets/1849174/21166452/b1bbf3e8-c1b6-11e6-8f06-468828402ebe.png)
12+
Eloquent flagged attributes behavior. Enhance eloquent models with commonly used flags like `Active`, `Published`, `Approved` and other in a minutes!
1113

1214
## Features
1315

@@ -50,7 +52,7 @@ composer require cybercog/laravel-eloquent-flag
5052

5153
And then include the service provider within `app/config/app.php`.
5254

53-
*// Service provider not using yet. Will be used to boot console commands in future.*
55+
*// Service provider not using yet. This step not mandatory. Will be used to boot console commands in future.*
5456

5557
```php
5658
'providers' => [
@@ -515,7 +517,7 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
515517

516518
## Security
517519

518-
If you discover any security related issues, please email support@cybercog.su instead of using the issue tracker.
520+
If you discover any security related issues, please email a.komarev@cybercog.su instead of using the issue tracker.
519521

520522
## Credits
521523

UPGRADING.md renamed to UPGRADE.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
# Upgrading
1+
# Upgrade Guide
22

3-
## From v2 to v3
3+
- [Upgrading To 3.0 From 2.0](#upgrade-3.0)
4+
- [Upgrading To 2.0 From 1.0](#upgrade-2.0)
5+
6+
<a name="upgrade-3.0"></a>
7+
## Upgrading To 3.0 From 2.0
48

59
You can upgrade from v2 to v3 by performing these renames in your model that has flags: `Accepted`, `Active` & `Approved`.
610

@@ -18,7 +22,8 @@ These methods should be renamed:
1822
- `withoutUnapproved()` has been renamed to `withoutDisapproved()`.
1923
- `onlyUnapproved()` has been renamed to `onlyDisapproved()`.
2024

21-
## From v1 to v2
25+
<a name="upgrade-2.0"></a>
26+
## Upgrading To 2.0 From 1.0
2227

2328
- Namespaces of flag's traits received `Classic` at the end: `Cog\Flag\Traits\Classic`.
2429
- Namespaces of flag's scopes received `Classic` at the end: `Cog\Flag\Scopes\Classic`.

src/Providers/FlagServiceProvider.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Scopes/Classic/AcceptedFlagScope.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Scopes/Classic/ActiveFlagScope.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Scopes/Classic/ApprovedFlagScope.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Scopes/Classic/KeptFlagScope.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Scopes/Classic/PublishedFlagScope.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Scopes/Classic/VerifiedFlagScope.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Scopes/Inverse/ClosedFlagScope.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Scopes/Inverse/ExpiredFlagScope.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasAcceptedFlag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasAcceptedFlagHelpers.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasAcceptedFlagScope.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasActiveFlag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasActiveFlagHelpers.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasActiveFlagScope.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasApprovedFlag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasApprovedFlagHelpers.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasApprovedFlagScope.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasKeptFlag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasKeptFlagBehavior.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasKeptFlagHelpers.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasKeptFlagScope.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasPublishedFlag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasPublishedFlagHelpers.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasPublishedFlagScope.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasVerifiedFlag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasVerifiedFlagHelpers.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Classic/HasVerifiedFlagScope.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Inverse/HasClosedFlag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Inverse/HasClosedFlagHelpers.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Inverse/HasClosedFlagScope.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Inverse/HasExpiredFlag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

src/Traits/Inverse/HasExpiredFlagHelpers.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/*
44
* This file is part of Laravel Eloquent Flag.
55
*
6-
* (c) CyberCog <support@cybercog.su>
6+
* (c) Anton Komarev <a.komarev@cybercog.su>
77
*
88
* For the full copyright and license information, please view the LICENSE
99
* file that was distributed with this source code.

0 commit comments

Comments
 (0)