Skip to content
This repository has been archived by the owner on Nov 26, 2024. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@nasrulhazim
nasrulhazim committed Oct 2, 2018
1 parent 5492024 commit ff8ef93
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .php_cs.cache
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"php":"7.2.10","version":"2.13.0","rules":{"binary_operator_spaces":{"default":"align_single_space_minimal"},"blank_line_after_opening_tag":true,"blank_line_before_statement":{"statements":["return"]},"braces":{"allow_single_line_closure":true},"cast_spaces":true,"class_attributes_separation":{"elements":["method"]},"class_definition":{"multiLineExtendsEachSingleLine":true},"concat_space":{"spacing":"one"},"declare_equal_normalize":true,"function_typehint_space":true,"include":true,"increment_style":true,"lowercase_cast":true,"lowercase_static_reference":true,"magic_constant_casing":true,"magic_method_casing":true,"method_argument_space":true,"native_function_casing":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_blank_lines_after_phpdoc":true,"no_empty_comment":true,"no_empty_phpdoc":true,"no_empty_statement":true,"no_extra_blank_lines":{"tokens":["curly_brace_block","extra","parenthesis_brace_block","square_brace_block","throw","use"]},"no_leading_import_slash":true,"no_leading_namespace_whitespace":true,"no_mixed_echo_print":{"use":"echo"},"no_multiline_whitespace_around_double_arrow":true,"no_short_bool_cast":true,"no_singleline_whitespace_before_semicolons":true,"no_spaces_around_offset":true,"no_trailing_comma_in_list_call":true,"no_trailing_comma_in_singleline_array":true,"no_unneeded_control_parentheses":true,"no_unneeded_curly_braces":true,"no_unneeded_final_method":true,"no_unused_imports":true,"no_whitespace_before_comma_in_array":true,"no_whitespace_in_blank_line":true,"normalize_index_brace":true,"object_operator_without_whitespace":true,"php_unit_fqcn_annotation":true,"phpdoc_align":{"tags":["method","param","property","return","throws","type","var"]},"phpdoc_annotation_without_dot":true,"phpdoc_indent":true,"phpdoc_inline_tag":true,"phpdoc_no_access":true,"phpdoc_no_alias_tag":true,"phpdoc_no_empty_return":true,"phpdoc_no_package":true,"phpdoc_no_useless_inheritdoc":true,"phpdoc_return_self_reference":true,"phpdoc_scalar":true,"phpdoc_separation":true,"phpdoc_single_line_var_spacing":true,"phpdoc_summary":true,"phpdoc_to_comment":true,"phpdoc_trim":true,"phpdoc_types":true,"phpdoc_var_without_name":true,"protected_to_private":true,"return_type_declaration":true,"semicolon_after_instruction":true,"short_scalar_cast":true,"single_blank_line_before_namespace":true,"single_class_element_per_statement":true,"single_line_comment_style":{"comment_types":["hash"]},"single_quote":true,"space_after_semicolon":{"remove_in_empty_for_expressions":true},"standardize_increment":true,"standardize_not_equals":true,"ternary_operator_spaces":true,"trailing_comma_in_multiline_array":true,"trim_array_spaces":true,"unary_operator_spaces":true,"whitespace_after_comma_in_array":true,"yoda_style":true,"blank_line_after_namespace":true,"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_constants":true,"lowercase_keywords":true,"no_break_comment":true,"no_closing_tag":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_import_per_statement":true,"single_line_after_imports":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"visibility_required":true,"encoding":true,"full_opening_tag":true,"ordered_class_elements":["use_trait","constant_public","constant_protected","constant_private","property_public","property_protected","property_private","construct","destruct","magic","phpunit","method_public","method_protected","method_private"],"array_syntax":{"syntax":"short"},"linebreak_after_opening_tag":true,"not_operator_with_successor_space":true,"ordered_imports":true,"phpdoc_order":true},"hashes":{"config\/attendance.php":1968799351,"database\/seeds\/AttendanceTypeSeeder.php":965999979,"src\/Adapters\/ApiAdapter.php":712951294,"src\/Adapters\/BaseAdapter.php":983632699,"src\/Adapters\/ConsoleAdapter.php":3911315451,"src\/Adapters\/WebAdapter.php":3695591437,"src\/AttendanceFacade.php":2887602336,"src\/AttendanceServiceProvider.php":895493519,"src\/Console\/Commands\/InstallCommand.php":2496148456,"src\/Console\/Commands\/LogAttendanceCommand.php":4050377130,"src\/Console\/Commands\/MakeAttendanceAdapterCommand.php":2604631063,"src\/Console\/Commands\/SeedAttendanceTypesCommand.php":1117661199,"src\/Http\/Controllers\/Api\/AttendanceController.php":1223798463,"src\/Http\/Controllers\/Controller.php":1080215761,"src\/Models\/Attendance.php":4048419665,"src\/Models\/AttendanceType.php":566522005,"src\/Support\/helpers.php":52093902,"tests\/PackageTest.php":1161420402,"tests\/TestCase.php":235502886,"tests\/Traits\/UserTrait.php":3051346990}}
{"php":"7.2.10","version":"2.13.0","rules":{"binary_operator_spaces":{"default":"align_single_space_minimal"},"blank_line_after_opening_tag":true,"blank_line_before_statement":{"statements":["return"]},"braces":{"allow_single_line_closure":true},"cast_spaces":true,"class_attributes_separation":{"elements":["method"]},"class_definition":{"multiLineExtendsEachSingleLine":true},"concat_space":{"spacing":"one"},"declare_equal_normalize":true,"function_typehint_space":true,"include":true,"increment_style":true,"lowercase_cast":true,"lowercase_static_reference":true,"magic_constant_casing":true,"magic_method_casing":true,"method_argument_space":true,"native_function_casing":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_blank_lines_after_phpdoc":true,"no_empty_comment":true,"no_empty_phpdoc":true,"no_empty_statement":true,"no_extra_blank_lines":{"tokens":["curly_brace_block","extra","parenthesis_brace_block","square_brace_block","throw","use"]},"no_leading_import_slash":true,"no_leading_namespace_whitespace":true,"no_mixed_echo_print":{"use":"echo"},"no_multiline_whitespace_around_double_arrow":true,"no_short_bool_cast":true,"no_singleline_whitespace_before_semicolons":true,"no_spaces_around_offset":true,"no_trailing_comma_in_list_call":true,"no_trailing_comma_in_singleline_array":true,"no_unneeded_control_parentheses":true,"no_unneeded_curly_braces":true,"no_unneeded_final_method":true,"no_unused_imports":true,"no_whitespace_before_comma_in_array":true,"no_whitespace_in_blank_line":true,"normalize_index_brace":true,"object_operator_without_whitespace":true,"php_unit_fqcn_annotation":true,"phpdoc_align":{"tags":["method","param","property","return","throws","type","var"]},"phpdoc_annotation_without_dot":true,"phpdoc_indent":true,"phpdoc_inline_tag":true,"phpdoc_no_access":true,"phpdoc_no_alias_tag":true,"phpdoc_no_empty_return":true,"phpdoc_no_package":true,"phpdoc_no_useless_inheritdoc":true,"phpdoc_return_self_reference":true,"phpdoc_scalar":true,"phpdoc_separation":true,"phpdoc_single_line_var_spacing":true,"phpdoc_summary":true,"phpdoc_to_comment":true,"phpdoc_trim":true,"phpdoc_types":true,"phpdoc_var_without_name":true,"protected_to_private":true,"return_type_declaration":true,"semicolon_after_instruction":true,"short_scalar_cast":true,"single_blank_line_before_namespace":true,"single_class_element_per_statement":true,"single_line_comment_style":{"comment_types":["hash"]},"single_quote":true,"space_after_semicolon":{"remove_in_empty_for_expressions":true},"standardize_increment":true,"standardize_not_equals":true,"ternary_operator_spaces":true,"trailing_comma_in_multiline_array":true,"trim_array_spaces":true,"unary_operator_spaces":true,"whitespace_after_comma_in_array":true,"yoda_style":true,"blank_line_after_namespace":true,"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_constants":true,"lowercase_keywords":true,"no_break_comment":true,"no_closing_tag":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_import_per_statement":true,"single_line_after_imports":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"visibility_required":true,"encoding":true,"full_opening_tag":true,"ordered_class_elements":["use_trait","constant_public","constant_protected","constant_private","property_public","property_protected","property_private","construct","destruct","magic","phpunit","method_public","method_protected","method_private"],"array_syntax":{"syntax":"short"},"linebreak_after_opening_tag":true,"not_operator_with_successor_space":true,"ordered_imports":true,"phpdoc_order":true},"hashes":{"config\/attendance.php":1968799351,"database\/seeds\/AttendanceTypeSeeder.php":965999979,"src\/Adapters\/ApiAdapter.php":712951294,"src\/Adapters\/BaseAdapter.php":983632699,"src\/Adapters\/ConsoleAdapter.php":3911315451,"src\/Adapters\/WebAdapter.php":3695591437,"src\/AttendanceFacade.php":2887602336,"src\/AttendanceServiceProvider.php":895493519,"src\/Console\/Commands\/InstallCommand.php":2496148456,"src\/Console\/Commands\/LogAttendanceCommand.php":4050377130,"src\/Console\/Commands\/MakeAttendanceAdapterCommand.php":2604631063,"src\/Console\/Commands\/SeedAttendanceTypesCommand.php":1117661199,"src\/Http\/Controllers\/Api\/AttendanceController.php":1223798463,"src\/Http\/Controllers\/Controller.php":1080215761,"src\/Models\/Attendance.php":3544856980,"src\/Models\/AttendanceType.php":566522005,"src\/Support\/helpers.php":52093902,"tests\/PackageTest.php":1161420402,"tests\/TestCase.php":235502886,"tests\/Traits\/UserTrait.php":3051346990,"src\/Traits\/AttendanceTrait.php":2370797484}}
33 changes: 33 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,24 @@ CleaniqueCoders\Attendance\AttendanceServiceProvider::class,
$ php artisan attendance:install
```

5. Setup `AttendanceTrait` to your user model.

```php
<?php

namespace App;

use CleaniqueCoders\Attendance\Traits\AttendanceTrait;
use Illuminate\Notifications\Notifiable;
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
use Notifiable, AttendanceTrait;
...
```

## Usage

### Artisan Commands
Expand All @@ -63,6 +81,21 @@ $ php artisan attendance:log "[email protected]" 2 "email"

When running `attendance:install`, API routes to for attendance will be append into your `routes/api.php` file.

### Scopes

To get all entries for today, you can use `todayEntries()` scope.

```php
\CleaniqueCoders\Attendance\Models\Attendance::todayEntries()->get();
```

To get based on one or more drivers.

```php
\CleaniqueCoders\Attendance\Models\Attendance::todayEntries('web')->get();
\CleaniqueCoders\Attendance\Models\Attendance::todayEntries(['api', 'access-card'])->get();
```

### Custom adapter

You can create custom adapter if you want to have custom integration with Slack, Telegram, etc.
Expand Down

0 comments on commit ff8ef93

Please sign in to comment.