Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bootstrap php package #30

Merged
merged 6 commits into from
Oct 15, 2020
+1,556 −3
Merged

Bootstrap php package #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
506af42
add phpunit to composer.json.
Oct 14, 2020
ff3360d
add vendor/ to .gitignore file.
Oct 14, 2020
da4590c
update readme file.
Oct 14, 2020
40219fe
add autoloading to composer.json file.
Oct 14, 2020
7feec47
add entrypoint + skeleton class.
Oct 14, 2020
e58f6a2
update composer.json authors section.
Oct 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions php/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/vendor/
4 changes: 3 additions & 1 deletion php/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# kuliya for php

Algeria's college hierarchy dataset as php package
Algeria's college hierarchy dataset as php package.
The package structure follows [the Standard PHP Package Skeleton](https://github.com/php-pds/skeleton).
To contribute to this package please make sure to follow the [standard package developement guidelines](http://phppackagechecklist.com/) and to read the main repository [contributing guidelines](../.github/CONTRIBUTING.md).
29 changes: 27 additions & 2 deletions php/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,32 @@
{
"name": "dzcode.io/kuliya",
"name": "dzcodeio/kuliya",
"description": "Algeria's college hierarchy dataset as a package.",
"keywords": [
"dzcode", "algeria", "dataset", "package", "college"
],
"license": "MIT",
"authors": [
{
"name": "Mohamed A. Ben Hamida",
"homepage": "http://mallekbh.github.io/",
"email": "[email protected]",
"role": "Developer"
}
],
"require": {
"php": "^7.2",
"php": "^7.2"
},
"require-dev": {
"phpunit/phpunit": "^7"
},
"autoload": {
"psr-4": {
"Dzcodeio\\Kuliya\\": "src/"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand well php and composer, but if it's possible, can u make all files/dirs lowercased ( either python-cased or snake_cased ) to avoid across OSs file-system issues

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most popular php projects/frameworks use PascalCase for file/dir names so i dont think that would cause any issues but i can use snake_case starting from the next PR. As for namespaces, Class/Method names and class file names i chose to respect PHP standard recommendations, specificaly PSR-4 for class autoloading and PSR-12 for code style which suggests adopting PascalCase for namespaces/classes and class file names and camelCase for methods.

Copy link
Member

@ZibanPirate ZibanPirate Oct 15, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case then, it's better to keep it consistent across the php folder, so let it be PascalCased 👌🏽.

Just note that later on, changing letter cases will cause problems on windows.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh i see! thanks for the hint, i'll investigate on it then and use the best strategy possible.

}
},
"autoload-dev": {
"psr-4": {
"Dzcodeio\\Kulyia\\Test\\": "tests/"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same casing request

}
}
}
Loading