{"id":18674247,"url":"https://github.com/simtabi/symlink","last_synced_at":"2025-11-07T01:30:38.857Z","repository":{"id":57051506,"uuid":"264066557","full_name":"simtabi/symlink","owner":"simtabi","description":"Small utility class to help create symlinks","archived":false,"fork":false,"pushed_at":"2020-05-15T01:51:48.000Z","size":208,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-12-27T20:13:58.392Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simtabi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-15T01:32:47.000Z","updated_at":"2022-03-26T19:56:08.000Z","dependencies_parsed_at":"2022-08-24T05:10:50.659Z","dependency_job_id":null,"html_url":"https://github.com/simtabi/symlink","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simtabi%2Fsymlink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simtabi%2Fsymlink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simtabi%2Fsymlink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simtabi%2Fsymlink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simtabi","download_url":"https://codeload.github.com/simtabi/symlink/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239515554,"owners_count":19651773,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T09:18:08.222Z","updated_at":"2025-11-07T01:30:38.800Z","avatar_url":"https://github.com/simtabi.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"![alt text](https://repository-images.githubusercontent.com/264064758/3083f000-9629-11ea-880f-c2d6542e4b6a?raw=true)\n\n# Symlink Helper\n\n\nThis package allows you to easily and quickly generate symlinks \nof any given files and or directories.\n\n* Ensure you have and are running PHP 7 and above\n\n* Fully Objected Oriented\n* Chained methods\n* Interactive API\n\n\n## Getting Started\n\n### 1. Install\n\nRun the following command:\n\n```bash\ncomposer require simtabi/symlink\n```\n\n### 2. Use case scenarios.\n\nIf you want to use within a class/project, install\n the project via composer and user as follows:\n\n\n```php\nuse Simtabi\\Symlink; \n\n$symlinkInit = new Symlink();\n$obj = $symlinkInit-\u003esetBatchJobs([\n        [\n            'destination' =\u003e 'path_to_destination/folder_name_1',\n            'source'      =\u003e 'path_to_create_file/folder_name',\n        ],\n        [\n           'destination' =\u003e 'path_to_destination/folder_name_1',\n           'source'      =\u003e 'path_to_create_file/folder_name',\n        ]\n    ])\n    -\u003egenerate();\n```\n#### 1. Create multiple symlinks at ago.\nIn this use-case, you have to provide an `array` list of the path to the file/link to be \ncreated a symlink for and the destination path and file `alias` name. To achieve\nthis, use the following method.\n```php\n -\u003esetBatchJobs([\n// sources here\n   'destination' =\u003e 'path_to_destination/folder_name_1',\n   'source'      =\u003e 'path_to_create_file/folder_name',\n]);\n```\n#### 2. Create a single symlink at ago.\nIn this use-case, you have to provide an `array` list of the path to the file/link to be \ncreated a symlink for and the destination path and file `alias` name. To achieve\nthis, use the following method.\n```php\n -\u003esetSource( 'source')-\u003esetDestination('destination');\n```\n#### 3. Using it.\n\nIf you want to use within a file and you don't need composer setup, I have \ninitialized a composer autoload for you and all you have to do is \nrequire/include the composer autoload file within the location where\nyou want to use it. In this case we assume:  `include_once 'vendor/autoload.php';`\nSee included `test.php` file for more examples.\n\n\n```php\ninclude_once 'symlink/src/Symlink.php';\nuse Simtabi\\Symlink;\n\n$symlinkInit = new Symlink();\n$symlinkInit\n       -\u003esetSource( 'source')\n       -\u003esetDestination('destination')\n      -\u003egenerate();\n```\n\n### 3. API Methods\n\nThese are the available methods.\n\n#### Setters\n\n```php\n-\u003esetSource($source) // define source path\n-\u003esetDestination($destination) // define destination path\n-\u003esetGenerated(string $generated, $key) // capture and store all registered links\n-\u003esetMessages(string $messages, $key) // capture and store all error messages\n-\u003esetBatchJobs(array $batchJobs) // define multiple symlinks to be created\n```\n\n#### Getters\n\n```php\n-\u003egetSource() // get source path\n-\u003egetDestination() // get destination path\n-\u003egetGenerated() // get all stored registered links\n-\u003egetMessages() // get all stored error messages\n-\u003egetBatchJobs() // get all symlinks to be created\n```\n\n#### Generate\nWhen the `$echo` is set to `TRUE`, it will output the error messages to the screen.\n```php\n-\u003egenerate($echo = true) // generate method. \n```\n\n## Changelog\n\nPlease see [Releases](../../releases) for more information what has changed recently.\n\n## Contributing\n\nPull requests are more than welcome. You must follow the PSR coding standards.\n\n## Security\n\nIf you discover any security related issues, please email security@simtabi.com instead of using the issue tracker.\n\n## Credits\n\n- [Imani Manyara](https://github.com/imanimanyara)\n- [Easter Manyara](https://simtabi.com/)\n- [All Contributors](../../contributors)\n\n## Copyright\n© 2020 Simtabi, LLC\n\n### License\n\nThe MIT License (MIT). Please see [LICENSE](LICENSE.md) for more information.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimtabi%2Fsymlink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimtabi%2Fsymlink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimtabi%2Fsymlink/lists"}