Search by

cable8mm / order-sheet

cable8mm

This package is able to generate a kind of seed for order sheets and order invoices so you can use it for testing like that

Package info

github.com/cable8mm/order-sheet

pkg:composer/cable8mm/order-sheet

Statistics

Installs: 456

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v1.2.3 2026-10-29 16:26 UTC

This package is auto-updated.

Last update: 2026-11-13 22:41:12 UTC


README

code-style run-tests pages-build-deployment Packagist Version Packagist Dependency Version Packagist Downloads Packagist Stars Packagist License

주문서와 인보이스 생성을 위한 테스트 데이터(시드)를 자동으로 생성하는 PHP 패키지입니다.

생성 데이터는 Faker 기반의 합성 데이터입니다. 현재 PlayAuto 실파일을 기준으로 검증된 데이터나 묶음 주문 시뮬레이션을 제공하지 않으며, 독립된 주문 행 단위로 샘플을 생성합니다.

공급가는 기본 매입 가격으로 생성하고, 원가는 공급가와 임의의 부대비용을 합산해 생성합니다.

API 문서: https://www.palgle.com/order-sheet/

지원 쇼핑몰

지원 온라인 몰

PLAYAUTO 주문서에서 사용 가능한 온라인 몰:

  • 티몬 (Timon)
  • 고도몰5 (GodoMall5)
  • 카페24(신) (NewCafe24)
  • 위메프2.0 (Wemake2)
  • 롯데백화점 (LotteDepartment)
  • 옥션 (Auction)

확장 방법

이 패키지는 새로운 쇼핑몰을 쉽게 추가할 수 있도록 설계되어 있습니다.

새 쇼핑몰 추가하기

  1. src/Factories/ 디렉토리에 새 Factory 클래스 생성 (예: NewCompanyFactory.php)
  2. definition() 메서드를 구현하여 컬럼명과 faker 값을 반환하는 배열 작성
  3. src/Enums/OrderSheetType.php enum에 새 케이스 추가
  4. factoryClass() 메서드에서 새 케이스를 Factory 클래스에 매핑

예제:

// src/Factories/NewCompanyFactory.php
namespace Cable8mm\OrderSheet\Factories;

class NewCompanyFactory extends Factory
{
    public function definition(): array
    {
        return [
            '주문번호' => Faker::shared()->randomNumber(10),
            '주문일' => Faker::make()->dateTime(),
            // ... 더 많은 필드들
        ];
    }
}

// src/Enums/OrderSheetType.php
enum OrderSheetType
{
    case PlayautoType;
    case NewCompanyType; // 새 타입 추가

    public function factoryClass(): string
    {
        return match ($this) {
            self::PlayautoType => PlayautoFactory::class,
            self::NewCompanyType => NewCompanyFactory::class, // 새 Factory 매핑
        };
    }
}

요구사항

  • PHP 8.2 이상

설치

composer require cable8mm/order-sheet

사용 방법

use Cable8mm\OrderSheet\OrderSheet;
use Cable8mm\OrderSheet\Enums\OrderSheetType;

// 헤더를 포함한 XLSX 파일로 저장
OrderSheet::of(OrderSheetType::PlayautoType)
  ->count(10)              // 10개의 데이터 생성
  ->header()               // 헤더 행 포함
  ->path('dist')           // 저장할 경로 지정
  ->xlsx('my.xlsx');       // xlsx 파일로 내보내기 (기본: 'order_sheet.xlsx')

// 주문당 2개 상품 행을 포함한 6개 주문 행 생성
// 묶음 주문의 주문번호, 구매자/수령자, 날짜, 배송 정보와 합계는 행 간에 일치합니다.
$bundledOrders = OrderSheet::of(OrderSheetType::PlayautoType)
  ->count(6)
  ->bundle(2)
  ->header()
  ->toArray();

// 헤더 없이 CSV 문자열로 내보내기
$csv = OrderSheet::of(OrderSheetType::PlayautoType)
  ->count(10)
  ->csv();

// 헤더 없이 배열로 내보내기
$array = OrderSheet::of(OrderSheetType::PlayautoType)
  ->count(10)
  ->toArray();

// state()로 특정 필드 값 변경
$customData = OrderSheet::of(OrderSheetType::PlayautoType)
  ->count(5)
  ->state([
    '상태' => '배송완료',   // 상태 필드 변경
    '구매자명' => '홍길동', // 구매자명 필드 변경
  ])
  ->toArray();

테스트

# 테스트 실행
composer test

# 코드 커버리지와 함께 테스트
composer test-coverage

# 코드 스타일 검사
composer lint

변경사항

CHANGELOG를 참고하세요.

기여하기

CONTRIBUTING을 참고하세요.

보안

보안 관련 문제는 이슈 트래커 대신 cable8mm@gmail.com으로 이메일 보내주세요.

크레딧

라이선스

MIT 라이선스. 자세한 내용은 License File를 참고하세요.